[thirdparty/kernel/linux.git] / include / linux / lightnvm.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef NVM_H
#define NVM_H

#include <linux/blkdev.h>
#include <linux/types.h>
#include <uapi/linux/lightnvm.h>

enum {
	NVM_IO_OK = 0,
	NVM_IO_REQUEUE = 1,
	NVM_IO_DONE = 2,
	NVM_IO_ERR = 3,

	NVM_IOTYPE_NONE = 0,
	NVM_IOTYPE_GC = 1,
};

#define NVM_BLK_BITS (16)
#define NVM_PG_BITS  (16)
#define NVM_SEC_BITS (8)
#define NVM_PL_BITS  (8)
#define NVM_LUN_BITS (8)
#define NVM_CH_BITS  (7)

struct ppa_addr {
	/* Generic structure for all addresses */
	union {
		struct {
			u64 blk		: NVM_BLK_BITS;
			u64 pg		: NVM_PG_BITS;
			u64 sec		: NVM_SEC_BITS;
			u64 pl		: NVM_PL_BITS;
			u64 lun		: NVM_LUN_BITS;
			u64 ch		: NVM_CH_BITS;
			u64 reserved	: 1;
		} g;

		struct {
			u64 line	: 63;
			u64 is_cached	: 1;
		} c;

		u64 ppa;
	};
};

struct nvm_rq;
struct nvm_id;
struct nvm_dev;
struct nvm_tgt_dev;

typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
				nvm_l2p_update_fn *, void *);
typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
typedef void (nvm_destroy_dma_pool_fn)(void *);
typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
								dma_addr_t *);
typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);

struct nvm_dev_ops {
	nvm_id_fn		*identity;
	nvm_get_l2p_tbl_fn	*get_l2p_tbl;
	nvm_op_bb_tbl_fn	*get_bb_tbl;
	nvm_op_set_bb_fn	*set_bb_tbl;

	nvm_submit_io_fn	*submit_io;

	nvm_create_dma_pool_fn	*create_dma_pool;
	nvm_destroy_dma_pool_fn	*destroy_dma_pool;
	nvm_dev_dma_alloc_fn	*dev_dma_alloc;
	nvm_dev_dma_free_fn	*dev_dma_free;

	unsigned int		max_phys_sect;
};

#ifdef CONFIG_NVM

#include <linux/blkdev.h>
#include <linux/file.h>
#include <linux/dmapool.h>
#include <uapi/linux/lightnvm.h>

enum {
	/* HW Responsibilities */
	NVM_RSP_L2P	= 1 << 0,
	NVM_RSP_ECC	= 1 << 1,

	/* Physical Adressing Mode */
	NVM_ADDRMODE_LINEAR	= 0,
	NVM_ADDRMODE_CHANNEL	= 1,

	/* Plane programming mode for LUN */
	NVM_PLANE_SINGLE	= 1,
	NVM_PLANE_DOUBLE	= 2,
	NVM_PLANE_QUAD		= 4,

	/* Status codes */
	NVM_RSP_SUCCESS		= 0x0,
	NVM_RSP_NOT_CHANGEABLE	= 0x1,
	NVM_RSP_ERR_FAILWRITE	= 0x40ff,
	NVM_RSP_ERR_EMPTYPAGE	= 0x42ff,
	NVM_RSP_ERR_FAILECC	= 0x4281,
	NVM_RSP_ERR_FAILCRC	= 0x4004,
	NVM_RSP_WARN_HIGHECC	= 0x4700,

	/* Device opcodes */
	NVM_OP_HBREAD		= 0x02,
	NVM_OP_HBWRITE		= 0x81,
	NVM_OP_PWRITE		= 0x91,
	NVM_OP_PREAD		= 0x92,
	NVM_OP_ERASE		= 0x90,

	/* PPA Command Flags */
	NVM_IO_SNGL_ACCESS	= 0x0,
	NVM_IO_DUAL_ACCESS	= 0x1,
	NVM_IO_QUAD_ACCESS	= 0x2,

	/* NAND Access Modes */
	NVM_IO_SUSPEND		= 0x80,
	NVM_IO_SLC_MODE		= 0x100,
	NVM_IO_SCRAMBLE_ENABLE	= 0x200,

	/* Block Types */
	NVM_BLK_T_FREE		= 0x0,
	NVM_BLK_T_BAD		= 0x1,
	NVM_BLK_T_GRWN_BAD	= 0x2,
	NVM_BLK_T_DEV		= 0x4,
	NVM_BLK_T_HOST		= 0x8,

