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_mbox.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_mbox.h')
-rw-r--r-- | drivers/scsi/megaraid/megaraid_mbox.h | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/drivers/scsi/megaraid/megaraid_mbox.h b/drivers/scsi/megaraid/megaraid_mbox.h index 963e0d2dbd97..9de803cebd4b 100644 --- a/drivers/scsi/megaraid/megaraid_mbox.h +++ b/drivers/scsi/megaraid/megaraid_mbox.h | |||
@@ -146,27 +146,27 @@ typedef struct { | |||
146 | 146 | ||
147 | /** | 147 | /** |
148 | * mraid_device_t - adapter soft state structure for mailbox controllers | 148 | * mraid_device_t - adapter soft state structure for mailbox controllers |
149 | * @param una_mbox64 : 64-bit mbox - unaligned | 149 | * @una_mbox64 : 64-bit mbox - unaligned |
150 | * @param una_mbox64_dma : mbox dma addr - unaligned | 150 | * @una_mbox64_dma : mbox dma addr - unaligned |
151 | * @param mbox : 32-bit mbox - aligned | 151 | * @mbox : 32-bit mbox - aligned |
152 | * @param mbox64 : 64-bit mbox - aligned | 152 | * @mbox64 : 64-bit mbox - aligned |
153 | * @param mbox_dma : mbox dma addr - aligned | 153 | * @mbox_dma : mbox dma addr - aligned |
154 | * @param mailbox_lock : exclusion lock for the mailbox | 154 | * @mailbox_lock : exclusion lock for the mailbox |
155 | * @param baseport : base port of hba memory | 155 | * @baseport : base port of hba memory |
156 | * @param baseaddr : mapped addr of hba memory | 156 | * @baseaddr : mapped addr of hba memory |
157 | * @param mbox_pool : pool of mailboxes | 157 | * @mbox_pool : pool of mailboxes |
158 | * @param mbox_pool_handle : handle for the mailbox pool memory | 158 | * @mbox_pool_handle : handle for the mailbox pool memory |
159 | * @param epthru_pool : a pool for extended passthru commands | 159 | * @epthru_pool : a pool for extended passthru commands |
160 | * @param epthru_pool_handle : handle to the pool above | 160 | * @epthru_pool_handle : handle to the pool above |
161 | * @param sg_pool : pool of scatter-gather lists for this driver | 161 | * @sg_pool : pool of scatter-gather lists for this driver |
162 | * @param sg_pool_handle : handle to the pool above | 162 | * @sg_pool_handle : handle to the pool above |
163 | * @param ccb_list : list of our command control blocks | 163 | * @ccb_list : list of our command control blocks |
164 | * @param uccb_list : list of cmd control blocks for mgmt module | 164 | * @uccb_list : list of cmd control blocks for mgmt module |
165 | * @param umbox64 : array of mailbox for user commands (cmm) | 165 | * @umbox64 : array of mailbox for user commands (cmm) |
166 | * @param pdrv_state : array for state of each physical drive. | 166 | * @pdrv_state : array for state of each physical drive. |
167 | * @param last_disp : flag used to show device scanning | 167 | * @last_disp : flag used to show device scanning |
168 | * @param hw_error : set if FW not responding | 168 | * @hw_error : set if FW not responding |
169 | * @param fast_load : If set, skip physical device scanning | 169 | * @fast_load : If set, skip physical device scanning |
170 | * @channel_class : channel class, RAID or SCSI | 170 | * @channel_class : channel class, RAID or SCSI |
171 | * @sysfs_sem : semaphore to serialize access to sysfs res. | 171 | * @sysfs_sem : semaphore to serialize access to sysfs res. |
172 | * @sysfs_uioc : management packet to issue FW calls from sysfs | 172 | * @sysfs_uioc : management packet to issue FW calls from sysfs |