Commit bfab1637 authored by Martin Peschke's avatar Martin Peschke Committed by James Bottomley

[SCSI] zfcp: Add docbook comments to debug trace.

Add missing docbook-comments for functions forming zfcp's internal
trace API.
Signed-off-by: default avatarMartin Peschke <mp3@de.ibm.com>
Signed-off-by: default avatarChristof Schmitt <christof.schmitt@de.ibm.com>
Signed-off-by: default avatarJames Bottomley <James.Bottomley@HansenPartnership.com>
parent 92c7a83f
...@@ -131,6 +131,10 @@ static int zfcp_dbf_view_header(debug_info_t *id, struct debug_view *view, ...@@ -131,6 +131,10 @@ static int zfcp_dbf_view_header(debug_info_t *id, struct debug_view *view,
return p - out_buf; return p - out_buf;
} }
/**
* zfcp_hba_dbf_event_fsf_response - trace event for request completion
* @fsf_req: request that has been completed
*/
void zfcp_hba_dbf_event_fsf_response(struct zfcp_fsf_req *fsf_req) void zfcp_hba_dbf_event_fsf_response(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_adapter *adapter = fsf_req->adapter; struct zfcp_adapter *adapter = fsf_req->adapter;
...@@ -247,6 +251,12 @@ void zfcp_hba_dbf_event_fsf_response(struct zfcp_fsf_req *fsf_req) ...@@ -247,6 +251,12 @@ void zfcp_hba_dbf_event_fsf_response(struct zfcp_fsf_req *fsf_req)
spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags); spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags);
} }
/**
* zfcp_hba_dbf_event_fsf_unsol - trace event for an unsolicited status buffer
* @tag: tag indicating which kind of unsolicited status has been received
* @adapter: adapter that has issued the unsolicited status buffer
* @status_buffer: buffer containing payload of unsolicited status
*/
void zfcp_hba_dbf_event_fsf_unsol(const char *tag, struct zfcp_adapter *adapter, void zfcp_hba_dbf_event_fsf_unsol(const char *tag, struct zfcp_adapter *adapter,
struct fsf_status_read_buffer *status_buffer) struct fsf_status_read_buffer *status_buffer)
{ {
...@@ -299,6 +309,15 @@ void zfcp_hba_dbf_event_fsf_unsol(const char *tag, struct zfcp_adapter *adapter, ...@@ -299,6 +309,15 @@ void zfcp_hba_dbf_event_fsf_unsol(const char *tag, struct zfcp_adapter *adapter,
spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags); spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags);
} }
/**
* zfcp_hba_dbf_event_qdio - trace event for QDIO related failure
* @adapter: adapter affected by this QDIO related event
* @status: as passed by qdio module
* @qdio_error: as passed by qdio module
* @siga_error: as passed by qdio module
* @sbal_index: first buffer with error condition, as passed by qdio module
* @sbal_count: number of buffers affected, as passed by qdio module
*/
void zfcp_hba_dbf_event_qdio(struct zfcp_adapter *adapter, unsigned int status, void zfcp_hba_dbf_event_qdio(struct zfcp_adapter *adapter, unsigned int status,
unsigned int qdio_error, unsigned int siga_error, unsigned int qdio_error, unsigned int siga_error,
int sbal_index, int sbal_count) int sbal_index, int sbal_count)
...@@ -810,6 +829,10 @@ void zfcp_rec_dbf_event_action(u8 id2, struct zfcp_erp_action *erp_action) ...@@ -810,6 +829,10 @@ void zfcp_rec_dbf_event_action(u8 id2, struct zfcp_erp_action *erp_action)
spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags); spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags);
} }
/**
* zfcp_san_dbf_event_ct_request - trace event for issued CT request
* @fsf_req: request containing issued CT data
*/
void zfcp_san_dbf_event_ct_request(struct zfcp_fsf_req *fsf_req) void zfcp_san_dbf_event_ct_request(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data; struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data;
...@@ -840,6 +863,10 @@ void zfcp_san_dbf_event_ct_request(struct zfcp_fsf_req *fsf_req) ...@@ -840,6 +863,10 @@ void zfcp_san_dbf_event_ct_request(struct zfcp_fsf_req *fsf_req)
spin_unlock_irqrestore(&adapter->san_dbf_lock, flags); spin_unlock_irqrestore(&adapter->san_dbf_lock, flags);
} }
/**
* zfcp_san_dbf_event_ct_response - trace event for completion of CT request
* @fsf_req: request containing CT response
*/
void zfcp_san_dbf_event_ct_response(struct zfcp_fsf_req *fsf_req) void zfcp_san_dbf_event_ct_response(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data; struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data;
...@@ -892,6 +919,10 @@ static void zfcp_san_dbf_event_els(const char *tag, int level, ...@@ -892,6 +919,10 @@ static void zfcp_san_dbf_event_els(const char *tag, int level,
spin_unlock_irqrestore(&adapter->san_dbf_lock, flags); spin_unlock_irqrestore(&adapter->san_dbf_lock, flags);
} }
/**
* zfcp_san_dbf_event_els_request - trace event for issued ELS
* @fsf_req: request containing issued ELS
*/
void zfcp_san_dbf_event_els_request(struct zfcp_fsf_req *fsf_req) void zfcp_san_dbf_event_els_request(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data; struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data;
...@@ -902,6 +933,10 @@ void zfcp_san_dbf_event_els_request(struct zfcp_fsf_req *fsf_req) ...@@ -902,6 +933,10 @@ void zfcp_san_dbf_event_els_request(struct zfcp_fsf_req *fsf_req)
zfcp_sg_to_address(els->req), els->req->length); zfcp_sg_to_address(els->req), els->req->length);
} }
/**
* zfcp_san_dbf_event_els_response - trace event for completed ELS
* @fsf_req: request containing ELS response
*/
void zfcp_san_dbf_event_els_response(struct zfcp_fsf_req *fsf_req) void zfcp_san_dbf_event_els_response(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data; struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data;
...@@ -913,6 +948,10 @@ void zfcp_san_dbf_event_els_response(struct zfcp_fsf_req *fsf_req) ...@@ -913,6 +948,10 @@ void zfcp_san_dbf_event_els_response(struct zfcp_fsf_req *fsf_req)
els->resp->length); els->resp->length);
} }
/**
* zfcp_san_dbf_event_incoming_els - trace event for incomig ELS
* @fsf_req: request containing unsolicited status buffer with incoming ELS
*/
void zfcp_san_dbf_event_incoming_els(struct zfcp_fsf_req *fsf_req) void zfcp_san_dbf_event_incoming_els(struct zfcp_fsf_req *fsf_req)
{ {
struct zfcp_adapter *adapter = fsf_req->adapter; struct zfcp_adapter *adapter = fsf_req->adapter;
...@@ -1069,6 +1108,14 @@ static void zfcp_scsi_dbf_event(const char *tag, const char *tag2, int level, ...@@ -1069,6 +1108,14 @@ static void zfcp_scsi_dbf_event(const char *tag, const char *tag2, int level,
spin_unlock_irqrestore(&adapter->scsi_dbf_lock, flags); spin_unlock_irqrestore(&adapter->scsi_dbf_lock, flags);
} }
/**
* zfcp_scsi_dbf_event_result - trace event for SCSI command completion
* @tag: tag indicating success or failure of SCSI command
* @level: trace level applicable for this event
* @adapter: adapter that has been used to issue the SCSI command
* @scsi_cmnd: SCSI command pointer
* @fsf_req: request used to issue SCSI command (might be NULL)
*/
void zfcp_scsi_dbf_event_result(const char *tag, int level, void zfcp_scsi_dbf_event_result(const char *tag, int level,
struct zfcp_adapter *adapter, struct zfcp_adapter *adapter,
struct scsi_cmnd *scsi_cmnd, struct scsi_cmnd *scsi_cmnd,
...@@ -1077,6 +1124,14 @@ void zfcp_scsi_dbf_event_result(const char *tag, int level, ...@@ -1077,6 +1124,14 @@ void zfcp_scsi_dbf_event_result(const char *tag, int level,
zfcp_scsi_dbf_event("rslt", tag, level, adapter, scsi_cmnd, fsf_req, 0); zfcp_scsi_dbf_event("rslt", tag, level, adapter, scsi_cmnd, fsf_req, 0);
} }
/**
* zfcp_scsi_dbf_event_abort - trace event for SCSI command abort
* @tag: tag indicating success or failure of abort operation
* @adapter: adapter thas has been used to issue SCSI command to be aborted
* @scsi_cmnd: SCSI command to be aborted
* @new_fsf_req: request containing abort (might be NULL)
* @old_req_id: identifier of request containg SCSI command to be aborted
*/
void zfcp_scsi_dbf_event_abort(const char *tag, struct zfcp_adapter *adapter, void zfcp_scsi_dbf_event_abort(const char *tag, struct zfcp_adapter *adapter,
struct scsi_cmnd *scsi_cmnd, struct scsi_cmnd *scsi_cmnd,
struct zfcp_fsf_req *new_fsf_req, struct zfcp_fsf_req *new_fsf_req,
...@@ -1086,6 +1141,13 @@ void zfcp_scsi_dbf_event_abort(const char *tag, struct zfcp_adapter *adapter, ...@@ -1086,6 +1141,13 @@ void zfcp_scsi_dbf_event_abort(const char *tag, struct zfcp_adapter *adapter,
old_req_id); old_req_id);
} }
/**
* zfcp_scsi_dbf_event_devreset - trace event for Logical Unit or Target Reset
* @tag: tag indicating success or failure of reset operation
* @flag: indicates type of reset (Target Reset, Logical Unit Reset)
* @unit: unit that needs reset
* @scsi_cmnd: SCSI command which caused this error recovery
*/
void zfcp_scsi_dbf_event_devreset(const char *tag, u8 flag, void zfcp_scsi_dbf_event_devreset(const char *tag, u8 flag,
struct zfcp_unit *unit, struct zfcp_unit *unit,
struct scsi_cmnd *scsi_cmnd) struct scsi_cmnd *scsi_cmnd)
......
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