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 typedefstructscsi_device{ 261 structscsi_device * next; /* Used for linked list */ 262 unsignedcharid, lun;
263 intaccess_count; /* Count of open channels/mounts */ 264 structwait_queue * device_wait; /* Used to wait if device is busy */ 265 structScsi_Host * host;
266 void (*scsi_request_fn)(void); /* Used to jumpstart things after an ioctl */ 267 chartype;
268 charscsi_level;
269 unsignedwriteable:1;
270 unsignedremovable:1;
271 unsignedrandom:1;
272 unsignedchanged:1; /* Data invalid due to media change */ 273 unsignedbusy:1; /* Used to prevent races */ 274 unsignedlockable:1; /* Able to prevent media removal */ 275 unsignedborken:1; /* Tell the Seagate driver to be 276 painfully slow on this device */ 277 unsignedtagged_supported:1; /* Supports SCSI-II tagged queing */ 278 unsignedtagged_queue:1; /*SCSI-II tagged queing enabled */ 279 unsigneddisconnect:1; /* can disconnect */ 280 unsignedsoft_reset:1; /* Uses soft reset option */ 281 unsignedcharcurrent_tag; /* current tag */ 282 }Scsi_Device;
283 /* 284 Use these to separate status msg and our bytes 285 */ 286
287 #definestatus_byte(result) (((result) >> 1) & 0xf)
288 #definemsg_byte(result) (((result) >> 8) & 0xff)
289 #definehost_byte(result) (((result) >> 16) & 0xff)
290 #definedriver_byte(result) (((result) >> 24) & 0xff)
291 #definesugestion(result) (driver_byte(result) & SUGGEST_MASK)
292
293 #definesense_class(sense) (((sense) >> 4) & 0x7)
294 #definesense_error(sense) ((sense) & 0xf)
295 #define sense_valid(sense) ((sense) & 0x80);
296
297 /* 298 These are the SCSI devices available on the system. 299 */ 300
301 externintNR_SCSI_DEVICES;
302 externScsi_Device * scsi_devices;
303 /* 304 Initializes all SCSI devices. This scans all scsi busses. 305 */ 306
307 externunsignedlongscsi_dev_init (unsignedlong, unsignedlong);
308
309 structscatterlist{ 310 char * address; /* Location data is to be transferred to */ 311 char * alt_address; /* Location of actual if address is a 312 dma indirect buffer. NULL otherwise */ 313 unsignedintlength;
314 };
315
316 #defineISA_DMA_THRESHOLD (0x00ffffff)
317 #defineCONTIGUOUS_BUFFERS(X,Y) ((X->b_data+X->b_size) == Y->b_data)
318
319
320 /* 321 * These are the return codes for the abort and reset functions. The mid-level 322 * code uses these to decide what to do next. Each of the low level abort 323 * and reset functions must correctly indicate what it has done. 324 */ 325
326 /* We did not do anything. Wait 327 some more for this command to complete, and if this does not work, try 328 something more serious. */ 329 #defineSCSI_ABORT_SNOOZE 0
330
331 /* This means that we were able to abort the command. We have already 332 called the mid-level done function, and do not expect an interrupt that will 333 lead to another call to the mid-level done function for this command */ 334 #defineSCSI_ABORT_SUCCESS 1
335
336 /* We called for an abort of this command, and we should get an interrupt 337 when this succeeds. Thus we should not restore the timer for this 338 command in the mid-level abort function. */ 339 #defineSCSI_ABORT_PENDING 2
340
341 /* Unable to abort - command is currently on the bus. Grin and bear it. */ 342 #defineSCSI_ABORT_BUSY 3
343
344 /* The command is not active in the low level code. Command probably 345 finished. */ 346 #defineSCSI_ABORT_NOT_RUNNING 4
347
348 /* Something went wrong. The low level driver will indicate the correct 349 error condition when it calls scsi_done, so the mid-level abort function 350 can simply wait until this comes through */ 351 #defineSCSI_ABORT_ERROR 5
352
353 /* We do not know how to reset the bus, or we do not want to. Bummer. 354 Anyway, just wait a little more for the command in question, and hope that 355 it eventually finishes. If it never finishes, the SCSI device could 356 hang, so use this with caution. */ 357 #defineSCSI_RESET_SNOOZE 0
358
359 /* We do not know how to reset the bus, or we do not want to. Bummer. 360 We have given up on this ever completing. The mid-level code will 361 request sense information to decide how to proceed from here. */ 362 #defineSCSI_RESET_PUNT 1
363
364 /* This means that we were able to reset the bus. We have restarted all of 365 the commands that should be restarted, and we should be able to continue 366 on normally from here. We do not expect any interrupts that will return 367 DID_RESET to any of the other commands in the host_queue, and the mid-level 368 code does not need to do anything special to keep the commands alive. */ 369 #defineSCSI_RESET_SUCCESS 2
370
371 /* We called for an reset of this bus, and we should get an interrupt 372 when this succeeds. Each command should get it's own status 373 passed up to scsi_done, but this has not happened yet. */ 374 #defineSCSI_RESET_PENDING 3
375
376 /* We did a reset, but do not expect an interrupt to signal DID_RESET. 377 This tells the upper level code to request the sense info, and this 378 should keep the command alive. */ 379 #defineSCSI_RESET_WAKEUP 4
380
381 /* Something went wrong, and we do not know how to fix it. */ 382 #defineSCSI_RESET_ERROR 5
383
384 void * scsi_malloc(unsignedint);
385 intscsi_free(void *, unsignedint);
386 externunsignedintdma_free_sectors; /* How much room do we have left */ 387 externunsignedintneed_isa_buffer; /* True if some devices need indirection 388 buffers */ 389
390 /* 391 The Scsi_Cmnd structure is used by scsi.c internally, and for communication with 392 low level drivers that support multiple outstanding commands. 393 */ 394 typedefstruct scsi_pointer { 395 char * ptr; /* data pointer */ 396 intthis_residual; /* left in this buffer */ 397 structscatterlist *buffer; /* which buffer */ 398 intbuffers_residual; /* how many buffers left */ 399
400 volatileintStatus;
401 volatileintMessage;
402 volatileinthave_data_in;
403 volatileintsent_command;
404 volatileintphase;
405 }Scsi_Pointer;
406
407 typedefstructscsi_cmnd{ 408 structScsi_Host * host;
409 Scsi_Device * device;
410 unsignedchartarget, lun;
411 structscsi_cmnd *next, *prev;
412
413 /* These elements define the operation we are about to perform */ 414 unsignedcharcmnd[12];
415 unsignedrequest_bufflen; /* Actual request size */ 416
417 void * request_buffer; /* Actual requested buffer */ 418
419 /* These elements define the operation we ultimately want to perform */ 420 unsignedchardata_cmnd[12];
421 unsignedshortold_use_sg; /* We save use_sg here when requesting 422 sense info */ 423 unsignedshortuse_sg; /* Number of pieces of scatter-gather */ 424 unsignedshortsglist_len; /* size of malloc'd scatter-gather list */ 425 unsignedshortabort_reason; /* If the mid-level code requests an 426 abort, this is the reason. */ 427 unsignedbufflen; /* Size of data buffer */ 428 void *buffer; /* Data buffer */ 429
430 unsignedunderflow; /* Return error if less than this amount is 431 transfered */ 432
433 unsignedtransfersize; /* How much we are guranteed to transfer with 434 each SCSI transfer (ie, between disconnect / 435 reconnects. Probably == sector size */ 436
437
438
439 structrequestrequest; /* A copy of the command we are working on*/ 440
441 unsignedcharsense_buffer[16]; /* Sense for this command, if needed*/ 442
443
444 intretries;
445 intallowed;
446 inttimeout_per_command, timeout_total, timeout;
447 /* 448 * We handle the timeout differently if it happens when a reset, 449 * abort, etc are in process. 450 */ 451
452 unsignedvolatilecharinternal_timeout;
453
454 unsignedflags;
455
456 /* These variables are for the cdrom only. Once we have variable size buffers 457 in the buffer cache, they will go away. */ 458 intthis_count;
459 /* End of special cdrom variables */ 460
461 /* Low-level done function - can be used by low-level driver to point 462 to completion function. Not used by mid/upper level code. */ 463 void (*scsi_done)(structscsi_cmnd *);
464 void (*done)(structscsi_cmnd *); /* Mid-level done function */ 465
466 /* The following fields can be written to by the host specific code. 467 Everything else should be left alone. */ 468
469 Scsi_PointerSCp; /* Scratchpad used by some host adapters */ 470
471 unsignedchar * host_scribble; /* The host adapter is allowed to 472 call scsi_malloc and get some memory 473 and hang it here. The host adapter 474 is also expected to call scsi_free 475 to release this memory. (The memory 476 obtained by scsi_malloc is guaranteed 477 to be at an address < 16Mb). */ 478
479 intresult; /* Status code from lower level driver */ 480
481 unsignedchartag; /* SCSI-II queued command tag */ 482 }Scsi_Cmnd;
483
484 /* 485 scsi_abort aborts the current command that is executing on host host. 486 The error code, if non zero is returned in the host byte, otherwise 487 DID_ABORT is returned in the hostbyte. 488 */ 489
490 externintscsi_abort (Scsi_Cmnd *, intcode);
491
492 externvoidscsi_do_cmd (Scsi_Cmnd *, constvoid *cmnd ,
493 void *buffer, unsignedbufflen, void (*done)(structscsi_cmnd *),
494 inttimeout, intretries);
495
496
497 externScsi_Cmnd * allocate_device(structrequest **, Scsi_Device *, int);
498
499 externScsi_Cmnd * request_queueable(structrequest *, Scsi_Device *);
500 externintscsi_reset (Scsi_Cmnd *);
501
502 externintmax_scsi_hosts;
503 externintMAX_SD, NR_SD, MAX_ST, NR_ST, MAX_SR, NR_SR, NR_SG, MAX_SG;
504 externunsignedlongsd_init(unsignedlong, unsignedlong);
505 externvoidsd_init1(void);
506 externvoidsd_attach(Scsi_Device *);
507
508 externunsignedlongsr_init(unsignedlong, unsignedlong);
509 externvoidsr_init1(void);
510 externvoidsr_attach(Scsi_Device *);
511
512 externunsignedlongst_init(unsignedlong, unsignedlong);
513 externvoidst_init1(void);
514 externvoidst_attach(Scsi_Device *);
515
516 externunsignedlongsg_init(unsignedlong, unsignedlong);
517 externvoidsg_init1(void);
518 externvoidsg_attach(Scsi_Device *);
519
520 #ifdefined(MAJOR_NR) && (MAJOR_NR != SCSI_TAPE_MAJOR)
521 staticvoidend_scsi_request(Scsi_Cmnd * SCpnt, intuptodate, intsectors)
/* */ 522 { 523 structrequest * req;
524 structbuffer_head * bh;
525
526 req = &SCpnt->request;
527 req->errors = 0;
528 if (!uptodate) { 529 printk(DEVICE_NAME " I/O error: dev %04x, sector %lu\n",
530 req->dev,req->sector);
531 } 532
533 do{ 534 if ((bh = req->bh) != NULL) { 535 req->bh = bh->b_reqnext;
536 req->nr_sectors -= bh->b_size >> 9;
537 req->sector += bh->b_size >> 9;
538 bh->b_reqnext = NULL;
539 bh->b_uptodate = uptodate;
540 unlock_buffer(bh);
541 sectors -= bh->b_size >> 9;
542 if ((bh = req->bh) != NULL) { 543 req->current_nr_sectors = bh->b_size >> 9;
544 if (req->nr_sectors < req->current_nr_sectors) { 545 req->nr_sectors = req->current_nr_sectors;
546 printk("end_scsi_request: buffer-list destroyed\n");
547 } 548 } 549 } 550 }while(sectors && bh);
551 if (req->bh){ 552 req->buffer = bh->b_data;
553 return;
554 };
555 DEVICE_OFF(req->dev);
556 if (req->sem != NULL) { 557 up(req->sem);
558 } 559 req->dev = -1;
560 wake_up(&SCpnt->device->device_wait);
561 return;
562 } 563
564
565 /* This is just like INIT_REQUEST, but we need to be aware of the fact 566 that an interrupt may start another request, so we run this with interrupts 567 turned off */ 568
569 #defineINIT_SCSI_REQUEST \
570 if (!CURRENT) {\
571 CLEAR_INTR; \
572 sti(); \
573 return; \
574 } \
575 if (MAJOR(CURRENT->dev) != MAJOR_NR) \
576 panic(DEVICE_NAME ": request list destroyed"); \
577 if (CURRENT->bh) { \
578 if (!CURRENT->bh->b_lock) \
579 panic(DEVICE_NAME ": block not locked"); \
580 } 581 #endif 582
583 #defineSCSI_SLEEP(QUEUE, CONDITION) { \
584 if (CONDITION) { \
585 structwait_queuewait = {current, NULL}; \
586 add_wait_queue(QUEUE, &wait); \
587 sleep_repeat: \
588 current->state = TASK_UNINTERRUPTIBLE; \
589 if (CONDITION) { \
590 schedule(); \
591 gotosleep_repeat; \
592 } \
593 remove_wait_queue(QUEUE, &wait); \
594 current->state = TASK_RUNNING; \
595 }; } 596
597 #endif