	/* Memory capabilities */
	NVM_ID_CAP_SLC		= 0x1,
	NVM_ID_CAP_CMD_SUSPEND	= 0x2,
	NVM_ID_CAP_SCRAMBLE	= 0x4,
	NVM_ID_CAP_ENCRYPT	= 0x8,

	/* Memory types */
	NVM_ID_FMTYPE_SLC	= 0,
	NVM_ID_FMTYPE_MLC	= 1,

	/* Device capabilities */
	NVM_ID_DCAP_BBLKMGMT	= 0x1,
	NVM_UD_DCAP_ECC		= 0x2,
};

struct nvm_id_lp_mlc {
	u16	num_pairs;
	u8	pairs[886];
};

struct nvm_id_lp_tbl {
	__u8	id[8];
	struct nvm_id_lp_mlc mlc;
};

struct nvm_id_group {
	u8	mtype;
	u8	fmtype;
	u8	num_ch;
	u8	num_lun;
	u8	num_pln;
	u16	num_blk;
	u16	num_pg;
	u16	fpg_sz;
	u16	csecs;
	u16	sos;
	u32	trdt;
	u32	trdm;
	u32	tprt;
	u32	tprm;
	u32	tbet;
	u32	tbem;
	u32	mpos;
	u32	mccap;
	u16	cpar;

	struct nvm_id_lp_tbl lptbl;
};

struct nvm_addr_format {
	u8	ch_offset;
	u8	ch_len;
	u8	lun_offset;
	u8	lun_len;
	u8	pln_offset;
	u8	pln_len;
	u8	blk_offset;
	u8	blk_len;
	u8	pg_offset;
	u8	pg_len;
	u8	sect_offset;
	u8	sect_len;
};

struct nvm_id {
	u8	ver_id;
	u8	vmnt;
	u32	cap;
	u32	dom;
	struct nvm_addr_format ppaf;
	struct nvm_id_group grp;
} __packed;

struct nvm_target {
	struct list_head list;
	struct nvm_tgt_dev *dev;
	struct nvm_tgt_type *type;
	struct gendisk *disk;
};

#define ADDR_EMPTY (~0ULL)

#define NVM_VERSION_MAJOR 1
#define NVM_VERSION_MINOR 0
#define NVM_VERSION_PATCH 0

struct nvm_rq;
typedef void (nvm_end_io_fn)(struct nvm_rq *);

struct nvm_rq {
	struct nvm_tgt_dev *dev;

	struct bio *bio;

	union {
		struct ppa_addr ppa_addr;
		dma_addr_t dma_ppa_list;
	};

	struct ppa_addr *ppa_list;

	void *meta_list;
	dma_addr_t dma_meta_list;

	struct completion *wait;
	nvm_end_io_fn *end_io;

	uint8_t opcode;
	uint16_t nr_ppas;
	uint16_t flags;

	u64 ppa_status; /* ppa media status */
	int error;

	void *private;
};

static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
{
	return pdu - sizeof(struct nvm_rq);
}

static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
{
	return rqdata + 1;
}

enum {
	NVM_BLK_ST_FREE =	0x1,	/* Free block */
	NVM_BLK_ST_TGT =	0x2,	/* Block in use by target */
	NVM_BLK_ST_BAD =	0x8,	/* Bad block */
};

/* Device generic information */
struct nvm_geo {
	int nr_chnls;
	int nr_luns;
	int luns_per_chnl; /* -1 if channels are not symmetric */
	int nr_planes;
	int sec_per_pg; /* only sectors for a single page */
	int pgs_per_blk;
	int blks_per_lun;
	int fpg_size;
	int pfpg_size; /* size of buffer if all pages are to be read */
	int sec_size;
	int oob_size;
	int mccap;
	struct nvm_addr_format ppaf;

	/* Calculated/Cached values. These do not reflect the actual usable
	 * blocks at run-time.
	 */
	int max_rq_size;
	int plane_mode; /* drive device in single, double or quad mode */

	int sec_per_pl; /* all sectors across planes */
	int sec_per_blk;
	int sec_per_lun;
};

/* sub-device structure */
struct nvm_tgt_dev {
	/* Device information */
	struct nvm_geo geo;

	/* Base ppas for target LUNs */
	struct ppa_addr *luns;

	sector_t total_secs;

	struct nvm_id identity;
	struct request_queue *q;

	struct nvm_dev *parent;
	void *map;
};

struct nvm_dev {
	struct nvm_dev_ops *ops;

	struct list_head devices;

	/* Device information */
	struct nvm_geo geo;

	  /* lower page table */
	int lps_per_blk;
	int *lptbl;

	unsigned long total_secs;

	unsigned long *lun_map;
	void *dma_pool;

