kernel-doc: fix fusion and i2o docs
PATCH 2/3 kernel-doc: fix fusion and i2o docs
From: Randy Dunlap <[email protected]>
Correct lots of typos, kernel-doc warnings, & kernel-doc usage in fusion and i2o drivers.
Signed-off-by Randy Dunlap <[email protected]>
--- drivers/message/fusion/mptbase.c | 255 ++++++++++++++++++++------------------ drivers/message/fusion/mptfc.c | 5 drivers/message/fusion/mptscsih.c | 24 +-- drivers/message/fusion/mptspi.c | 4 drivers/message/i2o/bus-osm.c | 3 drivers/message/i2o/device.c | 8 - drivers/message/i2o/driver.c | 20 +- drivers/message/i2o/exec-osm.c | 10 - drivers/message/i2o/i2o_block.c | 17 +- drivers/message/i2o/i2o_proc.c | 2 drivers/message/i2o/i2o_scsi.c | 11 - drivers/message/i2o/pci.c | 5 include/linux/i2o.h | 18 +- 13 files changed, 204 insertions(+), 178 deletions(-)
include/linux/i2o.h +11 -7
@@ -986,7 +986,8 @@ extern void i2o_driver_unregister(struct/** * i2o_driver_notify_controller_add - Send notification of added controller -* to a single I2O driver +* @drv: I2O driver +* @c: I2O controller * * Send notification of added controller to a single registered driver. */
@@ -998,8 +999,9 @@ static inline void i2o_driver_notify_con };/** -* i2o_driver_notify_controller_remove - Send notification of removed -* controller to a single I2O driver +* i2o_driver_notify_controller_remove - Send notification of removed controller +* @drv: I2O driver +* @c: I2O controller * * Send notification of removed controller to a single registered driver. */
@@ -1011,8 +1013,9 @@ static inline void i2o_driver_notify_con };/** -* i2o_driver_notify_device_add - Send notification of added device to a -* single I2O driver +* i2o_driver_notify_device_add - Send notification of added device +* @drv: I2O driver +* @i2o_dev: the added i2o_device * * Send notification of added device to a single registered driver. */
@@ -1025,7 +1028,8 @@ static inline void i2o_driver_notify_dev/** * i2o_driver_notify_device_remove - Send notification of removed device -* to a single I2O driver +* @drv: I2O driver +* @i2o_dev: the added i2o_device * * Send notification of removed device to a single registered driver. */
@@ -1148,7 +1152,7 @@ static inline void i2o_msg_post(struct i/** * i2o_msg_post_wait - Post and wait a message and wait until return * @c: controller -* @m: message to post +* @msg: message to post * @timeout: time in seconds to wait * * This API allows an OSM to post a message and then be told whether or
drivers/message/i2o/bus-osm.c +3 -0
@@ -56,6 +56,9 @@ static int i2o_bus_scan(struct i2o_devic/** * i2o_bus_store_scan - Scan the I2O Bus Adapter * @d: device which should be scanned +* @attr: device_attribute +* @buf: output buffer +* @count: buffer size * * Returns count. */
drivers/message/i2o/device.c +4 -4
@@ -54,8 +54,8 @@ static inline int i2o_device_issue_claim* @dev: I2O device to claim * @drv: I2O driver which wants to claim the device * -* Do the leg work to assign a device to a given OSM. If the claim succeed -* the owner of the rimary. If the attempt fails a negative errno code +* Do the leg work to assign a device to a given OSM. If the claim succeeds, +* the owner is the primary. If the attempt fails a negative errno code * is returned. On success zero is returned. */ int i2o_device_claim (struct i2o_device *dev)
@@ -208,7 +208,7 @@ static struct i2o_device *i2o_device_all/** * i2o_device_add - allocate a new I2O device and add it to the IOP -* @iop: I2O controller where the device is on +* @c: I2O controller that the device is on * @entry: LCT entry of the I2O device * * Allocate a new I2O device and initialize it with the LCT entry. The
@@ -275,7 +275,7 @@ static struct i2o_device *i2o_device_add/** * i2o_device_remove - remove an I2O device from the I2O core -* @dev: I2O device which should be released +* @i2o_dev: I2O device which should be released * * Is used on I2O controller removal or LCT modification, when the device * is removed from the system. Note that the device could still hang
drivers/message/i2o/driver.c +9 -11
@@ -34,9 +34,7 @@ static spinlock_t i2o_drivers_lock;static struct i2o_driver **i2o_drivers;/** -* i2o_bus_match - Tell if a I2O device class id match the class ids of -* the I2O driver (OSM) -* +* i2o_bus_match - Tell if I2O device class id matches the class ids of the I2O driver (OSM) * @dev: device which should be verified * @drv: the driver to match against *
@@ -248,7 +246,7 @@ int i2o_driver_dispatch(struct i2o_contr/** * i2o_driver_notify_controller_add_all - Send notify of added controller -* to all I2O drivers +* @c: newly added controller * * Send notifications to all registered drivers that a new controller was * added.
@@ -267,8 +265,8 @@ void i2o_driver_notify_controller_add_al }/** -* i2o_driver_notify_controller_remove_all - Send notify of removed -* controller to all I2O drivers +* i2o_driver_notify_controller_remove_all - Send notify of removed controller +* @c: controller that is being removed * * Send notifications to all registered drivers that a controller was * removed.
@@ -287,8 +285,8 @@ void i2o_driver_notify_controller_remove }/** -* i2o_driver_notify_device_add_all - Send notify of added device to all -* I2O drivers +* i2o_driver_notify_device_add_all - Send notify of added device +* @i2o_dev: newly added I2O device * * Send notifications to all registered drivers that a device was added. */
@@ -306,8 +304,8 @@ void i2o_driver_notify_device_add_all(st }/** -* i2o_driver_notify_device_remove_all - Send notify of removed device to -* all I2O drivers +* i2o_driver_notify_device_remove_all - Send notify of removed device +* @i2o_dev: device that is being removed * * Send notifications to all registered drivers that a device was removed. */
@@ -362,7 +360,7 @@ int __init i2o_driver_init(void)/** * i2o_driver_exit - clean up I2O drivers (OSMs) * -* Unregisters the I2O bus and free driver array. +* Unregisters the I2O bus and frees driver array. */ void __exit i2o_driver_exit(void) {
drivers/message/i2o/exec-osm.c +6 -4
@@ -94,8 +94,8 @@ static struct i2o_exec_wait *i2o_exec_wa };/** -* i2o_exec_wait_free - Free a i2o_exec_wait struct -* @i2o_exec_wait: I2O wait data which should be cleaned up +* i2o_exec_wait_free - Free an i2o_exec_wait struct +* @wait: I2O wait data which should be cleaned up */ static void i2o_exec_wait_free (struct i2o_exec_wait *wait) {
@@ -105,7 +105,7 @@ static void i2o_exec_wait_free(struct i2/** * i2o_msg_post_wait_mem - Post and wait a message with DMA buffers * @c: controller -* @m: message to post +* @msg: message to post * @timeout: time in seconds to wait * @dma: i2o_dma struct of the DMA buffer to free on failure *
@@ -269,6 +269,7 @@ static int i2o_msg_post_wait_complete(st/** * i2o_exec_show_vendor_id - Displays Vendor ID of controller * @d: device of which the Vendor ID should be displayed +* @attr: device_attribute to display * @buf: buffer into which the Vendor ID should be printed * * Returns number of bytes printed into buffer.
@@ -290,6 +291,7 @@ static ssize_t i2o_exec_show_vendor_id(s/** * i2o_exec_show_product_id - Displays Product ID of controller * @d: device of which the Product ID should be displayed +* @attr: device_attribute to display * @buf: buffer into which the Product ID should be printed * * Returns number of bytes printed into buffer.
@@ -365,7 +367,7 @@ static int i2o_exec_remove(struct device/** * i2o_exec_lct_modified - Called on LCT NOTIFY reply -* @c: I2O controller on which the LCT has modified +* @work: work struct for a specific controller * * This function handles asynchronus LCT NOTIFY replies. It parses the * new LCT and if the buffer for the LCT was to small sends a LCT NOTIFY
drivers/message/i2o/i2o_block.c +12 -5
@@ -259,7 +259,7 @@ static int i2o_block_device_unlock(struc/** * i2o_block_device_power - Power management for device dev * @dev: I2O device which should receive the power management request -* @operation: Operation which should be send +* @op: Operation to send * * Send a power management request to the device dev. *
@@ -315,7 +315,7 @@ static inline struct i2o_block_request ** i2o_block_request_free - Frees a I2O block request * @ireq: I2O block request which should be freed * -* Fres the allocated memory (give it back to the request mempool). +* Frees the allocated memory (give it back to the request mempool). */ static inline void i2o_block_request_free (struct i2o_block_request *ireq) {
@@ -326,6 +326,7 @@ static inline void i2o_block_request_fre* i2o_block_sglist_alloc - Allocate the SG list and map it * @c: I2O controller to which the request belongs * @ireq: I2O block request +* @mptr: message body pointer * * Builds the SG list and map it to be accessable by the controller. *
@@ -419,7 +420,7 @@ static int i2o_block_prep_req_fn(struct/** * i2o_block_delayed_request_fn - delayed request queue function -* delayed_request: the delayed request with the queue to start +* @delayed_request: the delayed request with the queue to start * * If the request queue is stopped for a disk, and there is no open * request, a new event is created, which calls this function to start
@@ -488,7 +489,7 @@ static void i2o_block_end_request(struct* i2o_block_reply - Block OSM reply handler. * @c: I2O controller from which the message arrives * @m: message id of reply -* qmsg: the actuall I2O message reply +* @msg: the actual I2O message reply * * This function gets all the message replies. *
@@ -599,6 +600,8 @@ static void i2o_block_biosparam(unsigned/** * i2o_block_open - Open the block device +* @inode: inode for block device being opened +* @file: file to open * * Power up the device, mount and lock the media. This function is called, * if the block device is opened for access.
@@ -626,6 +629,8 @@ static int i2o_block_open(struct inode */** * i2o_block_release - Release the I2O block device +* @inode: inode for block device being released +* @file: file to close * * Unlock and unmount the media, and power down the device. Gets called if * the block device is closed.
@@ -672,6 +677,8 @@ static int i2o_block_getgeo(struct block/** * i2o_block_ioctl - Issue device specific ioctl calls. +* @inode: inode for block device ioctl +* @file: file for ioctl * @cmd: ioctl command * @arg: arg *
@@ -899,7 +906,7 @@ static int i2o_block_transfer(struct req/** * i2o_block_request_fn - request queue handling function -* q: request queue from which the request could be fetched +* @q: request queue from which the request could be fetched * * Takes the next request from the queue, transfers it and if no error * occurs dequeue it from the queue. On arrival of the reply the message
drivers/message/i2o/pci.c +3 -2
@@ -259,6 +259,7 @@ static irqreturn_t i2o_pci_interrupt(int/** * i2o_pci_irq_enable - Allocate interrupt for I2O controller +* @c: i2o_controller that the request is for * * Allocate an interrupt for the I2O controller, and activate interrupts * on the I2O controller.
@@ -305,7 +306,7 @@ static void i2o_pci_irq_disable(struct i/** * i2o_pci_probe - Probe the PCI device for an I2O controller -* @dev: PCI device to test +* @pdev: PCI device to test * @id: id which matched with the PCI device id table * * Probe the PCI device for any device which is a memory of the
@@ -450,7 +451,7 @@ static int __devinit i2o_pci_probe(struc/** * i2o_pci_remove - Removes a I2O controller from the system -* pdev: I2O controller which should be removed +* @pdev: I2O controller which should be removed * * Reset the I2O controller, disable interrupts and remove all allocated * resources.
drivers/message/fusion/mptbase.c +137 -118
701 lines not on this page · raw message
drivers/message/fusion/mptscsih.c +11 -13
@@ -1230,15 +1230,15 @@ mptscsih_host_info(MPT_ADAPTER *ioc, cha/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** * mptscsih_proc_info - Return information about MPT adapter +* @host: scsi host struct +* @buffer: if write, user data; if read, buffer for user +* @start: returns the buffer address +* @offset: if write, 0; if read, the current offset into the buffer from +* the previous read. +* @length: if write, return length; +* @func: write = 1; read = 0 * * (linux scsi_host_template.info routine) -* -* buffer: if write, user data; if read, buffer for user -* length: if write, return length; -* offset: if write, 0; if read, the current offset into the buffer from -* the previous read. -* hostno: scsi host number -* func: if write = 1; if read = 0 */ int mptscsih_proc_info(struct Scsi_Host *host, char *buffer, char **start, off_t offset,
@@ -1902,8 +1902,7 @@ mptscsih_bus_reset(struct scsi_cmnd * SC/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** -* mptscsih_host_reset - Perform a SCSI host adapter RESET! -* new_eh variant +* mptscsih_host_reset - Perform a SCSI host adapter RESET (new_eh variant) * @SCpnt: Pointer to scsi_cmnd structure, IO which reset is due to * * (linux scsi_host_template.eh_host_reset_handler routine)
@@ -1949,8 +1948,7 @@ mptscsih_host_reset(struct scsi_cmnd *SC/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** -* mptscsih_tm_pending_wait - wait for pending task management request to -* complete. +* mptscsih_tm_pending_wait - wait for pending task management request to complete * @hd: Pointer to MPT host structure. * * Returns {SUCCESS,FAILED}.
@@ -1982,6 +1980,7 @@ mptscsih_tm_pending_wait(MPT_SCSI_HOST */** * mptscsih_tm_wait_for_completion - wait for completion of TM task * @hd: Pointer to MPT host structure. +* @timeout: timeout in seconds * * Returns {SUCCESS,FAILED}. */
@@ -3429,8 +3428,7 @@ mptscsih_do_cmd(MPT_SCSI_HOST *hd, INTER/** * mptscsih_synchronize_cache - Send SYNCHRONIZE_CACHE to all disks. * @hd: Pointer to a SCSI HOST structure -* @vtarget: per device private data -* @lun: lun +* @vdevice: virtual target device * * Uses the ISR, but with special processing. * MUST be single-threaded.
drivers/message/fusion/mptspi.c +1 -3
@@ -1098,8 +1098,7 @@ static struct pci_driver mptspi_driver =/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** -* mptspi_init - Register MPT adapter(s) as SCSI host(s) with -* linux scsi mid-layer. +* mptspi_init - Register MPT adapter(s) as SCSI host(s) with SCSI mid-layer. * * Returns 0 for success, non-zero for failure. */
@@ -1133,7 +1132,6 @@ mptspi_init(void)/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** * mptspi_exit - Unregisters MPT adapter(s) -* */ static void __exitmptspi_exit (void )
drivers/message/fusion/mptfc.c +2 -3
@@ -1393,8 +1393,7 @@ mptfc_ioc_reset(MPT_ADAPTER *ioc, int re/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** -* mptfc_init - Register MPT adapter(s) as SCSI host(s) with -* linux scsi mid-layer. +* mptfc_init - Register MPT adapter(s) as SCSI host(s) with SCSI mid-layer. * * Returns 0 for success, non-zero for failure. */
@@ -1438,7 +1437,7 @@ mptfc_init(void)/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ /** -* mptfc_remove - Removed fc infrastructure for devices +* mptfc_remove - Remove fc infrastructure for devices * @pdev: Pointer to pci_dev structure * */
drivers/message/i2o/i2o_scsi.c +4 -7
@@ -405,8 +405,7 @@ static void i2o_scsi_notify_device_add(s };/** -* i2o_scsi_notify_device_remove - Retrieve notifications of removed -* devices +* i2o_scsi_notify_device_remove - Retrieve notifications of removed devices * @i2o_dev: the I2O device which was removed * * If a I2O device is removed, we catch the notification to remove the
@@ -426,8 +425,7 @@ static void i2o_scsi_notify_device_remov };/** -* i2o_scsi_notify_controller_add - Retrieve notifications of added -* controllers +* i2o_scsi_notify_controller_add - Retrieve notifications of added controllers * @c: the controller which was added * * If a I2O controller is added, we catch the notification to add a
@@ -457,8 +455,7 @@ static void i2o_scsi_notify_controller_a };/** -* i2o_scsi_notify_controller_remove - Retrieve notifications of removed -* controllers +* i2o_scsi_notify_controller_remove - Retrieve notifications of removed controllers * @c: the controller which was removed * * If a I2O controller is removed, we catch the notification to remove the
@@ -745,7 +742,7 @@ static int i2o_scsi_abort(struct scsi_cm* @capacity: size in sectors * @ip: geometry array * -* This is anyones guess quite frankly. We use the same rules everyone +* This is anyone's guess quite frankly. We use the same rules everyone * else appears to and hope. It seems to work. */
drivers/message/i2o/i2o_proc.c +1 -1
@@ -163,7 +163,7 @@ static int print_serial_number(struct se* i2o_get_class_name - do i2o class name lookup * @class: class number * -* Return a descriptive string for an i2o class +* Return a descriptive string for an i2o class. */ static const char *i2o_get_class_name (int class) {
---