1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/blkdev.h>
6 #include <linux/types.h>
7 #include <uapi/linux/lightnvm.h>
19 #define NVM_BLK_BITS (16)
20 #define NVM_PG_BITS (16)
21 #define NVM_SEC_BITS (8)
22 #define NVM_PL_BITS (8)
23 #define NVM_LUN_BITS (8)
24 #define NVM_CH_BITS (7)
27 /* Generic structure for all addresses */
30 u64 blk : NVM_BLK_BITS;
32 u64 sec : NVM_SEC_BITS;
34 u64 lun : NVM_LUN_BITS;
53 typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
54 typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
55 typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
56 nvm_l2p_update_fn *, void *);
57 typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
58 typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
59 typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
60 typedef int (nvm_submit_io_sync_fn)(struct nvm_dev *, struct nvm_rq *);
61 typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
62 typedef void (nvm_destroy_dma_pool_fn)(void *);
63 typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
65 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
69 nvm_get_l2p_tbl_fn *get_l2p_tbl;
70 nvm_op_bb_tbl_fn *get_bb_tbl;
71 nvm_op_set_bb_fn *set_bb_tbl;
73 nvm_submit_io_fn *submit_io;
74 nvm_submit_io_sync_fn *submit_io_sync;
76 nvm_create_dma_pool_fn *create_dma_pool;
77 nvm_destroy_dma_pool_fn *destroy_dma_pool;
78 nvm_dev_dma_alloc_fn *dev_dma_alloc;
79 nvm_dev_dma_free_fn *dev_dma_free;
81 unsigned int max_phys_sect;
86 #include <linux/blkdev.h>
87 #include <linux/file.h>
88 #include <linux/dmapool.h>
89 #include <uapi/linux/lightnvm.h>
92 /* HW Responsibilities */
96 /* Physical Adressing Mode */
97 NVM_ADDRMODE_LINEAR = 0,
98 NVM_ADDRMODE_CHANNEL = 1,
100 /* Plane programming mode for LUN */
101 NVM_PLANE_SINGLE = 1,
102 NVM_PLANE_DOUBLE = 2,
106 NVM_RSP_SUCCESS = 0x0,
107 NVM_RSP_NOT_CHANGEABLE = 0x1,
108 NVM_RSP_ERR_FAILWRITE = 0x40ff,
109 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
110 NVM_RSP_ERR_FAILECC = 0x4281,
111 NVM_RSP_ERR_FAILCRC = 0x4004,
112 NVM_RSP_WARN_HIGHECC = 0x4700,
115 NVM_OP_HBREAD = 0x02,
116 NVM_OP_HBWRITE = 0x81,
117 NVM_OP_PWRITE = 0x91,
121 /* PPA Command Flags */
122 NVM_IO_SNGL_ACCESS = 0x0,
123 NVM_IO_DUAL_ACCESS = 0x1,
124 NVM_IO_QUAD_ACCESS = 0x2,
126 /* NAND Access Modes */
127 NVM_IO_SUSPEND = 0x80,
128 NVM_IO_SLC_MODE = 0x100,
129 NVM_IO_SCRAMBLE_ENABLE = 0x200,
132 NVM_BLK_T_FREE = 0x0,
134 NVM_BLK_T_GRWN_BAD = 0x2,
136 NVM_BLK_T_HOST = 0x8,
138 /* Memory capabilities */
139 NVM_ID_CAP_SLC = 0x1,
140 NVM_ID_CAP_CMD_SUSPEND = 0x2,
141 NVM_ID_CAP_SCRAMBLE = 0x4,
142 NVM_ID_CAP_ENCRYPT = 0x8,
145 NVM_ID_FMTYPE_SLC = 0,
146 NVM_ID_FMTYPE_MLC = 1,
148 /* Device capabilities */
149 NVM_ID_DCAP_BBLKMGMT = 0x1,
150 NVM_UD_DCAP_ECC = 0x2,
153 struct nvm_id_lp_mlc {
158 struct nvm_id_lp_tbl {
160 struct nvm_id_lp_mlc mlc;
163 struct nvm_id_group {
184 struct nvm_id_lp_tbl lptbl;
187 struct nvm_addr_format {
207 struct nvm_addr_format ppaf;
208 struct nvm_id_group grp;
212 struct list_head list;
213 struct nvm_tgt_dev *dev;
214 struct nvm_tgt_type *type;
215 struct gendisk *disk;
218 #define ADDR_EMPTY (~0ULL)
220 #define NVM_VERSION_MAJOR 1
221 #define NVM_VERSION_MINOR 0
222 #define NVM_VERSION_PATCH 0
225 typedef void (nvm_end_io_fn)(struct nvm_rq *);
228 struct nvm_tgt_dev *dev;
233 struct ppa_addr ppa_addr;
234 dma_addr_t dma_ppa_list;
237 struct ppa_addr *ppa_list;
240 dma_addr_t dma_meta_list;
242 struct completion *wait;
243 nvm_end_io_fn *end_io;
249 u64 ppa_status; /* ppa media status */
255 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
257 return pdu - sizeof(struct nvm_rq);
260 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
266 NVM_BLK_ST_FREE = 0x1, /* Free block */
267 NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
268 NVM_BLK_ST_BAD = 0x8, /* Bad block */
271 /* Device generic information */
275 int luns_per_chnl; /* -1 if channels are not symmetric */
277 int sec_per_pg; /* only sectors for a single page */
281 int pfpg_size; /* size of buffer if all pages are to be read */
285 struct nvm_addr_format ppaf;
287 /* Calculated/Cached values. These do not reflect the actual usable
288 * blocks at run-time.
291 int plane_mode; /* drive device in single, double or quad mode */
293 int sec_per_pl; /* all sectors across planes */
298 /* sub-device structure */
300 /* Device information */
303 /* Base ppas for target LUNs */
304 struct ppa_addr *luns;
308 struct nvm_id identity;
309 struct request_queue *q;
311 struct nvm_dev *parent;
316 struct nvm_dev_ops *ops;
318 struct list_head devices;
320 /* Device information */
323 /* lower page table */
327 unsigned long total_secs;
329 unsigned long *lun_map;
332 struct nvm_id identity;
335 struct request_queue *q;
336 char name[DISK_NAME_LEN];
344 /* target management */
345 struct list_head area_list;
346 struct list_head targets;
349 static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
353 int secs, pgs, blks, luns;
358 div_u64_rem(ppa, geo->sec_per_pg, &secs);
361 sector_div(ppa, geo->sec_per_pg);
362 div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
365 sector_div(ppa, geo->pgs_per_blk);
366 div_u64_rem(ppa, geo->blks_per_lun, &blks);
369 sector_div(ppa, geo->blks_per_lun);
370 div_u64_rem(ppa, geo->luns_per_chnl, &luns);
373 sector_div(ppa, geo->luns_per_chnl);
379 static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
382 struct nvm_geo *geo = &tgt_dev->geo;
385 l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
386 l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
387 l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
388 l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
389 l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
390 l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;
395 static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
398 struct nvm_geo *geo = &tgt_dev->geo;
403 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
405 l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
406 (((1 << geo->ppaf.blk_len) - 1));
407 l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
408 (((1 << geo->ppaf.pg_len) - 1));
409 l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
410 (((1 << geo->ppaf.sect_len) - 1));
411 l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
412 (((1 << geo->ppaf.pln_len) - 1));
413 l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
414 (((1 << geo->ppaf.lun_len) - 1));
415 l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
416 (((1 << geo->ppaf.ch_len) - 1));
421 static inline int ppa_empty(struct ppa_addr ppa_addr)
423 return (ppa_addr.ppa == ADDR_EMPTY);
426 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
428 ppa_addr->ppa = ADDR_EMPTY;
431 static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
433 if (ppa_empty(ppa1) || ppa_empty(ppa2))
436 return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
437 (ppa1.g.blk == ppa2.g.blk));
440 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
441 typedef sector_t (nvm_tgt_capacity_fn)(void *);
442 typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *,
444 typedef void (nvm_tgt_exit_fn)(void *);
445 typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
446 typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);
448 struct nvm_tgt_type {
450 unsigned int version[3];
452 /* target entry points */
453 nvm_tgt_make_rq_fn *make_rq;
454 nvm_tgt_capacity_fn *capacity;
456 /* module-specific init/teardown */
457 nvm_tgt_init_fn *init;
458 nvm_tgt_exit_fn *exit;
461 nvm_tgt_sysfs_init_fn *sysfs_init;
462 nvm_tgt_sysfs_exit_fn *sysfs_exit;
464 /* For internal use */
465 struct list_head list;
466 struct module *owner;
469 extern int nvm_register_tgt_type(struct nvm_tgt_type *);
470 extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
472 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
473 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
475 extern struct nvm_dev *nvm_alloc_dev(int);
476 extern int nvm_register(struct nvm_dev *);
477 extern void nvm_unregister(struct nvm_dev *);
479 extern int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr *,
481 extern int nvm_max_phys_sects(struct nvm_tgt_dev *);
482 extern int nvm_submit_io(struct nvm_tgt_dev *, struct nvm_rq *);
483 extern int nvm_submit_io_sync(struct nvm_tgt_dev *, struct nvm_rq *);
484 extern int nvm_erase_sync(struct nvm_tgt_dev *, struct ppa_addr *, int);
485 extern int nvm_get_l2p_tbl(struct nvm_tgt_dev *, u64, u32, nvm_l2p_update_fn *,
487 extern int nvm_get_area(struct nvm_tgt_dev *, sector_t *, sector_t);
488 extern void nvm_put_area(struct nvm_tgt_dev *, sector_t);
489 extern void nvm_end_io(struct nvm_rq *);
490 extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
491 extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr, u8 *);
493 extern void nvm_part_to_tgt(struct nvm_dev *, sector_t *, int);
495 #else /* CONFIG_NVM */
498 static inline struct nvm_dev *nvm_alloc_dev(int node)
500 return ERR_PTR(-EINVAL);
502 static inline int nvm_register(struct nvm_dev *dev)
506 static inline void nvm_unregister(struct nvm_dev *dev) {}
507 #endif /* CONFIG_NVM */
508 #endif /* LIGHTNVM.H */