blob: 8c8fe530895c938af8c44e8e11102c30e0d6b4b2 [file] [log] [blame]
Christopher Ferris7447a1c2022-10-04 18:24:44 -07001/****************************************************************************
2 ****************************************************************************
3 ***
4 *** This header was automatically generated from a Linux kernel header
5 *** of the same name, to make information necessary for userspace to
6 *** call into the kernel available to libc. It contains only constants,
7 *** structures, and macros generated from the original header, and thus,
8 *** contains no copyrightable information.
9 ***
10 *** To edit the content of this header, modify the corresponding
11 *** source file (e.g. under external/kernel-headers/original/) then
12 *** run bionic/libc/kernel/tools/update_all.py
13 ***
14 *** Any manual change here will be lost the next time this script will
15 *** be run. You've been warned!
16 ***
17 ****************************************************************************
18 ****************************************************************************/
19#ifndef USER_BLK_DRV_CMD_INC_H
20#define USER_BLK_DRV_CMD_INC_H
21#include <linux/types.h>
22#define UBLK_CMD_GET_QUEUE_AFFINITY 0x01
23#define UBLK_CMD_GET_DEV_INFO 0x02
24#define UBLK_CMD_ADD_DEV 0x04
25#define UBLK_CMD_DEL_DEV 0x05
26#define UBLK_CMD_START_DEV 0x06
27#define UBLK_CMD_STOP_DEV 0x07
28#define UBLK_CMD_SET_PARAMS 0x08
29#define UBLK_CMD_GET_PARAMS 0x09
Christopher Ferris6cd53a52022-12-12 23:39:16 +000030#define UBLK_CMD_START_USER_RECOVERY 0x10
31#define UBLK_CMD_END_USER_RECOVERY 0x11
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +000032#define UBLK_CMD_GET_DEV_INFO2 0x12
Christopher Ferris37c3f3c2023-07-10 10:59:05 -070033#define UBLK_U_CMD_GET_QUEUE_AFFINITY _IOR('u', UBLK_CMD_GET_QUEUE_AFFINITY, struct ublksrv_ctrl_cmd)
34#define UBLK_U_CMD_GET_DEV_INFO _IOR('u', UBLK_CMD_GET_DEV_INFO, struct ublksrv_ctrl_cmd)
35#define UBLK_U_CMD_ADD_DEV _IOWR('u', UBLK_CMD_ADD_DEV, struct ublksrv_ctrl_cmd)
36#define UBLK_U_CMD_DEL_DEV _IOWR('u', UBLK_CMD_DEL_DEV, struct ublksrv_ctrl_cmd)
37#define UBLK_U_CMD_START_DEV _IOWR('u', UBLK_CMD_START_DEV, struct ublksrv_ctrl_cmd)
38#define UBLK_U_CMD_STOP_DEV _IOWR('u', UBLK_CMD_STOP_DEV, struct ublksrv_ctrl_cmd)
39#define UBLK_U_CMD_SET_PARAMS _IOWR('u', UBLK_CMD_SET_PARAMS, struct ublksrv_ctrl_cmd)
40#define UBLK_U_CMD_GET_PARAMS _IOR('u', UBLK_CMD_GET_PARAMS, struct ublksrv_ctrl_cmd)
41#define UBLK_U_CMD_START_USER_RECOVERY _IOWR('u', UBLK_CMD_START_USER_RECOVERY, struct ublksrv_ctrl_cmd)
42#define UBLK_U_CMD_END_USER_RECOVERY _IOWR('u', UBLK_CMD_END_USER_RECOVERY, struct ublksrv_ctrl_cmd)
43#define UBLK_U_CMD_GET_DEV_INFO2 _IOR('u', UBLK_CMD_GET_DEV_INFO2, struct ublksrv_ctrl_cmd)
Christopher Ferris8666d042023-09-06 14:55:31 -070044#define UBLK_U_CMD_GET_FEATURES _IOR('u', 0x13, struct ublksrv_ctrl_cmd)
45#define UBLK_FEATURES_LEN 8
Christopher Ferris7447a1c2022-10-04 18:24:44 -070046#define UBLK_IO_FETCH_REQ 0x20
47#define UBLK_IO_COMMIT_AND_FETCH_REQ 0x21
48#define UBLK_IO_NEED_GET_DATA 0x22
Christopher Ferris37c3f3c2023-07-10 10:59:05 -070049#define UBLK_U_IO_FETCH_REQ _IOWR('u', UBLK_IO_FETCH_REQ, struct ublksrv_io_cmd)
50#define UBLK_U_IO_COMMIT_AND_FETCH_REQ _IOWR('u', UBLK_IO_COMMIT_AND_FETCH_REQ, struct ublksrv_io_cmd)
51#define UBLK_U_IO_NEED_GET_DATA _IOWR('u', UBLK_IO_NEED_GET_DATA, struct ublksrv_io_cmd)
Christopher Ferris7447a1c2022-10-04 18:24:44 -070052#define UBLK_IO_RES_OK 0
53#define UBLK_IO_RES_NEED_GET_DATA 1
54#define UBLK_IO_RES_ABORT (- ENODEV)
55#define UBLKSRV_CMD_BUF_OFFSET 0
56#define UBLKSRV_IO_BUF_OFFSET 0x80000000
57#define UBLK_MAX_QUEUE_DEPTH 4096
Christopher Ferris8666d042023-09-06 14:55:31 -070058#define UBLK_IO_BUF_OFF 0
59#define UBLK_IO_BUF_BITS 25
60#define UBLK_IO_BUF_BITS_MASK ((1ULL << UBLK_IO_BUF_BITS) - 1)
61#define UBLK_TAG_OFF UBLK_IO_BUF_BITS
62#define UBLK_TAG_BITS 16
63#define UBLK_TAG_BITS_MASK ((1ULL << UBLK_TAG_BITS) - 1)
64#define UBLK_QID_OFF (UBLK_TAG_OFF + UBLK_TAG_BITS)
65#define UBLK_QID_BITS 12
66#define UBLK_QID_BITS_MASK ((1ULL << UBLK_QID_BITS) - 1)
67#define UBLK_MAX_NR_QUEUES (1U << UBLK_QID_BITS)
68#define UBLKSRV_IO_BUF_TOTAL_BITS (UBLK_QID_OFF + UBLK_QID_BITS)
69#define UBLKSRV_IO_BUF_TOTAL_SIZE (1ULL << UBLKSRV_IO_BUF_TOTAL_BITS)
Christopher Ferris7447a1c2022-10-04 18:24:44 -070070#define UBLK_F_SUPPORT_ZERO_COPY (1ULL << 0)
71#define UBLK_F_URING_CMD_COMP_IN_TASK (1ULL << 1)
72#define UBLK_F_NEED_GET_DATA (1UL << 2)
Christopher Ferris6cd53a52022-12-12 23:39:16 +000073#define UBLK_F_USER_RECOVERY (1UL << 3)
74#define UBLK_F_USER_RECOVERY_REISSUE (1UL << 4)
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +000075#define UBLK_F_UNPRIVILEGED_DEV (1UL << 5)
Christopher Ferris37c3f3c2023-07-10 10:59:05 -070076#define UBLK_F_CMD_IOCTL_ENCODE (1UL << 6)
Christopher Ferris8666d042023-09-06 14:55:31 -070077#define UBLK_F_USER_COPY (1UL << 7)
Christopher Ferris67d1e5e2023-10-31 13:36:37 -070078#define UBLK_F_ZONED (1ULL << 8)
Christopher Ferris7447a1c2022-10-04 18:24:44 -070079#define UBLK_S_DEV_DEAD 0
80#define UBLK_S_DEV_LIVE 1
Christopher Ferris6cd53a52022-12-12 23:39:16 +000081#define UBLK_S_DEV_QUIESCED 2
Christopher Ferris7447a1c2022-10-04 18:24:44 -070082struct ublksrv_ctrl_cmd {
83 __u32 dev_id;
84 __u16 queue_id;
85 __u16 len;
86 __u64 addr;
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +000087 __u64 data[1];
88 __u16 dev_path_len;
89 __u16 pad;
90 __u32 reserved;
Christopher Ferris7447a1c2022-10-04 18:24:44 -070091};
92struct ublksrv_ctrl_dev_info {
93 __u16 nr_hw_queues;
94 __u16 queue_depth;
95 __u16 state;
96 __u16 pad0;
97 __u32 max_io_buf_bytes;
98 __u32 dev_id;
99 __s32 ublksrv_pid;
100 __u32 pad1;
101 __u64 flags;
102 __u64 ublksrv_flags;
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +0000103 __u32 owner_uid;
104 __u32 owner_gid;
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700105 __u64 reserved1;
106 __u64 reserved2;
107};
108#define UBLK_IO_OP_READ 0
109#define UBLK_IO_OP_WRITE 1
110#define UBLK_IO_OP_FLUSH 2
111#define UBLK_IO_OP_DISCARD 3
112#define UBLK_IO_OP_WRITE_SAME 4
113#define UBLK_IO_OP_WRITE_ZEROES 5
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700114#define UBLK_IO_OP_ZONE_OPEN 10
115#define UBLK_IO_OP_ZONE_CLOSE 11
116#define UBLK_IO_OP_ZONE_FINISH 12
117#define UBLK_IO_OP_ZONE_APPEND 13
118#define UBLK_IO_OP_ZONE_RESET_ALL 14
119#define UBLK_IO_OP_ZONE_RESET 15
120#define UBLK_IO_OP_REPORT_ZONES 18
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700121#define UBLK_IO_F_FAILFAST_DEV (1U << 8)
122#define UBLK_IO_F_FAILFAST_TRANSPORT (1U << 9)
123#define UBLK_IO_F_FAILFAST_DRIVER (1U << 10)
124#define UBLK_IO_F_META (1U << 11)
125#define UBLK_IO_F_FUA (1U << 13)
126#define UBLK_IO_F_NOUNMAP (1U << 15)
127#define UBLK_IO_F_SWAP (1U << 16)
128struct ublksrv_io_desc {
129 __u32 op_flags;
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700130 union {
131 __u32 nr_sectors;
132 __u32 nr_zones;
133 };
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700134 __u64 start_sector;
135 __u64 addr;
136};
137struct ublksrv_io_cmd {
138 __u16 q_id;
139 __u16 tag;
140 __s32 result;
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700141 union {
142 __u64 addr;
143 __u64 zone_append_lba;
144 };
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700145};
146struct ublk_param_basic {
147#define UBLK_ATTR_READ_ONLY (1 << 0)
148#define UBLK_ATTR_ROTATIONAL (1 << 1)
149#define UBLK_ATTR_VOLATILE_CACHE (1 << 2)
150#define UBLK_ATTR_FUA (1 << 3)
151 __u32 attrs;
152 __u8 logical_bs_shift;
153 __u8 physical_bs_shift;
154 __u8 io_opt_shift;
155 __u8 io_min_shift;
156 __u32 max_sectors;
157 __u32 chunk_sectors;
158 __u64 dev_sectors;
159 __u64 virt_boundary_mask;
160};
161struct ublk_param_discard {
162 __u32 discard_alignment;
163 __u32 discard_granularity;
164 __u32 max_discard_sectors;
165 __u32 max_write_zeroes_sectors;
166 __u16 max_discard_segments;
167 __u16 reserved0;
168};
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +0000169struct ublk_param_devt {
170 __u32 char_major;
171 __u32 char_minor;
172 __u32 disk_major;
173 __u32 disk_minor;
174};
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700175struct ublk_param_zoned {
176 __u32 max_open_zones;
177 __u32 max_active_zones;
178 __u32 max_zone_append_sectors;
179 __u8 reserved[20];
180};
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700181struct ublk_params {
182 __u32 len;
183#define UBLK_PARAM_TYPE_BASIC (1 << 0)
184#define UBLK_PARAM_TYPE_DISCARD (1 << 1)
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +0000185#define UBLK_PARAM_TYPE_DEVT (1 << 2)
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700186#define UBLK_PARAM_TYPE_ZONED (1 << 3)
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700187 __u32 types;
188 struct ublk_param_basic basic;
189 struct ublk_param_discard discard;
Christopher Ferrisb7cef6d2023-05-09 19:04:15 +0000190 struct ublk_param_devt devt;
Christopher Ferris67d1e5e2023-10-31 13:36:37 -0700191 struct ublk_param_zoned zoned;
Christopher Ferris7447a1c2022-10-04 18:24:44 -0700192};
193#endif