	struct nvm_id identity;

	/* Backend device */
	struct request_queue *q;
	char name[DISK_NAME_LEN];
	void *private_data;

	void *rmap;

	struct mutex mlock;
	spinlock_t lock;

	/* target management */
	struct list_head area_list;
	struct list_head targets;
};

static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
						     u64 pba)
{
	struct ppa_addr l;
	int secs, pgs, blks, luns;
	sector_t ppa = pba;

	l.ppa = 0;

	div_u64_rem(ppa, geo->sec_per_pg, &secs);
	l.g.sec = secs;

	sector_div(ppa, geo->sec_per_pg);
	div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
	l.g.pg = pgs;

	sector_div(ppa, geo->pgs_per_blk);
	div_u64_rem(ppa, geo->blks_per_lun, &blks);
	l.g.blk = blks;

	sector_div(ppa, geo->blks_per_lun);
	div_u64_rem(ppa, geo->luns_per_chnl, &luns);
	l.g.lun = luns;

	sector_div(ppa, geo->luns_per_chnl);
	l.g.ch = ppa;

	return l;
}

static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
						  struct ppa_addr r)
{
	struct nvm_geo *geo = &tgt_dev->geo;
	struct ppa_addr l;

	l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
	l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
	l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
	l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
	l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
	l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;

	return l;
}

static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
						  struct ppa_addr r)
{
	struct nvm_geo *geo = &tgt_dev->geo;
	struct ppa_addr l;

	l.ppa = 0;
	/*
	 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
	 */
	l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
					(((1 << geo->ppaf.blk_len) - 1));
	l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
					(((1 << geo->ppaf.pg_len) - 1));
	l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
					(((1 << geo->ppaf.sect_len) - 1));
	l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
					(((1 << geo->ppaf.pln_len) - 1));
	l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
					(((1 << geo->ppaf.lun_len) - 1));
	l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
					(((1 << geo->ppaf.ch_len) - 1));

	return l;
}

static inline int ppa_empty(struct ppa_addr ppa_addr)
{
	return (ppa_addr.ppa == ADDR_EMPTY);
}

static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
{
	ppa_addr->ppa = ADDR_EMPTY;
}

static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
{
	if (ppa_empty(ppa1) || ppa_empty(ppa2))
		return 0;

	return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
					(ppa1.g.blk == ppa2.g.blk));
}

typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
typedef sector_t (nvm_tgt_capacity_fn)(void *);
typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *,
				int flags);
typedef void (nvm_tgt_exit_fn)(void *);
typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);

struct nvm_tgt_type {
	const char *name;
	unsigned int version[3];

	/* target entry points */
	nvm_tgt_make_rq_fn *make_rq;
	nvm_tgt_capacity_fn *capacity;

	/* module-specific init/teardown */
	nvm_tgt_init_fn *init;
	nvm_tgt_exit_fn *exit;

	/* sysfs */
	nvm_tgt_sysfs_init_fn *sysfs_init;
	nvm_tgt_sysfs_exit_fn *sysfs_exit;

	/* For internal use */
	struct list_head list;
};

extern struct nvm_tgt_type *nvm_find_target_type(const char *, int);

extern int nvm_register_tgt_type(struct nvm_tgt_type *);
extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);

extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);

extern struct nvm_dev *nvm_alloc_dev(int);
extern int nvm_register(struct nvm_dev *);
extern void nvm_unregister(struct nvm_dev *);

extern int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr *,
			      int, int);
extern int nvm_max_phys_sects(struct nvm_tgt_dev *);
extern int nvm_submit_io(struct nvm_tgt_dev *, struct nvm_rq *);
extern int nvm_erase_sync(struct nvm_tgt_dev *, struct ppa_addr *, int);
extern int nvm_set_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *,
					const struct ppa_addr *, int, int);
extern void nvm_free_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *);
extern int nvm_get_l2p_tbl(struct nvm_tgt_dev *, u64, u32, nvm_l2p_update_fn *,
			   void *);
extern int nvm_get_area(struct nvm_tgt_dev *, sector_t *, sector_t);
extern void nvm_put_area(struct nvm_tgt_dev *, sector_t);
extern void nvm_end_io(struct nvm_rq *);
extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr, u8 *);

extern int nvm_dev_factory(struct nvm_dev *, int flags);

extern void nvm_part_to_tgt(struct nvm_dev *, sector_t *, int);

#else /* CONFIG_NVM */
struct nvm_dev_ops;

