d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
08537f4526
freebsd-skq/sys/cam/scsi/scsi_sg.h

170 lines
4.1 KiB
C
Raw Normal View History

Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
/*
* Structures and definitions for SCSI commands to the SG passthrough device.
*
* $FreeBSD$
*/
#ifndef _SCSI_SG_H
#define _SCSI_SG_H
#define SGIOC '"'
Overhaul CAM SG driver IOCTL interfaces. Make it really work for native FreeBSD programs. Before this it was broken for years due to different number of pointer dereferences in Linux and FreeBSD IOCTL paths, permanently returning errors to FreeBSD programs. This change breaks the driver FreeBSD IOCTL ABI, making it more strict, but since it was not working any way -- who bother. Add shims for 32-bit programs on 64-bit host, translating the argument of the SG_IO IOCTL for both FreeBSD and Linux ABIs. With this change I was able to run 32-bit Linux sg3_utils tools and simple 32 and 64-bit FreeBSD test tools on both 32 and 64-bit FreeBSD systems. MFC after: 1 month
2014-06-02 19:53:53 +00:00
#define SG_SET_TIMEOUT _IOW(SGIOC, 0x01, u_int)
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
#define SG_GET_TIMEOUT _IO(SGIOC, 0x02)
Overhaul CAM SG driver IOCTL interfaces. Make it really work for native FreeBSD programs. Before this it was broken for years due to different number of pointer dereferences in Linux and FreeBSD IOCTL paths, permanently returning errors to FreeBSD programs. This change breaks the driver FreeBSD IOCTL ABI, making it more strict, but since it was not working any way -- who bother. Add shims for 32-bit programs on 64-bit host, translating the argument of the SG_IO IOCTL for both FreeBSD and Linux ABIs. With this change I was able to run 32-bit Linux sg3_utils tools and simple 32 and 64-bit FreeBSD test tools on both 32 and 64-bit FreeBSD systems. MFC after: 1 month
2014-06-02 19:53:53 +00:00
#define SG_EMULATED_HOST _IOR(SGIOC, 0x03, int)
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
#define SG_SET_TRANSFORM _IO(SGIOC, 0x04)
#define SG_GET_TRANSFORM _IO(SGIOC, 0x05)
Overhaul CAM SG driver IOCTL interfaces. Make it really work for native FreeBSD programs. Before this it was broken for years due to different number of pointer dereferences in Linux and FreeBSD IOCTL paths, permanently returning errors to FreeBSD programs. This change breaks the driver FreeBSD IOCTL ABI, making it more strict, but since it was not working any way -- who bother. Add shims for 32-bit programs on 64-bit host, translating the argument of the SG_IO IOCTL for both FreeBSD and Linux ABIs. With this change I was able to run 32-bit Linux sg3_utils tools and simple 32 and 64-bit FreeBSD test tools on both 32 and 64-bit FreeBSD systems. MFC after: 1 month
2014-06-02 19:53:53 +00:00
#define SG_GET_COMMAND_Q _IOW(SGIOC, 0x70, int)
#define SG_SET_COMMAND_Q _IOR(SGIOC, 0x71, int)
#define SG_GET_RESERVED_SIZE _IOR(SGIOC, 0x72, int)
#define SG_SET_RESERVED_SIZE _IOW(SGIOC, 0x75, int)
#define SG_GET_SCSI_ID _IOR(SGIOC, 0x76, struct sg_scsi_id)
#define SG_SET_FORCE_LOW_DMA _IOW(SGIOC, 0x79, int)
#define SG_GET_LOW_DMA _IOR(SGIOC, 0x7a, int)
#define SG_SET_FORCE_PACK_ID _IOW(SGIOC, 0x7b, int)
#define SG_GET_PACK_ID _IOR(SGIOC, 0x7c, int)
#define SG_GET_NUM_WAITING _IOR(SGIOC, 0x7d, int)
#define SG_SET_DEBUG _IOW(SGIOC, 0x7e, int)
#define SG_GET_SG_TABLESIZE _IOR(SGIOC, 0x7f, int)
#define SG_GET_VERSION_NUM _IOR(SGIOC, 0x82, int)
#define SG_NEXT_CMD_LEN _IOW(SGIOC, 0x83, int)
#define SG_SCSI_RESET _IOW(SGIOC, 0x84, int)
#define SG_IO _IOWR(SGIOC, 0x85, struct sg_io_hdr)
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
#define SG_GET_REQUEST_TABLE _IO(SGIOC, 0x86)
Overhaul CAM SG driver IOCTL interfaces. Make it really work for native FreeBSD programs. Before this it was broken for years due to different number of pointer dereferences in Linux and FreeBSD IOCTL paths, permanently returning errors to FreeBSD programs. This change breaks the driver FreeBSD IOCTL ABI, making it more strict, but since it was not working any way -- who bother. Add shims for 32-bit programs on 64-bit host, translating the argument of the SG_IO IOCTL for both FreeBSD and Linux ABIs. With this change I was able to run 32-bit Linux sg3_utils tools and simple 32 and 64-bit FreeBSD test tools on both 32 and 64-bit FreeBSD systems. MFC after: 1 month
2014-06-02 19:53:53 +00:00
#define SG_SET_KEEP_ORPHAN _IOW(SGIOC, 0x87, int)
#define SG_GET_KEEP_ORPHAN _IOR(SGIOC, 0x88, int)
#define SG_GET_ACCESS_COUNT _IOR(SGIOC, 0x89, int)
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
struct sg_io_hdr {
int interface_id;
int dxfer_direction;
u_char cmd_len;
u_char mx_sb_len;
u_short iovec_count;
u_int dxfer_len;
void *dxferp;
u_char *cmdp;
u_char *sbp;
u_int timeout;
u_int flags;
int pack_id;
void *usr_ptr;
u_char status;
u_char masked_status;
u_char msg_status;
Overhaul CAM SG driver IOCTL interfaces. Make it really work for native FreeBSD programs. Before this it was broken for years due to different number of pointer dereferences in Linux and FreeBSD IOCTL paths, permanently returning errors to FreeBSD programs. This change breaks the driver FreeBSD IOCTL ABI, making it more strict, but since it was not working any way -- who bother. Add shims for 32-bit programs on 64-bit host, translating the argument of the SG_IO IOCTL for both FreeBSD and Linux ABIs. With this change I was able to run 32-bit Linux sg3_utils tools and simple 32 and 64-bit FreeBSD test tools on both 32 and 64-bit FreeBSD systems. MFC after: 1 month
2014-06-02 19:53:53 +00:00
u_char sb_len_wr;
u_short host_status;
u_short driver_status;
int resid;
u_int duration;
u_int info;
};
struct sg_io_hdr32 {
int interface_id;
int dxfer_direction;
u_char cmd_len;
u_char mx_sb_len;
u_short iovec_count;
u_int dxfer_len;
uint32_t dxferp;
uint32_t cmdp;
uint32_t sbp;
u_int timeout;
u_int flags;
int pack_id;
uint32_t usr_ptr;
u_char status;
u_char masked_status;
u_char msg_status;
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
u_char sb_len_wr;
u_short host_status;
u_short driver_status;
int resid;
u_int duration;
u_int info;
};
#define SG_DXFER_NONE -1
#define SG_DXFER_TO_DEV -2
#define SG_DXFER_FROM_DEV -3
#define SG_DXFER_TO_FROM_DEV -4
#define SG_DXFER_UNKNOWN -5
#define SG_MAX_SENSE 16
struct sg_header {
int pack_len;
int reply_len;
int pack_id;
int result;
u_int twelve_byte:1;
u_int target_status:5;
u_int host_status:8;
u_int driver_status:8;
u_int other_flags:10;
u_char sense_buffer[SG_MAX_SENSE];
};
struct sg_scsi_id {
int host_no;
int channel;
int scsi_id;
int lun;
int scsi_type;
short h_cmd_per_lun;
short d_queue_depth;
int unused[2];
};
struct scsi_idlun {
uint32_t dev_id;
uint32_t host_unique_id;
};
/*
* Host codes
*/
#define DID_OK 0x00 /* OK */
#define DID_NO_CONNECT 0x01 /* timeout during connect */
#define DID_BUS_BUSY 0x02 /* timeout during command */
#define DID_TIME_OUT 0x03 /* other timeout */
#define DID_BAD_TARGET 0x04 /* bad target */
#define DID_ABORT 0x05 /* abort */
#define DID_PARITY 0x06 /* parity error */
#define DID_ERROR 0x07 /* internal error */
#define DID_RESET 0x08 /* reset by somebody */
#define DID_BAD_INTR 0x09 /* unexpected interrupt */
#define DID_PASSTHROUGH 0x0a /* passthrough */
#define DID_SOFT_ERROR 0x0b /* low driver wants retry */
#define DID_IMM_RETRY 0x0c /* retry without decreasing retrycnt */
/*
* Driver codes
*/
#define DRIVER_OK 0x00
#define DRIVER_BUSY 0x01
#define DRIVER_SOFT 0x02
#define DRIVER_MEDIA 0x03
#define DRIVER_ERROR 0x04
#define DRIVER_INVALID 0x05
#define DRIVER_TIMEOUT 0x06
#define DRIVER_HARD 0x07
#define DRIVER_SENSE 0x08
#define SUGGEST_RETRY 0x10
#define SUGGEST_ABORT 0x20
#define SUGGEST_REMAP 0x30
#define SUGGEST_DIE 0x40
#define SUGGEST_SENSE 0x80
#define SUGGEST_IS_OK 0xff
#define DRIVER_MASK 0x0f
#define SUGGEST_MASK 0xf0
A fix for the SG_GET_TIMEOUT function slipped into a previous commit by accident. Remove the text describing the problem as it is no longer relevant. Also give real implementations for the GET and SET ioctls.
2007-04-10 20:03:42 +00:00
/* Other definitions */
/* HZ isn't always available, so simulate it */
#define SG_DEFAULT_HZ 1000
#define SG_DEFAULT_TIMEOUT (60*SG_DEFAULT_HZ)
Add the CAM 'SG' peripheral device. This device implements a subset of the Linux SCSI SG passthrough device API. The intention is to allow for both running of Linux apps that want to talk to /dev/sg* nodes, and to facilitate porting of apps from Linux to FreeBSD. As such, both native and linuxolator entry points and definitions are provided. Caveats: - This does not support the procfs and sysfs nodes that the Linux SG driver provides. Some Linux apps may rely on these for operation, others may only use them for informational purposes. - More ioctls need to be implemented. - Linux uses a naming scheme of "sg[a-z]" for devices, while FreeBSD uses a scheme of "sg[0-9]". Devfs aliasis (symlinks) are automatically created to link the two together. However, tools like camcontrol only see the native names. - Some operations were originally designed to return byte counts or other data directly as the syscall return value. The linuxolator doesn't appear to support this well, so this driver just punts for these cases. Now that the driver is in place, others are welcome to add missing functionality. Thanks to Roman Divacky for pushing this work along.
2007-04-07 19:40:58 +00:00
#endif /* !_SCSI_SG_H */
Reference in New Issue Copy Permalink