aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/scsi
diff options
context:
space:
mode:
authorChristoph Hellwig <hch@lst.de>2014-11-13 09:08:42 -0500
committerChristoph Hellwig <hch@lst.de>2014-11-24 08:45:27 -0500
commitdb5ed4dfd5dd0142ec36ff7b335e0ec3b836b3e6 (patch)
tree6cae824b5c9e5a7fd9d213e3f9c2b1c7dc8b7b8a /Documentation/scsi
parent1e6f2416044c062a56091ebf8d76760956dd5872 (diff)
scsi: drop reason argument from ->change_queue_depth
Drop the now unused reason argument from the ->change_queue_depth method. Also add a return value to scsi_adjust_queue_depth, and rename it to scsi_change_queue_depth now that it can be used as the default ->change_queue_depth implementation. Signed-off-by: Christoph Hellwig <hch@lst.de> Reviewed-by: Mike Christie <michaelc@cs.wisc.edu> Reviewed-by: Hannes Reinecke <hare@suse.de>
Diffstat (limited to 'Documentation/scsi')
-rw-r--r--Documentation/scsi/scsi_mid_low_api.txt20
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/scsi/scsi_mid_low_api.txt b/Documentation/scsi/scsi_mid_low_api.txt
index bee7d86b9dcc..731bc4f4c5e6 100644
--- a/Documentation/scsi/scsi_mid_low_api.txt
+++ b/Documentation/scsi/scsi_mid_low_api.txt
@@ -149,7 +149,7 @@ scsi_add_host() ---->
149scsi_scan_host() -------+ 149scsi_scan_host() -------+
150 | 150 |
151 slave_alloc() 151 slave_alloc()
152 slave_configure() --> scsi_adjust_queue_depth() 152 slave_configure() --> scsi_change_queue_depth()
153 | 153 |
154 slave_alloc() 154 slave_alloc()
155 slave_configure() 155 slave_configure()
@@ -159,7 +159,7 @@ scsi_scan_host() -------+
159------------------------------------------------------------ 159------------------------------------------------------------
160 160
161If the LLD wants to adjust the default queue settings, it can invoke 161If the LLD wants to adjust the default queue settings, it can invoke
162scsi_adjust_queue_depth() in its slave_configure() routine. 162scsi_change_queue_depth() in its slave_configure() routine.
163 163
164*** For scsi devices that the mid level tries to scan but do not 164*** For scsi devices that the mid level tries to scan but do not
165 respond, a slave_alloc(), slave_destroy() pair is called. 165 respond, a slave_alloc(), slave_destroy() pair is called.
@@ -203,7 +203,7 @@ LLD mid level LLD
203scsi_add_device() ------+ 203scsi_add_device() ------+
204 | 204 |
205 slave_alloc() 205 slave_alloc()
206 slave_configure() [--> scsi_adjust_queue_depth()] 206 slave_configure() [--> scsi_change_queue_depth()]
207------------------------------------------------------------ 207------------------------------------------------------------
208 208
209In a similar fashion, an LLD may become aware that a SCSI device has been 209In a similar fashion, an LLD may become aware that a SCSI device has been
@@ -261,7 +261,7 @@ init_this_scsi_driver() ----+
261 | scsi_register() 261 | scsi_register()
262 | 262 |
263 slave_alloc() 263 slave_alloc()
264 slave_configure() --> scsi_adjust_queue_depth() 264 slave_configure() --> scsi_change_queue_depth()
265 slave_alloc() *** 265 slave_alloc() ***
266 slave_destroy() *** 266 slave_destroy() ***
267 | 267 |
@@ -271,7 +271,7 @@ init_this_scsi_driver() ----+
271 slave_destroy() *** 271 slave_destroy() ***
272------------------------------------------------------------ 272------------------------------------------------------------
273 273
274The mid level invokes scsi_adjust_queue_depth() with "cmd_per_lun" for that 274The mid level invokes scsi_change_queue_depth() with "cmd_per_lun" for that
275host as the queue length. These settings can be overridden by a 275host as the queue length. These settings can be overridden by a
276slave_configure() supplied by the LLD. 276slave_configure() supplied by the LLD.
277 277
@@ -368,7 +368,7 @@ names all start with "scsi_".
368Summary: 368Summary:
369 scsi_add_device - creates new scsi device (lu) instance 369 scsi_add_device - creates new scsi device (lu) instance
370 scsi_add_host - perform sysfs registration and set up transport class 370 scsi_add_host - perform sysfs registration and set up transport class
371 scsi_adjust_queue_depth - change the queue depth on a SCSI device 371 scsi_change_queue_depth - change the queue depth on a SCSI device
372 scsi_bios_ptable - return copy of block device's partition table 372 scsi_bios_ptable - return copy of block device's partition table
373 scsi_block_requests - prevent further commands being queued to given host 373 scsi_block_requests - prevent further commands being queued to given host
374 scsi_host_alloc - return a new scsi_host instance whose refcount==1 374 scsi_host_alloc - return a new scsi_host instance whose refcount==1
@@ -436,7 +436,7 @@ int scsi_add_host(struct Scsi_Host *shost, struct device * dev)
436 436
437 437
438/** 438/**
439 * scsi_adjust_queue_depth - allow LLD to change queue depth on a SCSI device 439 * scsi_change_queue_depth - allow LLD to change queue depth on a SCSI device
440 * @sdev: pointer to SCSI device to change queue depth on 440 * @sdev: pointer to SCSI device to change queue depth on
441 * @tags Number of tags allowed if tagged queuing enabled, 441 * @tags Number of tags allowed if tagged queuing enabled,
442 * or number of commands the LLD can queue up 442 * or number of commands the LLD can queue up
@@ -453,7 +453,7 @@ int scsi_add_host(struct Scsi_Host *shost, struct device * dev)
453 * Defined in: drivers/scsi/scsi.c [see source code for more notes] 453 * Defined in: drivers/scsi/scsi.c [see source code for more notes]
454 * 454 *
455 **/ 455 **/
456void scsi_adjust_queue_depth(struct scsi_device *sdev, int tags) 456int scsi_change_queue_depth(struct scsi_device *sdev, int tags)
457 457
458 458
459/** 459/**
@@ -1214,7 +1214,7 @@ of interest:
1214 for disk firmware uploads. 1214 for disk firmware uploads.
1215 cmd_per_lun - maximum number of commands that can be queued on devices 1215 cmd_per_lun - maximum number of commands that can be queued on devices
1216 controlled by the host. Overridden by LLD calls to 1216 controlled by the host. Overridden by LLD calls to
1217 scsi_adjust_queue_depth(). 1217 scsi_change_queue_depth().
1218 unchecked_isa_dma - 1=>only use bottom 16 MB of ram (ISA DMA addressing 1218 unchecked_isa_dma - 1=>only use bottom 16 MB of ram (ISA DMA addressing
1219 restriction), 0=>can use full 32 bit (or better) DMA 1219 restriction), 0=>can use full 32 bit (or better) DMA
1220 address space 1220 address space
@@ -1254,7 +1254,7 @@ struct scsi_cmnd
1254Instances of this structure convey SCSI commands to the LLD and responses 1254Instances of this structure convey SCSI commands to the LLD and responses
1255back to the mid level. The SCSI mid level will ensure that no more SCSI 1255back to the mid level. The SCSI mid level will ensure that no more SCSI
1256commands become queued against the LLD than are indicated by 1256commands become queued against the LLD than are indicated by
1257scsi_adjust_queue_depth() (or struct Scsi_Host::cmd_per_lun). There will 1257scsi_change_queue_depth() (or struct Scsi_Host::cmd_per_lun). There will
1258be at least one instance of struct scsi_cmnd available for each SCSI device. 1258be at least one instance of struct scsi_cmnd available for each SCSI device.
1259Members of interest: 1259Members of interest:
1260 cmnd - array containing SCSI command 1260 cmnd - array containing SCSI command