[deliverable/linux.git] / include / linux / lightnvm.h

#ifndef NVM_H
#define NVM_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,
};

#ifdef CONFIG_NVM

#include <linux/blkdev.h>
#include <linux/types.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	= 0,
	NVM_PLANE_DOUBLE	= 1,
	NVM_PLANE_QUAD		= 2,

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

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

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

	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;

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

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 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_pages;
	unsigned long total_blocks;
	int nr_luns;
	unsigned max_pages_per_blk;

	void *ppalist_pool;

	struct nvm_id identity;

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

	struct mutex mlock;
};

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 void (nvmm_lun_info_print_fn)(struct nvm_dev *);

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;

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

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