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_fcs.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_fcs.h')
-rw-r--r-- | drivers/scsi/bfa/bfa_defs_fcs.h | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/drivers/scsi/bfa/bfa_defs_fcs.h b/drivers/scsi/bfa/bfa_defs_fcs.h index ae06258bda0b..191d34a58b9c 100644 --- a/drivers/scsi/bfa/bfa_defs_fcs.h +++ b/drivers/scsi/bfa/bfa_defs_fcs.h | |||
@@ -21,7 +21,7 @@ | |||
21 | #include "bfa_fc.h" | 21 | #include "bfa_fc.h" |
22 | #include "bfa_defs_svc.h" | 22 | #include "bfa_defs_svc.h" |
23 | 23 | ||
24 | /** | 24 | /* |
25 | * VF states | 25 | * VF states |
26 | */ | 26 | */ |
27 | enum bfa_vf_state { | 27 | enum bfa_vf_state { |
@@ -35,7 +35,7 @@ enum bfa_vf_state { | |||
35 | BFA_VF_ISOLATED = 7, /* port isolated due to vf_id mismatch */ | 35 | BFA_VF_ISOLATED = 7, /* port isolated due to vf_id mismatch */ |
36 | }; | 36 | }; |
37 | 37 | ||
38 | /** | 38 | /* |
39 | * VF statistics | 39 | * VF statistics |
40 | */ | 40 | */ |
41 | struct bfa_vf_stats_s { | 41 | struct bfa_vf_stats_s { |
@@ -55,7 +55,7 @@ struct bfa_vf_stats_s { | |||
55 | u32 resvd; /* padding for 64 bit alignment */ | 55 | u32 resvd; /* padding for 64 bit alignment */ |
56 | }; | 56 | }; |
57 | 57 | ||
58 | /** | 58 | /* |
59 | * VF attributes returned in queries | 59 | * VF attributes returned in queries |
60 | */ | 60 | */ |
61 | struct bfa_vf_attr_s { | 61 | struct bfa_vf_attr_s { |
@@ -67,7 +67,7 @@ struct bfa_vf_attr_s { | |||
67 | #define BFA_FCS_MAX_LPORTS 256 | 67 | #define BFA_FCS_MAX_LPORTS 256 |
68 | #define BFA_FCS_FABRIC_IPADDR_SZ 16 | 68 | #define BFA_FCS_FABRIC_IPADDR_SZ 16 |
69 | 69 | ||
70 | /** | 70 | /* |
71 | * symbolic names for base port/virtual port | 71 | * symbolic names for base port/virtual port |
72 | */ | 72 | */ |
73 | #define BFA_SYMNAME_MAXLEN 128 /* 128 bytes */ | 73 | #define BFA_SYMNAME_MAXLEN 128 /* 128 bytes */ |
@@ -75,7 +75,7 @@ struct bfa_lport_symname_s { | |||
75 | char symname[BFA_SYMNAME_MAXLEN]; | 75 | char symname[BFA_SYMNAME_MAXLEN]; |
76 | }; | 76 | }; |
77 | 77 | ||
78 | /** | 78 | /* |
79 | * Roles of FCS port: | 79 | * Roles of FCS port: |
80 | * - FCP IM and FCP TM roles cannot be enabled together for a FCS port | 80 | * - FCP IM and FCP TM roles cannot be enabled together for a FCS port |
81 | * - Create multiple ports if both IM and TM functions required. | 81 | * - Create multiple ports if both IM and TM functions required. |
@@ -86,7 +86,7 @@ enum bfa_lport_role { | |||
86 | BFA_LPORT_ROLE_FCP_MAX = BFA_LPORT_ROLE_FCP_IM, | 86 | BFA_LPORT_ROLE_FCP_MAX = BFA_LPORT_ROLE_FCP_IM, |
87 | }; | 87 | }; |
88 | 88 | ||
89 | /** | 89 | /* |
90 | * FCS port configuration. | 90 | * FCS port configuration. |
91 | */ | 91 | */ |
92 | struct bfa_lport_cfg_s { | 92 | struct bfa_lport_cfg_s { |
@@ -98,7 +98,7 @@ struct bfa_lport_cfg_s { | |||
98 | u8 tag[16]; /* opaque tag from application */ | 98 | u8 tag[16]; /* opaque tag from application */ |
99 | }; | 99 | }; |
100 | 100 | ||
101 | /** | 101 | /* |
102 | * FCS port states | 102 | * FCS port states |
103 | */ | 103 | */ |
104 | enum bfa_lport_state { | 104 | enum bfa_lport_state { |
@@ -108,7 +108,7 @@ enum bfa_lport_state { | |||
108 | BFA_LPORT_OFFLINE = 3, /* No login to fabric */ | 108 | BFA_LPORT_OFFLINE = 3, /* No login to fabric */ |
109 | }; | 109 | }; |
110 | 110 | ||
111 | /** | 111 | /* |
112 | * FCS port type. | 112 | * FCS port type. |
113 | */ | 113 | */ |
114 | enum bfa_lport_type { | 114 | enum bfa_lport_type { |
@@ -116,7 +116,7 @@ enum bfa_lport_type { | |||
116 | BFA_LPORT_TYPE_VIRTUAL, | 116 | BFA_LPORT_TYPE_VIRTUAL, |
117 | }; | 117 | }; |
118 | 118 | ||
119 | /** | 119 | /* |
120 | * FCS port offline reason. | 120 | * FCS port offline reason. |
121 | */ | 121 | */ |
122 | enum bfa_lport_offline_reason { | 122 | enum bfa_lport_offline_reason { |
@@ -128,7 +128,7 @@ enum bfa_lport_offline_reason { | |||
128 | BFA_LPORT_OFFLINE_FAB_LOGOUT, | 128 | BFA_LPORT_OFFLINE_FAB_LOGOUT, |
129 | }; | 129 | }; |
130 | 130 | ||
131 | /** | 131 | /* |
132 | * FCS lport info. | 132 | * FCS lport info. |
133 | */ | 133 | */ |
134 | struct bfa_lport_info_s { | 134 | struct bfa_lport_info_s { |
@@ -150,7 +150,7 @@ struct bfa_lport_info_s { | |||
150 | 150 | ||
151 | }; | 151 | }; |
152 | 152 | ||
153 | /** | 153 | /* |
154 | * FCS port statistics | 154 | * FCS port statistics |
155 | */ | 155 | */ |
156 | struct bfa_lport_stats_s { | 156 | struct bfa_lport_stats_s { |
@@ -222,7 +222,7 @@ struct bfa_lport_stats_s { | |||
222 | * (max retry of plogi) */ | 222 | * (max retry of plogi) */ |
223 | }; | 223 | }; |
224 | 224 | ||
225 | /** | 225 | /* |
226 | * BFA port attribute returned in queries | 226 | * BFA port attribute returned in queries |
227 | */ | 227 | */ |
228 | struct bfa_lport_attr_s { | 228 | struct bfa_lport_attr_s { |
@@ -239,7 +239,7 @@ struct bfa_lport_attr_s { | |||
239 | }; | 239 | }; |
240 | 240 | ||
241 | 241 | ||
242 | /** | 242 | /* |
243 | * VPORT states | 243 | * VPORT states |
244 | */ | 244 | */ |
245 | enum bfa_vport_state { | 245 | enum bfa_vport_state { |
@@ -258,7 +258,7 @@ enum bfa_vport_state { | |||
258 | BFA_FCS_VPORT_MAX_STATE, | 258 | BFA_FCS_VPORT_MAX_STATE, |
259 | }; | 259 | }; |
260 | 260 | ||
261 | /** | 261 | /* |
262 | * vport statistics | 262 | * vport statistics |
263 | */ | 263 | */ |
264 | struct bfa_vport_stats_s { | 264 | struct bfa_vport_stats_s { |
@@ -296,7 +296,7 @@ struct bfa_vport_stats_s { | |||
296 | u32 rsvd; | 296 | u32 rsvd; |
297 | }; | 297 | }; |
298 | 298 | ||
299 | /** | 299 | /* |
300 | * BFA vport attribute returned in queries | 300 | * BFA vport attribute returned in queries |
301 | */ | 301 | */ |
302 | struct bfa_vport_attr_s { | 302 | struct bfa_vport_attr_s { |
@@ -305,7 +305,7 @@ struct bfa_vport_attr_s { | |||
305 | u32 rsvd; | 305 | u32 rsvd; |
306 | }; | 306 | }; |
307 | 307 | ||
308 | /** | 308 | /* |
309 | * FCS remote port states | 309 | * FCS remote port states |
310 | */ | 310 | */ |
311 | enum bfa_rport_state { | 311 | enum bfa_rport_state { |
@@ -321,7 +321,7 @@ enum bfa_rport_state { | |||
321 | BFA_RPORT_NSDISC = 9, /* re-discover rport */ | 321 | BFA_RPORT_NSDISC = 9, /* re-discover rport */ |
322 | }; | 322 | }; |
323 | 323 | ||
324 | /** | 324 | /* |
325 | * Rport Scsi Function : Initiator/Target. | 325 | * Rport Scsi Function : Initiator/Target. |
326 | */ | 326 | */ |
327 | enum bfa_rport_function { | 327 | enum bfa_rport_function { |
@@ -329,7 +329,7 @@ enum bfa_rport_function { | |||
329 | BFA_RPORT_TARGET = 0x02, /* SCSI Target */ | 329 | BFA_RPORT_TARGET = 0x02, /* SCSI Target */ |
330 | }; | 330 | }; |
331 | 331 | ||
332 | /** | 332 | /* |
333 | * port/node symbolic names for rport | 333 | * port/node symbolic names for rport |
334 | */ | 334 | */ |
335 | #define BFA_RPORT_SYMNAME_MAXLEN 255 | 335 | #define BFA_RPORT_SYMNAME_MAXLEN 255 |
@@ -337,7 +337,7 @@ struct bfa_rport_symname_s { | |||
337 | char symname[BFA_RPORT_SYMNAME_MAXLEN]; | 337 | char symname[BFA_RPORT_SYMNAME_MAXLEN]; |
338 | }; | 338 | }; |
339 | 339 | ||
340 | /** | 340 | /* |
341 | * FCS remote port statistics | 341 | * FCS remote port statistics |
342 | */ | 342 | */ |
343 | struct bfa_rport_stats_s { | 343 | struct bfa_rport_stats_s { |
@@ -374,7 +374,7 @@ struct bfa_rport_stats_s { | |||
374 | struct bfa_rport_hal_stats_s hal_stats; /* BFA rport stats */ | 374 | struct bfa_rport_hal_stats_s hal_stats; /* BFA rport stats */ |
375 | }; | 375 | }; |
376 | 376 | ||
377 | /** | 377 | /* |
378 | * FCS remote port attributes returned in queries | 378 | * FCS remote port attributes returned in queries |
379 | */ | 379 | */ |
380 | struct bfa_rport_attr_s { | 380 | struct bfa_rport_attr_s { |
@@ -411,7 +411,7 @@ struct bfa_rport_remote_link_stats_s { | |||
411 | #define BFA_MAX_IO_INDEX 7 | 411 | #define BFA_MAX_IO_INDEX 7 |
412 | #define BFA_NO_IO_INDEX 9 | 412 | #define BFA_NO_IO_INDEX 9 |
413 | 413 | ||
414 | /** | 414 | /* |
415 | * FCS itnim states | 415 | * FCS itnim states |
416 | */ | 416 | */ |
417 | enum bfa_itnim_state { | 417 | enum bfa_itnim_state { |
@@ -425,7 +425,7 @@ enum bfa_itnim_state { | |||
425 | BFA_ITNIM_INITIATIOR = 7, /* initiator */ | 425 | BFA_ITNIM_INITIATIOR = 7, /* initiator */ |
426 | }; | 426 | }; |
427 | 427 | ||
428 | /** | 428 | /* |
429 | * FCS remote port statistics | 429 | * FCS remote port statistics |
430 | */ | 430 | */ |
431 | struct bfa_itnim_stats_s { | 431 | struct bfa_itnim_stats_s { |
@@ -443,7 +443,7 @@ struct bfa_itnim_stats_s { | |||
443 | u32 rsvd; /* padding for 64 bit alignment */ | 443 | u32 rsvd; /* padding for 64 bit alignment */ |
444 | }; | 444 | }; |
445 | 445 | ||
446 | /** | 446 | /* |
447 | * FCS itnim attributes returned in queries | 447 | * FCS itnim attributes returned in queries |
448 | */ | 448 | */ |
449 | struct bfa_itnim_attr_s { | 449 | struct bfa_itnim_attr_s { |