4 #include <linux/types.h>
16 #define NVM_BLK_BITS (16)
17 #define NVM_PG_BITS (16)
18 #define NVM_SEC_BITS (8)
19 #define NVM_PL_BITS (8)
20 #define NVM_LUN_BITS (8)
21 #define NVM_CH_BITS (8)
24 /* Generic structure for all addresses */
27 u64 blk
: NVM_BLK_BITS
;
29 u64 sec
: NVM_SEC_BITS
;
31 u64 lun
: NVM_LUN_BITS
;
43 typedef int (nvm_l2p_update_fn
)(u64
, u32
, __le64
*, void *);
44 typedef int (nvm_bb_update_fn
)(struct nvm_dev
*, struct ppa_addr
, u8
*, int,
46 typedef int (nvm_id_fn
)(struct nvm_dev
*, struct nvm_id
*);
47 typedef int (nvm_get_l2p_tbl_fn
)(struct nvm_dev
*, u64
, u32
,
48 nvm_l2p_update_fn
*, void *);
49 typedef int (nvm_op_bb_tbl_fn
)(struct nvm_dev
*, struct ppa_addr
,
50 nvm_bb_update_fn
*, void *);
51 typedef int (nvm_op_set_bb_fn
)(struct nvm_dev
*, struct nvm_rq
*, int);
52 typedef int (nvm_submit_io_fn
)(struct nvm_dev
*, struct nvm_rq
*);
53 typedef int (nvm_erase_blk_fn
)(struct nvm_dev
*, struct nvm_rq
*);
54 typedef void *(nvm_create_dma_pool_fn
)(struct nvm_dev
*, char *);
55 typedef void (nvm_destroy_dma_pool_fn
)(void *);
56 typedef void *(nvm_dev_dma_alloc_fn
)(struct nvm_dev
*, void *, gfp_t
,
58 typedef void (nvm_dev_dma_free_fn
)(void *, void*, dma_addr_t
);
62 nvm_get_l2p_tbl_fn
*get_l2p_tbl
;
63 nvm_op_bb_tbl_fn
*get_bb_tbl
;
64 nvm_op_set_bb_fn
*set_bb_tbl
;
66 nvm_submit_io_fn
*submit_io
;
67 nvm_erase_blk_fn
*erase_block
;
69 nvm_create_dma_pool_fn
*create_dma_pool
;
70 nvm_destroy_dma_pool_fn
*destroy_dma_pool
;
71 nvm_dev_dma_alloc_fn
*dev_dma_alloc
;
72 nvm_dev_dma_free_fn
*dev_dma_free
;
74 unsigned int max_phys_sect
;
81 #include <linux/blkdev.h>
82 #include <linux/file.h>
83 #include <linux/dmapool.h>
84 #include <uapi/linux/lightnvm.h>
87 /* HW Responsibilities */
91 /* Physical Adressing Mode */
92 NVM_ADDRMODE_LINEAR
= 0,
93 NVM_ADDRMODE_CHANNEL
= 1,
95 /* Plane programming mode for LUN */
101 NVM_RSP_SUCCESS
= 0x0,
102 NVM_RSP_NOT_CHANGEABLE
= 0x1,
103 NVM_RSP_ERR_FAILWRITE
= 0x40ff,
104 NVM_RSP_ERR_EMPTYPAGE
= 0x42ff,
107 NVM_OP_HBREAD
= 0x02,
108 NVM_OP_HBWRITE
= 0x81,
109 NVM_OP_PWRITE
= 0x91,
113 /* PPA Command Flags */
114 NVM_IO_SNGL_ACCESS
= 0x0,
115 NVM_IO_DUAL_ACCESS
= 0x1,
116 NVM_IO_QUAD_ACCESS
= 0x2,
118 /* NAND Access Modes */
119 NVM_IO_SUSPEND
= 0x80,
120 NVM_IO_SLC_MODE
= 0x100,
121 NVM_IO_SCRAMBLE_DISABLE
= 0x200,
124 NVM_BLK_T_FREE
= 0x0,
126 NVM_BLK_T_GRWN_BAD
= 0x2,
128 NVM_BLK_T_HOST
= 0x8,
130 /* Memory capabilities */
131 NVM_ID_CAP_SLC
= 0x1,
132 NVM_ID_CAP_CMD_SUSPEND
= 0x2,
133 NVM_ID_CAP_SCRAMBLE
= 0x4,
134 NVM_ID_CAP_ENCRYPT
= 0x8,
137 NVM_ID_FMTYPE_SLC
= 0,
138 NVM_ID_FMTYPE_MLC
= 1,
140 /* Device capabilities */
141 NVM_ID_DCAP_BBLKMGMT
= 0x1,
142 NVM_UD_DCAP_ECC
= 0x2,
145 struct nvm_id_lp_mlc
{
150 struct nvm_id_lp_tbl
{
152 struct nvm_id_lp_mlc mlc
;
155 struct nvm_id_group
{
176 struct nvm_id_lp_tbl lptbl
;
179 struct nvm_addr_format
{
200 struct nvm_addr_format ppaf
;
201 struct nvm_id_group groups
[4];
205 struct list_head list
;
206 struct nvm_tgt_type
*type
;
207 struct gendisk
*disk
;
210 struct nvm_tgt_instance
{
211 struct nvm_tgt_type
*tt
;
214 #define ADDR_EMPTY (~0ULL)
216 #define NVM_VERSION_MAJOR 1
217 #define NVM_VERSION_MINOR 0
218 #define NVM_VERSION_PATCH 0
221 typedef void (nvm_end_io_fn
)(struct nvm_rq
*);
224 struct nvm_tgt_instance
*ins
;
230 struct ppa_addr ppa_addr
;
231 dma_addr_t dma_ppa_list
;
234 struct ppa_addr
*ppa_list
;
237 dma_addr_t dma_metadata
;
239 struct completion
*wait
;
240 nvm_end_io_fn
*end_io
;
246 u64 ppa_status
; /* ppa media status */
250 static inline struct nvm_rq
*nvm_rq_from_pdu(void *pdu
)
252 return pdu
- sizeof(struct nvm_rq
);
255 static inline void *nvm_rq_to_pdu(struct nvm_rq
*rqdata
)
268 /* It is up to the target to mark blocks as closed. If the target does
269 * not do it, all blocks are marked as open, and nr_open_blocks
270 * represents the number of blocks in use
272 unsigned int nr_open_blocks
; /* Number of used, writable blocks */
273 unsigned int nr_closed_blocks
; /* Number of used, read-only blocks */
274 unsigned int nr_free_blocks
; /* Number of unused blocks */
275 unsigned int nr_bad_blocks
; /* Number of bad blocks */
279 struct nvm_block
*blocks
;
283 NVM_BLK_ST_FREE
= 0x1, /* Free block */
284 NVM_BLK_ST_OPEN
= 0x2, /* Open block - read-write */
285 NVM_BLK_ST_CLOSED
= 0x4, /* Closed block - read-only */
286 NVM_BLK_ST_BAD
= 0x8, /* Bad block */
290 struct list_head list
;
298 /* system block cpu representation */
301 unsigned long erase_cnt
;
302 unsigned int version
;
303 char mmtype
[NVM_MMTYPE_LEN
];
304 struct ppa_addr fs_ppa
;
308 struct nvm_dev_ops
*ops
;
310 struct list_head devices
;
311 struct list_head online_targets
;
314 struct nvmm_type
*mt
;
318 struct nvm_sb_info sb
;
320 /* Device information */
324 int sec_per_pg
; /* only sectors for a single page */
328 int pfpg_size
; /* size of buffer if all pages are to be read */
332 struct nvm_addr_format ppaf
;
334 /* Calculated/Cached values. These do not reflect the actual usable
335 * blocks at run-time.
338 int plane_mode
; /* drive device in single, double or quad mode */
340 int sec_per_pl
; /* all sectors across planes */
344 /* lower page table */
348 unsigned long total_blocks
;
349 unsigned long total_secs
;
351 unsigned max_pages_per_blk
;
353 unsigned long *lun_map
;
356 struct nvm_id identity
;
359 struct request_queue
*q
;
360 char name
[DISK_NAME_LEN
];
366 static inline struct ppa_addr
generic_to_dev_addr(struct nvm_dev
*dev
,
371 l
.ppa
= ((u64
)r
.g
.blk
) << dev
->ppaf
.blk_offset
;
372 l
.ppa
|= ((u64
)r
.g
.pg
) << dev
->ppaf
.pg_offset
;
373 l
.ppa
|= ((u64
)r
.g
.sec
) << dev
->ppaf
.sect_offset
;
374 l
.ppa
|= ((u64
)r
.g
.pl
) << dev
->ppaf
.pln_offset
;
375 l
.ppa
|= ((u64
)r
.g
.lun
) << dev
->ppaf
.lun_offset
;
376 l
.ppa
|= ((u64
)r
.g
.ch
) << dev
->ppaf
.ch_offset
;
381 static inline struct ppa_addr
dev_to_generic_addr(struct nvm_dev
*dev
,
387 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
389 l
.g
.blk
= (r
.ppa
>> dev
->ppaf
.blk_offset
) &
390 (((1 << dev
->ppaf
.blk_len
) - 1));
391 l
.g
.pg
|= (r
.ppa
>> dev
->ppaf
.pg_offset
) &
392 (((1 << dev
->ppaf
.pg_len
) - 1));
393 l
.g
.sec
|= (r
.ppa
>> dev
->ppaf
.sect_offset
) &
394 (((1 << dev
->ppaf
.sect_len
) - 1));
395 l
.g
.pl
|= (r
.ppa
>> dev
->ppaf
.pln_offset
) &
396 (((1 << dev
->ppaf
.pln_len
) - 1));
397 l
.g
.lun
|= (r
.ppa
>> dev
->ppaf
.lun_offset
) &
398 (((1 << dev
->ppaf
.lun_len
) - 1));
399 l
.g
.ch
|= (r
.ppa
>> dev
->ppaf
.ch_offset
) &
400 (((1 << dev
->ppaf
.ch_len
) - 1));
405 static inline int ppa_empty(struct ppa_addr ppa_addr
)
407 return (ppa_addr
.ppa
== ADDR_EMPTY
);
410 static inline void ppa_set_empty(struct ppa_addr
*ppa_addr
)
412 ppa_addr
->ppa
= ADDR_EMPTY
;
415 static inline struct ppa_addr
block_to_ppa(struct nvm_dev
*dev
,
416 struct nvm_block
*blk
)
419 struct nvm_lun
*lun
= blk
->lun
;
422 ppa
.g
.blk
= blk
->id
% dev
->blks_per_lun
;
423 ppa
.g
.lun
= lun
->lun_id
;
424 ppa
.g
.ch
= lun
->chnl_id
;
429 static inline int ppa_to_slc(struct nvm_dev
*dev
, int slc_pg
)
431 return dev
->lptbl
[slc_pg
];
434 typedef blk_qc_t (nvm_tgt_make_rq_fn
)(struct request_queue
*, struct bio
*);
435 typedef sector_t (nvm_tgt_capacity_fn
)(void *);
436 typedef void *(nvm_tgt_init_fn
)(struct nvm_dev
*, struct gendisk
*, int, int);
437 typedef void (nvm_tgt_exit_fn
)(void *);
439 struct nvm_tgt_type
{
441 unsigned int version
[3];
443 /* target entry points */
444 nvm_tgt_make_rq_fn
*make_rq
;
445 nvm_tgt_capacity_fn
*capacity
;
446 nvm_end_io_fn
*end_io
;
448 /* module-specific init/teardown */
449 nvm_tgt_init_fn
*init
;
450 nvm_tgt_exit_fn
*exit
;
452 /* For internal use */
453 struct list_head list
;
456 extern int nvm_register_tgt_type(struct nvm_tgt_type
*);
457 extern void nvm_unregister_tgt_type(struct nvm_tgt_type
*);
459 extern void *nvm_dev_dma_alloc(struct nvm_dev
*, gfp_t
, dma_addr_t
*);
460 extern void nvm_dev_dma_free(struct nvm_dev
*, void *, dma_addr_t
);
462 typedef int (nvmm_register_fn
)(struct nvm_dev
*);
463 typedef void (nvmm_unregister_fn
)(struct nvm_dev
*);
464 typedef struct nvm_block
*(nvmm_get_blk_fn
)(struct nvm_dev
*,
465 struct nvm_lun
*, unsigned long);
466 typedef void (nvmm_put_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
467 typedef int (nvmm_open_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
468 typedef int (nvmm_close_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
469 typedef void (nvmm_flush_blk_fn
)(struct nvm_dev
*, struct nvm_block
*);
470 typedef int (nvmm_submit_io_fn
)(struct nvm_dev
*, struct nvm_rq
*);
471 typedef int (nvmm_erase_blk_fn
)(struct nvm_dev
*, struct nvm_block
*,
473 typedef struct nvm_lun
*(nvmm_get_lun_fn
)(struct nvm_dev
*, int);
474 typedef int (nvmm_reserve_lun
)(struct nvm_dev
*, int);
475 typedef void (nvmm_release_lun
)(struct nvm_dev
*, int);
476 typedef void (nvmm_lun_info_print_fn
)(struct nvm_dev
*);
478 typedef int (nvmm_get_area_fn
)(struct nvm_dev
*, sector_t
*, sector_t
);
479 typedef void (nvmm_put_area_fn
)(struct nvm_dev
*, sector_t
);
483 unsigned int version
[3];
485 nvmm_register_fn
*register_mgr
;
486 nvmm_unregister_fn
*unregister_mgr
;
488 /* Block administration callbacks */
489 nvmm_get_blk_fn
*get_blk_unlocked
;
490 nvmm_put_blk_fn
*put_blk_unlocked
;
491 nvmm_get_blk_fn
*get_blk
;
492 nvmm_put_blk_fn
*put_blk
;
493 nvmm_open_blk_fn
*open_blk
;
494 nvmm_close_blk_fn
*close_blk
;
495 nvmm_flush_blk_fn
*flush_blk
;
497 nvmm_submit_io_fn
*submit_io
;
498 nvmm_erase_blk_fn
*erase_blk
;
500 /* Configuration management */
501 nvmm_get_lun_fn
*get_lun
;
502 nvmm_reserve_lun
*reserve_lun
;
503 nvmm_release_lun
*release_lun
;
506 nvmm_lun_info_print_fn
*lun_info_print
;
508 nvmm_get_area_fn
*get_area
;
509 nvmm_put_area_fn
*put_area
;
511 struct list_head list
;
514 extern int nvm_register_mgr(struct nvmm_type
*);
515 extern void nvm_unregister_mgr(struct nvmm_type
*);
517 extern struct nvm_block
*nvm_get_blk_unlocked(struct nvm_dev
*,
518 struct nvm_lun
*, unsigned long);
519 extern void nvm_put_blk_unlocked(struct nvm_dev
*, struct nvm_block
*);
521 extern struct nvm_block
*nvm_get_blk(struct nvm_dev
*, struct nvm_lun
*,
523 extern void nvm_put_blk(struct nvm_dev
*, struct nvm_block
*);
525 extern int nvm_register(struct request_queue
*, char *,
526 struct nvm_dev_ops
*);
527 extern void nvm_unregister(char *);
529 extern int nvm_submit_io(struct nvm_dev
*, struct nvm_rq
*);
530 extern void nvm_generic_to_addr_mode(struct nvm_dev
*, struct nvm_rq
*);
531 extern void nvm_addr_to_generic_mode(struct nvm_dev
*, struct nvm_rq
*);
532 extern int nvm_set_rqd_ppalist(struct nvm_dev
*, struct nvm_rq
*,
533 struct ppa_addr
*, int);
534 extern void nvm_free_rqd_ppalist(struct nvm_dev
*, struct nvm_rq
*);
535 extern int nvm_erase_ppa(struct nvm_dev
*, struct ppa_addr
*, int);
536 extern int nvm_erase_blk(struct nvm_dev
*, struct nvm_block
*);
537 extern void nvm_end_io(struct nvm_rq
*, int);
538 extern int nvm_submit_ppa(struct nvm_dev
*, struct ppa_addr
*, int, int, int,
540 extern int nvm_submit_ppa_list(struct nvm_dev
*, struct ppa_addr
*, int, int,
542 extern int nvm_bb_tbl_fold(struct nvm_dev
*, u8
*, int);
545 #define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
547 /* system block on disk representation */
548 struct nvm_system_block
{
549 __be32 magic
; /* magic signature */
550 __be32 seqnr
; /* sequence number */
551 __be32 erase_cnt
; /* erase count */
552 __be16 version
; /* version number */
553 u8 mmtype
[NVM_MMTYPE_LEN
]; /* media manager name */
554 __be64 fs_ppa
; /* PPA for media manager
558 extern int nvm_get_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
559 extern int nvm_update_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
560 extern int nvm_init_sysblock(struct nvm_dev
*, struct nvm_sb_info
*);
562 extern int nvm_dev_factory(struct nvm_dev
*, int flags
);
563 #else /* CONFIG_NVM */
566 static inline int nvm_register(struct request_queue
*q
, char *disk_name
,
567 struct nvm_dev_ops
*ops
)
571 static inline void nvm_unregister(char *disk_name
) {}
572 #endif /* CONFIG_NVM */
573 #endif /* LIGHTNVM.H */
This page took 0.044042 seconds and 6 git commands to generate.