root/drivers/scsi/scsi.h

/* [previous][next][first][last][top][bottom][index][help] */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. end_scsi_request

   1 /*
   2  *      scsi.h Copyright (C) 1992 Drew Eckhardt 
   3  *      generic SCSI package header file by
   4  *              Drew Eckhardt 
   5  *
   6  *      <drew@colorado.edu>
   7  *
   8  *       Modified by Eric Youngdale eric@tantalus.nrl.navy.mil to
   9  *       add scatter-gather, multiple outstanding request, and other
  10  *       enhancements.
  11  */
  12 
  13 #ifndef _SCSI_H
  14 #define _SCSI_H
  15 
  16 /*
  17         $Header: /usr/src/linux/kernel/blk_drv/scsi/RCS/scsi.h,v 1.3 1993/09/24 12:20:33 drew Exp $
  18 
  19         For documentation on the OPCODES, MESSAGES, and SENSE values,
  20         please consult the SCSI standard.
  21 
  22 */
  23 
  24 /*
  25         SCSI opcodes
  26 */
  27 
  28 #define TEST_UNIT_READY         0x00
  29 #define REZERO_UNIT             0x01
  30 #define REQUEST_SENSE           0x03
  31 #define FORMAT_UNIT             0x04
  32 #define READ_BLOCK_LIMITS       0x05
  33 #define REASSIGN_BLOCKS         0x07
  34 #define READ_6                  0x08
  35 #define WRITE_6                 0x0a
  36 #define SEEK_6                  0x0b
  37 #define READ_REVERSE            0x0f
  38 #define WRITE_FILEMARKS         0x10
  39 #define SPACE                   0x11
  40 #define INQUIRY                 0x12
  41 #define RECOVER_BUFFERED_DATA   0x14
  42 #define MODE_SELECT             0x15
  43 #define RESERVE                 0x16
  44 #define RELEASE                 0x17
  45 #define COPY                    0x18
  46 #define ERASE                   0x19
  47 #define MODE_SENSE              0x1a
  48 #define START_STOP              0x1b
  49 #define RECEIVE_DIAGNOSTIC      0x1c
  50 #define SEND_DIAGNOSTIC         0x1d
  51 #define ALLOW_MEDIUM_REMOVAL    0x1e
  52 
  53 #define READ_CAPACITY           0x25
  54 #define READ_10                 0x28
  55 #define WRITE_10                0x2a
  56 #define SEEK_10                 0x2b
  57 #define WRITE_VERIFY            0x2e
  58 #define VERIFY                  0x2f
  59 #define SEARCH_HIGH             0x30
  60 #define SEARCH_EQUAL            0x31
  61 #define SEARCH_LOW              0x32
  62 #define SET_LIMITS              0x33
  63 #define PRE_FETCH               0x34
  64 #define READ_POSITION           0x34
  65 #define SYNCRONIZE_CACHE        0x35
  66 #define LOCK_UNLOCK_CACHE       0x36
  67 #define READ_DEFECT_DATA        0x37
  68 #define COMPARE                 0x39
  69 #define COPY_VERIFY             0x3a
  70 #define WRITE_BUFFER            0x3b
  71 #define READ_BUFFER             0x3c
  72 #define READ_LONG               0x3e
  73 #define CHANGE_DEFINITION       0x40
  74 #define LOG_SELECT              0x4c
  75 #define LOG_SENSE               0x4d
  76 #define MODE_SELECT_10          0x55
  77 #define MODE_SENSE_10           0x5a
  78 
  79 extern const unsigned char scsi_command_size[8];
  80 #define COMMAND_SIZE(opcode) scsi_command_size[((opcode) >> 5) & 7]
  81 
  82 /*
  83         MESSAGE CODES
  84 */
  85 
  86 #define COMMAND_COMPLETE        0x00
  87 #define EXTENDED_MESSAGE        0x01
  88 #define SAVE_POINTERS           0x02
  89 #define RESTORE_POINTERS        0x03
  90 #define DISCONNECT              0x04
  91 #define INITIATOR_ERROR         0x05
  92 #define ABORT                   0x06
  93 #define MESSAGE_REJECT          0x07
  94 #define NOP                     0x08
  95 #define MSG_PARITY_ERROR        0x09
  96 #define LINKED_CMD_COMPLETE     0x0a
  97 #define LINKED_FLG_CMD_COMPLETE 0x0b
  98 #define BUS_DEVICE_RESET        0x0c
  99 
 100 #define SIMPLE_QUEUE_TAG        0x20
 101 #define HEAD_OF_QUEUE_TAG       0x21
 102 #define ORDERED_QUEUE_TAG       0x22
 103 
 104 #define IDENTIFY_BASE           0x80
 105 #define IDENTIFY(can_disconnect, lun)   (IDENTIFY_BASE |\
 106                                          ((can_disconnect) ?  0x40 : 0) |\
 107                                          ((lun) & 0x07)) 
 108 
 109                                  
 110 /*
 111         Status codes
 112 */
 113 
 114 #define GOOD                    0x00
 115 #define CHECK_CONDITION         0x01
 116 #define CONDITION_GOOD          0x02
 117 #define BUSY                    0x04
 118 #define INTERMEDIATE_GOOD       0x08
 119 #define INTERMEDIATE_C_GOOD     0x0a
 120 #define RESERVATION_CONFLICT    0x0c
 121 
 122 #define STATUS_MASK             0x1e
 123         
 124 /*
 125         the return of the status word will be in the following format :
 126         The low byte is the status returned by the SCSI command, 
 127         with vendor specific bits masked.
 128 
 129         The next byte is the message which followed the SCSI status.
 130         This allows a stos to be used, since the Intel is a little
 131         endian machine.
 132 
 133         The final byte is a host return code, which is one of the following.
 134 
 135         IE 
 136         lsb             msb
 137         status  msg     host code       
 138 
 139         Our errors returned by OUR driver, NOT SCSI message.  Orr'd with
 140         SCSI message passed back to driver <IF any>.
 141 */
 142 
 143 /*      NO error                                                        */
 144 #define DID_OK                  0x00
 145 /*      Couldn't connect before timeout period                          */
 146 #define DID_NO_CONNECT          0x01
 147 /*      BUS stayed busy through time out period                         */
 148 #define DID_BUS_BUSY            0x02
 149 /*      TIMED OUT for other reason                                      */
 150 #define DID_TIME_OUT            0x03
 151 /*      BAD target.                                                     */
 152 #define DID_BAD_TARGET          0x04
 153 /*      Told to abort for some other reason                             */
 154 #define DID_ABORT               0x05
 155 /*
 156         Parity error
 157 */
 158 #define DID_PARITY              0x06
 159 /*
 160         Internal error
 161 */
 162 #define DID_ERROR               0x07    
 163 /*
 164         Reset by somebody.
 165 */
 166 #define DID_RESET               0x08
 167 /*
 168         Got an interrupt we weren't expecting.
 169 */
 170 #define DID_BAD_INTR            0x09
 171 
 172 /*
 173         Driver status
 174 */ 
 175 #define DRIVER_OK               0x00
 176 
 177 /*
 178         These indicate the error that occured, and what is available.
 179 */
 180 
 181 #define DRIVER_BUSY             0x01
 182 #define DRIVER_SOFT             0x02
 183 #define DRIVER_MEDIA            0x03
 184 #define DRIVER_ERROR            0x04    
 185 
 186 #define DRIVER_INVALID          0x05
 187 #define DRIVER_TIMEOUT          0x06
 188 #define DRIVER_HARD             0x07
 189 
 190 #define SUGGEST_RETRY           0x10
 191 #define SUGGEST_ABORT           0x20 
 192 #define SUGGEST_REMAP           0x30
 193 #define SUGGEST_DIE             0x40
 194 #define SUGGEST_SENSE           0x80
 195 #define SUGGEST_IS_OK           0xff
 196 
 197 #define DRIVER_SENSE            0x08
 198 
 199 #define DRIVER_MASK 0x0f
 200 #define SUGGEST_MASK 0xf0
 201 
 202 /*
 203 
 204         SENSE KEYS
 205 */
 206 
 207 #define NO_SENSE                0x00
 208 #define RECOVERED_ERROR         0x01
 209 #define NOT_READY               0x02
 210 #define MEDIUM_ERROR            0x03
 211 #define HARDWARE_ERROR          0x04
 212 #define ILLEGAL_REQUEST         0x05
 213 #define UNIT_ATTENTION          0x06
 214 #define DATA_PROTECT            0x07
 215 #define BLANK_CHECK             0x08
 216 #define COPY_ABORTED            0x0a
 217 #define ABORTED_COMMAND         0x0b
 218 #define VOLUME_OVERFLOW         0x0d
 219 #define MISCOMPARE              0x0e
 220 
 221 
 222 /*
 223         DEVICE TYPES
 224 
 225 */
 226 
 227 #define TYPE_DISK       0x00
 228 #define TYPE_TAPE       0x01
 229 #define TYPE_WORM       0x04    /* Treated as ROM by our system */
 230 #define TYPE_ROM        0x05
 231 #define TYPE_MOD        0x07  /* Magneto-optical disk - treated as TYPE_DISK */
 232 #define TYPE_NO_LUN     0x7f
 233 
 234 
 235 #define MAX_COMMAND_SIZE 12
 236 /*
 237         SCSI command sets
 238 
 239 */
 240 
 241 #define SCSI_UNKNOWN    0
 242 #define SCSI_1          1
 243 #define SCSI_1_CCS      2
 244 #define SCSI_2          3
 245 
 246 /*
 247         Every SCSI command starts with a one byte OP-code.
 248         The next byte's high three bits are the LUN of the
 249         device.  Any multi-byte quantities are stored high byte
 250         first, and may have a 5 bit MSB in the same byte
 251         as the LUN.
 252 */
 253 
 254 
 255 /*
 256         The scsi_device struct contains what we know about each given scsi
 257         device.
 258 */
 259 
 260 typedef struct scsi_device {
 261         unsigned char id, lun, index;
 262         int access_count;       /* Count of open channels/mounts */
 263         struct wait_queue * device_wait;  /* Used to wait if device is busy */
 264         struct Scsi_Host * host;
 265         char type;
 266         char scsi_level;
 267         unsigned writeable:1;
 268         unsigned removable:1; 
 269         unsigned random:1;
 270         unsigned changed:1;     /* Data invalid due to media change */
 271         unsigned busy:1;        /* Used to prevent races */
 272         unsigned lockable:1;    /* Able to prevent media removal */
 273         unsigned borken:1;      /* Tell the Seagate driver to be 
 274                                    painfully slow on this device */ 
 275         unsigned tagged_supported:1; /* Supports SCSI-II tagged queing */
 276         unsigned tagged_queue:1;   /*SCSI-II tagged queing enabled */
 277         unsigned disconnect:1;     /* can disconnect */
 278         unsigned char current_tag; /* current tag */
 279 } Scsi_Device;
 280 /*
 281         Use these to separate status msg and our bytes
 282 */
 283 
 284 #define status_byte(result) (((result) >> 1) & 0xf)
 285 #define msg_byte(result) (((result) >> 8) & 0xff)
 286 #define host_byte(result) (((result) >> 16) & 0xff)
 287 #define driver_byte(result) (((result) >> 24) & 0xff)
 288 #define sugestion(result) (driver_byte(result) & SUGGEST_MASK)
 289 
 290 #define sense_class(sense) (((sense) >> 4) & 0x7)
 291 #define sense_error(sense) ((sense) & 0xf)
 292 #define sense_valid(sense) ((sense) & 0x80);
 293 
 294 /*
 295         These are the SCSI devices available on the system.
 296 */
 297 
 298 extern int NR_SCSI_DEVICES;
 299 extern Scsi_Device * scsi_devices;
 300 /*
 301         Initializes all SCSI devices.  This scans all scsi busses.
 302 */
 303 
 304 extern unsigned long scsi_dev_init (unsigned long, unsigned long);
 305 
 306 struct scatterlist {
 307      char *  address; /* Location data is to be transferred to */
 308      char * alt_address; /* Location of actual if address is a 
 309                             dma indirect buffer.  NULL otherwise */
 310      unsigned short length;
 311      };
 312 
 313 #define ISA_DMA_THRESHOLD (0x00ffffff)
 314 
 315 void *   scsi_malloc(unsigned int);
 316 int      scsi_free(void *, unsigned int);
 317 extern unsigned int dma_free_sectors;   /* How much room do we have left */
 318 extern unsigned int need_isa_buffer;   /* True if some devices need indirection
 319                                  buffers */
 320 
 321 /*
 322         The Scsi_Cmnd structure is used by scsi.c internally, and for communication with
 323         low level drivers that support multiple outstanding commands.
 324 */
 325 typedef struct scsi_pointer {
 326   char * ptr;                     /* data pointer */
 327   int this_residual;              /* left in this buffer */
 328   struct scatterlist *buffer;     /* which buffer */
 329   int buffers_residual;           /* how many buffers left */
 330 
 331   volatile int Status;
 332   volatile int Message;
 333   volatile int have_data_in;
 334   volatile int sent_command;
 335   volatile int phase;
 336 } Scsi_Pointer;
 337 
 338 typedef struct scsi_cmnd {
 339         struct Scsi_Host * host;
 340         unsigned char target, lun,  index;
 341         struct scsi_cmnd *next, *prev;  
 342 
 343 /* These elements define the operation we are about to perform */
 344         unsigned char cmnd[12];
 345         unsigned request_bufflen; /* Actual request size */
 346 
 347         void * request_buffer;  /* Actual requested buffer */
 348 
 349 /* These elements define the operation we ultimately want to perform */
 350         unsigned char data_cmnd[12];
 351         unsigned short old_use_sg;  /* We save  use_sg here when requesting
 352                                        sense info */
 353         unsigned short use_sg;  /* Number of pieces of scatter-gather */
 354         unsigned short sglist_len;  /* size of malloc'd scatter-gather list */
 355         unsigned bufflen;     /* Size of data buffer */
 356         void *buffer;   /* Data buffer */
 357 
 358         unsigned underflow;     /* Return error if less than this amount is 
 359                                    transfered */
 360 
 361         unsigned transfersize;  /* How much we are guranteed to transfer with
 362                                    each SCSI transfer (ie, between disconnect /
 363                                    reconnects.   Probably == sector size */
 364         
 365         
 366         
 367         struct request request;  /* A copy of the command we are working on*/
 368 
 369         unsigned char sense_buffer[16];  /* Sense for this command, if needed*/
 370 
 371 
 372         int retries;
 373         int allowed;
 374         int timeout_per_command, timeout_total, timeout;
 375 /*
 376  *      We handle the timeout differently if it happens when a reset, 
 377  *      abort, etc are in process. 
 378  */
 379 
 380         unsigned volatile char internal_timeout;
 381 
 382         unsigned flags;
 383                 
 384 /* These variables are for the cdrom only.  Once we have variable size buffers
 385    in the buffer cache, they will go away. */
 386         int this_count; 
 387 /* End of special cdrom variables */
 388         
 389         /* Low-level done function - can be used by low-level driver to point
 390          to completion function.  Not used by mid/upper level code. */
 391         void (*scsi_done)(struct scsi_cmnd *);  
 392 
 393         void (*done)(struct scsi_cmnd *);  /* Mid-level done function */
 394 
 395 /* The following fields can be written to by the host specific code. 
 396    Everything else should be left alone. */
 397 
 398         Scsi_Pointer SCp;   /* Scratchpad used by some host adapters */
 399 
 400         unsigned char * host_scribble; /* The host adapter is allowed to
 401                                           call scsi_malloc and get some memory
 402                                           and hang it here.  The host adapter
 403                                           is also expected to call scsi_free
 404                                           to release this memory.  (The memory
 405                                           obtained by scsi_malloc is guaranteed
 406                                           to be at an address < 16Mb). */
 407 
 408         int result;                   /* Status code from lower level driver */
 409 
 410         unsigned char tag;              /* SCSI-II queued command tag */
 411         } Scsi_Cmnd;             
 412 
 413 /*
 414         scsi_abort aborts the current command that is executing on host host.
 415         The error code, if non zero is returned in the host byte, otherwise 
 416         DID_ABORT is returned in the hostbyte.
 417 */
 418 
 419 extern int scsi_abort (Scsi_Cmnd *, int code);
 420 
 421 extern void scsi_do_cmd (Scsi_Cmnd *, const void *cmnd ,
 422                   void *buffer, unsigned bufflen, void (*done)(struct scsi_cmnd *),
 423                   int timeout, int retries);
 424 
 425 
 426 extern Scsi_Cmnd * allocate_device(struct request **, int, int);
 427 
 428 extern Scsi_Cmnd * request_queueable(struct request *, int);
 429 
 430 extern int scsi_reset (Scsi_Cmnd *);
 431 
 432 extern int max_scsi_hosts;
 433 extern int MAX_SD, NR_SD, MAX_ST, NR_ST, MAX_SR, NR_SR, NR_SG, MAX_SG;
 434 extern unsigned long sd_init(unsigned long, unsigned long);
 435 extern unsigned long sd_init1(unsigned long, unsigned long);
 436 extern void sd_attach(Scsi_Device *);
 437 
 438 extern unsigned long sr_init(unsigned long, unsigned long);
 439 extern unsigned long sr_init1(unsigned long, unsigned long);
 440 extern void sr_attach(Scsi_Device *);
 441 
 442 extern unsigned long st_init(unsigned long, unsigned long);
 443 extern unsigned long st_init1(unsigned long, unsigned long);
 444 extern void st_attach(Scsi_Device *);
 445 
 446 extern unsigned long sg_init(unsigned long, unsigned long);
 447 extern unsigned long sg_init1(unsigned long, unsigned long);
 448 extern void sg_attach(Scsi_Device *);
 449 
 450 #if defined(MAJOR_NR) && (MAJOR_NR != SCSI_TAPE_MAJOR)
 451 static void end_scsi_request(Scsi_Cmnd * SCpnt, int uptodate, int sectors)
     /* [previous][next][first][last][top][bottom][index][help] */
 452 {
 453         struct request * req;
 454         struct buffer_head * bh;
 455         struct task_struct * p;
 456 
 457         req = &SCpnt->request;
 458         req->errors = 0;
 459         if (!uptodate) {
 460                 printk(DEVICE_NAME " I/O error: dev %04x, sector %lu\n",
 461                        req->dev,req->sector);
 462         }
 463 
 464         do {
 465           if ((bh = req->bh) != NULL) {
 466             req->bh = bh->b_reqnext;
 467             req->nr_sectors -= bh->b_size >> 9;
 468             req->sector += bh->b_size >> 9;
 469             bh->b_reqnext = NULL;
 470             bh->b_uptodate = uptodate;
 471             unlock_buffer(bh);
 472             sectors -= bh->b_size >> 9;
 473             if ((bh = req->bh) != NULL) {
 474               req->current_nr_sectors = bh->b_size >> 9;
 475               if (req->nr_sectors < req->current_nr_sectors) {
 476                 req->nr_sectors = req->current_nr_sectors;
 477                 printk("end_scsi_request: buffer-list destroyed\n");
 478               }
 479             }
 480           }
 481         } while(sectors && bh);
 482         if (req->bh){
 483           req->buffer = bh->b_data;
 484           return;
 485         };
 486         DEVICE_OFF(req->dev);
 487         if ((p = req->waiting) != NULL) {
 488                 req->waiting = NULL;
 489                 p->state = TASK_RUNNING;
 490                 if (p->counter > current->counter)
 491                         need_resched = 1;
 492         }
 493         req->dev = -1;
 494         wake_up(&scsi_devices[SCpnt->index].device_wait);
 495         return;
 496 }
 497 
 498 
 499 /* This is just like INIT_REQUEST, but we need to be aware of the fact
 500    that an interrupt may start another request, so we run this with interrupts
 501    turned off */
 502 
 503 #define INIT_SCSI_REQUEST \
 504         if (!CURRENT) {\
 505                 CLEAR_INTR; \
 506                 sti();   \
 507                 return; \
 508         } \
 509         if (MAJOR(CURRENT->dev) != MAJOR_NR) \
 510                 panic(DEVICE_NAME ": request list destroyed"); \
 511         if (CURRENT->bh) { \
 512                 if (!CURRENT->bh->b_lock) \
 513                         panic(DEVICE_NAME ": block not locked"); \
 514         }
 515 #endif
 516 
 517 #define SCSI_SLEEP(QUEUE, CONDITION) {                          \
 518         if (CONDITION) {                                        \
 519                 struct wait_queue wait = { current, NULL};      \
 520                 add_wait_queue(QUEUE, &wait);                   \
 521 sleep_repeat:                                                   \
 522                 current->state = TASK_UNINTERRUPTIBLE;          \
 523                 if (CONDITION) {                                \
 524                         schedule();                             \
 525                         goto sleep_repeat;                      \
 526                 }                                               \
 527                 remove_wait_queue(QUEUE, &wait);                \
 528                 current->state = TASK_RUNNING;                  \
 529         }; }
 530 
 531 #endif

/* [previous][next][first][last][top][bottom][index][help] */