[linux-2.6-block.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;

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;

	spinlock_t lock;

	unsigned int nr_free_blocks;	/* Number of unused blocks */
	struct nvm_block *blocks;
};

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

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;

	l.ppa = 0;
	/*
	 * (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 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 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;

	nvmm_create_tgt_fn *create_tgt;
	nvmm_remove_tgt_fn *remove_tgt;

	/* Block administration callbacks */
	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(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 *);

void nvm_mark_blk(struct nvm_dev *dev, struct ppa_addr ppa, int type);

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 *,
					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);
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
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;
	50
	51	typedef int (nvm_l2p_update_fn)(u64, u32, __le64 , void );
a7fd9a4f JA	52	typedef int (nvm_id_fn)(struct nvm_dev , struct nvm_id );
	53	typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
	54	nvm_l2p_update_fn , void );
e11903f5	55	typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev , struct ppa_addr, u8 );
00ee6cc3	56	typedef int (nvm_op_set_bb_fn)(struct nvm_dev , struct ppa_addr , int, int);
a7fd9a4f JA	57	typedef int (nvm_submit_io_fn)(struct nvm_dev , struct nvm_rq );
	58	typedef int (nvm_erase_blk_fn)(struct nvm_dev , struct nvm_rq );
	59	typedef void (nvm_create_dma_pool_fn)(struct nvm_dev , char *);
	60	typedef void (nvm_destroy_dma_pool_fn)(void *);
	61	typedef void (nvm_dev_dma_alloc_fn)(struct nvm_dev , void *, gfp_t,
	62	dma_addr_t *);
	63	typedef void (nvm_dev_dma_free_fn)(void , void, dma_addr_t);
	64
	65	struct nvm_dev_ops {
	66	nvm_id_fn *identity;
	67	nvm_get_l2p_tbl_fn *get_l2p_tbl;
	68	nvm_op_bb_tbl_fn *get_bb_tbl;
	69	nvm_op_set_bb_fn *set_bb_tbl;
	70
	71	nvm_submit_io_fn *submit_io;
	72	nvm_erase_blk_fn *erase_block;
	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
	82
	83
cd9e9808 MB	84	#ifdef CONFIG_NVM
	85
	86	#include <linux/blkdev.h>
cd9e9808 MB	87	#include <linux/file.h>
cd9e9808 MB	88	#include <linux/dmapool.h>
e3eb3799	89	#include <uapi/linux/lightnvm.h>
cd9e9808 MB	90
	91	enum {
	92	/* HW Responsibilities */
	93	NVM_RSP_L2P = 1 << 0,
	94	NVM_RSP_ECC = 1 << 1,
	95
	96	/* Physical Adressing Mode */
	97	NVM_ADDRMODE_LINEAR = 0,
	98	NVM_ADDRMODE_CHANNEL = 1,
	99
	100	/* Plane programming mode for LUN */
d5bdec8d MB	101	NVM_PLANE_SINGLE = 1,
	102	NVM_PLANE_DOUBLE = 2,
	103	NVM_PLANE_QUAD = 4,
cd9e9808 MB	104
	105	/* Status codes */
	106	NVM_RSP_SUCCESS = 0x0,
	107	NVM_RSP_NOT_CHANGEABLE = 0x1,
	108	NVM_RSP_ERR_FAILWRITE = 0x40ff,
	109	NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
	110
	111	/* Device opcodes */
	112	NVM_OP_HBREAD = 0x02,
	113	NVM_OP_HBWRITE = 0x81,
	114	NVM_OP_PWRITE = 0x91,
	115	NVM_OP_PREAD = 0x92,
	116	NVM_OP_ERASE = 0x90,
	117
	118	/* PPA Command Flags */
	119	NVM_IO_SNGL_ACCESS = 0x0,
	120	NVM_IO_DUAL_ACCESS = 0x1,
	121	NVM_IO_QUAD_ACCESS = 0x2,
	122
57b4bd06	123	/* NAND Access Modes */
cd9e9808 MB	124	NVM_IO_SUSPEND = 0x80,
	125	NVM_IO_SLC_MODE = 0x100,
	126	NVM_IO_SCRAMBLE_DISABLE = 0x200,
57b4bd06 MB	127
	128	/* Block Types */
	129	NVM_BLK_T_FREE = 0x0,
	130	NVM_BLK_T_BAD = 0x1,
b5d4acd4 MB	131	NVM_BLK_T_GRWN_BAD = 0x2,
	132	NVM_BLK_T_DEV = 0x4,
	133	NVM_BLK_T_HOST = 0x8,
f9a99950 MB	134
	135	/* Memory capabilities */
	136	NVM_ID_CAP_SLC = 0x1,
	137	NVM_ID_CAP_CMD_SUSPEND = 0x2,
	138	NVM_ID_CAP_SCRAMBLE = 0x4,
	139	NVM_ID_CAP_ENCRYPT = 0x8,
ca5927e7 MB	140
	141	/* Memory types */
	142	NVM_ID_FMTYPE_SLC = 0,
	143	NVM_ID_FMTYPE_MLC = 1,
bf643185 MB	144
	145	/* Device capabilities */
	146	NVM_ID_DCAP_BBLKMGMT = 0x1,
	147	NVM_UD_DCAP_ECC = 0x2,
ca5927e7 MB	148	};
	149
	150	struct nvm_id_lp_mlc {
	151	u16 num_pairs;
	152	u8 pairs[886];
	153	};
	154
	155	struct nvm_id_lp_tbl {
	156	__u8 id[8];
	157	struct nvm_id_lp_mlc mlc;
cd9e9808 MB	158	};
	159
	160	struct nvm_id_group {
	161	u8 mtype;
	162	u8 fmtype;
cd9e9808 MB	163	u8 num_ch;
	164	u8 num_lun;
	165	u8 num_pln;
	166	u16 num_blk;
	167	u16 num_pg;
	168	u16 fpg_sz;
	169	u16 csecs;
	170	u16 sos;
	171	u32 trdt;
	172	u32 trdm;
	173	u32 tprt;
	174	u32 tprm;
	175	u32 tbet;
	176	u32 tbem;
	177	u32 mpos;
12be5edf	178	u32 mccap;
cd9e9808	179	u16 cpar;
ca5927e7 MB	180
ca5927e7 MB	181	struct nvm_id_lp_tbl lptbl;
73387e7b	182	};
cd9e9808 MB	183
	184	struct nvm_addr_format {
	185	u8 ch_offset;
	186	u8 ch_len;
	187	u8 lun_offset;
	188	u8 lun_len;
	189	u8 pln_offset;
	190	u8 pln_len;
	191	u8 blk_offset;
	192	u8 blk_len;
	193	u8 pg_offset;
	194	u8 pg_len;
	195	u8 sect_offset;
	196	u8 sect_len;
cd9e9808 MB	197	};
	198
	199	struct nvm_id {
	200	u8 ver_id;
	201	u8 vmnt;
	202	u8 cgrps;
cd9e9808 MB	203	u32 cap;
	204	u32 dom;
	205	struct nvm_addr_format ppaf;
cd9e9808 MB	206	struct nvm_id_group groups[4];
	207	} __packed;
	208
	209	struct nvm_target {
	210	struct list_head list;
976bdfca	211	struct nvm_dev *dev;
cd9e9808 MB	212	struct nvm_tgt_type *type;
	213	struct gendisk *disk;
	214	};
	215
	216	struct nvm_tgt_instance {
	217	struct nvm_tgt_type *tt;
	218	};
	219
	220	#define ADDR_EMPTY (~0ULL)
	221
	222	#define NVM_VERSION_MAJOR 1
	223	#define NVM_VERSION_MINOR 0
	224	#define NVM_VERSION_PATCH 0
	225
91276162	226	struct nvm_rq;
72d256ec	227	typedef void (nvm_end_io_fn)(struct nvm_rq *);
91276162	228
cd9e9808 MB	229	struct nvm_rq {
	230	struct nvm_tgt_instance *ins;
	231	struct nvm_dev *dev;
	232
	233	struct bio *bio;
	234
	235	union {
	236	struct ppa_addr ppa_addr;
	237	dma_addr_t dma_ppa_list;
	238	};
	239
	240	struct ppa_addr *ppa_list;
	241
003fad37 JG	242	void *meta_list;
003fad37 JG	243	dma_addr_t dma_meta_list;
cd9e9808	244
91276162 MB	245	struct completion *wait;
	246	nvm_end_io_fn *end_io;
	247
cd9e9808	248	uint8_t opcode;
6d5be959	249	uint16_t nr_ppas;
cd9e9808	250	uint16_t flags;
72d256ec	251
9f867268	252	u64 ppa_status; /* ppa media status */
72d256ec	253	int error;
cd9e9808 MB	254	};
	255
	256	static inline struct nvm_rq nvm_rq_from_pdu(void pdu)
	257	{
	258	return pdu - sizeof(struct nvm_rq);
	259	}
	260
	261	static inline void nvm_rq_to_pdu(struct nvm_rq rqdata)
	262	{
	263	return rqdata + 1;
	264	}
	265
	266	struct nvm_block;
	267
cd9e9808 MB	268	struct nvm_lun {
	269	int id;
	270
	271	int lun_id;
	272	int chnl_id;
	273
cd9e9808	274	spinlock_t lock;
ff0e498b	275
077d2389	276	unsigned int nr_free_blocks; /* Number of unused blocks */
ff0e498b JG	277	struct nvm_block *blocks;
	278	};
	279
	280	enum {
	281	NVM_BLK_ST_FREE = 0x1, /* Free block */
077d2389	282	NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
ff0e498b	283	NVM_BLK_ST_BAD = 0x8, /* Bad block */
cd9e9808 MB	284	};
	285
	286	struct nvm_block {
	287	struct list_head list;
	288	struct nvm_lun *lun;
	289	unsigned long id;
	290
	291	void *priv;
ff0e498b	292	int state;
cd9e9808 MB	293	};
cd9e9808 MB	294
e3eb3799 MB	295	/* system block cpu representation */
	296	struct nvm_sb_info {
	297	unsigned long seqnr;
	298	unsigned long erase_cnt;
	299	unsigned int version;
	300	char mmtype[NVM_MMTYPE_LEN];
	301	struct ppa_addr fs_ppa;
	302	};
	303
cd9e9808 MB	304	struct nvm_dev {
	305	struct nvm_dev_ops *ops;
	306
	307	struct list_head devices;
cd9e9808 MB	308
	309	/* Media manager */
	310	struct nvmm_type *mt;
	311	void *mp;
	312
b7692076 MB	313	/* System blocks */
	314	struct nvm_sb_info sb;
	315
cd9e9808 MB	316	/* Device information */
	317	int nr_chnls;
	318	int nr_planes;
	319	int luns_per_chnl;
	320	int sec_per_pg; /* only sectors for a single page */
	321	int pgs_per_blk;
	322	int blks_per_lun;
4891d120 MB	323	int fpg_size;
4891d120 MB	324	int pfpg_size; /* size of buffer if all pages are to be read */
cd9e9808 MB	325	int sec_size;
cd9e9808 MB	326	int oob_size;
f9a99950	327	int mccap;
7386af27	328	struct nvm_addr_format ppaf;
cd9e9808 MB	329
	330	/* Calculated/Cached values. These do not reflect the actual usable
	331	* blocks at run-time.
	332	*/
	333	int max_rq_size;
	334	int plane_mode; /* drive device in single, double or quad mode */
	335
	336	int sec_per_pl; /* all sectors across planes */
	337	int sec_per_blk;
	338	int sec_per_lun;
	339
ca5927e7 MB	340	/* lower page table */
	341	int lps_per_blk;
	342	int *lptbl;
	343
cd9e9808	344	unsigned long total_blocks;
4ece44af	345	unsigned long total_secs;
cd9e9808	346	int nr_luns;
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];
e3eb3799 MB	356
e3eb3799 MB	357	struct mutex mlock;
4c9dacb8	358	spinlock_t lock;
cd9e9808 MB	359	};
cd9e9808 MB	360
7386af27 MB	361	static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
7386af27 MB	362	struct ppa_addr r)
cd9e9808 MB	363	{
	364	struct ppa_addr l;
	365
7386af27 MB	366	l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
	367	l.ppa \|= ((u64)r.g.pg) << dev->ppaf.pg_offset;
	368	l.ppa \|= ((u64)r.g.sec) << dev->ppaf.sect_offset;
	369	l.ppa \|= ((u64)r.g.pl) << dev->ppaf.pln_offset;
	370	l.ppa \|= ((u64)r.g.lun) << dev->ppaf.lun_offset;
	371	l.ppa \|= ((u64)r.g.ch) << dev->ppaf.ch_offset;
cd9e9808 MB	372
	373	return l;
	374	}
	375
