sg.h
sg.h
是 Linux 系统中用于定义和操作 SCSI Generic(SG)设备的头文件。SG 设备是一种特殊的设备接口,允许用户空间应用程序与 SCSI 设备进行直接通信,执行 SCSI 命令和数据传输。
这个头文件提供了在用户空间中与 SG 设备进行通信所需的数据结构、常量和函数声明。它通常用于编写应用程序,通过 SG 设备接口与 SCSI 设备交互。
以下是一些 sg.h
头文件中可能包含的内容:
-
宏定义:例如
SG_DXFER_NONE
、SG_DXFER_TO_DEV
、SG_DXFER_FROM_DEV
等,用于定义数据传输方向等参数。 -
数据结构:例如
sg_iovec_t
、sg_io_hdr_t
等,用于描述数据传输、SCSI 命令等参数。 -
常量定义:例如
SG_FLAG_DIRECT_IO
、SG_IO
等,用于标识 SG 设备操作的选项和标志。 -
函数声明:例如
ioctl
、open
、close
等函数,用于操作 SG 设备。
sg_iovec_t
是一个结构体,通常用于在 Linux 系统中的 scatter-gather I/O 操作中(如 readv()
函数)定义 scatter-gather 元素,用于传输数据。这个结构体在许多 I/O 操作中被广泛使用,其中 iov_base
指向内存中数据的起始地址,iov_len
指定了该元素中数据的长度(以字节为单位)。
具体来说,sg_iovec_t
的定义如下:
typedef struct sg_iovec {
void __user *iov_base; // 数据的起始地址
size_t iov_len; // 数据的长度(字节数)
} sg_iovec_t;
在 scatter-gather I/O 操作中,应用程序可以使用一个或多个 sg_iovec_t
元素来描述要传输的数据块。这些数据块可以是非连续的内存区域,系统内核会将这些数据块按照元素的顺序进行传输。
这种 scatter-gather 操作对于处理大量数据或需要在非连续内存区域进行数据传输的情况非常有用,它可以有效地减少数据复制和内存移动的开销。
请注意,上述代码片段中的 __user
是 Linux 内核中的一种标记,用于指示指针指向用户空间的内存区域。这有助于内核执行合适的内存访问检查,以确保操作不会引发未授权的内存访问。
typedef struct sg_io_hdr
{
int interface_id; /* [i] 'S' for SCSI generic (required) */
int dxfer_direction; /* [i] data transfer direction */
unsigned char cmd_len; /* [i] SCSI command length */
unsigned char mx_sb_len; /* [i] max length to write to sbp */
unsigned short iovec_count; /* [i] 0 implies no scatter gather */
unsigned int dxfer_len; /* [i] byte count of data transfer */
void __user *dxferp; /* [i], [*io] points to data transfer memory
or scatter gather list */
unsigned char __user *cmdp; /* [i], [*i] points to command to perform */
void __user *sbp; /* [i], [*o] points to sense_buffer memory */
unsigned int timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */
unsigned int flags; /* [i] 0 -> default, see SG_FLAG... */
int pack_id; /* [i->o] unused internally (normally) */
void __user * usr_ptr; /* [i->o] unused internally */
unsigned char status; /* [o] scsi status */
unsigned char masked_status;/* [o] shifted, masked scsi status */
unsigned char msg_status; /* [o] messaging level data (optional) */
unsigned char sb_len_wr; /* [o] byte count actually written to sbp */
unsigned short host_status; /* [o] errors from host adapter */
unsigned short driver_status;/* [o] errors from software driver */
int resid; /* [o] dxfer_len - actual_transferred */
unsigned int duration; /* [o] time taken by cmd (unit: millisec) */
unsigned int info; /* [o] auxiliary information */
} sg_io_hdr_t; /* 64 bytes long (on i386) */
sg_io_hdr_t
是用于与 SCSI 设备进行通信的数据结构,它包含了执行 SCSI I/O 操作时所需的各种参数和状态信息。这个结构体在进行 SCSI 命令的传输和数据交互时起到关键的作用。
下面是 sg_io_hdr_t
结构体的各个成员的说明:
-
interface_id
: 表示接口标识,通常设置为 ‘S’,表示 SCSI generic。 -
dxfer_direction
: 数据传输方向,可以是以下值之一:SG_DXFER_NONE
: 没有数据传输。SG_DXFER_TO_DEV
: 将数据从主机传输到设备。SG_DXFER_FROM_DEV
: 将数据从设备传输到主机。SG_DXFER_TO_FROM_DEV
: 双向数据传输。
-
cmd_len
: SCSI 命令的长度(字节数)。 -
mx_sb_len
: 可写入 sense_buffer(感知缓冲区)的最大长度。 -
iovec_count
: scatter-gather 元素的数量。0 表示没有 scatter-gather 操作。 -
dxfer_len
: 数据传输的总字节数。 -
dxferp
: 指向数据传输内存或 scatter-gather 列表的指针。 -
cmdp
: 指向要执行的 SCSI 命令的指针。 -
sbp
: 指向 sense_buffer 内存的指针,用于存储设备返回的感知数据。 -
timeout
: 操作的超时时间,单位为毫秒。MAX_UINT
表示没有超时限制。 -
flags
: 标志位,控制操作的一些行为。可以使用SG_FLAG...
常量。 -
pack_id
: 用于内部用途的包标识,通常不使用。 -
usr_ptr
: 内部用途的用户指针,通常不使用。 -
status
: SCSI 命令的状态。 -
masked_status
: 经过位移和掩码处理后的 SCSI 状态。 -
msg_status
: 消息级别的数据(可选)。 -
sb_len_wr
: 实际写入到 sense_buffer 的字节数。 -
host_status
: 主机适配器返回的错误状态。 -
driver_status
: 软件驱动程序返回的错误状态。 -
resid
: 实际传输的字节数与预期传输的字节数之间的差值。 -
duration
: 命令执行的时间,单位为毫秒。 -
info
: 附加信息。
这个结构体用于描述 SCSI 命令和数据传输的参数,是在进行 SCSI I/O 操作时与设备进行通信的重要工具。在 Linux 等操作系统中,这个结构体通常作为参数传递给底层的 SCSI I/O 接口函数,用于执行 SCSI 命令和数据传输。
struct compat_sg_io_hdr {
compat_int_t interface_id; /* [i] 'S' for SCSI generic (required) */
compat_int_t dxfer_direction; /* [i] data transfer direction */
unsigned char cmd_len; /* [i] SCSI command length ( <= 16 bytes) */
unsigned char mx_sb_len; /* [i] max length to write to sbp */
unsigned short iovec_count; /* [i] 0 implies no scatter gather */
compat_uint_t dxfer_len; /* [i] byte count of data transfer */
compat_uint_t dxferp; /* [i], [*io] points to data transfer memory
or scatter gather list */
compat_uptr_t cmdp; /* [i], [*i] points to command to perform */
compat_uptr_t sbp; /* [i], [*o] points to sense_buffer memory */
compat_uint_t timeout; /* [i] MAX_UINT->no timeout (unit: millisec) */
compat_uint_t flags; /* [i] 0 -> default, see SG_FLAG... */
compat_int_t pack_id; /* [i->o] unused internally (normally) */
compat_uptr_t usr_ptr; /* [i->o] unused internally */
unsigned char status; /* [o] scsi status */
unsigned char masked_status; /* [o] shifted, masked scsi status */
unsigned char msg_status; /* [o] messaging level data (optional) */
unsigned char sb_len_wr; /* [o] byte count actually written to sbp */
unsigned short host_status; /* [o] errors from host adapter */
unsigned short driver_status; /* [o] errors from software driver */
compat_int_t resid; /* [o] dxfer_len - actual_transferred */
compat_uint_t duration; /* [o] time taken by cmd (unit: millisec) */
compat_uint_t info; /* [o] auxiliary information */
};
这段代码定义了一个兼容性结构体 compat_sg_io_hdr
,用于在 32位系统上与 64位系统之间传递 SCSI I/O 请求的头部信息。这种兼容性结构体的设计是为了在不同位数的系统之间保持数据传输的一致性。
这个结构体的定义与之前提供的 sg_io_hdr_t
结构体非常相似,但是为了在 32位系统上保持与 64位系统的对应,使用了 compat
类型来确保数据在不同位数的系统上正确对齐和传递。
这些兼容性数据类型(如 compat_int_t
、compat_uint_t
、compat_uptr_t
等)通常用于处理 32位和 64位系统之间的数据传递和对齐问题,以确保不同系统之间的二进制兼容性。
总之,这段代码定义了一个适用于 32位系统的 compat_sg_io_hdr
结构体,用于在不同位数的系统之间传递 SCSI I/O 请求的头部信息。
#define SG_INTERFACE_ID_ORIG 'S'
/* Use negative values to flag difference from original sg_header structure */
#define SG_DXFER_NONE (-1) /* e.g. a SCSI Test Unit Ready command */
#define SG_DXFER_TO_DEV (-2) /* e.g. a SCSI WRITE command */
#define SG_DXFER_FROM_DEV (-3) /* e.g. a SCSI READ command */
#define SG_DXFER_TO_FROM_DEV (-4) /* treated like SG_DXFER_FROM_DEV with the
additional property than during indirect
IO the user buffer is copied into the
kernel buffers before the transfer */
#define SG_DXFER_UNKNOWN (-5) /* Unknown data direction */
/* following flag values can be "or"-ed together */
#define SG_FLAG_DIRECT_IO 1 /* default is indirect IO */
#define SG_FLAG_UNUSED_LUN_INHIBIT 2 /* default is overwrite lun in SCSI */
/* command block (when <= SCSI_2) */
#define SG_FLAG_MMAP_IO 4 /* request memory mapped IO */
#define SG_FLAG_NO_DXFER 0x10000 /* no transfer of kernel buffers to/from */
/* user space (debug indirect IO) */
/* defaults:: for sg driver: Q_AT_HEAD; for block layer: Q_AT_TAIL */
#define SG_FLAG_Q_AT_TAIL 0x10
#define SG_FLAG_Q_AT_HEAD 0x20
/* following 'info' values are "or"-ed together */
#define SG_INFO_OK_MASK 0x1
#define SG_INFO_OK 0x0 /* no sense, host nor driver "noise" */
#define SG_INFO_CHECK 0x1 /* something abnormal happened */
#define SG_INFO_DIRECT_IO_MASK 0x6
#define SG_INFO_INDIRECT_IO 0x0 /* data xfer via kernel buffers (or no xfer) */
#define SG_INFO_DIRECT_IO 0x2 /* direct IO requested and performed */
#define SG_INFO_MIXED_IO 0x4 /* part direct, part indirect IO */
这段代码中定义了一些常量和标志,用于设置和描述 SCSI I/O 请求的不同参数和状态。以下是每个定义的解释:
-
SG_INTERFACE_ID_ORIG
: 这是一个用于识别 SCSI 接口的标志。在这里,‘S’ 用于表示原始的 SCSI 接口。 -
SG_DXFER_NONE
: 表示没有数据传输,例如 SCSI 的 Test Unit Ready 命令。 -
SG_DXFER_TO_DEV
: 表示数据传输方向是从主机到设备,例如 SCSI 的 WRITE 命令。 -
SG_DXFER_FROM_DEV
: 表示数据传输方向是从设备到主机,例如 SCSI 的 READ 命令。 -
SG_DXFER_TO_FROM_DEV
: 类似于SG_DXFER_FROM_DEV
,但在进行间接 I/O 时,用户缓冲区会在传输之前复制到内核缓冲区。 -
SG_DXFER_UNKNOWN
: 表示数据传输方向未知。 -
SG_FLAG_DIRECT_IO
: 表示进行直接 I/O,而不是间接 I/O。 -
SG_FLAG_UNUSED_LUN_INHIBIT
: 当 SCSI 命令块中的逻辑单元号 (LUN) 未使用时,不覆盖它。默认情况下,会在 SCSI_2 之前覆盖。 -
SG_FLAG_MMAP_IO
: 请求进行内存映射 I/O。 -
SG_FLAG_NO_DXFER
: 在内核缓冲区和用户空间之间不进行数据传输。 -
SG_FLAG_Q_AT_TAIL
和SG_FLAG_Q_AT_HEAD
: 指定请求队列(Q_AT_TAIL 表示在队列尾部,Q_AT_HEAD 表示在队列头部)。 -
SG_INFO_OK_MASK
、SG_INFO_OK
、SG_INFO_CHECK
: 用于描述 SCSI 请求的信息状态。SG_INFO_OK_MASK
是一个位掩码,SG_INFO_OK
表示没有感知、主机或驱动程序的异常情况,SG_INFO_CHECK
表示发生了异常。 -
SG_INFO_DIRECT_IO_MASK
、SG_INFO_INDIRECT_IO
、SG_INFO_DIRECT_IO
、SG_INFO_MIXED_IO
: 描述数据传输的方式,如通过内核缓冲区进行间接 I/O、直接 I/O 或混合 I/O。
这些常量和标志用于指定 SCSI I/O 请求的不同属性,以及描述传输的方向和状态。在进行 SCSI I/O 操作时,可以使用这些值来配置和识别请求的属性。
/*
* Obsolete DRIVER_SENSE driver byte
*
* Originally the SCSI midlayer would set the DRIVER_SENSE driver byte when
* a sense code was generated and a sense buffer was allocated.
* However, as nowadays every scsi command has a sense code allocated this
* distinction became moot as one could check the sense buffer directly.
* Consequently this byte is not set anymore from the midlayer, but SG will
* keep setting this byte to be compatible with previous releases.
*/
#define DRIVER_SENSE 0x08
/* Obsolete driver_byte() declaration */
#define driver_byte(result) (((result) >> 24) & 0xff)
/*
* Original linux SCSI Status codes. They are shifted 1 bit right
* from those found in the SCSI standards.
*/
#define GOOD 0x00
#define CHECK_CONDITION 0x01
#define CONDITION_GOOD 0x02
#define BUSY 0x04
#define INTERMEDIATE_GOOD 0x08
#define INTERMEDIATE_C_GOOD 0x0a
#define RESERVATION_CONFLICT 0x0c
#define COMMAND_TERMINATED 0x11
#define QUEUE_FULL 0x14
#define ACA_ACTIVE 0x18
#define TASK_ABORTED 0x20
/* Obsolete status_byte() declaration */
#define sg_status_byte(result) (((result) >> 1) & 0x7f)
这段代码包含了一些与 SCSI 相关的定义和常量,让我们一一解释:
-
DRIVER_SENSE
:这是一个过时的驱动程序字节。在早期的 SCSI 中间层版本中,当生成一个 sense code 并分配一个 sense buffer 时,SCSI 中间层会设置DRIVER_SENSE
驱动程序字节。然而,由于现在每个 SCSI 命令都有一个分配的 sense code,这个区分已经不再重要,因为可以直接检查 sense buffer。尽管如此,SG 仍然会继续设置这个字节,以保持与先前版本的兼容性。 -
driver_byte(result)
:这是一个宏,用于从结果中提取驱动程序字节。result
是一个整数结果,通过右移 24 位和按位与运算获取驱动程序字节的值。
接下来是一些原始的 Linux SCSI 状态代码,它们与标准中的状态代码相比,都向右移了 1 位:
-
GOOD
:操作成功完成。 -
CHECK_CONDITION
:检查条件,表示发生错误,需要读取 sense buffer 获取详细信息。 -
CONDITION_GOOD
:在检查条件下操作成功。 -
BUSY
:设备忙。 -
INTERMEDIATE_GOOD
:中间状态下操作成功。 -
INTERMEDIATE_C_GOOD
:中间状态下在检查条件下操作成功。 -
RESERVATION_CONFLICT
:保留冲突。 -
COMMAND_TERMINATED
:命令终止。 -
QUEUE_FULL
:队列已满。 -
ACA_ACTIVE
:自动控制激活。 -
TASK_ABORTED
:任务被中止。 -
sg_status_byte(result)
:这是一个宏,用于从结果中提取状态字节。result
是一个整数结果,通过右移 1 位和按位与运算获取状态字节的值。
这些定义和常量是与 SCSI 操作和状态相关的,在编程中用于解释和处理 SCSI 操作的结果和状态。
typedef struct sg_scsi_id { /* used by SG_GET_SCSI_ID ioctl() */
int host_no; /* as in "scsi<n>" where 'n' is one of 0, 1, 2 etc */
int channel;
int scsi_id; /* scsi id of target device */
int lun;
int scsi_type; /* TYPE_... defined in scsi/scsi.h */
short h_cmd_per_lun;/* host (adapter) maximum commands per lun */
short d_queue_depth;/* device (or adapter) maximum queue length */
int unused[2]; /* probably find a good use, set 0 for now */
} sg_scsi_id_t; /* 32 bytes long on i386 */
这段代码定义了一个名为 sg_scsi_id
的结构,用于在执行 SG_GET_SCSI_ID
ioctl 命令时获取 SCSI 设备的标识信息。以下是每个字段的解释:
-
host_no
: 主机编号,类似于 “scsi” 中的<n>
,其中<n>
是 0、1、2 等。 -
channel
: 通道号,表示 SCSI 设备所在的通道。 -
scsi_id
: SCSI 设备的标识号。 -
lun
: 逻辑单元号 (LUN),用于指定 SCSI 设备的特定逻辑单元。 -
scsi_type
: SCSI 设备类型,取值为TYPE_...
,定义在scsi/scsi.h
中。 -
h_cmd_per_lun
: 主机(适配器)每个逻辑单元的最大命令数。 -
d_queue_depth
: 设备(或适配器)的最大队列长度。 -
unused[2]
: 保留字段,暂时没有使用,可以留作将来扩展。
这个结构用于获取 SCSI 设备的标识信息,包括主机编号、通道、SCSI ID、LUN、设备类型以及主机和设备的队列深度等信息。通过执行 SG_GET_SCSI_ID
ioctl 命令,可以将这些信息从内核传递到用户空间。
typedef struct sg_req_info { /* used by SG_GET_REQUEST_TABLE ioctl() */
char req_state; /* 0 -> not used, 1 -> written, 2 -> ready to read */
char orphan; /* 0 -> normal request, 1 -> from interrupted SG_IO */
char sg_io_owned; /* 0 -> complete with read(), 1 -> owned by SG_IO */
char problem; /* 0 -> no problem detected, 1 -> error to report */
int pack_id; /* pack_id associated with request */
void __user *usr_ptr; /* user provided pointer (in new interface) */
unsigned int duration; /* millisecs elapsed since written (req_state==1)
or request duration (req_state==2) */
int unused;
} sg_req_info_t; /* 20 bytes long on i386 */
这段代码描述了 sg_req_info
结构,该结构用于 SG_GET_REQUEST_TABLE
ioctl 操作。这个结构包含了有关 SG 请求的信息,让我们逐个解释每个字段:
-
req_state
:请求状态。取值为 0、1 或 2,表示请求的状态。0 表示未使用,1 表示已写入(即已创建),2 表示准备好读取。 -
orphan
:孤立标志。取值为 0 或 1。0 表示正常请求,1 表示来自被中断的 SG_IO 请求。 -
sg_io_owned
:SG_IO 所有权标志。取值为 0 或 1。0 表示已使用 read() 完成,1 表示由 SG_IO 拥有。 -
problem
:问题标志。取值为 0 或 1。0 表示未检测到问题,1 表示要报告错误。 -
pack_id
:与请求关联的 pack_id。 -
usr_ptr
:用户提供的指针,用于新接口中。 -
duration
:已经过的毫秒数,从写入请求(当req_state
为 1 时)或请求的持续时间(当req_state
为 2 时)开始计算。 -
unused
:未使用字段。
这个结构主要用于提供关于 SG 请求的额外信息,以便在需要的情况下进行诊断和处理。
/* IOCTLs: Those ioctls that are relevant to the SG 3.x drivers follow.
[Those that only apply to the SG 2.x drivers are at the end of the file.]
(_GET_s yield result via 'int *' 3rd argument unless otherwise indicated) */
#define SG_EMULATED_HOST 0x2203 /* true for emulated host adapter (ATAPI) */
/* Used to configure SCSI command transformation layer for ATAPI devices */
/* Only supported by the ide-scsi driver */
#define SG_SET_TRANSFORM 0x2204 /* N.B. 3rd arg is not pointer but value: */
/* 3rd arg = 0 to disable transform, 1 to enable it */
#define SG_GET_TRANSFORM 0x2205
#define SG_SET_RESERVED_SIZE 0x2275 /* request a new reserved buffer size */
#define SG_GET_RESERVED_SIZE 0x2272 /* actual size of reserved buffer */
/* The following ioctl has a 'sg_scsi_id_t *' object as its 3rd argument. */
#define SG_GET_SCSI_ID 0x2276 /* Yields fd's bus, chan, dev, lun + type */
/* SCSI id information can also be obtained from SCSI_IOCTL_GET_IDLUN */
/* Override host setting and always DMA using low memory ( <16MB on i386) */
#define SG_SET_FORCE_LOW_DMA 0x2279 /* 0-> use adapter setting, 1-> force */
#define SG_GET_LOW_DMA 0x227a /* 0-> use all ram for dma; 1-> low dma ram */
/* When SG_SET_FORCE_PACK_ID set to 1, pack_id is input to read() which
tries to fetch a packet with a matching pack_id, waits, or returns EAGAIN.
If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0
then pack_id ignored by read() and oldest readable fetched. */
#define SG_SET_FORCE_PACK_ID 0x227b
#define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */
#define SG_GET_NUM_WAITING 0x227d /* Number of commands awaiting read() */
/* Yields max scatter gather tablesize allowed by current host adapter */
#define SG_GET_SG_TABLESIZE 0x227F /* 0 implies can't do scatter gather */
#define SG_GET_VERSION_NUM 0x2282 /* Example: version 2.1.34 yields 20134 */
/* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */
#define SG_SCSI_RESET 0x2284
/* Associated values that can be given to SG_SCSI_RESET follow.
* SG_SCSI_RESET_NO_ESCALATE may be OR-ed to the _DEVICE, _TARGET, _BUS
* or _HOST reset value so only that action is attempted. */
#define SG_SCSI_RESET_NOTHING 0
#define SG_SCSI_RESET_DEVICE 1
#define SG_SCSI_RESET_BUS 2
#define SG_SCSI_RESET_HOST 3
#define SG_SCSI_RESET_TARGET 4
#define SG_SCSI_RESET_NO_ESCALATE 0x100
/* synchronous SCSI command ioctl, (only in version 3 interface) */
#define SG_IO 0x2285 /* similar effect as write() followed by read() */
#define SG_GET_REQUEST_TABLE 0x2286 /* yields table of active requests */
/* How to treat EINTR during SG_IO ioctl(), only in SG 3.x series */
#define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */
#define SG_GET_KEEP_ORPHAN 0x2288
/* yields scsi midlevel's access_count for this SCSI device */
#define SG_GET_ACCESS_COUNT 0x2289
#define SG_SCATTER_SZ (8 * 4096)
/* Largest size (in bytes) a single scatter-gather list element can have.
The value used by the driver is 'max(SG_SCATTER_SZ, PAGE_SIZE)'.
This value should be a power of 2 (and may be rounded up internally).
If scatter-gather is not supported by adapter then this value is the
largest data block that can be read/written by a single scsi command. */
#define SG_DEFAULT_RETRIES 0
/* Defaults, commented if they differ from original sg driver */
#define SG_DEF_FORCE_PACK_ID 0
#define SG_DEF_KEEP_ORPHAN 0
#define SG_DEF_RESERVED_SIZE SG_SCATTER_SZ /* load time option */
/* maximum outstanding requests, write() yields EDOM if exceeded */
#define SG_MAX_QUEUE 16
#define SG_BIG_BUFF SG_DEF_RESERVED_SIZE /* for backward compatibility */
**上述代码中列出了一些 SG 驱动的 ioctl 命令以及它们的描述。让我解释一下其中一些常见的 ioctl 命令:
-
SG_SET_TRANSFORM
:用于配置 ATAPI 设备的 SCSI 命令转换层。只有 ide-scsi 驱动支持。第三个参数是一个值,0 表示禁用转换,1 表示启用它。 -
SG_GET_TRANSFORM
:获取当前转换层的状态。 -
SG_SET_RESERVED_SIZE
:请求设置保留缓冲区的新大小。 -
SG_GET_RESERVED_SIZE
:获取实际保留缓冲区的大小。 -
SG_GET_SCSI_ID
:获取与文件描述符关联的 SCSI 设备的详细信息,例如总线号、通道号、设备号、逻辑单元号和设备类型。 -
SG_SET_FORCE_LOW_DMA
:覆盖主机设置,始终使用低内存进行 DMA 操作。 -
SG_GET_LOW_DMA
:获取当前是否启用低内存 DMA。 -
SG_SET_FORCE_PACK_ID
:设置是否强制指定包 ID。 -
SG_GET_PACK_ID
:获取最旧可读的包 ID。 -
SG_GET_NUM_WAITING
:获取等待读取的命令数量。 -
SG_GET_SG_TABLESIZE
:获取当前主机适配器允许的最大分散收集表大小。 -
SG_SCSI_RESET
:执行 SCSI 复位操作,可以选择设备、总线、主机、目标等。 -
SG_IO
:同步 SCSI 命令 ioctl,类似于 write() 后面跟着 read()。 -
SG_GET_REQUEST_TABLE
:获取活动请求的表。 -
SG_SET_KEEP_ORPHAN
:设置在 SG_IO ioctl() 期间如何处理 EINTR。 -
SG_GET_KEEP_ORPHAN
:获取当前在 SG_IO ioctl() 期间如何处理 EINTR。 -
SG_GET_ACCESS_COUNT
:获取此 SCSI 设备的 SCSI 中层访问计数。
还有其他的一些 ioctl 命令用于配置和管理 SCSI 通信和设备。这些 ioctl 命令允许用户与底层的 SCSI 驱动进行交互,并进行各种配置和控制操作。**
/* Alternate style type names, "..._t" variants preferred */
typedef struct sg_io_hdr Sg_io_hdr;
typedef struct sg_io_vec Sg_io_vec;
typedef struct sg_scsi_id Sg_scsi_id;
typedef struct sg_req_info Sg_req_info;
这段代码定义了一些类型别名,以更方便地使用这些结构体类型:
-
Sg_io_hdr
是struct sg_io_hdr
的别名,用于简化代码中对这个结构体的引用。 -
Sg_io_vec
是struct sg_io_vec
的别名,用于简化代码中对这个结构体的引用。 -
Sg_scsi_id
是struct sg_scsi_id
的别名,用于简化代码中对这个结构体的引用。 -
Sg_req_info
是struct sg_req_info
的别名,用于简化代码中对这个结构体的引用。
通过定义这些类型别名,可以使代码更加清晰和易读,同时减少了冗长的类型名称的使用。
/* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv */
/* The older SG interface based on the 'sg_header' structure follows. */
/* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */
#define SG_MAX_SENSE 16 /* this only applies to the sg_header interface */
struct sg_header
{
int pack_len; /* [o] reply_len (ie useless), ignored as input */
int reply_len; /* [i] max length of expected reply (inc. sg_header) */
int pack_id; /* [io] id number of packet (use ints >= 0) */
int result; /* [o] 0==ok, else (+ve) Unix errno (best ignored) */
unsigned int twelve_byte:1;
/* [i] Force 12 byte command length for group 6 & 7 commands */
unsigned int target_status:5; /* [o] scsi status from target */
unsigned int host_status:8; /* [o] host status (see "DID" codes) */
unsigned int driver_status:8; /* [o] driver status+suggestion */
unsigned int other_flags:10; /* unused */
unsigned char sense_buffer[SG_MAX_SENSE]; /* [o] Output in 3 cases:
when target_status is CHECK_CONDITION or
when target_status is COMMAND_TERMINATED or
when (driver_status & DRIVER_SENSE) is true. */
}; /* This structure is 36 bytes long on i386 */
/* IOCTLs: The following are not required (or ignored) when the sg_io_hdr_t
interface is used. They are kept for backward compatibility with
the original and version 2 drivers. */
#define SG_SET_TIMEOUT 0x2201 /* unit: jiffies (10ms on i386) */
#define SG_GET_TIMEOUT 0x2202 /* yield timeout as _return_ value */
/* Get/set command queuing state per fd (default is SG_DEF_COMMAND_Q.
Each time a sg_io_hdr_t object is seen on this file descriptor, this
command queuing flag is set on (overriding the previous setting). */
#define SG_GET_COMMAND_Q 0x2270 /* Yields 0 (queuing off) or 1 (on) */
#define SG_SET_COMMAND_Q 0x2271 /* Change queuing state with 0 or 1 */
/* Turn on/off error sense trace (1 and 0 respectively, default is off).
Try using: "# cat /proc/scsi/sg/debug" instead in the v3 driver */
#define SG_SET_DEBUG 0x227e /* 0 -> turn off debug */
#define SG_NEXT_CMD_LEN 0x2283 /* override SCSI command length with given
number on the next write() on this file descriptor */
/* Defaults, commented if they differ from original sg driver */
#ifdef __KERNEL__
#define SG_DEFAULT_TIMEOUT_USER (60*USER_HZ) /* HZ == 'jiffies in 1 second' */
#else
#define SG_DEFAULT_TIMEOUT (60*HZ) /* HZ == 'jiffies in 1 second' */
#endif
#define SG_DEF_COMMAND_Q 0 /* command queuing is always on when
the new interface is used */
#define SG_DEF_UNDERRUN_FLAG 0
这段代码定义了一些与旧版的 SG 接口有关的内容,这个旧版 SG 接口是基于 struct sg_header
结构体的。下面是相关的内容:
-
SG_MAX_SENSE
定义了最大的感知缓冲区大小,这个值只在使用旧版 SG 接口的时候有效。 -
struct sg_header
描述了旧版 SG 接口中的头部结构。这个结构包含了一些控制和状态信息,如响应长度、包 ID、结果、目标状态、主机状态、驱动程序状态、以及感知缓冲区。在 i386 架构上,这个结构体的大小是 36 字节。 -
接下来是一系列与 IOCTL 相关的常量,这些 IOCTL 主要是与旧版的 SG 接口相关的。例如,
SG_SET_TIMEOUT
和SG_GET_TIMEOUT
用于设置和获取超时值,SG_GET_COMMAND_Q
和SG_SET_COMMAND_Q
用于获取和设置命令队列状态,SG_SET_DEBUG
用于开启或关闭错误感知跟踪等。 -
最后是一些默认值的定义,例如超时时间、命令队列状态等。
这些内容与旧版的 SG 接口有关,而在新版的 SG 接口中,使用了 struct sg_io_hdr
等更高级的结构体来提供更强大和灵活的接口。