aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/scsi/fcoe/fcoe_sw.c
diff options
context:
space:
mode:
authorRobert Love <robert.w.love@intel.com>2009-02-27 13:55:45 -0500
committerJames Bottomley <James.Bottomley@HansenPartnership.com>2009-03-10 10:04:40 -0400
commit34f42a070fc98f5dc07e9fa2338b7b8d1dc347eb (patch)
tree7e08edd537159be8a4fa341e7022cafd6f13b9e4 /drivers/scsi/fcoe/fcoe_sw.c
parent0ae4d4ae47d2ccbcad813b0d6d8fe12590c7d648 (diff)
[SCSI] libfc, fcoe: Fix kerneldoc comments
1) Added '()' for function names in kerneldoc comments 2) Changed comment bookends from '**/' to '*/'. The comment on the the mailing list was that '**/' "is consistently unconventional. Not wrong, just odd." The Documentation/kernel-doc-nano-HOWTO.txt states that kerneldoc comment blocks should end with '**/' but most (if not all) instance I found under drivers/scsi/ were only using the '*/' so I converted to that style. 3) Removed incorrect linebreaks in kerneldoc comments where found 4) Removed a few unnecessary blank comment lines in kerneldoc comment blocks Signed-off-by: Robert Love <robert.w.love@intel.com> Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
Diffstat (limited to 'drivers/scsi/fcoe/fcoe_sw.c')
-rw-r--r--drivers/scsi/fcoe/fcoe_sw.c42
1 files changed, 19 insertions, 23 deletions
diff --git a/drivers/scsi/fcoe/fcoe_sw.c b/drivers/scsi/fcoe/fcoe_sw.c
index cf83675a0fb9..007d1fbae808 100644
--- a/drivers/scsi/fcoe/fcoe_sw.c
+++ b/drivers/scsi/fcoe/fcoe_sw.c
@@ -104,13 +104,12 @@ static struct scsi_host_template fcoe_sw_shost_template = {
104 .max_sectors = 0xffff, 104 .max_sectors = 0xffff,
105}; 105};
106 106
107/* 107/**
108 * fcoe_sw_lport_config - sets up the fc_lport 108 * fcoe_sw_lport_config() - sets up the fc_lport
109 * @lp: ptr to the fc_lport 109 * @lp: ptr to the fc_lport
110 * @shost: ptr to the parent scsi host 110 * @shost: ptr to the parent scsi host
111 * 111 *
112 * Returns: 0 for success 112 * Returns: 0 for success
113 *
114 */ 113 */
115static int fcoe_sw_lport_config(struct fc_lport *lp) 114static int fcoe_sw_lport_config(struct fc_lport *lp)
116{ 115{
@@ -137,16 +136,14 @@ static int fcoe_sw_lport_config(struct fc_lport *lp)
137 return 0; 136 return 0;
138} 137}
139 138
140/* 139/**
141 * fcoe_sw_netdev_config - sets up fcoe_softc for lport and network 140 * fcoe_sw_netdev_config() - Set up netdev for SW FCoE
142 * related properties
143 * @lp : ptr to the fc_lport 141 * @lp : ptr to the fc_lport
144 * @netdev : ptr to the associated netdevice struct 142 * @netdev : ptr to the associated netdevice struct
145 * 143 *
146 * Must be called after fcoe_sw_lport_config() as it will use lport mutex 144 * Must be called after fcoe_sw_lport_config() as it will use lport mutex
147 * 145 *
148 * Returns : 0 for success 146 * Returns : 0 for success
149 *
150 */ 147 */
151static int fcoe_sw_netdev_config(struct fc_lport *lp, struct net_device *netdev) 148static int fcoe_sw_netdev_config(struct fc_lport *lp, struct net_device *netdev)
152{ 149{
@@ -224,16 +221,15 @@ static int fcoe_sw_netdev_config(struct fc_lport *lp, struct net_device *netdev)
224 return 0; 221 return 0;
225} 222}
226 223
227/* 224/**
228 * fcoe_sw_shost_config - sets up fc_lport->host 225 * fcoe_sw_shost_config() - Sets up fc_lport->host
229 * @lp : ptr to the fc_lport 226 * @lp : ptr to the fc_lport
230 * @shost : ptr to the associated scsi host 227 * @shost : ptr to the associated scsi host
231 * @dev : device associated to scsi host 228 * @dev : device associated to scsi host
232 * 229 *
233 * Must be called after fcoe_sw_lport_config) and fcoe_sw_netdev_config() 230 * Must be called after fcoe_sw_lport_config() and fcoe_sw_netdev_config()
234 * 231 *
235 * Returns : 0 for success 232 * Returns : 0 for success
236 *
237 */ 233 */
238static int fcoe_sw_shost_config(struct fc_lport *lp, struct Scsi_Host *shost, 234static int fcoe_sw_shost_config(struct fc_lport *lp, struct Scsi_Host *shost,
239 struct device *dev) 235 struct device *dev)
@@ -261,8 +257,8 @@ static int fcoe_sw_shost_config(struct fc_lport *lp, struct Scsi_Host *shost,
261 return 0; 257 return 0;
262} 258}
263 259
264/* 260/**
265 * fcoe_sw_em_config - allocates em for this lport 261 * fcoe_sw_em_config() - allocates em for this lport
266 * @lp: the port that em is to allocated for 262 * @lp: the port that em is to allocated for
267 * 263 *
268 * Returns : 0 on success 264 * Returns : 0 on success
@@ -279,8 +275,8 @@ static inline int fcoe_sw_em_config(struct fc_lport *lp)
279 return 0; 275 return 0;
280} 276}
281 277
282/* 278/**
283 * fcoe_sw_destroy - FCoE software HBA tear-down function 279 * fcoe_sw_destroy() - FCoE software HBA tear-down function
284 * @netdev: ptr to the associated net_device 280 * @netdev: ptr to the associated net_device
285 * 281 *
286 * Returns: 0 if link is OK for use by FCoE. 282 * Returns: 0 if link is OK for use by FCoE.
@@ -353,8 +349,8 @@ static struct libfc_function_template fcoe_sw_libfc_fcn_templ = {
353 .frame_send = fcoe_xmit, 349 .frame_send = fcoe_xmit,
354}; 350};
355 351
356/* 352/**
357 * fcoe_sw_create - this function creates the fcoe interface 353 * fcoe_sw_create() - this function creates the fcoe interface
358 * @netdev: pointer the associated netdevice 354 * @netdev: pointer the associated netdevice
359 * 355 *
360 * Creates fc_lport struct and scsi_host for lport, configures lport 356 * Creates fc_lport struct and scsi_host for lport, configures lport
@@ -440,8 +436,8 @@ out_host_put:
440 return rc; 436 return rc;
441} 437}
442 438
443/* 439/**
444 * fcoe_sw_match - the fcoe sw transport match function 440 * fcoe_sw_match() - The FCoE SW transport match function
445 * 441 *
446 * Returns : false always 442 * Returns : false always
447 */ 443 */
@@ -461,8 +457,8 @@ struct fcoe_transport fcoe_sw_transport = {
461 .device = 0xffff, 457 .device = 0xffff,
462}; 458};
463 459
464/* 460/**
465 * fcoe_sw_init - registers fcoe_sw_transport 461 * fcoe_sw_init() - Registers fcoe_sw_transport
466 * 462 *
467 * Returns : 0 on success 463 * Returns : 0 on success
468 */ 464 */
@@ -480,8 +476,8 @@ int __init fcoe_sw_init(void)
480 return 0; 476 return 0;
481} 477}
482 478
483/* 479/**
484 * fcoe_sw_exit - unregisters fcoe_sw_transport 480 * fcoe_sw_exit() - Unregisters fcoe_sw_transport
485 * 481 *
486 * Returns : 0 on success 482 * Returns : 0 on success
487 */ 483 */