xref: /OK3568_Linux_fs/kernel/include/uapi/linux/dm-user.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: LGPL-2.0+ WITH Linux-syscall-note */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2020 Google, Inc
4*4882a593Smuzhiyun  * Copyright (C) 2020 Palmer Dabbelt <palmerdabbelt@google.com>
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef _LINUX_DM_USER_H
8*4882a593Smuzhiyun #define _LINUX_DM_USER_H
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/types.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /*
13*4882a593Smuzhiyun  * dm-user proxies device mapper ops between the kernel and userspace.  It's
14*4882a593Smuzhiyun  * essentially just an RPC mechanism: all kernel calls create a request,
15*4882a593Smuzhiyun  * userspace handles that with a response.  Userspace obtains requests via
16*4882a593Smuzhiyun  * read() and provides responses via write().
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  * See Documentation/block/dm-user.rst for more information.
19*4882a593Smuzhiyun  */
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define DM_USER_REQ_MAP_READ 0
22*4882a593Smuzhiyun #define DM_USER_REQ_MAP_WRITE 1
23*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLUSH 2
24*4882a593Smuzhiyun #define DM_USER_REQ_MAP_DISCARD 3
25*4882a593Smuzhiyun #define DM_USER_REQ_MAP_SECURE_ERASE 4
26*4882a593Smuzhiyun #define DM_USER_REQ_MAP_WRITE_SAME 5
27*4882a593Smuzhiyun #define DM_USER_REQ_MAP_WRITE_ZEROES 6
28*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_OPEN 7
29*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_CLOSE 8
30*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_FINISH 9
31*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_APPEND 10
32*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_RESET 11
33*4882a593Smuzhiyun #define DM_USER_REQ_MAP_ZONE_RESET_ALL 12
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_FAILFAST_DEV 0x00001
36*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_FAILFAST_TRANSPORT 0x00002
37*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_FAILFAST_DRIVER 0x00004
38*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_SYNC 0x00008
39*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_META 0x00010
40*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_PRIO 0x00020
41*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_NOMERGE 0x00040
42*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_IDLE 0x00080
43*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_INTEGRITY 0x00100
44*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_FUA 0x00200
45*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_PREFLUSH 0x00400
46*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_RAHEAD 0x00800
47*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_BACKGROUND 0x01000
48*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_NOWAIT 0x02000
49*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_CGROUP_PUNT 0x04000
50*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_NOUNMAP 0x08000
51*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_HIPRI 0x10000
52*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_DRV 0x20000
53*4882a593Smuzhiyun #define DM_USER_REQ_MAP_FLAG_SWAP 0x40000
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun #define DM_USER_RESP_SUCCESS 0
56*4882a593Smuzhiyun #define DM_USER_RESP_ERROR 1
57*4882a593Smuzhiyun #define DM_USER_RESP_UNSUPPORTED 2
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun struct dm_user_message {
60*4882a593Smuzhiyun 	__u64 seq;
61*4882a593Smuzhiyun 	__u64 type;
62*4882a593Smuzhiyun 	__u64 flags;
63*4882a593Smuzhiyun 	__u64 sector;
64*4882a593Smuzhiyun 	__u64 len;
65*4882a593Smuzhiyun 	__u8 buf[];
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun #endif
69