]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/lightnvm.h
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
;
51 typedef int (nvm_l2p_update_fn
)(u64
, u32
, __le64
*, void *);
52 typedef int (nvm_id_fn
)(struct nvm_dev
*, struct nvm_id
*);
53 typedef int (nvm_get_l2p_tbl_fn
)(struct nvm_dev
*, u64
, u32
,
54 nvm_l2p_update_fn
*, void *);
55 typedef int (nvm_op_bb_tbl_fn
)(struct nvm_dev
*, struct ppa_addr
, u8
*);
56 typedef int (nvm_op_set_bb_fn
)(struct nvm_dev
*, struct ppa_addr
*, int, int);
57 typedef int (nvm_submit_io_fn
)(struct nvm_dev
*, struct nvm_rq
*);
58 typedef int (nvm_erase_blk_fn
)(struct nvm_dev
*, struct nvm_rq
*);
59 typedef void *(nvm_create_dma_pool_fn
)(struct nvm_dev
*, char *);
60 typedef void (nvm_destroy_dma_pool_fn
)(void *);
61 typedef void *(nvm_dev_dma_alloc_fn
)(struct nvm_dev
*, void *, gfp_t
,
63 typedef void (nvm_dev_dma_free_fn
)(void *, void*, dma_addr_t
);
67 nvm_get_l2p_tbl_fn
*get_l2p_tbl
;
68 nvm_op_bb_tbl_fn
*get_bb_tbl
;
69 nvm_op_set_bb_fn
*set_bb_tbl
;
71 nvm_submit_io_fn
*submit_io
;
72 nvm_erase_blk_fn
*erase_block
;
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
;
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,
112 NVM_OP_HBREAD
= 0x02,
113 NVM_OP_HBWRITE
= 0x81,
114 NVM_OP_PWRITE
= 0x91,
118 /* PPA Command Flags */
119 NVM_IO_SNGL_ACCESS
= 0x0,
120 NVM_IO_DUAL_ACCESS
= 0x1,
121 NVM_IO_QUAD_ACCESS
= 0x2,
123 /* NAND Access Modes */
124 NVM_IO_SUSPEND
= 0x80,
125 NVM_IO_SLC_MODE
= 0x100,
126 NVM_IO_SCRAMBLE_DISABLE
= 0x200,
129 NVM_BLK_T_FREE
= 0x0,
131 NVM_BLK_T_GRWN_BAD
= 0x2,
133 NVM_BLK_T_HOST
= 0x8,
135 /* Memory capabilities */
136 NVM_ID_CAP_SLC
= 0x1,
137 NVM_ID_CAP_CMD_SUSPEND
= 0x2,
138 NVM_ID_CAP_SCRAMBLE
= 0x4,
139 NVM_ID_CAP_ENCRYPT
= 0x8,
142 NVM_ID_FMTYPE_SLC
= 0,
143 NVM_ID_FMTYPE_MLC
= 1,
145 /* Device capabilities */
146 NVM_ID_DCAP_BBLKMGMT
= 0x1,
147 NVM_UD_DCAP_ECC
= 0x2,
150 struct nvm_id_lp_mlc
{
155 struct nvm_id_lp_tbl
{
157 struct nvm_id_lp_mlc mlc
;
160 struct nvm_id_group
{
181 struct nvm_id_lp_tbl lptbl
;
184 struct nvm_addr_format
{
205 struct nvm_addr_format ppaf
;
206 struct nvm_id_group groups
[4];
210 struct list_head list
;
212 struct nvm_tgt_type
*type
;
213 struct gendisk
*disk
;
216 struct nvm_tgt_instance
{
217 struct nvm_tgt_type
*tt
;
220 #define ADDR_EMPTY (~0ULL)
222 #define NVM_VERSION_MAJOR 1
223 #define NVM_VERSION_MINOR 0
224 #define NVM_VERSION_PATCH 0
227 typedef void (nvm_end_io_fn
)(struct nvm_rq
*);
230 struct nvm_tgt_instance
*ins
;
236 struct ppa_addr ppa_addr
;
237 dma_addr_t dma_ppa_list
;
240 struct ppa_addr
*ppa_list
;
243 dma_addr_t dma_meta_list
;
245 struct completion
*wait
;
246 nvm_end_io_fn
*end_io
;
252 u64 ppa_status
; /* ppa media status */
256 static inline struct nvm_rq
*nvm_rq_from_pdu(void *pdu
)
258 return pdu
- sizeof(struct nvm_rq
);
261 static inline void *nvm_rq_to_pdu(struct nvm_rq
*rqdata
)
276 unsigned int nr_free_blocks
; /* Number of unused blocks */
277 struct nvm_block
*blocks
;
281 NVM_BLK_ST_FREE
= 0x1, /* Free block */
282 NVM_BLK_ST_TGT
= 0x2, /* Block in use by target */
283 NVM_BLK_ST_BAD
= 0x8, /* Bad block */
287 struct list_head list
;
295 /* system block cpu representation */
298 unsigned long erase_cnt
;
299 unsigned int version
;
300 char mmtype
[NVM_MMTYPE_LEN
];
301 struct ppa_addr fs_ppa
;
305 struct nvm_dev_ops
*ops
;
307 struct list_head devices
;
310 struct nvmm_type
*mt
;
314 struct nvm_sb_info sb
;
316 /* Device information */
320 int sec_per_pg
; /* only sectors for a single page */
324 int pfpg_size
; /* size of buffer if all pages are to be read */
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
;
348 unsigned long *lun_map
;
351 struct nvm_id identity
;
354 struct request_queue
*q
;
356 struct device
*parent_dev
;
357 char name
[DISK_NAME_LEN
];
364 static inline struct ppa_addr
generic_to_dev_addr(struct nvm_dev
*dev
,
369 l
.ppa
= ((u64
)r
.g
.blk
) << dev
->ppaf
.blk_offset
;
370 l
.ppa
|= ((u64
)r
.g
.pg
) << dev
->ppaf
.pg_offset
;
371 l
.ppa
|= ((u64
)r
.g
.sec
) << dev
->ppaf
.sect_offset
;
372 l
.ppa
|= ((u64
)r
.g
.pl
) << dev
->ppaf
.pln_offset
;
373 l
.ppa
|= ((u64
)r
.g
.lun
) << dev
->ppaf
.lun_offset
;
374 l
.ppa
|= ((u64
)r
.g
.ch
) << dev
->ppaf
.ch_offset
;
379 static inline struct ppa_addr
dev_to_generic_addr(struct nvm_dev
*dev
,
386 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
388 l
.g
.blk
= (r
.ppa
>> dev
->ppaf
.blk_offset
) &
389 (((1 << dev
->ppaf
.blk_len
) - 1));
390 l
.g
.pg
|= (r
.ppa
>> dev
->ppaf
.pg_offset
) &
391 (((1 << dev
->ppaf
.pg_len
) - 1));
392 l
.g
.sec
|= (r
.ppa
>> dev
->ppaf
.sect_offset
) &
393 (((1 << dev
->ppaf
.sect_len
) - 1));
394 l
.g
.pl
|= (r
.ppa
>> dev
->ppaf
.pln_offset
) &
395 (((1 << dev
->ppaf
.pln_len
) - 1));
396 l
.g
.lun
|= (r
.ppa
>> dev
->ppaf
.lun_offset
) &
397 (((1 << dev
->ppaf
.lun_len
) - 1));
398 l
.g
.ch
|= (r
.ppa
>> dev
->ppaf
.ch_offset
) &
399 (((1 << dev
->ppaf
.ch_len
) - 1));
404 static inline int ppa_empty(struct ppa_addr ppa_addr
)
406 return (ppa_addr
.ppa
== ADDR_EMPTY
);
409 static inline void ppa_set_empty(struct ppa_addr
*ppa_addr
)
411 ppa_addr
->ppa
= ADDR_EMPTY
;
414 static inline struct ppa_addr
block_to_ppa(struct nvm_dev
*dev
,
415 struct nvm_block
*blk
)
418 struct nvm_lun
*lun
= blk
->lun
;
421 ppa
.g
.blk
= blk
->id
% dev
->blks_per_lun
;
422 ppa
.g
.lun
= lun
->lun_id
;
423 ppa
.g
.ch
= lun
->chnl_id
;
428 static inline int ppa_to_slc(struct nvm_dev
*dev
, int slc_pg
)
430 return dev
->lptbl
[slc_pg
];
433 typedef blk_qc_t (nvm_tgt_make_rq_fn
)(struct request_queue
*, struct bio
*);
434 typedef sector_t (nvm_tgt_capacity_fn
)(void *);
435 typedef void *(nvm_tgt_init_fn
)(struct nvm_dev
*, struct gendisk
*, int, int);
436 typedef void (nvm_tgt_exit_fn
)(void *);
438 struct nvm_tgt_type
{
440 unsigned int version
[3];
442 /* target entry points */
443 nvm_tgt_make_rq_fn
*make_rq
;
444 nvm_tgt_capacity_fn
*capacity
;
445 nvm_end_io_fn
*end_io
;
447 /* module-specific init/teardown */
448 nvm_tgt_init_fn
*init
;
449 nvm_tgt_exit_fn
*exit
;
451 /* For internal use */
452 struct list_head list
;
455 extern struct nvm_tgt_type
*nvm_find_target_type(const char *, int);
457 extern int nvm_register_tgt_type(struct nvm_tgt_type
*);
458 extern void nvm_unregister_tgt_type(struct nvm_tgt_type
*);
460 extern void *nvm_dev_dma_alloc(struct nvm_dev
*, gfp_t
, dma_addr_t
*);
461 extern void nvm_dev_dma_free(struct nvm_dev
*, void *, dma_addr_t
);
463 typedef int (nvmm_register_fn
)(struct nvm_dev
*);
464 typedef void (nvmm_unregister_fn
)(struct nvm_dev
*);
466 typedef int (nvmm_create_tgt_fn
)(struct nvm_dev
*, struct nvm_ioctl_create
*);
467 typedef int (nvmm_remove_tgt_fn
)(struct nvm_dev
*, struct nvm_ioctl_remove
*);
468 typedef struct nvm_block
*(nvmm_get_blk_fn
)(struct nvm_dev
*,
469 struct nvm_lun
*, unsigned long);
470 typedef void (nvmm_put_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
471 typedef int (nvmm_open_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
472 typedef int (nvmm_close_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
473 typedef void (nvmm_flush_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
474 typedef int (nvmm_submit_io_fn
)(struct nvm_dev
*, struct nvm_rq
*);
475 typedef int (nvmm_erase_blk_fn
)(struct nvm_dev
*, struct nvm_block
*,
477 typedef void (nvmm_mark_blk_fn
)(struct nvm_dev
*, struct ppa_addr
, int);
478 typedef struct nvm_lun
*(nvmm_get_lun_fn
)(struct nvm_dev
*, int);
479 typedef int (nvmm_reserve_lun
)(struct nvm_dev
*, int);
480 typedef void (nvmm_release_lun
)(struct nvm_dev
*, int);
481 typedef void (nvmm_lun_info_print_fn
)(struct nvm_dev
*);
483 typedef int (nvmm_get_area_fn
)(struct nvm_dev
*, sector_t
*, sector_t
);
484 typedef void (nvmm_put_area_fn
)(struct nvm_dev
*, sector_t
);
488 unsigned int version
[3];
490 nvmm_register_fn
*register_mgr
;
491 nvmm_unregister_fn
*unregister_mgr
;
493 nvmm_create_tgt_fn
*create_tgt
;
494 nvmm_remove_tgt_fn
*remove_tgt
;
496 /* Block administration callbacks */
497 nvmm_get_blk_fn
*get_blk
;
498 nvmm_put_blk_fn
*put_blk
;
499 nvmm_open_blk_fn
*open_blk
;
500 nvmm_close_blk_fn
*close_blk
;
501 nvmm_flush_blk_fn
*flush_blk
;
503 nvmm_submit_io_fn
*submit_io
;
504 nvmm_erase_blk_fn
*erase_blk
;
507 nvmm_mark_blk_fn
*mark_blk
;
509 /* Configuration management */
510 nvmm_get_lun_fn
*get_lun
;
511 nvmm_reserve_lun
*reserve_lun
;
512 nvmm_release_lun
*release_lun
;
515 nvmm_lun_info_print_fn
*lun_info_print
;
517 nvmm_get_area_fn
*get_area
;
518 nvmm_put_area_fn
*put_area
;
520 struct list_head list
;
523 extern int nvm_register_mgr(struct nvmm_type
*);
524 extern void nvm_unregister_mgr(struct nvmm_type
*);
526 extern struct nvm_block
*nvm_get_blk(struct nvm_dev
*, struct nvm_lun
*,
528 extern void nvm_put_blk(struct nvm_dev
*, struct nvm_block
*);
530 extern struct nvm_dev
*nvm_alloc_dev(int);
531 extern int nvm_register(struct nvm_dev
*);
532 extern void nvm_unregister(struct nvm_dev
*);
534 void nvm_mark_blk(struct nvm_dev
*dev
, struct ppa_addr ppa
, int type
);
536 extern int nvm_submit_io(struct nvm_dev
*, struct nvm_rq
*);
537 extern void nvm_generic_to_addr_mode(struct nvm_dev
*, struct nvm_rq
*);
538 extern void nvm_addr_to_generic_mode(struct nvm_dev
*, struct nvm_rq
*);
539 extern int nvm_set_rqd_ppalist(struct nvm_dev
*, struct nvm_rq
*,
540 const struct ppa_addr
*, int, int);
541 extern void nvm_free_rqd_ppalist(struct nvm_dev
*, struct nvm_rq
*);
542 extern int nvm_erase_ppa(struct nvm_dev
*, struct ppa_addr
*, int);
543 extern int nvm_erase_blk(struct nvm_dev
*, struct nvm_block
*);
544 extern void nvm_end_io(struct nvm_rq
*, int);
545 extern int nvm_submit_ppa(struct nvm_dev
*, struct ppa_addr
*, int, int, int,
547 extern int nvm_submit_ppa_list(struct nvm_dev
*, struct ppa_addr
*, int, int,
549 extern int nvm_bb_tbl_fold(struct nvm_dev
*, u8
*, int);
550 extern int nvm_get_bb_tbl(struct nvm_dev
*, struct ppa_addr
, u8
*);
553 #define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
555 /* system block on disk representation */
556 struct nvm_system_block
{
557 __be32 magic
; /* magic signature */
558 __be32 seqnr
; /* sequence number */
559 __be32 erase_cnt
; /* erase count */
560 __be16 version
; /* version number */
561 u8 mmtype
[NVM_MMTYPE_LEN
]; /* media manager name */
562 __be64 fs_ppa
; /* PPA for media manager
566 extern int nvm_get_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
567 extern int nvm_update_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
568 extern int nvm_init_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
570 extern int nvm_dev_factory(struct nvm_dev
*, int flags
);
572 #define nvm_for_each_lun_ppa(dev, ppa, chid, lunid) \
573 for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls; \
574 (chid)++, (ppa).g.ch = (chid)) \
575 for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl; \
576 (lunid)++, (ppa).g.lun = (lunid))
578 #else /* CONFIG_NVM */
581 static inline struct nvm_dev
*nvm_alloc_dev(int node
)
583 return ERR_PTR(-EINVAL
);
585 static inline int nvm_register(struct nvm_dev
*dev
)
589 static inline void nvm_unregister(struct nvm_dev
*dev
) {}
590 #endif /* CONFIG_NVM */
591 #endif /* LIGHTNVM.H */