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

#ifndef NVM_H
#define NVM_H

#include <linux/types.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;

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 int (nvm_erase_blk_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_erase_blk_fn	*erase_block;

	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,

	/* 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_DISABLE	= 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;
	u8	cgrps;
	u32	cap;
	u32	dom;
	struct nvm_addr_format ppaf;
	struct nvm_id_group groups[4];
} __packed;

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

struct nvm_tgt_instance {
	struct nvm_tgt_type *tt;
};

#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_instance *ins;
	struct nvm_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;
};

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;
}

struct nvm_block;

struct nvm_lun {
	int id;

	int lun_id;
	int chnl_id;

	/* It is up to the target to mark blocks as closed. If the target does
	 * not do it, all blocks are marked as open, and nr_open_blocks
	 * represents the number of blocks in use
	 */
	unsigned int nr_open_blocks;	/* Number of used, writable blocks */
	unsigned int nr_closed_blocks;	/* Number of used, read-only blocks */
	unsigned int nr_free_blocks;	/* Number of unused blocks */
	unsigned int nr_bad_blocks;	/* Number of bad blocks */

	spinlock_t lock;

	struct nvm_block *blocks;
};

enum {
	NVM_BLK_ST_FREE =	0x1,	/* Free block */
	NVM_BLK_ST_OPEN =	0x2,	/* Open block - read-write */
	NVM_BLK_ST_CLOSED =	0x4,	/* Closed block - read-only */
	NVM_BLK_ST_BAD =	0x8,	/* Bad block */
};

struct nvm_block {
	struct list_head list;
	struct nvm_lun *lun;
	unsigned long id;

	void *priv;
	int state;
};

/* system block cpu representation */
struct nvm_sb_info {
	unsigned long		seqnr;
	unsigned long		erase_cnt;
	unsigned int		version;
	char			mmtype[NVM_MMTYPE_LEN];
	struct ppa_addr		fs_ppa;
};

struct nvm_dev {
	struct nvm_dev_ops *ops;

	struct list_head devices;

	/* Media manager */
	struct nvmm_type *mt;
	void *mp;

	/* System blocks */
	struct nvm_sb_info sb;

	/* Device information */
	int nr_chnls;
	int nr_planes;
	int luns_per_chnl;
	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;

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

	unsigned long total_blocks;
	unsigned long total_secs;
	int nr_luns;

	unsigned long *lun_map;
	void *dma_pool;

	struct nvm_id identity;

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

	struct mutex mlock;
	spinlock_t lock;
};

static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
						struct ppa_addr r)
{
	struct ppa_addr l;

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

	return l;
}

static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
						struct ppa_addr r)
{
	struct ppa_addr l;

	/*
	 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
	 */
	l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
					(((1 << dev->ppaf.blk_len) - 1));
	l.g.pg |= (r.ppa >> dev->ppaf.pg_offset) &
					(((1 << dev->ppaf.pg_len) - 1));
	l.g.sec |= (r.ppa >> dev->ppaf.sect_offset) &
					(((1 << dev->ppaf.sect_len) - 1));
	l.g.pl |= (r.ppa >> dev->ppaf.pln_offset) &
					(((1 << dev->ppaf.pln_len) - 1));
	l.g.lun |= (r.ppa >> dev->ppaf.lun_offset) &
					(((1 << dev->ppaf.lun_len) - 1));
	l.g.ch |= (r.ppa >> dev->ppaf.ch_offset) &
					(((1 << dev->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 struct ppa_addr block_to_ppa(struct nvm_dev *dev,
							struct nvm_block *blk)
{
	struct ppa_addr ppa;
	struct nvm_lun *lun = blk->lun;

	ppa.ppa = 0;
	ppa.g.blk = blk->id % dev->blks_per_lun;
	ppa.g.lun = lun->lun_id;
	ppa.g.ch = lun->chnl_id;

	return ppa;
}

static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
{
	return dev->lptbl[slc_pg];
}

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_dev *, struct gendisk *, int, int);
typedef void (nvm_tgt_exit_fn)(void *);

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;
	nvm_end_io_fn *end_io;

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

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

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);

typedef int (nvmm_register_fn)(struct nvm_dev *);
typedef void (nvmm_unregister_fn)(struct nvm_dev *);
typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
					      struct nvm_lun *, unsigned long);
typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
								unsigned long);
