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 list_head lun_list;
 214         struct nvm_tgt_dev *dev;
 215         struct nvm_tgt_type *type;
 216         struct gendisk *disk;
 217 };
 218
 219 struct nvm_tgt_instance {
 220         struct nvm_tgt_type *tt;
 221 };
 222
 223 #define ADDR_EMPTY (~0ULL)
 224
 225 #define NVM_VERSION_MAJOR 1
 226 #define NVM_VERSION_MINOR 0
 227 #define NVM_VERSION_PATCH 0
 228
 229 struct nvm_rq;
 230 typedef void (nvm_end_io_fn)(struct nvm_rq *);
 231
 232 struct nvm_rq {
 233         struct nvm_tgt_instance *ins;
 234         struct nvm_dev *dev;
 235
 236         struct bio *bio;
 237
 238         union {
 239                 struct ppa_addr ppa_addr;
 240                 dma_addr_t dma_ppa_list;
 241         };
 242
 243         struct ppa_addr *ppa_list;
 244
 245         void *meta_list;
 246         dma_addr_t dma_meta_list;
 247
 248         struct completion *wait;
 249         nvm_end_io_fn *end_io;
 250
 251         uint8_t opcode;
 252         uint16_t nr_ppas;
 253         uint16_t flags;
 254
 255         u64 ppa_status; /* ppa media status */
 256         int error;
 257 };
 258
 259 static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
 260 {
 261         return pdu - sizeof(struct nvm_rq);
 262 }
 263
 264 static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
 265 {
 266         return rqdata + 1;
 267 }
 268
 269 struct nvm_lun {
 270         int id;
 271
 272         int lun_id;
 273         int chnl_id;
 274
 275         struct list_head list;
 276 };
 277
 278 enum {
 279         NVM_BLK_ST_FREE =       0x1,    /* Free block */
 280         NVM_BLK_ST_TGT =        0x2,    /* Block in use by target */
 281         NVM_BLK_ST_BAD =        0x8,    /* Bad block */
 282 };
 283
 284 /* system block cpu representation */
 285 struct nvm_sb_info {
 286         unsigned long           seqnr;
 287         unsigned long           erase_cnt;
 288         unsigned int            version;
 289         char                    mmtype[NVM_MMTYPE_LEN];
 290         struct ppa_addr         fs_ppa;
 291 };
 292
 293 /* Device generic information */
 294 struct nvm_geo {
 295         int nr_chnls;
 296         int nr_luns;
 297         int luns_per_chnl; /* -1 if channels are not symmetric */
 298         int nr_planes;
 299         int sec_per_pg; /* only sectors for a single page */
 300         int pgs_per_blk;
 301         int blks_per_lun;
 302         int fpg_size;
 303         int pfpg_size; /* size of buffer if all pages are to be read */
 304         int sec_size;
 305         int oob_size;
 306         int mccap;
 307         struct nvm_addr_format ppaf;
 308
 309         /* Calculated/Cached values. These do not reflect the actual usable
 310          * blocks at run-time.
 311          */
 312         int max_rq_size;
 313         int plane_mode; /* drive device in single, double or quad mode */
 314
 315         int sec_per_pl; /* all sectors across planes */
 316         int sec_per_blk;
 317         int sec_per_lun;
 318 };
 319
 320 struct nvm_tgt_dev {
 321         /* Device information */
 322         struct nvm_geo geo;
 323
 324         sector_t total_secs;
 325
 326         struct nvm_id identity;
 327         struct request_queue *q;
 328
 329         struct nvmm_type *mt;
 330         struct nvm_dev_ops *ops;
 331
 332         void *parent;
 333 };
 334
 335 struct nvm_dev {
 336         struct nvm_dev_ops *ops;
 337
 338         struct list_head devices;
 339
 340         /* Media manager */
 341         struct nvmm_type *mt;
 342         void *mp;
 343
 344         /* System blocks */
 345         struct nvm_sb_info sb;
 346
 347         /* Device information */
 348         struct nvm_geo geo;
 349
 350         /* lower page table */
 351         int lps_per_blk;
 352         int *lptbl;
 353
 354         unsigned long total_secs;
 355
 356         unsigned long *lun_map;
 357         void *dma_pool;
 358
 359         struct nvm_id identity;
 360
 361         /* Backend device */
 362         struct request_queue *q;
 363         char name[DISK_NAME_LEN];
 364         void *private_data;
 365
 366         struct mutex mlock;
 367         spinlock_t lock;
 368 };
 369
 370 static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
 371                                                         struct ppa_addr r)
 372 {
 373         struct ppa_addr l;
 374         int secs, pgs, blks, luns;
 375         sector_t ppa = r.ppa;
 376
 377         l.ppa = 0;
 378
 379         div_u64_rem(ppa, geo->sec_per_pg, &secs);
 380         l.g.sec = secs;
 381
 382         sector_div(ppa, geo->sec_per_pg);
 383         div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
 384         l.g.pg = pgs;
 385
 386         sector_div(ppa, geo->pgs_per_blk);
 387         div_u64_rem(ppa, geo->blks_per_lun, &blks);
 388         l.g.blk = blks;
 389
 390         sector_div(ppa, geo->blks_per_lun);
 391         div_u64_rem(ppa, geo->luns_per_chnl, &luns);
 392         l.g.lun = luns;
 393
 394         sector_div(ppa, geo->luns_per_chnl);
 395         l.g.ch = ppa;
 396
 397         return l;
 398 }
 399
 400 static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
 401                                                 struct ppa_addr r)
 402 {
 403         struct nvm_geo *geo = &dev->geo;
 404         struct ppa_addr l;
 405
 406         l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
 407         l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
 408         l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
 409         l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
 410         l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
 411         l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;
 412
 413         return l;
 414 }
 415
 416 static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
 417                                                 struct ppa_addr r)
 418 {
 419         struct nvm_geo *geo = &dev->geo;
 420         struct ppa_addr l;
 421
 422         l.ppa = 0;
 423         /*
 424          * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
 425          */
 426         l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
 427                                         (((1 << geo->ppaf.blk_len) - 1));
 428         l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
 429                                         (((1 << geo->ppaf.pg_len) - 1));
 430         l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
 431                                         (((1 << geo->ppaf.sect_len) - 1));
 432         l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
 433                                         (((1 << geo->ppaf.pln_len) - 1));
 434         l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
 435                                         (((1 << geo->ppaf.lun_len) - 1));
 436         l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
 437                                         (((1 << geo->ppaf.ch_len) - 1));
 438
 439         return l;
 440 }
 441
 442 static inline int ppa_empty(struct ppa_addr ppa_addr)
 443 {
 444         return (ppa_addr.ppa == ADDR_EMPTY);
 445 }
 446
 447 static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
 448 {
 449         ppa_addr->ppa = ADDR_EMPTY;
 450 }
 451
 452 static inline int ppa_cmp_blk(struct ppa_addr ppa1, struct ppa_addr ppa2)
 453 {
 454         if (ppa_empty(ppa1) || ppa_empty(ppa2))
 455                 return 0;
 456
 457         return ((ppa1.g.ch == ppa2.g.ch) && (ppa1.g.lun == ppa2.g.lun) &&
 458                                         (ppa1.g.blk == ppa2.g.blk));
 459 }
 460
 461 static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
 462 {
 463         return dev->lptbl[slc_pg];
 464 }
 465
 466 typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
 467 typedef sector_t (nvm_tgt_capacity_fn)(void *);
 468 typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *,
 469                                 struct list_head *lun_list);
 470 typedef void (nvm_tgt_exit_fn)(void *);
 471
 472 struct nvm_tgt_type {
 473         const char *name;
 474         unsigned int version[3];
 475
 476         /* target entry points */
 477         nvm_tgt_make_rq_fn *make_rq;
 478         nvm_tgt_capacity_fn *capacity;
 479         nvm_end_io_fn *end_io;
 480
 481         /* module-specific init/teardown */
 482         nvm_tgt_init_fn *init;
 483         nvm_tgt_exit_fn *exit;
 484
 485         /* For internal use */
 486         struct list_head list;
 487 };
 488
 489 extern struct nvm_tgt_type *nvm_find_target_type(const char *, int);
 490
 491 extern int nvm_register_tgt_type(struct nvm_tgt_type *);
 492 extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
 493
 494 extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
 495 extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
 496
 497 typedef int (nvmm_register_fn)(struct nvm_dev *);
 498 typedef void (nvmm_unregister_fn)(struct nvm_dev *);
 499
 500 typedef int (nvmm_create_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_create *);
 501 typedef int (nvmm_remove_tgt_fn)(struct nvm_dev *, struct nvm_ioctl_remove *);
 502 typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
 503 typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct ppa_addr *, int);
 504 typedef int (nvmm_get_area_fn)(struct nvm_dev *, sector_t *, sector_t);
 505 typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
 506
 507 struct nvmm_type {
 508         const char *name;
 509         unsigned int version[3];
 510
 511         nvmm_register_fn *register_mgr;
 512         nvmm_unregister_fn *unregister_mgr;
 513
 514         nvmm_create_tgt_fn *create_tgt;
 515         nvmm_remove_tgt_fn *remove_tgt;
 516
 517         nvmm_submit_io_fn *submit_io;
 518         nvmm_erase_blk_fn *erase_blk;
 519
 520         nvmm_get_area_fn *get_area;
 521         nvmm_put_area_fn *put_area;
 522
 523         struct list_head list;
 524 };
 525
 526 extern int nvm_register_mgr(struct nvmm_type *);
 527 extern void nvm_unregister_mgr(struct nvmm_type *);
 528
 529 extern struct nvm_dev *nvm_alloc_dev(int);
 530 extern int nvm_register(struct nvm_dev *);
 531 extern void nvm_unregister(struct nvm_dev *);
 532
 533 extern int nvm_set_bb_tbl(struct nvm_dev *dev, struct ppa_addr *ppas,
 534                                                         int nr_ppas, int type);
 535
 536 extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
 537 extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
 538 extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
 539 extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
 540                                         const struct ppa_addr *, int, int);
 541 extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
 542 extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int, int);
 543 extern int nvm_erase_blk(struct nvm_dev *, struct ppa_addr *, int);
 544 extern void nvm_end_io(struct nvm_rq *, int);
 545 extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
 546                                                                 void *, int);
 547 extern int nvm_submit_ppa_list(struct nvm_dev *, struct ppa_addr *, int, int,
 548                                                         int, void *, int);
 549 extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
 550 extern int nvm_get_bb_tbl(struct nvm_dev *, struct ppa_addr, u8 *);
 551
 552 /* sysblk.c */
 553 #define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
 554
 555 /* system block on disk representation */
 556 struct nvm_system_block {
 557         __be32                  magic;          /* magic signature */
 558         __be32                  seqnr;          /* sequence number */
 559         __be32                  erase_cnt;      /* erase count */
 560         __be16                  version;        /* version number */
 561         u8                      mmtype[NVM_MMTYPE_LEN]; /* media manager name */
 562         __be64                  fs_ppa;         /* PPA for media manager
 563                                                  * superblock */
 564 };
 565
 566 extern int nvm_get_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 567 extern int nvm_update_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 568 extern int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *);
 569
 570 extern int nvm_dev_factory(struct nvm_dev *, int flags);
 571
 572 #define nvm_for_each_lun_ppa(geo, ppa, chid, lunid)                     \
 573         for ((chid) = 0, (ppa).ppa = 0; (chid) < (geo)->nr_chnls;       \
 574                                         (chid)++, (ppa).g.ch = (chid))  \
 575                 for ((lunid) = 0; (lunid) < (geo)->luns_per_chnl;       \
 576                                         (lunid)++, (ppa).g.lun = (lunid))
 577
 578 #else /* CONFIG_NVM */
 579 struct nvm_dev_ops;
 580
 581 static inline struct nvm_dev *nvm_alloc_dev(int node)
 582 {
 583         return ERR_PTR(-EINVAL);
 584 }
 585 static inline int nvm_register(struct nvm_dev *dev)
 586 {
 587         return -EINVAL;
 588 }
 589 static inline void nvm_unregister(struct nvm_dev *dev) {}
 590 #endif /* CONFIG_NVM */
 591 #endif /* LIGHTNVM.H */