include/scsi/sg.h

1 /* SPDX-License-Identifier: GPL-2.0 */
16  *	Copyright (C) 1998 - 2014 Douglas Gilbert
27  * Also see: <kernel_source>/Documentation/scsi/scsi-generic.rst
34 {                       /* call. It defines one scatter-gather element. */
46     unsigned short iovec_count; /* [i] 0 implies no scatter gather */
49 					      or scatter gather list */
52     unsigned int timeout;       /* [i] MAX_UINT->no timeout (unit: millisec) */
53     unsigned int flags;         /* [i] 0 -> default, see SG_FLAG... */
54     int pack_id;                /* [i->o] unused internally (normally) */
55     void __user * usr_ptr;      /* [i->o] unused internally */
62     int resid;                  /* [o] dxfer_len - actual_transferred */
75 	unsigned short iovec_count;	/* [i] 0 implies no scatter gather */
78 						or scatter gather list */
81 	compat_uint_t timeout;		/* [i] MAX_UINT->no timeout (unit: millisec) */
82 	compat_uint_t flags;		/* [i] 0 -> default, see SG_FLAG... */
83 	compat_int_t pack_id;		/* [i->o] unused internally (normally) */
84 	compat_uptr_t usr_ptr;		/* [i->o] unused internally */
91 	compat_int_t resid;		/* [o] dxfer_len - actual_transferred */
100 #define SG_DXFER_NONE (-1)      /* e.g. a SCSI Test Unit Ready command */
101 #define SG_DXFER_TO_DEV (-2)    /* e.g. a SCSI WRITE command */
102 #define SG_DXFER_FROM_DEV (-3)  /* e.g. a SCSI READ command */
103 #define SG_DXFER_TO_FROM_DEV (-4) /* treated like SG_DXFER_FROM_DEV with the
107 #define SG_DXFER_UNKNOWN (-5)   /* Unknown data direction */
109 /* following flag values can be "or"-ed together */
120 /* following 'info' values are "or"-ed together */
176     char req_state;     /* 0 -> not used, 1 -> written, 2 -> ready to read */
177     char orphan;        /* 0 -> normal request, 1 -> from interrupted SG_IO */
178     char sg_io_owned;   /* 0 -> complete with read(), 1 -> owned by SG_IO */
179     char problem;       /* 0 -> no problem detected, 1 -> error to report */
195 /* Only supported by the ide-scsi driver */
208 #define SG_SET_FORCE_LOW_DMA 0x2279  /* 0-> use adapter setting, 1-> force */
209 #define SG_GET_LOW_DMA 0x227a   /* 0-> use all ram for dma; 1-> low dma ram */
213    If pack_id is -1 then read oldest waiting. When ...FORCE_PACK_ID set to 0
216 #define SG_GET_PACK_ID 0x227c /* Yields oldest readable pack_id (or -1) */
220 /* Yields max scatter gather tablesize allowed by current host adapter */
221 #define SG_GET_SG_TABLESIZE 0x227F  /* 0 implies can't do scatter gather */
225 /* Returns -EBUSY if occupied. 3rd argument pointer to int (see next) */
228  * SG_SCSI_RESET_NO_ESCALATE may be OR-ed to the _DEVICE, _TARGET, _BUS
243 #define SG_SET_KEEP_ORPHAN 0x2287 /* 1 -> hold for read(), 0 -> drop (def) */
251 /* Largest size (in bytes) a single scatter-gather list element can have.
254    If scatter-gather is not supported by adapter then this value is the
316 #define SG_SET_DEBUG 0x227e    /* 0 -> turn off debug */