typedef void (nvmm_mark_blk_fn)(struct nvm_dev *, struct ppa_addr, int);
typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
typedef int (nvmm_reserve_lun)(struct nvm_dev *, int);
typedef void (nvmm_release_lun)(struct nvm_dev *, int);
typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);

typedef int (nvmm_get_area_fn)(struct nvm_dev *, sector_t *, sector_t);
typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);

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

	nvmm_register_fn *register_mgr;
	nvmm_unregister_fn *unregister_mgr;

	/* Block administration callbacks */
	nvmm_get_blk_fn *get_blk_unlocked;
	nvmm_put_blk_fn *put_blk_unlocked;
	nvmm_get_blk_fn *get_blk;
	nvmm_put_blk_fn *put_blk;
	nvmm_open_blk_fn *open_blk;
	nvmm_close_blk_fn *close_blk;
	nvmm_flush_blk_fn *flush_blk;

	nvmm_submit_io_fn *submit_io;
	nvmm_erase_blk_fn *erase_blk;

	/* Bad block mgmt */
	nvmm_mark_blk_fn *mark_blk;

	/* Configuration management */
	nvmm_get_lun_fn *get_lun;
	nvmm_reserve_lun *reserve_lun;
	nvmm_release_lun *release_lun;

	/* Statistics */
	nvmm_lun_info_print_fn *lun_info_print;

	nvmm_get_area_fn *get_area;
	nvmm_put_area_fn *put_area;

	struct list_head list;
};

extern int nvm_register_mgr(struct nvmm_type *);
extern void nvm_unregister_mgr(struct nvmm_type *);

extern struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *,
					struct nvm_lun *, unsigned long);
extern void nvm_put_blk_unlocked(struct nvm_dev *, struct nvm_block *);

extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
								unsigned long);
extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);

extern int nvm_register(struct request_queue *, char *,
						struct nvm_dev_ops *);
extern void nvm_unregister(char *);

extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
						struct ppa_addr *, int, int);
extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int);
extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
extern void nvm_end_io(struct nvm_rq *, int);
extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
								void *, int);
extern int nvm_submit_ppa_list(struct nvm_dev *, struct ppa_addr *, int, int,
							int, void *, int);
extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
extern int nvm_get_bb_tbl(struct nvm_dev *, struct ppa_addr, u8 *);

/* sysblk.c */
#define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */

/* system block on disk representation */
struct nvm_system_block {
	__be32			magic;		/* magic signature */
	__be32			seqnr;		/* sequence number */
	__be32			erase_cnt;	/* erase count */
	__be16			version;	/* version number */
	u8			mmtype[NVM_MMTYPE_LEN]; /* media manager name */
	__be64			fs_ppa;		/* PPA for media manager
						 * superblock */
};

extern int nvm_get_sysblock(struct nvm_dev *, struct nvm_sb_info *);
extern int nvm_update_sysblock(struct nvm_dev *, struct nvm_sb_info *);
extern int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *);

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

#define nvm_for_each_lun_ppa(dev, ppa, chid, lunid)			\
	for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls;	\
					(chid)++, (ppa).g.ch = (chid))	\
		for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl;	\
					(lunid)++, (ppa).g.lun = (lunid))

#else /* CONFIG_NVM */
struct nvm_dev_ops;

static inline int nvm_register(struct request_queue *q, char *disk_name,
							struct nvm_dev_ops *ops)
{
	return -EINVAL;
}
static inline void nvm_unregister(char *disk_name) {}
#endif /* CONFIG_NVM */
#endif /* LIGHTNVM.H */
Commit	Line	Data
cd9e9808 MB	1	#ifndef NVM_H
	2	#define NVM_H
	3