static inline struct nvm_dev *nvm_alloc_dev(int node)
{
	return ERR_PTR(-EINVAL);
}
static inline int nvm_register(struct nvm_dev *dev)
{
	return -EINVAL;
}
static inline void nvm_unregister(struct nvm_dev *dev) {}
#endif /* CONFIG_NVM */
#endif /* LIGHTNVM.H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
cd9e9808 MB	2	#ifndef NVM_H
	3	#define NVM_H
	4
b76eb20b	5	#include <linux/blkdev.h>
a7fd9a4f	6	#include <linux/types.h>
b76eb20b	7	#include <uapi/linux/lightnvm.h>
a7fd9a4f	8
cd9e9808 MB	9	enum {
	10	NVM_IO_OK = 0,
	11	NVM_IO_REQUEUE = 1,
	12	NVM_IO_DONE = 2,
	13	NVM_IO_ERR = 3,
	14
	15	NVM_IOTYPE_NONE = 0,
	16	NVM_IOTYPE_GC = 1,
	17	};
	18
a7fd9a4f JA	19	#define NVM_BLK_BITS (16)
	20	#define NVM_PG_BITS (16)
	21	#define NVM_SEC_BITS (8)
	22	#define NVM_PL_BITS (8)
	23	#define NVM_LUN_BITS (8)
df414b33	24	#define NVM_CH_BITS (7)
a7fd9a4f JA	25
	26	struct ppa_addr {
	27	/* Generic structure for all addresses */
	28	union {
	29	struct {
	30	u64 blk : NVM_BLK_BITS;
	31	u64 pg : NVM_PG_BITS;
	32	u64 sec : NVM_SEC_BITS;
	33	u64 pl : NVM_PL_BITS;
	34	u64 lun : NVM_LUN_BITS;
	35	u64 ch : NVM_CH_BITS;
df414b33	36	u64 reserved : 1;
a7fd9a4f JA	37	} g;
a7fd9a4f JA	38
df414b33 MB	39	struct {
	40	u64 line : 63;
	41	u64 is_cached : 1;
	42	} c;
	43
a7fd9a4f JA	44	u64 ppa;
	45	};
	46	};
	47
	48	struct nvm_rq;
	49	struct nvm_id;
	50	struct nvm_dev;
8e53624d	51	struct nvm_tgt_dev;
a7fd9a4f JA	52
a7fd9a4f JA	53	typedef int (nvm_l2p_update_fn)(u64, u32, __le64 , void );
a7fd9a4f JA	54	typedef int (nvm_id_fn)(struct nvm_dev , struct nvm_id );
	55	typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
	56	nvm_l2p_update_fn , void );
e11903f5	57	typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev , struct ppa_addr, u8 );
00ee6cc3	58	typedef int (nvm_op_set_bb_fn)(struct nvm_dev , struct ppa_addr , int, int);
a7fd9a4f	59	typedef int (nvm_submit_io_fn)(struct nvm_dev , struct nvm_rq );
a7fd9a4f JA	60	typedef void (nvm_create_dma_pool_fn)(struct nvm_dev , char *);
	61	typedef void (nvm_destroy_dma_pool_fn)(void *);
	62	typedef void (nvm_dev_dma_alloc_fn)(struct nvm_dev , void *, gfp_t,
	63	dma_addr_t *);
	64	typedef void (nvm_dev_dma_free_fn)(void , void, dma_addr_t);
	65
	66	struct nvm_dev_ops {
	67	nvm_id_fn *identity;
	68	nvm_get_l2p_tbl_fn *get_l2p_tbl;
	69	nvm_op_bb_tbl_fn *get_bb_tbl;
	70	nvm_op_set_bb_fn *set_bb_tbl;
	71
	72	nvm_submit_io_fn *submit_io;
a7fd9a4f JA	73
	74	nvm_create_dma_pool_fn *create_dma_pool;
	75	nvm_destroy_dma_pool_fn *destroy_dma_pool;
	76	nvm_dev_dma_alloc_fn *dev_dma_alloc;
	77	nvm_dev_dma_free_fn *dev_dma_free;
	78
	79	unsigned int max_phys_sect;
	80	};
	81
cd9e9808 MB	82	#ifdef CONFIG_NVM
	83
	84	#include <linux/blkdev.h>
