include/linux/lightnvm.h

   1 #ifndef NVM_H
   2 #define NVM_H
   3
   4 #include <linux/blkdev.h>
   5 #include <linux/types.h>
   6 #include <uapi/linux/lightnvm.h>
   7
   8 enum {
   9         NVM_IO_OK = 0,
  10         NVM_IO_REQUEUE = 1,
  11         NVM_IO_DONE = 2,
  12         NVM_IO_ERR = 3,
  13
  14         NVM_IOTYPE_NONE = 0,
  15         NVM_IOTYPE_GC = 1,
  16 };
  17
  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)
  24
  25 struct ppa_addr {
  26         /* Generic structure for all addresses */
  27         union {
  28                 struct {
  29                         u64 blk         : NVM_BLK_BITS;
  30                         u64 pg          : NVM_PG_BITS;
  31                         u64 sec         : NVM_SEC_BITS;
  32                         u64 pl          : NVM_PL_BITS;
  33                         u64 lun         : NVM_LUN_BITS;
  34                         u64 ch          : NVM_CH_BITS;
  35                         u64 reserved    : 1;
  36                 } g;
  37
  38                 struct {
  39                         u64 line        : 63;
  40                         u64 is_cached   : 1;
  41                 } c;
  42
  43                 u64 ppa;
  44         };
  45 };
  46
  47 struct nvm_rq;
  48 struct nvm_id;
  49 struct nvm_dev;
  50
  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,
  62                                                                 dma_addr_t *);
  63 typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
  64
  65 struct nvm_dev_ops {
  66         nvm_id_fn               *identity;
  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;
  70
  71         nvm_submit_io_fn        *submit_io;
  72         nvm_erase_blk_fn        *erase_block;
  73
  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;
  78
  79         unsigned int            max_phys_sect;
  80 };
  81
  82
  83
  84 #ifdef CONFIG_NVM
  85
  86 #include <linux/blkdev.h>
  87 #include <linux/file.h>
  88 #include <linux/dmapool.h>
  89 #include <uapi/linux/lightnvm.h>
  90
  91 enum {
  92         /* HW Responsibilities */
  93         NVM_RSP_L2P     = 1 << 0,
  94         NVM_RSP_ECC     = 1 << 1,
  95
  96         /* Physical Adressing Mode */
  97         NVM_ADDRMODE_LINEAR     = 0,
  98         NVM_ADDRMODE_CHANNEL    = 1,
  99
 100         /* Plane programming mode for LUN */
 101         NVM_PLANE_SINGLE        = 1,
 102         NVM_PLANE_DOUBLE        = 2,
 103         NVM_PLANE_QUAD          = 4,
 104
 105         /* Status codes */
 106         NVM_RSP_SUCCESS         = 0x0,
 107         NVM_RSP_NOT_CHANGEABLE  = 0x1,
 108         NVM_RSP_ERR_FAILWRITE   = 0x40ff,
 109         NVM_RSP_ERR_EMPTYPAGE   = 0x42ff,
 110         NVM_RSP_ERR_FAILECC     = 0x4281,
 111         NVM_RSP_WARN_HIGHECC    = 0x4700,
 112
 113         /* Device opcodes */
 114         NVM_OP_HBREAD           = 0x02,
 115         NVM_OP_HBWRITE          = 0x81,
 116         NVM_OP_PWRITE           = 0x91,
 117         NVM_OP_PREAD            = 0x92,
 118         NVM_OP_ERASE            = 0x90,
 119
 120         /* PPA Command Flags */
 121         NVM_IO_SNGL_ACCESS      = 0x0,
 122         NVM_IO_DUAL_ACCESS      = 0x1,
 123         NVM_IO_QUAD_ACCESS      = 0x2,
 124
 125         /* NAND Access Modes */
 126         NVM_IO_SUSPEND          = 0x80,
 127         NVM_IO_SLC_MODE         = 0x100,
 128         NVM_IO_SCRAMBLE_DISABLE = 0x200,
 129
 130         /* Block Types */
 131         NVM_BLK_T_FREE          = 0x0,
 132         NVM_BLK_T_BAD           = 0x1,
 133         NVM_BLK_T_GRWN_BAD      = 0x2,
 134         NVM_BLK_T_DEV           = 0x4,
 135         NVM_BLK_T_HOST          = 0x8,
 136
 137         /* Memory capabilities */
 138         NVM_ID_CAP_SLC          = 0x1,
 139         NVM_ID_CAP_CMD_SUSPEND  = 0x2,
 140         NVM_ID_CAP_SCRAMBLE     = 0x4,
 141         NVM_ID_CAP_ENCRYPT      = 0x8,
 142
 143         /* Memory types */
 144         NVM_ID_FMTYPE_SLC       = 0,
 145         NVM_ID_FMTYPE_MLC       = 1,
 146
 147         /* Device capabilities */
 148         NVM_ID_DCAP_BBLKMGMT    = 0x1,
 149         NVM_UD_DCAP_ECC         = 0x2,
 150 };
 151
 152 struct nvm_id_lp_mlc {
 153         u16     num_pairs;
 154         u8      pairs[886];
 155 };
 156
 157 struct nvm_id_lp_tbl {
 158         __u8    id[8];
 159         struct nvm_id_lp_mlc mlc;
 160 };
 161
 162 struct nvm_id_group {
 163         u8      mtype;
 164         u8      fmtype;
 165         u8      num_ch;
 166         u8      num_lun;
 167         u8      num_pln;
 168         u16     num_blk;
 169         u16     num_pg;
 170         u16     fpg_sz;
 171         u16     csecs;
 172         u16     sos;
 173         u32     trdt;
 174         u32     trdm;
 175         u32     tprt;
 176         u32     tprm;
 177         u32     tbet;
 178         u32     tbem;
 179         u32     mpos;
 180         u32     mccap;
 181         u16     cpar;
 182
 183         struct nvm_id_lp_tbl lptbl;
 184 };
 185
 186 struct nvm_addr_format {
 187         u8      ch_offset;
 188         u8      ch_len;
 189         u8      lun_offset;
 190         u8      lun_len;
 191         u8      pln_offset;
 192         u8      pln_len;
 193         u8      blk_offset;
 194         u8      blk_len;
 195         u8      pg_offset;
 196         u8      pg_len;
 197         u8      sect_offset;
 198         u8      sect_len;
 199 };
 200
 201 struct nvm_id {
 202         u8      ver_id;
 203         u8      vmnt;
 204         u8      cgrps;
 205         u32     cap;
 206         u32     dom;
 207         struct nvm_addr_format ppaf;
 208         struct nvm_id_group groups[4];
 209 } __packed;
 210
 211 struct nvm_target {
 212         struct list_head list;
 213         struct nvm_dev *dev;
 214         struct nvm_tgt_type *type;
 215         struct gendisk *disk;
 216 };
 217
 218 struct nvm_tgt_instance {
 219         struct nvm_tgt_type *tt;
 220 };
 221
 222 #define ADDR_EMPTY (~0ULL)
 223
 224 #define NVM_VERSION_MAJOR 1
 225 #define NVM_VERSION_MINOR 0
 226 #define NVM_VERSION_PATCH 0
 227
 228 struct nvm_rq;
 229 typedef void (nvm_end_io_fn)(struct nvm_rq *);
 230
 231 struct nvm_rq {
 232         struct nvm_tgt_instance *ins;
 233         struct nvm_dev *dev;
 234
 235         struct bio *bio;
 236
 237         union {
 238                 struct ppa_addr ppa_addr;
 239                 dma_addr_t dma_ppa_list;
 240         };
 241
 242         struct ppa_addr *ppa_list;
 243
 244         void *meta_list;
 245         dma_addr_t dma_meta_list;
 246
 247         struct completion *wait;
 248         nvm_end_io_fn *end_io;
 249
 250         uint8_t opcode;
 251         uint16_t nr_ppas;
 252         uint16_t flags;
 253
 254         u64 ppa_status; /* ppa media status */
 255         int error;
 256 };
 257
 258 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
 259 {
 260         return pdu - sizeof(struct nvm_rq);
 261 }
 262
 263 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
 264 {
 265         return rqdata + 1;
 266 }
 267
 268 struct nvm_block;
 269
 270 struct nvm_lun {
 271         int id;
 272
 273         int lun_id;
 274         int chnl_id;
 275
 276         spinlock_t lock;
 277
 278         unsigned int nr_free_blocks;    /* Number of unused blocks */
 279         struct nvm_block *blocks;
 280 };
 281
 282 enum {
 283         NVM_BLK_ST_FREE =       0x1,    /* Free block */
 284         NVM_BLK_ST_TGT =        0x2,    /* Block in use by target */
 285         NVM_BLK_ST_BAD =        0x8,    /* Bad block */
 286 };
 287
 288 struct nvm_block {
 289         struct list_head list;
 290         struct nvm_lun *lun;
 291         unsigned long id;
 292
 293         void *priv;
 294         int state;
 295 };
 296
 297 /* system block cpu representation */
 298 struct nvm_sb_info {
 299         unsigned long           seqnr;
 300         unsigned long           erase_cnt;
 301         unsigned int            version;
 302         char                    mmtype[NVM_MMTYPE_LEN];
 303         struct ppa_addr         fs_ppa;
 304 };
 305
 306 struct nvm_dev {
 307         struct nvm_dev_ops *ops;
 308
 309         struct list_head devices;
 310
 311         /* Media manager */
 312         struct nvmm_type *mt;
 313         void *mp;
 314
 315         /* System blocks */
 316         struct nvm_sb_info sb;
 317
 318         /* Device information */
 319         int nr_chnls;
 320         int nr_planes;
 321         int luns_per_chnl;
 322         int sec_per_pg; /* only sectors for a single page */
 323         int pgs_per_blk;
 324         int blks_per_lun;
 325         int fpg_size;
 326         int pfpg_size; /* size of buffer if all pages are to be read */
 327         int sec_size;
 328         int oob_size;
 329         int mccap;
 330         struct nvm_addr_format ppaf;
 331
 332         /* Calculated/Cached values. These do not reflect the actual usable
 333          * blocks at run-time.
 334          */
 335         int max_rq_size;
 336         int plane_mode; /* drive device in single, double or quad mode */
 337
 338         int sec_per_pl; /* all sectors across planes */
 339         int sec_per_blk;
 340         int sec_per_lun;
 341
 342         /* lower page table */
 343         int lps_per_blk;
 344         int *lptbl;
 345
 346         unsigned long total_blocks;
 347         unsigned long total_secs;
 348         int nr_luns;
 349
 350         unsigned long *lun_map;
 351         void *dma_pool;
 352
 353         struct nvm_id identity;
 354
 355         /* Backend device */
 356         struct request_queue *q;
 357         char name[DISK_NAME_LEN];
 358         void *private_data;
 359
 360         struct mutex mlock;
 361         spinlock_t lock;
 362 };
 363
 364 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
 365                                                 struct ppa_addr r)
 366 {
 367         struct ppa_addr l;
 368
 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;
 375
 376         return l;
 377 }
 378
 379 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
 380                                                 struct ppa_addr r)
 381 {
 382         struct ppa_addr l;
 383
 384         l.ppa = 0;
 385         /*
 386          * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
 387          */
 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));
 400
 401         return l;
 402 }
 403
 404 static inline int ppa_empty(struct ppa_addr ppa_addr)
 405 {
 406         return (ppa_addr.ppa == ADDR_EMPTY);
 407 }
 408
 409 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
 410 {
 411         ppa_addr->ppa = ADDR_EMPTY;
 412 }
 413
 414 static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
 415                                                         struct nvm_block *blk)
 416 {
 417         struct ppa_addr ppa;
 418         struct nvm_lun *lun = blk->lun;
 419
 420         ppa.ppa = 0;
 421         ppa.g.blk = blk->id % dev->blks_per_lun;
 422         ppa.g.lun = lun->lun_id;
 423         ppa.g.ch = lun->chnl_id;
 424
 425         return ppa;
 426 }
 427
 428 static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
 429 {
 430         if (ppa_empty(ppa1) || ppa_empty(ppa2))
 431                 return 0;
 432
 433         return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
 434                                         (ppa1.g.blk == ppa2.g.blk));
 435 }
 436
 437 static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
 438 {
 439         return dev->lptbl[slc_pg];
 440 }
 441
 442 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
 443 typedef sector_t (nvm_tgt_capacity_fn)(void *);
 444 typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
 445 typedef void (nvm_tgt_exit_fn)(void *);
 446
 447 struct nvm_tgt_type {
 448         const char *name;
 449         unsigned int version[3];
 450
 451         /* target entry points */
 452         nvm_tgt_make_rq_fn *make_rq;
 453         nvm_tgt_capacity_fn *capacity;
 454         nvm_end_io_fn *end_io;
 455
 456         /* module-specific init/teardown */
 457         nvm_tgt_init_fn *init;
 458         nvm_tgt_exit_fn *exit;
 459
 460         /* For internal use */
 461         struct list_head list;
 462 };
 463
 464 extern struct nvm_tgt_type *nvm_find_target_type(const char *, int);
 465
 466 extern int nvm_register_tgt_type(struct nvm_tgt_type *);
 467 extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
 468
 469 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
 470 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
 471
 472 typedef int (nvmm_register_fn)(struct nvm_dev *);
 473 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
 474
 475 typedef int (nvmm_create_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_create *);
 476 typedef int (nvmm_remove_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_remove *);
 477 typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
 478                                               struct nvm_lun *, unsigned long);
 479 typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
 480 typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
 481 typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
 482 typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
 483 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
 484 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *, int);
 485 typedef void (nvmm_mark_blk_fn)(struct nvm_dev *, struct ppa_addr, int);
 486 typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
 487 typedef int (nvmm_reserve_lun)(struct nvm_dev *, int);
 488 typedef void (nvmm_release_lun)(struct nvm_dev *, int);
 489 typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
 490
 491 typedef int (nvmm_get_area_fn)(struct nvm_dev *, sector_t *, sector_t);
 492 typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
 493
 494 struct nvmm_type {
 495         const char *name;
 496         unsigned int version[3];
 497
 498         nvmm_register_fn *register_mgr;
 499         nvmm_unregister_fn *unregister_mgr;
 500
 501         nvmm_create_tgt_fn *create_tgt;
 502         nvmm_remove_tgt_fn *remove_tgt;
 503
 504         /* Block administration callbacks */
 505         nvmm_get_blk_fn *get_blk;
 506         nvmm_put_blk_fn *put_blk;
 507         nvmm_open_blk_fn *open_blk;
 508         nvmm_close_blk_fn *close_blk;
 509         nvmm_flush_blk_fn *flush_blk;
 510
 511         nvmm_submit_io_fn *submit_io;
 512         nvmm_erase_blk_fn *erase_blk;
 513
 514         /* Bad block mgmt */
 515         nvmm_mark_blk_fn *mark_blk;
 516
 517         /* Configuration management */
 518         nvmm_get_lun_fn *get_lun;
 519         nvmm_reserve_lun *reserve_lun;
 520         nvmm_release_lun *release_lun;
 521
 522         /* Statistics */
 523         nvmm_lun_info_print_fn *lun_info_print;
 524
 525         nvmm_get_area_fn *get_area;
 526         nvmm_put_area_fn *put_area;
 527
 528         struct list_head list;
 529 };
 530
 531 extern int nvm_register_mgr(struct nvmm_type *);
 532 extern void nvm_unregister_mgr(struct nvmm_type *);
 533
 534 extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
 535                                                                 unsigned long);
 536 extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
 537
 538 extern struct nvm_dev *nvm_alloc_dev(int);
 539 extern int nvm_register(struct nvm_dev *);
 540 extern void nvm_unregister(struct nvm_dev *);
 541
 542 extern void nvm_mark_blk(struct nvm_dev *dev, struct ppa_addr ppa, int type);
 543 extern int nvm_set_bb_tbl(struct nvm_dev *dev, struct ppa_addr *ppas,
 544                                                         int nr_ppas, int type);
 545
 546 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
 547 extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
 548 extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
 549 extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
 550                                         const struct ppa_addr *, int, int);
 551 extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
 552 extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int, int);
 553 extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *, int);
 554 extern void nvm_end_io(struct nvm_rq *, int);
 555 extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
 556                                                                 void *, int);
 557 extern int nvm_submit_ppa_list(struct nvm_dev *, struct ppa_addr *, int, int,
 558                                                         int, void *, int);
 559 extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
 560 extern int nvm_get_bb_tbl(struct nvm_dev *, struct ppa_addr, u8 *);
 561
 562 /* sysblk.c */
 563 #define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
 564
 565 /* system block on disk representation */
 566 struct nvm_system_block {
 567         __be32                  magic;          /* magic signature */
 568         __be32                  seqnr;          /* sequence number */
 569         __be32                  erase_cnt;      /* erase count */
 570         __be16                  version;        /* version number */
 571         u8                      mmtype[NVM_MMTYPE_LEN]; /* media manager name */
 572         __be64                  fs_ppa;         /* PPA for media manager
 573                                                  * superblock */
 574 };
 575
 576 extern int nvm_get_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 577 extern int nvm_update_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 578 extern int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 579
 580 extern int nvm_dev_factory(struct nvm_dev *, int flags);
 581
 582 #define nvm_for_each_lun_ppa(dev, ppa, chid, lunid)                     \
 583         for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls;       \
 584                                         (chid)++, (ppa).g.ch = (chid))  \
 585                 for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl;       \
 586                                         (lunid)++, (ppa).g.lun = (lunid))
 587
 588 #else /* CONFIG_NVM */
 589 struct nvm_dev_ops;
 590
 591 static inline struct nvm_dev *nvm_alloc_dev(int node)
 592 {
 593         return ERR_PTR(-EINVAL);
 594 }
 595 static inline int nvm_register(struct nvm_dev *dev)
 596 {
 597         return -EINVAL;
 598 }
 599 static inline void nvm_unregister(struct nvm_dev *dev) {}
 600 #endif /* CONFIG_NVM */
 601 #endif /* LIGHTNVM.H */