Merge branch 'master'
[pandora-kernel.git] / Documentation / scsi / scsi_mid_low_api.txt
1                           Linux Kernel 2.6 series
2                  SCSI mid_level - lower_level driver interface
3                  =============================================
4
5 Introduction
6 ============
7 This document outlines the interface between the Linux SCSI mid level and
8 SCSI lower level drivers. Lower level drivers (LLDs) are variously called 
9 host bus adapter (HBA) drivers and host drivers (HD). A "host" in this
10 context is a bridge between a computer IO bus (e.g. PCI or ISA) and a
11 single SCSI initiator port on a SCSI transport. An "initiator" port
12 (SCSI terminology, see SAM-3 at http://www.t10.org) sends SCSI commands
13 to "target" SCSI ports (e.g. disks). There can be many LLDs in a running
14 system, but only one per hardware type. Most LLDs can control one or more
15 SCSI HBAs. Some HBAs contain multiple hosts.
16
17 In some cases the SCSI transport is an external bus that already has
18 its own subsystem in Linux (e.g. USB and ieee1394). In such cases the
19 SCSI subsystem LLD is a software bridge to the other driver subsystem.
20 Examples are the usb-storage driver (found in the drivers/usb/storage
21 directory) and the ieee1394/sbp2 driver (found in the drivers/ieee1394
22 directory).
23
24 For example, the aic7xxx LLD controls Adaptec SCSI parallel interface
25 (SPI) controllers based on that company's 7xxx chip series. The aic7xxx
26 LLD can be built into the kernel or loaded as a module. There can only be
27 one aic7xxx LLD running in a Linux system but it may be controlling many 
28 HBAs. These HBAs might be either on PCI daughter-boards or built into 
29 the motherboard (or both). Some aic7xxx based HBAs are dual controllers
30 and thus represent two hosts. Like most modern HBAs, each aic7xxx host
31 has its own PCI device address. [The one-to-one correspondence between
32 a SCSI host and a PCI device is common but not required (e.g. with
33 ISA or MCA adapters).]
34
35 The SCSI mid level isolates an LLD from other layers such as the SCSI
36 upper layer drivers and the block layer.
37
38 This version of the document roughly matches linux kernel version 2.6.8 .
39
40 Documentation
41 =============
42 There is a SCSI documentation directory within the kernel source tree, 
43 typically Documentation/scsi . Most documents are in plain
44 (i.e. ASCII) text. This file is named scsi_mid_low_api.txt and can be 
45 found in that directory. A more recent copy of this document may be found
46 at http://www.torque.net/scsi/scsi_mid_low_api.txt.gz . 
47 Many LLDs are documented there (e.g. aic7xxx.txt). The SCSI mid-level is
48 briefly described in scsi.txt which contains a url to a document 
49 describing the SCSI subsystem in the lk 2.4 series. Two upper level 
50 drivers have documents in that directory: st.txt (SCSI tape driver) and 
51 scsi-generic.txt (for the sg driver).
52
53 Some documentation (or urls) for LLDs may be found in the C source code
54 or in the same directory as the C source code. For example to find a url
55 about the USB mass storage driver see the 
56 /usr/src/linux/drivers/usb/storage directory.
57
58 The Linux kernel source Documentation/DocBook/scsidrivers.tmpl file
59 refers to this file. With the appropriate DocBook tool-set, this permits
60 users to generate html, ps and pdf renderings of information within this
61 file (e.g. the interface functions).
62
63 Driver structure
64 ================
65 Traditionally an LLD for the SCSI subsystem has been at least two files in
66 the drivers/scsi directory. For example, a driver called "xyz" has a header
67 file "xyz.h" and a source file "xyz.c". [Actually there is no good reason
68 why this couldn't all be in one file; the header file is superfluous.] Some
69 drivers that have been ported to several operating systems have more than
70 two files. For example the aic7xxx driver has separate files for generic 
71 and OS-specific code (e.g. FreeBSD and Linux). Such drivers tend to have
72 their own directory under the drivers/scsi directory.
73
74 When a new LLD is being added to Linux, the following files (found in the
75 drivers/scsi directory) will need some attention: Makefile and Kconfig .
76 It is probably best to study how existing LLDs are organized.
77
78 As the 2.5 series development kernels evolve into the 2.6 series
79 production series, changes are being introduced into this interface. An
80 example of this is driver initialization code where there are now 2 models
81 available. The older one, similar to what was found in the lk 2.4 series,
82 is based on hosts that are detected at HBA driver load time. This will be
83 referred to the "passive" initialization model. The newer model allows HBAs
84 to be hot plugged (and unplugged) during the lifetime of the LLD and will
85 be referred to as the "hotplug" initialization model. The newer model is
86 preferred as it can handle both traditional SCSI equipment that is
87 permanently connected as well as modern "SCSI" devices (e.g. USB or
88 IEEE 1394 connected digital cameras) that are hotplugged. Both 
89 initialization models are discussed in the following sections.
90
91 An LLD interfaces to the SCSI subsystem several ways:
92   a) directly invoking functions supplied by the mid level
93   b) passing a set of function pointers to a registration function
94      supplied by the mid level. The mid level will then invoke these
95      functions at some point in the future. The LLD will supply
96      implementations of these functions.
97   c) direct access to instances of well known data structures maintained
98      by the mid level
99
100 Those functions in group a) are listed in a section entitled "Mid level
101 supplied functions" below.
102
103 Those functions in group b) are listed in a section entitled "Interface
104 functions" below. Their function pointers are placed in the members of
105 "struct scsi_host_template", an instance of which is passed to
106 scsi_host_alloc() ** .  Those interface functions that the LLD does not 
107 wish to supply should have NULL placed in the corresponding member of 
108 struct scsi_host_template.  Defining an instance of struct 
109 scsi_host_template at file scope will cause NULL to be  placed in function
110  pointer members not explicitly initialized.
111
112 Those usages in group c) should be handled with care, especially in a
113 "hotplug" environment. LLDs should be aware of the lifetime of instances
114 that are shared with the mid level and other layers.
115
116 All functions defined within an LLD and all data defined at file scope
117 should be static. For example the slave_alloc() function in an LLD
118 called "xxx" could be defined as 
119 "static int xxx_slave_alloc(struct scsi_device * sdev) { /* code */ }"
120
121 ** the scsi_host_alloc() function is a replacement for the rather vaguely
122 named scsi_register() function in most situations. The scsi_register()
123 and scsi_unregister() functions remain to support legacy LLDs that use
124 the passive initialization model.
125
126
127 Hotplug initialization model
128 ============================
129 In this model an LLD controls when SCSI hosts are introduced and removed
130 from the SCSI subsystem. Hosts can be introduced as early as driver
131 initialization and removed as late as driver shutdown. Typically a driver
132 will respond to a sysfs probe() callback that indicates an HBA has been
133 detected. After confirming that the new device is one that the LLD wants
134 to control, the LLD will initialize the HBA and then register a new host
135 with the SCSI mid level.
136
137 During LLD initialization the driver should register itself with the
138 appropriate IO bus on which it expects to find HBA(s) (e.g. the PCI bus).
139 This can probably be done via sysfs. Any driver parameters (especially
140 those that are writable after the driver is loaded) could also be
141 registered with sysfs at this point. The SCSI mid level first becomes
142 aware of an LLD when that LLD registers its first HBA.
143
144 At some later time, the LLD becomes aware of an HBA and what follows
145 is a typical sequence of calls between the LLD and the mid level.
146 This example shows the mid level scanning the newly introduced HBA for 3 
147 scsi devices of which only the first 2 respond:
148
149      HBA PROBE: assume 2 SCSI devices found in scan
150 LLD                   mid level                    LLD
151 ===-------------------=========--------------------===------
152 scsi_host_alloc()  -->
153 scsi_add_host()  --------+
154                          |
155                     slave_alloc()
156                     slave_configure() -->  scsi_adjust_queue_depth()
157                          |
158                     slave_alloc()
159                     slave_configure()
160                          |
161                     slave_alloc()   ***
162                     slave_destroy() ***
163 ------------------------------------------------------------
164
165 If the LLD wants to adjust the default queue settings, it can invoke
166 scsi_adjust_queue_depth() in its slave_configure() routine.
167
168 *** For scsi devices that the mid level tries to scan but do not
169     respond, a slave_alloc(), slave_destroy() pair is called.
170
171 When an HBA is being removed it could be as part of an orderly shutdown
172 associated with the LLD module being unloaded (e.g. with the "rmmod"
173 command) or in response to a "hot unplug" indicated by sysfs()'s
174 remove() callback being invoked. In either case, the sequence is the
175 same:
176
177         HBA REMOVE: assume 2 SCSI devices attached
178 LLD                      mid level                 LLD
179 ===----------------------=========-----------------===------
180 scsi_remove_host() ---------+
181                             |
182                      slave_destroy()
183                      slave_destroy()
184 scsi_host_put()
185 ------------------------------------------------------------
186                      
187 It may be useful for a LLD to keep track of struct Scsi_Host instances
188 (a pointer is returned by scsi_host_alloc()). Such instances are "owned"
189 by the mid-level.  struct Scsi_Host instances are freed from
190 scsi_host_put() when the reference count hits zero.
191
192 Hot unplugging an HBA that controls a disk which is processing SCSI
193 commands on a mounted file system is an interesting situation. Reference
194 counting logic is being introduced into the mid level to cope with many
195 of the issues involved. See the section on reference counting below.
196
197
198 The hotplug concept may be extended to SCSI devices. Currently, when an
199 HBA is added, the scsi_add_host() function causes a scan for SCSI devices
200 attached to the HBA's SCSI transport. On newer SCSI transports the HBA
201 may become aware of a new SCSI device _after_ the scan has completed.
202 An LLD can use this sequence to make the mid level aware of a SCSI device:
203
204                  SCSI DEVICE hotplug
205 LLD                   mid level                    LLD
206 ===-------------------=========--------------------===------
207 scsi_add_device()  ------+
208                          |
209                     slave_alloc()
210                     slave_configure()   [--> scsi_adjust_queue_depth()]
211 ------------------------------------------------------------
212
213 In a similar fashion, an LLD may become aware that a SCSI device has been
214 removed (unplugged) or the connection to it has been interrupted. Some
215 existing SCSI transports (e.g. SPI) may not become aware that a SCSI
216 device has been removed until a subsequent SCSI command fails which will
217 probably cause that device to be set offline by the mid level. An LLD that
218 detects the removal of a SCSI device can instigate its removal from
219 upper layers with this sequence:
220
221                   SCSI DEVICE hot unplug
222 LLD                      mid level                 LLD
223 ===----------------------=========-----------------===------
224 scsi_remove_device() -------+
225                             |
226                      slave_destroy()
227 ------------------------------------------------------------
228
229 It may be useful for an LLD to keep track of struct scsi_device instances
230 (a pointer is passed as the parameter to slave_alloc() and
231 slave_configure() callbacks). Such instances are "owned" by the mid-level.
232 struct scsi_device instances are freed after slave_destroy().
233
234
235 Passive initialization model
236 ============================
237 These older LLDs include a file called "scsi_module.c" [yes the ".c" is a
238 little surprising] in their source code. For that file to work an
239 instance of struct scsi_host_template with the name "driver_template"
240 needs to be defined. Here is a typical code sequence used in this model:
241     static struct scsi_host_template driver_template = {
242         ...
243     };
244     #include "scsi_module.c"
245
246 The scsi_module.c file contains two functions:
247   - init_this_scsi_driver() which is executed when the LLD is
248     initialized (i.e. boot time or module load time)
249   - exit_this_scsi_driver() which is executed when the LLD is shut
250     down (i.e. module unload time)
251 Note: since these functions are tagged with __init and __exit qualifiers
252 an LLD should not call them explicitly (since the kernel does that).
253
254 Here is an example of an initialization sequence when two hosts are
255 detected (so detect() returns 2) and the SCSI bus scan on each host
256 finds 1 SCSI device (and a second device does not respond).
257
258 LLD                      mid level                 LLD
259 ===----------------------=========-----------------===------
260 init_this_scsi_driver() ----+
261                             |
262                          detect()  -----------------+
263                             |                       |
264                             |                scsi_register()
265                             |                scsi_register()
266                             |
267                       slave_alloc()
268                       slave_configure()  -->  scsi_adjust_queue_depth()
269                       slave_alloc()   ***
270                       slave_destroy() ***
271                             |
272                       slave_alloc()
273                       slave_configure()
274                       slave_alloc()   ***
275                       slave_destroy() ***
276 ------------------------------------------------------------
277
278 The mid level invokes scsi_adjust_queue_depth() with tagged queuing off and
279 "cmd_per_lun" for that host as the queue length. These settings can be
280 overridden by a slave_configure() supplied by the LLD.
281
282 *** For scsi devices that the mid level tries to scan but do not
283     respond, a slave_alloc(), slave_destroy() pair is called.
284
285 Here is an LLD shutdown sequence:
286
287 LLD                      mid level                 LLD
288 ===----------------------=========-----------------===------
289 exit_this_scsi_driver() ----+
290                             |
291                      slave_destroy()
292                         release()   -->   scsi_unregister()
293                             |
294                      slave_destroy()
295                         release()   -->   scsi_unregister()
296 ------------------------------------------------------------
297
298 An LLD need not define slave_destroy() (i.e. it is optional). 
299
300 The shortcoming of the "passive initialization model" is that host
301 registration and de-registration are (typically) tied to LLD initialization
302 and shutdown. Once the LLD is initialized then a new host that appears
303 (e.g. via hotplugging) cannot easily be added without a redundant
304 driver shutdown and re-initialization. It may be possible to write an LLD
305 that uses both initialization models.
306
307
308 Reference Counting
309 ==================
310 The Scsi_Host structure has had reference counting infrastructure added.
311 This effectively spreads the ownership of struct Scsi_Host instances
312 across the various SCSI layers which use them. Previously such instances
313 were exclusively owned by the mid level. LLDs would not usually need to
314 directly manipulate these reference counts but there may be some cases
315 where they do.
316
317 There are 3 reference counting functions of interest associated with
318 struct Scsi_Host:
319   - scsi_host_alloc(): returns a pointer to new instance of struct 
320         Scsi_Host which has its reference count ^^ set to 1
321   - scsi_host_get(): adds 1 to the reference count of the given instance
322   - scsi_host_put(): decrements 1 from the reference count of the given
323         instance. If the reference count reaches 0 then the given instance
324         is freed
325
326 The Scsi_device structure has had reference counting infrastructure added.
327 This effectively spreads the ownership of struct Scsi_device instances
328 across the various SCSI layers which use them. Previously such instances
329 were exclusively owned by the mid level. See the access functions declared
330 towards the end of include/scsi/scsi_device.h . If an LLD wants to keep
331 a copy of a pointer to a Scsi_device instance it should use scsi_device_get()
332 to bump its reference count. When it is finished with the pointer it can
333 use scsi_device_put() to decrement its reference count (and potentially
334 delete it).
335
336 ^^ struct Scsi_Host actually has 2 reference counts which are manipulated
337 in parallel by these functions.
338
339
340 Conventions
341 ===========
342 First, Linus Torvalds's thoughts on C coding style can be found in the
343 Documentation/CodingStyle file. 
344
345 Next, there is a movement to "outlaw" typedefs introducing synonyms for 
346 struct tags. Both can be still found in the SCSI subsystem, but
347 the typedefs have been moved to a single file, scsi_typedefs.h to
348 make their future removal easier, for example: 
349 "typedef struct scsi_cmnd Scsi_Cmnd;"
350
351 Also, most C99 enhancements are encouraged to the extent they are supported
352 by the relevant gcc compilers. So C99 style structure and array
353 initializers are encouraged where appropriate. Don't go too far,
354 VLAs are not properly supported yet.  An exception to this is the use of
355 "//" style comments; /*...*/ comments are still preferred in Linux.
356
357 Well written, tested and documented code, need not be re-formatted to
358 comply with the above conventions. For example, the aic7xxx driver
359 comes to Linux from FreeBSD and Adaptec's own labs. No doubt FreeBSD
360 and Adaptec have their own coding conventions.
361
362
363 Mid level supplied functions
364 ============================
365 These functions are supplied by the SCSI mid level for use by LLDs.
366 The names (i.e. entry points) of these functions are exported 
367 so an LLD that is a module can access them. The kernel will
368 arrange for the SCSI mid level to be loaded and initialized before any LLD
369 is initialized. The functions below are listed alphabetically and their
370 names all start with "scsi_".
371
372 Summary:
373    scsi_activate_tcq - turn on tag command queueing
374    scsi_add_device - creates new scsi device (lu) instance
375    scsi_add_host - perform sysfs registration and SCSI bus scan.
376    scsi_adjust_queue_depth - change the queue depth on a SCSI device
377    scsi_assign_lock - replace default host_lock with given lock
378    scsi_bios_ptable - return copy of block device's partition table
379    scsi_block_requests - prevent further commands being queued to given host
380    scsi_deactivate_tcq - turn off tag command queueing
381    scsi_host_alloc - return a new scsi_host instance whose refcount==1
382    scsi_host_get - increments Scsi_Host instance's refcount
383    scsi_host_put - decrements Scsi_Host instance's refcount (free if 0)
384    scsi_partsize - parse partition table into cylinders, heads + sectors
385    scsi_register - create and register a scsi host adapter instance.
386    scsi_remove_device - detach and remove a SCSI device
387    scsi_remove_host - detach and remove all SCSI devices owned by host
388    scsi_report_bus_reset - report scsi _bus_ reset observed
389    scsi_track_queue_full - track successive QUEUE_FULL events 
390    scsi_unblock_requests - allow further commands to be queued to given host
391    scsi_unregister - [calls scsi_host_put()]
392
393
394 Details:
395
396 /**
397  * scsi_activate_tcq - turn on tag command queueing ("ordered" task attribute)
398  * @sdev:       device to turn on TCQ for
399  * @depth:      queue depth
400  *
401  *      Returns nothing
402  *
403  *      Might block: no
404  *
405  *      Notes: Eventually, it is hoped depth would be the maximum depth
406  *      the device could cope with and the real queue depth
407  *      would be adjustable from 0 to depth.
408  *
409  *      Defined (inline) in: include/scsi/scsi_tcq.h
410  **/
411 void scsi_activate_tcq(struct scsi_device *sdev, int depth)
412
413
414 /**
415  * scsi_add_device - creates new scsi device (lu) instance
416  * @shost:   pointer to scsi host instance
417  * @channel: channel number (rarely other than 0)
418  * @id:      target id number
419  * @lun:     logical unit number
420  *
421  *      Returns pointer to new struct scsi_device instance or 
422  *      ERR_PTR(-ENODEV) (or some other bent pointer) if something is
423  *      wrong (e.g. no lu responds at given address)
424  *
425  *      Might block: yes
426  *
427  *      Notes: This call is usually performed internally during a scsi
428  *      bus scan when an HBA is added (i.e. scsi_add_host()). So it
429  *      should only be called if the HBA becomes aware of a new scsi
430  *      device (lu) after scsi_add_host() has completed. If successful
431  *      this call we lead to slave_alloc() and slave_configure() callbacks
432  *      into the LLD.
433  *
434  *      Defined in: drivers/scsi/scsi_scan.c
435  **/
436 struct scsi_device * scsi_add_device(struct Scsi_Host *shost, 
437                                      unsigned int channel,
438                                      unsigned int id, unsigned int lun)
439
440
441 /**
442  * scsi_add_host - perform sysfs registration and SCSI bus scan.
443  * @shost:   pointer to scsi host instance
444  * @dev:     pointer to struct device of type scsi class
445  *
446  *      Returns 0 on success, negative errno of failure (e.g. -ENOMEM)
447  *
448  *      Might block: no
449  *
450  *      Notes: Only required in "hotplug initialization model" after a
451  *      successful call to scsi_host_alloc().
452  *
453  *      Defined in: drivers/scsi/hosts.c
454  **/
455 int scsi_add_host(struct Scsi_Host *shost, struct device * dev)
456
457
458 /**
459  * scsi_adjust_queue_depth - allow LLD to change queue depth on a SCSI device
460  * @sdev:       pointer to SCSI device to change queue depth on
461  * @tagged:     0 - no tagged queuing
462  *              MSG_SIMPLE_TAG - simple tagged queuing
463  *              MSG_ORDERED_TAG - ordered tagged queuing
464  * @tags        Number of tags allowed if tagged queuing enabled,
465  *              or number of commands the LLD can queue up
466  *              in non-tagged mode (as per cmd_per_lun).
467  *
468  *      Returns nothing
469  *
470  *      Might block: no
471  *
472  *      Notes: Can be invoked any time on a SCSI device controlled by this
473  *      LLD. [Specifically during and after slave_configure() and prior to
474  *      slave_destroy().] Can safely be invoked from interrupt code. Actual
475  *      queue depth change may be delayed until the next command is being
476  *      processed. See also scsi_activate_tcq() and scsi_deactivate_tcq().
477  *
478  *      Defined in: drivers/scsi/scsi.c [see source code for more notes]
479  *
480  **/
481 void scsi_adjust_queue_depth(struct scsi_device * sdev, int tagged, 
482                              int tags)
483
484
485 /**
486  * scsi_assign_lock - replace default host_lock with given lock
487  * @shost: a pointer to a scsi host instance
488  * @lock: pointer to lock to replace host_lock for this host
489  *
490  *      Returns nothing
491  *
492  *      Might block: no
493  *
494  *      Defined in: include/scsi/scsi_host.h .
495  **/
496 void scsi_assign_lock(struct Scsi_Host *shost, spinlock_t *lock)
497
498
499 /**
500  * scsi_bios_ptable - return copy of block device's partition table
501  * @dev:        pointer to block device
502  *
503  *      Returns pointer to partition table, or NULL for failure
504  *
505  *      Might block: yes
506  *
507  *      Notes: Caller owns memory returned (free with kfree() )
508  *
509  *      Defined in: drivers/scsi/scsicam.c
510  **/
511 unsigned char *scsi_bios_ptable(struct block_device *dev)
512
513
514 /**
515  * scsi_block_requests - prevent further commands being queued to given host
516  *
517  * @shost: pointer to host to block commands on
518  *
519  *      Returns nothing
520  *
521  *      Might block: no
522  *
523  *      Notes: There is no timer nor any other means by which the requests
524  *      get unblocked other than the LLD calling scsi_unblock_requests().
525  *
526  *      Defined in: drivers/scsi/scsi_lib.c
527 **/
528 void scsi_block_requests(struct Scsi_Host * shost)
529
530
531 /**
532  * scsi_deactivate_tcq - turn off tag command queueing
533  * @sdev:       device to turn off TCQ for
534  * @depth:      queue depth (stored in sdev)
535  *
536  *      Returns nothing
537  *
538  *      Might block: no
539  *
540  *      Defined (inline) in: include/scsi/scsi_tcq.h
541  **/
542 void scsi_deactivate_tcq(struct scsi_device *sdev, int depth)
543
544
545 /**
546  * scsi_host_alloc - create a scsi host adapter instance and perform basic
547  *                   initialization.
548  * @sht:        pointer to scsi host template
549  * @privsize:   extra bytes to allocate in hostdata array (which is the
550  *              last member of the returned Scsi_Host instance)
551  *
552  *      Returns pointer to new Scsi_Host instance or NULL on failure
553  *
554  *      Might block: yes
555  *
556  *      Notes: When this call returns to the LLD, the SCSI bus scan on
557  *      this host has _not_ yet been done.
558  *      The hostdata array (by default zero length) is a per host scratch 
559  *      area for the LLD's exclusive use.
560  *      Both associated refcounting objects have their refcount set to 1.
561  *      Full registration (in sysfs) and a bus scan are performed later when
562  *      scsi_add_host() is called.
563  *
564  *      Defined in: drivers/scsi/hosts.c .
565  **/
566 struct Scsi_Host * scsi_host_alloc(struct scsi_host_template * sht,
567                                    int privsize)
568
569
570 /**
571  * scsi_host_get - increment Scsi_Host instance refcount
572  * @shost:   pointer to struct Scsi_Host instance
573  *
574  *      Returns nothing
575  *
576  *      Might block: currently may block but may be changed to not block
577  *
578  *      Notes: Actually increments the counts in two sub-objects
579  *
580  *      Defined in: drivers/scsi/hosts.c
581  **/
582 void scsi_host_get(struct Scsi_Host *shost)
583
584
585 /**
586  * scsi_host_put - decrement Scsi_Host instance refcount, free if 0
587  * @shost:   pointer to struct Scsi_Host instance
588  *
589  *      Returns nothing
590  *
591  *      Might block: currently may block but may be changed to not block
592  *
593  *      Notes: Actually decrements the counts in two sub-objects. If the
594  *      latter refcount reaches 0, the Scsi_Host instance is freed.
595  *      The LLD need not worry exactly when the Scsi_Host instance is
596  *      freed, it just shouldn't access the instance after it has balanced
597  *      out its refcount usage.
598  *
599  *      Defined in: drivers/scsi/hosts.c
600  **/
601 void scsi_host_put(struct Scsi_Host *shost)
602
603
604 /**
605  * scsi_partsize - parse partition table into cylinders, heads + sectors
606  * @buf: pointer to partition table
607  * @capacity: size of (total) disk in 512 byte sectors
608  * @cyls: outputs number of cylinders calculated via this pointer
609  * @hds: outputs number of heads calculated via this pointer
610  * @secs: outputs number of sectors calculated via this pointer
611  *
612  *      Returns 0 on success, -1 on failure
613  *
614  *      Might block: no
615  *
616  *      Notes: Caller owns memory returned (free with kfree() )
617  *
618  *      Defined in: drivers/scsi/scsicam.c
619  **/
620 int scsi_partsize(unsigned char *buf, unsigned long capacity,
621                   unsigned int *cyls, unsigned int *hds, unsigned int *secs)
622
623
624 /**
625  * scsi_register - create and register a scsi host adapter instance.
626  * @sht:        pointer to scsi host template
627  * @privsize:   extra bytes to allocate in hostdata array (which is the
628  *              last member of the returned Scsi_Host instance)
629  *
630  *      Returns pointer to new Scsi_Host instance or NULL on failure
631  *
632  *      Might block: yes
633  *
634  *      Notes: When this call returns to the LLD, the SCSI bus scan on
635  *      this host has _not_ yet been done.
636  *      The hostdata array (by default zero length) is a per host scratch 
637  *      area for the LLD.
638  *
639  *      Defined in: drivers/scsi/hosts.c .
640  **/
641 struct Scsi_Host * scsi_register(struct scsi_host_template * sht,
642                                  int privsize)
643
644
645 /**
646  * scsi_remove_device - detach and remove a SCSI device
647  * @sdev:      a pointer to a scsi device instance
648  *
649  *      Returns value: 0 on success, -EINVAL if device not attached
650  *
651  *      Might block: yes
652  *
653  *      Notes: If an LLD becomes aware that a scsi device (lu) has
654  *      been removed but its host is still present then it can request
655  *      the removal of that scsi device. If successful this call will
656  *      lead to the slave_destroy() callback being invoked. sdev is an 
657  *      invalid pointer after this call.
658  *
659  *      Defined in: drivers/scsi/scsi_sysfs.c .
660  **/
661 int scsi_remove_device(struct scsi_device *sdev)
662
663
664 /**
665  * scsi_remove_host - detach and remove all SCSI devices owned by host
666  * @shost:      a pointer to a scsi host instance
667  *
668  *      Returns value: 0 on success, 1 on failure (e.g. LLD busy ??)
669  *
670  *      Might block: yes
671  *
672  *      Notes: Should only be invoked if the "hotplug initialization
673  *      model" is being used. It should be called _prior_ to  
674  *      scsi_unregister().
675  *
676  *      Defined in: drivers/scsi/hosts.c .
677  **/
678 int scsi_remove_host(struct Scsi_Host *shost)
679
680
681 /**
682  * scsi_report_bus_reset - report scsi _bus_ reset observed
683  * @shost: a pointer to a scsi host involved
684  * @channel: channel (within) host on which scsi bus reset occurred
685  *
686  *      Returns nothing
687  *
688  *      Might block: no
689  *
690  *      Notes: This only needs to be called if the reset is one which
691  *      originates from an unknown location.  Resets originated by the 
692  *      mid level itself don't need to call this, but there should be 
693  *      no harm.  The main purpose of this is to make sure that a
694  *      CHECK_CONDITION is properly treated.
695  *
696  *      Defined in: drivers/scsi/scsi_error.c .
697  **/
698 void scsi_report_bus_reset(struct Scsi_Host * shost, int channel)
699
700
701 /**
702  * scsi_track_queue_full - track successive QUEUE_FULL events on given
703  *                      device to determine if and when there is a need
704  *                      to adjust the queue depth on the device.
705  * @sdev:  pointer to SCSI device instance
706  * @depth: Current number of outstanding SCSI commands on this device,
707  *         not counting the one returned as QUEUE_FULL.
708  *
709  *      Returns 0  - no change needed
710  *              >0 - adjust queue depth to this new depth
711  *              -1 - drop back to untagged operation using host->cmd_per_lun
712  *                   as the untagged command depth
713  *
714  *      Might block: no
715  *
716  *      Notes: LLDs may call this at any time and we will do "The Right
717  *              Thing"; interrupt context safe. 
718  *
719  *      Defined in: drivers/scsi/scsi.c .
720  **/
721 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
722
723
724 /**
725  * scsi_unblock_requests - allow further commands to be queued to given host
726  *
727  * @shost: pointer to host to unblock commands on
728  *
729  *      Returns nothing
730  *
731  *      Might block: no
732  *
733  *      Defined in: drivers/scsi/scsi_lib.c .
734 **/
735 void scsi_unblock_requests(struct Scsi_Host * shost)
736
737
738 /**
739  * scsi_unregister - unregister and free memory used by host instance
740  * @shp:        pointer to scsi host instance to unregister.
741  *
742  *      Returns nothing
743  *
744  *      Might block: no
745  *
746  *      Notes: Should not be invoked if the "hotplug initialization
747  *      model" is being used. Called internally by exit_this_scsi_driver()
748  *      in the "passive initialization model". Hence a LLD has no need to
749  *      call this function directly.
750  *
751  *      Defined in: drivers/scsi/hosts.c .
752  **/
753 void scsi_unregister(struct Scsi_Host * shp)
754
755
756
757
758 Interface Functions
759 ===================
760 Interface functions are supplied (defined) by LLDs and their function
761 pointers are placed in an instance of struct scsi_host_template which
762 is passed to scsi_host_alloc() [or scsi_register() / init_this_scsi_driver()].
763 Some are mandatory. Interface functions should be declared static. The
764 accepted convention is that driver "xyz" will declare its slave_configure() 
765 function as:
766     static int xyz_slave_configure(struct scsi_device * sdev);
767 and so forth for all interface functions listed below.
768
769 A pointer to this function should be placed in the 'slave_configure' member
770 of a "struct scsi_host_template" instance. A pointer to such an instance
771 should be passed to the mid level's scsi_host_alloc() [or scsi_register() /
772 init_this_scsi_driver()].
773
774 The interface functions are also described in the include/scsi/scsi_host.h
775 file immediately above their definition point in "struct scsi_host_template".
776 In some cases more detail is given in scsi_host.h than below.
777
778 The interface functions are listed below in alphabetical order.
779
780 Summary:
781    bios_param - fetch head, sector, cylinder info for a disk
782    detect - detects HBAs this driver wants to control
783    eh_timed_out - notify the host that a command timer expired
784    eh_abort_handler - abort given command
785    eh_bus_reset_handler - issue SCSI bus reset
786    eh_device_reset_handler - issue SCSI device reset
787    eh_host_reset_handler - reset host (host bus adapter)
788    eh_strategy_handler - driver supplied alternate to scsi_unjam_host()
789    info - supply information about given host
790    ioctl - driver can respond to ioctls
791    proc_info - supports /proc/scsi/{driver_name}/{host_no}
792    queuecommand - queue scsi command, invoke 'done' on completion
793    release - release all resources associated with given host
794    slave_alloc - prior to any commands being sent to a new device 
795    slave_configure - driver fine tuning for given device after attach
796    slave_destroy - given device is about to be shut down
797
798
799 Details:
800
801 /**
802  *      bios_param - fetch head, sector, cylinder info for a disk
803  *      @sdev: pointer to scsi device context (defined in 
804  *             include/scsi/scsi_device.h)
805  *      @bdev: pointer to block device context (defined in fs.h)
806  *      @capacity:  device size (in 512 byte sectors)
807  *      @params: three element array to place output:
808  *              params[0] number of heads (max 255)
809  *              params[1] number of sectors (max 63)
810  *              params[2] number of cylinders 
811  *
812  *      Return value is ignored
813  *
814  *      Locks: none
815  *
816  *      Calling context: process (sd)
817  *
818  *      Notes: an arbitrary geometry (based on READ CAPACITY) is used
819  *      if this function is not provided. The params array is
820  *      pre-initialized with made up values just in case this function 
821  *      doesn't output anything.
822  *
823  *      Optionally defined in: LLD
824  **/
825     int bios_param(struct scsi_device * sdev, struct block_device *bdev,
826                    sector_t capacity, int params[3])
827
828
829 /**
830  *      detect - detects HBAs this driver wants to control
831  *      @shtp: host template for this driver.
832  *
833  *      Returns number of hosts this driver wants to control. 0 means no
834  *      suitable hosts found.
835  *
836  *      Locks: none held
837  *
838  *      Calling context: process [invoked from init_this_scsi_driver()]
839  *
840  *      Notes: First function called from the SCSI mid level on this
841  *      driver. Upper level drivers (e.g. sd) may not (yet) be present.
842  *      For each host found, this method should call scsi_register() 
843  *      [see hosts.c].
844  *
845  *      Defined in: LLD (required if "passive initialization mode" is used,
846  *                       not invoked in "hotplug initialization mode")
847  **/
848     int detect(struct scsi_host_template * shtp)
849
850
851 /**
852  *      eh_timed_out - The timer for the command has just fired
853  *      @scp: identifies command timing out
854  *
855  *      Returns:
856  *
857  *      EH_HANDLED:             I fixed the error, please complete the command
858  *      EH_RESET_TIMER:         I need more time, reset the timer and
859  *                              begin counting again
860  *      EH_NOT_HANDLED          Begin normal error recovery
861  *
862  *
863  *      Locks: None held
864  *
865  *      Calling context: interrupt
866  *
867  *      Notes: This is to give the LLD an opportunity to do local recovery.
868  *      This recovery is limited to determining if the outstanding command
869  *      will ever complete.  You may not abort and restart the command from
870  *      this callback.
871  *
872  *      Optionally defined in: LLD
873  **/
874      int eh_timed_out(struct scsi_cmnd * scp)
875
876
877 /**
878  *      eh_abort_handler - abort command associated with scp
879  *      @scp: identifies command to be aborted
880  *
881  *      Returns SUCCESS if command aborted else FAILED
882  *
883  *      Locks: None held
884  *
885  *      Calling context: kernel thread
886  *
887  *      Notes: Invoked from scsi_eh thread. No other commands will be
888  *      queued on current host during eh.
889  *
890  *      Optionally defined in: LLD
891  **/
892      int eh_abort_handler(struct scsi_cmnd * scp)
893
894
895 /**
896  *      eh_bus_reset_handler - issue SCSI bus reset
897  *      @scp: SCSI bus that contains this device should be reset
898  *
899  *      Returns SUCCESS if command aborted else FAILED
900  *
901  *      Locks: None held
902  *
903  *      Calling context: kernel thread
904  *
905  *      Notes: Invoked from scsi_eh thread. No other commands will be
906  *      queued on current host during eh.
907  *
908  *      Optionally defined in: LLD
909  **/
910      int eh_bus_reset_handler(struct scsi_cmnd * scp)
911
912
913 /**
914  *      eh_device_reset_handler - issue SCSI device reset
915  *      @scp: identifies SCSI device to be reset
916  *
917  *      Returns SUCCESS if command aborted else FAILED
918  *
919  *      Locks: None held
920  *
921  *      Calling context: kernel thread
922  *
923  *      Notes: Invoked from scsi_eh thread. No other commands will be
924  *      queued on current host during eh.
925  *
926  *      Optionally defined in: LLD
927  **/
928      int eh_device_reset_handler(struct scsi_cmnd * scp)
929
930
931 /**
932  *      eh_host_reset_handler - reset host (host bus adapter)
933  *      @scp: SCSI host that contains this device should be reset
934  *
935  *      Returns SUCCESS if command aborted else FAILED
936  *
937  *      Locks: None held
938  *
939  *      Calling context: kernel thread
940  *
941  *      Notes: Invoked from scsi_eh thread. No other commands will be
942  *      queued on current host during eh. 
943  *      With the default eh_strategy in place, if none of the _abort_, 
944  *      _device_reset_, _bus_reset_ or this eh handler function are 
945  *      defined (or they all return FAILED) then the device in question 
946  *      will be set offline whenever eh is invoked.
947  *
948  *      Optionally defined in: LLD
949  **/
950      int eh_host_reset_handler(struct scsi_cmnd * scp)
951
952
953 /**
954  *      eh_strategy_handler - driver supplied alternate to scsi_unjam_host()
955  *      @shp: host on which error has occurred
956  *
957  *      Returns TRUE if host unjammed, else FALSE.
958  *
959  *      Locks: none
960  *
961  *      Calling context: kernel thread
962  *
963  *      Notes: Invoked from scsi_eh thread. LLD supplied alternate to 
964  *      scsi_unjam_host() found in scsi_error.c
965  *
966  *      Optionally defined in: LLD
967  **/
968      int eh_strategy_handler(struct Scsi_Host * shp)
969
970
971 /**
972  *      info - supply information about given host: driver name plus data
973  *             to distinguish given host
974  *      @shp: host to supply information about
975  *
976  *      Return ASCII null terminated string. [This driver is assumed to
977  *      manage the memory pointed to and maintain it, typically for the
978  *      lifetime of this host.]
979  *
980  *      Locks: none
981  *
982  *      Calling context: process
983  *
984  *      Notes: Often supplies PCI or ISA information such as IO addresses
985  *      and interrupt numbers. If not supplied struct Scsi_Host::name used
986  *      instead. It is assumed the returned information fits on one line 
987  *      (i.e. does not included embedded newlines).
988  *      The SCSI_IOCTL_PROBE_HOST ioctl yields the string returned by this
989  *      function (or struct Scsi_Host::name if this function is not
990  *      available).
991  *      In a similar manner, init_this_scsi_driver() outputs to the console
992  *      each host's "info" (or name) for the driver it is registering.
993  *      Also if proc_info() is not supplied, the output of this function
994  *      is used instead.
995  *
996  *      Optionally defined in: LLD
997  **/
998     const char * info(struct Scsi_Host * shp)
999
1000
1001 /**
1002  *      ioctl - driver can respond to ioctls
1003  *      @sdp: device that ioctl was issued for
1004  *      @cmd: ioctl number
1005  *      @arg: pointer to read or write data from. Since it points to
1006  *            user space, should use appropriate kernel functions
1007  *            (e.g. copy_from_user() ). In the Unix style this argument
1008  *            can also be viewed as an unsigned long.
1009  *
1010  *      Returns negative "errno" value when there is a problem. 0 or a
1011  *      positive value indicates success and is returned to the user space.
1012  *
1013  *      Locks: none
1014  *
1015  *      Calling context: process
1016  *
1017  *      Notes: The SCSI subsystem uses a "trickle down" ioctl model.
1018  *      The user issues an ioctl() against an upper level driver
1019  *      (e.g. /dev/sdc) and if the upper level driver doesn't recognize
1020  *      the 'cmd' then it is passed to the SCSI mid level. If the SCSI
1021  *      mid level does not recognize it, then the LLD that controls
1022  *      the device receives the ioctl. According to recent Unix standards
1023  *      unsupported ioctl() 'cmd' numbers should return -ENOTTY.
1024  *
1025  *      Optionally defined in: LLD
1026  **/
1027     int ioctl(struct scsi_device *sdp, int cmd, void *arg)
1028
1029
1030 /**
1031  *      proc_info - supports /proc/scsi/{driver_name}/{host_no}
1032  *      @buffer: anchor point to output to (0==writeto1_read0) or fetch from
1033  *               (1==writeto1_read0).
1034  *      @start: where "interesting" data is written to. Ignored when
1035  *              1==writeto1_read0.
1036  *      @offset: offset within buffer 0==writeto1_read0 is actually
1037  *               interested in. Ignored when 1==writeto1_read0 .
1038  *      @length: maximum (or actual) extent of buffer
1039  *      @host_no: host number of interest (struct Scsi_Host::host_no)
1040  *      @writeto1_read0: 1 -> data coming from user space towards driver
1041  *                            (e.g. "echo some_string > /proc/scsi/xyz/2")
1042  *                       0 -> user what data from this driver
1043  *                            (e.g. "cat /proc/scsi/xyz/2")
1044  *
1045  *      Returns length when 1==writeto1_read0. Otherwise number of chars
1046  *      output to buffer past offset.
1047  *
1048  *      Locks: none held
1049  *
1050  *      Calling context: process
1051  *
1052  *      Notes: Driven from scsi_proc.c which interfaces to proc_fs. proc_fs
1053  *      support can now be configured out of the scsi subsystem.
1054  *
1055  *      Optionally defined in: LLD
1056  **/
1057     int proc_info(char * buffer, char ** start, off_t offset, 
1058                   int length, int host_no, int writeto1_read0)
1059
1060
1061 /**
1062  *      queuecommand - queue scsi command, invoke 'done' on completion
1063  *      @scp: pointer to scsi command object
1064  *      @done: function pointer to be invoked on completion
1065  *
1066  *      Returns 0 on success.
1067  *
1068  *      If there's a failure, return either:
1069  *
1070  *      SCSI_MLQUEUE_DEVICE_BUSY if the device queue is full, or
1071  *      SCSI_MLQUEUE_HOST_BUSY if the entire host queue is full
1072  *
1073  *      On both of these returns, the mid-layer will requeue the I/O
1074  *
1075  *      - if the return is SCSI_MLQUEUE_DEVICE_BUSY, only that particular
1076  *      device will be paused, and it will be unpaused when a command to
1077  *      the device returns (or after a brief delay if there are no more
1078  *      outstanding commands to it).  Commands to other devices continue
1079  *      to be processed normally.
1080  *
1081  *      - if the return is SCSI_MLQUEUE_HOST_BUSY, all I/O to the host
1082  *      is paused and will be unpaused when any command returns from
1083  *      the host (or after a brief delay if there are no outstanding
1084  *      commands to the host).
1085  *
1086  *      For compatibility with earlier versions of queuecommand, any
1087  *      other return value is treated the same as
1088  *      SCSI_MLQUEUE_HOST_BUSY.
1089  *
1090  *      Other types of errors that are detected immediately may be
1091  *      flagged by setting scp->result to an appropriate value,
1092  *      invoking the 'done' callback, and then returning 0 from this
1093  *      function. If the command is not performed immediately (and the
1094  *      LLD is starting (or will start) the given command) then this
1095  *      function should place 0 in scp->result and return 0.
1096  *
1097  *      Command ownership.  If the driver returns zero, it owns the
1098  *      command and must take responsibility for ensuring the 'done'
1099  *      callback is executed.  Note: the driver may call done before
1100  *      returning zero, but after it has called done, it may not
1101  *      return any value other than zero.  If the driver makes a
1102  *      non-zero return, it must not execute the command's done
1103  *      callback at any time.
1104  *
1105  *      Locks: struct Scsi_Host::host_lock held on entry (with "irqsave")
1106  *             and is expected to be held on return.
1107  *
1108  *      Calling context: in interrupt (soft irq) or process context
1109  *
1110  *      Notes: This function should be relatively fast. Normally it will
1111  *      not wait for IO to complete. Hence the 'done' callback is invoked 
1112  *      (often directly from an interrupt service routine) some time after
1113  *      this function has returned. In some cases (e.g. pseudo adapter 
1114  *      drivers that manufacture the response to a SCSI INQUIRY)
1115  *      the 'done' callback may be invoked before this function returns.
1116  *      If the 'done' callback is not invoked within a certain period
1117  *      the SCSI mid level will commence error processing.
1118  *      If a status of CHECK CONDITION is placed in "result" when the
1119  *      'done' callback is invoked, then the LLD driver should 
1120  *      perform autosense and fill in the struct scsi_cmnd::sense_buffer
1121  *      array. The scsi_cmnd::sense_buffer array is zeroed prior to
1122  *      the mid level queuing a command to an LLD.
1123  *
1124  *      Defined in: LLD
1125  **/
1126     int queuecommand(struct scsi_cmnd * scp, 
1127                      void (*done)(struct scsi_cmnd *))
1128
1129
1130 /**
1131  *      release - release all resources associated with given host
1132  *      @shp: host to be released.
1133  *
1134  *      Return value ignored (could soon be a function returning void).
1135  *
1136  *      Locks: none held
1137  *
1138  *      Calling context: process
1139  *
1140  *      Notes: Invoked from scsi_module.c's exit_this_scsi_driver().
1141  *      LLD's implementation of this function should call 
1142  *      scsi_unregister(shp) prior to returning.
1143  *      Only needed for old-style host templates.
1144  *
1145  *      Defined in: LLD (required in "passive initialization model",
1146  *                       should not be defined in hotplug model)
1147  **/
1148     int release(struct Scsi_Host * shp)
1149
1150
1151 /**
1152  *      slave_alloc -   prior to any commands being sent to a new device 
1153  *                      (i.e. just prior to scan) this call is made
1154  *      @sdp: pointer to new device (about to be scanned)
1155  *
1156  *      Returns 0 if ok. Any other return is assumed to be an error and
1157  *      the device is ignored.
1158  *
1159  *      Locks: none
1160  *
1161  *      Calling context: process
1162  *
1163  *      Notes: Allows the driver to allocate any resources for a device
1164  *      prior to its initial scan. The corresponding scsi device may not
1165  *      exist but the mid level is just about to scan for it (i.e. send
1166  *      and INQUIRY command plus ...). If a device is found then
1167  *      slave_configure() will be called while if a device is not found
1168  *      slave_destroy() is called.
1169  *      For more details see the include/scsi/scsi_host.h file.
1170  *
1171  *      Optionally defined in: LLD
1172  **/
1173     int slave_alloc(struct scsi_device *sdp)
1174
1175
1176 /**
1177  *      slave_configure - driver fine tuning for given device just after it
1178  *                     has been first scanned (i.e. it responded to an
1179  *                     INQUIRY)
1180  *      @sdp: device that has just been attached
1181  *
1182  *      Returns 0 if ok. Any other return is assumed to be an error and
1183  *      the device is taken offline. [offline devices will _not_ have
1184  *      slave_destroy() called on them so clean up resources.]
1185  *
1186  *      Locks: none
1187  *
1188  *      Calling context: process
1189  *
1190  *      Notes: Allows the driver to inspect the response to the initial
1191  *      INQUIRY done by the scanning code and take appropriate action.
1192  *      For more details see the include/scsi/scsi_host.h file.
1193  *
1194  *      Optionally defined in: LLD
1195  **/
1196     int slave_configure(struct scsi_device *sdp)
1197
1198
1199 /**
1200  *      slave_destroy - given device is about to be shut down. All
1201  *                      activity has ceased on this device.
1202  *      @sdp: device that is about to be shut down
1203  *
1204  *      Returns nothing
1205  *
1206  *      Locks: none
1207  *
1208  *      Calling context: process
1209  *
1210  *      Notes: Mid level structures for given device are still in place
1211  *      but are about to be torn down. Any per device resources allocated
1212  *      by this driver for given device should be freed now. No further
1213  *      commands will be sent for this sdp instance. [However the device
1214  *      could be re-attached in the future in which case a new instance
1215  *      of struct scsi_device would be supplied by future slave_alloc()
1216  *      and slave_configure() calls.]
1217  *
1218  *      Optionally defined in: LLD
1219  **/
1220     void slave_destroy(struct scsi_device *sdp)
1221
1222
1223
1224 Data Structures
1225 ===============
1226 struct scsi_host_template
1227 -------------------------
1228 There is one "struct scsi_host_template" instance per LLD ***. It is
1229 typically initialized as a file scope static in a driver's header file. That
1230 way members that are not explicitly initialized will be set to 0 or NULL.
1231 Member of interest:
1232     name         - name of driver (may contain spaces, please limit to
1233                    less than 80 characters)
1234     proc_name    - name used in "/proc/scsi/<proc_name>/<host_no>" and
1235                    by sysfs in one of its "drivers" directories. Hence
1236                    "proc_name" should only contain characters acceptable
1237                    to a Unix file name.
1238    (*queuecommand)() - primary callback that the mid level uses to inject
1239                    SCSI commands into an LLD.
1240 The structure is defined and commented in include/scsi/scsi_host.h
1241
1242 *** In extreme situations a single driver may have several instances
1243     if it controls several different classes of hardware (e.g. an LLD
1244     that handles both ISA and PCI cards and has a separate instance of
1245     struct scsi_host_template for each class).
1246
1247 struct Scsi_Host
1248 ----------------
1249 There is one struct Scsi_Host instance per host (HBA) that an LLD
1250 controls. The struct Scsi_Host structure has many members in common
1251 with "struct scsi_host_template". When a new struct Scsi_Host instance
1252 is created (in scsi_host_alloc() in hosts.c) those common members are
1253 initialized from the driver's struct scsi_host_template instance. Members
1254 of interest:
1255     host_no      - system wide unique number that is used for identifying
1256                    this host. Issued in ascending order from 0.
1257     can_queue    - must be greater than 0; do not send more than can_queue
1258                    commands to the adapter.
1259     this_id      - scsi id of host (scsi initiator) or -1 if not known
1260     sg_tablesize - maximum scatter gather elements allowed by host.
1261                    0 implies scatter gather not supported by host
1262     max_sectors  - maximum number of sectors (usually 512 bytes) allowed
1263                    in a single SCSI command. The default value of 0 leads
1264                    to a setting of SCSI_DEFAULT_MAX_SECTORS (defined in
1265                    scsi_host.h) which is currently set to 1024. So for a
1266                    disk the maximum transfer size is 512 KB when max_sectors
1267                    is not defined. Note that this size may not be sufficient
1268                    for disk firmware uploads.
1269     cmd_per_lun  - maximum number of commands that can be queued on devices
1270                    controlled by the host. Overridden by LLD calls to
1271                    scsi_adjust_queue_depth().
1272     unchecked_isa_dma - 1=>only use bottom 16 MB of ram (ISA DMA addressing
1273                    restriction), 0=>can use full 32 bit (or better) DMA
1274                    address space
1275     use_clustering - 1=>SCSI commands in mid level's queue can be merged,
1276                      0=>disallow SCSI command merging
1277     hostt        - pointer to driver's struct scsi_host_template from which
1278                    this struct Scsi_Host instance was spawned
1279     hostt->proc_name  - name of LLD. This is the driver name that sysfs uses
1280     transportt   - pointer to driver's struct scsi_transport_template instance
1281                    (if any). FC and SPI transports currently supported.
1282     sh_list      - a double linked list of pointers to all struct Scsi_Host
1283                    instances (currently ordered by ascending host_no)
1284     my_devices   - a double linked list of pointers to struct scsi_device 
1285                    instances that belong to this host.
1286     hostdata[0]  - area reserved for LLD at end of struct Scsi_Host. Size
1287                    is set by the second argument (named 'xtr_bytes') to
1288                    scsi_host_alloc() or scsi_register().
1289
1290 The scsi_host structure is defined in include/scsi/scsi_host.h
1291
1292 struct scsi_device
1293 ------------------
1294 Generally, there is one instance of this structure for each SCSI logical unit
1295 on a host. Scsi devices connected to a host are uniquely identified by a
1296 channel number, target id and logical unit number (lun).
1297 The structure is defined in include/scsi/scsi_device.h
1298
1299 struct scsi_cmnd
1300 ----------------
1301 Instances of this structure convey SCSI commands to the LLD and responses
1302 back to the mid level. The SCSI mid level will ensure that no more SCSI
1303 commands become queued against the LLD than are indicated by
1304 scsi_adjust_queue_depth() (or struct Scsi_Host::cmd_per_lun). There will
1305 be at least one instance of struct scsi_cmnd available for each SCSI device.
1306 Members of interest:
1307     cmnd         - array containing SCSI command
1308     cmnd_len     - length (in bytes) of SCSI command
1309     sc_data_direction - direction of data transfer in data phase. See
1310                 "enum dma_data_direction" in include/linux/dma-mapping.h
1311     request_bufflen - number of data bytes to transfer (0 if no data phase)
1312     use_sg       - ==0 -> no scatter gather list, hence transfer data
1313                           to/from request_buffer
1314                  - >0 ->  scatter gather list (actually an array) in
1315                           request_buffer with use_sg elements
1316     request_buffer - either contains data buffer or scatter gather list
1317                      depending on the setting of use_sg. Scatter gather
1318                      elements are defined by 'struct scatterlist' found
1319                      in include/asm/scatterlist.h .
1320     done         - function pointer that should be invoked by LLD when the
1321                    SCSI command is completed (successfully or otherwise).
1322                    Should only be called by an LLD if the LLD has accepted
1323                    the command (i.e. queuecommand() returned or will return
1324                    0). The LLD may invoke 'done'  prior to queuecommand()
1325                    finishing.
1326     result       - should be set by LLD prior to calling 'done'. A value
1327                    of 0 implies a successfully completed command (and all
1328                    data (if any) has been transferred to or from the SCSI
1329                    target device). 'result' is a 32 bit unsigned integer that
1330                    can be viewed as 4 related bytes. The SCSI status value is
1331                    in the LSB. See include/scsi/scsi.h status_byte(),
1332                    msg_byte(), host_byte() and driver_byte() macros and
1333                    related constants.
1334     sense_buffer - an array (maximum size: SCSI_SENSE_BUFFERSIZE bytes) that
1335                    should be written when the SCSI status (LSB of 'result')
1336                    is set to CHECK_CONDITION (2). When CHECK_CONDITION is
1337                    set, if the top nibble of sense_buffer[0] has the value 7
1338                    then the mid level will assume the sense_buffer array
1339                    contains a valid SCSI sense buffer; otherwise the mid
1340                    level will issue a REQUEST_SENSE SCSI command to
1341                    retrieve the sense buffer. The latter strategy is error
1342                    prone in the presence of command queuing so the LLD should
1343                    always "auto-sense".
1344     device       - pointer to scsi_device object that this command is
1345                    associated with.
1346     resid        - an LLD should set this signed integer to the requested
1347                    transfer length (i.e. 'request_bufflen') less the number
1348                    of bytes that are actually transferred. 'resid' is
1349                    preset to 0 so an LLD can ignore it if it cannot detect
1350                    underruns (overruns should be rare). If possible an LLD
1351                    should set 'resid' prior to invoking 'done'. The most
1352                    interesting case is data transfers from a SCSI target
1353                    device device (i.e. READs) that underrun. 
1354     underflow    - LLD should place (DID_ERROR << 16) in 'result' if
1355                    actual number of bytes transferred is less than this
1356                    figure. Not many LLDs implement this check and some that
1357                    do just output an error message to the log rather than
1358                    report a DID_ERROR. Better for an LLD to implement
1359                    'resid'.
1360
1361 The scsi_cmnd structure is defined in include/scsi/scsi_cmnd.h
1362
1363
1364 Locks
1365 =====
1366 Each struct Scsi_Host instance has a spin_lock called struct 
1367 Scsi_Host::default_lock which is initialized in scsi_host_alloc() [found in 
1368 hosts.c]. Within the same function the struct Scsi_Host::host_lock pointer
1369 is initialized to point at default_lock with the scsi_assign_lock() function.
1370 Thereafter lock and unlock operations performed by the mid level use the
1371 struct Scsi_Host::host_lock pointer.
1372
1373 LLDs can override the use of struct Scsi_Host::default_lock by
1374 using scsi_assign_lock(). The earliest opportunity to do this would
1375 be in the detect() function after it has invoked scsi_register(). It
1376 could be replaced by a coarser grain lock (e.g. per driver) or a
1377 lock of equal granularity (i.e. per host). Using finer grain locks 
1378 (e.g. per SCSI device) may be possible by juggling locks in
1379 queuecommand().
1380
1381 Autosense
1382 =========
1383 Autosense (or auto-sense) is defined in the SAM-2 document as "the
1384 automatic return of sense data to the application client coincident
1385 with the completion of a SCSI command" when a status of CHECK CONDITION
1386 occurs. LLDs should perform autosense. This should be done when the LLD
1387 detects a CHECK CONDITION status by either: 
1388     a) instructing the SCSI protocol (e.g. SCSI Parallel Interface (SPI))
1389        to perform an extra data in phase on such responses
1390     b) or, the LLD issuing a REQUEST SENSE command itself
1391
1392 Either way, when a status of CHECK CONDITION is detected, the mid level
1393 decides whether the LLD has performed autosense by checking struct 
1394 scsi_cmnd::sense_buffer[0] . If this byte has an upper nibble of 7 (or 0xf)
1395 then autosense is assumed to have taken place. If it has another value (and
1396 this byte is initialized to 0 before each command) then the mid level will
1397 issue a REQUEST SENSE command.
1398
1399 In the presence of queued commands the "nexus" that maintains sense
1400 buffer data from the command that failed until a following REQUEST SENSE
1401 may get out of synchronization. This is why it is best for the LLD
1402 to perform autosense.
1403
1404
1405 Changes since lk 2.4 series
1406 ===========================
1407 io_request_lock has been replaced by several finer grained locks. The lock 
1408 relevant to LLDs is struct Scsi_Host::host_lock and there is
1409 one per SCSI host.
1410
1411 The older error handling mechanism has been removed. This means the
1412 LLD interface functions abort() and reset() have been removed.
1413 The struct scsi_host_template::use_new_eh_code flag has been removed.
1414
1415 In the 2.4 series the SCSI subsystem configuration descriptions were 
1416 aggregated with the configuration descriptions from all other Linux 
1417 subsystems in the Documentation/Configure.help file. In the 2.6 series, 
1418 the SCSI subsystem now has its own (much smaller) drivers/scsi/Kconfig
1419 file that contains both configuration and help information.
1420
1421 struct SHT has been renamed to struct scsi_host_template.
1422
1423 Addition of the "hotplug initialization model" and many extra functions
1424 to support it.
1425
1426
1427 Credits
1428 =======
1429 The following people have contributed to this document:
1430         Mike Anderson <andmike at us dot ibm dot com>
1431         James Bottomley <James dot Bottomley at steeleye dot com> 
1432         Patrick Mansfield <patmans at us dot ibm dot com> 
1433         Christoph Hellwig <hch at infradead dot org>
1434         Doug Ledford <dledford at redhat dot com>
1435         Andries Brouwer <Andries dot Brouwer at cwi dot nl>
1436         Randy Dunlap <rddunlap at osdl dot org>
1437         Alan Stern <stern at rowland dot harvard dot edu>
1438
1439
1440 Douglas Gilbert
1441 dgilbert at interlog dot com
1442 21st September 2004