cd9e9808 MB	85	#include <linux/file.h>
cd9e9808 MB	86	#include <linux/dmapool.h>
e3eb3799	87	#include <uapi/linux/lightnvm.h>
cd9e9808 MB	88
	89	enum {
	90	/* HW Responsibilities */
	91	NVM_RSP_L2P = 1 << 0,
	92	NVM_RSP_ECC = 1 << 1,
	93
	94	/* Physical Adressing Mode */
	95	NVM_ADDRMODE_LINEAR = 0,
	96	NVM_ADDRMODE_CHANNEL = 1,
	97
	98	/* Plane programming mode for LUN */
d5bdec8d MB	99	NVM_PLANE_SINGLE = 1,
	100	NVM_PLANE_DOUBLE = 2,
	101	NVM_PLANE_QUAD = 4,
cd9e9808 MB	102
	103	/* Status codes */
	104	NVM_RSP_SUCCESS = 0x0,
	105	NVM_RSP_NOT_CHANGEABLE = 0x1,
	106	NVM_RSP_ERR_FAILWRITE = 0x40ff,
	107	NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
402ab9a8	108	NVM_RSP_ERR_FAILECC = 0x4281,
38ea2f76	109	NVM_RSP_ERR_FAILCRC = 0x4004,
402ab9a8	110	NVM_RSP_WARN_HIGHECC = 0x4700,
cd9e9808 MB	111
	112	/* Device opcodes */
	113	NVM_OP_HBREAD = 0x02,
	114	NVM_OP_HBWRITE = 0x81,
	115	NVM_OP_PWRITE = 0x91,
	116	NVM_OP_PREAD = 0x92,
	117	NVM_OP_ERASE = 0x90,
	118
	119	/* PPA Command Flags */
	120	NVM_IO_SNGL_ACCESS = 0x0,
	121	NVM_IO_DUAL_ACCESS = 0x1,
	122	NVM_IO_QUAD_ACCESS = 0x2,
	123
57b4bd06	124	/* NAND Access Modes */
cd9e9808 MB	125	NVM_IO_SUSPEND = 0x80,
cd9e9808 MB	126	NVM_IO_SLC_MODE = 0x100,
a7737f39	127	NVM_IO_SCRAMBLE_ENABLE = 0x200,
57b4bd06 MB	128
	129	/* Block Types */
	130	NVM_BLK_T_FREE = 0x0,
	131	NVM_BLK_T_BAD = 0x1,
b5d4acd4 MB	132	NVM_BLK_T_GRWN_BAD = 0x2,
	133	NVM_BLK_T_DEV = 0x4,
	134	NVM_BLK_T_HOST = 0x8,
f9a99950 MB	135
	136	/* Memory capabilities */
	137	NVM_ID_CAP_SLC = 0x1,
	138	NVM_ID_CAP_CMD_SUSPEND = 0x2,
	139	NVM_ID_CAP_SCRAMBLE = 0x4,
	140	NVM_ID_CAP_ENCRYPT = 0x8,
ca5927e7 MB	141
	142	/* Memory types */
	143	NVM_ID_FMTYPE_SLC = 0,
	144	NVM_ID_FMTYPE_MLC = 1,
bf643185 MB	145
	146	/* Device capabilities */
	147	NVM_ID_DCAP_BBLKMGMT = 0x1,
	148	NVM_UD_DCAP_ECC = 0x2,
ca5927e7 MB	149	};
	150
	151	struct nvm_id_lp_mlc {
	152	u16 num_pairs;
	153	u8 pairs[886];
	154	};
	155
	156	struct nvm_id_lp_tbl {
	157	__u8 id[8];
	158	struct nvm_id_lp_mlc mlc;
cd9e9808 MB	159	};
	160
	161	struct nvm_id_group {
	162	u8 mtype;
	163	u8 fmtype;
cd9e9808 MB	164	u8 num_ch;
	165	u8 num_lun;
	166	u8 num_pln;
	167	u16 num_blk;
	168	u16 num_pg;
	169	u16 fpg_sz;
	170	u16 csecs;
	171	u16 sos;
	172	u32 trdt;
	173	u32 trdm;
	174	u32 tprt;
	175	u32 tprm;
	176	u32 tbet;
	177	u32 tbem;
	178	u32 mpos;
12be5edf	179	u32 mccap;
cd9e9808	180	u16 cpar;
ca5927e7 MB	181
ca5927e7 MB	182	struct nvm_id_lp_tbl lptbl;
73387e7b	183	};
cd9e9808 MB	184
	185	struct nvm_addr_format {
	186	u8 ch_offset;
	187	u8 ch_len;
	188	u8 lun_offset;
	189	u8 lun_len;
	190	u8 pln_offset;
	191	u8 pln_len;
	192	u8 blk_offset;
	193	u8 blk_len;
	194	u8 pg_offset;
	195	u8 pg_len;
	196	u8 sect_offset;
	197	u8 sect_len;
cd9e9808 MB	198	};
	199
	200	struct nvm_id {
	201	u8 ver_id;
	202	u8 vmnt;
cd9e9808 MB	203	u32 cap;
	204	u32 dom;
	205	struct nvm_addr_format ppaf;
19bd6fe7	206	struct nvm_id_group grp;
cd9e9808 MB	207	} __packed;
	208
	209	struct nvm_target {
	210	struct list_head list;
8e79b5cb	211	struct nvm_tgt_dev *dev;
cd9e9808 MB	212	struct nvm_tgt_type *type;
	213	struct gendisk *disk;
	214	};
	215