7386af27 MB	376	static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
7386af27 MB	377	struct ppa_addr r)
cd9e9808 MB	378	{
	379	struct ppa_addr l;
	380
5389a1df	381	l.ppa = 0;
7386af27 MB	382	/*
	383	* (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
	384	*/
	385	l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
	386	(((1 << dev->ppaf.blk_len) - 1));
	387	l.g.pg \|= (r.ppa >> dev->ppaf.pg_offset) &
	388	(((1 << dev->ppaf.pg_len) - 1));
	389	l.g.sec \|= (r.ppa >> dev->ppaf.sect_offset) &
	390	(((1 << dev->ppaf.sect_len) - 1));
	391	l.g.pl \|= (r.ppa >> dev->ppaf.pln_offset) &
	392	(((1 << dev->ppaf.pln_len) - 1));
	393	l.g.lun \|= (r.ppa >> dev->ppaf.lun_offset) &
	394	(((1 << dev->ppaf.lun_len) - 1));
	395	l.g.ch \|= (r.ppa >> dev->ppaf.ch_offset) &
	396	(((1 << dev->ppaf.ch_len) - 1));
cd9e9808 MB	397
	398	return l;
	399	}
	400
cd9e9808 MB	401	static inline int ppa_empty(struct ppa_addr ppa_addr)
	402	{
	403	return (ppa_addr.ppa == ADDR_EMPTY);
	404	}
	405
	406	static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
	407	{
	408	ppa_addr->ppa = ADDR_EMPTY;
	409	}
	410
	411	static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
	412	struct nvm_block *blk)
	413	{
	414	struct ppa_addr ppa;
	415	struct nvm_lun *lun = blk->lun;
	416
	417	ppa.ppa = 0;
	418	ppa.g.blk = blk->id % dev->blks_per_lun;
	419	ppa.g.lun = lun->lun_id;
	420	ppa.g.ch = lun->chnl_id;
	421
	422	return ppa;
	423	}
	424
