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