a7fd9a4f JA	4	#include <linux/types.h>
a7fd9a4f JA	5
cd9e9808 MB	6	enum {
	7	NVM_IO_OK = 0,
	8	NVM_IO_REQUEUE = 1,
	9	NVM_IO_DONE = 2,
	10	NVM_IO_ERR = 3,
	11
	12	NVM_IOTYPE_NONE = 0,
	13	NVM_IOTYPE_GC = 1,
	14	};
	15
a7fd9a4f JA	16	#define NVM_BLK_BITS (16)
	17	#define NVM_PG_BITS (16)
	18	#define NVM_SEC_BITS (8)
	19	#define NVM_PL_BITS (8)
	20	#define NVM_LUN_BITS (8)
df414b33	21	#define NVM_CH_BITS (7)
a7fd9a4f JA	22
	23	struct ppa_addr {
	24	/* Generic structure for all addresses */
	25	union {
	26	struct {
	27	u64 blk : NVM_BLK_BITS;
	28	u64 pg : NVM_PG_BITS;
	29	u64 sec : NVM_SEC_BITS;
	30	u64 pl : NVM_PL_BITS;
	31	u64 lun : NVM_LUN_BITS;
	32	u64 ch : NVM_CH_BITS;
df414b33	33	u64 reserved : 1;
a7fd9a4f JA	34	} g;
a7fd9a4f JA	35
df414b33 MB	36	struct {
	37	u64 line : 63;
	38	u64 is_cached : 1;
	39	} c;
	40
a7fd9a4f JA	41	u64 ppa;
	42	};
	43	};
	44
	45	struct nvm_rq;
	46	struct nvm_id;
	47	struct nvm_dev;
	48
	49	typedef int (nvm_l2p_update_fn)(u64, u32, __le64 , void );
a7fd9a4f JA	50	typedef int (nvm_id_fn)(struct nvm_dev , struct nvm_id );
	51	typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
	52	nvm_l2p_update_fn , void );
e11903f5	53	typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev , struct ppa_addr, u8 );
00ee6cc3	54	typedef int (nvm_op_set_bb_fn)(struct nvm_dev , struct ppa_addr , int, int);
a7fd9a4f JA	55	typedef int (nvm_submit_io_fn)(struct nvm_dev , struct nvm_rq );
	56	typedef int (nvm_erase_blk_fn)(struct nvm_dev , struct nvm_rq );
	57	typedef void (nvm_create_dma_pool_fn)(struct nvm_dev , char *);
	58	typedef void (nvm_destroy_dma_pool_fn)(void *);
	59	typedef void (nvm_dev_dma_alloc_fn)(struct nvm_dev , void *, gfp_t,
	60	dma_addr_t *);
	61	typedef void (nvm_dev_dma_free_fn)(void , void, dma_addr_t);
	62
	63	struct nvm_dev_ops {
	64	nvm_id_fn *identity;
	65	nvm_get_l2p_tbl_fn *get_l2p_tbl;
	66	nvm_op_bb_tbl_fn *get_bb_tbl;
	67	nvm_op_set_bb_fn *set_bb_tbl;
	68
	69	nvm_submit_io_fn *submit_io;
	70	nvm_erase_blk_fn *erase_block;
	71
	72	nvm_create_dma_pool_fn *create_dma_pool;
	73	nvm_destroy_dma_pool_fn *destroy_dma_pool;
	74	nvm_dev_dma_alloc_fn *dev_dma_alloc;
	75	nvm_dev_dma_free_fn *dev_dma_free;
	76
	77	unsigned int max_phys_sect;
	78	};
	79
	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,
	108
	109	/* Device opcodes */
	110	NVM_OP_HBREAD = 0x02,
	111	NVM_OP_HBWRITE = 0x81,
	112	NVM_OP_PWRITE = 0x91,
	113	NVM_OP_PREAD = 0x92,
	114	NVM_OP_ERASE = 0x90,
	115
	116	/* PPA Command Flags */
	117	NVM_IO_SNGL_ACCESS = 0x0,
	118	NVM_IO_DUAL_ACCESS = 0x1,
	119	NVM_IO_QUAD_ACCESS = 0x2,
	120
