[SCSI] cxgb3i: fix function descriptions

Limit function descriptions to be one line.

Signed-off-by: Karen Xie <kxie@chelsio.com>
Signed-off-by: Mike Christie <michaelc@cs.wisc.edu>
Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
This commit is contained in:
Karen Xie 2009-03-05 14:46:08 -06:00 committed by James Bottomley
parent 728996829b
commit 154229a33e
5 changed files with 14 additions and 20 deletions

View File

@ -196,7 +196,7 @@ static inline int ddp_alloc_gl_skb(struct cxgb3i_ddp_info *ddp, int idx,
} }
/** /**
* cxgb3i_ddp_find_page_index - return ddp page index for a given page size. * cxgb3i_ddp_find_page_index - return ddp page index for a given page size
* @pgsz: page size * @pgsz: page size
* return the ddp page index, if no match is found return DDP_PGIDX_MAX. * return the ddp page index, if no match is found return DDP_PGIDX_MAX.
*/ */
@ -355,8 +355,7 @@ EXPORT_SYMBOL_GPL(cxgb3i_ddp_release_gl);
* @tdev: t3cdev adapter * @tdev: t3cdev adapter
* @tid: connection id * @tid: connection id
* @tformat: tag format * @tformat: tag format
* @tagp: the s/w tag, if ddp setup is successful, it will be updated with * @tagp: contains s/w tag initially, will be updated with ddp/hw tag
* ddp/hw tag
* @gl: the page momory list * @gl: the page momory list
* @gfp: allocation mode * @gfp: allocation mode
* *

View File

@ -185,12 +185,11 @@ static inline int cxgb3i_is_ddp_tag(struct cxgb3i_tag_format *tformat, u32 tag)
} }
/** /**
* cxgb3i_sw_tag_usable - check if a given s/w tag has enough bits left for * cxgb3i_sw_tag_usable - check if s/w tag has enough bits left for hw bits
* the reserved/hw bits
* @tformat: tag format information * @tformat: tag format information
* @sw_tag: s/w tag to be checked * @sw_tag: s/w tag to be checked
* *
* return true if the tag is a ddp tag, false otherwise. * return true if the tag can be used for hw ddp tag, false otherwise.
*/ */
static inline int cxgb3i_sw_tag_usable(struct cxgb3i_tag_format *tformat, static inline int cxgb3i_sw_tag_usable(struct cxgb3i_tag_format *tformat,
u32 sw_tag) u32 sw_tag)
@ -222,8 +221,7 @@ static inline u32 cxgb3i_set_non_ddp_tag(struct cxgb3i_tag_format *tformat,
} }
/** /**
* cxgb3i_ddp_tag_base - shift the s/w tag bits so that reserved bits are not * cxgb3i_ddp_tag_base - shift s/w tag bits so that reserved bits are not used
* used.
* @tformat: tag format information * @tformat: tag format information
* @sw_tag: s/w tag to be checked * @sw_tag: s/w tag to be checked
*/ */

View File

@ -101,8 +101,7 @@ free_snic:
} }
/** /**
* cxgb3i_adapter_remove - release all the resources held and cleanup any * cxgb3i_adapter_remove - release the resources held and cleanup h/w settings
* h/w settings
* @t3dev: t3cdev adapter * @t3dev: t3cdev adapter
*/ */
void cxgb3i_adapter_remove(struct t3cdev *t3dev) void cxgb3i_adapter_remove(struct t3cdev *t3dev)
@ -135,8 +134,7 @@ void cxgb3i_adapter_remove(struct t3cdev *t3dev)
} }
/** /**
* cxgb3i_hba_find_by_netdev - find the cxgb3i_hba structure with a given * cxgb3i_hba_find_by_netdev - find the cxgb3i_hba structure via net_device
* net_device
* @t3dev: t3cdev adapter * @t3dev: t3cdev adapter
*/ */
struct cxgb3i_hba *cxgb3i_hba_find_by_netdev(struct net_device *ndev) struct cxgb3i_hba *cxgb3i_hba_find_by_netdev(struct net_device *ndev)
@ -390,9 +388,9 @@ static void cxgb3i_session_destroy(struct iscsi_cls_session *cls_session)
} }
/** /**
* cxgb3i_conn_max_xmit_dlength -- check the max. xmit pdu segment size, * cxgb3i_conn_max_xmit_dlength -- calc the max. xmit pdu segment size
* reduce it to be within the hardware limit if needed
* @conn: iscsi connection * @conn: iscsi connection
* check the max. xmit pdu payload, reduce it if needed
*/ */
static inline int cxgb3i_conn_max_xmit_dlength(struct iscsi_conn *conn) static inline int cxgb3i_conn_max_xmit_dlength(struct iscsi_conn *conn)
@ -413,8 +411,7 @@ static inline int cxgb3i_conn_max_xmit_dlength(struct iscsi_conn *conn)
} }
/** /**
* cxgb3i_conn_max_recv_dlength -- check the max. recv pdu segment size against * cxgb3i_conn_max_recv_dlength -- check the max. recv pdu segment size
* the hardware limit
* @conn: iscsi connection * @conn: iscsi connection
* return 0 if the value is valid, < 0 otherwise. * return 0 if the value is valid, < 0 otherwise.
*/ */
@ -755,9 +752,9 @@ static void cxgb3i_parse_itt(struct iscsi_conn *conn, itt_t itt,
/** /**
* cxgb3i_reserve_itt - generate tag for a give task * cxgb3i_reserve_itt - generate tag for a give task
* Try to set up ddp for a scsi read task.
* @task: iscsi task * @task: iscsi task
* @hdr_itt: tag, filled in by this function * @hdr_itt: tag, filled in by this function
* Set up ddp for scsi read tasks if possible.
*/ */
int cxgb3i_reserve_itt(struct iscsi_task *task, itt_t *hdr_itt) int cxgb3i_reserve_itt(struct iscsi_task *task, itt_t *hdr_itt)
{ {
@ -805,9 +802,9 @@ int cxgb3i_reserve_itt(struct iscsi_task *task, itt_t *hdr_itt)
/** /**
* cxgb3i_release_itt - release the tag for a given task * cxgb3i_release_itt - release the tag for a given task
* if the tag is a ddp tag, release the ddp setup
* @task: iscsi task * @task: iscsi task
* @hdr_itt: tag * @hdr_itt: tag
* If the tag is a ddp tag, release the ddp setup
*/ */
void cxgb3i_release_itt(struct iscsi_task *task, itt_t hdr_itt) void cxgb3i_release_itt(struct iscsi_task *task, itt_t hdr_itt)
{ {

View File

@ -1417,8 +1417,7 @@ static void c3cn_active_close(struct s3_conn *c3cn)
} }
/** /**
* cxgb3i_c3cn_release - close and release an iscsi tcp connection and any * cxgb3i_c3cn_release - close and release an iscsi tcp connection
* resource held
* @c3cn: the iscsi tcp connection * @c3cn: the iscsi tcp connection
*/ */
void cxgb3i_c3cn_release(struct s3_conn *c3cn) void cxgb3i_c3cn_release(struct s3_conn *c3cn)

View File

@ -139,6 +139,7 @@ enum c3cn_flags {
/** /**
* cxgb3i_sdev_data - Per adapter data. * cxgb3i_sdev_data - Per adapter data.
*
* Linked off of each Ethernet device port on the adapter. * Linked off of each Ethernet device port on the adapter.
* Also available via the t3cdev structure since we have pointers to our port * Also available via the t3cdev structure since we have pointers to our port
* net_device's there ... * net_device's there ...