diff options
author | Jing Huang <huangj@brocade.com> | 2010-10-18 20:15:55 -0400 |
---|---|---|
committer | James Bottomley <James.Bottomley@suse.de> | 2010-10-25 17:26:57 -0400 |
commit | acdc79a60cb3cbbc9f07bb5032d890e9cf94f0ff (patch) | |
tree | cea700a23bf6e96e084bee54392b11bc4d307710 /drivers/scsi/bfa/bfa_defs.h | |
parent | e0a08a30c9451333c9c4a8981fbfccc80b87ce78 (diff) |
[SCSI] bfa: fix comments for header files
This patch addresses the comments from Randy Dunlap (Randy.Dunlap@oracle.com)
regarding comment blocks that begining with "/**". bfa driver comments
currently do not follow kernel-doc convention, we hence replace all
/** with /* and **/ with */.
Signed-off-by: Jing Huang <huangj@brocade.com>
Signed-off-by: James Bottomley <James.Bottomley@suse.de>
Diffstat (limited to 'drivers/scsi/bfa/bfa_defs.h')
-rw-r--r-- | drivers/scsi/bfa/bfa_defs.h | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/drivers/scsi/bfa/bfa_defs.h b/drivers/scsi/bfa/bfa_defs.h index d49877ff5140..4b5b9e35abb9 100644 --- a/drivers/scsi/bfa/bfa_defs.h +++ b/drivers/scsi/bfa/bfa_defs.h | |||
@@ -24,7 +24,7 @@ | |||
24 | #define BFA_MFG_SERIALNUM_SIZE 11 | 24 | #define BFA_MFG_SERIALNUM_SIZE 11 |
25 | #define STRSZ(_n) (((_n) + 4) & ~3) | 25 | #define STRSZ(_n) (((_n) + 4) & ~3) |
26 | 26 | ||
27 | /** | 27 | /* |
28 | * Manufacturing card type | 28 | * Manufacturing card type |
29 | */ | 29 | */ |
30 | enum { | 30 | enum { |
@@ -45,7 +45,7 @@ enum { | |||
45 | 45 | ||
46 | #pragma pack(1) | 46 | #pragma pack(1) |
47 | 47 | ||
48 | /** | 48 | /* |
49 | * Check if Mezz card | 49 | * Check if Mezz card |
50 | */ | 50 | */ |
51 | #define bfa_mfg_is_mezz(type) (( \ | 51 | #define bfa_mfg_is_mezz(type) (( \ |
@@ -55,7 +55,7 @@ enum { | |||
55 | (type) == BFA_MFG_TYPE_LIGHTNING_P0 || \ | 55 | (type) == BFA_MFG_TYPE_LIGHTNING_P0 || \ |
56 | (type) == BFA_MFG_TYPE_LIGHTNING)) | 56 | (type) == BFA_MFG_TYPE_LIGHTNING)) |
57 | 57 | ||
58 | /** | 58 | /* |
59 | * Check if the card having old wwn/mac handling | 59 | * Check if the card having old wwn/mac handling |
60 | */ | 60 | */ |
61 | #define bfa_mfg_is_old_wwn_mac_model(type) (( \ | 61 | #define bfa_mfg_is_old_wwn_mac_model(type) (( \ |
@@ -78,12 +78,12 @@ do { \ | |||
78 | (m)[2] = t & 0xFF; \ | 78 | (m)[2] = t & 0xFF; \ |
79 | } while (0) | 79 | } while (0) |
80 | 80 | ||
81 | /** | 81 | /* |
82 | * VPD data length | 82 | * VPD data length |
83 | */ | 83 | */ |
84 | #define BFA_MFG_VPD_LEN 512 | 84 | #define BFA_MFG_VPD_LEN 512 |
85 | 85 | ||
86 | /** | 86 | /* |
87 | * VPD vendor tag | 87 | * VPD vendor tag |
88 | */ | 88 | */ |
89 | enum { | 89 | enum { |
@@ -97,7 +97,7 @@ enum { | |||
97 | BFA_MFG_VPD_PCI_BRCD = 0xf8, /* PCI VPD Brocade */ | 97 | BFA_MFG_VPD_PCI_BRCD = 0xf8, /* PCI VPD Brocade */ |
98 | }; | 98 | }; |
99 | 99 | ||
100 | /** | 100 | /* |
101 | * All numerical fields are in big-endian format. | 101 | * All numerical fields are in big-endian format. |
102 | */ | 102 | */ |
103 | struct bfa_mfg_vpd_s { | 103 | struct bfa_mfg_vpd_s { |
@@ -112,7 +112,7 @@ struct bfa_mfg_vpd_s { | |||
112 | 112 | ||
113 | #pragma pack() | 113 | #pragma pack() |
114 | 114 | ||
115 | /** | 115 | /* |
116 | * Status return values | 116 | * Status return values |
117 | */ | 117 | */ |
118 | enum bfa_status { | 118 | enum bfa_status { |
@@ -167,11 +167,11 @@ enum bfa_boolean { | |||
167 | #define BFA_STRING_32 32 | 167 | #define BFA_STRING_32 32 |
168 | #define BFA_VERSION_LEN 64 | 168 | #define BFA_VERSION_LEN 64 |
169 | 169 | ||
170 | /** | 170 | /* |
171 | * ---------------------- adapter definitions ------------ | 171 | * ---------------------- adapter definitions ------------ |
172 | */ | 172 | */ |
173 | 173 | ||
174 | /** | 174 | /* |
175 | * BFA adapter level attributes. | 175 | * BFA adapter level attributes. |
176 | */ | 176 | */ |
177 | enum { | 177 | enum { |
@@ -215,7 +215,7 @@ struct bfa_adapter_attr_s { | |||
215 | u8 trunk_capable; | 215 | u8 trunk_capable; |
216 | }; | 216 | }; |
217 | 217 | ||
218 | /** | 218 | /* |
219 | * ---------------------- IOC definitions ------------ | 219 | * ---------------------- IOC definitions ------------ |
220 | */ | 220 | */ |
221 | 221 | ||
@@ -224,7 +224,7 @@ enum { | |||
224 | BFA_IOC_CHIP_REV_LEN = 8, | 224 | BFA_IOC_CHIP_REV_LEN = 8, |
225 | }; | 225 | }; |
226 | 226 | ||
227 | /** | 227 | /* |
228 | * Driver and firmware versions. | 228 | * Driver and firmware versions. |
229 | */ | 229 | */ |
230 | struct bfa_ioc_driver_attr_s { | 230 | struct bfa_ioc_driver_attr_s { |
@@ -236,7 +236,7 @@ struct bfa_ioc_driver_attr_s { | |||
236 | char ob_ver[BFA_VERSION_LEN]; /* openboot version */ | 236 | char ob_ver[BFA_VERSION_LEN]; /* openboot version */ |
237 | }; | 237 | }; |
238 | 238 | ||
239 | /** | 239 | /* |
240 | * IOC PCI device attributes | 240 | * IOC PCI device attributes |
241 | */ | 241 | */ |
242 | struct bfa_ioc_pci_attr_s { | 242 | struct bfa_ioc_pci_attr_s { |
@@ -249,7 +249,7 @@ struct bfa_ioc_pci_attr_s { | |||
249 | char chip_rev[BFA_IOC_CHIP_REV_LEN]; /* chip revision */ | 249 | char chip_rev[BFA_IOC_CHIP_REV_LEN]; /* chip revision */ |
250 | }; | 250 | }; |
251 | 251 | ||
252 | /** | 252 | /* |
253 | * IOC states | 253 | * IOC states |
254 | */ | 254 | */ |
255 | enum bfa_ioc_state { | 255 | enum bfa_ioc_state { |
@@ -267,7 +267,7 @@ enum bfa_ioc_state { | |||
267 | BFA_IOC_ENABLING = 12, /* IOC is being enabled */ | 267 | BFA_IOC_ENABLING = 12, /* IOC is being enabled */ |
268 | }; | 268 | }; |
269 | 269 | ||
270 | /** | 270 | /* |
271 | * IOC firmware stats | 271 | * IOC firmware stats |
272 | */ | 272 | */ |
273 | struct bfa_fw_ioc_stats_s { | 273 | struct bfa_fw_ioc_stats_s { |
@@ -279,7 +279,7 @@ struct bfa_fw_ioc_stats_s { | |||
279 | u32 unknown_reqs; | 279 | u32 unknown_reqs; |
280 | }; | 280 | }; |
281 | 281 | ||
282 | /** | 282 | /* |
283 | * IOC driver stats | 283 | * IOC driver stats |
284 | */ | 284 | */ |
285 | struct bfa_ioc_drv_stats_s { | 285 | struct bfa_ioc_drv_stats_s { |
@@ -296,7 +296,7 @@ struct bfa_ioc_drv_stats_s { | |||
296 | u32 enable_replies; | 296 | u32 enable_replies; |
297 | }; | 297 | }; |
298 | 298 | ||
299 | /** | 299 | /* |
300 | * IOC statistics | 300 | * IOC statistics |
301 | */ | 301 | */ |
302 | struct bfa_ioc_stats_s { | 302 | struct bfa_ioc_stats_s { |
@@ -310,7 +310,7 @@ enum bfa_ioc_type_e { | |||
310 | BFA_IOC_TYPE_LL = 3, | 310 | BFA_IOC_TYPE_LL = 3, |
311 | }; | 311 | }; |
312 | 312 | ||
313 | /** | 313 | /* |
314 | * IOC attributes returned in queries | 314 | * IOC attributes returned in queries |
315 | */ | 315 | */ |
316 | struct bfa_ioc_attr_s { | 316 | struct bfa_ioc_attr_s { |
@@ -323,11 +323,11 @@ struct bfa_ioc_attr_s { | |||
323 | u8 rsvd[7]; /* 64bit align */ | 323 | u8 rsvd[7]; /* 64bit align */ |
324 | }; | 324 | }; |
325 | 325 | ||
326 | /** | 326 | /* |
327 | * ---------------------- mfg definitions ------------ | 327 | * ---------------------- mfg definitions ------------ |
328 | */ | 328 | */ |
329 | 329 | ||
330 | /** | 330 | /* |
331 | * Checksum size | 331 | * Checksum size |
332 | */ | 332 | */ |
333 | #define BFA_MFG_CHKSUM_SIZE 16 | 333 | #define BFA_MFG_CHKSUM_SIZE 16 |
@@ -340,7 +340,7 @@ struct bfa_ioc_attr_s { | |||
340 | 340 | ||
341 | #pragma pack(1) | 341 | #pragma pack(1) |
342 | 342 | ||
343 | /** | 343 | /* |
344 | * All numerical fields are in big-endian format. | 344 | * All numerical fields are in big-endian format. |
345 | */ | 345 | */ |
346 | struct bfa_mfg_block_s { | 346 | struct bfa_mfg_block_s { |
@@ -373,11 +373,11 @@ struct bfa_mfg_block_s { | |||
373 | 373 | ||
374 | #pragma pack() | 374 | #pragma pack() |
375 | 375 | ||
376 | /** | 376 | /* |
377 | * ---------------------- pci definitions ------------ | 377 | * ---------------------- pci definitions ------------ |
378 | */ | 378 | */ |
379 | 379 | ||
380 | /** | 380 | /* |
381 | * PCI device and vendor ID information | 381 | * PCI device and vendor ID information |
382 | */ | 382 | */ |
383 | enum { | 383 | enum { |
@@ -392,14 +392,14 @@ enum { | |||
392 | ((devid) == BFA_PCI_DEVICE_ID_CT || \ | 392 | ((devid) == BFA_PCI_DEVICE_ID_CT || \ |
393 | (devid) == BFA_PCI_DEVICE_ID_CT_FC) | 393 | (devid) == BFA_PCI_DEVICE_ID_CT_FC) |
394 | 394 | ||
395 | /** | 395 | /* |
396 | * PCI sub-system device and vendor ID information | 396 | * PCI sub-system device and vendor ID information |
397 | */ | 397 | */ |
398 | enum { | 398 | enum { |
399 | BFA_PCI_FCOE_SSDEVICE_ID = 0x14, | 399 | BFA_PCI_FCOE_SSDEVICE_ID = 0x14, |
400 | }; | 400 | }; |
401 | 401 | ||
402 | /** | 402 | /* |
403 | * Maximum number of device address ranges mapped through different BAR(s) | 403 | * Maximum number of device address ranges mapped through different BAR(s) |
404 | */ | 404 | */ |
405 | #define BFA_PCI_ACCESS_RANGES 1 | 405 | #define BFA_PCI_ACCESS_RANGES 1 |
@@ -430,7 +430,7 @@ enum { | |||
430 | #define BOOT_CFG_REV1 1 | 430 | #define BOOT_CFG_REV1 1 |
431 | #define BOOT_CFG_VLAN 1 | 431 | #define BOOT_CFG_VLAN 1 |
432 | 432 | ||
433 | /** | 433 | /* |
434 | * Boot options setting. Boot options setting determines from where | 434 | * Boot options setting. Boot options setting determines from where |
435 | * to get the boot lun information | 435 | * to get the boot lun information |
436 | */ | 436 | */ |
@@ -442,7 +442,7 @@ enum bfa_boot_bootopt { | |||
442 | }; | 442 | }; |
443 | 443 | ||
444 | #pragma pack(1) | 444 | #pragma pack(1) |
445 | /** | 445 | /* |
446 | * Boot lun information. | 446 | * Boot lun information. |
447 | */ | 447 | */ |
448 | struct bfa_boot_bootlun_s { | 448 | struct bfa_boot_bootlun_s { |
@@ -451,7 +451,7 @@ struct bfa_boot_bootlun_s { | |||
451 | }; | 451 | }; |
452 | #pragma pack() | 452 | #pragma pack() |
453 | 453 | ||
454 | /** | 454 | /* |
455 | * BOOT boot configuraton | 455 | * BOOT boot configuraton |
456 | */ | 456 | */ |
457 | struct bfa_boot_pbc_s { | 457 | struct bfa_boot_pbc_s { |