57b4bd06	121	/* NAND Access Modes */
cd9e9808 MB	122	NVM_IO_SUSPEND = 0x80,
	123	NVM_IO_SLC_MODE = 0x100,
	124	NVM_IO_SCRAMBLE_DISABLE = 0x200,
57b4bd06 MB	125
	126	/* Block Types */
	127	NVM_BLK_T_FREE = 0x0,
	128	NVM_BLK_T_BAD = 0x1,
b5d4acd4 MB	129	NVM_BLK_T_GRWN_BAD = 0x2,
	130	NVM_BLK_T_DEV = 0x4,
	131	NVM_BLK_T_HOST = 0x8,
f9a99950 MB	132
	133	/* Memory capabilities */
	134	NVM_ID_CAP_SLC = 0x1,
	135	NVM_ID_CAP_CMD_SUSPEND = 0x2,
	136	NVM_ID_CAP_SCRAMBLE = 0x4,
	137	NVM_ID_CAP_ENCRYPT = 0x8,
ca5927e7 MB	138
	139	/* Memory types */
	140	NVM_ID_FMTYPE_SLC = 0,
	141	NVM_ID_FMTYPE_MLC = 1,
bf643185 MB	142
	143	/* Device capabilities */
	144	NVM_ID_DCAP_BBLKMGMT = 0x1,
	145	NVM_UD_DCAP_ECC = 0x2,
ca5927e7 MB	146	};
	147
	148	struct nvm_id_lp_mlc {
	149	u16 num_pairs;
	150	u8 pairs[886];
	151	};
	152
	153	struct nvm_id_lp_tbl {
	154	__u8 id[8];
	155	struct nvm_id_lp_mlc mlc;
cd9e9808 MB	156	};
	157
	158	struct nvm_id_group {
	159	u8 mtype;
	160	u8 fmtype;
cd9e9808 MB	161	u8 num_ch;
	162	u8 num_lun;
	163	u8 num_pln;
	164	u16 num_blk;
	165	u16 num_pg;
	166	u16 fpg_sz;
	167	u16 csecs;
	168	u16 sos;
	169	u32 trdt;
	170	u32 trdm;
	171	u32 tprt;
	172	u32 tprm;
	173	u32 tbet;
	174	u32 tbem;
	175	u32 mpos;
12be5edf	176	u32 mccap;
cd9e9808	177	u16 cpar;
ca5927e7 MB	178
ca5927e7 MB	179	struct nvm_id_lp_tbl lptbl;
73387e7b	180	};
cd9e9808 MB	181
	182	struct nvm_addr_format {
	183	u8 ch_offset;
	184	u8 ch_len;
	185	u8 lun_offset;
	186	u8 lun_len;
	187	u8 pln_offset;
	188	u8 pln_len;
	189	u8 blk_offset;
	190	u8 blk_len;
	191	u8 pg_offset;
	192	u8 pg_len;
	193	u8 sect_offset;
	194	u8 sect_len;
cd9e9808 MB	195	};
	196
	197	struct nvm_id {
	198	u8 ver_id;
	199	u8 vmnt;
	200	u8 cgrps;
cd9e9808 MB	201	u32 cap;
	202	u32 dom;
	203	struct nvm_addr_format ppaf;
cd9e9808 MB	204	struct nvm_id_group groups[4];
	205	} __packed;
	206
	207	struct nvm_target {
	208	struct list_head list;
976bdfca	209	struct nvm_dev *dev;
cd9e9808 MB	210	struct nvm_tgt_type *type;
	211	struct gendisk *disk;
	212	};
	213
	214	struct nvm_tgt_instance {
	215	struct nvm_tgt_type *tt;
	216	};
	217
	218	#define ADDR_EMPTY (~0ULL)
	219
	220	#define NVM_VERSION_MAJOR 1
	221	#define NVM_VERSION_MINOR 0
	222	#define NVM_VERSION_PATCH 0
	223
