include/linux/lightnvm.h

   1 #ifndef NVM_H
   2 #define NVM_H
   3
   4 enum {
   5         NVM_IO_OK = 0,
   6         NVM_IO_REQUEUE = 1,
   7         NVM_IO_DONE = 2,
   8         NVM_IO_ERR = 3,
   9
  10         NVM_IOTYPE_NONE = 0,
  11         NVM_IOTYPE_GC = 1,
  12 };
  13
  14 #ifdef CONFIG_NVM
  15
  16 #include <linux/blkdev.h>
  17 #include <linux/types.h>
  18 #include <linux/file.h>
  19 #include <linux/dmapool.h>
  20
  21 enum {
  22         /* HW Responsibilities */
  23         NVM_RSP_L2P     = 1 << 0,
  24         NVM_RSP_ECC     = 1 << 1,
  25
  26         /* Physical Adressing Mode */
  27         NVM_ADDRMODE_LINEAR     = 0,
  28         NVM_ADDRMODE_CHANNEL    = 1,
  29
  30         /* Plane programming mode for LUN */
  31         NVM_PLANE_SINGLE        = 0,
  32         NVM_PLANE_DOUBLE        = 1,
  33         NVM_PLANE_QUAD          = 2,
  34
  35         /* Status codes */
  36         NVM_RSP_SUCCESS         = 0x0,
  37         NVM_RSP_NOT_CHANGEABLE  = 0x1,
  38         NVM_RSP_ERR_FAILWRITE   = 0x40ff,
  39         NVM_RSP_ERR_EMPTYPAGE   = 0x42ff,
  40
  41         /* Device opcodes */
  42         NVM_OP_HBREAD           = 0x02,
  43         NVM_OP_HBWRITE          = 0x81,
  44         NVM_OP_PWRITE           = 0x91,
  45         NVM_OP_PREAD            = 0x92,
  46         NVM_OP_ERASE            = 0x90,
  47
  48         /* PPA Command Flags */
  49         NVM_IO_SNGL_ACCESS      = 0x0,
  50         NVM_IO_DUAL_ACCESS      = 0x1,
  51         NVM_IO_QUAD_ACCESS      = 0x2,
  52
  53         /* NAND Access Modes */
  54         NVM_IO_SUSPEND          = 0x80,
  55         NVM_IO_SLC_MODE         = 0x100,
  56         NVM_IO_SCRAMBLE_DISABLE = 0x200,
  57
  58         /* Block Types */
  59         NVM_BLK_T_FREE          = 0x0,
  60         NVM_BLK_T_BAD           = 0x1,
  61         NVM_BLK_T_GRWN_BAD      = 0x2,
  62         NVM_BLK_T_DEV           = 0x4,
  63         NVM_BLK_T_HOST          = 0x8,
  64
  65         /* Memory capabilities */
  66         NVM_ID_CAP_SLC          = 0x1,
  67         NVM_ID_CAP_CMD_SUSPEND  = 0x2,
  68         NVM_ID_CAP_SCRAMBLE     = 0x4,
  69         NVM_ID_CAP_ENCRYPT      = 0x8,
  70
  71         /* Memory types */
  72         NVM_ID_FMTYPE_SLC       = 0,
  73         NVM_ID_FMTYPE_MLC       = 1,
  74 };
  75
  76 struct nvm_id_lp_mlc {
  77         u16     num_pairs;
  78         u8      pairs[886];
  79 };
  80
  81 struct nvm_id_lp_tbl {
  82         __u8    id[8];
  83         struct nvm_id_lp_mlc mlc;
  84 };
  85
  86 struct nvm_id_group {
  87         u8      mtype;
  88         u8      fmtype;
  89         u8      num_ch;
  90         u8      num_lun;
  91         u8      num_pln;
  92         u16     num_blk;
  93         u16     num_pg;
  94         u16     fpg_sz;
  95         u16     csecs;
  96         u16     sos;
  97         u32     trdt;
  98         u32     trdm;
  99         u32     tprt;
 100         u32     tprm;
 101         u32     tbet;
 102         u32     tbem;
 103         u32     mpos;
 104         u32     mccap;
 105         u16     cpar;
 106
 107         struct nvm_id_lp_tbl lptbl;
 108 };
 109
 110 struct nvm_addr_format {
 111         u8      ch_offset;
 112         u8      ch_len;
 113         u8      lun_offset;
 114         u8      lun_len;
 115         u8      pln_offset;
 116         u8      pln_len;
 117         u8      blk_offset;
 118         u8      blk_len;
 119         u8      pg_offset;
 120         u8      pg_len;
 121         u8      sect_offset;
 122         u8      sect_len;
 123 };
 124
 125 struct nvm_id {
 126         u8      ver_id;
 127         u8      vmnt;
 128         u8      cgrps;
 129         u32     cap;
 130         u32     dom;
 131         struct nvm_addr_format ppaf;
 132         struct nvm_id_group groups[4];
 133 } __packed;
 134
 135 struct nvm_target {
 136         struct list_head list;
 137         struct nvm_tgt_type *type;
 138         struct gendisk *disk;
 139 };
 140
 141 struct nvm_tgt_instance {
 142         struct nvm_tgt_type *tt;
 143 };
 144
 145 #define ADDR_EMPTY (~0ULL)
 146
 147 #define NVM_VERSION_MAJOR 1
 148 #define NVM_VERSION_MINOR 0
 149 #define NVM_VERSION_PATCH 0
 150
 151 #define NVM_BLK_BITS (16)
 152 #define NVM_PG_BITS  (16)
 153 #define NVM_SEC_BITS (8)
 154 #define NVM_PL_BITS  (8)
 155 #define NVM_LUN_BITS (8)
 156 #define NVM_CH_BITS  (8)
 157
 158 struct ppa_addr {
 159         /* Generic structure for all addresses */
 160         union {
 161                 struct {
 162                         u64 blk         : NVM_BLK_BITS;
 163                         u64 pg          : NVM_PG_BITS;
 164                         u64 sec         : NVM_SEC_BITS;
 165                         u64 pl          : NVM_PL_BITS;
 166                         u64 lun         : NVM_LUN_BITS;
 167                         u64 ch          : NVM_CH_BITS;
 168                 } g;
 169
 170                 u64 ppa;
 171         };
 172 };
 173
 174 struct nvm_rq;
 175 typedef void (nvm_end_io_fn)(struct nvm_rq *);
 176
 177 struct nvm_rq {
 178         struct nvm_tgt_instance *ins;
 179         struct nvm_dev *dev;
 180
 181         struct bio *bio;
 182
 183         union {
 184                 struct ppa_addr ppa_addr;
 185                 dma_addr_t dma_ppa_list;
 186         };
 187
 188         struct ppa_addr *ppa_list;
 189
 190         void *metadata;
 191         dma_addr_t dma_metadata;
 192
 193         struct completion *wait;
 194         nvm_end_io_fn *end_io;
 195
 196         uint8_t opcode;
 197         uint16_t nr_pages;
 198         uint16_t flags;
 199
 200         int error;
 201 };
 202
 203 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
 204 {
 205         return pdu - sizeof(struct nvm_rq);
 206 }
 207
 208 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
 209 {
 210         return rqdata + 1;
 211 }
 212
 213 struct nvm_block;
 214
 215 typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
 216 typedef int (nvm_bb_update_fn)(struct ppa_addr, int, u8 *, void *);
 217 typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
 218 typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
 219                                 nvm_l2p_update_fn *, void *);
 220 typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, int,
 221                                 nvm_bb_update_fn *, void *);
 222 typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct nvm_rq *, int);
 223 typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
 224 typedef int (nvm_erase_blk_fn)(struct nvm_dev *, struct nvm_rq *);
 225 typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
 226 typedef void (nvm_destroy_dma_pool_fn)(void *);
 227 typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
 228                                                                 dma_addr_t *);
 229 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
 230
 231 struct nvm_dev_ops {
 232         nvm_id_fn               *identity;
 233         nvm_get_l2p_tbl_fn      *get_l2p_tbl;
 234         nvm_op_bb_tbl_fn        *get_bb_tbl;
 235         nvm_op_set_bb_fn        *set_bb_tbl;
 236
 237         nvm_submit_io_fn        *submit_io;
 238         nvm_erase_blk_fn        *erase_block;
 239
 240         nvm_create_dma_pool_fn  *create_dma_pool;
 241         nvm_destroy_dma_pool_fn *destroy_dma_pool;
 242         nvm_dev_dma_alloc_fn    *dev_dma_alloc;
 243         nvm_dev_dma_free_fn     *dev_dma_free;
 244
 245         unsigned int            max_phys_sect;
 246 };
 247
 248 struct nvm_lun {
 249         int id;
 250
 251         int lun_id;
 252         int chnl_id;
 253
 254         /* It is up to the target to mark blocks as closed. If the target does
 255          * not do it, all blocks are marked as open, and nr_open_blocks
 256          * represents the number of blocks in use
 257          */
 258         unsigned int nr_open_blocks;    /* Number of used, writable blocks */
 259         unsigned int nr_closed_blocks;  /* Number of used, read-only blocks */
 260         unsigned int nr_free_blocks;    /* Number of unused blocks */
 261         unsigned int nr_bad_blocks;     /* Number of bad blocks */
 262
 263         spinlock_t lock;
 264
 265         struct nvm_block *blocks;
 266 };
 267
 268 enum {
 269         NVM_BLK_ST_FREE =       0x1,    /* Free block */
 270         NVM_BLK_ST_OPEN =       0x2,    /* Open block - read-write */
 271         NVM_BLK_ST_CLOSED =     0x4,    /* Closed block - read-only */
 272         NVM_BLK_ST_BAD =        0x8,    /* Bad block */
 273 };
 274
 275 struct nvm_block {
 276         struct list_head list;
 277         struct nvm_lun *lun;
 278         unsigned long id;
 279
 280         void *priv;
 281         int state;
 282 };
 283
 284 struct nvm_dev {
 285         struct nvm_dev_ops *ops;
 286
 287         struct list_head devices;
 288         struct list_head online_targets;
 289
 290         /* Media manager */
 291         struct nvmm_type *mt;
 292         void *mp;
 293
 294         /* Device information */
 295         int nr_chnls;
 296         int nr_planes;
 297         int luns_per_chnl;
 298         int sec_per_pg; /* only sectors for a single page */
 299         int pgs_per_blk;
 300         int blks_per_lun;
 301         int sec_size;
 302         int oob_size;
 303         int mccap;
 304         struct nvm_addr_format ppaf;
 305
 306         /* Calculated/Cached values. These do not reflect the actual usable
 307          * blocks at run-time.
 308          */
 309         int max_rq_size;
 310         int plane_mode; /* drive device in single, double or quad mode */
 311
 312         int sec_per_pl; /* all sectors across planes */
 313         int sec_per_blk;
 314         int sec_per_lun;
 315
 316         /* lower page table */
 317         int lps_per_blk;
 318         int *lptbl;
 319
 320         unsigned long total_pages;
 321         unsigned long total_blocks;
 322         int nr_luns;
 323         unsigned max_pages_per_blk;
 324
 325         void *ppalist_pool;
 326
 327         struct nvm_id identity;
 328
 329         /* Backend device */
 330         struct request_queue *q;
 331         char name[DISK_NAME_LEN];
 332 };
 333
 334 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
 335                                                 struct ppa_addr r)
 336 {
 337         struct ppa_addr l;
 338
 339         l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
 340         l.ppa |= ((u64)r.g.pg) << dev->ppaf.pg_offset;
 341         l.ppa |= ((u64)r.g.sec) << dev->ppaf.sect_offset;
 342         l.ppa |= ((u64)r.g.pl) << dev->ppaf.pln_offset;
 343         l.ppa |= ((u64)r.g.lun) << dev->ppaf.lun_offset;
 344         l.ppa |= ((u64)r.g.ch) << dev->ppaf.ch_offset;
 345
 346         return l;
 347 }
 348
 349 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
 350                                                 struct ppa_addr r)
 351 {
 352         struct ppa_addr l;
 353
 354         /*
 355          * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
 356          */
 357         l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
 358                                         (((1 << dev->ppaf.blk_len) - 1));
 359         l.g.pg |= (r.ppa >> dev->ppaf.pg_offset) &
 360                                         (((1 << dev->ppaf.pg_len) - 1));
 361         l.g.sec |= (r.ppa >> dev->ppaf.sect_offset) &
 362                                         (((1 << dev->ppaf.sect_len) - 1));
 363         l.g.pl |= (r.ppa >> dev->ppaf.pln_offset) &
 364                                         (((1 << dev->ppaf.pln_len) - 1));
 365         l.g.lun |= (r.ppa >> dev->ppaf.lun_offset) &
 366                                         (((1 << dev->ppaf.lun_len) - 1));
 367         l.g.ch |= (r.ppa >> dev->ppaf.ch_offset) &
 368                                         (((1 << dev->ppaf.ch_len) - 1));
 369
 370         return l;
 371 }
 372
 373 static inline int ppa_empty(struct ppa_addr ppa_addr)
 374 {
 375         return (ppa_addr.ppa == ADDR_EMPTY);
 376 }
 377
 378 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
 379 {
 380         ppa_addr->ppa = ADDR_EMPTY;
 381 }
 382
 383 static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
 384                                                         struct nvm_block *blk)
 385 {
 386         struct ppa_addr ppa;
 387         struct nvm_lun *lun = blk->lun;
 388
 389         ppa.ppa = 0;
 390         ppa.g.blk = blk->id % dev->blks_per_lun;
 391         ppa.g.lun = lun->lun_id;
 392         ppa.g.ch = lun->chnl_id;
 393
 394         return ppa;
 395 }
 396
 397 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
 398 typedef sector_t (nvm_tgt_capacity_fn)(void *);
 399 typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
 400 typedef void (nvm_tgt_exit_fn)(void *);
 401
 402 struct nvm_tgt_type {
 403         const char *name;
 404         unsigned int version[3];
 405
 406         /* target entry points */
 407         nvm_tgt_make_rq_fn *make_rq;
 408         nvm_tgt_capacity_fn *capacity;
 409         nvm_end_io_fn *end_io;
 410
 411         /* module-specific init/teardown */
 412         nvm_tgt_init_fn *init;
 413         nvm_tgt_exit_fn *exit;
 414
 415         /* For internal use */
 416         struct list_head list;
 417 };
 418
 419 extern int nvm_register_target(struct nvm_tgt_type *);
 420 extern void nvm_unregister_target(struct nvm_tgt_type *);
 421
 422 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
 423 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
 424
 425 typedef int (nvmm_register_fn)(struct nvm_dev *);
 426 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
 427 typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
 428                                               struct nvm_lun *, unsigned long);
 429 typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
 430 typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
 431 typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
 432 typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
 433 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
 434 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
 435                                                                 unsigned long);
 436 typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
 437 typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
 438
 439 struct nvmm_type {
 440         const char *name;
 441         unsigned int version[3];
 442
 443         nvmm_register_fn *register_mgr;
 444         nvmm_unregister_fn *unregister_mgr;
 445
 446         /* Block administration callbacks */
 447         nvmm_get_blk_fn *get_blk_unlocked;
 448         nvmm_put_blk_fn *put_blk_unlocked;
 449         nvmm_get_blk_fn *get_blk;
 450         nvmm_put_blk_fn *put_blk;
 451         nvmm_open_blk_fn *open_blk;
 452         nvmm_close_blk_fn *close_blk;
 453         nvmm_flush_blk_fn *flush_blk;
 454
 455         nvmm_submit_io_fn *submit_io;
 456         nvmm_erase_blk_fn *erase_blk;
 457
 458         /* Configuration management */
 459         nvmm_get_lun_fn *get_lun;
 460
 461         /* Statistics */
 462         nvmm_lun_info_print_fn *lun_info_print;
 463         struct list_head list;
 464 };
 465
 466 extern int nvm_register_mgr(struct nvmm_type *);
 467 extern void nvm_unregister_mgr(struct nvmm_type *);
 468
 469 extern struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *,
 470                                         struct nvm_lun *, unsigned long);
 471 extern void nvm_put_blk_unlocked(struct nvm_dev *, struct nvm_block *);
 472
 473 extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
 474                                                                 unsigned long);
 475 extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
 476
 477 extern int nvm_register(struct request_queue *, char *,
 478                                                 struct nvm_dev_ops *);
 479 extern void nvm_unregister(char *);
 480
 481 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
 482 extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
 483 extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
 484 extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
 485                                                         struct ppa_addr *, int);
 486 extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
 487 extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int);
 488 extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
 489 extern void nvm_end_io(struct nvm_rq *, int);
 490 extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
 491                                                                 void *, int);
 492 #else /* CONFIG_NVM */
 493 struct nvm_dev_ops;
 494
 495 static inline int nvm_register(struct request_queue *q, char *disk_name,
 496                                                         struct nvm_dev_ops *ops)
 497 {
 498         return -EINVAL;
 499 }
 500 static inline void nvm_unregister(char *disk_name) {}
 501 #endif /* CONFIG_NVM */
 502 #endif /* LIGHTNVM.H */