diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-01-06 01:41:48 -0500 |
---|---|---|
committer | James Bottomley <jejb@mulgrave.il.steeleye.com> | 2007-01-13 14:55:01 -0500 |
commit | a69b74d39f50b3e3ca9a6641bd71f3fc55d32d98 (patch) | |
tree | f7563f5bac36a2bfcc93d488364263a66d450436 /drivers/scsi/megaraid/megaraid_sas.h | |
parent | cd96d96f20f2509dfeb302548132e30f471c071a (diff) |
[SCSI] megaraid: fix kernel-doc
kernel-doc modifications:
- change "@param var" notation to @var;
- change function/description separator from ':' to '-';
- change var/description separator from '-' to ':';
- fix a few doc. typos;
- don't use kernel-doc /** lead-in when the doc. block is not kernel-doc;
- use Linux common */ ending comment format instead of **/;
- use correct function parameter names;
- place function parameters immediately after the function short description;
- place kernel-doc immediately before its function or macro;
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Acked-by: Sumant Patro <sumantp@lsil.com>
Signed-off-by: James Bottomley <James.Bottomley@SteelEye.com>
Diffstat (limited to 'drivers/scsi/megaraid/megaraid_sas.h')
-rw-r--r-- | drivers/scsi/megaraid/megaraid_sas.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/drivers/scsi/megaraid/megaraid_sas.h b/drivers/scsi/megaraid/megaraid_sas.h index 55eddcf8eb1..cacb3ad9252 100644 --- a/drivers/scsi/megaraid/megaraid_sas.h +++ b/drivers/scsi/megaraid/megaraid_sas.h | |||
@@ -15,7 +15,7 @@ | |||
15 | #ifndef LSI_MEGARAID_SAS_H | 15 | #ifndef LSI_MEGARAID_SAS_H |
16 | #define LSI_MEGARAID_SAS_H | 16 | #define LSI_MEGARAID_SAS_H |
17 | 17 | ||
18 | /** | 18 | /* |
19 | * MegaRAID SAS Driver meta data | 19 | * MegaRAID SAS Driver meta data |
20 | */ | 20 | */ |
21 | #define MEGASAS_VERSION "00.00.03.05" | 21 | #define MEGASAS_VERSION "00.00.03.05" |
@@ -40,7 +40,7 @@ | |||
40 | * "message frames" | 40 | * "message frames" |
41 | */ | 41 | */ |
42 | 42 | ||
43 | /** | 43 | /* |
44 | * FW posts its state in upper 4 bits of outbound_msg_0 register | 44 | * FW posts its state in upper 4 bits of outbound_msg_0 register |
45 | */ | 45 | */ |
46 | #define MFI_STATE_MASK 0xF0000000 | 46 | #define MFI_STATE_MASK 0xF0000000 |
@@ -58,7 +58,7 @@ | |||
58 | 58 | ||
59 | #define MEGAMFI_FRAME_SIZE 64 | 59 | #define MEGAMFI_FRAME_SIZE 64 |
60 | 60 | ||
61 | /** | 61 | /* |
62 | * During FW init, clear pending cmds & reset state using inbound_msg_0 | 62 | * During FW init, clear pending cmds & reset state using inbound_msg_0 |
63 | * | 63 | * |
64 | * ABORT : Abort all pending cmds | 64 | * ABORT : Abort all pending cmds |
@@ -78,7 +78,7 @@ | |||
78 | MFI_INIT_MFIMODE| \ | 78 | MFI_INIT_MFIMODE| \ |
79 | MFI_INIT_ABORT | 79 | MFI_INIT_ABORT |
80 | 80 | ||
81 | /** | 81 | /* |
82 | * MFI frame flags | 82 | * MFI frame flags |
83 | */ | 83 | */ |
84 | #define MFI_FRAME_POST_IN_REPLY_QUEUE 0x0000 | 84 | #define MFI_FRAME_POST_IN_REPLY_QUEUE 0x0000 |
@@ -92,12 +92,12 @@ | |||
92 | #define MFI_FRAME_DIR_READ 0x0010 | 92 | #define MFI_FRAME_DIR_READ 0x0010 |
93 | #define MFI_FRAME_DIR_BOTH 0x0018 | 93 | #define MFI_FRAME_DIR_BOTH 0x0018 |
94 | 94 | ||
95 | /** | 95 | /* |
96 | * Definition for cmd_status | 96 | * Definition for cmd_status |
97 | */ | 97 | */ |
98 | #define MFI_CMD_STATUS_POLL_MODE 0xFF | 98 | #define MFI_CMD_STATUS_POLL_MODE 0xFF |
99 | 99 | ||
100 | /** | 100 | /* |
101 | * MFI command opcodes | 101 | * MFI command opcodes |
102 | */ | 102 | */ |
103 | #define MFI_CMD_INIT 0x00 | 103 | #define MFI_CMD_INIT 0x00 |
@@ -128,7 +128,7 @@ | |||
128 | #define MR_DCMD_CLUSTER_RESET_ALL 0x08010100 | 128 | #define MR_DCMD_CLUSTER_RESET_ALL 0x08010100 |
129 | #define MR_DCMD_CLUSTER_RESET_LD 0x08010200 | 129 | #define MR_DCMD_CLUSTER_RESET_LD 0x08010200 |
130 | 130 | ||
131 | /** | 131 | /* |
132 | * MFI command completion codes | 132 | * MFI command completion codes |
133 | */ | 133 | */ |
134 | enum MFI_STAT { | 134 | enum MFI_STAT { |