11da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#ifndef _SCSI_GENERIC_H 21da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define _SCSI_GENERIC_H 31da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 41da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#include <linux/compiler.h> 51da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 61da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* 765c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * History: 865c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Started: Aug 9 by Lawrence Foard (entropy@world.std.com), to allow user 965c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * process control of SCSI devices. 1065c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Development Sponsored by Killy Corp. NY NY 1165c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * 1265c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Original driver (sg.h): 1365c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Copyright (C) 1992 Lawrence Foard 1465c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Version 2 and 3 extensions to driver: 1565c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Copyright (C) 1998 - 2014 Douglas Gilbert 1665c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * 1765c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Version: 3.5.36 (20140603) 1865c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * This version is for 2.6 and 3 series kernels. 1965c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * 2065c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Documentation 2165c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * ============= 2265c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * A web site for the SG device driver can be found at: 2365c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * http://sg.danny.cz/sg [alternatively check the MAINTAINERS file] 2465c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * The documentation for the sg version 3 driver can be found at: 2565c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * http://sg.danny.cz/sg/p/sg_v3_ho.html 2665c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * Also see: <kernel_source>/Documentation/scsi/scsi-generic.txt 2765c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * 2865c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert * For utility and test programs see: http://sg.danny.cz/sg/sg3_utils.html 2965c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert */ 301da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 3115485a4682d1d3bfee2aa78b4b1a5d36f5746b64Dave Young#ifdef __KERNEL__ 3215485a4682d1d3bfee2aa78b4b1a5d36f5746b64Dave Youngextern int sg_big_buff; /* for sysctl */ 3315485a4682d1d3bfee2aa78b4b1a5d36f5746b64Dave Young#endif 341da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 351da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 361da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_iovec /* same structure as used by readv() Linux system */ 371da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds{ /* call. It defines one scatter-gather element. */ 381da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds void __user *iov_base; /* Starting address */ 391da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds size_t iov_len; /* Length in bytes */ 401da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds} sg_iovec_t; 411da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 421da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 431da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_io_hdr 441da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds{ 451da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int interface_id; /* [i] 'S' for SCSI generic (required) */ 461da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int dxfer_direction; /* [i] data transfer direction */ 4765c26a0f39695ba01d9693754f27ca76cc8a3ab5Douglas Gilbert unsigned char cmd_len; /* [i] SCSI command length */ 481da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char mx_sb_len; /* [i] max length to write to sbp */ 491da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned short iovec_count; /* [i] 0 implies no scatter gather */ 501da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int dxfer_len; /* [i] byte count of data transfer */ 511da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds void __user *dxferp; /* [i], [*io] points to data transfer memory 521da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds or scatter gather list */ 531da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char __user *cmdp; /* [i], [*i] points to command to perform */ 541da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds void __user *sbp; /* [i], [*o] points to sense_buffer memory */ 551da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */ 561da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int flags; /* [i] 0 -> default, see SG_FLAG... */ 571da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int pack_id; /* [i->o] unused internally (normally) */ 581da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds void __user * usr_ptr; /* [i->o] unused internally */ 591da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char status; /* [o] scsi status */ 601da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char masked_status;/* [o] shifted, masked scsi status */ 611da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char msg_status; /* [o] messaging level data (optional) */ 621da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char sb_len_wr; /* [o] byte count actually written to sbp */ 631da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned short host_status; /* [o] errors from host adapter */ 641da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned short driver_status;/* [o] errors from software driver */ 651da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int resid; /* [o] dxfer_len - actual_transferred */ 661da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int duration; /* [o] time taken by cmd (unit: millisec) */ 671da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int info; /* [o] auxiliary information */ 681da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds} sg_io_hdr_t; /* 64 bytes long (on i386) */ 691da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 701da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INTERFACE_ID_ORIG 'S' 711da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 721da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Use negative values to flag difference from original sg_header structure */ 731da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DXFER_NONE (-1) /* e.g. a SCSI Test Unit Ready command */ 741da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DXFER_TO_DEV (-2) /* e.g. a SCSI WRITE command */ 751da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DXFER_FROM_DEV (-3) /* e.g. a SCSI READ command */ 761da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DXFER_TO_FROM_DEV (-4) /* treated like SG_DXFER_FROM_DEV with the 771da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds additional property than during indirect 781da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds IO the user buffer is copied into the 791da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds kernel buffers before the transfer */ 801da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DXFER_UNKNOWN (-5) /* Unknown data direction */ 811da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 821da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* following flag values can be "or"-ed together */ 831da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_FLAG_DIRECT_IO 1 /* default is indirect IO */ 841da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_FLAG_UNUSED_LUN_INHIBIT 2 /* default is overwrite lun in SCSI */ 851da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds /* command block (when <= SCSI_2) */ 861da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_FLAG_MMAP_IO 4 /* request memory mapped IO */ 871da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_FLAG_NO_DXFER 0x10000 /* no transfer of kernel buffers to/from */ 881da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds /* user space (debug indirect IO) */ 89d15156138dad40205c9fdd9abe85c9e1479ae272Douglas Gilbert/* defaults:: for sg driver: Q_AT_HEAD; for block layer: Q_AT_TAIL */ 90d15156138dad40205c9fdd9abe85c9e1479ae272Douglas Gilbert#define SG_FLAG_Q_AT_TAIL 0x10 91d15156138dad40205c9fdd9abe85c9e1479ae272Douglas Gilbert#define SG_FLAG_Q_AT_HEAD 0x20 921da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 931da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* following 'info' values are "or"-ed together */ 941da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_OK_MASK 0x1 951da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_OK 0x0 /* no sense, host nor driver "noise" */ 961da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_CHECK 0x1 /* something abnormal happened */ 971da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 981da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_DIRECT_IO_MASK 0x6 991da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_INDIRECT_IO 0x0 /* data xfer via kernel buffers (or no xfer) */ 1001da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_DIRECT_IO 0x2 /* direct IO requested and performed */ 1011da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_INFO_MIXED_IO 0x4 /* part direct, part indirect IO */ 1021da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1031da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1041da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_scsi_id { /* used by SG_GET_SCSI_ID ioctl() */ 1051da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int host_no; /* as in "scsi<n>" where 'n' is one of 0, 1, 2 etc */ 1061da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int channel; 1071da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int scsi_id; /* scsi id of target device */ 1081da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int lun; 1091da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int scsi_type; /* TYPE_... defined in scsi/scsi.h */ 1101da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds short h_cmd_per_lun;/* host (adapter) maximum commands per lun */ 1111da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds short d_queue_depth;/* device (or adapter) maximum queue length */ 1121da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int unused[2]; /* probably find a good use, set 0 for now */ 1131da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds} sg_scsi_id_t; /* 32 bytes long on i386 */ 1141da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1151da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_req_info { /* used by SG_GET_REQUEST_TABLE ioctl() */ 1161da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds char req_state; /* 0 -> not used, 1 -> written, 2 -> ready to read */ 1171da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds char orphan; /* 0 -> normal request, 1 -> from interruped SG_IO */ 1181da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds char sg_io_owned; /* 0 -> complete with read(), 1 -> owned by SG_IO */ 1191da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds char problem; /* 0 -> no problem detected, 1 -> error to report */ 1201da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int pack_id; /* pack_id associated with request */ 1211da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds void __user *usr_ptr; /* user provided pointer (in new interface) */ 1221da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int duration; /* millisecs elapsed since written (req_state==1) 1231da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds or request duration (req_state==2) */ 1241da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int unused; 1251da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds} sg_req_info_t; /* 20 bytes long on i386 */ 1261da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1271da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1281da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* IOCTLs: Those ioctls that are relevant to the SG 3.x drivers follow. 1291da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds [Those that only apply to the SG 2.x drivers are at the end of the file.] 1301da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds (_GET_s yield result via 'int *' 3rd argument unless otherwise indicated) */ 1311da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1321da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_EMULATED_HOST 0x2203 /* true for emulated host adapter (ATAPI) */ 1331da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1341da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Used to configure SCSI command transformation layer for ATAPI devices */ 1351da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Only supported by the ide-scsi driver */ 1361da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_TRANSFORM 0x2204 /* N.B. 3rd arg is not pointer but value: */ 1371da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds /* 3rd arg = 0 to disable transform, 1 to enable it */ 1381da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_TRANSFORM 0x2205 1391da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1401da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_RESERVED_SIZE 0x2275 /* request a new reserved buffer size */ 1411da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_RESERVED_SIZE 0x2272 /* actual size of reserved buffer */ 1421da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1431da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* The following ioctl has a 'sg_scsi_id_t *' object as its 3rd argument. */ 1441da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_SCSI_ID 0x2276 /* Yields fd's bus, chan, dev, lun + type */ 1451da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* SCSI id information can also be obtained from SCSI_IOCTL_GET_IDLUN */ 1461da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1471da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Override host setting and always DMA using low memory ( <16MB on i386) */ 1481da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_FORCE_LOW_DMA 0x2279 /* 0-> use adapter setting, 1-> force */ 1491da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_LOW_DMA 0x227a /* 0-> use all ram for dma; 1-> low dma ram */ 1501da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1511da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* When SG_SET_FORCE_PACK_ID set to 1, pack_id is input to read() which 1521da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds tries to fetch a packet with a matching pack_id, waits, or returns EAGAIN. 1531da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0 1541da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds then pack_id ignored by read() and oldest readable fetched. */ 1551da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_FORCE_PACK_ID 0x227b 1561da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */ 1571da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1581da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_NUM_WAITING 0x227d /* Number of commands awaiting read() */ 1591da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1601da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Yields max scatter gather tablesize allowed by current host adapter */ 1611da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_SG_TABLESIZE 0x227F /* 0 implies can't do scatter gather */ 1621da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1631da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_VERSION_NUM 0x2282 /* Example: version 2.1.34 yields 20134 */ 1641da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1651da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */ 1661da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SCSI_RESET 0x2284 1671da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Associated values that can be given to SG_SCSI_RESET follow */ 1681da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SCSI_RESET_NOTHING 0 1691da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SCSI_RESET_DEVICE 1 1701da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SCSI_RESET_BUS 2 1711da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SCSI_RESET_HOST 3 17239120e11705782c77d3a47d7d2927676fd8e3aaaBrian King#define SG_SCSI_RESET_TARGET 4 1731da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1741da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* synchronous SCSI command ioctl, (only in version 3 interface) */ 1751da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_IO 0x2285 /* similar effect as write() followed by read() */ 1761da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1771da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_REQUEST_TABLE 0x2286 /* yields table of active requests */ 1781da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1791da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* How to treat EINTR during SG_IO ioctl(), only in SG 3.x series */ 1801da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */ 1811da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_KEEP_ORPHAN 0x2288 1821da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1831da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* yields scsi midlevel's access_count for this SCSI device */ 1841da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_ACCESS_COUNT 0x2289 1851da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1861da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1876460e75a104d10458817d2f5b2fbff775bf0b43aDouglas Gilbert#define SG_SCATTER_SZ (8 * 4096) 1881da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Largest size (in bytes) a single scatter-gather list element can have. 1896460e75a104d10458817d2f5b2fbff775bf0b43aDouglas Gilbert The value used by the driver is 'max(SG_SCATTER_SZ, PAGE_SIZE)'. 1906460e75a104d10458817d2f5b2fbff775bf0b43aDouglas Gilbert This value should be a power of 2 (and may be rounded up internally). 1916460e75a104d10458817d2f5b2fbff775bf0b43aDouglas Gilbert If scatter-gather is not supported by adapter then this value is the 1926460e75a104d10458817d2f5b2fbff775bf0b43aDouglas Gilbert largest data block that can be read/written by a single scsi command. */ 1931da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1941da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEFAULT_RETRIES 0 1951da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 1961da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Defaults, commented if they differ from original sg driver */ 1971da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_FORCE_LOW_DMA 0 /* was 1 -> memory below 16MB on i386 */ 1981da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_FORCE_PACK_ID 0 1991da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_KEEP_ORPHAN 0 2001da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_RESERVED_SIZE SG_SCATTER_SZ /* load time option */ 2011da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2021da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* maximum outstanding requests, write() yields EDOM if exceeded */ 2031da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_MAX_QUEUE 16 2041da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2051da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_BIG_BUFF SG_DEF_RESERVED_SIZE /* for backward compatibility */ 2061da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2071da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Alternate style type names, "..._t" variants preferred */ 2081da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_io_hdr Sg_io_hdr; 2091da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_io_vec Sg_io_vec; 2101da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_scsi_id Sg_scsi_id; 2111da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldstypedef struct sg_req_info Sg_req_info; 2121da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2131da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2141da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv */ 2151da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* The older SG interface based on the 'sg_header' structure follows. */ 2161da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */ 2171da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2181da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_MAX_SENSE 16 /* this only applies to the sg_header interface */ 2191da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2201da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvaldsstruct sg_header 2211da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds{ 2221da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int pack_len; /* [o] reply_len (ie useless), ignored as input */ 2231da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int reply_len; /* [i] max length of expected reply (inc. sg_header) */ 2241da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int pack_id; /* [io] id number of packet (use ints >= 0) */ 2251da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds int result; /* [o] 0==ok, else (+ve) Unix errno (best ignored) */ 2261da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int twelve_byte:1; 2271da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds /* [i] Force 12 byte command length for group 6 & 7 commands */ 2281da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int target_status:5; /* [o] scsi status from target */ 2291da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int host_status:8; /* [o] host status (see "DID" codes) */ 2301da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int driver_status:8; /* [o] driver status+suggestion */ 2311da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned int other_flags:10; /* unused */ 2321da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds unsigned char sense_buffer[SG_MAX_SENSE]; /* [o] Output in 3 cases: 2331da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds when target_status is CHECK_CONDITION or 2341da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds when target_status is COMMAND_TERMINATED or 2351da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds when (driver_status & DRIVER_SENSE) is true. */ 2361da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds}; /* This structure is 36 bytes long on i386 */ 2371da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2381da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2391da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* IOCTLs: The following are not required (or ignored) when the sg_io_hdr_t 2401da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds interface is used. They are kept for backward compatibility with 2411da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds the original and version 2 drivers. */ 2421da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2431da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_TIMEOUT 0x2201 /* unit: jiffies (10ms on i386) */ 2441da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_TIMEOUT 0x2202 /* yield timeout as _return_ value */ 2451da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2461da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Get/set command queuing state per fd (default is SG_DEF_COMMAND_Q. 2471da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds Each time a sg_io_hdr_t object is seen on this file descriptor, this 2481da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds command queuing flag is set on (overriding the previous setting). */ 2491da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_GET_COMMAND_Q 0x2270 /* Yields 0 (queuing off) or 1 (on) */ 2501da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_COMMAND_Q 0x2271 /* Change queuing state with 0 or 1 */ 2511da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2521da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Turn on/off error sense trace (1 and 0 respectively, default is off). 2531da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds Try using: "# cat /proc/scsi/sg/debug" instead in the v3 driver */ 2541da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_SET_DEBUG 0x227e /* 0 -> turn off debug */ 2551da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2561da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_NEXT_CMD_LEN 0x2283 /* override SCSI command length with given 2571da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds number on the next write() on this file descriptor */ 2581da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2591da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2601da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds/* Defaults, commented if they differ from original sg driver */ 2611da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#ifdef __KERNEL__ 2621da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEFAULT_TIMEOUT_USER (60*USER_HZ) /* HZ == 'jiffies in 1 second' */ 2631da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#else 2641da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEFAULT_TIMEOUT (60*HZ) /* HZ == 'jiffies in 1 second' */ 2651da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#endif 2661da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2671da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_COMMAND_Q 0 /* command queuing is always on when 2681da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds the new interface is used */ 2691da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#define SG_DEF_UNDERRUN_FLAG 0 2701da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds 2711da177e4c3f41524e886b7f1b8a0c1fc7321cacLinus Torvalds#endif 272