4 #include <linux/blkdev.h>
5 #include <linux/types.h>
6 #include <uapi/linux/lightnvm.h>
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)
23 #define NVM_CH_BITS (7)
26 /* Generic structure for all addresses */
29 u64 blk : NVM_BLK_BITS;
31 u64 sec : NVM_SEC_BITS;
33 u64 lun : NVM_LUN_BITS;
52 typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
53 typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
54 typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
55 nvm_l2p_update_fn *, void *);
56 typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
57 typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
58 typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
59 typedef int (nvm_erase_blk_fn)(struct nvm_dev *, struct nvm_rq *);
60 typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
61 typedef void (nvm_destroy_dma_pool_fn)(void *);
62 typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
64 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
68 nvm_get_l2p_tbl_fn *get_l2p_tbl;
69 nvm_op_bb_tbl_fn *get_bb_tbl;
70 nvm_op_set_bb_fn *set_bb_tbl;
72 nvm_submit_io_fn *submit_io;
73 nvm_erase_blk_fn *erase_block;
75 nvm_create_dma_pool_fn *create_dma_pool;
76 nvm_destroy_dma_pool_fn *destroy_dma_pool;
77 nvm_dev_dma_alloc_fn *dev_dma_alloc;
78 nvm_dev_dma_free_fn *dev_dma_free;
80 unsigned int max_phys_sect;
85 #include <linux/blkdev.h>
86 #include <linux/file.h>
87 #include <linux/dmapool.h>
88 #include <uapi/linux/lightnvm.h>
91 /* HW Responsibilities */
95 /* Physical Adressing Mode */
96 NVM_ADDRMODE_LINEAR = 0,
97 NVM_ADDRMODE_CHANNEL = 1,
99 /* Plane programming mode for LUN */
100 NVM_PLANE_SINGLE = 1,
101 NVM_PLANE_DOUBLE = 2,
105 NVM_RSP_SUCCESS = 0x0,
106 NVM_RSP_NOT_CHANGEABLE = 0x1,
107 NVM_RSP_ERR_FAILWRITE = 0x40ff,
108 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
109 NVM_RSP_ERR_FAILECC = 0x4281,
110 NVM_RSP_ERR_FAILCRC = 0x4004,
111 NVM_RSP_WARN_HIGHECC = 0x4700,
114 NVM_OP_HBREAD = 0x02,
115 NVM_OP_HBWRITE = 0x81,
116 NVM_OP_PWRITE = 0x91,
120 /* PPA Command Flags */
121 NVM_IO_SNGL_ACCESS = 0x0,
122 NVM_IO_DUAL_ACCESS = 0x1,
123 NVM_IO_QUAD_ACCESS = 0x2,
125 /* NAND Access Modes */
126 NVM_IO_SUSPEND = 0x80,
127 NVM_IO_SLC_MODE = 0x100,
128 NVM_IO_SCRAMBLE_DISABLE = 0x200,
131 NVM_BLK_T_FREE = 0x0,
133 NVM_BLK_T_GRWN_BAD = 0x2,
135 NVM_BLK_T_HOST = 0x8,
137 /* Memory capabilities */
138 NVM_ID_CAP_SLC = 0x1,
139 NVM_ID_CAP_CMD_SUSPEND = 0x2,
140 NVM_ID_CAP_SCRAMBLE = 0x4,
141 NVM_ID_CAP_ENCRYPT = 0x8,
144 NVM_ID_FMTYPE_SLC = 0,
145 NVM_ID_FMTYPE_MLC = 1,
147 /* Device capabilities */
148 NVM_ID_DCAP_BBLKMGMT = 0x1,
149 NVM_UD_DCAP_ECC = 0x2,
152 struct nvm_id_lp_mlc {
157 struct nvm_id_lp_tbl {
159 struct nvm_id_lp_mlc mlc;
162 struct nvm_id_group {
183 struct nvm_id_lp_tbl lptbl;
186 struct nvm_addr_format {
206 struct nvm_addr_format ppaf;
207 struct nvm_id_group grp;
211 struct list_head list;
212 struct nvm_tgt_dev *dev;
213 struct nvm_tgt_type *type;
214 struct gendisk *disk;
217 #define ADDR_EMPTY (~0ULL)
219 #define NVM_VERSION_MAJOR 1
220 #define NVM_VERSION_MINOR 0
221 #define NVM_VERSION_PATCH 0
224 typedef void (nvm_end_io_fn)(struct nvm_rq *);
227 struct nvm_tgt_dev *dev;
232 struct ppa_addr ppa_addr;
233 dma_addr_t dma_ppa_list;
236 struct ppa_addr *ppa_list;
239 dma_addr_t dma_meta_list;
241 struct completion *wait;
242 nvm_end_io_fn *end_io;
248 u64 ppa_status; /* ppa media status */
254 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
256 return pdu - sizeof(struct nvm_rq);
259 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
265 NVM_BLK_ST_FREE = 0x1, /* Free block */
266 NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
267 NVM_BLK_ST_BAD = 0x8, /* Bad block */
270 /* Device generic information */
274 int luns_per_chnl; /* -1 if channels are not symmetric */
276 int sec_per_pg; /* only sectors for a single page */
280 int pfpg_size; /* size of buffer if all pages are to be read */
284 struct nvm_addr_format ppaf;
286 /* Calculated/Cached values. These do not reflect the actual usable
287 * blocks at run-time.
290 int plane_mode; /* drive device in single, double or quad mode */
292 int sec_per_pl; /* all sectors across planes */
297 /* sub-device structure */
299 /* Device information */
302 /* Base ppas for target LUNs */
303 struct ppa_addr *luns;
307 struct nvm_id identity;
308 struct request_queue *q;
310 struct nvm_dev *parent;
315 struct nvm_dev_ops *ops;
317 struct list_head devices;
319 /* Device information */
322 /* lower page table */
326 unsigned long total_secs;
328 unsigned long *lun_map;
331 struct nvm_id identity;
334 struct request_queue *q;
335 char name[DISK_NAME_LEN];
343 /* target management */
344 struct list_head area_list;
345 struct list_head targets;
348 static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
352 int secs, pgs, blks, luns;
357 div_u64_rem(ppa, geo->sec_per_pg, &secs);
360 sector_div(ppa, geo->sec_per_pg);
361 div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
364 sector_div(ppa, geo->pgs_per_blk);
365 div_u64_rem(ppa, geo->blks_per_lun, &blks);
368 sector_div(ppa, geo->blks_per_lun);
369 div_u64_rem(ppa, geo->luns_per_chnl, &luns);
372 sector_div(ppa, geo->luns_per_chnl);
378 static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
381 struct nvm_geo *geo = &tgt_dev->geo;
384 l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
385 l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
386 l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
387 l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
388 l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
389 l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;
394 static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
397 struct nvm_geo *geo = &tgt_dev->geo;
402 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
404 l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
405 (((1 << geo->ppaf.blk_len) - 1));
406 l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
407 (((1 << geo->ppaf.pg_len) - 1));
408 l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
409 (((1 << geo->ppaf.sect_len) - 1));
410 l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
411 (((1 << geo->ppaf.pln_len) - 1));
412 l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
413 (((1 << geo->ppaf.lun_len) - 1));
414 l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
415 (((1 << geo->ppaf.ch_len) - 1));
420 static inline int ppa_empty(struct ppa_addr ppa_addr)
422 return (ppa_addr.ppa == ADDR_EMPTY);
425 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
427 ppa_addr->ppa = ADDR_EMPTY;
430 static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
432 if (ppa_empty(ppa1) || ppa_empty(ppa2))
435 return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
436 (ppa1.g.blk == ppa2.g.blk));
439 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
440 typedef sector_t (nvm_tgt_capacity_fn)(void *);
441 typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *);
442 typedef void (nvm_tgt_exit_fn)(void *);
443 typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
444 typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);
446 struct nvm_tgt_type {
448 unsigned int version[3];
450 /* target entry points */
451 nvm_tgt_make_rq_fn *make_rq;
452 nvm_tgt_capacity_fn *capacity;
454 /* module-specific init/teardown */
455 nvm_tgt_init_fn *init;
456 nvm_tgt_exit_fn *exit;
459 nvm_tgt_sysfs_init_fn *sysfs_init;
460 nvm_tgt_sysfs_exit_fn *sysfs_exit;
462 /* For internal use */
463 struct list_head list;
466 extern struct nvm_tgt_type *nvm_find_target_type(const char *, int);
468 extern int nvm_register_tgt_type(struct nvm_tgt_type *);
469 extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
471 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
472 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
474 extern struct nvm_dev *nvm_alloc_dev(int);
475 extern int nvm_register(struct nvm_dev *);
476 extern void nvm_unregister(struct nvm_dev *);
478 extern int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr *,
480 extern int nvm_max_phys_sects(struct nvm_tgt_dev *);
481 extern int nvm_submit_io(struct nvm_tgt_dev *, struct nvm_rq *);
482 extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
483 const struct ppa_addr *, int, int);
484 extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
485 extern int nvm_erase_blk(struct nvm_tgt_dev *, struct ppa_addr *, int);
486 extern int nvm_get_l2p_tbl(struct nvm_tgt_dev *, u64, u32, nvm_l2p_update_fn *,
488 extern int nvm_get_area(struct nvm_tgt_dev *, sector_t *, sector_t);
489 extern void nvm_put_area(struct nvm_tgt_dev *, sector_t);
490 extern void nvm_end_io(struct nvm_rq *);
491 extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
492 extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr, u8 *);
494 extern int nvm_dev_factory(struct nvm_dev *, int flags);
496 extern void nvm_part_to_tgt(struct nvm_dev *, sector_t *, int);
498 #else /* CONFIG_NVM */
501 static inline struct nvm_dev *nvm_alloc_dev(int node)
503 return ERR_PTR(-EINVAL);
505 static inline int nvm_register(struct nvm_dev *dev)
509 static inline void nvm_unregister(struct nvm_dev *dev) {}
510 #endif /* CONFIG_NVM */
511 #endif /* LIGHTNVM.H */