1 /* Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation, Inc. 2 This file is part of the GNU C Library. 3 4 The GNU C Library is free software; you can redistribute it and/or 5 modify it under the terms of the GNU Lesser General Public 6 License as published by the Free Software Foundation; either 7 version 2.1 of the License, or (at your option) any later version. 8 9 The GNU C Library is distributed in the hope that it will be useful, 10 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 Lesser General Public License for more details. 13 14 You should have received a copy of the GNU Lesser General Public 15 License along with the GNU C Library; if not, see 16 <http://www.gnu.org/licenses/>. */ 17 18 /* 19 History: 20 Started: Aug 9 by Lawrence Foard (entropy@world.std.com), to allow user 21 process control of SCSI devices. 22 Development Sponsored by Killy Corp. NY NY 23 */ 24 25 #ifndef _SCSI_SG_H 26 #define _SCSI_SG_H 1 27 28 #include <features.h> 29 30 31 /* New interface introduced in the 3.x SG drivers follows */ 32 33 /* Same structure as used by readv() Linux system call. It defines one 34 scatter-gather element. */ 35 typedef struct sg_iovec 36 { 37 void * iov_base; /* Starting address */ 38 size_t iov_len; /* Length in bytes */ 39 } sg_iovec_t; 40 41 42 typedef struct sg_io_hdr 43 { 44 int interface_id; /* [i] 'S' for SCSI generic (required) */ 45 int dxfer_direction; /* [i] data transfer direction */ 46 unsigned char cmd_len; /* [i] SCSI command length ( <= 16 bytes) */ 47 unsigned char mx_sb_len; /* [i] max length to write to sbp */ 48 unsigned short int iovec_count; /* [i] 0 implies no scatter gather */ 49 unsigned int dxfer_len; /* [i] byte count of data transfer */ 50 void * dxferp; /* [i], [*io] points to data transfer memory 51 or scatter gather list */ 52 unsigned char * cmdp; /* [i], [*i] points to command to perform */ 53 unsigned char * sbp; /* [i], [*o] points to sense_buffer memory */ 54 unsigned int timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */ 55 unsigned int flags; /* [i] 0 -> default, see SG_FLAG... */ 56 int pack_id; /* [i->o] unused internally (normally) */ 57 void * usr_ptr; /* [i->o] unused internally */ 58 unsigned char status; /* [o] scsi status */ 59 unsigned char masked_status;/* [o] shifted, masked scsi status */ 60 unsigned char msg_status; /* [o] messaging level data (optional) */ 61 unsigned char sb_len_wr; /* [o] byte count actually written to sbp */ 62 unsigned short int host_status; /* [o] errors from host adapter */ 63 unsigned short int driver_status;/* [o] errors from software driver */ 64 int resid; /* [o] dxfer_len - actual_transferred */ 65 unsigned int duration; /* [o] time taken by cmd (unit: millisec) */ 66 unsigned int info; /* [o] auxiliary information */ 67 } sg_io_hdr_t; 68 69 70 /* Use negative values to flag difference from original sg_header structure. */ 71 #define SG_DXFER_NONE -1 /* e.g. a SCSI Test Unit Ready command */ 72 #define SG_DXFER_TO_DEV -2 /* e.g. a SCSI WRITE command */ 73 #define SG_DXFER_FROM_DEV -3 /* e.g. a SCSI READ command */ 74 #define SG_DXFER_TO_FROM_DEV -4 /* treated like SG_DXFER_FROM_DEV with the 75 additional property than during indirect 76 IO the user buffer is copied into the 77 kernel buffers before the transfer */ 78 79 80 /* following flag values can be "or"-ed together */ 81 #define SG_FLAG_DIRECT_IO 1 /* default is indirect IO */ 82 #define SG_FLAG_LUN_INHIBIT 2 /* default is to put device's lun into */ 83 /* the 2nd byte of SCSI command */ 84 #define SG_FLAG_NO_DXFER 0x10000 /* no transfer of kernel buffers to/from */ 85 /* user space (debug indirect IO) */ 86 87 /* The following 'info' values are "or"-ed together. */ 88 #define SG_INFO_OK_MASK 0x1 89 #define SG_INFO_OK 0x0 /* no sense, host nor driver "noise" */ 90 #define SG_INFO_CHECK 0x1 /* something abnormal happened */ 91 92 #define SG_INFO_DIRECT_IO_MASK 0x6 93 #define SG_INFO_INDIRECT_IO 0x0 /* data xfer via kernel buffers (or no xfer) */ 94 #define SG_INFO_DIRECT_IO 0x2 /* direct IO requested and performed */ 95 #define SG_INFO_MIXED_IO 0x4 /* part direct, part indirect IO */ 96 97 98 /* Request information about a specific SG device, used by 99 SG_GET_SCSI_ID ioctl (). */ 100 struct sg_scsi_id { 101 /* Host number as in "scsi<n>" where 'n' is one of 0, 1, 2 etc. */ 102 int host_no; 103 int channel; 104 /* SCSI id of target device. */ 105 int scsi_id; 106 int lun; 107 /* TYPE_... defined in <scsi/scsi.h>. */ 108 int scsi_type; 109 /* Host (adapter) maximum commands per lun. */ 110 short int h_cmd_per_lun; 111 /* Device (or adapter) maximum queue length. */ 112 short int d_queue_depth; 113 /* Unused, set to 0 for now. */ 114 int unused[2]; 115 }; 116 117 /* Used by SG_GET_REQUEST_TABLE ioctl(). */ 118 typedef struct sg_req_info { 119 char req_state; /* 0 -> not used, 1 -> written, 2 -> ready to read */ 120 char orphan; /* 0 -> normal request, 1 -> from interruped SG_IO */ 121 char sg_io_owned; /* 0 -> complete with read(), 1 -> owned by SG_IO */ 122 char problem; /* 0 -> no problem detected, 1 -> error to report */ 123 int pack_id; /* pack_id associated with request */ 124 void * usr_ptr; /* user provided pointer (in new interface) */ 125 unsigned int duration; /* millisecs elapsed since written (req_state==1) 126 or request duration (req_state==2) */ 127 int unused; 128 } sg_req_info_t; 129 130 131 /* IOCTLs: Those ioctls that are relevant to the SG 3.x drivers follow. 132 [Those that only apply to the SG 2.x drivers are at the end of the file.] 133 (_GET_s yield result via 'int *' 3rd argument unless otherwise indicated) */ 134 135 #define SG_EMULATED_HOST 0x2203 /* true for emulated host adapter (ATAPI) */ 136 137 /* Used to configure SCSI command transformation layer for ATAPI devices */ 138 /* Only supported by the ide-scsi driver */ 139 #define SG_SET_TRANSFORM 0x2204 /* N.B. 3rd arg is not pointer but value: */ 140 /* 3rd arg = 0 to disable transform, 1 to enable it */ 141 #define SG_GET_TRANSFORM 0x2205 142 143 #define SG_SET_RESERVED_SIZE 0x2275 /* request a new reserved buffer size */ 144 #define SG_GET_RESERVED_SIZE 0x2272 /* actual size of reserved buffer */ 145 146 /* The following ioctl has a 'sg_scsi_id_t *' object as its 3rd argument. */ 147 #define SG_GET_SCSI_ID 0x2276 /* Yields fd's bus, chan, dev, lun + type */ 148 /* SCSI id information can also be obtained from SCSI_IOCTL_GET_IDLUN */ 149 150 /* Override host setting and always DMA using low memory ( <16MB on i386) */ 151 #define SG_SET_FORCE_LOW_DMA 0x2279 /* 0-> use adapter setting, 1-> force */ 152 #define SG_GET_LOW_DMA 0x227a /* 0-> use all ram for dma; 1-> low dma ram */ 153 154 /* When SG_SET_FORCE_PACK_ID set to 1, pack_id is input to read() which 155 tries to fetch a packet with a matching pack_id, waits, or returns EAGAIN. 156 If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0 157 then pack_id ignored by read() and oldest readable fetched. */ 158 #define SG_SET_FORCE_PACK_ID 0x227b 159 #define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */ 160 161 #define SG_GET_NUM_WAITING 0x227d /* Number of commands awaiting read() */ 162 163 /* Yields max scatter gather tablesize allowed by current host adapter */ 164 #define SG_GET_SG_TABLESIZE 0x227F /* 0 implies can't do scatter gather */ 165 166 #define SG_GET_VERSION_NUM 0x2282 /* Example: version 2.1.34 yields 20134 */ 167 168 /* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */ 169 #define SG_SCSI_RESET 0x2284 170 /* Associated values that can be given to SG_SCSI_RESET follow */ 171 #define SG_SCSI_RESET_NOTHING 0 172 #define SG_SCSI_RESET_DEVICE 1 173 #define SG_SCSI_RESET_BUS 2 174 #define SG_SCSI_RESET_HOST 3 175 176 /* synchronous SCSI command ioctl, (only in version 3 interface) */ 177 #define SG_IO 0x2285 /* similar effect as write() followed by read() */ 178 179 #define SG_GET_REQUEST_TABLE 0x2286 /* yields table of active requests */ 180 181 /* How to treat EINTR during SG_IO ioctl(), only in SG 3.x series */ 182 #define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */ 183 #define SG_GET_KEEP_ORPHAN 0x2288 184 185 186 #define SG_SCATTER_SZ (8 * 4096) /* PAGE_SIZE not available to user */ 187 /* Largest size (in bytes) a single scatter-gather list element can have. 188 The value must be a power of 2 and <= (PAGE_SIZE * 32) [131072 bytes on 189 i386]. The minimum value is PAGE_SIZE. If scatter-gather not supported 190 by adapter then this value is the largest data block that can be 191 read/written by a single scsi command. The user can find the value of 192 PAGE_SIZE by calling getpagesize() defined in unistd.h . */ 193 194 #define SG_DEFAULT_RETRIES 1 195 196 /* Defaults, commented if they differ from original sg driver */ 197 #define SG_DEF_FORCE_LOW_DMA 0 /* was 1 -> memory below 16MB on i386 */ 198 #define SG_DEF_FORCE_PACK_ID 0 199 #define SG_DEF_KEEP_ORPHAN 0 200 #define SG_DEF_RESERVED_SIZE SG_SCATTER_SZ /* load time option */ 201 202 /* maximum outstanding requests, write() yields EDOM if exceeded */ 203 #define SG_MAX_QUEUE 16 204 205 #define SG_BIG_BUFF SG_DEF_RESERVED_SIZE /* for backward compatibility */ 206 207 /* Alternate style type names, "..._t" variants preferred */ 208 typedef struct sg_io_hdr Sg_io_hdr; 209 typedef struct sg_io_vec Sg_io_vec; 210 typedef struct sg_scsi_id Sg_scsi_id; 211 typedef struct sg_req_info Sg_req_info; 212 213 214 /* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv */ 215 /* The older SG interface based on the 'sg_header' structure follows. */ 216 /* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */ 217 218 #define SG_MAX_SENSE 16 /* this only applies to the sg_header interface */ 219 220 struct sg_header 221 { 222 /* Length of incoming packet (including header). */ 223 int pack_len; 224 /* Maximal length of expected reply. */ 225 int reply_len; 226 /* Id number of packet. */ 227 int pack_id; 228 /* 0==ok, otherwise error number. */ 229 int result; 230 /* Force 12 byte command length for group 6 & 7 commands. */ 231 unsigned int twelve_byte:1; 232 /* SCSI status from target. */ 233 unsigned int target_status:5; 234 /* Host status (see "DID" codes). */ 235 unsigned int host_status:8; 236 /* Driver status+suggestion. */ 237 unsigned int driver_status:8; 238 /* Unused. */ 239 unsigned int other_flags:10; 240 /* Output in 3 cases: 241 when target_status is CHECK_CONDITION or 242 when target_status is COMMAND_TERMINATED or 243 when (driver_status & DRIVER_SENSE) is true. */ 244 unsigned char sense_buffer[SG_MAX_SENSE]; 245 }; 246 247 248 /* IOCTLs: The following are not required (or ignored) when the sg_io_hdr_t 249 interface is used. They are kept for backward compatibility with 250 the original and version 2 drivers. */ 251 252 #define SG_SET_TIMEOUT 0x2201 /* Set timeout; *(int *)arg==timeout. */ 253 #define SG_GET_TIMEOUT 0x2202 /* Get timeout; return timeout. */ 254 255 /* Get/set command queuing state per fd (default is SG_DEF_COMMAND_Q). */ 256 #define SG_GET_COMMAND_Q 0x2270 /* Yields 0 (queuing off) or 1 (on). */ 257 #define SG_SET_COMMAND_Q 0x2271 /* Change queuing state with 0 or 1. */ 258 259 /* Turn on error sense trace (1..8), dump this device to log/console (9) 260 or dump all sg device states ( >9 ) to log/console. */ 261 #define SG_SET_DEBUG 0x227e /* 0 -> turn off debug */ 262 263 #define SG_NEXT_CMD_LEN 0x2283 /* Override SCSI command length with given 264 number on the next write() on this file 265 descriptor. */ 266 267 /* Defaults, commented if they differ from original sg driver */ 268 #define SG_DEFAULT_TIMEOUT (60*HZ) /* HZ == 'jiffies in 1 second' */ 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 274 #endif /* scsi/sg.h */ 275