]>
Commit | Line | Data |
---|---|---|
1 | #ifndef _SCSI_GENERIC_H | |
2 | #define _SCSI_GENERIC_H | |
3 | ||
4 | #include <linux/compiler.h> | |
5 | ||
6 | /* | |
7 | * History: | |
8 | * Started: Aug 9 by Lawrence Foard (entropy@world.std.com), to allow user | |
9 | * process control of SCSI devices. | |
10 | * Development Sponsored by Killy Corp. NY NY | |
11 | * | |
12 | * Original driver (sg.h): | |
13 | * Copyright (C) 1992 Lawrence Foard | |
14 | * Version 2 and 3 extensions to driver: | |
15 | * Copyright (C) 1998 - 2014 Douglas Gilbert | |
16 | * | |
17 | * Version: 3.5.36 (20140603) | |
18 | * This version is for 2.6 and 3 series kernels. | |
19 | * | |
20 | * Documentation | |
21 | * ============= | |
22 | * A web site for the SG device driver can be found at: | |
23 | * http://sg.danny.cz/sg [alternatively check the MAINTAINERS file] | |
24 | * The documentation for the sg version 3 driver can be found at: | |
25 | * http://sg.danny.cz/sg/p/sg_v3_ho.html | |
26 | * Also see: <kernel_source>/Documentation/scsi/scsi-generic.txt | |
27 | * | |
28 | * For utility and test programs see: http://sg.danny.cz/sg/sg3_utils.html | |
29 | */ | |
30 | ||
31 | #ifdef __KERNEL__ | |
32 | extern int sg_big_buff; /* for sysctl */ | |
33 | #endif | |
34 | ||
35 | ||
36 | typedef struct sg_iovec /* same structure as used by readv() Linux system */ | |
37 | { /* call. It defines one scatter-gather element. */ | |
38 | void __user *iov_base; /* Starting address */ | |
39 | size_t iov_len; /* Length in bytes */ | |
40 | } sg_iovec_t; | |
41 | ||
42 | ||
43 | typedef struct sg_io_hdr | |
44 | { | |
45 | int interface_id; /* [i] 'S' for SCSI generic (required) */ | |
46 | int dxfer_direction; /* [i] data transfer direction */ | |
47 | unsigned char cmd_len; /* [i] SCSI command length */ | |
48 | unsigned char mx_sb_len; /* [i] max length to write to sbp */ | |
49 | unsigned short iovec_count; /* [i] 0 implies no scatter gather */ | |
50 | unsigned int dxfer_len; /* [i] byte count of data transfer */ | |
51 | void __user *dxferp; /* [i], [*io] points to data transfer memory | |
52 | or scatter gather list */ | |
53 | unsigned char __user *cmdp; /* [i], [*i] points to command to perform */ | |
54 | void __user *sbp; /* [i], [*o] points to sense_buffer memory */ | |
55 | unsigned int timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */ | |
56 | unsigned int flags; /* [i] 0 -> default, see SG_FLAG... */ | |
57 | int pack_id; /* [i->o] unused internally (normally) */ | |
58 | void __user * usr_ptr; /* [i->o] unused internally */ | |
59 | unsigned char status; /* [o] scsi status */ | |
60 | unsigned char masked_status;/* [o] shifted, masked scsi status */ | |
61 | unsigned char msg_status; /* [o] messaging level data (optional) */ | |
62 | unsigned char sb_len_wr; /* [o] byte count actually written to sbp */ | |
63 | unsigned short host_status; /* [o] errors from host adapter */ | |
64 | unsigned short driver_status;/* [o] errors from software driver */ | |
65 | int resid; /* [o] dxfer_len - actual_transferred */ | |
66 | unsigned int duration; /* [o] time taken by cmd (unit: millisec) */ | |
67 | unsigned int info; /* [o] auxiliary information */ | |
68 | } sg_io_hdr_t; /* 64 bytes long (on i386) */ | |
69 | ||
70 | #define SG_INTERFACE_ID_ORIG 'S' | |
71 | ||
72 | /* Use negative values to flag difference from original sg_header structure */ | |
73 | #define SG_DXFER_NONE (-1) /* e.g. a SCSI Test Unit Ready command */ | |
74 | #define SG_DXFER_TO_DEV (-2) /* e.g. a SCSI WRITE command */ | |
75 | #define SG_DXFER_FROM_DEV (-3) /* e.g. a SCSI READ command */ | |
76 | #define SG_DXFER_TO_FROM_DEV (-4) /* treated like SG_DXFER_FROM_DEV with the | |
77 | additional property than during indirect | |
78 | IO the user buffer is copied into the | |
79 | kernel buffers before the transfer */ | |
80 | #define SG_DXFER_UNKNOWN (-5) /* Unknown data direction */ | |
81 | ||
82 | /* following flag values can be "or"-ed together */ | |
83 | #define SG_FLAG_DIRECT_IO 1 /* default is indirect IO */ | |
84 | #define SG_FLAG_UNUSED_LUN_INHIBIT 2 /* default is overwrite lun in SCSI */ | |
85 | /* command block (when <= SCSI_2) */ | |
86 | #define SG_FLAG_MMAP_IO 4 /* request memory mapped IO */ | |
87 | #define SG_FLAG_NO_DXFER 0x10000 /* no transfer of kernel buffers to/from */ | |
88 | /* user space (debug indirect IO) */ | |
89 | /* defaults:: for sg driver: Q_AT_HEAD; for block layer: Q_AT_TAIL */ | |
90 | #define SG_FLAG_Q_AT_TAIL 0x10 | |
91 | #define SG_FLAG_Q_AT_HEAD 0x20 | |
92 | ||
93 | /* following 'info' values are "or"-ed together */ | |
94 | #define SG_INFO_OK_MASK 0x1 | |
95 | #define SG_INFO_OK 0x0 /* no sense, host nor driver "noise" */ | |
96 | #define SG_INFO_CHECK 0x1 /* something abnormal happened */ | |
97 | ||
98 | #define SG_INFO_DIRECT_IO_MASK 0x6 | |
99 | #define SG_INFO_INDIRECT_IO 0x0 /* data xfer via kernel buffers (or no xfer) */ | |
100 | #define SG_INFO_DIRECT_IO 0x2 /* direct IO requested and performed */ | |
101 | #define SG_INFO_MIXED_IO 0x4 /* part direct, part indirect IO */ | |
102 | ||
103 | ||
104 | typedef struct sg_scsi_id { /* used by SG_GET_SCSI_ID ioctl() */ | |
105 | int host_no; /* as in "scsi<n>" where 'n' is one of 0, 1, 2 etc */ | |
106 | int channel; | |
107 | int scsi_id; /* scsi id of target device */ | |
108 | int lun; | |
109 | int scsi_type; /* TYPE_... defined in scsi/scsi.h */ | |
110 | short h_cmd_per_lun;/* host (adapter) maximum commands per lun */ | |
111 | short d_queue_depth;/* device (or adapter) maximum queue length */ | |
112 | int unused[2]; /* probably find a good use, set 0 for now */ | |
113 | } sg_scsi_id_t; /* 32 bytes long on i386 */ | |
114 | ||
115 | typedef struct sg_req_info { /* used by SG_GET_REQUEST_TABLE ioctl() */ | |
116 | char req_state; /* 0 -> not used, 1 -> written, 2 -> ready to read */ | |
117 | char orphan; /* 0 -> normal request, 1 -> from interruped SG_IO */ | |
118 | char sg_io_owned; /* 0 -> complete with read(), 1 -> owned by SG_IO */ | |
119 | char problem; /* 0 -> no problem detected, 1 -> error to report */ | |
120 | int pack_id; /* pack_id associated with request */ | |
121 | void __user *usr_ptr; /* user provided pointer (in new interface) */ | |
122 | unsigned int duration; /* millisecs elapsed since written (req_state==1) | |
123 | or request duration (req_state==2) */ | |
124 | int unused; | |
125 | } sg_req_info_t; /* 20 bytes long on i386 */ | |
126 | ||
127 | ||
128 | /* IOCTLs: Those ioctls that are relevant to the SG 3.x drivers follow. | |
129 | [Those that only apply to the SG 2.x drivers are at the end of the file.] | |
130 | (_GET_s yield result via 'int *' 3rd argument unless otherwise indicated) */ | |
131 | ||
132 | #define SG_EMULATED_HOST 0x2203 /* true for emulated host adapter (ATAPI) */ | |
133 | ||
134 | /* Used to configure SCSI command transformation layer for ATAPI devices */ | |
135 | /* Only supported by the ide-scsi driver */ | |
136 | #define SG_SET_TRANSFORM 0x2204 /* N.B. 3rd arg is not pointer but value: */ | |
137 | /* 3rd arg = 0 to disable transform, 1 to enable it */ | |
138 | #define SG_GET_TRANSFORM 0x2205 | |
139 | ||
140 | #define SG_SET_RESERVED_SIZE 0x2275 /* request a new reserved buffer size */ | |
141 | #define SG_GET_RESERVED_SIZE 0x2272 /* actual size of reserved buffer */ | |
142 | ||
143 | /* The following ioctl has a 'sg_scsi_id_t *' object as its 3rd argument. */ | |
144 | #define SG_GET_SCSI_ID 0x2276 /* Yields fd's bus, chan, dev, lun + type */ | |
145 | /* SCSI id information can also be obtained from SCSI_IOCTL_GET_IDLUN */ | |
146 | ||
147 | /* Override host setting and always DMA using low memory ( <16MB on i386) */ | |
148 | #define SG_SET_FORCE_LOW_DMA 0x2279 /* 0-> use adapter setting, 1-> force */ | |
149 | #define SG_GET_LOW_DMA 0x227a /* 0-> use all ram for dma; 1-> low dma ram */ | |
150 | ||
151 | /* When SG_SET_FORCE_PACK_ID set to 1, pack_id is input to read() which | |
152 | tries to fetch a packet with a matching pack_id, waits, or returns EAGAIN. | |
153 | If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0 | |
154 | then pack_id ignored by read() and oldest readable fetched. */ | |
155 | #define SG_SET_FORCE_PACK_ID 0x227b | |
156 | #define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */ | |
157 | ||
158 | #define SG_GET_NUM_WAITING 0x227d /* Number of commands awaiting read() */ | |
159 | ||
160 | /* Yields max scatter gather tablesize allowed by current host adapter */ | |
161 | #define SG_GET_SG_TABLESIZE 0x227F /* 0 implies can't do scatter gather */ | |
162 | ||
163 | #define SG_GET_VERSION_NUM 0x2282 /* Example: version 2.1.34 yields 20134 */ | |
164 | ||
165 | /* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */ | |
166 | #define SG_SCSI_RESET 0x2284 | |
167 | /* Associated values that can be given to SG_SCSI_RESET follow. | |
168 | * SG_SCSI_RESET_NO_ESCALATE may be OR-ed to the _DEVICE, _TARGET, _BUS | |
169 | * or _HOST reset value so only that action is attempted. */ | |
170 | #define SG_SCSI_RESET_NOTHING 0 | |
171 | #define SG_SCSI_RESET_DEVICE 1 | |
172 | #define SG_SCSI_RESET_BUS 2 | |
173 | #define SG_SCSI_RESET_HOST 3 | |
174 | #define SG_SCSI_RESET_TARGET 4 | |
175 | #define SG_SCSI_RESET_NO_ESCALATE 0x100 | |
176 | ||
177 | /* synchronous SCSI command ioctl, (only in version 3 interface) */ | |
178 | #define SG_IO 0x2285 /* similar effect as write() followed by read() */ | |
179 | ||
180 | #define SG_GET_REQUEST_TABLE 0x2286 /* yields table of active requests */ | |
181 | ||
182 | /* How to treat EINTR during SG_IO ioctl(), only in SG 3.x series */ | |
183 | #define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */ | |
184 | #define SG_GET_KEEP_ORPHAN 0x2288 | |
185 | ||
186 | /* yields scsi midlevel's access_count for this SCSI device */ | |
187 | #define SG_GET_ACCESS_COUNT 0x2289 | |
188 | ||
189 | ||
190 | #define SG_SCATTER_SZ (8 * 4096) | |
191 | /* Largest size (in bytes) a single scatter-gather list element can have. | |
192 | The value used by the driver is 'max(SG_SCATTER_SZ, PAGE_SIZE)'. | |
193 | This value should be a power of 2 (and may be rounded up internally). | |
194 | If scatter-gather is not supported by adapter then this value is the | |
195 | largest data block that can be read/written by a single scsi command. */ | |
196 | ||
197 | #define SG_DEFAULT_RETRIES 0 | |
198 | ||
199 | /* Defaults, commented if they differ from original sg driver */ | |
200 | #define SG_DEF_FORCE_PACK_ID 0 | |
201 | #define SG_DEF_KEEP_ORPHAN 0 | |
202 | #define SG_DEF_RESERVED_SIZE SG_SCATTER_SZ /* load time option */ | |
203 | ||
204 | /* maximum outstanding requests, write() yields EDOM if exceeded */ | |
205 | #define SG_MAX_QUEUE 16 | |
206 | ||
207 | #define SG_BIG_BUFF SG_DEF_RESERVED_SIZE /* for backward compatibility */ | |
208 | ||
209 | /* Alternate style type names, "..._t" variants preferred */ | |
210 | typedef struct sg_io_hdr Sg_io_hdr; | |
211 | typedef struct sg_io_vec Sg_io_vec; | |
212 | typedef struct sg_scsi_id Sg_scsi_id; | |
213 | typedef struct sg_req_info Sg_req_info; | |
214 | ||
215 | ||
216 | /* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv */ | |
217 | /* The older SG interface based on the 'sg_header' structure follows. */ | |
218 | /* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */ | |
219 | ||
220 | #define SG_MAX_SENSE 16 /* this only applies to the sg_header interface */ | |
221 | ||
222 | struct sg_header | |
223 | { | |
224 | int pack_len; /* [o] reply_len (ie useless), ignored as input */ | |
225 | int reply_len; /* [i] max length of expected reply (inc. sg_header) */ | |
226 | int pack_id; /* [io] id number of packet (use ints >= 0) */ | |
227 | int result; /* [o] 0==ok, else (+ve) Unix errno (best ignored) */ | |
228 | unsigned int twelve_byte:1; | |
229 | /* [i] Force 12 byte command length for group 6 & 7 commands */ | |
230 | unsigned int target_status:5; /* [o] scsi status from target */ | |
231 | unsigned int host_status:8; /* [o] host status (see "DID" codes) */ | |
232 | unsigned int driver_status:8; /* [o] driver status+suggestion */ | |
233 | unsigned int other_flags:10; /* unused */ | |
234 | unsigned char sense_buffer[SG_MAX_SENSE]; /* [o] Output in 3 cases: | |
235 | when target_status is CHECK_CONDITION or | |
236 | when target_status is COMMAND_TERMINATED or | |
237 | when (driver_status & DRIVER_SENSE) is true. */ | |
238 | }; /* This structure is 36 bytes long on i386 */ | |
239 | ||
240 | ||
241 | /* IOCTLs: The following are not required (or ignored) when the sg_io_hdr_t | |
242 | interface is used. They are kept for backward compatibility with | |
243 | the original and version 2 drivers. */ | |
244 | ||
245 | #define SG_SET_TIMEOUT 0x2201 /* unit: jiffies (10ms on i386) */ | |
246 | #define SG_GET_TIMEOUT 0x2202 /* yield timeout as _return_ value */ | |
247 | ||
248 | /* Get/set command queuing state per fd (default is SG_DEF_COMMAND_Q. | |
249 | Each time a sg_io_hdr_t object is seen on this file descriptor, this | |
250 | command queuing flag is set on (overriding the previous setting). */ | |
251 | #define SG_GET_COMMAND_Q 0x2270 /* Yields 0 (queuing off) or 1 (on) */ | |
252 | #define SG_SET_COMMAND_Q 0x2271 /* Change queuing state with 0 or 1 */ | |
253 | ||
254 | /* Turn on/off error sense trace (1 and 0 respectively, default is off). | |
255 | Try using: "# cat /proc/scsi/sg/debug" instead in the v3 driver */ | |
256 | #define SG_SET_DEBUG 0x227e /* 0 -> turn off debug */ | |
257 | ||
258 | #define SG_NEXT_CMD_LEN 0x2283 /* override SCSI command length with given | |
259 | number on the next write() on this file descriptor */ | |
260 | ||
261 | ||
262 | /* Defaults, commented if they differ from original sg driver */ | |
263 | #ifdef __KERNEL__ | |
264 | #define SG_DEFAULT_TIMEOUT_USER (60*USER_HZ) /* HZ == 'jiffies in 1 second' */ | |
265 | #else | |
266 | #define SG_DEFAULT_TIMEOUT (60*HZ) /* HZ == 'jiffies in 1 second' */ | |
267 | #endif | |
268 | ||
269 | #define SG_DEF_COMMAND_Q 0 /* command queuing is always on when | |
270 | the new interface is used */ | |
271 | #define SG_DEF_UNDERRUN_FLAG 0 | |
272 | ||
273 | #endif |