1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
/* $OpenBSD: scsiconf.h,v 1.54 2005/05/25 21:39:08 krw Exp $ */
/* $NetBSD: scsiconf.h,v 1.35 1997/04/02 02:29:38 mycroft Exp $ */
/*
* Copyright (c) 1993, 1994, 1995 Charles Hannum. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by Charles Hannum.
* 4. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Originally written by Julian Elischer (julian@tfs.com)
* for TRW Financial Systems for use under the MACH(2.5) operating system.
*
* TRW Financial Systems, in accordance with their agreement with Carnegie
* Mellon University, makes this software available to CMU to distribute
* or use in any manner that they see fit as long as this message is kept with
* the software. For this reason TFS also grants any other persons or
* organisations permission to use or modify this software.
*
* TFS supplies this software to be publicly redistributed
* on the understanding that TFS is not responsible for the correct
* functioning of this software in any circumstances.
*
* Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
*/
#ifndef SCSI_SCSICONF_H
#define SCSI_SCSICONF_H 1
typedef int boolean;
#include <sys/queue.h>
#include <sys/timeout.h>
#include <machine/cpu.h>
#include <scsi/scsi_debug.h>
/*
* The following documentation tries to describe the relationship between the
* various structures defined in this file:
*
* each adapter type has a scsi_adapter struct. This describes the adapter and
* identifies routines that can be called to use the adapter.
* each device type has a scsi_device struct. This describes the device and
* identifies routines that can be called to use the device.
* each existing device position (scsibus + target + lun)
* can be described by a scsi_link struct.
* Only scsi positions that actually have devices, have a scsi_link
* structure assigned. so in effect each device has scsi_link struct.
* The scsi_link structure contains information identifying both the
* device driver and the adapter driver for that position on that scsi bus,
* and can be said to 'link' the two.
* each individual scsi bus has an array that points to all the scsi_link
* structs associated with that scsi bus. Slots with no device have
* a NULL pointer.
* each individual device also knows the address of it's own scsi_link
* structure.
*
* -------------
*
* The key to all this is the scsi_link structure which associates all the
* other structures with each other in the correct configuration. The
* scsi_link is the connecting information that allows each part of the
* scsi system to find the associated other parts.
*/
struct buf;
struct scsi_xfer;
struct scsi_link;
/*
* Temporary hack
*/
extern int scsi_autoconf;
/*
* Specify which buses and targets must scan all LUNs, even when IDENTIFY does
* not seem to be working. Some devices (e.g. some external RAID devices) may
* seem to have non-functional IDENTIFY because they return identical INQUIRY
* data for all LUNs.
*/
#ifndef SCSIFORCELUN_BUSES
#define SCSIFORCELUN_BUSES 0
#endif
#ifndef SCSIFORCELUN_TARGETS
#define SCSIFORCELUN_TARGETS 0
#endif
extern int scsiforcelun_buses, scsiforcelun_targets;
/*
* These entrypoints are called by the high-end drivers to get services from
* whatever low-end drivers they are attached to. Each adapter type has one
* of these statically allocated.
*/
struct scsi_adapter {
int (*scsi_cmd)(struct scsi_xfer *);
void (*scsi_minphys)(struct buf *);
int (*open_target_lu)(void);
int (*close_target_lu)(void);
int (*ioctl)(struct scsi_link *, u_long cmd,
caddr_t addrp, int flag, struct proc *p);
};
/*
* return values for scsi_cmd()
*/
#define SUCCESSFULLY_QUEUED 0
#define TRY_AGAIN_LATER 1
#define COMPLETE 2
#define ESCAPE_NOT_SUPPORTED 3
/*
* These entry points are called by the low-end drivers to get services from
* whatever high-end drivers they are attached to. Each device type has one
* of these statically allocated.
*/
struct scsi_device {
int (*err_handler)(struct scsi_xfer *);
/* returns -1 to say err processing done */
void (*start)(void *);
int (*async)(void);
/*
* When called with `0' as the second argument, we expect status
* back from the upper-level driver. When called with a `1',
* we're simply notifying the upper-level driver that the command
* is complete and expect no status back.
*/
void (*done)(struct scsi_xfer *);
};
/*
* This structure describes the connection between an adapter driver and
* a device driver, and is used by each to call services provided by
* the other, and to allow generic scsi glue code to call these services
* as well.
*/
struct scsi_link {
u_int8_t scsi_version; /* SCSI-I, SCSI-II, etc. */
u_int8_t scsibus; /* the Nth scsibus */
u_int16_t target; /* targ of this dev */
u_int16_t lun; /* lun of this dev */
u_int16_t adapter_target; /* what are we on the scsi bus */
u_int16_t adapter_buswidth; /* 8 (regular) or 16 (wide). (0 becomes 8) */
u_int16_t openings; /* available operations */
u_int16_t active; /* operations in progress */
u_int16_t flags; /* flags that all devices have */
#define SDEV_REMOVABLE 0x0001 /* media is removable */
#define SDEV_MEDIA_LOADED 0x0002 /* device figures are still valid */
#define SDEV_WAITING 0x0004 /* a process is waiting for this */
#define SDEV_OPEN 0x0008 /* at least 1 open session */
#define SDEV_DBX 0x00f0 /* debugging flags (scsi_debug.h) */
#define SDEV_EJECTING 0x0100 /* eject on device close */
#define SDEV_ATAPI 0x0200 /* device is ATAPI */
#define SDEV_2NDBUS 0x0400 /* device is a 'second' bus device */
#define SDEV_UMASS 0x0800 /* device is UMASS SCSI */
u_int16_t quirks; /* per-device oddities */
#define SDEV_AUTOSAVE 0x0001 /* do implicit SAVEDATAPOINTER on disconnect */
#define SDEV_NOSYNC 0x0002 /* does not grok SDTR */
#define SDEV_NOWIDE 0x0004 /* does not grok WDTR */
#define SDEV_NOTAGS 0x0008 /* lies about having tagged queueing */
#define SDEV_NOSYNCCACHE 0x0100 /* no SYNCHRONIZE_CACHE */
#define ADEV_NOSENSE 0x0200 /* No request sense - ATAPI */
#define ADEV_LITTLETOC 0x0400 /* little-endian TOC - ATAPI */
#define ADEV_NOCAPACITY 0x0800 /* no READ CD CAPACITY */
#define ADEV_NOTUR 0x1000 /* No TEST UNIT READY */
#define ADEV_NODOORLOCK 0x2000 /* can't lock door */
#define SDEV_ONLYBIG 0x4000 /* always use READ_BIG and WRITE_BIG */
u_int8_t inquiry_flags; /* copy of flags from probe INQUIRY */
struct scsi_device *device; /* device entry points etc. */
void *device_softc; /* needed for call to foo_start */
struct scsi_adapter *adapter; /* adapter entry points etc. */
void *adapter_softc; /* needed for call to foo_scsi_cmd */
u_char luns;
};
int scsiprint(void *, const char *);
/*
* This describes matching information for scsi_inqmatch(). The more things
* match, the higher the configuration priority.
*/
struct scsi_inquiry_pattern {
u_int8_t type;
boolean removable;
char *vendor;
char *product;
char *revision;
};
/*
* One of these is allocated and filled in for each scsi bus.
* It holds pointers to allow the scsi bus to get to the driver
* that is running each LUN on the bus.
* It also has a template entry which is the prototype struct
* supplied by the adapter driver. This is used to initialise
* the others, before they have the rest of the fields filled in.
*/
struct scsibus_softc {
struct device sc_dev;
struct scsi_link *adapter_link; /* prototype supplied by adapter */
struct scsi_link ***sc_link;
u_int16_t sc_buswidth;
};
/*
* This is used to pass information from the high-level configuration code
* to the device-specific drivers.
*/
struct scsibus_attach_args {
struct scsi_link *sa_sc_link;
struct scsi_inquiry_data *sa_inqbuf;
};
/*
* Each scsi transaction is fully described by one of these structures.
* It includes information about the source of the command and also the
* device and adapter for which the command is destined.
* (via the scsi_link structure)
*/
struct scsi_xfer {
LIST_ENTRY(scsi_xfer) free_list;
int flags;
struct scsi_link *sc_link; /* all about our device and adapter */
int retries; /* the number of times to retry */
int timeout; /* in milliseconds */
struct scsi_generic *cmd; /* The scsi command to execute */
int cmdlen; /* how long it is */
u_char *data; /* dma address OR a uio address */
int datalen; /* data len (blank if uio) */
size_t resid; /* how much buffer was not touched */
int error; /* an error value */
struct buf *bp; /* If we need to associate with a buf */
struct scsi_sense_data sense; /* 32 bytes*/
/*
* Believe it or not, Some targets fall on the ground with
* anything but a certain sense length.
*/
int req_sense_length; /* Explicit request sense length */
u_int8_t status; /* SCSI status */
struct scsi_generic cmdstore; /* stash the command in here */
/*
* timeout structure for hba's to use for a command
*/
struct timeout stimeout;
};
/*
* Per-request Flag values
*/
#define SCSI_NOSLEEP 0x00001 /* don't sleep */
#define SCSI_POLL 0x00002 /* poll for completion */
#define SCSI_AUTOCONF 0x00003 /* shorthand for SCSI_POLL | SCSI_NOSLEEP */
#define SCSI_USER 0x00004 /* Is a user cmd, call scsi_user_done */
#define ITSDONE 0x00008 /* the transfer is as done as it gets */
#define SCSI_SILENT 0x00020 /* don't announce NOT READY or MEDIA CHANGE */
#define SCSI_IGNORE_NOT_READY 0x00040 /* ignore NOT READY */
#define SCSI_IGNORE_MEDIA_CHANGE 0x00080 /* ignore MEDIA CHANGE */
#define SCSI_IGNORE_ILLEGAL_REQUEST 0x00100 /* ignore ILLEGAL REQUEST */
#define SCSI_RESET 0x00200 /* Reset the device in question */
#define SCSI_DATA_UIO 0x00400 /* The data address refers to a UIO */
#define SCSI_DATA_IN 0x00800 /* expect data to come INTO memory */
#define SCSI_DATA_OUT 0x01000 /* expect data to flow OUT of memory */
#define SCSI_TARGET 0x02000 /* This defines a TARGET mode op. */
#define SCSI_ESCAPE 0x04000 /* Escape operation */
#define SCSI_URGENT 0x08000 /* Urgent operation (e.g., HTAG) */
#define SCSI_PRIVATE 0xf0000 /* private to each HBA flags */
/*
* Escape op-codes. This provides an extensible setup for operations
* that are not scsi commands. They are intended for modal operations.
*/
#define SCSI_OP_TARGET 0x0001
#define SCSI_OP_RESET 0x0002
#define SCSI_OP_BDINFO 0x0003
/*
* Error values an adapter driver may return
*/
#define XS_NOERROR 0 /* there is no error, (sense is invalid) */
#define XS_SENSE 1 /* Check the returned sense for the error */
#define XS_DRIVER_STUFFUP 2 /* Driver failed to perform operation */
#define XS_SELTIMEOUT 3 /* The device timed out.. turned off? */
#define XS_TIMEOUT 4 /* The Timeout reported was caught by SW */
#define XS_BUSY 5 /* The device busy, try again later? */
#define XS_SHORTSENSE 6 /* Check the ATAPI sense for the error */
#define XS_RESET 8 /* bus was reset; possible retry command */
/*
* Possible retries numbers for scsi_test_unit_ready()
*/
#define TEST_READY_RETRIES_DEFAULT 5
#define TEST_READY_RETRIES_CD 10
#define TEST_READY_RETRIES_TAPE 60
const void *scsi_inqmatch(struct scsi_inquiry_data *, const void *, int,
int, int *);
void scsi_init(void);
struct scsi_xfer *
scsi_get_xs(struct scsi_link *, int);
void scsi_free_xs(struct scsi_xfer *);
int scsi_execute_xs(struct scsi_xfer *);
u_long scsi_size(struct scsi_link *, int);
int scsi_test_unit_ready(struct scsi_link *, int, int);
int scsi_inquire(struct scsi_link *, struct scsi_inquiry_data *, int);
int scsi_prevent(struct scsi_link *, int, int);
int scsi_start(struct scsi_link *, int, int);
int scsi_mode_sense(struct scsi_link *, int, int, struct scsi_mode_header *,
size_t, int, int);
int scsi_mode_sense_big(struct scsi_link *, int, int,
struct scsi_mode_header_big *, size_t, int, int);
void * scsi_mode_sense_page(struct scsi_mode_header *, int);
void * scsi_mode_sense_big_page(struct scsi_mode_header_big *, int);
int scsi_do_mode_sense(struct scsi_link *, int,
struct scsi_mode_sense_buf *, void **, int *, int *, int *, int,
int);
int scsi_mode_select(struct scsi_link *, int, struct scsi_mode_header *,
size_t, int, int);
int scsi_mode_select_big(struct scsi_link *, int,
struct scsi_mode_header_big *, size_t, int, int);
void scsi_done(struct scsi_xfer *);
void scsi_user_done(struct scsi_xfer *);
int scsi_scsi_cmd(struct scsi_link *, struct scsi_generic *,
int cmdlen, u_char *data_addr, int datalen, int retries,
int timeout, struct buf *bp, int flags);
int scsi_do_ioctl(struct scsi_link *, dev_t, u_long, caddr_t,
int, struct proc *);
void sc_print_addr(struct scsi_link *);
void show_scsi_xs(struct scsi_xfer *);
void scsi_print_sense(struct scsi_xfer *);
void show_scsi_cmd(struct scsi_xfer *);
void show_mem(u_char *, int);
int scsi_probe_busses(int, int, int);
void scsi_strvis(u_char *, u_char *, int);
static __inline void _lto2b(u_int32_t val, u_int8_t *bytes);
static __inline void _lto3b(u_int32_t val, u_int8_t *bytes);
static __inline void _lto4b(u_int32_t val, u_int8_t *bytes);
static __inline u_int32_t _2btol(u_int8_t *bytes);
static __inline u_int32_t _3btol(u_int8_t *bytes);
static __inline u_int32_t _4btol(u_int8_t *bytes);
static __inline void _lto2l(u_int32_t val, u_int8_t *bytes);
static __inline void _lto3l(u_int32_t val, u_int8_t *bytes);
static __inline void _lto4l(u_int32_t val, u_int8_t *bytes);
static __inline u_int32_t _2ltol(u_int8_t *bytes);
static __inline u_int32_t _3ltol(u_int8_t *bytes);
static __inline u_int32_t _4ltol(u_int8_t *bytes);
static __inline void
_lto2b(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = (val >> 8) & 0xff;
bytes[1] = val & 0xff;
}
static __inline void
_lto3b(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = (val >> 16) & 0xff;
bytes[1] = (val >> 8) & 0xff;
bytes[2] = val & 0xff;
}
static __inline void
_lto4b(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = (val >> 24) & 0xff;
bytes[1] = (val >> 16) & 0xff;
bytes[2] = (val >> 8) & 0xff;
bytes[3] = val & 0xff;
}
static __inline u_int32_t
_2btol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = (bytes[0] << 8) | bytes[1];
return (rv);
}
static __inline u_int32_t
_3btol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = (bytes[0] << 16) | (bytes[1] << 8) | bytes[2];
return (rv);
}
static __inline u_int32_t
_4btol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = (bytes[0] << 24) | (bytes[1] << 16) |
(bytes[2] << 8) | bytes[3];
return (rv);
}
static __inline void
_lto2l(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = val & 0xff;
bytes[1] = (val >> 8) & 0xff;
}
static __inline void
_lto3l(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = val & 0xff;
bytes[1] = (val >> 8) & 0xff;
bytes[2] = (val >> 16) & 0xff;
}
static __inline void
_lto4l(val, bytes)
u_int32_t val;
u_int8_t *bytes;
{
bytes[0] = val & 0xff;
bytes[1] = (val >> 8) & 0xff;
bytes[2] = (val >> 16) & 0xff;
bytes[3] = (val >> 24) & 0xff;
}
static __inline u_int32_t
_2ltol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = bytes[0] | (bytes[1] << 8);
return (rv);
}
static __inline u_int32_t
_3ltol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = bytes[0] | (bytes[1] << 8) | (bytes[2] << 16);
return (rv);
}
static __inline u_int32_t
_4ltol(bytes)
u_int8_t *bytes;
{
u_int32_t rv;
rv = bytes[0] | (bytes[1] << 8) |
(bytes[2] << 16) | (bytes[3] << 24);
return (rv);
}
#endif /* SCSI_SCSICONF_H */
|