blob: cd6302def5ed720acec704bd811194f3254848a9 [file] [log] [blame]
Christopher Ferris25981132017-11-14 16:53:49 -08001/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
Ben Cheng30692c62013-10-15 18:26:18 -07002#ifndef _UAPIBSG_H
3#define _UAPIBSG_H
4
5#include <linux/types.h>
6
7#define BSG_PROTOCOL_SCSI 0
8
9#define BSG_SUB_PROTOCOL_SCSI_CMD 0
10#define BSG_SUB_PROTOCOL_SCSI_TMF 1
11#define BSG_SUB_PROTOCOL_SCSI_TRANSPORT 2
12
13/*
Christopher Ferris7c0b6392015-01-23 15:34:26 -080014 * For flag constants below:
15 * sg.h sg_io_hdr also has bits defined for it's flags member. These
16 * two flag values (0x10 and 0x20) have the same meaning in sg.h . For
17 * bsg the BSG_FLAG_Q_AT_HEAD flag is ignored since it is the deafult.
Ben Cheng30692c62013-10-15 18:26:18 -070018 */
Christopher Ferris7c0b6392015-01-23 15:34:26 -080019#define BSG_FLAG_Q_AT_TAIL 0x10 /* default is Q_AT_HEAD */
20#define BSG_FLAG_Q_AT_HEAD 0x20
Ben Cheng30692c62013-10-15 18:26:18 -070021
22struct sg_io_v4 {
23 __s32 guard; /* [i] 'Q' to differentiate from v3 */
24 __u32 protocol; /* [i] 0 -> SCSI , .... */
25 __u32 subprotocol; /* [i] 0 -> SCSI command, 1 -> SCSI task
26 management function, .... */
27
28 __u32 request_len; /* [i] in bytes */
29 __u64 request; /* [i], [*i] {SCSI: cdb} */
30 __u64 request_tag; /* [i] {SCSI: task tag (only if flagged)} */
31 __u32 request_attr; /* [i] {SCSI: task attribute} */
32 __u32 request_priority; /* [i] {SCSI: task priority} */
33 __u32 request_extra; /* [i] {spare, for padding} */
34 __u32 max_response_len; /* [i] in bytes */
35 __u64 response; /* [i], [*o] {SCSI: (auto)sense data} */
36
37 /* "dout_": data out (to device); "din_": data in (from device) */
38 __u32 dout_iovec_count; /* [i] 0 -> "flat" dout transfer else
39 dout_xfer points to array of iovec */
40 __u32 dout_xfer_len; /* [i] bytes to be transferred to device */
41 __u32 din_iovec_count; /* [i] 0 -> "flat" din transfer */
42 __u32 din_xfer_len; /* [i] bytes to be transferred from device */
43 __u64 dout_xferp; /* [i], [*i] */
44 __u64 din_xferp; /* [i], [*o] */
45
46 __u32 timeout; /* [i] units: millisecond */
47 __u32 flags; /* [i] bit mask */
48 __u64 usr_ptr; /* [i->o] unused internally */
49 __u32 spare_in; /* [i] */
50
51 __u32 driver_status; /* [o] 0 -> ok */
52 __u32 transport_status; /* [o] 0 -> ok */
53 __u32 device_status; /* [o] {SCSI: command completion status} */
54 __u32 retry_delay; /* [o] {SCSI: status auxiliary information} */
55 __u32 info; /* [o] additional information */
56 __u32 duration; /* [o] time to complete, in milliseconds */
57 __u32 response_len; /* [o] bytes of response actually written */
58 __s32 din_resid; /* [o] din_xfer_len - actual_din_xfer_len */
59 __s32 dout_resid; /* [o] dout_xfer_len - actual_dout_xfer_len */
60 __u64 generated_tag; /* [o] {SCSI: transport generated task tag} */
61 __u32 spare_out; /* [o] */
62
63 __u32 padding;
64};
65
66
67#endif /* _UAPIBSG_H */