?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
mm, debug: replace dump_flags() with the new printk formats
[linux/fpc-iii.git] / drivers / nvme / host / lightnvm.c
blob6bb15e4926dc86ed8b30e5cc2c504dc29090d545
1 /*
2 * nvme-lightnvm.c - LightNVM NVMe device
3 *
4 * Copyright (C) 2014-2015 IT University of Copenhagen
5 * Initial release: Matias Bjorling <mb@lightnvm.io>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
19 * USA.
20 *
21 */
22
23 #include "nvme.h"
24
25 #include <linux/nvme.h>
26 #include <linux/bitops.h>
27 #include <linux/lightnvm.h>
28 #include <linux/vmalloc.h>
29
30 enum nvme_nvm_admin_opcode {
31 nvme_nvm_admin_identity = 0xe2,
32 nvme_nvm_admin_get_l2p_tbl = 0xea,
33 nvme_nvm_admin_get_bb_tbl = 0xf2,
34 nvme_nvm_admin_set_bb_tbl = 0xf1,
35 };
36
37 struct nvme_nvm_hb_rw {
38 __u8 opcode;
39 __u8 flags;
40 __u16 command_id;
41 __le32 nsid;
42 __u64 rsvd2;
43 __le64 metadata;
44 __le64 prp1;
45 __le64 prp2;
46 __le64 spba;
47 __le16 length;
48 __le16 control;
49 __le32 dsmgmt;
50 __le64 slba;
51 };
52
53 struct nvme_nvm_ph_rw {
54 __u8 opcode;
55 __u8 flags;
56 __u16 command_id;
57 __le32 nsid;
58 __u64 rsvd2;
59 __le64 metadata;
60 __le64 prp1;
61 __le64 prp2;
62 __le64 spba;
63 __le16 length;
64 __le16 control;
65 __le32 dsmgmt;
66 __le64 resv;
67 };
68
69 struct nvme_nvm_identity {
70 __u8 opcode;
71 __u8 flags;
72 __u16 command_id;
73 __le32 nsid;
74 __u64 rsvd[2];
75 __le64 prp1;
76 __le64 prp2;
77 __le32 chnl_off;
78 __u32 rsvd11[5];
79 };
80
81 struct nvme_nvm_l2ptbl {
82 __u8 opcode;
83 __u8 flags;
84 __u16 command_id;
85 __le32 nsid;
86 __le32 cdw2[4];
87 __le64 prp1;
88 __le64 prp2;
89 __le64 slba;
90 __le32 nlb;
91 __le16 cdw14[6];
92 };
93
94 struct nvme_nvm_getbbtbl {
95 __u8 opcode;
96 __u8 flags;
97 __u16 command_id;
98 __le32 nsid;
99 __u64 rsvd[2];
100 __le64 prp1;
101 __le64 prp2;
102 __le64 spba;
103 __u32 rsvd4[4];
104 };
105
106 struct nvme_nvm_setbbtbl {
107 __u8 opcode;
108 __u8 flags;
109 __u16 command_id;
110 __le32 nsid;
111 __le64 rsvd[2];
112 __le64 prp1;
113 __le64 prp2;
114 __le64 spba;
115 __le16 nlb;
116 __u8 value;
117 __u8 rsvd3;
118 __u32 rsvd4[3];
119 };
120
121 struct nvme_nvm_erase_blk {
122 __u8 opcode;
123 __u8 flags;
124 __u16 command_id;
125 __le32 nsid;
126 __u64 rsvd[2];
127 __le64 prp1;
128 __le64 prp2;
129 __le64 spba;
130 __le16 length;
131 __le16 control;
132 __le32 dsmgmt;
133 __le64 resv;
134 };
135
136 struct nvme_nvm_command {
137 union {
138 struct nvme_common_command common;
139 struct nvme_nvm_identity identity;
140 struct nvme_nvm_hb_rw hb_rw;
141 struct nvme_nvm_ph_rw ph_rw;
142 struct nvme_nvm_l2ptbl l2p;
143 struct nvme_nvm_getbbtbl get_bb;
144 struct nvme_nvm_setbbtbl set_bb;
145 struct nvme_nvm_erase_blk erase;
146 };
147 };
148
149 #define NVME_NVM_LP_MLC_PAIRS 886
150 struct nvme_nvm_lp_mlc {
151 __u16 num_pairs;
152 __u8 pairs[NVME_NVM_LP_MLC_PAIRS];
153 };
154
155 struct nvme_nvm_lp_tbl {
156 __u8 id[8];
157 struct nvme_nvm_lp_mlc mlc;
158 };
159
160 struct nvme_nvm_id_group {
161 __u8 mtype;
162 __u8 fmtype;
163 __le16 res16;
164 __u8 num_ch;
165 __u8 num_lun;
166 __u8 num_pln;
167 __u8 rsvd1;
168 __le16 num_blk;
169 __le16 num_pg;
170 __le16 fpg_sz;
171 __le16 csecs;
172 __le16 sos;
173 __le16 rsvd2;
174 __le32 trdt;
175 __le32 trdm;
176 __le32 tprt;
177 __le32 tprm;
178 __le32 tbet;
179 __le32 tbem;
180 __le32 mpos;
181 __le32 mccap;
182 __le16 cpar;
183 __u8 reserved[10];
184 struct nvme_nvm_lp_tbl lptbl;
185 } __packed;
186
187 struct nvme_nvm_addr_format {
188 __u8 ch_offset;
189 __u8 ch_len;
190 __u8 lun_offset;
191 __u8 lun_len;
192 __u8 pln_offset;
193 __u8 pln_len;
194 __u8 blk_offset;
195 __u8 blk_len;
196 __u8 pg_offset;
197 __u8 pg_len;
198 __u8 sect_offset;
199 __u8 sect_len;
200 __u8 res[4];
201 } __packed;
202
203 struct nvme_nvm_id {
204 __u8 ver_id;
205 __u8 vmnt;
206 __u8 cgrps;
207 __u8 res;
208 __le32 cap;
209 __le32 dom;
210 struct nvme_nvm_addr_format ppaf;
211 __u8 resv[228];
212 struct nvme_nvm_id_group groups[4];
213 } __packed;
214
215 struct nvme_nvm_bb_tbl {
216 __u8 tblid[4];
217 __le16 verid;
218 __le16 revid;
219 __le32 rvsd1;
220 __le32 tblks;
221 __le32 tfact;
222 __le32 tgrown;
223 __le32 tdresv;
224 __le32 thresv;
225 __le32 rsvd2[8];
226 __u8 blk[0];
227 };
228
229 /*
230 * Check we didn't inadvertently grow the command struct
231 */
232 static inline void _nvme_nvm_check_size(void)
233 {
234 BUILD_BUG_ON(sizeof(struct nvme_nvm_identity) != 64);
235 BUILD_BUG_ON(sizeof(struct nvme_nvm_hb_rw) != 64);
236 BUILD_BUG_ON(sizeof(struct nvme_nvm_ph_rw) != 64);
237 BUILD_BUG_ON(sizeof(struct nvme_nvm_getbbtbl) != 64);
238 BUILD_BUG_ON(sizeof(struct nvme_nvm_setbbtbl) != 64);
239 BUILD_BUG_ON(sizeof(struct nvme_nvm_l2ptbl) != 64);
240 BUILD_BUG_ON(sizeof(struct nvme_nvm_erase_blk) != 64);
241 BUILD_BUG_ON(sizeof(struct nvme_nvm_id_group) != 960);
242 BUILD_BUG_ON(sizeof(struct nvme_nvm_addr_format) != 128);
243 BUILD_BUG_ON(sizeof(struct nvme_nvm_id) != 4096);
244 BUILD_BUG_ON(sizeof(struct nvme_nvm_bb_tbl) != 512);
245 }
246
247 static int init_grps(struct nvm_id *nvm_id, struct nvme_nvm_id *nvme_nvm_id)
248 {
249 struct nvme_nvm_id_group *src;
250 struct nvm_id_group *dst;
251 int i, end;
252
253 end = min_t(u32, 4, nvm_id->cgrps);
254
255 for (i = 0; i < end; i++) {
256 src = &nvme_nvm_id->groups[i];
257 dst = &nvm_id->groups[i];
258
259 dst->mtype = src->mtype;
260 dst->fmtype = src->fmtype;
261 dst->num_ch = src->num_ch;
262 dst->num_lun = src->num_lun;
263 dst->num_pln = src->num_pln;
264
265 dst->num_pg = le16_to_cpu(src->num_pg);
266 dst->num_blk = le16_to_cpu(src->num_blk);
267 dst->fpg_sz = le16_to_cpu(src->fpg_sz);
268 dst->csecs = le16_to_cpu(src->csecs);
269 dst->sos = le16_to_cpu(src->sos);
270
271 dst->trdt = le32_to_cpu(src->trdt);
272 dst->trdm = le32_to_cpu(src->trdm);
273 dst->tprt = le32_to_cpu(src->tprt);
274 dst->tprm = le32_to_cpu(src->tprm);
275 dst->tbet = le32_to_cpu(src->tbet);
276 dst->tbem = le32_to_cpu(src->tbem);
277 dst->mpos = le32_to_cpu(src->mpos);
278 dst->mccap = le32_to_cpu(src->mccap);
279
280 dst->cpar = le16_to_cpu(src->cpar);
281
282 if (dst->fmtype == NVM_ID_FMTYPE_MLC) {
283 memcpy(dst->lptbl.id, src->lptbl.id, 8);
284 dst->lptbl.mlc.num_pairs =
285 le16_to_cpu(src->lptbl.mlc.num_pairs);
286
287 if (dst->lptbl.mlc.num_pairs > NVME_NVM_LP_MLC_PAIRS) {
288 pr_err("nvm: number of MLC pairs not supported\n");
289 return -EINVAL;
290 }
291
292 memcpy(dst->lptbl.mlc.pairs, src->lptbl.mlc.pairs,
293 dst->lptbl.mlc.num_pairs);
294 }
295 }
296
297 return 0;
298 }
299
300 static int nvme_nvm_identity(struct nvm_dev *nvmdev, struct nvm_id *nvm_id)
301 {
302 struct nvme_ns *ns = nvmdev->q->queuedata;
303 struct nvme_nvm_id *nvme_nvm_id;
304 struct nvme_nvm_command c = {};
305 int ret;
306
307 c.identity.opcode = nvme_nvm_admin_identity;
308 c.identity.nsid = cpu_to_le32(ns->ns_id);
309 c.identity.chnl_off = 0;
310
311 nvme_nvm_id = kmalloc(sizeof(struct nvme_nvm_id), GFP_KERNEL);
312 if (!nvme_nvm_id)
313 return -ENOMEM;
314
315 ret = nvme_submit_sync_cmd(ns->ctrl->admin_q, (struct nvme_command *)&c,
316 nvme_nvm_id, sizeof(struct nvme_nvm_id));
317 if (ret) {
318 ret = -EIO;
319 goto out;
320 }
321
322 nvm_id->ver_id = nvme_nvm_id->ver_id;
323 nvm_id->vmnt = nvme_nvm_id->vmnt;
324 nvm_id->cgrps = nvme_nvm_id->cgrps;
325 nvm_id->cap = le32_to_cpu(nvme_nvm_id->cap);
326 nvm_id->dom = le32_to_cpu(nvme_nvm_id->dom);
327 memcpy(&nvm_id->ppaf, &nvme_nvm_id->ppaf,
328 sizeof(struct nvme_nvm_addr_format));
329
330 ret = init_grps(nvm_id, nvme_nvm_id);
331 out:
332 kfree(nvme_nvm_id);
333 return ret;
334 }
335
336 static int nvme_nvm_get_l2p_tbl(struct nvm_dev *nvmdev, u64 slba, u32 nlb,
337 nvm_l2p_update_fn *update_l2p, void *priv)
338 {
339 struct nvme_ns *ns = nvmdev->q->queuedata;
340 struct nvme_nvm_command c = {};
341 u32 len = queue_max_hw_sectors(ns->ctrl->admin_q) << 9;
342 u32 nlb_pr_rq = len / sizeof(u64);
343 u64 cmd_slba = slba;
344 void *entries;
345 int ret = 0;
346
347 c.l2p.opcode = nvme_nvm_admin_get_l2p_tbl;
348 c.l2p.nsid = cpu_to_le32(ns->ns_id);
349 entries = kmalloc(len, GFP_KERNEL);
350 if (!entries)
351 return -ENOMEM;
352
353 while (nlb) {
354 u32 cmd_nlb = min(nlb_pr_rq, nlb);
355
356 c.l2p.slba = cpu_to_le64(cmd_slba);
357 c.l2p.nlb = cpu_to_le32(cmd_nlb);
358
359 ret = nvme_submit_sync_cmd(ns->ctrl->admin_q,
360 (struct nvme_command *)&c, entries, len);
361 if (ret) {
362 dev_err(ns->ctrl->dev, "L2P table transfer failed (%d)\n",
363 ret);
364 ret = -EIO;
365 goto out;
366 }
367
368 if (update_l2p(cmd_slba, cmd_nlb, entries, priv)) {
369 ret = -EINTR;
370 goto out;
371 }
372
373 cmd_slba += cmd_nlb;
374 nlb -= cmd_nlb;
375 }
376
377 out:
378 kfree(entries);
379 return ret;
380 }
381
382 static int nvme_nvm_get_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr ppa,
383 int nr_blocks, nvm_bb_update_fn *update_bbtbl,
384 void *priv)
385 {
386 struct request_queue *q = nvmdev->q;
387 struct nvme_ns *ns = q->queuedata;
388 struct nvme_ctrl *ctrl = ns->ctrl;
389 struct nvme_nvm_command c = {};
390 struct nvme_nvm_bb_tbl *bb_tbl;
391 int tblsz = sizeof(struct nvme_nvm_bb_tbl) + nr_blocks;
392 int ret = 0;
393
394 c.get_bb.opcode = nvme_nvm_admin_get_bb_tbl;
395 c.get_bb.nsid = cpu_to_le32(ns->ns_id);
396 c.get_bb.spba = cpu_to_le64(ppa.ppa);
397
398 bb_tbl = kzalloc(tblsz, GFP_KERNEL);
399 if (!bb_tbl)
400 return -ENOMEM;
401
402 ret = nvme_submit_sync_cmd(ctrl->admin_q, (struct nvme_command *)&c,
403 bb_tbl, tblsz);
404 if (ret) {
405 dev_err(ctrl->dev, "get bad block table failed (%d)\n", ret);
406 ret = -EIO;
407 goto out;
408 }
409
410 if (bb_tbl->tblid[0] != 'B' || bb_tbl->tblid[1] != 'B' ||
411 bb_tbl->tblid[2] != 'L' || bb_tbl->tblid[3] != 'T') {
412 dev_err(ctrl->dev, "bbt format mismatch\n");
413 ret = -EINVAL;
414 goto out;
415 }
416
417 if (le16_to_cpu(bb_tbl->verid) != 1) {
418 ret = -EINVAL;
419 dev_err(ctrl->dev, "bbt version not supported\n");
420 goto out;
421 }
422
423 if (le32_to_cpu(bb_tbl->tblks) != nr_blocks) {
424 ret = -EINVAL;
425 dev_err(ctrl->dev, "bbt unsuspected blocks returned (%u!=%u)",
426 le32_to_cpu(bb_tbl->tblks), nr_blocks);
427 goto out;
428 }
429
430 ppa = dev_to_generic_addr(nvmdev, ppa);
431 ret = update_bbtbl(ppa, nr_blocks, bb_tbl->blk, priv);
432 out:
433 kfree(bb_tbl);
434 return ret;
435 }
436
437 static int nvme_nvm_set_bb_tbl(struct nvm_dev *nvmdev, struct nvm_rq *rqd,
438 int type)
439 {
440 struct nvme_ns *ns = nvmdev->q->queuedata;
441 struct nvme_nvm_command c = {};
442 int ret = 0;
443
444 c.set_bb.opcode = nvme_nvm_admin_set_bb_tbl;
445 c.set_bb.nsid = cpu_to_le32(ns->ns_id);
446 c.set_bb.spba = cpu_to_le64(rqd->ppa_addr.ppa);
447 c.set_bb.nlb = cpu_to_le16(rqd->nr_pages - 1);
448 c.set_bb.value = type;
449
450 ret = nvme_submit_sync_cmd(ns->ctrl->admin_q, (struct nvme_command *)&c,
451 NULL, 0);
452 if (ret)
453 dev_err(ns->ctrl->dev, "set bad block table failed (%d)\n", ret);
454 return ret;
455 }
456
457 static inline void nvme_nvm_rqtocmd(struct request *rq, struct nvm_rq *rqd,
458 struct nvme_ns *ns, struct nvme_nvm_command *c)
459 {
460 c->ph_rw.opcode = rqd->opcode;
461 c->ph_rw.nsid = cpu_to_le32(ns->ns_id);
462 c->ph_rw.spba = cpu_to_le64(rqd->ppa_addr.ppa);
463 c->ph_rw.control = cpu_to_le16(rqd->flags);
464 c->ph_rw.length = cpu_to_le16(rqd->nr_pages - 1);
465
466 if (rqd->opcode == NVM_OP_HBWRITE || rqd->opcode == NVM_OP_HBREAD)
467 c->hb_rw.slba = cpu_to_le64(nvme_block_nr(ns,
468 rqd->bio->bi_iter.bi_sector));
469 }
470
471 static void nvme_nvm_end_io(struct request *rq, int error)
472 {
473 struct nvm_rq *rqd = rq->end_io_data;
474
475 nvm_end_io(rqd, error);
476
477 kfree(rq->cmd);
478 blk_mq_free_request(rq);
479 }
480
481 static int nvme_nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
482 {
483 struct request_queue *q = dev->q;
484 struct nvme_ns *ns = q->queuedata;
485 struct request *rq;
486 struct bio *bio = rqd->bio;
487 struct nvme_nvm_command *cmd;
488
489 rq = blk_mq_alloc_request(q, bio_rw(bio), 0);
490 if (IS_ERR(rq))
491 return -ENOMEM;
492
493 cmd = kzalloc(sizeof(struct nvme_nvm_command), GFP_KERNEL);
494 if (!cmd) {
495 blk_mq_free_request(rq);
496 return -ENOMEM;
497 }
498
499 rq->cmd_type = REQ_TYPE_DRV_PRIV;
500 rq->ioprio = bio_prio(bio);
501
502 if (bio_has_data(bio))
503 rq->nr_phys_segments = bio_phys_segments(q, bio);
504
505 rq->__data_len = bio->bi_iter.bi_size;
506 rq->bio = rq->biotail = bio;
507
508 nvme_nvm_rqtocmd(rq, rqd, ns, cmd);
509
510 rq->cmd = (unsigned char *)cmd;
511 rq->cmd_len = sizeof(struct nvme_nvm_command);
512 rq->special = (void *)0;
513
514 rq->end_io_data = rqd;
515
516 blk_execute_rq_nowait(q, NULL, rq, 0, nvme_nvm_end_io);
517
518 return 0;
519 }
520
521 static int nvme_nvm_erase_block(struct nvm_dev *dev, struct nvm_rq *rqd)
522 {
523 struct request_queue *q = dev->q;
524 struct nvme_ns *ns = q->queuedata;
525 struct nvme_nvm_command c = {};
526
527 c.erase.opcode = NVM_OP_ERASE;
528 c.erase.nsid = cpu_to_le32(ns->ns_id);
529 c.erase.spba = cpu_to_le64(rqd->ppa_addr.ppa);
530 c.erase.length = cpu_to_le16(rqd->nr_pages - 1);
531
532 return nvme_submit_sync_cmd(q, (struct nvme_command *)&c, NULL, 0);
533 }
534
535 static void *nvme_nvm_create_dma_pool(struct nvm_dev *nvmdev, char *name)
536 {
537 struct nvme_ns *ns = nvmdev->q->queuedata;
538
539 return dma_pool_create(name, ns->ctrl->dev, PAGE_SIZE, PAGE_SIZE, 0);
540 }
541
542 static void nvme_nvm_destroy_dma_pool(void *pool)
543 {
544 struct dma_pool *dma_pool = pool;
545
546 dma_pool_destroy(dma_pool);
547 }
548
549 static void *nvme_nvm_dev_dma_alloc(struct nvm_dev *dev, void *pool,
550 gfp_t mem_flags, dma_addr_t *dma_handler)
551 {
552 return dma_pool_alloc(pool, mem_flags, dma_handler);
553 }
554
555 static void nvme_nvm_dev_dma_free(void *pool, void *ppa_list,
556 dma_addr_t dma_handler)
557 {
558 dma_pool_free(pool, ppa_list, dma_handler);
559 }
560
561 static struct nvm_dev_ops nvme_nvm_dev_ops = {
562 .identity = nvme_nvm_identity,
563
564 .get_l2p_tbl = nvme_nvm_get_l2p_tbl,
565
566 .get_bb_tbl = nvme_nvm_get_bb_tbl,
567 .set_bb_tbl = nvme_nvm_set_bb_tbl,
568
569 .submit_io = nvme_nvm_submit_io,
570 .erase_block = nvme_nvm_erase_block,
571
572 .create_dma_pool = nvme_nvm_create_dma_pool,
573 .destroy_dma_pool = nvme_nvm_destroy_dma_pool,
574 .dev_dma_alloc = nvme_nvm_dev_dma_alloc,
575 .dev_dma_free = nvme_nvm_dev_dma_free,
576
577 .max_phys_sect = 64,
578 };
579
580 int nvme_nvm_register(struct request_queue *q, char *disk_name)
581 {
582 return nvm_register(q, disk_name, &nvme_nvm_dev_ops);
583 }
584
585 void nvme_nvm_unregister(struct request_queue *q, char *disk_name)
586 {
587 nvm_unregister(disk_name);
588 }
589
590 /* move to shared place when used in multiple places. */
591 #define PCI_VENDOR_ID_CNEX 0x1d1d
592 #define PCI_DEVICE_ID_CNEX_WL 0x2807
593 #define PCI_DEVICE_ID_CNEX_QEMU 0x1f1f
594
595 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
596 {
597 struct nvme_ctrl *ctrl = ns->ctrl;
598 /* XXX: this is poking into PCI structures from generic code! */
599 struct pci_dev *pdev = to_pci_dev(ctrl->dev);
600
601 /* QEMU NVMe simulator - PCI ID + Vendor specific bit */
602 if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
603 pdev->device == PCI_DEVICE_ID_CNEX_QEMU &&
604 id->vs[0] == 0x1)
605 return 1;
606
607 /* CNEX Labs - PCI ID + Vendor specific bit */
608 if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
609 pdev->device == PCI_DEVICE_ID_CNEX_WL &&
610 id->vs[0] == 0x1)
611 return 1;
612
613 return 0;
614 }
Linux with added FPC-III support