[SCSI] Add Documentation and integrate into docbook build
Add Documentation/DocBook/scsi_midlayer.tmpl, add to Makefile, and update lots of kerneldoc comments in drivers/scsi/*. Updated with comments from Stefan Richter, Stephen M. Cameron, James Bottomley and Randy Dunlap. Signed-off-by: Rob Landley <rob@landley.net> Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
This commit is contained in:

committed by
James Bottomley

parent
3f48985823
commit
eb44820c28
@@ -174,10 +174,15 @@ static int scsi_ioctl_get_pci(struct scsi_device *sdev, void __user *arg)
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* the scsi_ioctl() function differs from most ioctls in that it does
|
||||
* not take a major/minor number as the dev field. Rather, it takes
|
||||
* a pointer to a scsi_devices[] element, a structure.
|
||||
/**
|
||||
* scsi_ioctl - Dispatch ioctl to scsi device
|
||||
* @sdev: scsi device receiving ioctl
|
||||
* @cmd: which ioctl is it
|
||||
* @arg: data associated with ioctl
|
||||
*
|
||||
* Description: The scsi_ioctl() function differs from most ioctls in that it
|
||||
* does not take a major/minor number as the dev field. Rather, it takes
|
||||
* a pointer to a &struct scsi_device.
|
||||
*/
|
||||
int scsi_ioctl(struct scsi_device *sdev, int cmd, void __user *arg)
|
||||
{
|
||||
@@ -264,9 +269,12 @@ int scsi_ioctl(struct scsi_device *sdev, int cmd, void __user *arg)
|
||||
}
|
||||
EXPORT_SYMBOL(scsi_ioctl);
|
||||
|
||||
/*
|
||||
* the scsi_nonblock_ioctl() function is designed for ioctls which may
|
||||
* be executed even if the device is in recovery.
|
||||
/**
|
||||
* scsi_nonblock_ioctl() - Handle SG_SCSI_RESET
|
||||
* @sdev: scsi device receiving ioctl
|
||||
* @cmd: Must be SC_SCSI_RESET
|
||||
* @arg: pointer to int containing SG_SCSI_RESET_{DEVICE,BUS,HOST}
|
||||
* @filp: either NULL or a &struct file which must have the O_NONBLOCK flag.
|
||||
*/
|
||||
int scsi_nonblockable_ioctl(struct scsi_device *sdev, int cmd,
|
||||
void __user *arg, struct file *filp)
|
||||
@@ -276,7 +284,7 @@ int scsi_nonblockable_ioctl(struct scsi_device *sdev, int cmd,
|
||||
/* The first set of iocts may be executed even if we're doing
|
||||
* error processing, as long as the device was opened
|
||||
* non-blocking */
|
||||
if (filp && filp->f_flags & O_NONBLOCK) {
|
||||
if (filp && (filp->f_flags & O_NONBLOCK)) {
|
||||
if (scsi_host_in_recovery(sdev->host))
|
||||
return -ENODEV;
|
||||
} else if (!scsi_block_when_processing_errors(sdev))
|
||||
|
Reference in New Issue
Block a user