1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 21da177e4SLinus Torvalds #ifndef _SCSI_GENERIC_H 31da177e4SLinus Torvalds #define _SCSI_GENERIC_H 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds #include <linux/compiler.h> 61da177e4SLinus Torvalds 71da177e4SLinus Torvalds /* 865c26a0fSDouglas Gilbert * History: 965c26a0fSDouglas Gilbert * Started: Aug 9 by Lawrence Foard (entropy@world.std.com), to allow user 1065c26a0fSDouglas Gilbert * process control of SCSI devices. 1165c26a0fSDouglas Gilbert * Development Sponsored by Killy Corp. NY NY 1265c26a0fSDouglas Gilbert * 1365c26a0fSDouglas Gilbert * Original driver (sg.h): 141da177e4SLinus Torvalds * Copyright (C) 1992 Lawrence Foard 1565c26a0fSDouglas Gilbert * Version 2 and 3 extensions to driver: 1665c26a0fSDouglas Gilbert * Copyright (C) 1998 - 2014 Douglas Gilbert 1765c26a0fSDouglas Gilbert * 1865c26a0fSDouglas Gilbert * Version: 3.5.36 (20140603) 1965c26a0fSDouglas Gilbert * This version is for 2.6 and 3 series kernels. 2065c26a0fSDouglas Gilbert * 2165c26a0fSDouglas Gilbert * Documentation 2265c26a0fSDouglas Gilbert * ============= 2365c26a0fSDouglas Gilbert * A web site for the SG device driver can be found at: 2465c26a0fSDouglas Gilbert * http://sg.danny.cz/sg [alternatively check the MAINTAINERS file] 2565c26a0fSDouglas Gilbert * The documentation for the sg version 3 driver can be found at: 2665c26a0fSDouglas Gilbert * http://sg.danny.cz/sg/p/sg_v3_ho.html 27d4d79340SMauro Carvalho Chehab * Also see: <kernel_source>/Documentation/scsi/scsi-generic.rst 2865c26a0fSDouglas Gilbert * 2965c26a0fSDouglas Gilbert * For utility and test programs see: http://sg.danny.cz/sg/sg3_utils.html 301da177e4SLinus Torvalds */ 311da177e4SLinus Torvalds 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds typedef struct sg_iovec /* same structure as used by readv() Linux system */ 341da177e4SLinus Torvalds { /* call. It defines one scatter-gather element. */ 351da177e4SLinus Torvalds void __user *iov_base; /* Starting address */ 361da177e4SLinus Torvalds size_t iov_len; /* Length in bytes */ 371da177e4SLinus Torvalds } sg_iovec_t; 381da177e4SLinus Torvalds 391da177e4SLinus Torvalds 401da177e4SLinus Torvalds typedef struct sg_io_hdr 411da177e4SLinus Torvalds { 421da177e4SLinus Torvalds int interface_id; /* [i] 'S' for SCSI generic (required) */ 431da177e4SLinus Torvalds int dxfer_direction; /* [i] data transfer direction */ 4465c26a0fSDouglas Gilbert unsigned char cmd_len; /* [i] SCSI command length */ 451da177e4SLinus Torvalds unsigned char mx_sb_len; /* [i] max length to write to sbp */ 461da177e4SLinus Torvalds unsigned short iovec_count; /* [i] 0 implies no scatter gather */ 471da177e4SLinus Torvalds unsigned int dxfer_len; /* [i] byte count of data transfer */ 481da177e4SLinus Torvalds void __user *dxferp; /* [i], [*io] points to data transfer memory 491da177e4SLinus Torvalds or scatter gather list */ 501da177e4SLinus Torvalds unsigned char __user *cmdp; /* [i], [*i] points to command to perform */ 511da177e4SLinus Torvalds void __user *sbp; /* [i], [*o] points to sense_buffer memory */ 521da177e4SLinus Torvalds unsigned int timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */ 531da177e4SLinus Torvalds unsigned int flags; /* [i] 0 -> default, see SG_FLAG... */ 541da177e4SLinus Torvalds int pack_id; /* [i->o] unused internally (normally) */ 551da177e4SLinus Torvalds void __user * usr_ptr; /* [i->o] unused internally */ 561da177e4SLinus Torvalds unsigned char status; /* [o] scsi status */ 571da177e4SLinus Torvalds unsigned char masked_status;/* [o] shifted, masked scsi status */ 581da177e4SLinus Torvalds unsigned char msg_status; /* [o] messaging level data (optional) */ 591da177e4SLinus Torvalds unsigned char sb_len_wr; /* [o] byte count actually written to sbp */ 601da177e4SLinus Torvalds unsigned short host_status; /* [o] errors from host adapter */ 611da177e4SLinus Torvalds unsigned short driver_status;/* [o] errors from software driver */ 621da177e4SLinus Torvalds int resid; /* [o] dxfer_len - actual_transferred */ 631da177e4SLinus Torvalds unsigned int duration; /* [o] time taken by cmd (unit: millisec) */ 641da177e4SLinus Torvalds unsigned int info; /* [o] auxiliary information */ 651da177e4SLinus Torvalds } sg_io_hdr_t; /* 64 bytes long (on i386) */ 661da177e4SLinus Torvalds 6778ed001dSArnd Bergmann #if defined(__KERNEL__) 6878ed001dSArnd Bergmann #include <linux/compat.h> 6978ed001dSArnd Bergmann 7078ed001dSArnd Bergmann struct compat_sg_io_hdr { 7178ed001dSArnd Bergmann compat_int_t interface_id; /* [i] 'S' for SCSI generic (required) */ 7278ed001dSArnd Bergmann compat_int_t dxfer_direction; /* [i] data transfer direction */ 7378ed001dSArnd Bergmann unsigned char cmd_len; /* [i] SCSI command length ( <= 16 bytes) */ 7478ed001dSArnd Bergmann unsigned char mx_sb_len; /* [i] max length to write to sbp */ 7578ed001dSArnd Bergmann unsigned short iovec_count; /* [i] 0 implies no scatter gather */ 7678ed001dSArnd Bergmann compat_uint_t dxfer_len; /* [i] byte count of data transfer */ 7778ed001dSArnd Bergmann compat_uint_t dxferp; /* [i], [*io] points to data transfer memory 7878ed001dSArnd Bergmann or scatter gather list */ 7978ed001dSArnd Bergmann compat_uptr_t cmdp; /* [i], [*i] points to command to perform */ 8078ed001dSArnd Bergmann compat_uptr_t sbp; /* [i], [*o] points to sense_buffer memory */ 8178ed001dSArnd Bergmann compat_uint_t timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */ 8278ed001dSArnd Bergmann compat_uint_t flags; /* [i] 0 -> default, see SG_FLAG... */ 8378ed001dSArnd Bergmann compat_int_t pack_id; /* [i->o] unused internally (normally) */ 8478ed001dSArnd Bergmann compat_uptr_t usr_ptr; /* [i->o] unused internally */ 8578ed001dSArnd Bergmann unsigned char status; /* [o] scsi status */ 8678ed001dSArnd Bergmann unsigned char masked_status; /* [o] shifted, masked scsi status */ 8778ed001dSArnd Bergmann unsigned char msg_status; /* [o] messaging level data (optional) */ 8878ed001dSArnd Bergmann unsigned char sb_len_wr; /* [o] byte count actually written to sbp */ 8978ed001dSArnd Bergmann unsigned short host_status; /* [o] errors from host adapter */ 9078ed001dSArnd Bergmann unsigned short driver_status; /* [o] errors from software driver */ 9178ed001dSArnd Bergmann compat_int_t resid; /* [o] dxfer_len - actual_transferred */ 9278ed001dSArnd Bergmann compat_uint_t duration; /* [o] time taken by cmd (unit: millisec) */ 9378ed001dSArnd Bergmann compat_uint_t info; /* [o] auxiliary information */ 9478ed001dSArnd Bergmann }; 9578ed001dSArnd Bergmann #endif 9678ed001dSArnd Bergmann 971da177e4SLinus Torvalds #define SG_INTERFACE_ID_ORIG 'S' 981da177e4SLinus Torvalds 991da177e4SLinus Torvalds /* Use negative values to flag difference from original sg_header structure */ 1001da177e4SLinus Torvalds #define SG_DXFER_NONE (-1) /* e.g. a SCSI Test Unit Ready command */ 1011da177e4SLinus Torvalds #define SG_DXFER_TO_DEV (-2) /* e.g. a SCSI WRITE command */ 1021da177e4SLinus Torvalds #define SG_DXFER_FROM_DEV (-3) /* e.g. a SCSI READ command */ 1031da177e4SLinus Torvalds #define SG_DXFER_TO_FROM_DEV (-4) /* treated like SG_DXFER_FROM_DEV with the 1041da177e4SLinus Torvalds additional property than during indirect 1051da177e4SLinus Torvalds IO the user buffer is copied into the 1061da177e4SLinus Torvalds kernel buffers before the transfer */ 1071da177e4SLinus Torvalds #define SG_DXFER_UNKNOWN (-5) /* Unknown data direction */ 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds /* following flag values can be "or"-ed together */ 1101da177e4SLinus Torvalds #define SG_FLAG_DIRECT_IO 1 /* default is indirect IO */ 1111da177e4SLinus Torvalds #define SG_FLAG_UNUSED_LUN_INHIBIT 2 /* default is overwrite lun in SCSI */ 1121da177e4SLinus Torvalds /* command block (when <= SCSI_2) */ 1131da177e4SLinus Torvalds #define SG_FLAG_MMAP_IO 4 /* request memory mapped IO */ 1141da177e4SLinus Torvalds #define SG_FLAG_NO_DXFER 0x10000 /* no transfer of kernel buffers to/from */ 1151da177e4SLinus Torvalds /* user space (debug indirect IO) */ 116d1515613SDouglas Gilbert /* defaults:: for sg driver: Q_AT_HEAD; for block layer: Q_AT_TAIL */ 117d1515613SDouglas Gilbert #define SG_FLAG_Q_AT_TAIL 0x10 118d1515613SDouglas Gilbert #define SG_FLAG_Q_AT_HEAD 0x20 1191da177e4SLinus Torvalds 1201da177e4SLinus Torvalds /* following 'info' values are "or"-ed together */ 1211da177e4SLinus Torvalds #define SG_INFO_OK_MASK 0x1 1221da177e4SLinus Torvalds #define SG_INFO_OK 0x0 /* no sense, host nor driver "noise" */ 1231da177e4SLinus Torvalds #define SG_INFO_CHECK 0x1 /* something abnormal happened */ 1241da177e4SLinus Torvalds 1251da177e4SLinus Torvalds #define SG_INFO_DIRECT_IO_MASK 0x6 1261da177e4SLinus Torvalds #define SG_INFO_INDIRECT_IO 0x0 /* data xfer via kernel buffers (or no xfer) */ 1271da177e4SLinus Torvalds #define SG_INFO_DIRECT_IO 0x2 /* direct IO requested and performed */ 1281da177e4SLinus Torvalds #define SG_INFO_MIXED_IO 0x4 /* part direct, part indirect IO */ 1291da177e4SLinus Torvalds 130464a00c9SHannes Reinecke /* 131464a00c9SHannes Reinecke * Obsolete DRIVER_SENSE driver byte 132464a00c9SHannes Reinecke * 133464a00c9SHannes Reinecke * Originally the SCSI midlayer would set the DRIVER_SENSE driver byte when 134464a00c9SHannes Reinecke * a sense code was generated and a sense buffer was allocated. 135464a00c9SHannes Reinecke * However, as nowadays every scsi command has a sense code allocated this 136464a00c9SHannes Reinecke * distinction became moot as one could check the sense buffer directly. 137464a00c9SHannes Reinecke * Consequently this byte is not set anymore from the midlayer, but SG will 138464a00c9SHannes Reinecke * keep setting this byte to be compatible with previous releases. 139464a00c9SHannes Reinecke */ 140464a00c9SHannes Reinecke #define DRIVER_SENSE 0x08 14154c29086SHannes Reinecke /* Obsolete driver_byte() declaration */ 14254c29086SHannes Reinecke #define driver_byte(result) (((result) >> 24) & 0xff) 1431da177e4SLinus Torvalds 1443d45cefcSHannes Reinecke /* 1453d45cefcSHannes Reinecke * Original linux SCSI Status codes. They are shifted 1 bit right 1463d45cefcSHannes Reinecke * from those found in the SCSI standards. 1473d45cefcSHannes Reinecke */ 1483d45cefcSHannes Reinecke 1493d45cefcSHannes Reinecke #define GOOD 0x00 1503d45cefcSHannes Reinecke #define CHECK_CONDITION 0x01 1513d45cefcSHannes Reinecke #define CONDITION_GOOD 0x02 1523d45cefcSHannes Reinecke #define BUSY 0x04 1533d45cefcSHannes Reinecke #define INTERMEDIATE_GOOD 0x08 1543d45cefcSHannes Reinecke #define INTERMEDIATE_C_GOOD 0x0a 1553d45cefcSHannes Reinecke #define RESERVATION_CONFLICT 0x0c 1563d45cefcSHannes Reinecke #define COMMAND_TERMINATED 0x11 1573d45cefcSHannes Reinecke #define QUEUE_FULL 0x14 1583d45cefcSHannes Reinecke #define ACA_ACTIVE 0x18 1593d45cefcSHannes Reinecke #define TASK_ABORTED 0x20 1603d45cefcSHannes Reinecke 1613d45cefcSHannes Reinecke /* Obsolete status_byte() declaration */ 162*c9293c11SMike Christie #define sg_status_byte(result) (((result) >> 1) & 0x7f) 1633d45cefcSHannes Reinecke 1641da177e4SLinus Torvalds typedef struct sg_scsi_id { /* used by SG_GET_SCSI_ID ioctl() */ 1651da177e4SLinus Torvalds int host_no; /* as in "scsi<n>" where 'n' is one of 0, 1, 2 etc */ 1661da177e4SLinus Torvalds int channel; 1671da177e4SLinus Torvalds int scsi_id; /* scsi id of target device */ 1681da177e4SLinus Torvalds int lun; 1691da177e4SLinus Torvalds int scsi_type; /* TYPE_... defined in scsi/scsi.h */ 1701da177e4SLinus Torvalds short h_cmd_per_lun;/* host (adapter) maximum commands per lun */ 1711da177e4SLinus Torvalds short d_queue_depth;/* device (or adapter) maximum queue length */ 1721da177e4SLinus Torvalds int unused[2]; /* probably find a good use, set 0 for now */ 1731da177e4SLinus Torvalds } sg_scsi_id_t; /* 32 bytes long on i386 */ 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds typedef struct sg_req_info { /* used by SG_GET_REQUEST_TABLE ioctl() */ 1761da177e4SLinus Torvalds char req_state; /* 0 -> not used, 1 -> written, 2 -> ready to read */ 17740d6b939SZhen Lei char orphan; /* 0 -> normal request, 1 -> from interrupted SG_IO */ 1781da177e4SLinus Torvalds char sg_io_owned; /* 0 -> complete with read(), 1 -> owned by SG_IO */ 1791da177e4SLinus Torvalds char problem; /* 0 -> no problem detected, 1 -> error to report */ 1801da177e4SLinus Torvalds int pack_id; /* pack_id associated with request */ 1811da177e4SLinus Torvalds void __user *usr_ptr; /* user provided pointer (in new interface) */ 1821da177e4SLinus Torvalds unsigned int duration; /* millisecs elapsed since written (req_state==1) 1831da177e4SLinus Torvalds or request duration (req_state==2) */ 1841da177e4SLinus Torvalds int unused; 1851da177e4SLinus Torvalds } sg_req_info_t; /* 20 bytes long on i386 */ 1861da177e4SLinus Torvalds 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds /* IOCTLs: Those ioctls that are relevant to the SG 3.x drivers follow. 1891da177e4SLinus Torvalds [Those that only apply to the SG 2.x drivers are at the end of the file.] 1901da177e4SLinus Torvalds (_GET_s yield result via 'int *' 3rd argument unless otherwise indicated) */ 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds #define SG_EMULATED_HOST 0x2203 /* true for emulated host adapter (ATAPI) */ 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds /* Used to configure SCSI command transformation layer for ATAPI devices */ 1951da177e4SLinus Torvalds /* Only supported by the ide-scsi driver */ 1961da177e4SLinus Torvalds #define SG_SET_TRANSFORM 0x2204 /* N.B. 3rd arg is not pointer but value: */ 1971da177e4SLinus Torvalds /* 3rd arg = 0 to disable transform, 1 to enable it */ 1981da177e4SLinus Torvalds #define SG_GET_TRANSFORM 0x2205 1991da177e4SLinus Torvalds 2001da177e4SLinus Torvalds #define SG_SET_RESERVED_SIZE 0x2275 /* request a new reserved buffer size */ 2011da177e4SLinus Torvalds #define SG_GET_RESERVED_SIZE 0x2272 /* actual size of reserved buffer */ 2021da177e4SLinus Torvalds 2031da177e4SLinus Torvalds /* The following ioctl has a 'sg_scsi_id_t *' object as its 3rd argument. */ 2041da177e4SLinus Torvalds #define SG_GET_SCSI_ID 0x2276 /* Yields fd's bus, chan, dev, lun + type */ 2051da177e4SLinus Torvalds /* SCSI id information can also be obtained from SCSI_IOCTL_GET_IDLUN */ 2061da177e4SLinus Torvalds 2071da177e4SLinus Torvalds /* Override host setting and always DMA using low memory ( <16MB on i386) */ 2081da177e4SLinus Torvalds #define SG_SET_FORCE_LOW_DMA 0x2279 /* 0-> use adapter setting, 1-> force */ 2091da177e4SLinus Torvalds #define SG_GET_LOW_DMA 0x227a /* 0-> use all ram for dma; 1-> low dma ram */ 2101da177e4SLinus Torvalds 2111da177e4SLinus Torvalds /* When SG_SET_FORCE_PACK_ID set to 1, pack_id is input to read() which 2121da177e4SLinus Torvalds tries to fetch a packet with a matching pack_id, waits, or returns EAGAIN. 2131da177e4SLinus Torvalds If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0 2141da177e4SLinus Torvalds then pack_id ignored by read() and oldest readable fetched. */ 2151da177e4SLinus Torvalds #define SG_SET_FORCE_PACK_ID 0x227b 2161da177e4SLinus Torvalds #define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */ 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds #define SG_GET_NUM_WAITING 0x227d /* Number of commands awaiting read() */ 2191da177e4SLinus Torvalds 2201da177e4SLinus Torvalds /* Yields max scatter gather tablesize allowed by current host adapter */ 2211da177e4SLinus Torvalds #define SG_GET_SG_TABLESIZE 0x227F /* 0 implies can't do scatter gather */ 2221da177e4SLinus Torvalds 2231da177e4SLinus Torvalds #define SG_GET_VERSION_NUM 0x2282 /* Example: version 2.1.34 yields 20134 */ 2241da177e4SLinus Torvalds 2251da177e4SLinus Torvalds /* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */ 2261da177e4SLinus Torvalds #define SG_SCSI_RESET 0x2284 22726cf591eSDouglas Gilbert /* Associated values that can be given to SG_SCSI_RESET follow. 22826cf591eSDouglas Gilbert * SG_SCSI_RESET_NO_ESCALATE may be OR-ed to the _DEVICE, _TARGET, _BUS 22926cf591eSDouglas Gilbert * or _HOST reset value so only that action is attempted. */ 2301da177e4SLinus Torvalds #define SG_SCSI_RESET_NOTHING 0 2311da177e4SLinus Torvalds #define SG_SCSI_RESET_DEVICE 1 2321da177e4SLinus Torvalds #define SG_SCSI_RESET_BUS 2 2331da177e4SLinus Torvalds #define SG_SCSI_RESET_HOST 3 23439120e11SBrian King #define SG_SCSI_RESET_TARGET 4 23526cf591eSDouglas Gilbert #define SG_SCSI_RESET_NO_ESCALATE 0x100 2361da177e4SLinus Torvalds 2371da177e4SLinus Torvalds /* synchronous SCSI command ioctl, (only in version 3 interface) */ 2381da177e4SLinus Torvalds #define SG_IO 0x2285 /* similar effect as write() followed by read() */ 2391da177e4SLinus Torvalds 2401da177e4SLinus Torvalds #define SG_GET_REQUEST_TABLE 0x2286 /* yields table of active requests */ 2411da177e4SLinus Torvalds 2421da177e4SLinus Torvalds /* How to treat EINTR during SG_IO ioctl(), only in SG 3.x series */ 2431da177e4SLinus Torvalds #define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */ 2441da177e4SLinus Torvalds #define SG_GET_KEEP_ORPHAN 0x2288 2451da177e4SLinus Torvalds 2461da177e4SLinus Torvalds /* yields scsi midlevel's access_count for this SCSI device */ 2471da177e4SLinus Torvalds #define SG_GET_ACCESS_COUNT 0x2289 2481da177e4SLinus Torvalds 2491da177e4SLinus Torvalds 2506460e75aSDouglas Gilbert #define SG_SCATTER_SZ (8 * 4096) 2511da177e4SLinus Torvalds /* Largest size (in bytes) a single scatter-gather list element can have. 2526460e75aSDouglas Gilbert The value used by the driver is 'max(SG_SCATTER_SZ, PAGE_SIZE)'. 2536460e75aSDouglas Gilbert This value should be a power of 2 (and may be rounded up internally). 2546460e75aSDouglas Gilbert If scatter-gather is not supported by adapter then this value is the 2556460e75aSDouglas Gilbert largest data block that can be read/written by a single scsi command. */ 2561da177e4SLinus Torvalds 2571da177e4SLinus Torvalds #define SG_DEFAULT_RETRIES 0 2581da177e4SLinus Torvalds 2591da177e4SLinus Torvalds /* Defaults, commented if they differ from original sg driver */ 2601da177e4SLinus Torvalds #define SG_DEF_FORCE_PACK_ID 0 2611da177e4SLinus Torvalds #define SG_DEF_KEEP_ORPHAN 0 2621da177e4SLinus Torvalds #define SG_DEF_RESERVED_SIZE SG_SCATTER_SZ /* load time option */ 2631da177e4SLinus Torvalds 2641da177e4SLinus Torvalds /* maximum outstanding requests, write() yields EDOM if exceeded */ 2651da177e4SLinus Torvalds #define SG_MAX_QUEUE 16 2661da177e4SLinus Torvalds 2671da177e4SLinus Torvalds #define SG_BIG_BUFF SG_DEF_RESERVED_SIZE /* for backward compatibility */ 2681da177e4SLinus Torvalds 2691da177e4SLinus Torvalds /* Alternate style type names, "..._t" variants preferred */ 2701da177e4SLinus Torvalds typedef struct sg_io_hdr Sg_io_hdr; 2711da177e4SLinus Torvalds typedef struct sg_io_vec Sg_io_vec; 2721da177e4SLinus Torvalds typedef struct sg_scsi_id Sg_scsi_id; 2731da177e4SLinus Torvalds typedef struct sg_req_info Sg_req_info; 2741da177e4SLinus Torvalds 2751da177e4SLinus Torvalds 2761da177e4SLinus Torvalds /* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv */ 2771da177e4SLinus Torvalds /* The older SG interface based on the 'sg_header' structure follows. */ 2781da177e4SLinus Torvalds /* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */ 2791da177e4SLinus Torvalds 2801da177e4SLinus Torvalds #define SG_MAX_SENSE 16 /* this only applies to the sg_header interface */ 2811da177e4SLinus Torvalds 2821da177e4SLinus Torvalds struct sg_header 2831da177e4SLinus Torvalds { 2841da177e4SLinus Torvalds int pack_len; /* [o] reply_len (ie useless), ignored as input */ 2851da177e4SLinus Torvalds int reply_len; /* [i] max length of expected reply (inc. sg_header) */ 2861da177e4SLinus Torvalds int pack_id; /* [io] id number of packet (use ints >= 0) */ 2871da177e4SLinus Torvalds int result; /* [o] 0==ok, else (+ve) Unix errno (best ignored) */ 2881da177e4SLinus Torvalds unsigned int twelve_byte:1; 2891da177e4SLinus Torvalds /* [i] Force 12 byte command length for group 6 & 7 commands */ 2901da177e4SLinus Torvalds unsigned int target_status:5; /* [o] scsi status from target */ 2911da177e4SLinus Torvalds unsigned int host_status:8; /* [o] host status (see "DID" codes) */ 2921da177e4SLinus Torvalds unsigned int driver_status:8; /* [o] driver status+suggestion */ 2931da177e4SLinus Torvalds unsigned int other_flags:10; /* unused */ 2941da177e4SLinus Torvalds unsigned char sense_buffer[SG_MAX_SENSE]; /* [o] Output in 3 cases: 2951da177e4SLinus Torvalds when target_status is CHECK_CONDITION or 2961da177e4SLinus Torvalds when target_status is COMMAND_TERMINATED or 2971da177e4SLinus Torvalds when (driver_status & DRIVER_SENSE) is true. */ 2981da177e4SLinus Torvalds }; /* This structure is 36 bytes long on i386 */ 2991da177e4SLinus Torvalds 3001da177e4SLinus Torvalds 3011da177e4SLinus Torvalds /* IOCTLs: The following are not required (or ignored) when the sg_io_hdr_t 3021da177e4SLinus Torvalds interface is used. They are kept for backward compatibility with 3031da177e4SLinus Torvalds the original and version 2 drivers. */ 3041da177e4SLinus Torvalds 3051da177e4SLinus Torvalds #define SG_SET_TIMEOUT 0x2201 /* unit: jiffies (10ms on i386) */ 3061da177e4SLinus Torvalds #define SG_GET_TIMEOUT 0x2202 /* yield timeout as _return_ value */ 3071da177e4SLinus Torvalds 3081da177e4SLinus Torvalds /* Get/set command queuing state per fd (default is SG_DEF_COMMAND_Q. 3091da177e4SLinus Torvalds Each time a sg_io_hdr_t object is seen on this file descriptor, this 3101da177e4SLinus Torvalds command queuing flag is set on (overriding the previous setting). */ 3111da177e4SLinus Torvalds #define SG_GET_COMMAND_Q 0x2270 /* Yields 0 (queuing off) or 1 (on) */ 3121da177e4SLinus Torvalds #define SG_SET_COMMAND_Q 0x2271 /* Change queuing state with 0 or 1 */ 3131da177e4SLinus Torvalds 3141da177e4SLinus Torvalds /* Turn on/off error sense trace (1 and 0 respectively, default is off). 3151da177e4SLinus Torvalds Try using: "# cat /proc/scsi/sg/debug" instead in the v3 driver */ 3161da177e4SLinus Torvalds #define SG_SET_DEBUG 0x227e /* 0 -> turn off debug */ 3171da177e4SLinus Torvalds 3181da177e4SLinus Torvalds #define SG_NEXT_CMD_LEN 0x2283 /* override SCSI command length with given 3191da177e4SLinus Torvalds number on the next write() on this file descriptor */ 3201da177e4SLinus Torvalds 3211da177e4SLinus Torvalds 3221da177e4SLinus Torvalds /* Defaults, commented if they differ from original sg driver */ 3231da177e4SLinus Torvalds #ifdef __KERNEL__ 3241da177e4SLinus Torvalds #define SG_DEFAULT_TIMEOUT_USER (60*USER_HZ) /* HZ == 'jiffies in 1 second' */ 3251da177e4SLinus Torvalds #else 3261da177e4SLinus Torvalds #define SG_DEFAULT_TIMEOUT (60*HZ) /* HZ == 'jiffies in 1 second' */ 3271da177e4SLinus Torvalds #endif 3281da177e4SLinus Torvalds 3291da177e4SLinus Torvalds #define SG_DEF_COMMAND_Q 0 /* command queuing is always on when 3301da177e4SLinus Torvalds the new interface is used */ 3311da177e4SLinus Torvalds #define SG_DEF_UNDERRUN_FLAG 0 3321da177e4SLinus Torvalds 3331da177e4SLinus Torvalds #endif 334