7536823c0cb1d392b30876eb1922dffd0a5b9b07
[linux-2.6.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_host_template Scsi_Host_Template;"
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_add_timer - (re-)start timer on a SCSI command.
377    scsi_adjust_queue_depth - change the queue depth on a SCSI device
378    scsi_assign_lock - replace default host_lock with given lock
379    scsi_bios_ptable - return copy of block device's partition table
380    scsi_block_requests - prevent further commands being queued to given host
381    scsi_deactivate_tcq - turn off tag command queueing
382    scsi_delete_timer - cancel timer on a SCSI command.
383    scsi_host_alloc - return a new scsi_host instance whose refcount==1
384    scsi_host_get - increments Scsi_Host instance's refcount
385    scsi_host_put - decrements Scsi_Host instance's refcount (free if 0)
386    scsi_partsize - parse partition table into cylinders, heads + sectors
387    scsi_register - create and register a scsi host adapter instance.
388    scsi_remove_device - detach and remove a SCSI device
389    scsi_remove_host - detach and remove all SCSI devices owned by host
390    scsi_report_bus_reset - report scsi _bus_ reset observed
391    scsi_track_queue_full - track successive QUEUE_FULL events 
392    scsi_unblock_requests - allow further commands to be queued to given host
393    scsi_unregister - [calls scsi_host_put()]
394
395
396 Details:
397
398 /**
399  * scsi_activate_tcq - turn on tag command queueing ("ordered" task attribute)
400  * @sdev:       device to turn on TCQ for
401  * @depth:      queue depth
402  *
403  *      Returns nothing
404  *
405  *      Might block: no
406  *
407  *      Notes: Eventually, it is hoped depth would be the maximum depth
408  *      the device could cope with and the real queue depth
409  *      would be adjustable from 0 to depth.
410  *
411  *      Defined (inline) in: include/scsi/scsi_tcq.h
412  **/
413 void scsi_activate_tcq(struct scsi_device *sdev, int depth)
414
415
416 /**
417  * scsi_add_device - creates new scsi device (lu) instance
418  * @shost:   pointer to scsi host instance
419  * @channel: channel number (rarely other than 0)
420  * @id:      target id number
421  * @lun:     logical unit number
422  *
423  *      Returns pointer to new struct scsi_device instance or 
424  *      ERR_PTR(-ENODEV) (or some other bent pointer) if something is
425  *      wrong (e.g. no lu responds at given address)
426  *
427  *      Might block: yes
428  *
429  *      Notes: This call is usually performed internally during a scsi
430  *      bus scan when an HBA is added (i.e. scsi_add_host()). So it
431  *      should only be called if the HBA becomes aware of a new scsi
432  *      device (lu) after scsi_add_host() has completed. If successful
433  *      this call we lead to slave_alloc() and slave_configure() callbacks
434  *      into the LLD.
435  *
436  *      Defined in: drivers/scsi/scsi_scan.c
437  **/
438 struct scsi_device * scsi_add_device(struct Scsi_Host *shost, 
439                                      unsigned int channel,
440                                      unsigned int id, unsigned int lun)
441
442
443 /**
444  * scsi_add_host - perform sysfs registration and SCSI bus scan.
445  * @shost:   pointer to scsi host instance
446  * @dev:     pointer to struct device of type scsi class
447  *
448  *      Returns 0 on success, negative errno of failure (e.g. -ENOMEM)
449  *
450  *      Might block: no
451  *
452  *      Notes: Only required in "hotplug initialization model" after a
453  *      successful call to scsi_host_alloc().
454  *
455  *      Defined in: drivers/scsi/hosts.c
456  **/
457 int scsi_add_host(struct Scsi_Host *shost, struct device * dev)
458
459
460 /**
461  * scsi_add_timer - (re-)start timer on a SCSI command.
462  * @scmd:    pointer to scsi command instance
463  * @timeout: duration of timeout in "jiffies"
464  * @complete: pointer to function to call if timeout expires
465  *
466  *      Returns nothing
467  *
468  *      Might block: no
469  *
470  *      Notes: Each scsi command has its own timer, and as it is added
471  *      to the queue, we set up the timer. When the command completes, 
472  *      we cancel the timer. An LLD can use this function to change
473  *      the existing timeout value.
474  *
475  *      Defined in: drivers/scsi/scsi_error.c
476  **/
477 void scsi_add_timer(struct scsi_cmnd *scmd, int timeout, 
478                     void (*complete)(struct scsi_cmnd *))
479
480
481 /**
482  * scsi_adjust_queue_depth - allow LLD to change queue depth on a SCSI device
483  * @sdev:       pointer to SCSI device to change queue depth on
484  * @tagged:     0 - no tagged queuing
485  *              MSG_SIMPLE_TAG - simple tagged queuing
486  *              MSG_ORDERED_TAG - ordered tagged queuing
487  * @tags        Number of tags allowed if tagged queuing enabled,
488  *              or number of commands the LLD can queue up
489  *              in non-tagged mode (as per cmd_per_lun).
490  *
491  *      Returns nothing
492  *
493  *      Might block: no
494  *
495  *      Notes: Can be invoked any time on a SCSI device controlled by this
496  *      LLD. [Specifically during and after slave_configure() and prior to
497  *      slave_destroy().] Can safely be invoked from interrupt code. Actual
498  *      queue depth change may be delayed until the next command is being
499  *      processed. See also scsi_activate_tcq() and scsi_deactivate_tcq().
500  *
501  *      Defined in: drivers/scsi/scsi.c [see source code for more notes]
502  *
503  **/
504 void scsi_adjust_queue_depth(struct scsi_device * sdev, int tagged, 
505                              int tags)
506
507
508 /**
509  * scsi_assign_lock - replace default host_lock with given lock
510  * @shost: a pointer to a scsi host instance
511  * @lock: pointer to lock to replace host_lock for this host
512  *
513  *      Returns nothing
514  *
515  *      Might block: no
516  *
517  *      Defined in: include/scsi/scsi_host.h .
518  **/
519 void scsi_assign_lock(struct Scsi_Host *shost, spinlock_t *lock)
520
521
522 /**
523  * scsi_bios_ptable - return copy of block device's partition table
524  * @dev:        pointer to block device
525  *
526  *      Returns pointer to partition table, or NULL for failure
527  *
528  *      Might block: yes
529  *
530  *      Notes: Caller owns memory returned (free with kfree() )
531  *
532  *      Defined in: drivers/scsi/scsicam.c
533  **/
534 unsigned char *scsi_bios_ptable(struct block_device *dev)
535
536
537 /**
538  * scsi_block_requests - prevent further commands being queued to given host
539  *
540  * @shost: pointer to host to block commands on
541  *
542  *      Returns nothing
543  *
544  *      Might block: no
545  *
546  *      Notes: There is no timer nor any other means by which the requests
547  *      get unblocked other than the LLD calling scsi_unblock_requests().
548  *
549  *      Defined in: drivers/scsi/scsi_lib.c
550 **/
551 void scsi_block_requests(struct Scsi_Host * shost)
552
553
554 /**
555  * scsi_deactivate_tcq - turn off tag command queueing
556  * @sdev:       device to turn off TCQ for
557  * @depth:      queue depth (stored in sdev)
558  *
559  *      Returns nothing
560  *
561  *      Might block: no
562  *
563  *      Defined (inline) in: include/scsi/scsi_tcq.h
564  **/
565 void scsi_deactivate_tcq(struct scsi_device *sdev, int depth)
566
567
568 /**
569  * scsi_delete_timer - cancel timer on a SCSI command.
570  * @scmd:    pointer to scsi command instance
571  *
572  *      Returns 1 if able to cancel timer else 0 (i.e. too late or already
573  *      cancelled).
574  *
575  *      Might block: no [may in the future if it invokes del_timer_sync()]
576  *
577  *      Notes: All commands issued by upper levels already have a timeout
578  *      associated with them. An LLD can use this function to cancel the
579  *      timer.
580  *
581  *      Defined in: drivers/scsi/scsi_error.c
582  **/
583 int scsi_delete_timer(struct scsi_cmnd *scmd)
584
585
586 /**
587  * scsi_host_alloc - create a scsi host adapter instance and perform basic
588  *                   initialization.
589  * @sht:        pointer to scsi host template
590  * @privsize:   extra bytes to allocate in hostdata array (which is the
591  *              last member of the returned Scsi_Host instance)
592  *
593  *      Returns pointer to new Scsi_Host instance or NULL on failure
594  *
595  *      Might block: yes
596  *
597  *      Notes: When this call returns to the LLD, the SCSI bus scan on
598  *      this host has _not_ yet been done.
599  *      The hostdata array (by default zero length) is a per host scratch 
600  *      area for the LLD's exclusive use.
601  *      Both associated refcounting objects have their refcount set to 1.
602  *      Full registration (in sysfs) and a bus scan are performed later when
603  *      scsi_add_host() is called.
604  *
605  *      Defined in: drivers/scsi/hosts.c .
606  **/
607 struct Scsi_Host * scsi_host_alloc(struct scsi_host_template * sht,
608                                    int privsize)
609
610
611 /**
612  * scsi_host_get - increment Scsi_Host instance refcount
613  * @shost:   pointer to struct Scsi_Host instance
614  *
615  *      Returns nothing
616  *
617  *      Might block: currently may block but may be changed to not block
618  *
619  *      Notes: Actually increments the counts in two sub-objects
620  *
621  *      Defined in: drivers/scsi/hosts.c
622  **/
623 void scsi_host_get(struct Scsi_Host *shost)
624
625
626 /**
627  * scsi_host_put - decrement Scsi_Host instance refcount, free if 0
628  * @shost:   pointer to struct Scsi_Host instance
629  *
630  *      Returns nothing
631  *
632  *      Might block: currently may block but may be changed to not block
633  *
634  *      Notes: Actually decrements the counts in two sub-objects. If the
635  *      latter refcount reaches 0, the Scsi_Host instance is freed.
636  *      The LLD need not worry exactly when the Scsi_Host instance is
637  *      freed, it just shouldn't access the instance after it has balanced
638  *      out its refcount usage.
639  *
640  *      Defined in: drivers/scsi/hosts.c
641  **/
642 void scsi_host_put(struct Scsi_Host *shost)
643
644
645 /**
646  * scsi_partsize - parse partition table into cylinders, heads + sectors
647  * @buf: pointer to partition table
648  * @capacity: size of (total) disk in 512 byte sectors
649  * @cyls: outputs number of cylinders calculated via this pointer
650  * @hds: outputs number of heads calculated via this pointer
651  * @secs: outputs number of sectors calculated via this pointer
652  *
653  *      Returns 0 on success, -1 on failure
654  *
655  *      Might block: no
656  *
657  *      Notes: Caller owns memory returned (free with kfree() )
658  *
659  *      Defined in: drivers/scsi/scsicam.c
660  **/
661 int scsi_partsize(unsigned char *buf, unsigned long capacity,
662                   unsigned int *cyls, unsigned int *hds, unsigned int *secs)
663
664
665 /**
666  * scsi_register - create and register a scsi host adapter instance.
667  * @sht:        pointer to scsi host template
668  * @privsize:   extra bytes to allocate in hostdata array (which is the
669  *              last member of the returned Scsi_Host instance)
670  *
671  *      Returns pointer to new Scsi_Host instance or NULL on failure
672  *
673  *      Might block: yes
674  *
675  *      Notes: When this call returns to the LLD, the SCSI bus scan on
676  *      this host has _not_ yet been done.
677  *      The hostdata array (by default zero length) is a per host scratch 
678  *      area for the LLD.
679  *
680  *      Defined in: drivers/scsi/hosts.c .
681  **/
682 struct Scsi_Host * scsi_register(struct scsi_host_template * sht,
683                                  int privsize)
684
685
686 /**
687  * scsi_remove_device - detach and remove a SCSI device
688  * @sdev:      a pointer to a scsi device instance
689  *
690  *      Returns value: 0 on success, -EINVAL if device not attached
691  *
692  *      Might block: yes
693  *
694  *      Notes: If an LLD becomes aware that a scsi device (lu) has
695  *      been removed but its host is still present then it can request
696  *      the removal of that scsi device. If successful this call will
697  *      lead to the slave_destroy() callback being invoked. sdev is an 
698  *      invalid pointer after this call.
699  *
700  *      Defined in: drivers/scsi/scsi_sysfs.c .
701  **/
702 int scsi_remove_device(struct scsi_device *sdev)
703
704
705 /**
706  * scsi_remove_host - detach and remove all SCSI devices owned by host
707  * @shost:      a pointer to a scsi host instance
708  *
709  *      Returns value: 0 on success, 1 on failure (e.g. LLD busy ??)
710  *
711  *      Might block: yes
712  *
713  *      Notes: Should only be invoked if the "hotplug initialization
714  *      model" is being used. It should be called _prior_ to  
715  *      scsi_unregister().
716  *
717  *      Defined in: drivers/scsi/hosts.c .
718  **/
719 int scsi_remove_host(struct Scsi_Host *shost)
720
721
722 /**
723  * scsi_report_bus_reset - report scsi _bus_ reset observed
724  * @shost: a pointer to a scsi host involved
725  * @channel: channel (within) host on which scsi bus reset occurred
726  *
727  *      Returns nothing
728  *
729  *      Might block: no
730  *
731  *      Notes: This only needs to be called if the reset is one which
732  *      originates from an unknown location.  Resets originated by the 
733  *      mid level itself don't need to call this, but there should be 
734  *      no harm.  The main purpose of this is to make sure that a
735  *      CHECK_CONDITION is properly treated.
736  *
737  *      Defined in: drivers/scsi/scsi_error.c .
738  **/
739 void scsi_report_bus_reset(struct Scsi_Host * shost, int channel)
740
741
742 /**
743  * scsi_track_queue_full - track successive QUEUE_FULL events on given
744  *                      device to determine if and when there is a need
745  *                      to adjust the queue depth on the device.
746  * @sdev:  pointer to SCSI device instance
747  * @depth: Current number of outstanding SCSI commands on this device,
748  *         not counting the one returned as QUEUE_FULL.
749  *
750  *      Returns 0  - no change needed
751  *              >0 - adjust queue depth to this new depth
752  *              -1 - drop back to untagged operation using host->cmd_per_lun
753  *                   as the untagged command depth
754  *
755  *      Might block: no
756  *
757  *      Notes: LLDs may call this at any time and we will do "The Right
758  *              Thing"; interrupt context safe. 
759  *
760  *      Defined in: drivers/scsi/scsi.c .
761  **/
762 int scsi_track_queue_full(Scsi_Device *sdev, int depth)
763
764
765 /**
766  * scsi_unblock_requests - allow further commands to be queued to given host
767  *
768  * @shost: pointer to host to unblock commands on
769  *
770  *      Returns nothing
771  *
772  *      Might block: no
773  *
774  *      Defined in: drivers/scsi/scsi_lib.c .
775 **/
776 void scsi_unblock_requests(struct Scsi_Host * shost)
777
778
779 /**
780  * scsi_unregister - unregister and free memory used by host instance
781  * @shp:        pointer to scsi host instance to unregister.
782  *
783  *      Returns nothing
784  *
785  *      Might block: no
786  *
787  *      Notes: Should not be invoked if the "hotplug initialization
788  *      model" is being used. Called internally by exit_this_scsi_driver()
789  *      in the "passive initialization model". Hence a LLD has no need to
790  *      call this function directly.
791  *
792  *      Defined in: drivers/scsi/hosts.c .
793  **/
794 void scsi_unregister(struct Scsi_Host * shp)
795
796
797
798
799 Interface Functions
800 ===================
801 Interface functions are supplied (defined) by LLDs and their function
802 pointers are placed in an instance of struct scsi_host_template which
803 is passed to scsi_host_alloc() [or scsi_register() / init_this_scsi_driver()].
804 Some are mandatory. Interface functions should be declared static. The
805 accepted convention is that driver "xyz" will declare its slave_configure() 
806 function as:
807     static int xyz_slave_configure(struct scsi_device * sdev);
808 and so forth for all interface functions listed below.
809
810 A pointer to this function should be placed in the 'slave_configure' member
811 of a "struct scsi_host_template" instance. A pointer to such an instance
812 should be passed to the mid level's scsi_host_alloc() [or scsi_register() /
813 init_this_scsi_driver()].
814
815 The interface functions are also described in the include/scsi/scsi_host.h
816 file immediately above their definition point in "struct scsi_host_template".
817 In some cases more detail is given in scsi_host.h than below.
818
819 The interface functions are listed below in alphabetical order.
820
821 Summary:
822    bios_param - fetch head, sector, cylinder info for a disk
823    detect - detects HBAs this driver wants to control
824    eh_timed_out - notify the host that a command timer expired
825    eh_abort_handler - abort given command
826    eh_bus_reset_handler - issue SCSI bus reset
827    eh_device_reset_handler - issue SCSI device reset
828    eh_host_reset_handler - reset host (host bus adapter)
829    eh_strategy_handler - driver supplied alternate to scsi_unjam_host()
830    info - supply information about given host
831    ioctl - driver can respond to ioctls
832    proc_info - supports /proc/scsi/{driver_name}/{host_no}
833    queuecommand - queue scsi command, invoke 'done' on completion
834    release - release all resources associated with given host
835    slave_alloc - prior to any commands being sent to a new device 
836    slave_configure - driver fine tuning for given device after attach
837    slave_destroy - given device is about to be shut down
838
839
840 Details:
841
842 /**
843  *      bios_param - fetch head, sector, cylinder info for a disk
844  *      @sdev: pointer to scsi device context (defined in 
845  *             include/scsi/scsi_device.h)
846  *      @bdev: pointer to block device context (defined in fs.h)
847  *      @capacity:  device size (in 512 byte sectors)
848  *      @params: three element array to place output:
849  *              params[0] number of heads (max 255)
850  *              params[1] number of sectors (max 63)
851  *              params[2] number of cylinders 
852  *
853  *      Return value is ignored
854  *
855  *      Locks: none
856  *
857  *      Calling context: process (sd)
858  *
859  *      Notes: an arbitrary geometry (based on READ CAPACITY) is used
860  *      if this function is not provided. The params array is
861  *      pre-initialized with made up values just in case this function 
862  *      doesn't output anything.
863  *
864  *      Optionally defined in: LLD
865  **/
866     int bios_param(struct scsi_device * sdev, struct block_device *bdev,
867                    sector_t capacity, int params[3])
868
869
870 /**
871  *      detect - detects HBAs this driver wants to control
872  *      @shtp: host template for this driver.
873  *
874  *      Returns number of hosts this driver wants to control. 0 means no
875  *      suitable hosts found.
876  *
877  *      Locks: none held
878  *
879  *      Calling context: process [invoked from init_this_scsi_driver()]
880  *
881  *      Notes: First function called from the SCSI mid level on this
882  *      driver. Upper level drivers (e.g. sd) may not (yet) be present.
883  *      For each host found, this method should call scsi_register() 
884  *      [see hosts.c].
885  *
886  *      Defined in: LLD (required if "passive initialization mode" is used,
887  *                       not invoked in "hotplug initialization mode")
888  **/
889     int detect(struct scsi_host_template * shtp)
890
891
892 /**
893  *      eh_timed_out - The timer for the command has just fired
894  *      @scp: identifies command timing out
895  *
896  *      Returns:
897  *
898  *      EH_HANDLED:             I fixed the error, please complete the command
899  *      EH_RESET_TIMER:         I need more time, reset the timer and
900  *                              begin counting again
901  *      EH_NOT_HANDLED          Begin normal error recovery
902  *
903  *
904  *      Locks: None held
905  *
906  *      Calling context: interrupt
907  *
908  *      Notes: This is to give the LLD an opportunity to do local recovery.
909  *      This recovery is limited to determining if the outstanding command
910  *      will ever complete.  You may not abort and restart the command from
911  *      this callback.
912  *
913  *      Optionally defined in: LLD
914  **/
915      int eh_timed_out(struct scsi_cmnd * scp)
916
917
918 /**
919  *      eh_abort_handler - abort command associated with scp
920  *      @scp: identifies command to be aborted
921  *
922  *      Returns SUCCESS if command aborted else FAILED
923  *
924  *      Locks: None held
925  *
926  *      Calling context: kernel thread
927  *
928  *      Notes: Invoked from scsi_eh thread. No other commands will be
929  *      queued on current host during eh.
930  *
931  *      Optionally defined in: LLD
932  **/
933      int eh_abort_handler(struct scsi_cmnd * scp)
934
935
936 /**
937  *      eh_bus_reset_handler - issue SCSI bus reset
938  *      @scp: SCSI bus that contains this device should be reset
939  *
940  *      Returns SUCCESS if command aborted else FAILED
941  *
942  *      Locks: None held
943  *
944  *      Calling context: kernel thread
945  *
946  *      Notes: Invoked from scsi_eh thread. No other commands will be
947  *      queued on current host during eh.
948  *
949  *      Optionally defined in: LLD
950  **/
951      int eh_bus_reset_handler(struct scsi_cmnd * scp)
952
953
954 /**
955  *      eh_device_reset_handler - issue SCSI device reset
956  *      @scp: identifies SCSI device to be reset
957  *
958  *      Returns SUCCESS if command aborted else FAILED
959  *
960  *      Locks: None held
961  *
962  *      Calling context: kernel thread
963  *
964  *      Notes: Invoked from scsi_eh thread. No other commands will be
965  *      queued on current host during eh.
966  *
967  *      Optionally defined in: LLD
968  **/
969      int eh_device_reset_handler(struct scsi_cmnd * scp)
970
971
972 /**
973  *      eh_host_reset_handler - reset host (host bus adapter)
974  *      @scp: SCSI host that contains this device should be reset
975  *
976  *      Returns SUCCESS if command aborted else FAILED
977  *
978  *      Locks: None held
979  *
980  *      Calling context: kernel thread
981  *
982  *      Notes: Invoked from scsi_eh thread. No other commands will be
983  *      queued on current host during eh. 
984  *      With the default eh_strategy in place, if none of the _abort_, 
985  *      _device_reset_, _bus_reset_ or this eh handler function are 
986  *      defined (or they all return FAILED) then the device in question 
987  *      will be set offline whenever eh is invoked.
988  *
989  *      Optionally defined in: LLD
990  **/
991      int eh_host_reset_handler(struct scsi_cmnd * scp)
992
993
994 /**
995  *      eh_strategy_handler - driver supplied alternate to scsi_unjam_host()
996  *      @shp: host on which error has occurred
997  *
998  *      Returns TRUE if host unjammed, else FALSE.
999  *
1000  *      Locks: none
1001  *
1002  *      Calling context: kernel thread
1003  *
1004  *      Notes: Invoked from scsi_eh thread. LLD supplied alternate to 
1005  *      scsi_unjam_host() found in scsi_error.c
1006  *
1007  *      Optionally defined in: LLD
1008  **/
1009      int eh_strategy_handler(struct Scsi_Host * shp)
1010
1011
1012 /**
1013  *      info - supply information about given host: driver name plus data
1014  *             to distinguish given host
1015  *      @shp: host to supply information about
1016  *
1017  *      Return ASCII null terminated string. [This driver is assumed to
1018  *      manage the memory pointed to and maintain it, typically for the
1019  *      lifetime of this host.]
1020  *
1021  *      Locks: none
1022  *
1023  *      Calling context: process
1024  *
1025  *      Notes: Often supplies PCI or ISA information such as IO addresses
1026  *      and interrupt numbers. If not supplied struct Scsi_Host::name used
1027  *      instead. It is assumed the returned information fits on one line 
1028  *      (i.e. does not included embedded newlines).
1029  *      The SCSI_IOCTL_PROBE_HOST ioctl yields the string returned by this
1030  *      function (or struct Scsi_Host::name if this function is not
1031  *      available).
1032  *      In a similar manner, init_this_scsi_driver() outputs to the console
1033  *      each host's "info" (or name) for the driver it is registering.
1034  *      Also if proc_info() is not supplied, the output of this function
1035  *      is used instead.
1036  *
1037  *      Optionally defined in: LLD
1038  **/
1039     const char * info(struct Scsi_Host * shp)
1040
1041
1042 /**
1043  *      ioctl - driver can respond to ioctls
1044  *      @sdp: device that ioctl was issued for
1045  *      @cmd: ioctl number
1046  *      @arg: pointer to read or write data from. Since it points to
1047  *            user space, should use appropriate kernel functions
1048  *            (e.g. copy_from_user() ). In the Unix style this argument
1049  *            can also be viewed as an unsigned long.
1050  *
1051  *      Returns negative "errno" value when there is a problem. 0 or a
1052  *      positive value indicates success and is returned to the user space.
1053  *
1054  *      Locks: none
1055  *
1056  *      Calling context: process
1057  *
1058  *      Notes: The SCSI subsystem uses a "trickle down" ioctl model.
1059  *      The user issues an ioctl() against an upper level driver
1060  *      (e.g. /dev/sdc) and if the upper level driver doesn't recognize
1061  *      the 'cmd' then it is passed to the SCSI mid level. If the SCSI
1062  *      mid level does not recognize it, then the LLD that controls
1063  *      the device receives the ioctl. According to recent Unix standards
1064  *      unsupported ioctl() 'cmd' numbers should return -ENOTTY.
1065  *
1066  *      Optionally defined in: LLD
1067  **/
1068     int ioctl(struct scsi_device *sdp, int cmd, void *arg)
1069
1070
1071 /**
1072  *      proc_info - supports /proc/scsi/{driver_name}/{host_no}
1073  *      @buffer: anchor point to output to (0==writeto1_read0) or fetch from
1074  *               (1==writeto1_read0).
1075  *      @start: where "interesting" data is written to. Ignored when
1076  *              1==writeto1_read0.
1077  *      @offset: offset within buffer 0==writeto1_read0 is actually
1078  *               interested in. Ignored when 1==writeto1_read0 .
1079  *      @length: maximum (or actual) extent of buffer
1080  *      @host_no: host number of interest (struct Scsi_Host::host_no)
1081  *      @writeto1_read0: 1 -> data coming from user space towards driver
1082  *                            (e.g. "echo some_string > /proc/scsi/xyz/2")
1083  *                       0 -> user what data from this driver
1084  *                            (e.g. "cat /proc/scsi/xyz/2")
1085  *
1086  *      Returns length when 1==writeto1_read0. Otherwise number of chars
1087  *      output to buffer past offset.
1088  *
1089  *      Locks: none held
1090  *
1091  *      Calling context: process
1092  *
1093  *      Notes: Driven from scsi_proc.c which interfaces to proc_fs. proc_fs
1094  *      support can now be configured out of the scsi subsystem.
1095  *
1096  *      Optionally defined in: LLD
1097  **/
1098     int proc_info(char * buffer, char ** start, off_t offset, 
1099                   int length, int host_no, int writeto1_read0)
1100
1101
1102 /**
1103  *      queuecommand - queue scsi command, invoke 'done' on completion
1104  *      @scp: pointer to scsi command object
1105  *      @done: function pointer to be invoked on completion
1106  *
1107  *      Returns 0 on success.
1108  *
1109  *      If there's a failure, return either:
1110  *
1111  *      SCSI_MLQUEUE_DEVICE_BUSY if the device queue is full, or
1112  *      SCSI_MLQUEUE_HOST_BUSY if the entire host queue is full
1113  *
1114  *      On both of these returns, the mid-layer will requeue the I/O
1115  *
1116  *      - if the return is SCSI_MLQUEUE_DEVICE_BUSY, only that particular
1117  *      device will be paused, and it will be unpaused when a command to
1118  *      the device returns (or after a brief delay if there are no more
1119  *      outstanding commands to it).  Commands to other devices continue
1120  *      to be processed normally.
1121  *
1122  *      - if the return is SCSI_MLQUEUE_HOST_BUSY, all I/O to the host
1123  *      is paused and will be unpaused when any command returns from
1124  *      the host (or after a brief delay if there are no outstanding
1125  *      commands to the host).
1126  *
1127  *      For compatibility with earlier versions of queuecommand, any
1128  *      other return value is treated the same as
1129  *      SCSI_MLQUEUE_HOST_BUSY.
1130  *
1131  *      Other types of errors that are detected immediately may be
1132  *      flagged by setting scp->result to an appropriate value,
1133  *      invoking the 'done' callback, and then returning 0 from this
1134  *      function. If the command is not performed immediately (and the
1135  *      LLD is starting (or will start) the given command) then this
1136  *      function should place 0 in scp->result and return 0.
1137  *
1138  *      Command ownership.  If the driver returns zero, it owns the
1139  *      command and must take responsibility for ensuring the 'done'
1140  *      callback is executed.  Note: the driver may call done before
1141  *      returning zero, but after it has called done, it may not
1142  *      return any value other than zero.  If the driver makes a
1143  *      non-zero return, it must not execute the command's done
1144  *      callback at any time.
1145  *
1146  *      Locks: struct Scsi_Host::host_lock held on entry (with "irqsave")
1147  *             and is expected to be held on return.
1148  *
1149  *      Calling context: in interrupt (soft irq) or process context
1150  *
1151  *      Notes: This function should be relatively fast. Normally it will
1152  *      not wait for IO to complete. Hence the 'done' callback is invoked 
1153  *      (often directly from an interrupt service routine) some time after
1154  *      this function has returned. In some cases (e.g. pseudo adapter 
1155  *      drivers that manufacture the response to a SCSI INQUIRY)
1156  *      the 'done' callback may be invoked before this function returns.
1157  *      If the 'done' callback is not invoked within a certain period
1158  *      the SCSI mid level will commence error processing.
1159  *      If a status of CHECK CONDITION is placed in "result" when the
1160  *      'done' callback is invoked, then the LLD driver should 
1161  *      perform autosense and fill in the struct scsi_cmnd::sense_buffer
1162  *      array. The scsi_cmnd::sense_buffer array is zeroed prior to
1163  *      the mid level queuing a command to an LLD.
1164  *
1165  *      Defined in: LLD
1166  **/
1167     int queuecommand(struct scsi_cmnd * scp, 
1168                      void (*done)(struct scsi_cmnd *))
1169
1170
1171 /**
1172  *      release - release all resources associated with given host
1173  *      @shp: host to be released.
1174  *
1175  *      Return value ignored (could soon be a function returning void).
1176  *
1177  *      Locks: none held
1178  *
1179  *      Calling context: process
1180  *
1181  *      Notes: Invoked from scsi_module.c's exit_this_scsi_driver().
1182  *      LLD's implementation of this function should call 
1183  *      scsi_unregister(shp) prior to returning.
1184  *      Only needed for old-style host templates.
1185  *
1186  *      Defined in: LLD (required in "passive initialization model",
1187  *                       should not be defined in hotplug model)
1188  **/
1189     int release(struct Scsi_Host * shp)
1190
1191
1192 /**
1193  *      slave_alloc -   prior to any commands being sent to a new device 
1194  *                      (i.e. just prior to scan) this call is made
1195  *      @sdp: pointer to new device (about to be scanned)
1196  *
1197  *      Returns 0 if ok. Any other return is assumed to be an error and
1198  *      the device is ignored.
1199  *
1200  *      Locks: none
1201  *
1202  *      Calling context: process
1203  *
1204  *      Notes: Allows the driver to allocate any resources for a device
1205  *      prior to its initial scan. The corresponding scsi device may not
1206  *      exist but the mid level is just about to scan for it (i.e. send
1207  *      and INQUIRY command plus ...). If a device is found then
1208  *      slave_configure() will be called while if a device is not found
1209  *      slave_destroy() is called.
1210  *      For more details see the include/scsi/scsi_host.h file.
1211  *
1212  *      Optionally defined in: LLD
1213  **/
1214     int slave_alloc(struct scsi_device *sdp)
1215
1216
1217 /**
1218  *      slave_configure - driver fine tuning for given device just after it
1219  *                     has been first scanned (i.e. it responded to an
1220  *                     INQUIRY)
1221  *      @sdp: device that has just been attached
1222  *
1223  *      Returns 0 if ok. Any other return is assumed to be an error and
1224  *      the device is taken offline. [offline devices will _not_ have
1225  *      slave_destroy() called on them so clean up resources.]
1226  *
1227  *      Locks: none
1228  *
1229  *      Calling context: process
1230  *
1231  *      Notes: Allows the driver to inspect the response to the initial
1232  *      INQUIRY done by the scanning code and take appropriate action.
1233  *      For more details see the include/scsi/scsi_host.h file.
1234  *
1235  *      Optionally defined in: LLD
1236  **/
1237     int slave_configure(struct scsi_device *sdp)
1238
1239
1240 /**
1241  *      slave_destroy - given device is about to be shut down. All
1242  *                      activity has ceased on this device.
1243  *      @sdp: device that is about to be shut down
1244  *
1245  *      Returns nothing
1246  *
1247  *      Locks: none
1248  *
1249  *      Calling context: process
1250  *
1251  *      Notes: Mid level structures for given device are still in place
1252  *      but are about to be torn down. Any per device resources allocated
1253  *      by this driver for given device should be freed now. No further
1254  *      commands will be sent for this sdp instance. [However the device
1255  *      could be re-attached in the future in which case a new instance
1256  *      of struct scsi_device would be supplied by future slave_alloc()
1257  *      and slave_configure() calls.]
1258  *
1259  *      Optionally defined in: LLD
1260  **/
1261     void slave_destroy(struct scsi_device *sdp)
1262
1263
1264
1265 Data Structures
1266 ===============
1267 struct scsi_host_template
1268 -------------------------
1269 There is one "struct scsi_host_template" instance per LLD ***. It is
1270 typically initialized as a file scope static in a driver's header file. That
1271 way members that are not explicitly initialized will be set to 0 or NULL.
1272 Member of interest:
1273     name         - name of driver (may contain spaces, please limit to
1274                    less than 80 characters)
1275     proc_name    - name used in "/proc/scsi/<proc_name>/<host_no>" and
1276                    by sysfs in one of its "drivers" directories. Hence
1277                    "proc_name" should only contain characters acceptable
1278                    to a Unix file name.
1279    (*queuecommand)() - primary callback that the mid level uses to inject
1280                    SCSI commands into an LLD.
1281 The structure is defined and commented in include/scsi/scsi_host.h
1282
1283 *** In extreme situations a single driver may have several instances
1284     if it controls several different classes of hardware (e.g. an LLD
1285     that handles both ISA and PCI cards and has a separate instance of
1286     struct scsi_host_template for each class).
1287
1288 struct Scsi_Host
1289 ----------------
1290 There is one struct Scsi_Host instance per host (HBA) that an LLD
1291 controls. The struct Scsi_Host structure has many members in common
1292 with "struct scsi_host_template". When a new struct Scsi_Host instance
1293 is created (in scsi_host_alloc() in hosts.c) those common members are
1294 initialized from the driver's struct scsi_host_template instance. Members
1295 of interest:
1296     host_no      - system wide unique number that is used for identifying
1297                    this host. Issued in ascending order from 0.
1298     can_queue    - must be greater than 0; do not send more than can_queue
1299                    commands to the adapter.
1300     this_id      - scsi id of host (scsi initiator) or -1 if not known
1301     sg_tablesize - maximum scatter gather elements allowed by host.
1302                    0 implies scatter gather not supported by host
1303     max_sectors  - maximum number of sectors (usually 512 bytes) allowed
1304                    in a single SCSI command. The default value of 0 leads
1305                    to a setting of SCSI_DEFAULT_MAX_SECTORS (defined in
1306                    scsi_host.h) which is currently set to 1024. So for a
1307                    disk the maximum transfer size is 512 KB when max_sectors
1308                    is not defined. Note that this size may not be sufficient
1309                    for disk firmware uploads.
1310     cmd_per_lun  - maximum number of commands that can be queued on devices
1311                    controlled by the host. Overridden by LLD calls to
1312                    scsi_adjust_queue_depth().
1313     unchecked_isa_dma - 1=>only use bottom 16 MB of ram (ISA DMA addressing
1314                    restriction), 0=>can use full 32 bit (or better) DMA
1315                    address space
1316     use_clustering - 1=>SCSI commands in mid level's queue can be merged,
1317                      0=>disallow SCSI command merging
1318     hostt        - pointer to driver's struct scsi_host_template from which
1319                    this struct Scsi_Host instance was spawned
1320     hostt->proc_name  - name of LLD. This is the driver name that sysfs uses
1321     transportt   - pointer to driver's struct scsi_transport_template instance
1322                    (if any). FC and SPI transports currently supported.
1323     sh_list      - a double linked list of pointers to all struct Scsi_Host
1324                    instances (currently ordered by ascending host_no)
1325     my_devices   - a double linked list of pointers to struct scsi_device 
1326                    instances that belong to this host.
1327     hostdata[0]  - area reserved for LLD at end of struct Scsi_Host. Size
1328                    is set by the second argument (named 'xtr_bytes') to
1329                    scsi_host_alloc() or scsi_register().
1330
1331 The scsi_host structure is defined in include/scsi/scsi_host.h
1332
1333 struct scsi_device
1334 ------------------
1335 Generally, there is one instance of this structure for each SCSI logical unit
1336 on a host. Scsi devices connected to a host are uniquely identified by a
1337 channel number, target id and logical unit number (lun).
1338 The structure is defined in include/scsi/scsi_device.h
1339
1340 struct scsi_cmnd
1341 ----------------
1342 Instances of this structure convey SCSI commands to the LLD and responses
1343 back to the mid level. The SCSI mid level will ensure that no more SCSI
1344 commands become queued against the LLD than are indicated by
1345 scsi_adjust_queue_depth() (or struct Scsi_Host::cmd_per_lun). There will
1346 be at least one instance of struct scsi_cmnd available for each SCSI device.
1347 Members of interest:
1348     cmnd         - array containing SCSI command
1349     cmnd_len     - length (in bytes) of SCSI command
1350     sc_data_direction - direction of data transfer in data phase. See
1351                 "enum dma_data_direction" in include/linux/dma-mapping.h
1352     request_bufflen - number of data bytes to transfer (0 if no data phase)
1353     use_sg       - ==0 -> no scatter gather list, hence transfer data
1354                           to/from request_buffer
1355                  - >0 ->  scatter gather list (actually an array) in
1356                           request_buffer with use_sg elements
1357     request_buffer - either contains data buffer or scatter gather list
1358                      depending on the setting of use_sg. Scatter gather
1359                      elements are defined by 'struct scatterlist' found
1360                      in include/asm/scatterlist.h .
1361     done         - function pointer that should be invoked by LLD when the
1362                    SCSI command is completed (successfully or otherwise).
1363                    Should only be called by an LLD if the LLD has accepted
1364                    the command (i.e. queuecommand() returned or will return
1365                    0). The LLD may invoke 'done'  prior to queuecommand()
1366                    finishing.
1367     result       - should be set by LLD prior to calling 'done'. A value
1368                    of 0 implies a successfully completed command (and all
1369                    data (if any) has been transferred to or from the SCSI
1370                    target device). 'result' is a 32 bit unsigned integer that
1371                    can be viewed as 4 related bytes. The SCSI status value is
1372                    in the LSB. See include/scsi/scsi.h status_byte(),
1373                    msg_byte(), host_byte() and driver_byte() macros and
1374                    related constants.
1375     sense_buffer - an array (maximum size: SCSI_SENSE_BUFFERSIZE bytes) that
1376                    should be written when the SCSI status (LSB of 'result')
1377                    is set to CHECK_CONDITION (2). When CHECK_CONDITION is
1378                    set, if the top nibble of sense_buffer[0] has the value 7
1379                    then the mid level will assume the sense_buffer array
1380                    contains a valid SCSI sense buffer; otherwise the mid
1381                    level will issue a REQUEST_SENSE SCSI command to
1382                    retrieve the sense buffer. The latter strategy is error
1383                    prone in the presence of command queuing so the LLD should
1384                    always "auto-sense".
1385     device       - pointer to scsi_device object that this command is
1386                    associated with.
1387     resid        - an LLD should set this signed integer to the requested
1388                    transfer length (i.e. 'request_bufflen') less the number
1389                    of bytes that are actually transferred. 'resid' is
1390                    preset to 0 so an LLD can ignore it if it cannot detect
1391                    underruns (overruns should be rare). If possible an LLD
1392                    should set 'resid' prior to invoking 'done'. The most
1393                    interesting case is data transfers from a SCSI target
1394                    device device (i.e. READs) that underrun. 
1395     underflow    - LLD should place (DID_ERROR << 16) in 'result' if
1396                    actual number of bytes transferred is less than this
1397                    figure. Not many LLDs implement this check and some that
1398                    do just output an error message to the log rather than
1399                    report a DID_ERROR. Better for an LLD to implement
1400                    'resid'.
1401
1402 The scsi_cmnd structure is defined in include/scsi/scsi_cmnd.h
1403
1404
1405 Locks
1406 =====
1407 Each struct Scsi_Host instance has a spin_lock called struct 
1408 Scsi_Host::default_lock which is initialized in scsi_host_alloc() [found in 
1409 hosts.c]. Within the same function the struct Scsi_Host::host_lock pointer
1410 is initialized to point at default_lock with the scsi_assign_lock() function.
1411 Thereafter lock and unlock operations performed by the mid level use the
1412 struct Scsi_Host::host_lock pointer.
1413
1414 LLDs can override the use of struct Scsi_Host::default_lock by
1415 using scsi_assign_lock(). The earliest opportunity to do this would
1416 be in the detect() function after it has invoked scsi_register(). It
1417 could be replaced by a coarser grain lock (e.g. per driver) or a
1418 lock of equal granularity (i.e. per host). Using finer grain locks 
1419 (e.g. per SCSI device) may be possible by juggling locks in
1420 queuecommand().
1421
1422 Autosense
1423 =========
1424 Autosense (or auto-sense) is defined in the SAM-2 document as "the
1425 automatic return of sense data to the application client coincident
1426 with the completion of a SCSI command" when a status of CHECK CONDITION
1427 occurs. LLDs should perform autosense. This should be done when the LLD
1428 detects a CHECK CONDITION status by either: 
1429     a) instructing the SCSI protocol (e.g. SCSI Parallel Interface (SPI))
1430        to perform an extra data in phase on such responses
1431     b) or, the LLD issuing a REQUEST SENSE command itself
1432
1433 Either way, when a status of CHECK CONDITION is detected, the mid level
1434 decides whether the LLD has performed autosense by checking struct 
1435 scsi_cmnd::sense_buffer[0] . If this byte has an upper nibble of 7 (or 0xf)
1436 then autosense is assumed to have taken place. If it has another value (and
1437 this byte is initialized to 0 before each command) then the mid level will
1438 issue a REQUEST SENSE command.
1439
1440 In the presence of queued commands the "nexus" that maintains sense
1441 buffer data from the command that failed until a following REQUEST SENSE
1442 may get out of synchronization. This is why it is best for the LLD
1443 to perform autosense.
1444
1445
1446 Changes since lk 2.4 series
1447 ===========================
1448 io_request_lock has been replaced by several finer grained locks. The lock 
1449 relevant to LLDs is struct Scsi_Host::host_lock and there is
1450 one per SCSI host.
1451
1452 The older error handling mechanism has been removed. This means the
1453 LLD interface functions abort() and reset() have been removed.
1454 The struct scsi_host_template::use_new_eh_code flag has been removed.
1455
1456 In the 2.4 series the SCSI subsystem configuration descriptions were 
1457 aggregated with the configuration descriptions from all other Linux 
1458 subsystems in the Documentation/Configure.help file. In the 2.6 series, 
1459 the SCSI subsystem now has its own (much smaller) drivers/scsi/Kconfig
1460 file that contains both configuration and help information.
1461
1462 struct SHT has been renamed to struct scsi_host_template.
1463
1464 Addition of the "hotplug initialization model" and many extra functions
1465 to support it.
1466
1467
1468 Credits
1469 =======
1470 The following people have contributed to this document:
1471         Mike Anderson <andmike at us dot ibm dot com>
1472         James Bottomley <James dot Bottomley at steeleye dot com> 
1473         Patrick Mansfield <patmans at us dot ibm dot com> 
1474         Christoph Hellwig <hch at infradead dot org>
1475         Doug Ledford <dledford at redhat dot com>
1476         Andries Brouwer <Andries dot Brouwer at cwi dot nl>
1477         Randy Dunlap <rddunlap at osdl dot org>
1478         Alan Stern <stern at rowland dot harvard dot edu>
1479
1480
1481 Douglas Gilbert
1482 dgilbert at interlog dot com
1483 21st September 2004