kernel/include/linux/lightnvm.h

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