cd9e9808 MB	216	#define ADDR_EMPTY (~0ULL)
	217
	218	#define NVM_VERSION_MAJOR 1
	219	#define NVM_VERSION_MINOR 0
	220	#define NVM_VERSION_PATCH 0
	221
91276162	222	struct nvm_rq;
72d256ec	223	typedef void (nvm_end_io_fn)(struct nvm_rq *);
91276162	224
cd9e9808	225	struct nvm_rq {
8e53624d	226	struct nvm_tgt_dev *dev;
cd9e9808 MB	227
	228	struct bio *bio;
	229
	230	union {
	231	struct ppa_addr ppa_addr;
	232	dma_addr_t dma_ppa_list;
	233	};
	234
	235	struct ppa_addr *ppa_list;
	236
003fad37 JG	237	void *meta_list;
003fad37 JG	238	dma_addr_t dma_meta_list;
cd9e9808	239
91276162 MB	240	struct completion *wait;
	241	nvm_end_io_fn *end_io;
	242
cd9e9808	243	uint8_t opcode;
6d5be959	244	uint16_t nr_ppas;
cd9e9808	245	uint16_t flags;
72d256ec	246
9f867268	247	u64 ppa_status; /* ppa media status */
72d256ec	248	int error;
06894efe MB	249
06894efe MB	250	void *private;
cd9e9808 MB	251	};
	252
	253	static inline struct nvm_rq nvm_rq_from_pdu(void pdu)
	254	{
	255	return pdu - sizeof(struct nvm_rq);
	256	}
	257
	258	static inline void nvm_rq_to_pdu(struct nvm_rq rqdata)
	259	{
	260	return rqdata + 1;
	261	}
	262
ff0e498b JG	263	enum {
ff0e498b JG	264	NVM_BLK_ST_FREE = 0x1, /* Free block */
077d2389	265	NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
ff0e498b	266	NVM_BLK_ST_BAD = 0x8, /* Bad block */
cd9e9808 MB	267	};
cd9e9808 MB	268
8e79b5cb JG	269	/* Device generic information */
8e79b5cb JG	270	struct nvm_geo {
cd9e9808	271	int nr_chnls;
8e79b5cb JG	272	int nr_luns;
8e79b5cb JG	273	int luns_per_chnl; /* -1 if channels are not symmetric */
cd9e9808	274	int nr_planes;
cd9e9808 MB	275	int sec_per_pg; /* only sectors for a single page */
	276	int pgs_per_blk;
	277	int blks_per_lun;
4891d120 MB	278	int fpg_size;
4891d120 MB	279	int pfpg_size; /* size of buffer if all pages are to be read */
cd9e9808 MB	280	int sec_size;
cd9e9808 MB	281	int oob_size;
f9a99950	282	int mccap;
7386af27	283	struct nvm_addr_format ppaf;
cd9e9808 MB	284
	285	/* Calculated/Cached values. These do not reflect the actual usable
	286	* blocks at run-time.
	287	*/
	288	int max_rq_size;
	289	int plane_mode; /* drive device in single, double or quad mode */
	290
	291	int sec_per_pl; /* all sectors across planes */
	292	int sec_per_blk;
	293	int sec_per_lun;
8e79b5cb JG	294	};
8e79b5cb JG	295
ade69e24	296	/* sub-device structure */
8e79b5cb JG	297	struct nvm_tgt_dev {
	298	/* Device information */
	299	struct nvm_geo geo;
	300
8e53624d JG	301	/* Base ppas for target LUNs */
	302	struct ppa_addr *luns;
	303
8e79b5cb JG	304	sector_t total_secs;
	305
	306	struct nvm_id identity;
	307	struct request_queue *q;
	308
959e911b	309	struct nvm_dev *parent;
8e53624d	310	void *map;
8e79b5cb JG	311	};
	312
	313	struct nvm_dev {
	314	struct nvm_dev_ops *ops;
	315
	316	struct list_head devices;
	317
8e79b5cb JG	318	/* Device information */
8e79b5cb JG	319	struct nvm_geo geo;
cd9e9808	320
ade69e24	321	/* lower page table */
ca5927e7 MB	322	int lps_per_blk;
	323	int *lptbl;
	324
4ece44af	325	unsigned long total_secs;
cd9e9808	326
da1e2849	327	unsigned long *lun_map;
75b85649	328	void *dma_pool;
cd9e9808 MB	329
	330	struct nvm_id identity;
	331
	332	/* Backend device */
	333	struct request_queue *q;
	334	char name[DISK_NAME_LEN];
40267efd	335	void *private_data;
e3eb3799	336
8e53624d JG	337	void *rmap;
8e53624d JG	338
e3eb3799	339	struct mutex mlock;
4c9dacb8	340	spinlock_t lock;
ade69e24 MB	341
	342	/* target management */
	343	struct list_head area_list;
	344	struct list_head targets;
cd9e9808 MB	345	};
cd9e9808 MB	346
8e79b5cb	347	static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
8e53624d	348	u64 pba)
0e5c3246 JG	349	{
	350	struct ppa_addr l;
	351	int secs, pgs, blks, luns;
8e53624d	352	sector_t ppa = pba;
0e5c3246 JG	353
	354	l.ppa = 0;
	355
8e79b5cb	356	div_u64_rem(ppa, geo->sec_per_pg, &secs);
0e5c3246 JG	357	l.g.sec = secs;
0e5c3246 JG	358
8e79b5cb JG	359	sector_div(ppa, geo->sec_per_pg);
8e79b5cb JG	360	div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
0e5c3246 JG	361	l.g.pg = pgs;
0e5c3246 JG	362
8e79b5cb JG	363	sector_div(ppa, geo->pgs_per_blk);
8e79b5cb JG	364	div_u64_rem(ppa, geo->blks_per_lun, &blks);
0e5c3246 JG	365	l.g.blk = blks;
0e5c3246 JG	366
8e79b5cb JG	367	sector_div(ppa, geo->blks_per_lun);
8e79b5cb JG	368	div_u64_rem(ppa, geo->luns_per_chnl, &luns);
0e5c3246 JG	369	l.g.lun = luns;
0e5c3246 JG	370
8e79b5cb	371	sector_div(ppa, geo->luns_per_chnl);
0e5c3246 JG	372	l.g.ch = ppa;
	373
	374	return l;
	375	}
	376
