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