e3eb3799 MB	425	static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
	426	{
	427	return dev->lptbl[slc_pg];
	428	}
	429
dece1635	430	typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue , struct bio );
cd9e9808	431	typedef sector_t (nvm_tgt_capacity_fn)(void *);
cd9e9808 MB	432	typedef void (nvm_tgt_init_fn)(struct nvm_dev , struct gendisk *, int, int);
	433	typedef void (nvm_tgt_exit_fn)(void *);
	434
	435	struct nvm_tgt_type {
	436	const char *name;
	437	unsigned int version[3];
	438
	439	/* target entry points */
	440	nvm_tgt_make_rq_fn *make_rq;
	441	nvm_tgt_capacity_fn *capacity;
91276162	442	nvm_end_io_fn *end_io;
cd9e9808 MB	443
	444	/* module-specific init/teardown */
	445	nvm_tgt_init_fn *init;
	446	nvm_tgt_exit_fn *exit;
	447
	448	/* For internal use */
	449	struct list_head list;
	450	};
	451
b76eb20b MB	452	extern struct nvm_tgt_type nvm_find_target_type(const char , int);
b76eb20b MB	453
6063fe39 SL	454	extern int nvm_register_tgt_type(struct nvm_tgt_type *);
6063fe39 SL	455	extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
cd9e9808 MB	456
	457	extern void nvm_dev_dma_alloc(struct nvm_dev , gfp_t, dma_addr_t *);
	458	extern void nvm_dev_dma_free(struct nvm_dev , void , dma_addr_t);
	459
	460	typedef int (nvmm_register_fn)(struct nvm_dev *);
	461	typedef void (nvmm_unregister_fn)(struct nvm_dev *);