dab8ee9e MB	377	static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
dab8ee9e MB	378	struct ppa_addr r)
cd9e9808	379	{
dab8ee9e	380	struct nvm_geo *geo = &tgt_dev->geo;
cd9e9808 MB	381	struct ppa_addr l;
cd9e9808 MB	382
8e79b5cb JG	383	l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
	384	l.ppa \|= ((u64)r.g.pg) << geo->ppaf.pg_offset;
	385	l.ppa \|= ((u64)r.g.sec) << geo->ppaf.sect_offset;
	386	l.ppa \|= ((u64)r.g.pl) << geo->ppaf.pln_offset;
	387	l.ppa \|= ((u64)r.g.lun) << geo->ppaf.lun_offset;
	388	l.ppa \|= ((u64)r.g.ch) << geo->ppaf.ch_offset;
cd9e9808 MB	389
	390	return l;
	391	}
	392
dab8ee9e MB	393	static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
dab8ee9e MB	394	struct ppa_addr r)
cd9e9808	395	{
dab8ee9e	396	struct nvm_geo *geo = &tgt_dev->geo;
cd9e9808 MB	397	struct ppa_addr l;
cd9e9808 MB	398
5389a1df	399	l.ppa = 0;
7386af27 MB	400	/*
	401	* (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
	402	*/
8e79b5cb JG	403	l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
	404	(((1 << geo->ppaf.blk_len) - 1));
	405	l.g.pg \|= (r.ppa >> geo->ppaf.pg_offset) &
	406	(((1 << geo->ppaf.pg_len) - 1));
	407	l.g.sec \|= (r.ppa >> geo->ppaf.sect_offset) &
	408	(((1 << geo->ppaf.sect_len) - 1));
	409	l.g.pl \|= (r.ppa >> geo->ppaf.pln_offset) &
	410	(((1 << geo->ppaf.pln_len) - 1));
	411	l.g.lun \|= (r.ppa >> geo->ppaf.lun_offset) &
	412	(((1 << geo->ppaf.lun_len) - 1));
	413	l.g.ch \|= (r.ppa >> geo->ppaf.ch_offset) &
	414	(((1 << geo->ppaf.ch_len) - 1));
cd9e9808 MB	415
	416	return l;
	417	}
	418
cd9e9808 MB	419	static inline int ppa_empty(struct ppa_addr ppa_addr)
	420	{
	421	return (ppa_addr.ppa == ADDR_EMPTY);
	422	}
	423
	424	static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
	425	{
	426	ppa_addr->ppa = ADDR_EMPTY;
	427	}
	428
