Commit 623cd180 authored by Steffen Maier's avatar Steffen Maier Committed by Martin K. Petersen

scsi: zfcp: silence remaining kdoc warnings in header files

Improve whatever the following simple invocation reported:
$ ./scripts/kernel-doc -none drivers/s390/scsi/*.h

While at it, improve some related kdoc,
including struct zfcp_fsf_ct_els in zfcp_fsf.h.
Signed-off-by: default avatarSteffen Maier <maier@linux.ibm.com>
Reviewed-by: default avatarBenjamin Block <bblock@linux.ibm.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 8684d614
...@@ -42,7 +42,8 @@ struct zfcp_dbf_rec_trigger { ...@@ -42,7 +42,8 @@ struct zfcp_dbf_rec_trigger {
* @fsf_req_id: request id for fsf requests * @fsf_req_id: request id for fsf requests
* @rec_status: status of the fsf request * @rec_status: status of the fsf request
* @rec_step: current step of the recovery action * @rec_step: current step of the recovery action
* rec_count: recovery counter * @rec_action: ERP action type
* @rec_count: recoveries including retries for particular @rec_action
*/ */
struct zfcp_dbf_rec_running { struct zfcp_dbf_rec_running {
u64 fsf_req_id; u64 fsf_req_id;
...@@ -72,6 +73,7 @@ enum zfcp_dbf_rec_id { ...@@ -72,6 +73,7 @@ enum zfcp_dbf_rec_id {
* @adapter_status: current status of the adapter * @adapter_status: current status of the adapter
* @port_status: current status of the port * @port_status: current status of the port
* @lun_status: current status of the lun * @lun_status: current status of the lun
* @u: record type specific data
* @u.trig: structure zfcp_dbf_rec_trigger * @u.trig: structure zfcp_dbf_rec_trigger
* @u.run: structure zfcp_dbf_rec_running * @u.run: structure zfcp_dbf_rec_running
*/ */
...@@ -126,6 +128,8 @@ struct zfcp_dbf_san { ...@@ -126,6 +128,8 @@ struct zfcp_dbf_san {
* @prot_status_qual: protocol status qualifier * @prot_status_qual: protocol status qualifier
* @fsf_status: fsf status * @fsf_status: fsf status
* @fsf_status_qual: fsf status qualifier * @fsf_status_qual: fsf status qualifier
* @port_handle: handle for port
* @lun_handle: handle for LUN
*/ */
struct zfcp_dbf_hba_res { struct zfcp_dbf_hba_res {
u64 req_issued; u64 req_issued;
...@@ -158,6 +162,7 @@ struct zfcp_dbf_hba_uss { ...@@ -158,6 +162,7 @@ struct zfcp_dbf_hba_uss {
* @ZFCP_DBF_HBA_RES: response trace record * @ZFCP_DBF_HBA_RES: response trace record
* @ZFCP_DBF_HBA_USS: unsolicited status trace record * @ZFCP_DBF_HBA_USS: unsolicited status trace record
* @ZFCP_DBF_HBA_BIT: bit error trace record * @ZFCP_DBF_HBA_BIT: bit error trace record
* @ZFCP_DBF_HBA_BASIC: basic adapter event, only trace tag, no other data
*/ */
enum zfcp_dbf_hba_id { enum zfcp_dbf_hba_id {
ZFCP_DBF_HBA_RES = 1, ZFCP_DBF_HBA_RES = 1,
...@@ -176,6 +181,9 @@ enum zfcp_dbf_hba_id { ...@@ -176,6 +181,9 @@ enum zfcp_dbf_hba_id {
* @fsf_seq_no: fsf sequence number * @fsf_seq_no: fsf sequence number
* @pl_len: length of payload stored as zfcp_dbf_pay * @pl_len: length of payload stored as zfcp_dbf_pay
* @u: record type specific data * @u: record type specific data
* @u.res: data for fsf responses
* @u.uss: data for unsolicited status buffer
* @u.be: data for bit error unsolicited status buffer
*/ */
struct zfcp_dbf_hba { struct zfcp_dbf_hba {
u8 id; u8 id;
......
...@@ -121,9 +121,24 @@ struct zfcp_fc_rspn_req { ...@@ -121,9 +121,24 @@ struct zfcp_fc_rspn_req {
/** /**
* struct zfcp_fc_req - Container for FC ELS and CT requests sent from zfcp * struct zfcp_fc_req - Container for FC ELS and CT requests sent from zfcp
* @ct_els: data required for issuing fsf command * @ct_els: data required for issuing fsf command
* @sg_req: scatterlist entry for request data * @sg_req: scatterlist entry for request data, refers to embedded @u submember
* @sg_rsp: scatterlist entry for response data * @sg_rsp: scatterlist entry for response data, refers to embedded @u submember
* @u: request specific data * @u: request and response specific data
* @u.adisc: ADISC specific data
* @u.adisc.req: ADISC request
* @u.adisc.rsp: ADISC response
* @u.gid_pn: GID_PN specific data
* @u.gid_pn.req: GID_PN request
* @u.gid_pn.rsp: GID_PN response
* @u.gpn_ft: GPN_FT specific data
* @u.gpn_ft.sg_rsp2: GPN_FT response, not embedded here, allocated elsewhere
* @u.gpn_ft.req: GPN_FT request
* @u.gspn: GSPN specific data
* @u.gspn.req: GSPN request
* @u.gspn.rsp: GSPN response
* @u.rspn: RSPN specific data
* @u.rspn.req: RSPN request
* @u.rspn.rsp: RSPN response
*/ */
struct zfcp_fc_req { struct zfcp_fc_req {
struct zfcp_fsf_ct_els ct_els; struct zfcp_fsf_ct_els ct_els;
......
...@@ -438,8 +438,8 @@ struct zfcp_blk_drv_data { ...@@ -438,8 +438,8 @@ struct zfcp_blk_drv_data {
/** /**
* struct zfcp_fsf_ct_els - zfcp data for ct or els request * struct zfcp_fsf_ct_els - zfcp data for ct or els request
* @req: scatter-gather list for request * @req: scatter-gather list for request, points to &zfcp_fc_req.sg_req or BSG
* @resp: scatter-gather list for response * @resp: scatter-gather list for response, points to &zfcp_fc_req.sg_rsp or BSG
* @handler: handler function (called for response to the request) * @handler: handler function (called for response to the request)
* @handler_data: data passed to handler function * @handler_data: data passed to handler function
* @port: Optional pointer to port for zfcp internal ELS (only test link ADISC) * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
......
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
* @req_q_full: queue full incidents * @req_q_full: queue full incidents
* @req_q_wq: used to wait for SBAL availability * @req_q_wq: used to wait for SBAL availability
* @adapter: adapter used in conjunction with this qdio structure * @adapter: adapter used in conjunction with this qdio structure
* @max_sbale_per_sbal: qdio limit per sbal
* @max_sbale_per_req: qdio limit per request
*/ */
struct zfcp_qdio { struct zfcp_qdio {
struct qdio_buffer *res_q[QDIO_MAX_BUFFERS_PER_Q]; struct qdio_buffer *res_q[QDIO_MAX_BUFFERS_PER_Q];
...@@ -70,7 +72,7 @@ struct zfcp_qdio_req { ...@@ -70,7 +72,7 @@ struct zfcp_qdio_req {
/** /**
* zfcp_qdio_sbale_req - return pointer to sbale on req_q for a request * zfcp_qdio_sbale_req - return pointer to sbale on req_q for a request
* @qdio: pointer to struct zfcp_qdio * @qdio: pointer to struct zfcp_qdio
* @q_rec: pointer to struct zfcp_qdio_req * @q_req: pointer to struct zfcp_qdio_req
* Returns: pointer to qdio_buffer_element (sbale) structure * Returns: pointer to qdio_buffer_element (sbale) structure
*/ */
static inline struct qdio_buffer_element * static inline struct qdio_buffer_element *
...@@ -82,7 +84,7 @@ zfcp_qdio_sbale_req(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req) ...@@ -82,7 +84,7 @@ zfcp_qdio_sbale_req(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
/** /**
* zfcp_qdio_sbale_curr - return current sbale on req_q for a request * zfcp_qdio_sbale_curr - return current sbale on req_q for a request
* @qdio: pointer to struct zfcp_qdio * @qdio: pointer to struct zfcp_qdio
* @fsf_req: pointer to struct zfcp_fsf_req * @q_req: pointer to struct zfcp_qdio_req
* Returns: pointer to qdio_buffer_element (sbale) structure * Returns: pointer to qdio_buffer_element (sbale) structure
*/ */
static inline struct qdio_buffer_element * static inline struct qdio_buffer_element *
...@@ -135,6 +137,8 @@ void zfcp_qdio_req_init(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req, ...@@ -135,6 +137,8 @@ void zfcp_qdio_req_init(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req,
* zfcp_qdio_fill_next - Fill next sbale, only for single sbal requests * zfcp_qdio_fill_next - Fill next sbale, only for single sbal requests
* @qdio: pointer to struct zfcp_qdio * @qdio: pointer to struct zfcp_qdio
* @q_req: pointer to struct zfcp_queue_req * @q_req: pointer to struct zfcp_queue_req
* @data: pointer to data
* @len: length of data
* *
* This is only required for single sbal requests, calling it when * This is only required for single sbal requests, calling it when
* wrapping around to the next sbal is a bug. * wrapping around to the next sbal is a bug.
...@@ -182,6 +186,7 @@ int zfcp_qdio_sg_one_sbale(struct scatterlist *sg) ...@@ -182,6 +186,7 @@ int zfcp_qdio_sg_one_sbale(struct scatterlist *sg)
/** /**
* zfcp_qdio_skip_to_last_sbale - skip to last sbale in sbal * zfcp_qdio_skip_to_last_sbale - skip to last sbale in sbal
* @qdio: pointer to struct zfcp_qdio
* @q_req: The current zfcp_qdio_req * @q_req: The current zfcp_qdio_req
*/ */
static inline static inline
......
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
/** /**
* struct zfcp_reqlist - Container for request list (reqlist) * struct zfcp_reqlist - Container for request list (reqlist)
* @lock: Spinlock for protecting the hash list * @lock: Spinlock for protecting the hash list
* @list: Array of hashbuckets, each is a list of requests in this bucket * @buckets: Array of hashbuckets, each is a list of requests in this bucket
*/ */
struct zfcp_reqlist { struct zfcp_reqlist {
spinlock_t lock; spinlock_t lock;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment