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 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;
74 nvm_create_dma_pool_fn *create_dma_pool;
75 nvm_destroy_dma_pool_fn *destroy_dma_pool;
76 nvm_dev_dma_alloc_fn *dev_dma_alloc;
77 nvm_dev_dma_free_fn *dev_dma_free;
79 unsigned int max_phys_sect;
84 #include <linux/blkdev.h>
85 #include <linux/file.h>
86 #include <linux/dmapool.h>
87 #include <uapi/linux/lightnvm.h>
90 /* HW Responsibilities */
94 /* Physical Adressing Mode */
95 NVM_ADDRMODE_LINEAR = 0,
96 NVM_ADDRMODE_CHANNEL = 1,
98 /* Plane programming mode for LUN */
100 NVM_PLANE_DOUBLE = 2,
104 NVM_RSP_SUCCESS = 0x0,
105 NVM_RSP_NOT_CHANGEABLE = 0x1,
106 NVM_RSP_ERR_FAILWRITE = 0x40ff,
107 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
108 NVM_RSP_ERR_FAILECC = 0x4281,
109 NVM_RSP_ERR_FAILCRC = 0x4004,
110 NVM_RSP_WARN_HIGHECC = 0x4700,
113 NVM_OP_HBREAD = 0x02,
114 NVM_OP_HBWRITE = 0x81,
115 NVM_OP_PWRITE = 0x91,
119 /* PPA Command Flags */
120 NVM_IO_SNGL_ACCESS = 0x0,
121 NVM_IO_DUAL_ACCESS = 0x1,
122 NVM_IO_QUAD_ACCESS = 0x2,
124 /* NAND Access Modes */
125 NVM_IO_SUSPEND = 0x80,
126 NVM_IO_SLC_MODE = 0x100,
127 NVM_IO_SCRAMBLE_ENABLE = 0x200,
130 NVM_BLK_T_FREE = 0x0,
132 NVM_BLK_T_GRWN_BAD = 0x2,
134 NVM_BLK_T_HOST = 0x8,
136 /* Memory capabilities */
137 NVM_ID_CAP_SLC = 0x1,
138 NVM_ID_CAP_CMD_SUSPEND = 0x2,
139 NVM_ID_CAP_SCRAMBLE = 0x4,
140 NVM_ID_CAP_ENCRYPT = 0x8,
143 NVM_ID_FMTYPE_SLC = 0,
144 NVM_ID_FMTYPE_MLC = 1,
146 /* Device capabilities */
147 NVM_ID_DCAP_BBLKMGMT = 0x1,
148 NVM_UD_DCAP_ECC = 0x2,
151 struct nvm_id_lp_mlc {
156 struct nvm_id_lp_tbl {
158 struct nvm_id_lp_mlc mlc;
161 struct nvm_id_group {
182 struct nvm_id_lp_tbl lptbl;
185 struct nvm_addr_format {
205 struct nvm_addr_format ppaf;
206 struct nvm_id_group grp;
210 struct list_head list;
211 struct nvm_tgt_dev *dev;
212 struct nvm_tgt_type *type;
213 struct gendisk *disk;
216 #define ADDR_EMPTY (~0ULL)
218 #define NVM_VERSION_MAJOR 1
219 #define NVM_VERSION_MINOR 0
220 #define NVM_VERSION_PATCH 0
223 typedef void (nvm_end_io_fn)(struct nvm_rq *);
226 struct nvm_tgt_dev *dev;
231 struct ppa_addr ppa_addr;
232 dma_addr_t dma_ppa_list;
235 struct ppa_addr *ppa_list;
238 dma_addr_t dma_meta_list;
240 struct completion *wait;
241 nvm_end_io_fn *end_io;
247 u64 ppa_status; /* ppa media status */
253 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
255 return pdu - sizeof(struct nvm_rq);
258 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
264 NVM_BLK_ST_FREE = 0x1, /* Free block */
265 NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
266 NVM_BLK_ST_BAD = 0x8, /* Bad block */
269 /* Device generic information */
273 int luns_per_chnl; /* -1 if channels are not symmetric */
275 int sec_per_pg; /* only sectors for a single page */
279 int pfpg_size; /* size of buffer if all pages are to be read */
283 struct nvm_addr_format ppaf;
285 /* Calculated/Cached values. These do not reflect the actual usable
286 * blocks at run-time.
289 int plane_mode; /* drive device in single, double or quad mode */
291 int sec_per_pl; /* all sectors across planes */
296 /* sub-device structure */
298 /* Device information */
301 /* Base ppas for target LUNs */
302 struct ppa_addr *luns;
306 struct nvm_id identity;
307 struct request_queue *q;
309 struct nvm_dev *parent;
314 struct nvm_dev_ops *ops;
316 struct list_head devices;
318 /* Device information */
321 /* lower page table */
325 unsigned long total_secs;
327 unsigned long *lun_map;
330 struct nvm_id identity;
333 struct request_queue *q;
334 char name[DISK_NAME_LEN];
342 /* target management */
343 struct list_head area_list;
344 struct list_head targets;
347 static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
351 int secs, pgs, blks, luns;
356 div_u64_rem(ppa, geo->sec_per_pg, &secs);
359 sector_div(ppa, geo->sec_per_pg);
360 div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
363 sector_div(ppa, geo->pgs_per_blk);
364 div_u64_rem(ppa, geo->blks_per_lun, &blks);
367 sector_div(ppa, geo->blks_per_lun);
368 div_u64_rem(ppa, geo->luns_per_chnl, &luns);
371 sector_div(ppa, geo->luns_per_chnl);
377 static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
380 struct nvm_geo *geo = &tgt_dev->geo;
383 l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
384 l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
385 l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
386 l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
387 l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
388 l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;
393 static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
396 struct nvm_geo *geo = &tgt_dev->geo;
401 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
403 l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
404 (((1 << geo->ppaf.blk_len) - 1));
405 l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
406 (((1 << geo->ppaf.pg_len) - 1));
407 l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
408 (((1 << geo->ppaf.sect_len) - 1));
409 l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
410 (((1 << geo->ppaf.pln_len) - 1));
411 l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
412 (((1 << geo->ppaf.lun_len) - 1));
413 l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
414 (((1 << geo->ppaf.ch_len) - 1));
419 static inline int ppa_empty(struct ppa_addr ppa_addr)
421 return (ppa_addr.ppa == ADDR_EMPTY);
424 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
426 ppa_addr->ppa = ADDR_EMPTY;
429 static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
431 if (ppa_empty(ppa1) || ppa_empty(ppa2))
434 return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
435 (ppa1.g.blk == ppa2.g.blk));
438 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
439 typedef sector_t (nvm_tgt_capacity_fn)(void *);
440 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_erase_sync(struct nvm_tgt_dev *, struct ppa_addr *, int);
483 extern int nvm_set_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *,
484 const struct ppa_addr *, int, int);
485 extern void nvm_free_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *);
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 */