4 #include <linux/types.h>
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)
24 /* Generic structure for all addresses */
27 u64 blk : NVM_BLK_BITS;
29 u64 sec : NVM_SEC_BITS;
31 u64 lun : NVM_LUN_BITS;
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,
57 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
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;
65 nvm_submit_io_fn *submit_io;
66 nvm_erase_blk_fn *erase_block;
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;
73 unsigned int max_phys_sect;
80 #include <linux/blkdev.h>
81 #include <linux/file.h>
82 #include <linux/dmapool.h>
83 #include <uapi/linux/lightnvm.h>
86 /* HW Responsibilities */
90 /* Physical Adressing Mode */
91 NVM_ADDRMODE_LINEAR = 0,
92 NVM_ADDRMODE_CHANNEL = 1,
94 /* Plane programming mode for LUN */
100 NVM_RSP_SUCCESS = 0x0,
101 NVM_RSP_NOT_CHANGEABLE = 0x1,
102 NVM_RSP_ERR_FAILWRITE = 0x40ff,
103 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
106 NVM_OP_HBREAD = 0x02,
107 NVM_OP_HBWRITE = 0x81,
108 NVM_OP_PWRITE = 0x91,
112 /* PPA Command Flags */
113 NVM_IO_SNGL_ACCESS = 0x0,
114 NVM_IO_DUAL_ACCESS = 0x1,
115 NVM_IO_QUAD_ACCESS = 0x2,
117 /* NAND Access Modes */
118 NVM_IO_SUSPEND = 0x80,
119 NVM_IO_SLC_MODE = 0x100,
120 NVM_IO_SCRAMBLE_DISABLE = 0x200,
123 NVM_BLK_T_FREE = 0x0,
125 NVM_BLK_T_GRWN_BAD = 0x2,
127 NVM_BLK_T_HOST = 0x8,
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,
136 NVM_ID_FMTYPE_SLC = 0,
137 NVM_ID_FMTYPE_MLC = 1,
139 /* Device capabilities */
140 NVM_ID_DCAP_BBLKMGMT = 0x1,
141 NVM_UD_DCAP_ECC = 0x2,
144 struct nvm_id_lp_mlc {
149 struct nvm_id_lp_tbl {
151 struct nvm_id_lp_mlc mlc;
154 struct nvm_id_group {
175 struct nvm_id_lp_tbl lptbl;
178 struct nvm_addr_format {
199 struct nvm_addr_format ppaf;
200 struct nvm_id_group groups[4];
204 struct list_head list;
205 struct nvm_tgt_type *type;
206 struct gendisk *disk;
209 struct nvm_tgt_instance {
210 struct nvm_tgt_type *tt;
213 #define ADDR_EMPTY (~0ULL)
215 #define NVM_VERSION_MAJOR 1
216 #define NVM_VERSION_MINOR 0
217 #define NVM_VERSION_PATCH 0
220 typedef void (nvm_end_io_fn)(struct nvm_rq *);
223 struct nvm_tgt_instance *ins;
229 struct ppa_addr ppa_addr;
230 dma_addr_t dma_ppa_list;
233 struct ppa_addr *ppa_list;
236 dma_addr_t dma_metadata;
238 struct completion *wait;
239 nvm_end_io_fn *end_io;
248 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
250 return pdu - sizeof(struct nvm_rq);
253 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
266 /* It is up to the target to mark blocks as closed. If the target does
267 * not do it, all blocks are marked as open, and nr_open_blocks
268 * represents the number of blocks in use
270 unsigned int nr_open_blocks; /* Number of used, writable blocks */
271 unsigned int nr_closed_blocks; /* Number of used, read-only blocks */
272 unsigned int nr_free_blocks; /* Number of unused blocks */
273 unsigned int nr_bad_blocks; /* Number of bad blocks */
277 struct nvm_block *blocks;
281 NVM_BLK_ST_FREE = 0x1, /* Free block */
282 NVM_BLK_ST_OPEN = 0x2, /* Open block - read-write */
283 NVM_BLK_ST_CLOSED = 0x4, /* Closed block - read-only */
284 NVM_BLK_ST_BAD = 0x8, /* Bad block */
288 struct list_head list;
296 /* system block cpu representation */
299 unsigned long erase_cnt;
300 unsigned int version;
301 char mmtype[NVM_MMTYPE_LEN];
302 struct ppa_addr fs_ppa;
306 struct nvm_dev_ops *ops;
308 struct list_head devices;
309 struct list_head online_targets;
312 struct nvmm_type *mt;
316 struct nvm_sb_info sb;
318 /* Device information */
322 int sec_per_pg; /* only sectors for a single page */
328 struct nvm_addr_format ppaf;
330 /* Calculated/Cached values. These do not reflect the actual usable
331 * blocks at run-time.
334 int plane_mode; /* drive device in single, double or quad mode */
336 int sec_per_pl; /* all sectors across planes */
340 /* lower page table */
344 unsigned long total_blocks;
345 unsigned long total_secs;
347 unsigned max_pages_per_blk;
351 struct nvm_id identity;
354 struct request_queue *q;
355 char name[DISK_NAME_LEN];
360 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
365 l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
366 l.ppa |= ((u64)r.g.pg) << dev->ppaf.pg_offset;
367 l.ppa |= ((u64)r.g.sec) << dev->ppaf.sect_offset;
368 l.ppa |= ((u64)r.g.pl) << dev->ppaf.pln_offset;
369 l.ppa |= ((u64)r.g.lun) << dev->ppaf.lun_offset;
370 l.ppa |= ((u64)r.g.ch) << dev->ppaf.ch_offset;
375 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
381 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
383 l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
384 (((1 << dev->ppaf.blk_len) - 1));
385 l.g.pg |= (r.ppa >> dev->ppaf.pg_offset) &
386 (((1 << dev->ppaf.pg_len) - 1));
387 l.g.sec |= (r.ppa >> dev->ppaf.sect_offset) &
388 (((1 << dev->ppaf.sect_len) - 1));
389 l.g.pl |= (r.ppa >> dev->ppaf.pln_offset) &
390 (((1 << dev->ppaf.pln_len) - 1));
391 l.g.lun |= (r.ppa >> dev->ppaf.lun_offset) &
392 (((1 << dev->ppaf.lun_len) - 1));
393 l.g.ch |= (r.ppa >> dev->ppaf.ch_offset) &
394 (((1 << dev->ppaf.ch_len) - 1));
399 static inline int ppa_empty(struct ppa_addr ppa_addr)
401 return (ppa_addr.ppa == ADDR_EMPTY);
404 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
406 ppa_addr->ppa = ADDR_EMPTY;
409 static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
410 struct nvm_block *blk)
413 struct nvm_lun *lun = blk->lun;
416 ppa.g.blk = blk->id % dev->blks_per_lun;
417 ppa.g.lun = lun->lun_id;
418 ppa.g.ch = lun->chnl_id;
423 static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
425 return dev->lptbl[slc_pg];
428 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
429 typedef sector_t (nvm_tgt_capacity_fn)(void *);
430 typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
431 typedef void (nvm_tgt_exit_fn)(void *);
433 struct nvm_tgt_type {
435 unsigned int version[3];
437 /* target entry points */
438 nvm_tgt_make_rq_fn *make_rq;
439 nvm_tgt_capacity_fn *capacity;
440 nvm_end_io_fn *end_io;
442 /* module-specific init/teardown */
443 nvm_tgt_init_fn *init;
444 nvm_tgt_exit_fn *exit;
446 /* For internal use */
447 struct list_head list;
450 extern int nvm_register_target(struct nvm_tgt_type *);
451 extern void nvm_unregister_target(struct nvm_tgt_type *);
453 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
454 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
456 typedef int (nvmm_register_fn)(struct nvm_dev *);
457 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
458 typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
459 struct nvm_lun *, unsigned long);
460 typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
461 typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
462 typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
463 typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
464 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
465 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
467 typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
468 typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
472 unsigned int version[3];
474 nvmm_register_fn *register_mgr;
475 nvmm_unregister_fn *unregister_mgr;
477 /* Block administration callbacks */
478 nvmm_get_blk_fn *get_blk_unlocked;
479 nvmm_put_blk_fn *put_blk_unlocked;
480 nvmm_get_blk_fn *get_blk;
481 nvmm_put_blk_fn *put_blk;
482 nvmm_open_blk_fn *open_blk;
483 nvmm_close_blk_fn *close_blk;
484 nvmm_flush_blk_fn *flush_blk;
486 nvmm_submit_io_fn *submit_io;
487 nvmm_erase_blk_fn *erase_blk;
489 /* Configuration management */
490 nvmm_get_lun_fn *get_lun;
493 nvmm_lun_info_print_fn *lun_info_print;
494 struct list_head list;
497 extern int nvm_register_mgr(struct nvmm_type *);
498 extern void nvm_unregister_mgr(struct nvmm_type *);
500 extern struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *,
501 struct nvm_lun *, unsigned long);
502 extern void nvm_put_blk_unlocked(struct nvm_dev *, struct nvm_block *);
504 extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
506 extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
508 extern int nvm_register(struct request_queue *, char *,
509 struct nvm_dev_ops *);
510 extern void nvm_unregister(char *);
512 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
513 extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
514 extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
515 extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
516 struct ppa_addr *, int);
517 extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
518 extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int);
519 extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
520 extern void nvm_end_io(struct nvm_rq *, int);
521 extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
525 #define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
527 /* system block on disk representation */
528 struct nvm_system_block {
529 __be32 magic; /* magic signature */
530 __be32 seqnr; /* sequence number */
531 __be32 erase_cnt; /* erase count */
532 __be16 version; /* version number */
533 u8 mmtype[NVM_MMTYPE_LEN]; /* media manager name */
534 __be64 fs_ppa; /* PPA for media manager
538 extern int nvm_get_sysblock(struct nvm_dev *, struct nvm_sb_info *);
539 extern int nvm_update_sysblock(struct nvm_dev *, struct nvm_sb_info *);
540 extern int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *);
542 extern int nvm_dev_factory(struct nvm_dev *, int flags);
543 #else /* CONFIG_NVM */
546 static inline int nvm_register(struct request_queue *q, char *disk_name,
547 struct nvm_dev_ops *ops)
551 static inline void nvm_unregister(char *disk_name) {}
552 #endif /* CONFIG_NVM */
553 #endif /* LIGHTNVM.H */