[mirror_ubuntu-eoan-kernel.git] / include / uapi / linux / lightnvm.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * Copyright (C) 2015 CNEX Labs.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
 * USA.
 */

#ifndef _UAPI_LINUX_LIGHTNVM_H
#define _UAPI_LINUX_LIGHTNVM_H

#ifdef __KERNEL__
#include <linux/kernel.h>
#include <linux/ioctl.h>
#else /* __KERNEL__ */
#include <stdio.h>
#include <sys/ioctl.h>
#define DISK_NAME_LEN 32
#endif /* __KERNEL__ */

#include <linux/types.h>
#include <linux/ioctl.h>

#define NVM_TTYPE_NAME_MAX 48
#define NVM_TTYPE_MAX 63
#define NVM_MMTYPE_LEN 8

#define NVM_CTRL_FILE "/dev/lightnvm/control"

struct nvm_ioctl_info_tgt {
	__u32 version[3];
	__u32 reserved;
	char tgtname[NVM_TTYPE_NAME_MAX];
};

struct nvm_ioctl_info {
	__u32 version[3];	/* in/out - major, minor, patch */
	__u16 tgtsize;		/* number of targets */
	__u16 reserved16;	/* pad to 4K page */
	__u32 reserved[12];
	struct nvm_ioctl_info_tgt tgts[NVM_TTYPE_MAX];
};

enum {
	NVM_DEVICE_ACTIVE = 1 << 0,
};

struct nvm_ioctl_device_info {
	char devname[DISK_NAME_LEN];
	char bmname[NVM_TTYPE_NAME_MAX];
	__u32 bmversion[3];
	__u32 flags;
	__u32 reserved[8];
};

struct nvm_ioctl_get_devices {
	__u32 nr_devices;
	__u32 reserved[31];
	struct nvm_ioctl_device_info info[31];
};

struct nvm_ioctl_create_simple {
	__u32 lun_begin;
	__u32 lun_end;
};

enum {
	NVM_CONFIG_TYPE_SIMPLE = 0,
};

struct nvm_ioctl_create_conf {
	__u32 type;
	union {
		struct nvm_ioctl_create_simple s;
	};
};

enum {
	NVM_TARGET_FACTORY = 1 << 0,	/* Init target in factory mode */
};

struct nvm_ioctl_create {
	char dev[DISK_NAME_LEN];		/* open-channel SSD device */
	char tgttype[NVM_TTYPE_NAME_MAX];	/* target type name */
	char tgtname[DISK_NAME_LEN];		/* dev to expose target as */

	__u32 flags;

	struct nvm_ioctl_create_conf conf;
};

struct nvm_ioctl_remove {
	char tgtname[DISK_NAME_LEN];

	__u32 flags;
};

struct nvm_ioctl_dev_init {
	char dev[DISK_NAME_LEN];		/* open-channel SSD device */
	char mmtype[NVM_MMTYPE_LEN];		/* register to media manager */

	__u32 flags;
};

enum {
	NVM_FACTORY_ERASE_ONLY_USER	= 1 << 0, /* erase only blocks used as
						   * host blks or grown blks */
	NVM_FACTORY_RESET_HOST_BLKS	= 1 << 1, /* remove host blk marks */
	NVM_FACTORY_RESET_GRWN_BBLKS	= 1 << 2, /* remove grown blk marks */
	NVM_FACTORY_NR_BITS		= 1 << 3, /* stops here */
};

struct nvm_ioctl_dev_factory {
	char dev[DISK_NAME_LEN];

	__u32 flags;
};

struct nvm_user_vio {
	__u8 opcode;
	__u8 flags;
	__u16 control;
	__u16 nppas;
	__u16 rsvd;
	__u64 metadata;
	__u64 addr;
	__u64 ppa_list;
	__u32 metadata_len;
	__u32 data_len;
	__u64 status;
	__u32 result;
	__u32 rsvd3[3];
};

struct nvm_passthru_vio {
	__u8 opcode;
	__u8 flags;
	__u8 rsvd[2];
	__u32 nsid;
	__u32 cdw2;
	__u32 cdw3;
	__u64 metadata;
	__u64 addr;
	__u32 metadata_len;
	__u32 data_len;
	__u64 ppa_list;
	__u16 nppas;
	__u16 control;
	__u32 cdw13;
	__u32 cdw14;
	__u32 cdw15;
	__u64 status;
	__u32 result;
	__u32 timeout_ms;
};

/* The ioctl type, 'L', 0x20 - 0x2F documented in ioctl-number.txt */
enum {
	/* top level cmds */
	NVM_INFO_CMD = 0x20,
	NVM_GET_DEVICES_CMD,

	/* device level cmds */
	NVM_DEV_CREATE_CMD,
	NVM_DEV_REMOVE_CMD,

	/* Init a device to support LightNVM media managers */
	NVM_DEV_INIT_CMD,

	/* Factory reset device */
	NVM_DEV_FACTORY_CMD,

	/* Vector user I/O */
	NVM_DEV_VIO_ADMIN_CMD = 0x41,
	NVM_DEV_VIO_CMD = 0x42,
	NVM_DEV_VIO_USER_CMD = 0x43,
};

#define NVM_IOCTL 'L' /* 0x4c */

#define NVM_INFO		_IOWR(NVM_IOCTL, NVM_INFO_CMD, \
						struct nvm_ioctl_info)
#define NVM_GET_DEVICES		_IOR(NVM_IOCTL, NVM_GET_DEVICES_CMD, \
						struct nvm_ioctl_get_devices)
#define NVM_DEV_CREATE		_IOW(NVM_IOCTL, NVM_DEV_CREATE_CMD, \
						struct nvm_ioctl_create)
#define NVM_DEV_REMOVE		_IOW(NVM_IOCTL, NVM_DEV_REMOVE_CMD, \
						struct nvm_ioctl_remove)
#define NVM_DEV_INIT		_IOW(NVM_IOCTL, NVM_DEV_INIT_CMD, \
						struct nvm_ioctl_dev_init)
#define NVM_DEV_FACTORY		_IOW(NVM_IOCTL, NVM_DEV_FACTORY_CMD, \
						struct nvm_ioctl_dev_factory)

#define NVME_NVM_IOCTL_IO_VIO		_IOWR(NVM_IOCTL, NVM_DEV_VIO_USER_CMD, \
						struct nvm_passthru_vio)
#define NVME_NVM_IOCTL_ADMIN_VIO	_IOWR(NVM_IOCTL, NVM_DEV_VIO_ADMIN_CMD,\
						struct nvm_passthru_vio)
#define NVME_NVM_IOCTL_SUBMIT_VIO	_IOWR(NVM_IOCTL, NVM_DEV_VIO_CMD,\
						struct nvm_user_vio)

#define NVM_VERSION_MAJOR	1
#define NVM_VERSION_MINOR	0
#define NVM_VERSION_PATCHLEVEL	0

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