scsi.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:30k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  *  scsi.h Copyright (C) 1992 Drew Eckhardt 
  3.  *         Copyright (C) 1993, 1994, 1995, 1998, 1999 Eric Youngdale
  4.  *  generic SCSI package header file by
  5.  *      Initial versions: Drew Eckhardt
  6.  *      Subsequent revisions: Eric Youngdale
  7.  *
  8.  *  <drew@colorado.edu>
  9.  *
  10.  *       Modified by Eric Youngdale eric@andante.org to
  11.  *       add scatter-gather, multiple outstanding request, and other
  12.  *       enhancements.
  13.  */
  14. #ifndef _SCSI_H
  15. #define _SCSI_H
  16. #include <linux/config.h> /* for CONFIG_SCSI_LOGGING */
  17. #include <linux/devfs_fs_kernel.h>
  18. #include <linux/proc_fs.h>
  19. /*
  20.  * Some of the public constants are being moved to this file.
  21.  * We include it here so that what came from where is transparent.
  22.  */
  23. #include <scsi/scsi.h>
  24. #include <linux/random.h>
  25. #include <asm/hardirq.h>
  26. #include <asm/scatterlist.h>
  27. #include <asm/io.h>
  28. /*
  29.  * These are the values that the SCpnt->sc_data_direction and 
  30.  * SRpnt->sr_data_direction can take.  These need to be set
  31.  * The SCSI_DATA_UNKNOWN value is essentially the default.
  32.  * In the event that the command creator didn't bother to
  33.  * set a value, you will see SCSI_DATA_UNKNOWN.
  34.  */
  35. #define SCSI_DATA_UNKNOWN       0
  36. #define SCSI_DATA_WRITE         1
  37. #define SCSI_DATA_READ          2
  38. #define SCSI_DATA_NONE          3
  39. #ifdef CONFIG_PCI
  40. #include <linux/pci.h>
  41. #if ((SCSI_DATA_UNKNOWN == PCI_DMA_BIDIRECTIONAL) && (SCSI_DATA_WRITE == PCI_DMA_TODEVICE) && (SCSI_DATA_READ == PCI_DMA_FROMDEVICE) && (SCSI_DATA_NONE == PCI_DMA_NONE))
  42. #define scsi_to_pci_dma_dir(scsi_dir) ((int)(scsi_dir))
  43. #else
  44. extern __inline__ int scsi_to_pci_dma_dir(unsigned char scsi_dir)
  45. {
  46.         if (scsi_dir == SCSI_DATA_UNKNOWN)
  47.                 return PCI_DMA_BIDIRECTIONAL;
  48.         if (scsi_dir == SCSI_DATA_WRITE)
  49.                 return PCI_DMA_TODEVICE;
  50.         if (scsi_dir == SCSI_DATA_READ)
  51.                 return PCI_DMA_FROMDEVICE;
  52.         return PCI_DMA_NONE;
  53. }
  54. #endif
  55. #endif
  56. #if defined(CONFIG_SBUS) && !defined(CONFIG_SUN3) && !defined(CONFIG_SUN3X)
  57. #include <asm/sbus.h>
  58. #if ((SCSI_DATA_UNKNOWN == SBUS_DMA_BIDIRECTIONAL) && (SCSI_DATA_WRITE == SBUS_DMA_TODEVICE) && (SCSI_DATA_READ == SBUS_DMA_FROMDEVICE) && (SCSI_DATA_NONE == SBUS_DMA_NONE))
  59. #define scsi_to_sbus_dma_dir(scsi_dir) ((int)(scsi_dir))
  60. #else
  61. extern __inline__ int scsi_to_sbus_dma_dir(unsigned char scsi_dir)
  62. {
  63.         if (scsi_dir == SCSI_DATA_UNKNOWN)
  64.                 return SBUS_DMA_BIDIRECTIONAL;
  65.         if (scsi_dir == SCSI_DATA_WRITE)
  66.                 return SBUS_DMA_TODEVICE;
  67.         if (scsi_dir == SCSI_DATA_READ)
  68.                 return SBUS_DMA_FROMDEVICE;
  69.         return SBUS_DMA_NONE;
  70. }
  71. #endif
  72. #endif
  73. /*
  74.  * Some defs, in case these are not defined elsewhere.
  75.  */
  76. #ifndef TRUE
  77. #define TRUE 1
  78. #endif
  79. #ifndef FALSE
  80. #define FALSE 0
  81. #endif
  82. #define MAX_SCSI_DEVICE_CODE 14
  83. extern const char *const scsi_device_types[MAX_SCSI_DEVICE_CODE];
  84. #ifdef DEBUG
  85. #define SCSI_TIMEOUT (5*HZ)
  86. #else
  87. #define SCSI_TIMEOUT (2*HZ)
  88. #endif
  89. /*
  90.  * Used for debugging the new queueing code.  We want to make sure
  91.  * that the lock state is consistent with design.  Only do this in
  92.  * the user space simulator.
  93.  */
  94. #define ASSERT_LOCK(_LOCK, _COUNT)
  95. #if defined(CONFIG_SMP) && defined(CONFIG_USER_DEBUG)
  96. #undef ASSERT_LOCK
  97. #define ASSERT_LOCK(_LOCK,_COUNT)       
  98.         { if( (_LOCK)->lock != _COUNT )   
  99.                 panic("Lock count inconsistent %s %dn", __FILE__, __LINE__); 
  100.                                                                                        }
  101. #endif
  102. /*
  103.  *  Use these to separate status msg and our bytes
  104.  *
  105.  *  These are set by:
  106.  *
  107.  *      status byte = set from target device
  108.  *      msg_byte    = return status from host adapter itself.
  109.  *      host_byte   = set by low-level driver to indicate status.
  110.  *      driver_byte = set by mid-level.
  111.  */
  112. #define status_byte(result) (((result) >> 1) & 0x1f)
  113. #define msg_byte(result)    (((result) >> 8) & 0xff)
  114. #define host_byte(result)   (((result) >> 16) & 0xff)
  115. #define driver_byte(result) (((result) >> 24) & 0xff)
  116. #define suggestion(result)  (driver_byte(result) & SUGGEST_MASK)
  117. #define sense_class(sense)  (((sense) >> 4) & 0x7)
  118. #define sense_error(sense)  ((sense) & 0xf)
  119. #define sense_valid(sense)  ((sense) & 0x80);
  120. #define NEEDS_RETRY     0x2001
  121. #define SUCCESS         0x2002
  122. #define FAILED          0x2003
  123. #define QUEUED          0x2004
  124. #define SOFT_ERROR      0x2005
  125. #define ADD_TO_MLQUEUE  0x2006
  126. /*
  127.  * These are the values that scsi_cmd->state can take.
  128.  */
  129. #define SCSI_STATE_TIMEOUT         0x1000
  130. #define SCSI_STATE_FINISHED        0x1001
  131. #define SCSI_STATE_FAILED          0x1002
  132. #define SCSI_STATE_QUEUED          0x1003
  133. #define SCSI_STATE_UNUSED          0x1006
  134. #define SCSI_STATE_DISCONNECTING   0x1008
  135. #define SCSI_STATE_INITIALIZING    0x1009
  136. #define SCSI_STATE_BHQUEUE         0x100a
  137. #define SCSI_STATE_MLQUEUE         0x100b
  138. /*
  139.  * These are the values that the owner field can take.
  140.  * They are used as an indication of who the command belongs to.
  141.  */
  142. #define SCSI_OWNER_HIGHLEVEL      0x100
  143. #define SCSI_OWNER_MIDLEVEL       0x101
  144. #define SCSI_OWNER_LOWLEVEL       0x102
  145. #define SCSI_OWNER_ERROR_HANDLER  0x103
  146. #define SCSI_OWNER_BH_HANDLER     0x104
  147. #define SCSI_OWNER_NOBODY         0x105
  148. #define COMMAND_SIZE(opcode) scsi_command_size[((opcode) >> 5) & 7]
  149. #define IDENTIFY_BASE       0x80
  150. #define IDENTIFY(can_disconnect, lun)   (IDENTIFY_BASE |
  151.      ((can_disconnect) ?  0x40 : 0) |
  152.      ((lun) & 0x07))
  153. /*
  154.  * This defines the scsi logging feature.  It is a means by which the
  155.  * user can select how much information they get about various goings on,
  156.  * and it can be really useful for fault tracing.  The logging word is divided
  157.  * into 8 nibbles, each of which describes a loglevel.  The division of things
  158.  * is somewhat arbitrary, and the division of the word could be changed if it
  159.  * were really needed for any reason.  The numbers below are the only place where these
  160.  * are specified.  For a first go-around, 3 bits is more than enough, since this
  161.  * gives 8 levels of logging (really 7, since 0 is always off).  Cutting to 2 bits
  162.  * might be wise at some point.
  163.  */
  164. #define SCSI_LOG_ERROR_SHIFT              0
  165. #define SCSI_LOG_TIMEOUT_SHIFT            3
  166. #define SCSI_LOG_SCAN_SHIFT               6
  167. #define SCSI_LOG_MLQUEUE_SHIFT            9
  168. #define SCSI_LOG_MLCOMPLETE_SHIFT         12
  169. #define SCSI_LOG_LLQUEUE_SHIFT            15
  170. #define SCSI_LOG_LLCOMPLETE_SHIFT         18
  171. #define SCSI_LOG_HLQUEUE_SHIFT            21
  172. #define SCSI_LOG_HLCOMPLETE_SHIFT         24
  173. #define SCSI_LOG_IOCTL_SHIFT              27
  174. #define SCSI_LOG_ERROR_BITS               3
  175. #define SCSI_LOG_TIMEOUT_BITS             3
  176. #define SCSI_LOG_SCAN_BITS                3
  177. #define SCSI_LOG_MLQUEUE_BITS             3
  178. #define SCSI_LOG_MLCOMPLETE_BITS          3
  179. #define SCSI_LOG_LLQUEUE_BITS             3
  180. #define SCSI_LOG_LLCOMPLETE_BITS          3
  181. #define SCSI_LOG_HLQUEUE_BITS             3
  182. #define SCSI_LOG_HLCOMPLETE_BITS          3
  183. #define SCSI_LOG_IOCTL_BITS               3
  184. #if CONFIG_SCSI_LOGGING
  185. #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD)     
  186. {                                                       
  187.         unsigned int mask;                              
  188.                                                         
  189.         mask = (1 << (BITS)) - 1;                       
  190.         if( ((scsi_logging_level >> (SHIFT)) & mask) > (LEVEL) ) 
  191.         {                                               
  192.                 (CMD);                                  
  193.         }
  194. }
  195. #define SCSI_SET_LOGGING(SHIFT, BITS, LEVEL)            
  196. {                                                       
  197.         unsigned int mask;                              
  198.                                                         
  199.         mask = ((1 << (BITS)) - 1) << SHIFT;            
  200.         scsi_logging_level = ((scsi_logging_level & ~mask) 
  201.                               | ((LEVEL << SHIFT) & mask));     
  202. }
  203. #else
  204. /*
  205.  * With no logging enabled, stub these out so they don't do anything.
  206.  */
  207. #define SCSI_SET_LOGGING(SHIFT, BITS, LEVEL)
  208. #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD)
  209. #endif
  210. /*
  211.  * These are the macros that are actually used throughout the code to
  212.  * log events.  If logging isn't enabled, they are no-ops and will be
  213.  * completely absent from the user's code.
  214.  *
  215.  * The 'set' versions of the macros are really intended to only be called
  216.  * from the /proc filesystem, and in production kernels this will be about
  217.  * all that is ever used.  It could be useful in a debugging environment to
  218.  * bump the logging level when certain strange events are detected, however.
  219.  */
  220. #define SCSI_LOG_ERROR_RECOVERY(LEVEL,CMD)  
  221.         SCSI_CHECK_LOGGING(SCSI_LOG_ERROR_SHIFT, SCSI_LOG_ERROR_BITS, LEVEL,CMD);
  222. #define SCSI_LOG_TIMEOUT(LEVEL,CMD)  
  223.         SCSI_CHECK_LOGGING(SCSI_LOG_TIMEOUT_SHIFT, SCSI_LOG_TIMEOUT_BITS, LEVEL,CMD);
  224. #define SCSI_LOG_SCAN_BUS(LEVEL,CMD)  
  225.         SCSI_CHECK_LOGGING(SCSI_LOG_SCAN_SHIFT, SCSI_LOG_SCAN_BITS, LEVEL,CMD);
  226. #define SCSI_LOG_MLQUEUE(LEVEL,CMD)  
  227.         SCSI_CHECK_LOGGING(SCSI_LOG_MLQUEUE_SHIFT, SCSI_LOG_MLQUEUE_BITS, LEVEL,CMD);
  228. #define SCSI_LOG_MLCOMPLETE(LEVEL,CMD)  
  229.         SCSI_CHECK_LOGGING(SCSI_LOG_MLCOMPLETE_SHIFT, SCSI_LOG_MLCOMPLETE_BITS, LEVEL,CMD);
  230. #define SCSI_LOG_LLQUEUE(LEVEL,CMD)  
  231.         SCSI_CHECK_LOGGING(SCSI_LOG_LLQUEUE_SHIFT, SCSI_LOG_LLQUEUE_BITS, LEVEL,CMD);
  232. #define SCSI_LOG_LLCOMPLETE(LEVEL,CMD)  
  233.         SCSI_CHECK_LOGGING(SCSI_LOG_LLCOMPLETE_SHIFT, SCSI_LOG_LLCOMPLETE_BITS, LEVEL,CMD);
  234. #define SCSI_LOG_HLQUEUE(LEVEL,CMD)  
  235.         SCSI_CHECK_LOGGING(SCSI_LOG_HLQUEUE_SHIFT, SCSI_LOG_HLQUEUE_BITS, LEVEL,CMD);
  236. #define SCSI_LOG_HLCOMPLETE(LEVEL,CMD)  
  237.         SCSI_CHECK_LOGGING(SCSI_LOG_HLCOMPLETE_SHIFT, SCSI_LOG_HLCOMPLETE_BITS, LEVEL,CMD);
  238. #define SCSI_LOG_IOCTL(LEVEL,CMD)  
  239.         SCSI_CHECK_LOGGING(SCSI_LOG_IOCTL_SHIFT, SCSI_LOG_IOCTL_BITS, LEVEL,CMD);
  240. #define SCSI_SET_ERROR_RECOVERY_LOGGING(LEVEL)  
  241.         SCSI_SET_LOGGING(SCSI_LOG_ERROR_SHIFT, SCSI_LOG_ERROR_BITS, LEVEL);
  242. #define SCSI_SET_TIMEOUT_LOGGING(LEVEL)  
  243.         SCSI_SET_LOGGING(SCSI_LOG_TIMEOUT_SHIFT, SCSI_LOG_TIMEOUT_BITS, LEVEL);
  244. #define SCSI_SET_SCAN_BUS_LOGGING(LEVEL)  
  245.         SCSI_SET_LOGGING(SCSI_LOG_SCAN_SHIFT, SCSI_LOG_SCAN_BITS, LEVEL);
  246. #define SCSI_SET_MLQUEUE_LOGGING(LEVEL)  
  247.         SCSI_SET_LOGGING(SCSI_LOG_MLQUEUE_SHIFT, SCSI_LOG_MLQUEUE_BITS, LEVEL);
  248. #define SCSI_SET_MLCOMPLETE_LOGGING(LEVEL)  
  249.         SCSI_SET_LOGGING(SCSI_LOG_MLCOMPLETE_SHIFT, SCSI_LOG_MLCOMPLETE_BITS, LEVEL);
  250. #define SCSI_SET_LLQUEUE_LOGGING(LEVEL)  
  251.         SCSI_SET_LOGGING(SCSI_LOG_LLQUEUE_SHIFT, SCSI_LOG_LLQUEUE_BITS, LEVEL);
  252. #define SCSI_SET_LLCOMPLETE_LOGGING(LEVEL)  
  253.         SCSI_SET_LOGGING(SCSI_LOG_LLCOMPLETE_SHIFT, SCSI_LOG_LLCOMPLETE_BITS, LEVEL);
  254. #define SCSI_SET_HLQUEUE_LOGGING(LEVEL)  
  255.         SCSI_SET_LOGGING(SCSI_LOG_HLQUEUE_SHIFT, SCSI_LOG_HLQUEUE_BITS, LEVEL);
  256. #define SCSI_SET_HLCOMPLETE_LOGGING(LEVEL)  
  257.         SCSI_SET_LOGGING(SCSI_LOG_HLCOMPLETE_SHIFT, SCSI_LOG_HLCOMPLETE_BITS, LEVEL);
  258. #define SCSI_SET_IOCTL_LOGGING(LEVEL)  
  259.         SCSI_SET_LOGGING(SCSI_LOG_IOCTL_SHIFT, SCSI_LOG_IOCTL_BITS, LEVEL);
  260. /*
  261.  *  the return of the status word will be in the following format :
  262.  *  The low byte is the status returned by the SCSI command, 
  263.  *  with vendor specific bits masked.
  264.  *  
  265.  *  The next byte is the message which followed the SCSI status.
  266.  *  This allows a stos to be used, since the Intel is a little
  267.  *  endian machine.
  268.  *  
  269.  *  The final byte is a host return code, which is one of the following.
  270.  *  
  271.  *  IE 
  272.  *  lsb     msb
  273.  *  status  msg host code   
  274.  *  
  275.  *  Our errors returned by OUR driver, NOT SCSI message.  Or'd with
  276.  *  SCSI message passed back to driver <IF any>.
  277.  */
  278. #define DID_OK          0x00 /* NO error                                */
  279. #define DID_NO_CONNECT  0x01 /* Couldn't connect before timeout period  */
  280. #define DID_BUS_BUSY    0x02 /* BUS stayed busy through time out period */
  281. #define DID_TIME_OUT    0x03 /* TIMED OUT for other reason              */
  282. #define DID_BAD_TARGET  0x04 /* BAD target.                             */
  283. #define DID_ABORT       0x05 /* Told to abort for some other reason     */
  284. #define DID_PARITY      0x06 /* Parity error                            */
  285. #define DID_ERROR       0x07 /* Internal error                          */
  286. #define DID_RESET       0x08 /* Reset by somebody.                      */
  287. #define DID_BAD_INTR    0x09 /* Got an interrupt we weren't expecting.  */
  288. #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer            */
  289. #define DID_SOFT_ERROR  0x0b /* The low level driver just wish a retry  */
  290. #define DRIVER_OK       0x00 /* Driver status                           */
  291. /*
  292.  *  These indicate the error that occurred, and what is available.
  293.  */
  294. #define DRIVER_BUSY         0x01
  295. #define DRIVER_SOFT         0x02
  296. #define DRIVER_MEDIA        0x03
  297. #define DRIVER_ERROR        0x04
  298. #define DRIVER_INVALID      0x05
  299. #define DRIVER_TIMEOUT      0x06
  300. #define DRIVER_HARD         0x07
  301. #define DRIVER_SENSE     0x08
  302. #define SUGGEST_RETRY       0x10
  303. #define SUGGEST_ABORT       0x20
  304. #define SUGGEST_REMAP       0x30
  305. #define SUGGEST_DIE         0x40
  306. #define SUGGEST_SENSE       0x80
  307. #define SUGGEST_IS_OK       0xff
  308. #define DRIVER_MASK         0x0f
  309. #define SUGGEST_MASK        0xf0
  310. #define MAX_COMMAND_SIZE    16
  311. #define SCSI_SENSE_BUFFERSIZE   64
  312. /*
  313.  *  SCSI command sets
  314.  */
  315. #define SCSI_UNKNOWN    0
  316. #define SCSI_1          1
  317. #define SCSI_1_CCS      2
  318. #define SCSI_2          3
  319. #define SCSI_3          4
  320. /*
  321.  *  Every SCSI command starts with a one byte OP-code.
  322.  *  The next byte's high three bits are the LUN of the
  323.  *  device.  Any multi-byte quantities are stored high byte
  324.  *  first, and may have a 5 bit MSB in the same byte
  325.  *  as the LUN.
  326.  */
  327. /*
  328.  *  As the scsi do command functions are intelligent, and may need to
  329.  *  redo a command, we need to keep track of the last command
  330.  *  executed on each one.
  331.  */
  332. #define WAS_RESET       0x01
  333. #define WAS_TIMEDOUT    0x02
  334. #define WAS_SENSE       0x04
  335. #define IS_RESETTING    0x08
  336. #define IS_ABORTING     0x10
  337. #define ASKED_FOR_SENSE 0x20
  338. #define SYNC_RESET      0x40
  339. #if defined(__mc68000__) || defined(CONFIG_APUS)
  340. #include <asm/pgtable.h>
  341. #define CONTIGUOUS_BUFFERS(X,Y) 
  342. (virt_to_phys((X)->b_data+(X)->b_size-1)+1==virt_to_phys((Y)->b_data))
  343. #else
  344. #define CONTIGUOUS_BUFFERS(X,Y) ((X->b_data+X->b_size) == Y->b_data)
  345. #endif
  346. /*
  347.  * This is the crap from the old error handling code.  We have it in a special
  348.  * place so that we can more easily delete it later on.
  349.  */
  350. #include "scsi_obsolete.h"
  351. /*
  352.  * Add some typedefs so that we can prototyope a bunch of the functions.
  353.  */
  354. typedef struct scsi_device Scsi_Device;
  355. typedef struct scsi_cmnd Scsi_Cmnd;
  356. typedef struct scsi_request Scsi_Request;
  357. #define SCSI_CMND_MAGIC 0xE25C23A5
  358. #define SCSI_REQ_MAGIC  0x75F6D354
  359. /*
  360.  * Here is where we prototype most of the mid-layer.
  361.  */
  362. /*
  363.  *  Initializes all SCSI devices.  This scans all scsi busses.
  364.  */
  365. extern unsigned int scsi_logging_level; /* What do we log? */
  366. extern unsigned int scsi_dma_free_sectors; /* How much room do we have left */
  367. extern unsigned int scsi_need_isa_buffer; /* True if some devices need indirection
  368.    * buffers */
  369. extern volatile int in_scan_scsis;
  370. extern const unsigned char scsi_command_size[8];
  371. /*
  372.  * These are the error handling functions defined in scsi_error.c
  373.  */
  374. extern void scsi_times_out(Scsi_Cmnd * SCpnt);
  375. extern void scsi_add_timer(Scsi_Cmnd * SCset, int timeout,
  376.    void (*complete) (Scsi_Cmnd *));
  377. extern int scsi_delete_timer(Scsi_Cmnd * SCset);
  378. extern void scsi_error_handler(void *host);
  379. extern int scsi_sense_valid(Scsi_Cmnd *);
  380. extern int scsi_decide_disposition(Scsi_Cmnd * SCpnt);
  381. extern int scsi_block_when_processing_errors(Scsi_Device *);
  382. extern void scsi_sleep(int);
  383. /*
  384.  * Prototypes for functions in scsicam.c
  385.  */
  386. extern int  scsi_partsize(struct buffer_head *bh, unsigned long capacity,
  387.                     unsigned int *cyls, unsigned int *hds,
  388.                     unsigned int *secs);
  389. /*
  390.  * Prototypes for functions in scsi_dma.c
  391.  */
  392. void scsi_resize_dma_pool(void);
  393. int scsi_init_minimal_dma_pool(void);
  394. void *scsi_malloc(unsigned int);
  395. int scsi_free(void *, unsigned int);
  396. /*
  397.  * Prototypes for functions in scsi_merge.c
  398.  */
  399. extern void recount_segments(Scsi_Cmnd * SCpnt);
  400. extern void initialize_merge_fn(Scsi_Device * SDpnt);
  401. /*
  402.  * Prototypes for functions in scsi_queue.c
  403.  */
  404. extern int scsi_mlqueue_insert(Scsi_Cmnd * cmd, int reason);
  405. /*
  406.  * Prototypes for functions in scsi_lib.c
  407.  */
  408. extern int scsi_maybe_unblock_host(Scsi_Device * SDpnt);
  409. extern Scsi_Cmnd *scsi_end_request(Scsi_Cmnd * SCpnt, int uptodate,
  410.    int sectors);
  411. extern struct Scsi_Device_Template *scsi_get_request_dev(struct request *);
  412. extern int scsi_init_cmd_errh(Scsi_Cmnd * SCpnt);
  413. extern int scsi_insert_special_cmd(Scsi_Cmnd * SCpnt, int);
  414. extern void scsi_io_completion(Scsi_Cmnd * SCpnt, int good_sectors,
  415.        int block_sectors);
  416. extern void scsi_queue_next_request(request_queue_t * q, Scsi_Cmnd * SCpnt);
  417. extern void scsi_request_fn(request_queue_t * q);
  418. extern int scsi_starvation_completion(Scsi_Device * SDpnt);
  419. /*
  420.  * Prototypes for functions in scsi.c
  421.  */
  422. extern int scsi_dispatch_cmd(Scsi_Cmnd * SCpnt);
  423. extern void scsi_bottom_half_handler(void);
  424. extern void scsi_release_commandblocks(Scsi_Device * SDpnt);
  425. extern void scsi_build_commandblocks(Scsi_Device * SDpnt);
  426. extern void scsi_done(Scsi_Cmnd * SCpnt);
  427. extern void scsi_finish_command(Scsi_Cmnd *);
  428. extern int scsi_retry_command(Scsi_Cmnd *);
  429. extern Scsi_Cmnd *scsi_allocate_device(Scsi_Device *, int, int);
  430. extern void __scsi_release_command(Scsi_Cmnd *);
  431. extern void scsi_release_command(Scsi_Cmnd *);
  432. extern void scsi_do_cmd(Scsi_Cmnd *, const void *cmnd,
  433. void *buffer, unsigned bufflen,
  434. void (*done) (struct scsi_cmnd *),
  435. int timeout, int retries);
  436. extern int scsi_dev_init(void);
  437. /*
  438.  * Newer request-based interfaces.
  439.  */
  440. extern Scsi_Request *scsi_allocate_request(Scsi_Device *);
  441. extern void scsi_release_request(Scsi_Request *);
  442. extern void scsi_wait_req(Scsi_Request *, const void *cmnd,
  443.   void *buffer, unsigned bufflen,
  444.   int timeout, int retries);
  445. extern void scsi_do_req(Scsi_Request *, const void *cmnd,
  446. void *buffer, unsigned bufflen,
  447. void (*done) (struct scsi_cmnd *),
  448. int timeout, int retries);
  449. extern int scsi_insert_special_req(Scsi_Request * SRpnt, int);
  450. extern void scsi_init_cmd_from_req(Scsi_Cmnd *, Scsi_Request *);
  451. /*
  452.  * Prototypes for functions/data in hosts.c
  453.  */
  454. extern int max_scsi_hosts;
  455. /*
  456.  * Prototypes for functions in scsi_proc.c
  457.  */
  458. extern void proc_print_scsidevice(Scsi_Device *, char *, int *, int);
  459. extern struct proc_dir_entry *proc_scsi;
  460. /*
  461.  * Prototypes for functions in constants.c
  462.  */
  463. extern void print_command(unsigned char *);
  464. extern void print_sense(const char *, Scsi_Cmnd *);
  465. extern void print_req_sense(const char *, Scsi_Request *);
  466. extern void print_driverbyte(int scsiresult);
  467. extern void print_hostbyte(int scsiresult);
  468. extern void print_status (int status);
  469. /*
  470.  *  The scsi_device struct contains what we know about each given scsi
  471.  *  device.
  472.  *
  473.  * FIXME(eric) - one of the great regrets that I have is that I failed to define
  474.  * these structure elements as something like sdev_foo instead of foo.  This would
  475.  * make it so much easier to grep through sources and so forth.  I propose that
  476.  * all new elements that get added to these structures follow this convention.
  477.  * As time goes on and as people have the stomach for it, it should be possible to 
  478.  * go back and retrofit at least some of the elements here with with the prefix.
  479.  */
  480. struct scsi_device {
  481. /* private: */
  482. /*
  483.  * This information is private to the scsi mid-layer.  Wrapping it in a
  484.  * struct private is a way of marking it in a sort of C++ type of way.
  485.  */
  486. struct scsi_device *next; /* Used for linked list */
  487. struct scsi_device *prev; /* Used for linked list */
  488. wait_queue_head_t   scpnt_wait; /* Used to wait if
  489.    device is busy */
  490. struct Scsi_Host *host;
  491. request_queue_t request_queue;
  492.         atomic_t                device_active; /* commands checked out for device */
  493. volatile unsigned short device_busy; /* commands actually active on low-level */
  494. int (*scsi_init_io_fn) (Scsi_Cmnd *); /* Used to initialize
  495.    new request */
  496. Scsi_Cmnd *device_queue; /* queue of SCSI Command structures */
  497. /* public: */
  498. unsigned int id, lun, channel;
  499. unsigned int manufacturer; /* Manufacturer of device, for using 
  500.  * vendor-specific cmd's */
  501. unsigned sector_size; /* size in bytes */
  502. int attached; /* # of high level drivers attached to this */
  503. int detected; /* Delta attached - don't use in drivers! */
  504. int access_count; /* Count of open channels/mounts */
  505. void *hostdata; /* available to low-level driver */
  506. devfs_handle_t de;      /* directory for the device      */
  507. char type;
  508. char scsi_level;
  509. char vendor[8], model[16], rev[4];
  510. unsigned char current_tag; /* current tag */
  511. unsigned char sync_min_period; /* Not less than this period */
  512. unsigned char sync_max_offset; /* Not greater than this offset */
  513. unsigned char queue_depth; /* How deep a queue to use */
  514. unsigned online:1;
  515. unsigned writeable:1;
  516. unsigned removable:1;
  517. unsigned random:1;
  518. unsigned has_cmdblocks:1;
  519. unsigned changed:1; /* Data invalid due to media change */
  520. unsigned busy:1; /* Used to prevent races */
  521. unsigned lockable:1; /* Able to prevent media removal */
  522. unsigned borken:1; /* Tell the Seagate driver to be 
  523.  * painfully slow on this device */
  524. unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
  525. unsigned tagged_queue:1; /* SCSI-II tagged queuing enabled */
  526. unsigned disconnect:1; /* can disconnect */
  527. unsigned soft_reset:1; /* Uses soft reset option */
  528. unsigned sync:1; /* Negotiate for sync transfers */
  529. unsigned wide:1; /* Negotiate for WIDE transfers */
  530. unsigned single_lun:1; /* Indicates we should only allow I/O to
  531.  * one of the luns for the device at a 
  532.  * time. */
  533. unsigned was_reset:1; /* There was a bus reset on the bus for 
  534.  * this device */
  535. unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
  536.  * because we did a bus reset. */
  537. unsigned device_blocked:1; /* Device returned QUEUE_FULL. */
  538. unsigned ten:1; /* support ten byte read / write */
  539. unsigned remap:1; /* support remapping  */
  540. unsigned starved:1; /* unable to process commands because
  541.    host busy */
  542. // Flag to allow revalidate to succeed in sd_open
  543. int allow_revalidate;
  544. };
  545. /*
  546.  * The Scsi_Cmnd structure is used by scsi.c internally, and for communication
  547.  * with low level drivers that support multiple outstanding commands.
  548.  */
  549. typedef struct scsi_pointer {
  550. char *ptr; /* data pointer */
  551. int this_residual; /* left in this buffer */
  552. struct scatterlist *buffer; /* which buffer */
  553. int buffers_residual; /* how many buffers left */
  554.         dma_addr_t dma_handle;
  555. volatile int Status;
  556. volatile int Message;
  557. volatile int have_data_in;
  558. volatile int sent_command;
  559. volatile int phase;
  560. } Scsi_Pointer;
  561. /*
  562.  * This is essentially a slimmed down version of Scsi_Cmnd.  The point of
  563.  * having this is that requests that are injected into the queue as result
  564.  * of things like ioctls and character devices shouldn't be using a
  565.  * Scsi_Cmnd until such a time that the command is actually at the head
  566.  * of the queue and being sent to the driver.
  567.  */
  568. struct scsi_request {
  569. int     sr_magic;
  570. int     sr_result; /* Status code from lower level driver */
  571. unsigned char sr_sense_buffer[SCSI_SENSE_BUFFERSIZE]; /* obtained by REQUEST SENSE
  572.  * when CHECK CONDITION is
  573.  * received on original command 
  574.  * (auto-sense) */
  575. struct Scsi_Host *sr_host;
  576. Scsi_Device *sr_device;
  577. Scsi_Cmnd *sr_command;
  578. struct request sr_request; /* A copy of the command we are
  579.    working on */
  580. unsigned sr_bufflen; /* Size of data buffer */
  581. void *sr_buffer; /* Data buffer */
  582. int sr_allowed;
  583. unsigned char sr_data_direction;
  584. unsigned char sr_cmd_len;
  585. unsigned char sr_cmnd[MAX_COMMAND_SIZE];
  586. void (*sr_done) (struct scsi_cmnd *); /* Mid-level done function */
  587. int sr_timeout_per_command;
  588. unsigned short sr_use_sg; /* Number of pieces of scatter-gather */
  589. unsigned short sr_sglist_len; /* size of malloc'd scatter-gather list */
  590. unsigned sr_underflow; /* Return error if less than
  591.    this amount is transferred */
  592. };
  593. /*
  594.  * FIXME(eric) - one of the great regrets that I have is that I failed to define
  595.  * these structure elements as something like sc_foo instead of foo.  This would
  596.  * make it so much easier to grep through sources and so forth.  I propose that
  597.  * all new elements that get added to these structures follow this convention.
  598.  * As time goes on and as people have the stomach for it, it should be possible to 
  599.  * go back and retrofit at least some of the elements here with with the prefix.
  600.  */
  601. struct scsi_cmnd {
  602. int     sc_magic;
  603. /* private: */
  604. /*
  605.  * This information is private to the scsi mid-layer.  Wrapping it in a
  606.  * struct private is a way of marking it in a sort of C++ type of way.
  607.  */
  608. struct Scsi_Host *host;
  609. unsigned short state;
  610. unsigned short owner;
  611. Scsi_Device *device;
  612. Scsi_Request *sc_request;
  613. struct scsi_cmnd *next;
  614. struct scsi_cmnd *reset_chain;
  615. int eh_state; /* Used for state tracking in error handlr */
  616. void (*done) (struct scsi_cmnd *); /* Mid-level done function */
  617. /*
  618.    A SCSI Command is assigned a nonzero serial_number when internal_cmnd
  619.    passes it to the driver's queue command function.  The serial_number
  620.    is cleared when scsi_done is entered indicating that the command has
  621.    been completed.  If a timeout occurs, the serial number at the moment
  622.    of timeout is copied into serial_number_at_timeout.  By subsequently
  623.    comparing the serial_number and serial_number_at_timeout fields
  624.    during abort or reset processing, we can detect whether the command
  625.    has already completed.  This also detects cases where the command has
  626.    completed and the SCSI Command structure has already being reused
  627.    for another command, so that we can avoid incorrectly aborting or
  628.    resetting the new command.
  629.  */
  630. unsigned long serial_number;
  631. unsigned long serial_number_at_timeout;
  632. int retries;
  633. int allowed;
  634. int timeout_per_command;
  635. int timeout_total;
  636. int timeout;
  637. /*
  638.  * We handle the timeout differently if it happens when a reset, 
  639.  * abort, etc are in process. 
  640.  */
  641. unsigned volatile char internal_timeout;
  642. struct scsi_cmnd *bh_next; /* To enumerate the commands waiting 
  643.    to be processed. */
  644. /* public: */
  645. unsigned int target;
  646. unsigned int lun;
  647. unsigned int channel;
  648. unsigned char cmd_len;
  649. unsigned char old_cmd_len;
  650. unsigned char sc_data_direction;
  651. unsigned char sc_old_data_direction;
  652. /* These elements define the operation we are about to perform */
  653. unsigned char cmnd[MAX_COMMAND_SIZE];
  654. unsigned request_bufflen; /* Actual request size */
  655. struct timer_list eh_timeout; /* Used to time out the command. */
  656. void *request_buffer; /* Actual requested buffer */
  657.         void **bounce_buffers; /* Array of bounce buffers when using scatter-gather */
  658. /* These elements define the operation we ultimately want to perform */
  659. unsigned char data_cmnd[MAX_COMMAND_SIZE];
  660. unsigned short old_use_sg; /* We save  use_sg here when requesting
  661.  * sense info */
  662. unsigned short use_sg; /* Number of pieces of scatter-gather */
  663. unsigned short sglist_len; /* size of malloc'd scatter-gather list */
  664. unsigned short abort_reason; /* If the mid-level code requests an
  665.  * abort, this is the reason. */
  666. unsigned bufflen; /* Size of data buffer */
  667. void *buffer; /* Data buffer */
  668. unsigned underflow; /* Return error if less than
  669.    this amount is transferred */
  670. unsigned old_underflow; /* save underflow here when reusing the
  671.  * command for error handling */
  672. unsigned transfersize; /* How much we are guaranteed to
  673.    transfer with each SCSI transfer
  674.    (ie, between disconnect / 
  675.    reconnects.   Probably == sector
  676.    size */
  677. int resid; /* Number of bytes requested to be
  678.    transferred less actual number
  679.    transferred (0 if not supported) */
  680. struct request request; /* A copy of the command we are
  681.    working on */
  682. unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE]; /* obtained by REQUEST SENSE
  683.  * when CHECK CONDITION is
  684.  * received on original command 
  685.  * (auto-sense) */
  686. unsigned flags;
  687. /*
  688.  * Used to indicate that a command which has timed out also
  689.  * completed normally.  Typically the completion function will
  690.  * do nothing but set this flag in this instance because the
  691.  * timeout handler is already running.
  692.  */
  693. unsigned done_late:1;
  694. /* Low-level done function - can be used by low-level driver to point
  695.  *        to completion function.  Not used by mid/upper level code. */
  696. void (*scsi_done) (struct scsi_cmnd *);
  697. /*
  698.  * The following fields can be written to by the host specific code. 
  699.  * Everything else should be left alone. 
  700.  */
  701. Scsi_Pointer SCp; /* Scratchpad used by some host adapters */
  702. unsigned char *host_scribble; /* The host adapter is allowed to
  703.    * call scsi_malloc and get some memory
  704.    * and hang it here.     The host adapter
  705.    * is also expected to call scsi_free
  706.    * to release this memory.  (The memory
  707.    * obtained by scsi_malloc is guaranteed
  708.    * to be at an address < 16Mb). */
  709. int result; /* Status code from lower level driver */
  710. unsigned char tag; /* SCSI-II queued command tag */
  711. unsigned long pid; /* Process ID, starts at 0 */
  712. };
  713. /*
  714.  *  Flag bit for the internal_timeout array
  715.  */
  716. #define NORMAL_TIMEOUT 0
  717. /*
  718.  * Definitions and prototypes used for scsi mid-level queue.
  719.  */
  720. #define SCSI_MLQUEUE_HOST_BUSY   0x1055
  721. #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
  722. #define SCSI_SLEEP(QUEUE, CONDITION) {     
  723.     if (CONDITION) {             
  724. DECLARE_WAITQUEUE(wait, current);     
  725. add_wait_queue(QUEUE, &wait);     
  726. for(;;) {             
  727. set_current_state(TASK_UNINTERRUPTIBLE);    
  728. if (CONDITION) {             
  729.             if (in_interrupt())                     
  730.         panic("scsi: trying to call schedule() in interrupt" 
  731.       ", file %s, line %d.n", __FILE__, __LINE__);  
  732.     schedule();
  733.         }
  734. else         
  735.     break;      
  736. }         
  737. remove_wait_queue(QUEUE, &wait);
  738. current->state = TASK_RUNNING;
  739.     }; }
  740. #endif
  741. /*
  742.  * Overrides for Emacs so that we follow Linus's tabbing style.
  743.  * Emacs will notice this stuff at the end of the file and automatically
  744.  * adjust the settings for this buffer only.  This must remain at the end
  745.  * of the file.
  746.  * ---------------------------------------------------------------------------
  747.  * Local variables:
  748.  * c-indent-level: 4 
  749.  * c-brace-imaginary-offset: 0
  750.  * c-brace-offset: -4
  751.  * c-argdecl-indent: 4
  752.  * c-label-offset: -4
  753.  * c-continued-statement-offset: 4
  754.  * c-continued-brace-offset: 0
  755.  * indent-tabs-mode: nil
  756.  * tab-width: 8
  757.  * End:
  758.  */