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