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 NVM_IO_SUSPEND = 0x80,
54 NVM_IO_SLC_MODE = 0x100,
55 NVM_IO_SCRAMBLE_DISABLE = 0x200,
81 struct nvm_addr_format {
104 struct nvm_addr_format ppaf;
107 struct nvm_id_group groups[4];
111 struct list_head list;
112 struct nvm_tgt_type *type;
113 struct gendisk *disk;
116 struct nvm_tgt_instance {
117 struct nvm_tgt_type *tt;
120 #define ADDR_EMPTY (~0ULL)
122 #define NVM_VERSION_MAJOR 1
123 #define NVM_VERSION_MINOR 0
124 #define NVM_VERSION_PATCH 0
126 #define NVM_SEC_BITS (8)
127 #define NVM_PL_BITS (6)
128 #define NVM_PG_BITS (16)
129 #define NVM_BLK_BITS (16)
130 #define NVM_LUN_BITS (10)
131 #define NVM_CH_BITS (8)
135 /* Channel-based PPA format in nand 4x2x2x2x8x10 */
138 u64 sec : 2; /* 4 sectors per page */
139 u64 pl : 2; /* 4 planes per LUN */
140 u64 lun : 2; /* 4 LUNs per channel */
141 u64 pg : 8; /* 256 pages per block */
142 u64 blk : 10;/* 1024 blocks per plane */
146 /* Generic structure for all addresses */
148 u64 sec : NVM_SEC_BITS;
149 u64 pl : NVM_PL_BITS;
150 u64 pg : NVM_PG_BITS;
151 u64 blk : NVM_BLK_BITS;
152 u64 lun : NVM_LUN_BITS;
153 u64 ch : NVM_CH_BITS;
161 struct nvm_tgt_instance *ins;
167 struct ppa_addr ppa_addr;
168 dma_addr_t dma_ppa_list;
171 struct ppa_addr *ppa_list;
174 dma_addr_t dma_metadata;
181 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
183 return pdu - sizeof(struct nvm_rq);
186 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
193 typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
194 typedef int (nvm_bb_update_fn)(u32, void *, unsigned int, void *);
195 typedef int (nvm_id_fn)(struct request_queue *, struct nvm_id *);
196 typedef int (nvm_get_l2p_tbl_fn)(struct request_queue *, u64, u32,
197 nvm_l2p_update_fn *, void *);
198 typedef int (nvm_op_bb_tbl_fn)(struct request_queue *, int, unsigned int,
199 nvm_bb_update_fn *, void *);
200 typedef int (nvm_op_set_bb_fn)(struct request_queue *, struct nvm_rq *, int);
201 typedef int (nvm_submit_io_fn)(struct request_queue *, struct nvm_rq *);
202 typedef int (nvm_erase_blk_fn)(struct request_queue *, struct nvm_rq *);
203 typedef void *(nvm_create_dma_pool_fn)(struct request_queue *, char *);
204 typedef void (nvm_destroy_dma_pool_fn)(void *);
205 typedef void *(nvm_dev_dma_alloc_fn)(struct request_queue *, void *, gfp_t,
207 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
211 nvm_get_l2p_tbl_fn *get_l2p_tbl;
212 nvm_op_bb_tbl_fn *get_bb_tbl;
213 nvm_op_set_bb_fn *set_bb;
215 nvm_submit_io_fn *submit_io;
216 nvm_erase_blk_fn *erase_block;
218 nvm_create_dma_pool_fn *create_dma_pool;
219 nvm_destroy_dma_pool_fn *destroy_dma_pool;
220 nvm_dev_dma_alloc_fn *dev_dma_alloc;
221 nvm_dev_dma_free_fn *dev_dma_free;
223 uint8_t max_phys_sect;
232 unsigned int nr_free_blocks; /* Number of unused blocks */
233 struct nvm_block *blocks;
239 struct list_head list;
248 struct nvm_dev_ops *ops;
250 struct list_head devices;
251 struct list_head online_targets;
254 struct nvmm_type *mt;
257 /* Device information */
261 int sec_per_pg; /* only sectors for a single page */
267 struct nvm_addr_format addr_format;
269 /* Calculated/Cached values. These do not reflect the actual usable
270 * blocks at run-time.
273 int plane_mode; /* drive device in single, double or quad mode */
275 int sec_per_pl; /* all sectors across planes */
279 unsigned long total_pages;
280 unsigned long total_blocks;
282 unsigned max_pages_per_blk;
286 struct nvm_id identity;
289 struct request_queue *q;
290 char name[DISK_NAME_LEN];
293 /* fallback conversion */
294 static struct ppa_addr __generic_to_linear_addr(struct nvm_dev *dev,
300 r.g.pg * dev->sec_per_pg +
301 r.g.blk * (dev->pgs_per_blk *
303 r.g.lun * (dev->blks_per_lun *
306 r.g.ch * (dev->blks_per_lun *
314 /* fallback conversion */
315 static struct ppa_addr __linear_to_generic_addr(struct nvm_dev *dev,
319 int secs, pgs, blks, luns;
320 sector_t ppa = r.ppa;
324 div_u64_rem(ppa, dev->sec_per_pg, &secs);
327 sector_div(ppa, dev->sec_per_pg);
328 div_u64_rem(ppa, dev->sec_per_blk, &pgs);
331 sector_div(ppa, dev->pgs_per_blk);
332 div_u64_rem(ppa, dev->blks_per_lun, &blks);
335 sector_div(ppa, dev->blks_per_lun);
336 div_u64_rem(ppa, dev->luns_per_chnl, &luns);
339 sector_div(ppa, dev->luns_per_chnl);
345 static struct ppa_addr __generic_to_chnl_addr(struct ppa_addr r)
351 l.chnl.sec = r.g.sec;
354 l.chnl.blk = r.g.blk;
355 l.chnl.lun = r.g.lun;
361 static struct ppa_addr __chnl_to_generic_addr(struct ppa_addr r)
367 l.g.sec = r.chnl.sec;
370 l.g.blk = r.chnl.blk;
371 l.g.lun = r.chnl.lun;
377 static inline struct ppa_addr addr_to_generic_mode(struct nvm_dev *dev,
378 struct ppa_addr gppa)
380 switch (dev->addr_mode) {
381 case NVM_ADDRMODE_LINEAR:
382 return __linear_to_generic_addr(dev, gppa);
383 case NVM_ADDRMODE_CHANNEL:
384 return __chnl_to_generic_addr(gppa);
391 static inline struct ppa_addr generic_to_addr_mode(struct nvm_dev *dev,
392 struct ppa_addr gppa)
394 switch (dev->addr_mode) {
395 case NVM_ADDRMODE_LINEAR:
396 return __generic_to_linear_addr(dev, gppa);
397 case NVM_ADDRMODE_CHANNEL:
398 return __generic_to_chnl_addr(gppa);
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 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
430 typedef sector_t (nvm_tgt_capacity_fn)(void *);
431 typedef int (nvm_tgt_end_io_fn)(struct nvm_rq *, int);
432 typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
433 typedef void (nvm_tgt_exit_fn)(void *);
435 struct nvm_tgt_type {
437 unsigned int version[3];
439 /* target entry points */
440 nvm_tgt_make_rq_fn *make_rq;
441 nvm_tgt_capacity_fn *capacity;
442 nvm_tgt_end_io_fn *end_io;
444 /* module-specific init/teardown */
445 nvm_tgt_init_fn *init;
446 nvm_tgt_exit_fn *exit;
448 /* For internal use */
449 struct list_head list;
452 extern int nvm_register_target(struct nvm_tgt_type *);
453 extern void nvm_unregister_target(struct nvm_tgt_type *);
455 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
456 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
458 typedef int (nvmm_register_fn)(struct nvm_dev *);
459 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
460 typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
461 struct nvm_lun *, unsigned long);
462 typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
463 typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
464 typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
465 typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
466 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
467 typedef int (nvmm_end_io_fn)(struct nvm_rq *, int);
468 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
470 typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
471 typedef void (nvmm_free_blocks_print_fn)(struct nvm_dev *);
475 unsigned int version[3];
477 nvmm_register_fn *register_mgr;
478 nvmm_unregister_fn *unregister_mgr;
480 /* Block administration callbacks */
481 nvmm_get_blk_fn *get_blk;
482 nvmm_put_blk_fn *put_blk;
483 nvmm_open_blk_fn *open_blk;
484 nvmm_close_blk_fn *close_blk;
485 nvmm_flush_blk_fn *flush_blk;
487 nvmm_submit_io_fn *submit_io;
488 nvmm_end_io_fn *end_io;
489 nvmm_erase_blk_fn *erase_blk;
491 /* Configuration management */
492 nvmm_get_lun_fn *get_lun;
495 nvmm_free_blocks_print_fn *free_blocks_print;
496 struct list_head list;
499 extern int nvm_register_mgr(struct nvmm_type *);
500 extern void nvm_unregister_mgr(struct nvmm_type *);
502 extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
504 extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
506 extern int nvm_register(struct request_queue *, char *,
507 struct nvm_dev_ops *);
508 extern void nvm_unregister(char *);
510 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
511 extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
512 #else /* CONFIG_NVM */
515 static inline int nvm_register(struct request_queue *q, char *disk_name,
516 struct nvm_dev_ops *ops)
520 static inline void nvm_unregister(char *disk_name) {}
521 #endif /* CONFIG_NVM */
522 #endif /* LIGHTNVM.H */