91276162	224	struct nvm_rq;
72d256ec	225	typedef void (nvm_end_io_fn)(struct nvm_rq *);
91276162	226
cd9e9808 MB	227	struct nvm_rq {
	228	struct nvm_tgt_instance *ins;
	229	struct nvm_dev *dev;
	230
	231	struct bio *bio;
	232
	233	union {
	234	struct ppa_addr ppa_addr;
	235	dma_addr_t dma_ppa_list;
	236	};
	237
	238	struct ppa_addr *ppa_list;
	239
003fad37 JG	240	void *meta_list;
003fad37 JG	241	dma_addr_t dma_meta_list;
cd9e9808	242
91276162 MB	243	struct completion *wait;
	244	nvm_end_io_fn *end_io;
	245
cd9e9808	246	uint8_t opcode;
6d5be959	247	uint16_t nr_ppas;
cd9e9808	248	uint16_t flags;
72d256ec	249
9f867268	250	u64 ppa_status; /* ppa media status */
72d256ec	251	int error;
cd9e9808 MB	252	};
	253
	254	static inline struct nvm_rq nvm_rq_from_pdu(void pdu)
	255	{
	256	return pdu - sizeof(struct nvm_rq);
	257	}
	258
	259	static inline void nvm_rq_to_pdu(struct nvm_rq rqdata)
	260	{
	261	return rqdata + 1;
	262	}
	263
	264	struct nvm_block;
	265
cd9e9808 MB	266	struct nvm_lun {
	267	int id;
	268
	269	int lun_id;
	270	int chnl_id;
	271
ff0e498b JG	272	/* It is up to the target to mark blocks as closed. If the target does
	273	* not do it, all blocks are marked as open, and nr_open_blocks
	274	* represents the number of blocks in use
	275	*/
	276	unsigned int nr_open_blocks; /* Number of used, writable blocks */
	277	unsigned int nr_closed_blocks; /* Number of used, read-only blocks */
cd9e9808	278	unsigned int nr_free_blocks; /* Number of unused blocks */
0b59733b	279	unsigned int nr_bad_blocks; /* Number of bad blocks */
cd9e9808 MB	280
cd9e9808 MB	281	spinlock_t lock;
ff0e498b JG	282
	283	struct nvm_block *blocks;
	284	};
	285
	286	enum {
	287	NVM_BLK_ST_FREE = 0x1, /* Free block */
	288	NVM_BLK_ST_OPEN = 0x2, /* Open block - read-write */
	289	NVM_BLK_ST_CLOSED = 0x4, /* Closed block - read-only */
	290	NVM_BLK_ST_BAD = 0x8, /* Bad block */
cd9e9808 MB	291	};
	292
	293	struct nvm_block {
	294	struct list_head list;
	295	struct nvm_lun *lun;
	296	unsigned long id;
	297
	298	void *priv;
ff0e498b	299	int state;
cd9e9808 MB	300	};
cd9e9808 MB	301
e3eb3799 MB	302	/* system block cpu representation */
	303	struct nvm_sb_info {
	304	unsigned long seqnr;
	305	unsigned long erase_cnt;
	306	unsigned int version;
	307	char mmtype[NVM_MMTYPE_LEN];
	308	struct ppa_addr fs_ppa;
	309	};
	310