b76eb20b MB	462
	463	typedef int (nvmm_create_tgt_fn)(struct nvm_dev , struct nvm_ioctl_create );
	464	typedef int (nvmm_remove_tgt_fn)(struct nvm_dev , struct nvm_ioctl_remove );
cd9e9808 MB	465	typedef struct nvm_block (nvmm_get_blk_fn)(struct nvm_dev ,
	466	struct nvm_lun *, unsigned long);
	467	typedef void (nvmm_put_blk_fn)(struct nvm_dev , struct nvm_block );
	468	typedef int (nvmm_open_blk_fn)(struct nvm_dev , struct nvm_block );
	469	typedef int (nvmm_close_blk_fn)(struct nvm_dev , struct nvm_block );
	470	typedef void (nvmm_flush_blk_fn)(struct nvm_dev , struct nvm_block );
	471	typedef int (nvmm_submit_io_fn)(struct nvm_dev , struct nvm_rq );
cd9e9808 MB	472	typedef int (nvmm_erase_blk_fn)(struct nvm_dev , struct nvm_block ,
cd9e9808 MB	473	unsigned long);
04a8aa17	474	typedef void (nvmm_mark_blk_fn)(struct nvm_dev *, struct ppa_addr, int);
cd9e9808	475	typedef struct nvm_lun (nvmm_get_lun_fn)(struct nvm_dev , int);
da1e2849 WT	476	typedef int (nvmm_reserve_lun)(struct nvm_dev *, int);
da1e2849 WT	477	typedef void (nvmm_release_lun)(struct nvm_dev *, int);
2fde0e48	478	typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
cd9e9808	479
4c9dacb8 WT	480	typedef int (nvmm_get_area_fn)(struct nvm_dev , sector_t , sector_t);
	481	typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
	482