a24ba464 JG	429	static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
	430	{
	431	if (ppa_empty(ppa1) \|\| ppa_empty(ppa2))
	432	return 0;
	433
	434	return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
	435	(ppa1.g.blk == ppa2.g.blk));
	436	}
	437
dece1635	438	typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue , struct bio );
cd9e9808	439	typedef sector_t (nvm_tgt_capacity_fn)(void *);
4af3f75d JG	440	typedef void (nvm_tgt_init_fn)(struct nvm_tgt_dev , struct gendisk *,
4af3f75d JG	441	int flags);
cd9e9808	442	typedef void (nvm_tgt_exit_fn)(void *);
9a69b0ed JG	443	typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
9a69b0ed JG	444	typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);
cd9e9808 MB	445
	446	struct nvm_tgt_type {
	447	const char *name;
	448	unsigned int version[3];
	449
	450	/* target entry points */
	451	nvm_tgt_make_rq_fn *make_rq;
	452	nvm_tgt_capacity_fn *capacity;
cd9e9808 MB	453
	454	/* module-specific init/teardown */
	455	nvm_tgt_init_fn *init;
	456	nvm_tgt_exit_fn *exit;
	457
9a69b0ed JG	458	/* sysfs */
	459	nvm_tgt_sysfs_init_fn *sysfs_init;
	460	nvm_tgt_sysfs_exit_fn *sysfs_exit;
	461
cd9e9808 MB	462	/* For internal use */
	463	struct list_head list;
	464	};
	465
b76eb20b MB	466	extern struct nvm_tgt_type nvm_find_target_type(const char , int);
b76eb20b MB	467
6063fe39 SL	468	extern int nvm_register_tgt_type(struct nvm_tgt_type *);
6063fe39 SL	469	extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
cd9e9808 MB	470
	471	extern void nvm_dev_dma_alloc(struct nvm_dev , gfp_t, dma_addr_t *);
	472	extern void nvm_dev_dma_free(struct nvm_dev , void , dma_addr_t);
	473
b0b4e09c MB	474	extern struct nvm_dev *nvm_alloc_dev(int);
	475	extern int nvm_register(struct nvm_dev *);
	476	extern void nvm_unregister(struct nvm_dev *);
cd9e9808	477
333ba053 JG	478	extern int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev , struct ppa_addr ,
333ba053 JG	479	int, int);
a279006a	480	extern int nvm_max_phys_sects(struct nvm_tgt_dev *);
8e53624d	481	extern int nvm_submit_io(struct nvm_tgt_dev , struct nvm_rq );
17912c49 JG	482	extern int nvm_erase_sync(struct nvm_tgt_dev , struct ppa_addr , int);
17912c49 JG	483	extern int nvm_set_rqd_ppalist(struct nvm_tgt_dev , struct nvm_rq ,
8680f165	484	const struct ppa_addr *, int, int);
17912c49	485	extern void nvm_free_rqd_ppalist(struct nvm_tgt_dev , struct nvm_rq );
da2d7cb8	486	extern int nvm_get_l2p_tbl(struct nvm_tgt_dev , u64, u32, nvm_l2p_update_fn ,
8e53624d	487	void *);
da2d7cb8 JG	488	extern int nvm_get_area(struct nvm_tgt_dev , sector_t , sector_t);
da2d7cb8 JG	489	extern void nvm_put_area(struct nvm_tgt_dev *, sector_t);
06894efe	490	extern void nvm_end_io(struct nvm_rq *);
22e8c976	491	extern int nvm_bb_tbl_fold(struct nvm_dev , u8 , int);
333ba053	492	extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev , struct ppa_addr, u8 );
e3eb3799	493
8b4970c4	494	extern int nvm_dev_factory(struct nvm_dev *, int flags);
5136061c	495
ade69e24	496	extern void nvm_part_to_tgt(struct nvm_dev , sector_t , int);
5136061c	497
cd9e9808 MB	498	#else /* CONFIG_NVM */
	499	struct nvm_dev_ops;
	500
b0b4e09c MB	501	static inline struct nvm_dev *nvm_alloc_dev(int node)
	502	{
	503	return ERR_PTR(-EINVAL);
	504	}
	505	static inline int nvm_register(struct nvm_dev *dev)
cd9e9808 MB	506	{
	507	return -EINVAL;
	508	}
b0b4e09c	509	static inline void nvm_unregister(struct nvm_dev *dev) {}
cd9e9808 MB	510	#endif /* CONFIG_NVM */
cd9e9808 MB	511	#endif /* LIGHTNVM.H */