cd9e9808 MB	311	struct nvm_dev {
	312	struct nvm_dev_ops *ops;
	313
	314	struct list_head devices;
cd9e9808 MB	315
	316	/* Media manager */
	317	struct nvmm_type *mt;
	318	void *mp;
	319
b7692076 MB	320	/* System blocks */
	321	struct nvm_sb_info sb;
	322
cd9e9808 MB	323	/* Device information */
	324	int nr_chnls;
	325	int nr_planes;
	326	int luns_per_chnl;
	327	int sec_per_pg; /* only sectors for a single page */
	328	int pgs_per_blk;
	329	int blks_per_lun;
4891d120 MB	330	int fpg_size;
4891d120 MB	331	int pfpg_size; /* size of buffer if all pages are to be read */
cd9e9808 MB	332	int sec_size;
cd9e9808 MB	333	int oob_size;
f9a99950	334	int mccap;
7386af27	335	struct nvm_addr_format ppaf;
cd9e9808 MB	336
	337	/* Calculated/Cached values. These do not reflect the actual usable
	338	* blocks at run-time.
	339	*/
	340	int max_rq_size;
	341	int plane_mode; /* drive device in single, double or quad mode */
	342
	343	int sec_per_pl; /* all sectors across planes */
	344	int sec_per_blk;
	345	int sec_per_lun;
	346
ca5927e7 MB	347	/* lower page table */
	348	int lps_per_blk;
	349	int *lptbl;
	350
cd9e9808	351	unsigned long total_blocks;
4ece44af	352	unsigned long total_secs;
cd9e9808	353	int nr_luns;
cd9e9808	354
da1e2849	355	unsigned long *lun_map;
75b85649	356	void *dma_pool;
cd9e9808 MB	357
	358	struct nvm_id identity;
	359
	360	/* Backend device */
	361	struct request_queue *q;
	362	char name[DISK_NAME_LEN];
e3eb3799 MB	363
e3eb3799 MB	364	struct mutex mlock;
4c9dacb8	365	spinlock_t lock;
cd9e9808 MB	366	};
cd9e9808 MB	367
7386af27 MB	368	static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
7386af27 MB	369	struct ppa_addr r)
cd9e9808 MB	370	{
	371	struct ppa_addr l;
	372
7386af27 MB	373	l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
	374	l.ppa \|= ((u64)r.g.pg) << dev->ppaf.pg_offset;
	375	l.ppa \|= ((u64)r.g.sec) << dev->ppaf.sect_offset;
	376	l.ppa \|= ((u64)r.g.pl) << dev->ppaf.pln_offset;
	377	l.ppa \|= ((u64)r.g.lun) << dev->ppaf.lun_offset;
	378	l.ppa \|= ((u64)r.g.ch) << dev->ppaf.ch_offset;
cd9e9808 MB	379
	380	return l;
	381	}
	382
7386af27 MB	383	static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
7386af27 MB	384	struct ppa_addr r)
cd9e9808 MB	385	{
	386	struct ppa_addr l;
	387
7386af27 MB	388	/*
	389	* (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
	390	*/
	391	l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
	392	(((1 << dev->ppaf.blk_len) - 1));
	393	l.g.pg \|= (r.ppa >> dev->ppaf.pg_offset) &
	394	(((1 << dev->ppaf.pg_len) - 1));
	395	l.g.sec \|= (r.ppa >> dev->ppaf.sect_offset) &
	396	(((1 << dev->ppaf.sect_len) - 1));
	397	l.g.pl \|= (r.ppa >> dev->ppaf.pln_offset) &
	398	(((1 << dev->ppaf.pln_len) - 1));
	399	l.g.lun \|= (r.ppa >> dev->ppaf.lun_offset) &
	400	(((1 << dev->ppaf.lun_len) - 1));
	401	l.g.ch \|= (r.ppa >> dev->ppaf.ch_offset) &
	402	(((1 << dev->ppaf.ch_len) - 1));
cd9e9808 MB	403
	404	return l;
	405	}
	406
cd9e9808 MB	407	static inline int ppa_empty(struct ppa_addr ppa_addr)
	408	{
	409	return (ppa_addr.ppa == ADDR_EMPTY);
	410	}
	411
	412	static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
	413	{
	414	ppa_addr->ppa = ADDR_EMPTY;
	415	}
	416
	417	static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
	418	struct nvm_block *blk)
	419	{
	420	struct ppa_addr ppa;
	421	struct nvm_lun *lun = blk->lun;
	422
	423	ppa.ppa = 0;
	424	ppa.g.blk = blk->id % dev->blks_per_lun;
	425	ppa.g.lun = lun->lun_id;
	426	ppa.g.ch = lun->chnl_id;
	427
	428	return ppa;
	429	}
	430
e3eb3799 MB	431	static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
	432	{
	433	return dev->lptbl[slc_pg];
	434	}
	435
