Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * Copyright (C) 2015 CNEX Labs. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License version
6 * 2 as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; see the file COPYING. If not, write to
15 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
16 * USA.
17 */
18
19#ifndef _UAPI_LINUX_LIGHTNVM_H
20#define _UAPI_LINUX_LIGHTNVM_H
21
22#ifdef __KERNEL__
23#include <linux/kernel.h>
24#include <linux/ioctl.h>
25#else /* __KERNEL__ */
26#include <stdio.h>
27#include <sys/ioctl.h>
28#define DISK_NAME_LEN 32
29#endif /* __KERNEL__ */
30
31#include <linux/types.h>
32#include <linux/ioctl.h>
33
34#define NVM_TTYPE_NAME_MAX 48
35#define NVM_TTYPE_MAX 63
36#define NVM_MMTYPE_LEN 8
37
38#define NVM_CTRL_FILE "/dev/lightnvm/control"
39
40struct nvm_ioctl_info_tgt {
41 __u32 version[3];
42 __u32 reserved;
43 char tgtname[NVM_TTYPE_NAME_MAX];
44};
45
46struct nvm_ioctl_info {
47 __u32 version[3]; /* in/out - major, minor, patch */
48 __u16 tgtsize; /* number of targets */
49 __u16 reserved16; /* pad to 4K page */
50 __u32 reserved[12];
51 struct nvm_ioctl_info_tgt tgts[NVM_TTYPE_MAX];
52};
53
54enum {
55 NVM_DEVICE_ACTIVE = 1 << 0,
56};
57
58struct nvm_ioctl_device_info {
59 char devname[DISK_NAME_LEN];
60 char bmname[NVM_TTYPE_NAME_MAX];
61 __u32 bmversion[3];
62 __u32 flags;
63 __u32 reserved[8];
64};
65
66struct nvm_ioctl_get_devices {
67 __u32 nr_devices;
68 __u32 reserved[31];
69 struct nvm_ioctl_device_info info[31];
70};
71
72struct nvm_ioctl_create_simple {
73 __u32 lun_begin;
74 __u32 lun_end;
75};
76
77enum {
78 NVM_CONFIG_TYPE_SIMPLE = 0,
79};
80
81struct nvm_ioctl_create_conf {
82 __u32 type;
83 union {
84 struct nvm_ioctl_create_simple s;
85 };
86};
87
88enum {
89 NVM_TARGET_FACTORY = 1 << 0, /* Init target in factory mode */
90};
91
92struct nvm_ioctl_create {
93 char dev[DISK_NAME_LEN]; /* open-channel SSD device */
94 char tgttype[NVM_TTYPE_NAME_MAX]; /* target type name */
95 char tgtname[DISK_NAME_LEN]; /* dev to expose target as */
96
97 __u32 flags;
98
99 struct nvm_ioctl_create_conf conf;
100};
101
102struct nvm_ioctl_remove {
103 char tgtname[DISK_NAME_LEN];
104
105 __u32 flags;
106};
107
108struct nvm_ioctl_dev_init {
109 char dev[DISK_NAME_LEN]; /* open-channel SSD device */
110 char mmtype[NVM_MMTYPE_LEN]; /* register to media manager */
111
112 __u32 flags;
113};
114
115enum {
116 NVM_FACTORY_ERASE_ONLY_USER = 1 << 0, /* erase only blocks used as
117 * host blks or grown blks */
118 NVM_FACTORY_RESET_HOST_BLKS = 1 << 1, /* remove host blk marks */
119 NVM_FACTORY_RESET_GRWN_BBLKS = 1 << 2, /* remove grown blk marks */
120 NVM_FACTORY_NR_BITS = 1 << 3, /* stops here */
121};
122
123struct nvm_ioctl_dev_factory {
124 char dev[DISK_NAME_LEN];
125
126 __u32 flags;
127};
128
129struct nvm_user_vio {
130 __u8 opcode;
131 __u8 flags;
132 __u16 control;
133 __u16 nppas;
134 __u16 rsvd;
135 __u64 metadata;
136 __u64 addr;
137 __u64 ppa_list;
138 __u32 metadata_len;
139 __u32 data_len;
140 __u64 status;
141 __u32 result;
142 __u32 rsvd3[3];
143};
144
145struct nvm_passthru_vio {
146 __u8 opcode;
147 __u8 flags;
148 __u8 rsvd[2];
149 __u32 nsid;
150 __u32 cdw2;
151 __u32 cdw3;
152 __u64 metadata;
153 __u64 addr;
154 __u32 metadata_len;
155 __u32 data_len;
156 __u64 ppa_list;
157 __u16 nppas;
158 __u16 control;
159 __u32 cdw13;
160 __u32 cdw14;
161 __u32 cdw15;
162 __u64 status;
163 __u32 result;
164 __u32 timeout_ms;
165};
166
167/* The ioctl type, 'L', 0x20 - 0x2F documented in ioctl-number.txt */
168enum {
169 /* top level cmds */
170 NVM_INFO_CMD = 0x20,
171 NVM_GET_DEVICES_CMD,
172
173 /* device level cmds */
174 NVM_DEV_CREATE_CMD,
175 NVM_DEV_REMOVE_CMD,
176
177 /* Init a device to support LightNVM media managers */
178 NVM_DEV_INIT_CMD,
179
180 /* Factory reset device */
181 NVM_DEV_FACTORY_CMD,
182
183 /* Vector user I/O */
184 NVM_DEV_VIO_ADMIN_CMD = 0x41,
185 NVM_DEV_VIO_CMD = 0x42,
186 NVM_DEV_VIO_USER_CMD = 0x43,
187};
188
189#define NVM_IOCTL 'L' /* 0x4c */
190
191#define NVM_INFO _IOWR(NVM_IOCTL, NVM_INFO_CMD, \
192 struct nvm_ioctl_info)
193#define NVM_GET_DEVICES _IOR(NVM_IOCTL, NVM_GET_DEVICES_CMD, \
194 struct nvm_ioctl_get_devices)
195#define NVM_DEV_CREATE _IOW(NVM_IOCTL, NVM_DEV_CREATE_CMD, \
196 struct nvm_ioctl_create)
197#define NVM_DEV_REMOVE _IOW(NVM_IOCTL, NVM_DEV_REMOVE_CMD, \
198 struct nvm_ioctl_remove)
199#define NVM_DEV_INIT _IOW(NVM_IOCTL, NVM_DEV_INIT_CMD, \
200 struct nvm_ioctl_dev_init)
201#define NVM_DEV_FACTORY _IOW(NVM_IOCTL, NVM_DEV_FACTORY_CMD, \
202 struct nvm_ioctl_dev_factory)
203
204#define NVME_NVM_IOCTL_IO_VIO _IOWR(NVM_IOCTL, NVM_DEV_VIO_USER_CMD, \
205 struct nvm_passthru_vio)
206#define NVME_NVM_IOCTL_ADMIN_VIO _IOWR(NVM_IOCTL, NVM_DEV_VIO_ADMIN_CMD,\
207 struct nvm_passthru_vio)
208#define NVME_NVM_IOCTL_SUBMIT_VIO _IOWR(NVM_IOCTL, NVM_DEV_VIO_CMD,\
209 struct nvm_user_vio)
210
211#define NVM_VERSION_MAJOR 1
212#define NVM_VERSION_MINOR 0
213#define NVM_VERSION_PATCHLEVEL 0
214
215#endif