1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/blkdev.h>
6 #include <linux/types.h>
7 #include <uapi/linux/lightnvm.h>
20 #define NVM_GEN_CH_BITS (8)
21 #define NVM_GEN_LUN_BITS (8)
22 #define NVM_GEN_BLK_BITS (16)
23 #define NVM_GEN_RESERVED (32)
26 #define NVM_12_PG_BITS (16)
27 #define NVM_12_PL_BITS (4)
28 #define NVM_12_SEC_BITS (4)
29 #define NVM_12_RESERVED (8)
32 #define NVM_20_SEC_BITS (24)
33 #define NVM_20_RESERVED (8)
36 NVM_OCSSD_SPEC_12 = 12,
37 NVM_OCSSD_SPEC_20 = 20,
41 /* Generic structure for all addresses */
43 /* generic device format */
45 u64 ch : NVM_GEN_CH_BITS;
46 u64 lun : NVM_GEN_LUN_BITS;
47 u64 blk : NVM_GEN_BLK_BITS;
48 u64 reserved : NVM_GEN_RESERVED;
51 /* 1.2 device format */
53 u64 ch : NVM_GEN_CH_BITS;
54 u64 lun : NVM_GEN_LUN_BITS;
55 u64 blk : NVM_GEN_BLK_BITS;
56 u64 pg : NVM_12_PG_BITS;
57 u64 pl : NVM_12_PL_BITS;
58 u64 sec : NVM_12_SEC_BITS;
59 u64 reserved : NVM_12_RESERVED;
62 /* 2.0 device format */
64 u64 grp : NVM_GEN_CH_BITS;
65 u64 pu : NVM_GEN_LUN_BITS;
66 u64 chk : NVM_GEN_BLK_BITS;
67 u64 sec : NVM_20_SEC_BITS;
68 u64 reserved : NVM_20_RESERVED;
86 typedef int (nvm_id_fn)(struct nvm_dev *);
87 typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
88 typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
89 typedef int (nvm_get_chk_meta_fn)(struct nvm_dev *, sector_t, int,
90 struct nvm_chk_meta *);
91 typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
92 typedef int (nvm_submit_io_sync_fn)(struct nvm_dev *, struct nvm_rq *);
93 typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *, int);
94 typedef void (nvm_destroy_dma_pool_fn)(void *);
95 typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
97 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
101 nvm_op_bb_tbl_fn *get_bb_tbl;
102 nvm_op_set_bb_fn *set_bb_tbl;
104 nvm_get_chk_meta_fn *get_chk_meta;
106 nvm_submit_io_fn *submit_io;
107 nvm_submit_io_sync_fn *submit_io_sync;
109 nvm_create_dma_pool_fn *create_dma_pool;
110 nvm_destroy_dma_pool_fn *destroy_dma_pool;
111 nvm_dev_dma_alloc_fn *dev_dma_alloc;
112 nvm_dev_dma_free_fn *dev_dma_free;
117 #include <linux/blkdev.h>
118 #include <linux/file.h>
119 #include <linux/dmapool.h>
120 #include <uapi/linux/lightnvm.h>
123 /* HW Responsibilities */
124 NVM_RSP_L2P = 1 << 0,
125 NVM_RSP_ECC = 1 << 1,
127 /* Physical Adressing Mode */
128 NVM_ADDRMODE_LINEAR = 0,
129 NVM_ADDRMODE_CHANNEL = 1,
131 /* Plane programming mode for LUN */
132 NVM_PLANE_SINGLE = 1,
133 NVM_PLANE_DOUBLE = 2,
137 NVM_RSP_SUCCESS = 0x0,
138 NVM_RSP_NOT_CHANGEABLE = 0x1,
139 NVM_RSP_ERR_FAILWRITE = 0x40ff,
140 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
141 NVM_RSP_ERR_FAILECC = 0x4281,
142 NVM_RSP_ERR_FAILCRC = 0x4004,
143 NVM_RSP_WARN_HIGHECC = 0x4700,
146 NVM_OP_PWRITE = 0x91,
150 /* PPA Command Flags */
151 NVM_IO_SNGL_ACCESS = 0x0,
152 NVM_IO_DUAL_ACCESS = 0x1,
153 NVM_IO_QUAD_ACCESS = 0x2,
155 /* NAND Access Modes */
156 NVM_IO_SUSPEND = 0x80,
157 NVM_IO_SLC_MODE = 0x100,
158 NVM_IO_SCRAMBLE_ENABLE = 0x200,
161 NVM_BLK_T_FREE = 0x0,
163 NVM_BLK_T_GRWN_BAD = 0x2,
165 NVM_BLK_T_HOST = 0x8,
167 /* Memory capabilities */
168 NVM_ID_CAP_SLC = 0x1,
169 NVM_ID_CAP_CMD_SUSPEND = 0x2,
170 NVM_ID_CAP_SCRAMBLE = 0x4,
171 NVM_ID_CAP_ENCRYPT = 0x8,
174 NVM_ID_FMTYPE_SLC = 0,
175 NVM_ID_FMTYPE_MLC = 1,
177 /* Device capabilities */
178 NVM_ID_DCAP_BBLKMGMT = 0x1,
179 NVM_UD_DCAP_ECC = 0x2,
182 struct nvm_id_lp_mlc {
187 struct nvm_id_lp_tbl {
189 struct nvm_id_lp_mlc mlc;
192 struct nvm_addrf_12 {
237 NVM_CHK_ST_FREE = 1 << 0,
238 NVM_CHK_ST_CLOSED = 1 << 1,
239 NVM_CHK_ST_OPEN = 1 << 2,
240 NVM_CHK_ST_OFFLINE = 1 << 3,
243 NVM_CHK_TP_W_SEQ = 1 << 0,
244 NVM_CHK_TP_W_RAN = 1 << 1,
245 NVM_CHK_TP_SZ_SPEC = 1 << 4,
249 * Note: The structure size is linked to nvme_nvm_chk_meta such that the same
250 * buffer can be used when converting from little endian to cpu addressing.
252 struct nvm_chk_meta {
263 struct list_head list;
264 struct nvm_tgt_dev *dev;
265 struct nvm_tgt_type *type;
266 struct gendisk *disk;
269 #define ADDR_EMPTY (~0ULL)
271 #define NVM_TARGET_DEFAULT_OP (101)
272 #define NVM_TARGET_MIN_OP (3)
273 #define NVM_TARGET_MAX_OP (80)
275 #define NVM_VERSION_MAJOR 1
276 #define NVM_VERSION_MINOR 0
277 #define NVM_VERSION_PATCH 0
279 #define NVM_MAX_VLBA (64) /* max logical blocks in a vector command */
282 typedef void (nvm_end_io_fn)(struct nvm_rq *);
285 struct nvm_tgt_dev *dev;
290 struct ppa_addr ppa_addr;
291 dma_addr_t dma_ppa_list;
294 struct ppa_addr *ppa_list;
297 dma_addr_t dma_meta_list;
299 nvm_end_io_fn *end_io;
305 u64 ppa_status; /* ppa media status */
308 int is_seq; /* Sequential hint flag. 1.2 only */
313 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
315 return pdu - sizeof(struct nvm_rq);
318 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
323 static inline struct ppa_addr *nvm_rq_to_ppa_list(struct nvm_rq *rqd)
325 return (rqd->nr_ppas > 1) ? rqd->ppa_list : &rqd->ppa_addr;
329 NVM_BLK_ST_FREE = 0x1, /* Free block */
330 NVM_BLK_ST_TGT = 0x2, /* Block in use by target */
331 NVM_BLK_ST_BAD = 0x8, /* Bad block */
334 /* Instance geometry */
336 /* device reported version */
340 /* kernel short version */
343 /* instance specific geometry */
345 int num_lun; /* per channel */
347 /* calculated values */
348 int all_luns; /* across channels */
349 int all_chunks; /* across channels */
351 int op; /* over-provision in instance */
353 sector_t total_secs; /* across channels */
356 u32 num_chk; /* chunks per lun */
357 u32 clba; /* sectors per chunk */
358 u16 csecs; /* sector size */
359 u16 sos; /* out-of-band area size */
360 bool ext; /* metadata in extended data buffer */
361 u32 mdts; /* Max data transfer size*/
363 /* device write constrains */
364 u32 ws_min; /* minimum write size */
365 u32 ws_opt; /* optimal write size */
366 u32 mw_cunits; /* distance required for successful read */
367 u32 maxoc; /* maximum open chunks */
368 u32 maxocpu; /* maximum open chunks per parallel unit */
370 /* device capabilities */
374 u32 trdt; /* Avg. Tread (ns) */
375 u32 trdm; /* Max Tread (ns) */
376 u32 tprt; /* Avg. Tprog (ns) */
377 u32 tprm; /* Max Tprog (ns) */
378 u32 tbet; /* Avg. Terase (ns) */
379 u32 tbem; /* Max Terase (ns) */
381 /* generic address format */
382 struct nvm_addrf addrf;
384 /* 1.2 compatibility */
401 /* sub-device structure */
403 /* Device information */
406 /* Base ppas for target LUNs */
407 struct ppa_addr *luns;
409 struct request_queue *q;
411 struct nvm_dev *parent;
416 struct nvm_dev_ops *ops;
418 struct list_head devices;
420 /* Device information */
423 unsigned long *lun_map;
427 struct request_queue *q;
428 char name[DISK_NAME_LEN];
437 /* target management */
438 struct list_head area_list;
439 struct list_head targets;
442 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
445 struct nvm_geo *geo = &dev->geo;
448 if (geo->version == NVM_OCSSD_SPEC_12) {
449 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&geo->addrf;
451 l.ppa = ((u64)r.g.ch) << ppaf->ch_offset;
452 l.ppa |= ((u64)r.g.lun) << ppaf->lun_offset;
453 l.ppa |= ((u64)r.g.blk) << ppaf->blk_offset;
454 l.ppa |= ((u64)r.g.pg) << ppaf->pg_offset;
455 l.ppa |= ((u64)r.g.pl) << ppaf->pln_offset;
456 l.ppa |= ((u64)r.g.sec) << ppaf->sec_offset;
458 struct nvm_addrf *lbaf = &geo->addrf;
460 l.ppa = ((u64)r.m.grp) << lbaf->ch_offset;
461 l.ppa |= ((u64)r.m.pu) << lbaf->lun_offset;
462 l.ppa |= ((u64)r.m.chk) << lbaf->chk_offset;
463 l.ppa |= ((u64)r.m.sec) << lbaf->sec_offset;
469 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
472 struct nvm_geo *geo = &dev->geo;
477 if (geo->version == NVM_OCSSD_SPEC_12) {
478 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&geo->addrf;
480 l.g.ch = (r.ppa & ppaf->ch_mask) >> ppaf->ch_offset;
481 l.g.lun = (r.ppa & ppaf->lun_mask) >> ppaf->lun_offset;
482 l.g.blk = (r.ppa & ppaf->blk_mask) >> ppaf->blk_offset;
483 l.g.pg = (r.ppa & ppaf->pg_mask) >> ppaf->pg_offset;
484 l.g.pl = (r.ppa & ppaf->pln_mask) >> ppaf->pln_offset;
485 l.g.sec = (r.ppa & ppaf->sec_mask) >> ppaf->sec_offset;
487 struct nvm_addrf *lbaf = &geo->addrf;
489 l.m.grp = (r.ppa & lbaf->ch_mask) >> lbaf->ch_offset;
490 l.m.pu = (r.ppa & lbaf->lun_mask) >> lbaf->lun_offset;
491 l.m.chk = (r.ppa & lbaf->chk_mask) >> lbaf->chk_offset;
492 l.m.sec = (r.ppa & lbaf->sec_mask) >> lbaf->sec_offset;
498 static inline u64 dev_to_chunk_addr(struct nvm_dev *dev, void *addrf,
501 struct nvm_geo *geo = &dev->geo;
504 if (geo->version == NVM_OCSSD_SPEC_12) {
505 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)addrf;
507 caddr = (u64)p.g.pg << ppaf->pg_offset;
508 caddr |= (u64)p.g.pl << ppaf->pln_offset;
509 caddr |= (u64)p.g.sec << ppaf->sec_offset;
517 static inline struct ppa_addr nvm_ppa32_to_ppa64(struct nvm_dev *dev,
518 void *addrf, u32 ppa32)
520 struct ppa_addr ppa64;
525 ppa64.ppa = ADDR_EMPTY;
526 } else if (ppa32 & (1U << 31)) {
527 ppa64.c.line = ppa32 & ((~0U) >> 1);
528 ppa64.c.is_cached = 1;
530 struct nvm_geo *geo = &dev->geo;
532 if (geo->version == NVM_OCSSD_SPEC_12) {
533 struct nvm_addrf_12 *ppaf = addrf;
535 ppa64.g.ch = (ppa32 & ppaf->ch_mask) >>
537 ppa64.g.lun = (ppa32 & ppaf->lun_mask) >>
539 ppa64.g.blk = (ppa32 & ppaf->blk_mask) >>
541 ppa64.g.pg = (ppa32 & ppaf->pg_mask) >>
543 ppa64.g.pl = (ppa32 & ppaf->pln_mask) >>
545 ppa64.g.sec = (ppa32 & ppaf->sec_mask) >>
548 struct nvm_addrf *lbaf = addrf;
550 ppa64.m.grp = (ppa32 & lbaf->ch_mask) >>
552 ppa64.m.pu = (ppa32 & lbaf->lun_mask) >>
554 ppa64.m.chk = (ppa32 & lbaf->chk_mask) >>
556 ppa64.m.sec = (ppa32 & lbaf->sec_mask) >>
564 static inline u32 nvm_ppa64_to_ppa32(struct nvm_dev *dev,
565 void *addrf, struct ppa_addr ppa64)
569 if (ppa64.ppa == ADDR_EMPTY) {
571 } else if (ppa64.c.is_cached) {
572 ppa32 |= ppa64.c.line;
575 struct nvm_geo *geo = &dev->geo;
577 if (geo->version == NVM_OCSSD_SPEC_12) {
578 struct nvm_addrf_12 *ppaf = addrf;
580 ppa32 |= ppa64.g.ch << ppaf->ch_offset;
581 ppa32 |= ppa64.g.lun << ppaf->lun_offset;
582 ppa32 |= ppa64.g.blk << ppaf->blk_offset;
583 ppa32 |= ppa64.g.pg << ppaf->pg_offset;
584 ppa32 |= ppa64.g.pl << ppaf->pln_offset;
585 ppa32 |= ppa64.g.sec << ppaf->sec_offset;
587 struct nvm_addrf *lbaf = addrf;
589 ppa32 |= ppa64.m.grp << lbaf->ch_offset;
590 ppa32 |= ppa64.m.pu << lbaf->lun_offset;
591 ppa32 |= ppa64.m.chk << lbaf->chk_offset;
592 ppa32 |= ppa64.m.sec << lbaf->sec_offset;
599 static inline int nvm_next_ppa_in_chk(struct nvm_tgt_dev *dev,
600 struct ppa_addr *ppa)
602 struct nvm_geo *geo = &dev->geo;
605 if (geo->version == NVM_OCSSD_SPEC_12) {
606 int sec = ppa->g.sec;
609 if (sec == geo->ws_min) {
614 if (pg == geo->num_pg) {
619 if (pl == geo->num_pln)
629 if (ppa->m.sec == geo->clba)
636 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
637 typedef sector_t (nvm_tgt_capacity_fn)(void *);
638 typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *,
640 typedef void (nvm_tgt_exit_fn)(void *, bool);
641 typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
642 typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);
645 NVM_TGT_F_DEV_L2P = 0,
646 NVM_TGT_F_HOST_L2P = 1 << 0,
649 struct nvm_tgt_type {
651 unsigned int version[3];
654 /* target entry points */
655 nvm_tgt_make_rq_fn *make_rq;
656 nvm_tgt_capacity_fn *capacity;
658 /* module-specific init/teardown */
659 nvm_tgt_init_fn *init;
660 nvm_tgt_exit_fn *exit;
663 nvm_tgt_sysfs_init_fn *sysfs_init;
664 nvm_tgt_sysfs_exit_fn *sysfs_exit;
666 /* For internal use */
667 struct list_head list;
668 struct module *owner;
671 extern int nvm_register_tgt_type(struct nvm_tgt_type *);
672 extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
674 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
675 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
677 extern struct nvm_dev *nvm_alloc_dev(int);
678 extern int nvm_register(struct nvm_dev *);
679 extern void nvm_unregister(struct nvm_dev *);
681 extern int nvm_get_chunk_meta(struct nvm_tgt_dev *, struct ppa_addr,
682 int, struct nvm_chk_meta *);
683 extern int nvm_set_chunk_meta(struct nvm_tgt_dev *, struct ppa_addr *,
685 extern int nvm_submit_io(struct nvm_tgt_dev *, struct nvm_rq *);
686 extern int nvm_submit_io_sync(struct nvm_tgt_dev *, struct nvm_rq *);
687 extern void nvm_end_io(struct nvm_rq *);
689 #else /* CONFIG_NVM */
692 static inline struct nvm_dev *nvm_alloc_dev(int node)
694 return ERR_PTR(-EINVAL);
696 static inline int nvm_register(struct nvm_dev *dev)
700 static inline void nvm_unregister(struct nvm_dev *dev) {}
701 #endif /* CONFIG_NVM */
702 #endif /* LIGHTNVM.H */