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

#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 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,
	NVM_RSP_ERR_FAILECC	= 0x4281,
	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_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_tgt_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_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;
};

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

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

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

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;

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

	/* System blocks */
	struct nvm_sb_info sb;

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

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_dev *dev,
						struct ppa_addr r)
{
	struct nvm_geo *geo = &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_dev *dev,
						struct ppa_addr r)
{
	struct nvm_geo *geo = &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));
}

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_tgt_dev *, struct gendisk *);
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 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);

typedef int (nvmm_register_fn)(struct nvm_dev *);
typedef void (nvmm_unregister_fn)(struct nvm_dev *);

typedef int (nvmm_create_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_create *);
typedef int (nvmm_remove_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_remove *);
typedef int (nvmm_submit_io_fn)(struct nvm_tgt_dev *, struct nvm_rq *);
typedef int (nvmm_erase_blk_fn)(struct nvm_tgt_dev *, struct ppa_addr *, int);
typedef int (nvmm_get_area_fn)(struct nvm_dev *, sector_t *, sector_t);
typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
typedef struct ppa_addr (nvmm_trans_ppa_fn)(struct nvm_tgt_dev *,
					    struct ppa_addr, int);
typedef void (nvmm_part_to_tgt_fn)(struct nvm_dev *, sector_t*, int);

enum {
	TRANS_TGT_TO_DEV =	0x0,
	TRANS_DEV_TO_TGT =	0x1,
};

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

	nvmm_register_fn *register_mgr;
	nvmm_unregister_fn *unregister_mgr;

	nvmm_create_tgt_fn *create_tgt;
	nvmm_remove_tgt_fn *remove_tgt;

	nvmm_submit_io_fn *submit_io;
	nvmm_erase_blk_fn *erase_blk;

	nvmm_get_area_fn *get_area;
	nvmm_put_area_fn *put_area;

	nvmm_trans_ppa_fn *trans_ppa;
	nvmm_part_to_tgt_fn *part_to_tgt;

	struct list_head list;
};

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

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_bb_tbl(struct nvm_dev *, struct ppa_addr *, int, int);
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 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 *,
					const 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, int);
extern int nvm_erase_blk(struct nvm_tgt_dev *, struct ppa_addr *, int);
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 *, 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 *);
extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_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(geo, ppa, chid, lunid)			\
	for ((chid) = 0, (ppa).ppa = 0; (chid) < (geo)->nr_chnls;	\
					(chid)++, (ppa).g.ch = (chid))	\
		for ((lunid) = 0; (lunid) < (geo)->luns_per_chnl;	\
					(lunid)++, (ppa).g.lun = (lunid))

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