cd9e9808 MB	483	struct nvmm_type {
	484	const char *name;
	485	unsigned int version[3];
	486
	487	nvmm_register_fn *register_mgr;
	488	nvmm_unregister_fn *unregister_mgr;
	489
b76eb20b MB	490	nvmm_create_tgt_fn *create_tgt;
	491	nvmm_remove_tgt_fn *remove_tgt;
	492
cd9e9808 MB	493	/* Block administration callbacks */
	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
	523	extern struct nvm_block nvm_get_blk(struct nvm_dev , struct nvm_lun *,
	524	unsigned long);
	525	extern void nvm_put_blk(struct nvm_dev , struct nvm_block );
	526
	527	extern int nvm_register(struct request_queue , char ,
	528	struct nvm_dev_ops *);
	529	extern void nvm_unregister(char *);
	530
529435e8 JG	531	void nvm_mark_blk(struct nvm_dev *dev, struct ppa_addr ppa, int type);
529435e8 JG	532
cd9e9808	533	extern int nvm_submit_io(struct nvm_dev , struct nvm_rq );
069368e9 MB	534	extern void nvm_generic_to_addr_mode(struct nvm_dev , struct nvm_rq );
069368e9 MB	535	extern void nvm_addr_to_generic_mode(struct nvm_dev , struct nvm_rq );
abd805ec	536	extern int nvm_set_rqd_ppalist(struct nvm_dev , struct nvm_rq ,
8680f165	537	const struct ppa_addr *, int, int);
abd805ec	538	extern void nvm_free_rqd_ppalist(struct nvm_dev , struct nvm_rq );
81e681d3	539	extern int nvm_erase_ppa(struct nvm_dev , struct ppa_addr , int);
cd9e9808	540	extern int nvm_erase_blk(struct nvm_dev , struct nvm_block );
91276162	541	extern void nvm_end_io(struct nvm_rq *, int);
09719b62 MB	542	extern int nvm_submit_ppa(struct nvm_dev , struct ppa_addr , int, int, int,
09719b62 MB	543	void *, int);
1145e635 MB	544	extern int nvm_submit_ppa_list(struct nvm_dev , struct ppa_addr , int, int,
1145e635 MB	545	int, void *, int);
22e8c976	546	extern int nvm_bb_tbl_fold(struct nvm_dev , u8 , int);
e11903f5	547	extern int nvm_get_bb_tbl(struct nvm_dev , struct ppa_addr, u8 );
e3eb3799 MB	548
	549	/* sysblk.c */
	550	#define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
	551
	552	/* system block on disk representation */
	553	struct nvm_system_block {
	554	__be32 magic; /* magic signature */
	555	__be32 seqnr; /* sequence number */
	556	__be32 erase_cnt; /* erase count */
	557	__be16 version; /* version number */
	558	u8 mmtype[NVM_MMTYPE_LEN]; /* media manager name */
	559	__be64 fs_ppa; /* PPA for media manager
	560	* superblock */
	561	};
	562
	563	extern int nvm_get_sysblock(struct nvm_dev , struct nvm_sb_info );
	564	extern int nvm_update_sysblock(struct nvm_dev , struct nvm_sb_info );
	565	extern int nvm_init_sysblock(struct nvm_dev , struct nvm_sb_info );
8b4970c4 MB	566
8b4970c4 MB	567	extern int nvm_dev_factory(struct nvm_dev *, int flags);
5136061c MB	568
	569	#define nvm_for_each_lun_ppa(dev, ppa, chid, lunid) \
	570	for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls; \
	571	(chid)++, (ppa).g.ch = (chid)) \
	572	for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl; \
	573	(lunid)++, (ppa).g.lun = (lunid))
	574
cd9e9808 MB	575	#else /* CONFIG_NVM */
	576	struct nvm_dev_ops;
	577
	578	static inline int nvm_register(struct request_queue q, char disk_name,
	579	struct nvm_dev_ops *ops)
	580	{
	581	return -EINVAL;
	582	}
	583	static inline void nvm_unregister(char *disk_name) {}
	584	#endif /* CONFIG_NVM */
	585	#endif /* LIGHTNVM.H */