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
8enum {
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
25struct ppa_addr {
26
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
47struct nvm_rq;
48struct nvm_id;
49struct nvm_dev;
50struct nvm_tgt_dev;
51
52typedef int (nvm_l2p_update_fn)(u64, u32, __le64 *, void *);
53typedef int (nvm_id_fn)(struct nvm_dev *, struct nvm_id *);
54typedef int (nvm_get_l2p_tbl_fn)(struct nvm_dev *, u64, u32,
55 nvm_l2p_update_fn *, void *);
56typedef int (nvm_op_bb_tbl_fn)(struct nvm_dev *, struct ppa_addr, u8 *);
57typedef int (nvm_op_set_bb_fn)(struct nvm_dev *, struct ppa_addr *, int, int);
58typedef int (nvm_submit_io_fn)(struct nvm_dev *, struct nvm_rq *);
59typedef void *(nvm_create_dma_pool_fn)(struct nvm_dev *, char *);
60typedef void (nvm_destroy_dma_pool_fn)(void *);
61typedef void *(nvm_dev_dma_alloc_fn)(struct nvm_dev *, void *, gfp_t,
62 dma_addr_t *);
63typedef void (nvm_dev_dma_free_fn)(void *, void*, dma_addr_t);
64
65struct 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
73 nvm_create_dma_pool_fn *create_dma_pool;
74 nvm_destroy_dma_pool_fn *destroy_dma_pool;
75 nvm_dev_dma_alloc_fn *dev_dma_alloc;
76 nvm_dev_dma_free_fn *dev_dma_free;
77
78 unsigned int max_phys_sect;
79};
80
81#ifdef CONFIG_NVM
82
83#include <linux/blkdev.h>
84#include <linux/file.h>
85#include <linux/dmapool.h>
86#include <uapi/linux/lightnvm.h>
87
88enum {
89
90 NVM_RSP_L2P = 1 << 0,
91 NVM_RSP_ECC = 1 << 1,
92
93
94 NVM_ADDRMODE_LINEAR = 0,
95 NVM_ADDRMODE_CHANNEL = 1,
96
97
98 NVM_PLANE_SINGLE = 1,
99 NVM_PLANE_DOUBLE = 2,
100 NVM_PLANE_QUAD = 4,
101
102
103 NVM_RSP_SUCCESS = 0x0,
104 NVM_RSP_NOT_CHANGEABLE = 0x1,
105 NVM_RSP_ERR_FAILWRITE = 0x40ff,
106 NVM_RSP_ERR_EMPTYPAGE = 0x42ff,
107 NVM_RSP_ERR_FAILECC = 0x4281,
108 NVM_RSP_ERR_FAILCRC = 0x4004,
109 NVM_RSP_WARN_HIGHECC = 0x4700,
110
111
112 NVM_OP_HBREAD = 0x02,
113 NVM_OP_HBWRITE = 0x81,
114 NVM_OP_PWRITE = 0x91,
115 NVM_OP_PREAD = 0x92,
116 NVM_OP_ERASE = 0x90,
117
118
119 NVM_IO_SNGL_ACCESS = 0x0,
120 NVM_IO_DUAL_ACCESS = 0x1,
121 NVM_IO_QUAD_ACCESS = 0x2,
122
123
124 NVM_IO_SUSPEND = 0x80,
125 NVM_IO_SLC_MODE = 0x100,
126 NVM_IO_SCRAMBLE_ENABLE = 0x200,
127
128
129 NVM_BLK_T_FREE = 0x0,
130 NVM_BLK_T_BAD = 0x1,
131 NVM_BLK_T_GRWN_BAD = 0x2,
132 NVM_BLK_T_DEV = 0x4,
133 NVM_BLK_T_HOST = 0x8,
134
135
136 NVM_ID_CAP_SLC = 0x1,
137 NVM_ID_CAP_CMD_SUSPEND = 0x2,
138 NVM_ID_CAP_SCRAMBLE = 0x4,
139 NVM_ID_CAP_ENCRYPT = 0x8,
140
141
142 NVM_ID_FMTYPE_SLC = 0,
143 NVM_ID_FMTYPE_MLC = 1,
144
145
146 NVM_ID_DCAP_BBLKMGMT = 0x1,
147 NVM_UD_DCAP_ECC = 0x2,
148};
149
150struct nvm_id_lp_mlc {
151 u16 num_pairs;
152 u8 pairs[886];
153};
154
155struct nvm_id_lp_tbl {
156 __u8 id[8];
157 struct nvm_id_lp_mlc mlc;
158};
159
160struct nvm_id_group {
161 u8 mtype;
162 u8 fmtype;
163 u8 num_ch;
164 u8 num_lun;
165 u8 num_pln;
166 u16 num_blk;
167 u16 num_pg;
168 u16 fpg_sz;
169 u16 csecs;
170 u16 sos;
171 u32 trdt;
172 u32 trdm;
173 u32 tprt;
174 u32 tprm;
175 u32 tbet;
176 u32 tbem;
177 u32 mpos;
178 u32 mccap;
179 u16 cpar;
180
181 struct nvm_id_lp_tbl lptbl;
182};
183
184struct nvm_addr_format {
185 u8 ch_offset;
186 u8 ch_len;
187 u8 lun_offset;
188 u8 lun_len;
189 u8 pln_offset;
190 u8 pln_len;
191 u8 blk_offset;
192 u8 blk_len;
193 u8 pg_offset;
194 u8 pg_len;
195 u8 sect_offset;
196 u8 sect_len;
197};
198
199struct nvm_id {
200 u8 ver_id;
201 u8 vmnt;
202 u32 cap;
203 u32 dom;
204 struct nvm_addr_format ppaf;
205 struct nvm_id_group grp;
206} __packed;
207
208struct nvm_target {
209 struct list_head list;
210 struct nvm_tgt_dev *dev;
211 struct nvm_tgt_type *type;
212 struct gendisk *disk;
213};
214
215#define ADDR_EMPTY (~0ULL)
216
217#define NVM_VERSION_MAJOR 1
218#define NVM_VERSION_MINOR 0
219#define NVM_VERSION_PATCH 0
220
221struct nvm_rq;
222typedef void (nvm_end_io_fn)(struct nvm_rq *);
223
224struct nvm_rq {
225 struct nvm_tgt_dev *dev;
226
227 struct bio *bio;
228
229 union {
230 struct ppa_addr ppa_addr;
231 dma_addr_t dma_ppa_list;
232 };
233
234 struct ppa_addr *ppa_list;
235
236 void *meta_list;
237 dma_addr_t dma_meta_list;
238
239 struct completion *wait;
240 nvm_end_io_fn *end_io;
241
242 uint8_t opcode;
243 uint16_t nr_ppas;
244 uint16_t flags;
245
246 u64 ppa_status;
247 int error;
248
249 void *private;
250};
251
252static inline struct nvm_rq *nvm_rq_from_pdu(void *pdu)
253{
254 return pdu - sizeof(struct nvm_rq);
255}
256
257static inline void *nvm_rq_to_pdu(struct nvm_rq *rqdata)
258{
259 return rqdata + 1;
260}
261
262enum {
263 NVM_BLK_ST_FREE = 0x1,
264 NVM_BLK_ST_TGT = 0x2,
265 NVM_BLK_ST_BAD = 0x8,
266};
267
268
269struct nvm_geo {
270 int nr_chnls;
271 int nr_luns;
272 int luns_per_chnl;
273 int nr_planes;
274 int sec_per_pg;
275 int pgs_per_blk;
276 int blks_per_lun;
277 int fpg_size;
278 int pfpg_size;
279 int sec_size;
280 int oob_size;
281 int mccap;
282 struct nvm_addr_format ppaf;
283
284
285
286
287 int max_rq_size;
288 int plane_mode;
289
290 int sec_per_pl;
291 int sec_per_blk;
292 int sec_per_lun;
293};
294
295
296struct nvm_tgt_dev {
297
298 struct nvm_geo geo;
299
300
301 struct ppa_addr *luns;
302
303 sector_t total_secs;
304
305 struct nvm_id identity;
306 struct request_queue *q;
307
308 struct nvm_dev *parent;
309 void *map;
310};
311
312struct nvm_dev {
313 struct nvm_dev_ops *ops;
314
315 struct list_head devices;
316
317
318 struct nvm_geo geo;
319
320
321 int lps_per_blk;
322 int *lptbl;
323
324 unsigned long total_secs;
325
326 unsigned long *lun_map;
327 void *dma_pool;
328
329 struct nvm_id identity;
330
331
332 struct request_queue *q;
333 char name[DISK_NAME_LEN];
334 void *private_data;
335
336 void *rmap;
337
338 struct mutex mlock;
339 spinlock_t lock;
340
341
342 struct list_head area_list;
343 struct list_head targets;
344};
345
346static inline struct ppa_addr linear_to_generic_addr(struct nvm_geo *geo,
347 u64 pba)
348{
349 struct ppa_addr l;
350 int secs, pgs, blks, luns;
351 sector_t ppa = pba;
352
353 l.ppa = 0;
354
355 div_u64_rem(ppa, geo->sec_per_pg, &secs);
356 l.g.sec = secs;
357
358 sector_div(ppa, geo->sec_per_pg);
359 div_u64_rem(ppa, geo->pgs_per_blk, &pgs);
360 l.g.pg = pgs;
361
362 sector_div(ppa, geo->pgs_per_blk);
363 div_u64_rem(ppa, geo->blks_per_lun, &blks);
364 l.g.blk = blks;
365
366 sector_div(ppa, geo->blks_per_lun);
367 div_u64_rem(ppa, geo->luns_per_chnl, &luns);
368 l.g.lun = luns;
369
370 sector_div(ppa, geo->luns_per_chnl);
371 l.g.ch = ppa;
372
373 return l;
374}
375
376static inline struct ppa_addr generic_to_dev_addr(struct nvm_tgt_dev *tgt_dev,
377 struct ppa_addr r)
378{
379 struct nvm_geo *geo = &tgt_dev->geo;
380 struct ppa_addr l;
381
382 l.ppa = ((u64)r.g.blk) << geo->ppaf.blk_offset;
383 l.ppa |= ((u64)r.g.pg) << geo->ppaf.pg_offset;
384 l.ppa |= ((u64)r.g.sec) << geo->ppaf.sect_offset;
385 l.ppa |= ((u64)r.g.pl) << geo->ppaf.pln_offset;
386 l.ppa |= ((u64)r.g.lun) << geo->ppaf.lun_offset;
387 l.ppa |= ((u64)r.g.ch) << geo->ppaf.ch_offset;
388
389 return l;
390}
391
392static inline struct ppa_addr dev_to_generic_addr(struct nvm_tgt_dev *tgt_dev,
393 struct ppa_addr r)
394{
395 struct nvm_geo *geo = &tgt_dev->geo;
396 struct ppa_addr l;
397
398 l.ppa = 0;
399
400
401
402 l.g.blk = (r.ppa >> geo->ppaf.blk_offset) &
403 (((1 << geo->ppaf.blk_len) - 1));
404 l.g.pg |= (r.ppa >> geo->ppaf.pg_offset) &
405 (((1 << geo->ppaf.pg_len) - 1));
406 l.g.sec |= (r.ppa >> geo->ppaf.sect_offset) &
407 (((1 << geo->ppaf.sect_len) - 1));
408 l.g.pl |= (r.ppa >> geo->ppaf.pln_offset) &
409 (((1 << geo->ppaf.pln_len) - 1));
410 l.g.lun |= (r.ppa >> geo->ppaf.lun_offset) &
411 (((1 << geo->ppaf.lun_len) - 1));
412 l.g.ch |= (r.ppa >> geo->ppaf.ch_offset) &
413 (((1 << geo->ppaf.ch_len) - 1));
414
415 return l;
416}
417
418static inline int ppa_empty(struct ppa_addr ppa_addr)
419{
420 return (ppa_addr.ppa == ADDR_EMPTY);
421}
422
423static inline void ppa_set_empty(struct ppa_addr *ppa_addr)
424{
425 ppa_addr->ppa = ADDR_EMPTY;
426}
427
428static 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
437typedef blk_qc_t (nvm_tgt_make_rq_fn)(struct request_queue *, struct bio *);
438typedef sector_t (nvm_tgt_capacity_fn)(void *);
439typedef void *(nvm_tgt_init_fn)(struct nvm_tgt_dev *, struct gendisk *,
440 int flags);
441typedef void (nvm_tgt_exit_fn)(void *);
442typedef int (nvm_tgt_sysfs_init_fn)(struct gendisk *);
443typedef void (nvm_tgt_sysfs_exit_fn)(struct gendisk *);
444
445struct nvm_tgt_type {
446 const char *name;
447 unsigned int version[3];
448
449
450 nvm_tgt_make_rq_fn *make_rq;
451 nvm_tgt_capacity_fn *capacity;
452
453
454 nvm_tgt_init_fn *init;
455 nvm_tgt_exit_fn *exit;
456
457
458 nvm_tgt_sysfs_init_fn *sysfs_init;
459 nvm_tgt_sysfs_exit_fn *sysfs_exit;
460
461
462 struct list_head list;
463};
464
465extern struct nvm_tgt_type *nvm_find_target_type(const char *, int);
466
467extern int nvm_register_tgt_type(struct nvm_tgt_type *);
468extern void nvm_unregister_tgt_type(struct nvm_tgt_type *);
469
470extern void *nvm_dev_dma_alloc(struct nvm_dev *, gfp_t, dma_addr_t *);
471extern void nvm_dev_dma_free(struct nvm_dev *, void *, dma_addr_t);
472
473extern struct nvm_dev *nvm_alloc_dev(int);
474extern int nvm_register(struct nvm_dev *);
475extern void nvm_unregister(struct nvm_dev *);
476
477extern int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr *,
478 int, int);
479extern int nvm_max_phys_sects(struct nvm_tgt_dev *);
480extern int nvm_submit_io(struct nvm_tgt_dev *, struct nvm_rq *);
481extern int nvm_erase_sync(struct nvm_tgt_dev *, struct ppa_addr *, int);
482extern int nvm_set_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *,
483 const struct ppa_addr *, int, int);
484extern void nvm_free_rqd_ppalist(struct nvm_tgt_dev *, struct nvm_rq *);
485extern int nvm_get_l2p_tbl(struct nvm_tgt_dev *, u64, u32, nvm_l2p_update_fn *,
486 void *);
487extern int nvm_get_area(struct nvm_tgt_dev *, sector_t *, sector_t);
488extern void nvm_put_area(struct nvm_tgt_dev *, sector_t);
489extern void nvm_end_io(struct nvm_rq *);
490extern int nvm_bb_tbl_fold(struct nvm_dev *, u8 *, int);
491extern int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *, struct ppa_addr, u8 *);
492
493extern int nvm_dev_factory(struct nvm_dev *, int flags);
494
495extern void nvm_part_to_tgt(struct nvm_dev *, sector_t *, int);
496
497#else
498struct nvm_dev_ops;
499
500static inline struct nvm_dev *nvm_alloc_dev(int node)
501{
502 return ERR_PTR(-EINVAL);
503}
504static inline int nvm_register(struct nvm_dev *dev)
505{
506 return -EINVAL;
507}
508static inline void nvm_unregister(struct nvm_dev *dev) {}
509#endif
510#endif
511