dece1635	436	typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue , struct bio );
cd9e9808	437	typedef sector_t (nvm_tgt_capacity_fn)(void *);
cd9e9808 MB	438	typedef void (nvm_tgt_init_fn)(struct nvm_dev , struct gendisk *, int, int);
	439	typedef void (nvm_tgt_exit_fn)(void *);
	440
	441	struct nvm_tgt_type {
	442	const char *name;
	443	unsigned int version[3];
	444
	445	/* target entry points */
	446	nvm_tgt_make_rq_fn *make_rq;
	447	nvm_tgt_capacity_fn *capacity;
91276162	448	nvm_end_io_fn *end_io;
cd9e9808 MB	449
	450	/* module-specific init/teardown */
	451	nvm_tgt_init_fn *init;
	452	nvm_tgt_exit_fn *exit;
	453
	454	/* For internal use */
	455	struct list_head list;
	456	};
	457
6063fe39 SL	458	extern int nvm_register_tgt_type(struct nvm_tgt_type *);
6063fe39 SL	459	extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
cd9e9808 MB	460
	461	extern void nvm_dev_dma_alloc(struct nvm_dev , gfp_t, dma_addr_t *);
	462	extern void nvm_dev_dma_free(struct nvm_dev , void , dma_addr_t);
	463
	464	typedef int (nvmm_register_fn)(struct nvm_dev *);
	465	typedef void (nvmm_unregister_fn)(struct nvm_dev *);
	466	typedef struct nvm_block (nvmm_get_blk_fn)(struct nvm_dev ,
	467	struct nvm_lun *, unsigned long);
	468	typedef void (nvmm_put_blk_fn)(struct nvm_dev , struct nvm_block );
	469	typedef int (nvmm_open_blk_fn)(struct nvm_dev , struct nvm_block );
	470	typedef int (nvmm_close_blk_fn)(struct nvm_dev , struct nvm_block );
	471	typedef void (nvmm_flush_blk_fn)(struct nvm_dev , struct nvm_block );
	472	typedef int (nvmm_submit_io_fn)(struct nvm_dev , struct nvm_rq );
cd9e9808 MB	473	typedef int (nvmm_erase_blk_fn)(struct nvm_dev , struct nvm_block ,
cd9e9808 MB	474	unsigned long);
04a8aa17	475	typedef void (nvmm_mark_blk_fn)(struct nvm_dev *, struct ppa_addr, int);
cd9e9808	476	typedef struct nvm_lun (nvmm_get_lun_fn)(struct nvm_dev , int);
da1e2849 WT	477	typedef int (nvmm_reserve_lun)(struct nvm_dev *, int);
da1e2849 WT	478	typedef void (nvmm_release_lun)(struct nvm_dev *, int);
2fde0e48	479	typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
cd9e9808	480
4c9dacb8 WT	481	typedef int (nvmm_get_area_fn)(struct nvm_dev , sector_t , sector_t);
	482	typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
	483
cd9e9808 MB	484	struct nvmm_type {
	485	const char *name;
	486	unsigned int version[3];
	487
	488	nvmm_register_fn *register_mgr;
	489	nvmm_unregister_fn *unregister_mgr;
	490
	491	/* Block administration callbacks */
ff0e498b JG	492	nvmm_get_blk_fn *get_blk_unlocked;
ff0e498b JG	493	nvmm_put_blk_fn *put_blk_unlocked;
cd9e9808 MB	494	nvmm_get_blk_fn *get_blk;
	495	nvmm_put_blk_fn *put_blk;
	496	nvmm_open_blk_fn *open_blk;
	497	nvmm_close_blk_fn *close_blk;
	498	nvmm_flush_blk_fn *flush_blk;
	499
	500	nvmm_submit_io_fn *submit_io;
cd9e9808 MB	501	nvmm_erase_blk_fn *erase_blk;
cd9e9808 MB	502
04a8aa17 MB	503	/* Bad block mgmt */
	504	nvmm_mark_blk_fn *mark_blk;
	505
cd9e9808 MB	506	/* Configuration management */
cd9e9808 MB	507	nvmm_get_lun_fn *get_lun;
da1e2849 WT	508	nvmm_reserve_lun *reserve_lun;
da1e2849 WT	509	nvmm_release_lun *release_lun;
cd9e9808 MB	510
cd9e9808 MB	511	/* Statistics */
2fde0e48	512	nvmm_lun_info_print_fn *lun_info_print;
4c9dacb8 WT	513
	514	nvmm_get_area_fn *get_area;
	515	nvmm_put_area_fn *put_area;
	516
cd9e9808 MB	517	struct list_head list;
	518	};
	519
	520	extern int nvm_register_mgr(struct nvmm_type *);
	521	extern void nvm_unregister_mgr(struct nvmm_type *);
	522
