projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lightnvm: remove mgt targets on mgt removal
[linux-2.6-block.git] / include / linux / lightnvm.h
CommitLineData
cd9e9808
MB		 1#ifndef NVM_H
2#define NVM_H
3
a7fd9a4f
JA		 4#include <linux/types.h>
5
cd9e9808
MB		 6enum {
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
a7fd9a4f
JA		 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
23struct 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
39struct nvm_rq;
40struct nvm_id;
41struct nvm_dev;
42
43typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
a7fd9a4f
JA		 44typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
45typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
46 nvm_l2p_update_fn *, void *);
e11903f5 47typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
00ee6cc3 48typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
a7fd9a4f
JA		 49typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
50typedef int (nvm_erase_blk_fn)(struct nvm_dev *, struct nvm_rq *);
51typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
52typedef void (nvm_destroy_dma_pool_fn)(void *);
53typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
54 dma_addr_t *);
55typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
56
57struct nvm_dev_ops {
58 nvm_id_fn *identity;
59 nvm_get_l2p_tbl_fn *get_l2p_tbl;
60 nvm_op_bb_tbl_fn *get_bb_tbl;
61 nvm_op_set_bb_fn *set_bb_tbl;
62
63 nvm_submit_io_fn *submit_io;
64 nvm_erase_blk_fn *erase_block;
65
66 nvm_create_dma_pool_fn *create_dma_pool;
67 nvm_destroy_dma_pool_fn *destroy_dma_pool;
68 nvm_dev_dma_alloc_fn *dev_dma_alloc;
69 nvm_dev_dma_free_fn *dev_dma_free;
70
71 unsigned int max_phys_sect;
72};
73
74
75
cd9e9808
MB		 76#ifdef CONFIG_NVM
77
78#include <linux/blkdev.h>
cd9e9808
MB		 79#include <linux/file.h>
80#include <linux/dmapool.h>
e3eb3799 81#include <uapi/linux/lightnvm.h>
cd9e9808
MB		 82
83enum {
84 /* HW Responsibilities */
85 NVM_RSP_L2P = 1 << 0,
86 NVM_RSP_ECC = 1 << 1,
87
88 /* Physical Adressing Mode */
89 NVM_ADDRMODE_LINEAR = 0,
90 NVM_ADDRMODE_CHANNEL = 1,
91
92 /* Plane programming mode for LUN */
d5bdec8d
MB		 93 NVM_PLANE_SINGLE = 1,
94 NVM_PLANE_DOUBLE = 2,
95 NVM_PLANE_QUAD = 4,
cd9e9808
MB		 96
97 /* Status codes */
98 NVM_RSP_SUCCESS = 0x0,
99 NVM_RSP_NOT_CHANGEABLE = 0x1,
100 NVM_RSP_ERR_FAILWRITE = 0x40ff,
101 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
102
103 /* Device opcodes */
104 NVM_OP_HBREAD = 0x02,
105 NVM_OP_HBWRITE = 0x81,
106 NVM_OP_PWRITE = 0x91,
107 NVM_OP_PREAD = 0x92,
108 NVM_OP_ERASE = 0x90,
109
110 /* PPA Command Flags */
111 NVM_IO_SNGL_ACCESS = 0x0,
112 NVM_IO_DUAL_ACCESS = 0x1,
113 NVM_IO_QUAD_ACCESS = 0x2,
114
57b4bd06 115 /* NAND Access Modes */
cd9e9808
MB		 116 NVM_IO_SUSPEND = 0x80,
117 NVM_IO_SLC_MODE = 0x100,
118 NVM_IO_SCRAMBLE_DISABLE = 0x200,
57b4bd06
MB		 119
120 /* Block Types */
121 NVM_BLK_T_FREE = 0x0,
122 NVM_BLK_T_BAD = 0x1,
b5d4acd4
MB		 123 NVM_BLK_T_GRWN_BAD = 0x2,
124 NVM_BLK_T_DEV = 0x4,
125 NVM_BLK_T_HOST = 0x8,
f9a99950
MB		 126
127 /* Memory capabilities */
128 NVM_ID_CAP_SLC = 0x1,
129 NVM_ID_CAP_CMD_SUSPEND = 0x2,
130 NVM_ID_CAP_SCRAMBLE = 0x4,
131 NVM_ID_CAP_ENCRYPT = 0x8,
ca5927e7
MB		 132
133 /* Memory types */
134 NVM_ID_FMTYPE_SLC = 0,
135 NVM_ID_FMTYPE_MLC = 1,
bf643185
MB		 136
137 /* Device capabilities */
138 NVM_ID_DCAP_BBLKMGMT = 0x1,
139 NVM_UD_DCAP_ECC = 0x2,
ca5927e7
MB		 140};
141
142struct nvm_id_lp_mlc {
143 u16 num_pairs;
144 u8 pairs[886];
145};
146
147struct nvm_id_lp_tbl {
148 __u8 id[8];
149 struct nvm_id_lp_mlc mlc;
cd9e9808
MB		 150};
151
152struct nvm_id_group {
153 u8 mtype;
154 u8 fmtype;
cd9e9808
MB		 155 u8 num_ch;
156 u8 num_lun;
157 u8 num_pln;
158 u16 num_blk;
159 u16 num_pg;
160 u16 fpg_sz;
161 u16 csecs;
162 u16 sos;
163 u32 trdt;
164 u32 trdm;
165 u32 tprt;
166 u32 tprm;
167 u32 tbet;
168 u32 tbem;
169 u32 mpos;
12be5edf 170 u32 mccap;
cd9e9808 171 u16 cpar;
ca5927e7
MB		 172
173 struct nvm_id_lp_tbl lptbl;
73387e7b 174};
cd9e9808
MB		 175
176struct nvm_addr_format {
177 u8 ch_offset;
178 u8 ch_len;
179 u8 lun_offset;
180 u8 lun_len;
181 u8 pln_offset;
182 u8 pln_len;
183 u8 blk_offset;
184 u8 blk_len;
185 u8 pg_offset;
186 u8 pg_len;
187 u8 sect_offset;
188 u8 sect_len;
cd9e9808
MB		 189};
190
191struct nvm_id {
192 u8 ver_id;
193 u8 vmnt;
194 u8 cgrps;
cd9e9808
MB		 195 u32 cap;
196 u32 dom;
197 struct nvm_addr_format ppaf;
cd9e9808
MB		 198 struct nvm_id_group groups[4];
199} __packed;
200
201struct nvm_target {
202 struct list_head list;
976bdfca 203 struct nvm_dev *dev;
cd9e9808
MB		 204 struct nvm_tgt_type *type;
205 struct gendisk *disk;
206};
207
208struct nvm_tgt_instance {
209 struct nvm_tgt_type *tt;
210};
211
212#define ADDR_EMPTY (~0ULL)
213
214#define NVM_VERSION_MAJOR 1
215#define NVM_VERSION_MINOR 0
216#define NVM_VERSION_PATCH 0
217
91276162 218struct nvm_rq;
72d256ec 219typedef void (nvm_end_io_fn)(struct nvm_rq *);
91276162 220
cd9e9808
MB		 221struct nvm_rq {
222 struct nvm_tgt_instance *ins;
223 struct nvm_dev *dev;
224
225 struct bio *bio;
226
227 union {
228 struct ppa_addr ppa_addr;
229 dma_addr_t dma_ppa_list;
230 };
231
232 struct ppa_addr *ppa_list;
233
003fad37
JG		 234 void *meta_list;
235 dma_addr_t dma_meta_list;
cd9e9808 236
91276162
MB		 237 struct completion *wait;
238 nvm_end_io_fn *end_io;
239
cd9e9808
MB		 240 uint8_t opcode;
241 uint16_t nr_pages;
242 uint16_t flags;
72d256ec 243
9f867268 244 u64 ppa_status; /* ppa media status */
72d256ec 245 int error;
cd9e9808
MB		 246};
247
248static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
249{
250 return pdu - sizeof(struct nvm_rq);
251}
252
253static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
254{
255 return rqdata + 1;
256}
257
258struct nvm_block;
259
cd9e9808
MB		 260struct nvm_lun {
261 int id;
262
263 int lun_id;
264 int chnl_id;
265
ff0e498b
JG		 266 /* It is up to the target to mark blocks as closed. If the target does
267 * not do it, all blocks are marked as open, and nr_open_blocks
268 * represents the number of blocks in use
269 */
270 unsigned int nr_open_blocks; /* Number of used, writable blocks */
271 unsigned int nr_closed_blocks; /* Number of used, read-only blocks */
cd9e9808 272 unsigned int nr_free_blocks; /* Number of unused blocks */
0b59733b 273 unsigned int nr_bad_blocks; /* Number of bad blocks */
cd9e9808
MB		 274
275 spinlock_t lock;
ff0e498b
JG		 276
277 struct nvm_block *blocks;
278};
279
280enum {
281 NVM_BLK_ST_FREE = 0x1, /* Free block */
282 NVM_BLK_ST_OPEN = 0x2, /* Open block - read-write */
283 NVM_BLK_ST_CLOSED = 0x4, /* Closed block - read-only */
284 NVM_BLK_ST_BAD = 0x8, /* Bad block */
cd9e9808
MB		 285};
286
287struct nvm_block {
288 struct list_head list;
289 struct nvm_lun *lun;
290 unsigned long id;
291
292 void *priv;
ff0e498b 293 int state;
cd9e9808
MB		 294};
295
e3eb3799
MB		 296/* system block cpu representation */
297struct nvm_sb_info {
298 unsigned long seqnr;
299 unsigned long erase_cnt;
300 unsigned int version;
301 char mmtype[NVM_MMTYPE_LEN];
302 struct ppa_addr fs_ppa;
303};
304
cd9e9808
MB		 305struct nvm_dev {
306 struct nvm_dev_ops *ops;
307
308 struct list_head devices;
cd9e9808
MB		 309
310 /* Media manager */
311 struct nvmm_type *mt;
312 void *mp;
313
b7692076
MB		 314 /* System blocks */
315 struct nvm_sb_info sb;
316
cd9e9808
MB		 317 /* Device information */
318 int nr_chnls;
319 int nr_planes;
320 int luns_per_chnl;
321 int sec_per_pg; /* only sectors for a single page */
322 int pgs_per_blk;
323 int blks_per_lun;
4891d120
MB		 324 int fpg_size;
325 int pfpg_size; /* size of buffer if all pages are to be read */
cd9e9808
MB		 326 int sec_size;
327 int oob_size;
f9a99950 328 int mccap;
7386af27 329 struct nvm_addr_format ppaf;
cd9e9808
MB		 330
331 /* Calculated/Cached values. These do not reflect the actual usable
332 * blocks at run-time.
333 */
334 int max_rq_size;
335 int plane_mode; /* drive device in single, double or quad mode */
336
337 int sec_per_pl; /* all sectors across planes */
338 int sec_per_blk;
339 int sec_per_lun;
340
ca5927e7
MB		 341 /* lower page table */
342 int lps_per_blk;
343 int *lptbl;
344
cd9e9808 345 unsigned long total_blocks;
4ece44af 346 unsigned long total_secs;
cd9e9808
MB		 347 int nr_luns;
348 unsigned max_pages_per_blk;
349
da1e2849 350 unsigned long *lun_map;
75b85649 351 void *dma_pool;
cd9e9808
MB		 352
353 struct nvm_id identity;
354
355 /* Backend device */
356 struct request_queue *q;
357 char name[DISK_NAME_LEN];
e3eb3799
MB		 358
359 struct mutex mlock;
4c9dacb8 360 spinlock_t lock;
cd9e9808
MB		 361};
362
7386af27
MB		 363static inline struct ppa_addr generic_to_dev_addr(struct nvm_dev *dev,
364 struct ppa_addr r)
cd9e9808
MB		 365{
366 struct ppa_addr l;
367
7386af27
MB		 368 l.ppa = ((u64)r.g.blk) << dev->ppaf.blk_offset;
369 l.ppa |= ((u64)r.g.pg) << dev->ppaf.pg_offset;
370 l.ppa |= ((u64)r.g.sec) << dev->ppaf.sect_offset;
371 l.ppa |= ((u64)r.g.pl) << dev->ppaf.pln_offset;
372 l.ppa |= ((u64)r.g.lun) << dev->ppaf.lun_offset;
373 l.ppa |= ((u64)r.g.ch) << dev->ppaf.ch_offset;
cd9e9808
MB		 374
375 return l;
376}
377
7386af27
MB		 378static inline struct ppa_addr dev_to_generic_addr(struct nvm_dev *dev,
379 struct ppa_addr r)
cd9e9808
MB		 380{
381 struct ppa_addr l;
382
7386af27
MB		 383 /*
384 * (r.ppa << X offset) & X len bitmask. X eq. blk, pg, etc.
385 */
386 l.g.blk = (r.ppa >> dev->ppaf.blk_offset) &
387 (((1 << dev->ppaf.blk_len) - 1));
388 l.g.pg |= (r.ppa >> dev->ppaf.pg_offset) &
389 (((1 << dev->ppaf.pg_len) - 1));
390 l.g.sec |= (r.ppa >> dev->ppaf.sect_offset) &
391 (((1 << dev->ppaf.sect_len) - 1));
392 l.g.pl |= (r.ppa >> dev->ppaf.pln_offset) &
393 (((1 << dev->ppaf.pln_len) - 1));
394 l.g.lun |= (r.ppa >> dev->ppaf.lun_offset) &
395 (((1 << dev->ppaf.lun_len) - 1));
396 l.g.ch |= (r.ppa >> dev->ppaf.ch_offset) &
397 (((1 << dev->ppaf.ch_len) - 1));
cd9e9808
MB		 398
399 return l;
400}
401
cd9e9808
MB		 402static inline int ppa_empty(struct ppa_addr ppa_addr)
403{
404 return (ppa_addr.ppa == ADDR_EMPTY);
405}
406
407static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
408{
409 ppa_addr->ppa = ADDR_EMPTY;
410}
411
412static inline struct ppa_addr block_to_ppa(struct nvm_dev *dev,
413 struct nvm_block *blk)
414{
415 struct ppa_addr ppa;
416 struct nvm_lun *lun = blk->lun;
417
418 ppa.ppa = 0;
419 ppa.g.blk = blk->id % dev->blks_per_lun;
420 ppa.g.lun = lun->lun_id;
421 ppa.g.ch = lun->chnl_id;
422
423 return ppa;
424}
425
e3eb3799
MB		 426static inline int ppa_to_slc(struct nvm_dev *dev, int slc_pg)
427{
428 return dev->lptbl[slc_pg];
429}
430
dece1635 431typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
cd9e9808 432typedef sector_t (nvm_tgt_capacity_fn)(void *);
cd9e9808
MB		 433typedef void *(nvm_tgt_init_fn)(struct nvm_dev *, struct gendisk *, int, int);
434typedef void (nvm_tgt_exit_fn)(void *);
435
436struct nvm_tgt_type {
437 const char *name;
438 unsigned int version[3];
439
440 /* target entry points */
441 nvm_tgt_make_rq_fn *make_rq;
442 nvm_tgt_capacity_fn *capacity;
91276162 443 nvm_end_io_fn *end_io;
cd9e9808
MB		 444
445 /* module-specific init/teardown */
446 nvm_tgt_init_fn *init;
447 nvm_tgt_exit_fn *exit;
448
449 /* For internal use */
450 struct list_head list;
451};
452
6063fe39
SL		 453extern int nvm_register_tgt_type(struct nvm_tgt_type *);
454extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
cd9e9808
MB		 455
456extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
457extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
458
459typedef int (nvmm_register_fn)(struct nvm_dev *);
460typedef void (nvmm_unregister_fn)(struct nvm_dev *);
461typedef struct nvm_block *(nvmm_get_blk_fn)(struct nvm_dev *,
462 struct nvm_lun *, unsigned long);
463typedef void (nvmm_put_blk_fn)(struct nvm_dev *, struct nvm_block *);
464typedef int (nvmm_open_blk_fn)(struct nvm_dev *, struct nvm_block *);
465typedef int (nvmm_close_blk_fn)(struct nvm_dev *, struct nvm_block *);
466typedef void (nvmm_flush_blk_fn)(struct nvm_dev *, struct nvm_block *);
467typedef int (nvmm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
cd9e9808
MB		 468typedef int (nvmm_erase_blk_fn)(struct nvm_dev *, struct nvm_block *,
469 unsigned long);
470typedef struct nvm_lun *(nvmm_get_lun_fn)(struct nvm_dev *, int);
da1e2849
WT		 471typedef int (nvmm_reserve_lun)(struct nvm_dev *, int);
472typedef void (nvmm_release_lun)(struct nvm_dev *, int);
2fde0e48 473typedef void (nvmm_lun_info_print_fn)(struct nvm_dev *);
cd9e9808 474
4c9dacb8
WT		 475typedef int (nvmm_get_area_fn)(struct nvm_dev *, sector_t *, sector_t);
476typedef void (nvmm_put_area_fn)(struct nvm_dev *, sector_t);
477
cd9e9808
MB		 478struct nvmm_type {
479 const char *name;
480 unsigned int version[3];
481
482 nvmm_register_fn *register_mgr;
483 nvmm_unregister_fn *unregister_mgr;
484
485 /* Block administration callbacks */
ff0e498b
JG		 486 nvmm_get_blk_fn *get_blk_unlocked;
487 nvmm_put_blk_fn *put_blk_unlocked;
cd9e9808
MB		 488 nvmm_get_blk_fn *get_blk;
489 nvmm_put_blk_fn *put_blk;
490 nvmm_open_blk_fn *open_blk;
491 nvmm_close_blk_fn *close_blk;
492 nvmm_flush_blk_fn *flush_blk;
493
494 nvmm_submit_io_fn *submit_io;
cd9e9808
MB		 495 nvmm_erase_blk_fn *erase_blk;
496
497 /* Configuration management */
498 nvmm_get_lun_fn *get_lun;
da1e2849
WT		 499 nvmm_reserve_lun *reserve_lun;
500 nvmm_release_lun *release_lun;
cd9e9808
MB		 501
502 /* Statistics */
2fde0e48 503 nvmm_lun_info_print_fn *lun_info_print;
4c9dacb8
WT		 504
505 nvmm_get_area_fn *get_area;
506 nvmm_put_area_fn *put_area;
507
cd9e9808
MB		 508 struct list_head list;
509};
510
511extern int nvm_register_mgr(struct nvmm_type *);
512extern void nvm_unregister_mgr(struct nvmm_type *);
513
ff0e498b
JG		 514extern struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *,
515 struct nvm_lun *, unsigned long);
516extern void nvm_put_blk_unlocked(struct nvm_dev *, struct nvm_block *);
517
cd9e9808
MB		 518extern struct nvm_block *nvm_get_blk(struct nvm_dev *, struct nvm_lun *,
519 unsigned long);
520extern void nvm_put_blk(struct nvm_dev *, struct nvm_block *);
521
522extern int nvm_register(struct request_queue *, char *,
523 struct nvm_dev_ops *);
524extern void nvm_unregister(char *);
525
526extern int nvm_submit_io(struct nvm_dev *, struct nvm_rq *);
069368e9
MB		 527extern void nvm_generic_to_addr_mode(struct nvm_dev *, struct nvm_rq *);
528extern void nvm_addr_to_generic_mode(struct nvm_dev *, struct nvm_rq *);
abd805ec 529extern int nvm_set_rqd_ppalist(struct nvm_dev *, struct nvm_rq *,
5ebc7d9f 530 struct ppa_addr *, int, int);
abd805ec 531extern void nvm_free_rqd_ppalist(struct nvm_dev *, struct nvm_rq *);
81e681d3 532extern int nvm_erase_ppa(struct nvm_dev *, struct ppa_addr *, int);
cd9e9808 533extern int nvm_erase_blk(struct nvm_dev *, struct nvm_block *);
91276162 534extern void nvm_end_io(struct nvm_rq *, int);
09719b62
MB		 535extern int nvm_submit_ppa(struct nvm_dev *, struct ppa_addr *, int, int, int,
536 void *, int);
1145e635
MB		 537extern int nvm_submit_ppa_list(struct nvm_dev *, struct ppa_addr *, int, int,
538 int, void *, int);
22e8c976 539extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
e11903f5 540extern int nvm_get_bb_tbl(struct nvm_dev *, struct ppa_addr, u8 *);
e3eb3799
MB		 541
542/* sysblk.c */
543#define NVM_SYSBLK_MAGIC 0x4E564D53 /* "NVMS" */
544
545/* system block on disk representation */
546struct nvm_system_block {
547 __be32 magic; /* magic signature */
548 __be32 seqnr; /* sequence number */
549 __be32 erase_cnt; /* erase count */
550 __be16 version; /* version number */
551 u8 mmtype[NVM_MMTYPE_LEN]; /* media manager name */
552 __be64 fs_ppa; /* PPA for media manager
553 * superblock */
554};
555
556extern int nvm_get_sysblock(struct nvm_dev *, struct nvm_sb_info *);
557extern int nvm_update_sysblock(struct nvm_dev *, struct nvm_sb_info *);
558extern int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *);
8b4970c4
MB		 559
560extern int nvm_dev_factory(struct nvm_dev *, int flags);
5136061c
MB		 561
562#define nvm_for_each_lun_ppa(dev, ppa, chid, lunid) \
563 for ((chid) = 0, (ppa).ppa = 0; (chid) < (dev)->nr_chnls; \
564 (chid)++, (ppa).g.ch = (chid)) \
565 for ((lunid) = 0; (lunid) < (dev)->luns_per_chnl; \
566 (lunid)++, (ppa).g.lun = (lunid))
567
cd9e9808
MB		 568#else /* CONFIG_NVM */
569struct nvm_dev_ops;
570
571static inline int nvm_register(struct request_queue *q, char *disk_name,
572 struct nvm_dev_ops *ops)
573{
574 return -EINVAL;
575}
576static inline void nvm_unregister(char *disk_name) {}
577#endif /* CONFIG_NVM */
578#endif /* LIGHTNVM.H */
Linux 6.x block layer and io_uring tree(s)