[linux-2.6-block.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  (8)

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

		u64 ppa;
	};
};

struct nvm_rq;
struct nvm_id;
struct nvm_dev;

typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
typedef int (nvm_bb_update_fn)(struct ppa_addr, int, u8 *, 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, int,
				nvm_bb_update_fn *, void *);
typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct nvm_rq *, 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_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 *metadata;
	dma_addr_t dma_metadata;

	struct completion *wait;
	nvm_end_io_fn *end_io;

	uint8_t opcode;
	uint16_t nr_pages;
	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;
	struct list_head online_targets;

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

	unsigned long *lun_map;
	void *ppalist_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_target(struct nvm_tgt_type *);
extern void nvm_unregister_target(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 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;

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

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