16 #include <linux/blkdev.h>
17 #include <linux/types.h>
18 #include <linux/file.h>
19 #include <linux/dmapool.h>
22 /* HW Responsibilities */
26 /* Physical Adressing Mode */
27 NVM_ADDRMODE_LINEAR = 0,
28 NVM_ADDRMODE_CHANNEL = 1,
30 /* Plane programming mode for LUN */
36 NVM_RSP_SUCCESS = 0x0,
37 NVM_RSP_NOT_CHANGEABLE = 0x1,
38 NVM_RSP_ERR_FAILWRITE = 0x40ff,
39 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
43 NVM_OP_HBWRITE = 0x81,
48 /* PPA Command Flags */
49 NVM_IO_SNGL_ACCESS = 0x0,
50 NVM_IO_DUAL_ACCESS = 0x1,
51 NVM_IO_QUAD_ACCESS = 0x2,
53 /* NAND Access Modes */
54 NVM_IO_SUSPEND = 0x80,
55 NVM_IO_SLC_MODE = 0x100,
56 NVM_IO_SCRAMBLE_DISABLE = 0x200,
61 NVM_BLK_T_GRWN_BAD = 0x2,
88 struct nvm_addr_format {
109 struct nvm_addr_format ppaf;
110 struct nvm_id_group groups[4];
114 struct list_head list;
115 struct nvm_tgt_type *type;
116 struct gendisk *disk;
119 struct nvm_tgt_instance {
120 struct nvm_tgt_type *tt;
123 #define ADDR_EMPTY (~0ULL)
125 #define NVM_VERSION_MAJOR 1
126 #define NVM_VERSION_MINOR 0
127 #define NVM_VERSION_PATCH 0
129 #define NVM_BLK_BITS (16)
130 #define NVM_PG_BITS (16)
131 #define NVM_SEC_BITS (8)
132 #define NVM_PL_BITS (8)
133 #define NVM_LUN_BITS (8)
134 #define NVM_CH_BITS (8)
137 /* Generic structure for all addresses */
140 u64 blk : NVM_BLK_BITS;
141 u64 pg : NVM_PG_BITS;
142 u64 sec : NVM_SEC_BITS;
143 u64 pl : NVM_PL_BITS;
144 u64 lun : NVM_LUN_BITS;
145 u64 ch : NVM_CH_BITS;
153 struct nvm_tgt_instance *ins;
159 struct ppa_addr ppa_addr;
160 dma_addr_t dma_ppa_list;
163 struct ppa_addr *ppa_list;
166 dma_addr_t dma_metadata;
173 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
175 return pdu - sizeof(struct nvm_rq);
178 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
185 typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
186 typedef int (nvm_bb_update_fn)(struct ppa_addr, int, u8 *, void *);
187 typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
188 typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
189 nvm_l2p_update_fn *, void *);
190 typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, int,
191 nvm_bb_update_fn *, void *);
192 typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct nvm_rq *, int);
193 typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
194 typedef int (nvm_erase_blk_fn)(struct nvm_dev *, struct nvm_rq *);
195 typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
196 typedef void (nvm_destroy_dma_pool_fn)(void *);
197 typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
199 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
203 nvm_get_l2p_tbl_fn *get_l2p_tbl;
204 nvm_op_bb_tbl_fn *get_bb_tbl;
205 nvm_op_set_bb_fn *set_bb_tbl;
207 nvm_submit_io_fn *submit_io;
208 nvm_erase_blk_fn *erase_block;
210 nvm_create_dma_pool_fn *create_dma_pool;
211 nvm_destroy_dma_pool_fn *destroy_dma_pool;
212 nvm_dev_dma_alloc_fn *dev_dma_alloc;
213 nvm_dev_dma_free_fn *dev_dma_free;
215 unsigned int max_phys_sect;
224 unsigned int nr_inuse_blocks; /* Number of used blocks */
225 unsigned int nr_free_blocks; /* Number of unused blocks */
226 unsigned int nr_bad_blocks; /* Number of bad blocks */
227 struct nvm_block *blocks;
233 struct list_head list;
242 struct nvm_dev_ops *ops;
244 struct list_head devices;
245 struct list_head online_targets;
248 struct nvmm_type *mt;
251 /* Device information */
255 int sec_per_pg; /* only sectors for a single page */
260 struct nvm_addr_format ppaf;
262 /* Calculated/Cached values. These do not reflect the actual usable
263 * blocks at run-time.
266 int plane_mode; /* drive device in single, double or quad mode */
268 int sec_per_pl; /* all sectors across planes */
272 unsigned long total_pages;
273 unsigned long total_blocks;
275 unsigned max_pages_per_blk;
279 struct nvm_id identity;
282 struct request_queue *q;
283 char name[DISK_NAME_LEN];
286 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
291 l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
292 l.ppa |= ((u64)r.g.pg) << dev->ppaf.pg_offset;
293 l.ppa |= ((u64)r.g.sec) << dev->ppaf.sect_offset;
294 l.ppa |= ((u64)r.g.pl) << dev->ppaf.pln_offset;
295 l.ppa |= ((u64)r.g.lun) << dev->ppaf.lun_offset;
296 l.ppa |= ((u64)r.g.ch) << dev->ppaf.ch_offset;
301 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
307 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
309 l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
310 (((1 << dev->ppaf.blk_len) - 1));
311 l.g.pg |= (r.ppa >> dev->ppaf.pg_offset) &
312 (((1 << dev->ppaf.pg_len) - 1));
313 l.g.sec |= (r.ppa >> dev->ppaf.sect_offset) &
314 (((1 << dev->ppaf.sect_len) - 1));
315 l.g.pl |= (r.ppa >> dev->ppaf.pln_offset) &
316 (((1 << dev->ppaf.pln_len) - 1));
317 l.g.lun |= (r.ppa >> dev->ppaf.lun_offset) &
318 (((1 << dev->ppaf.lun_len) - 1));
319 l.g.ch |= (r.ppa >> dev->ppaf.ch_offset) &
320 (((1 << dev->ppaf.ch_len) - 1));
325 static inline int ppa_empty(struct ppa_addr ppa_addr)
327 return (ppa_addr.ppa == ADDR_EMPTY);
330 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
332 ppa_addr->ppa = ADDR_EMPTY;
335 static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
336 struct nvm_block *blk)
339 struct nvm_lun *lun = blk->lun;
342 ppa.g.blk = blk->id % dev->blks_per_lun;
343 ppa.g.lun = lun->lun_id;
344 ppa.g.ch = lun->chnl_id;
349 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
350 typedef sector_t (nvm_tgt_capacity_fn)(void *);
351 typedef int (nvm_tgt_end_io_fn)(struct nvm_rq *, int);
352 typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
353 typedef void (nvm_tgt_exit_fn)(void *);
355 struct nvm_tgt_type {
357 unsigned int version[3];
359 /* target entry points */
360 nvm_tgt_make_rq_fn *make_rq;
361 nvm_tgt_capacity_fn *capacity;
362 nvm_tgt_end_io_fn *end_io;
364 /* module-specific init/teardown */
365 nvm_tgt_init_fn *init;
366 nvm_tgt_exit_fn *exit;
368 /* For internal use */
369 struct list_head list;
372 extern int nvm_register_target(struct nvm_tgt_type *);
373 extern void nvm_unregister_target(struct nvm_tgt_type *);
375 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
376 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
378 typedef int (nvmm_register_fn)(struct nvm_dev *);
379 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
380 typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
381 struct nvm_lun *, unsigned long);
382 typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
383 typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
384 typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
385 typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
386 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
387 typedef int (nvmm_end_io_fn)(struct nvm_rq *, int);
388 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
390 typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
391 typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
395 unsigned int version[3];
397 nvmm_register_fn *register_mgr;
398 nvmm_unregister_fn *unregister_mgr;
400 /* Block administration callbacks */
401 nvmm_get_blk_fn *get_blk;
402 nvmm_put_blk_fn *put_blk;
403 nvmm_open_blk_fn *open_blk;
404 nvmm_close_blk_fn *close_blk;
405 nvmm_flush_blk_fn *flush_blk;
407 nvmm_submit_io_fn *submit_io;
408 nvmm_end_io_fn *end_io;
409 nvmm_erase_blk_fn *erase_blk;
411 /* Configuration management */
412 nvmm_get_lun_fn *get_lun;
415 nvmm_lun_info_print_fn *lun_info_print;
416 struct list_head list;
419 extern int nvm_register_mgr(struct nvmm_type *);
420 extern void nvm_unregister_mgr(struct nvmm_type *);
422 extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
424 extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
426 extern int nvm_register(struct request_queue *, char *,
427 struct nvm_dev_ops *);
428 extern void nvm_unregister(char *);
430 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
431 extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
432 #else /* CONFIG_NVM */
435 static inline int nvm_register(struct request_queue *q, char *disk_name,
436 struct nvm_dev_ops *ops)
440 static inline void nvm_unregister(char *disk_name) {}
441 #endif /* CONFIG_NVM */
442 #endif /* LIGHTNVM.H */