ff0e498b JG	523	extern struct nvm_block nvm_get_blk_unlocked(struct nvm_dev ,
	524	struct nvm_lun *, unsigned long);
	525	extern void nvm_put_blk_unlocked(struct nvm_dev , struct nvm_block );
	526
cd9e9808 MB	527	extern struct nvm_block nvm_get_blk(struct nvm_dev , struct nvm_lun *,
	528	unsigned long);
	529	extern void nvm_put_blk(struct nvm_dev , struct nvm_block );
	530
	531	extern int nvm_register(struct request_queue , char ,
	532	struct nvm_dev_ops *);
	533	extern void nvm_unregister(char *);
	534
	535	extern int nvm_submit_io(struct nvm_dev , struct nvm_rq );
069368e9 MB	536	extern void nvm_generic_to_addr_mode(struct nvm_dev , struct nvm_rq );
069368e9 MB	537	extern void nvm_addr_to_generic_mode(struct nvm_dev , struct nvm_rq );
abd805ec	538	extern int nvm_set_rqd_ppalist(struct nvm_dev , struct nvm_rq ,
5ebc7d9f	539	struct ppa_addr *, int, int);
abd805ec	540	extern void nvm_free_rqd_ppalist(struct nvm_dev , struct nvm_rq );
81e681d3	541	extern int nvm_erase_ppa(struct nvm_dev , struct ppa_addr , int);
cd9e9808	542	extern int nvm_erase_blk(struct nvm_dev , struct nvm_block );
91276162	543	extern void nvm_end_io(struct nvm_rq *, int);
09719b62 MB	544	extern int nvm_submit_ppa(struct nvm_dev , struct ppa_addr , int, int, int,
09719b62 MB	545	void *, int);
1145e635 MB	546	extern int nvm_submit_ppa_list(struct nvm_dev , struct ppa_addr , int, int,
1145e635 MB	547	int, void *, int);
22e8c976	548	extern int nvm_bb_tbl_fold(struct nvm_dev , u8 , int);
e11903f5	549	extern int nvm_get_bb_tbl(struct nvm_dev , struct ppa_addr, u8 );
e3eb3799 MB	550
	551	/* sysblk.c */
	552	#define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
	553
	554	/* system block on disk representation */
	555	struct nvm_system_block {
	556	__be32 magic; /* magic signature */
	557	__be32 seqnr; /* sequence number */
	558	__be32 erase_cnt; /* erase count */
	559	__be16 version; /* version number */
	560	u8 mmtype[NVM_MMTYPE_LEN]; /* media manager name */
	561	__be64 fs_ppa; /* PPA for media manager
	562	* superblock */
	563	};
	564
	565	extern int nvm_get_sysblock(struct nvm_dev , struct nvm_sb_info );
	566	extern int nvm_update_sysblock(struct nvm_dev , struct nvm_sb_info );
	567	extern int nvm_init_sysblock(struct nvm_dev , struct nvm_sb_info );
8b4970c4 MB	568
8b4970c4 MB	569	extern int nvm_dev_factory(struct nvm_dev *, int flags);
5136061c MB	570
	571	#define nvm_for_each_lun_ppa(dev, ppa, chid, lunid) \
	572	for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls; \
	573	(chid)++, (ppa).g.ch = (chid)) \
	574	for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl; \
	575	(lunid)++, (ppa).g.lun = (lunid))
	576
cd9e9808 MB	577	#else /* CONFIG_NVM */
	578	struct nvm_dev_ops;
	579
	580	static inline int nvm_register(struct request_queue q, char disk_name,
	581	struct nvm_dev_ops *ops)
	582	{
	583	return -EINVAL;
	584	}
	585	static inline void nvm_unregister(char *disk_name) {}
	586	#endif /* CONFIG_NVM */
	587	#endif /* LIGHTNVM.H */