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 #defineTEST_UNIT_READY 0x00
29 #defineREZERO_UNIT 0x01
30 #defineREQUEST_SENSE 0x03
31 #defineFORMAT_UNIT 0x04
32 #defineREAD_BLOCK_LIMITS 0x05
33 #defineREASSIGN_BLOCKS 0x07
34 #defineREAD_6 0x08
35 #defineWRITE_6 0x0a
36 #defineSEEK_6 0x0b
37 #define READ_REVERSE 0x0f
38 #defineWRITE_FILEMARKS 0x10
39 #defineSPACE 0x11
40 #defineINQUIRY 0x12
41 #define RECOVER_BUFFERED_DATA 0x14
42 #defineMODE_SELECT 0x15
43 #defineRESERVE 0x16
44 #define RELEASE 0x17
45 #defineCOPY 0x18
46 #defineERASE 0x19
47 #defineMODE_SENSE 0x1a
48 #defineSTART_STOP 0x1b
49 #define RECEIVE_DIAGNOSTIC 0x1c
50 #defineSEND_DIAGNOSTIC 0x1d
51 #defineALLOW_MEDIUM_REMOVAL 0x1e
52
53 #defineREAD_CAPACITY 0x25
54 #defineREAD_10 0x28
55 #defineWRITE_10 0x2a
56 #defineSEEK_10 0x2b
57 #defineWRITE_VERIFY 0x2e
58 #define VERIFY 0x2f
59 #defineSEARCH_HIGH 0x30
60 #defineSEARCH_EQUAL 0x31
61 #defineSEARCH_LOW 0x32
62 #define SET_LIMITS 0x33
63 #define PRE_FETCH 0x34
64 #defineREAD_POSITION 0x34
65 #define SYNCRONIZE_CACHE 0x35
66 #define LOCK_UNLOCK_CACHE 0x36
67 #define READ_DEFECT_DATA 0x37
68 #defineCOMPARE 0x39
69 #defineCOPY_VERIFY 0x3a
70 #defineWRITE_BUFFER 0x3b
71 #define READ_BUFFER 0x3c
72 #define READ_LONG 0x3e
73 #defineCHANGE_DEFINITION 0x40
74 #defineLOG_SELECT 0x4c
75 #define LOG_SENSE 0x4d
76 #defineMODE_SELECT_10 0x55
77 #define MODE_SENSE_10 0x5a
78
79 externconstunsignedcharscsi_command_size[8];
80 #defineCOMMAND_SIZE(opcode) scsi_command_size[((opcode) >> 5) & 7]
81
82 /* 83 MESSAGE CODES 84 */ 85
86 #defineCOMMAND_COMPLETE 0x00
87 #defineEXTENDED_MESSAGE 0x01
88 #defineSAVE_POINTERS 0x02
89 #defineRESTORE_POINTERS 0x03
90 #defineDISCONNECT 0x04
91 #define INITIATOR_ERROR 0x05
92 #defineABORT 0x06
93 #defineMESSAGE_REJECT 0x07
94 #defineNOP 0x08
95 #define MSG_PARITY_ERROR 0x09
96 #defineLINKED_CMD_COMPLETE 0x0a
97 #defineLINKED_FLG_CMD_COMPLETE 0x0b
98 #define BUS_DEVICE_RESET 0x0c
99
100 #defineSIMPLE_QUEUE_TAG 0x20
101 #defineHEAD_OF_QUEUE_TAG 0x21
102 #defineORDERED_QUEUE_TAG 0x22
103
104 #defineIDENTIFY_BASE 0x80
105 #defineIDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
106 ((can_disconnect) ? 0x40 : 0) |\
107 ((lun) & 0x07))
108
109
110 /* 111 Status codes 112 */ 113
114 #defineGOOD 0x00
115 #defineCHECK_CONDITION 0x01
116 #defineCONDITION_GOOD 0x02
117 #defineBUSY 0x04
118 #defineINTERMEDIATE_GOOD 0x08
119 #defineINTERMEDIATE_C_GOOD 0x0a
120 #defineRESERVATION_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 #defineDID_OK 0x00
145 /* Couldn't connect before timeout period */ 146 #defineDID_NO_CONNECT 0x01
147 /* BUS stayed busy through time out period */ 148 #defineDID_BUS_BUSY 0x02
149 /* TIMED OUT for other reason */ 150 #defineDID_TIME_OUT 0x03
151 /* BAD target. */ 152 #defineDID_BAD_TARGET 0x04
153 /* Told to abort for some other reason */ 154 #defineDID_ABORT 0x05
155 /* 156 Parity error 157 */ 158 #defineDID_PARITY 0x06
159 /* 160 Internal error 161 */ 162 #defineDID_ERROR 0x07
163 /* 164 Reset by somebody. 165 */ 166 #defineDID_RESET 0x08
167 /* 168 Got an interrupt we weren't expecting. 169 */ 170 #defineDID_BAD_INTR 0x09
171
172 /* 173 Driver status 174 */ 175 #defineDRIVER_OK 0x00
176
177 /* 178 These indicate the error that occured, and what is available. 179 */ 180
181 #define DRIVER_BUSY 0x01
182 #defineDRIVER_SOFT 0x02
183 #define DRIVER_MEDIA 0x03
184 #defineDRIVER_ERROR 0x04
185
186 #defineDRIVER_INVALID 0x05
187 #defineDRIVER_TIMEOUT 0x06
188 #defineDRIVER_HARD 0x07
189
190 #defineSUGGEST_RETRY 0x10
191 #defineSUGGEST_ABORT 0x20
192 #defineSUGGEST_REMAP 0x30
193 #defineSUGGEST_DIE 0x40
194 #defineSUGGEST_SENSE 0x80
195 #defineSUGGEST_IS_OK 0xff
196
197 #defineDRIVER_SENSE 0x08
198
199 #define DRIVER_MASK 0x0f
200 #defineSUGGEST_MASK 0xf0
201
202 /* 203
204 SENSE KEYS 205 */ 206
207 #defineNO_SENSE 0x00
208 #defineRECOVERED_ERROR 0x01
209 #defineNOT_READY 0x02
210 #defineMEDIUM_ERROR 0x03
211 #defineHARDWARE_ERROR 0x04
212 #defineILLEGAL_REQUEST 0x05
213 #defineUNIT_ATTENTION 0x06
214 #defineDATA_PROTECT 0x07
215 #defineBLANK_CHECK 0x08
216 #defineCOPY_ABORTED 0x0a
217 #defineABORTED_COMMAND 0x0b
218 #defineVOLUME_OVERFLOW 0x0d
219 #defineMISCOMPARE 0x0e
220
221
222 /* 223 DEVICE TYPES 224
225 */ 226
227 #defineTYPE_DISK 0x00
228 #defineTYPE_TAPE 0x01
229 #defineTYPE_WORM 0x04 /* Treated as ROM by our system */ 230 #defineTYPE_ROM 0x05
231 #defineTYPE_MOD 0x07 /* Magneto-optical disk - treated as TYPE_DISK */ 232 #define TYPE_NO_LUN 0x7f
233
234
235 #defineMAX_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 #defineSCSI_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 typedefstruct scsi_device { 261 unsignedcharid, lun, index;
262 intaccess_count; /* Count of open channels/mounts */ 263 structwait_queue * device_wait; /* Used to wait if device is busy */ 264 structScsi_Host * host;
265 void (*scsi_request_fn)(void); /* Used to jumpstart things after an ioctl */ 266 chartype;
267 charscsi_level;
268 unsignedwriteable:1;
269 unsignedremovable:1;
270 unsignedrandom:1;
271 unsignedchanged:1; /* Data invalid due to media change */ 272 unsignedbusy:1; /* Used to prevent races */ 273 unsignedlockable:1; /* Able to prevent media removal */ 274 unsignedborken:1; /* Tell the Seagate driver to be 275 painfully slow on this device */ 276 unsignedtagged_supported:1; /* Supports SCSI-II tagged queing */ 277 unsignedtagged_queue:1; /*SCSI-II tagged queing enabled */ 278 unsigneddisconnect:1; /* can disconnect */ 279 unsignedsoft_reset:1; /* Uses soft reset option */ 280 unsignedcharcurrent_tag; /* current tag */ 281 }Scsi_Device;
282 /* 283 Use these to separate status msg and our bytes 284 */ 285
286 #definestatus_byte(result) (((result) >> 1) & 0xf)
287 #definemsg_byte(result) (((result) >> 8) & 0xff)
288 #definehost_byte(result) (((result) >> 16) & 0xff)
289 #definedriver_byte(result) (((result) >> 24) & 0xff)
290 #definesugestion(result) (driver_byte(result) & SUGGEST_MASK)
291
292 #definesense_class(sense) (((sense) >> 4) & 0x7)
293 #definesense_error(sense) ((sense) & 0xf)
294 #define sense_valid(sense) ((sense) & 0x80);
295
296 /* 297 These are the SCSI devices available on the system. 298 */ 299
300 externintNR_SCSI_DEVICES;
301 externScsi_Device * scsi_devices;
302 /* 303 Initializes all SCSI devices. This scans all scsi busses. 304 */ 305
306 externunsignedlongscsi_dev_init (unsignedlong, unsignedlong);
307
308 structscatterlist{ 309 char * address; /* Location data is to be transferred to */ 310 char * alt_address; /* Location of actual if address is a 311 dma indirect buffer. NULL otherwise */ 312 unsignedintlength;
313 };
314
315 #defineISA_DMA_THRESHOLD (0x00ffffff)
316 #defineCONTIGUOUS_BUFFERS(X,Y) ((X->b_data+X->b_size) == Y->b_data)
317
318
319 /* 320 * These are the return codes for the abort and reset functions. The mid-level 321 * code uses these to decide what to do next. Each of the low level abort 322 * and reset functions must correctly indicate what it has done. 323 */ 324
325 /* We did not do anything. Wait 326 some more for this command to complete, and if this does not work, try 327 something more serious. */ 328 #defineSCSI_ABORT_SNOOZE 0
329
330 /* This means that we were able to abort the command. We have already 331 called the mid-level done function, and do not expect an interrupt that will 332 lead to another call to the mid-level done function for this command */ 333 #defineSCSI_ABORT_SUCCESS 1
334
335 /* We called for an abort of this command, and we should get an interrupt 336 when this succeeds. Thus we should not restore the timer for this 337 command in the mid-level abort function. */ 338 #defineSCSI_ABORT_PENDING 2
339
340 /* Unable to abort - command is currently on the bus. Grin and bear it. */ 341 #defineSCSI_ABORT_BUSY 3
342
343 /* The command is not active in the low level code. Command probably 344 finished. */ 345 #defineSCSI_ABORT_NOT_RUNNING 4
346
347 /* Something went wrong. The low level driver will indicate the correct 348 error condition when it calls scsi_done, so the mid-level abort function 349 can simply wait until this comes through */ 350 #defineSCSI_ABORT_ERROR 5
351
352 /* We do not know how to reset the bus, or we do not want to. Bummer. 353 Anyway, just wait a little more for the command in question, and hope that 354 it eventually finishes */ 355 #defineSCSI_RESET_SNOOZE 0
356
357 /* This means that we were able to reset the bus. We have restarted all of 358 the commands that should be restarted, and we should be able to continue 359 on normally from here. We do not expect any interrupts that will return 360 DID_RESET to any of the other commands in the host_queue. */ 361 #defineSCSI_RESET_SUCCESS 1
362
363 /* We called for an reset of this bus, and we should get an interrupt 364 when this succeeds. Each command should get it's own status 365 passed up to scsi_done, but this has not happened yet. */ 366 #defineSCSI_RESET_PENDING 2
367
368 /* We did a reset, but do not expect an interrupt to signal DID_RESET. 369 This tells the upper level code to request the sense info, and this 370 should keep the command alive. */ 371 #defineSCSI_RESET_WAKEUP 3
372
373 /* Something went wrong, and we do not know how to fix it. */ 374 #defineSCSI_RESET_ERROR 4
375
376 void * scsi_malloc(unsignedint);
377 intscsi_free(void *, unsignedint);
378 externunsignedintdma_free_sectors; /* How much room do we have left */ 379 externunsignedintneed_isa_buffer; /* True if some devices need indirection 380 buffers */ 381
382 /* 383 The Scsi_Cmnd structure is used by scsi.c internally, and for communication with 384 low level drivers that support multiple outstanding commands. 385 */ 386 typedefstruct scsi_pointer { 387 char * ptr; /* data pointer */ 388 intthis_residual; /* left in this buffer */ 389 structscatterlist *buffer; /* which buffer */ 390 intbuffers_residual; /* how many buffers left */ 391
392 volatileintStatus;
393 volatileintMessage;
394 volatileinthave_data_in;
395 volatileintsent_command;
396 volatileintphase;
397 }Scsi_Pointer;
398
399 typedefstructscsi_cmnd{ 400 structScsi_Host * host;
401 Scsi_Device * device;
402 unsignedchartarget, lun, index;
403 structscsi_cmnd *next, *prev;
404
405 /* These elements define the operation we are about to perform */ 406 unsignedcharcmnd[12];
407 unsignedrequest_bufflen; /* Actual request size */ 408
409 void * request_buffer; /* Actual requested buffer */ 410
411 /* These elements define the operation we ultimately want to perform */ 412 unsignedchardata_cmnd[12];
413 unsignedshortold_use_sg; /* We save use_sg here when requesting 414 sense info */ 415 unsignedshortuse_sg; /* Number of pieces of scatter-gather */ 416 unsignedshortsglist_len; /* size of malloc'd scatter-gather list */ 417 unsignedshortabort_reason; /* If the mid-level code requests an 418 abort, this is the reason. */ 419 unsignedbufflen; /* Size of data buffer */ 420 void *buffer; /* Data buffer */ 421
422 unsignedunderflow; /* Return error if less than this amount is 423 transfered */ 424
425 unsignedtransfersize; /* How much we are guranteed to transfer with 426 each SCSI transfer (ie, between disconnect / 427 reconnects. Probably == sector size */ 428
429
430
431 structrequestrequest; /* A copy of the command we are working on*/ 432
433 unsignedcharsense_buffer[16]; /* Sense for this command, if needed*/ 434
435
436 intretries;
437 intallowed;
438 inttimeout_per_command, timeout_total, timeout;
439 /* 440 * We handle the timeout differently if it happens when a reset, 441 * abort, etc are in process. 442 */ 443
444 unsignedvolatilecharinternal_timeout;
445
446 unsignedflags;
447
448 /* These variables are for the cdrom only. Once we have variable size buffers 449 in the buffer cache, they will go away. */ 450 intthis_count;
451 /* End of special cdrom variables */ 452
453 /* Low-level done function - can be used by low-level driver to point 454 to completion function. Not used by mid/upper level code. */ 455 void (*scsi_done)(structscsi_cmnd *);
456 void (*done)(structscsi_cmnd *); /* Mid-level done function */ 457
458 /* The following fields can be written to by the host specific code. 459 Everything else should be left alone. */ 460
461 Scsi_PointerSCp; /* Scratchpad used by some host adapters */ 462
463 unsignedchar * host_scribble; /* The host adapter is allowed to 464 call scsi_malloc and get some memory 465 and hang it here. The host adapter 466 is also expected to call scsi_free 467 to release this memory. (The memory 468 obtained by scsi_malloc is guaranteed 469 to be at an address < 16Mb). */ 470
471 intresult; /* Status code from lower level driver */ 472
473 unsignedchartag; /* SCSI-II queued command tag */ 474 }Scsi_Cmnd;
475
476 /* 477 scsi_abort aborts the current command that is executing on host host. 478 The error code, if non zero is returned in the host byte, otherwise 479 DID_ABORT is returned in the hostbyte. 480 */ 481
482 externintscsi_abort (Scsi_Cmnd *, intcode);
483
484 externvoidscsi_do_cmd (Scsi_Cmnd *, constvoid *cmnd ,
485 void *buffer, unsignedbufflen, void (*done)(structscsi_cmnd *),
486 inttimeout, intretries);
487
488
489 externScsi_Cmnd * allocate_device(structrequest **, int, int);
490
491 externScsi_Cmnd * request_queueable(structrequest *, int);
492 externintscsi_reset (Scsi_Cmnd *);
493
494 externintmax_scsi_hosts;
495 externintMAX_SD, NR_SD, MAX_ST, NR_ST, MAX_SR, NR_SR, NR_SG, MAX_SG;
496 externunsignedlongsd_init(unsignedlong, unsignedlong);
497 externunsignedlongsd_init1(unsignedlong, unsignedlong);
498 externvoidsd_attach(Scsi_Device *);
499
500 externunsignedlongsr_init(unsignedlong, unsignedlong);
501 externunsignedlongsr_init1(unsignedlong, unsignedlong);
502 externvoidsr_attach(Scsi_Device *);
503
504 externunsignedlongst_init(unsignedlong, unsignedlong);
505 externunsignedlongst_init1(unsignedlong, unsignedlong);
506 externvoidst_attach(Scsi_Device *);
507
508 externunsignedlongsg_init(unsignedlong, unsignedlong);
509 externunsignedlongsg_init1(unsignedlong, unsignedlong);
510 externvoidsg_attach(Scsi_Device *);
511
512 #ifdefined(MAJOR_NR) && (MAJOR_NR != SCSI_TAPE_MAJOR)
513 staticvoidend_scsi_request(Scsi_Cmnd * SCpnt, intuptodate, intsectors)
/* */ 514 { 515 structrequest * req;
516 structbuffer_head * bh;
517 structtask_struct * p;
518
519 req = &SCpnt->request;
520 req->errors = 0;
521 if (!uptodate) { 522 printk(DEVICE_NAME " I/O error: dev %04x, sector %lu\n",
523 req->dev,req->sector);
524 } 525
526 do{ 527 if ((bh = req->bh) != NULL) { 528 req->bh = bh->b_reqnext;
529 req->nr_sectors -= bh->b_size >> 9;
530 req->sector += bh->b_size >> 9;
531 bh->b_reqnext = NULL;
532 bh->b_uptodate = uptodate;
533 unlock_buffer(bh);
534 sectors -= bh->b_size >> 9;
535 if ((bh = req->bh) != NULL) { 536 req->current_nr_sectors = bh->b_size >> 9;
537 if (req->nr_sectors < req->current_nr_sectors) { 538 req->nr_sectors = req->current_nr_sectors;
539 printk("end_scsi_request: buffer-list destroyed\n");
540 } 541 } 542 } 543 }while(sectors && bh);
544 if (req->bh){ 545 req->buffer = bh->b_data;
546 return;
547 };
548 DEVICE_OFF(req->dev);
549 if ((p = req->waiting) != NULL) { 550 req->waiting = NULL;
551 p->state = TASK_RUNNING;
552 if (p->counter > current->counter)
553 need_resched = 1;
554 } 555 req->dev = -1;
556 wake_up(&scsi_devices[SCpnt->index].device_wait);
557 return;
558 } 559
560
561 /* This is just like INIT_REQUEST, but we need to be aware of the fact 562 that an interrupt may start another request, so we run this with interrupts 563 turned off */ 564
565 #defineINIT_SCSI_REQUEST \
566 if (!CURRENT) {\
567 CLEAR_INTR; \
568 sti(); \
569 return; \
570 } \
571 if (MAJOR(CURRENT->dev) != MAJOR_NR) \
572 panic(DEVICE_NAME ": request list destroyed"); \
573 if (CURRENT->bh) { \
574 if (!CURRENT->bh->b_lock) \
575 panic(DEVICE_NAME ": block not locked"); \
576 } 577 #endif 578
579 #defineSCSI_SLEEP(QUEUE, CONDITION) { \
580 if (CONDITION) { \
581 structwait_queuewait = {current, NULL}; \
582 add_wait_queue(QUEUE, &wait); \
583 sleep_repeat: \
584 current->state = TASK_UNINTERRUPTIBLE; \
585 if (CONDITION) { \
586 schedule(); \
587 gotosleep_repeat; \
588 } \
589 remove_wait_queue(QUEUE, &wait); \
590 current->state = TASK_RUNNING; \
591 }; } 592
593 #endif