projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lightnvm: introduce nvm_for_each_lun_ppa() macro
[linux-2.6-block.git] / drivers / lightnvm / core.c
CommitLineData
cd9e9808
MB		 1/*
2 * Copyright (C) 2015 IT University of Copenhagen. All rights reserved.
3 * Initial release: Matias Bjorling <m@bjorling.me>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License version
7 * 2 as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; see the file COPYING. If not, write to
16 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
17 * USA.
18 *
19 */
20
21#include <linux/blkdev.h>
22#include <linux/blk-mq.h>
23#include <linux/list.h>
24#include <linux/types.h>
25#include <linux/sem.h>
26#include <linux/bitmap.h>
27#include <linux/module.h>
28#include <linux/miscdevice.h>
29#include <linux/lightnvm.h>
91276162 30#include <linux/sched/sysctl.h>
cd9e9808
MB		 31#include <uapi/linux/lightnvm.h>
32
6063fe39 33static LIST_HEAD(nvm_tgt_types);
cd9e9808
MB		 34static LIST_HEAD(nvm_mgrs);
35static LIST_HEAD(nvm_devices);
6f8645cb 36static LIST_HEAD(nvm_targets);
cd9e9808
MB		 37static DECLARE_RWSEM(nvm_lock);
38
6f8645cb
SL		 39static struct nvm_target *nvm_find_target(const char *name)
40{
41 struct nvm_target *tgt;
42
43 list_for_each_entry(tgt, &nvm_targets, list)
44 if (!strcmp(name, tgt->disk->disk_name))
45 return tgt;
46
47 return NULL;
48}
49
cd9e9808
MB		 50static struct nvm_tgt_type *nvm_find_target_type(const char *name)
51{
52 struct nvm_tgt_type *tt;
53
6063fe39 54 list_for_each_entry(tt, &nvm_tgt_types, list)
cd9e9808
MB		 55 if (!strcmp(name, tt->name))
56 return tt;
57
58 return NULL;
59}
60
6063fe39 61int nvm_register_tgt_type(struct nvm_tgt_type *tt)
cd9e9808
MB		 62{
63 int ret = 0;
64
65 down_write(&nvm_lock);
66 if (nvm_find_target_type(tt->name))
67 ret = -EEXIST;
68 else
6063fe39 69 list_add(&tt->list, &nvm_tgt_types);
cd9e9808
MB		 70 up_write(&nvm_lock);
71
72 return ret;
73}
6063fe39 74EXPORT_SYMBOL(nvm_register_tgt_type);
cd9e9808 75
6063fe39 76void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
cd9e9808
MB		 77{
78 if (!tt)
79 return;
80
81 down_write(&nvm_lock);
82 list_del(&tt->list);
83 up_write(&nvm_lock);
84}
6063fe39 85EXPORT_SYMBOL(nvm_unregister_tgt_type);
cd9e9808
MB		 86
87void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
88 dma_addr_t *dma_handler)
89{
16f26c3a 90 return dev->ops->dev_dma_alloc(dev, dev->ppalist_pool, mem_flags,
cd9e9808
MB		 91 dma_handler);
92}
93EXPORT_SYMBOL(nvm_dev_dma_alloc);
94
95void nvm_dev_dma_free(struct nvm_dev *dev, void *ppa_list,
96 dma_addr_t dma_handler)
97{
98 dev->ops->dev_dma_free(dev->ppalist_pool, ppa_list, dma_handler);
99}
100EXPORT_SYMBOL(nvm_dev_dma_free);
101
102static struct nvmm_type *nvm_find_mgr_type(const char *name)
103{
104 struct nvmm_type *mt;
105
106 list_for_each_entry(mt, &nvm_mgrs, list)
107 if (!strcmp(name, mt->name))
108 return mt;
109
110 return NULL;
111}
112
762796bc
MB		 113struct nvmm_type *nvm_init_mgr(struct nvm_dev *dev)
114{
115 struct nvmm_type *mt;
116 int ret;
117
118 lockdep_assert_held(&nvm_lock);
119
120 list_for_each_entry(mt, &nvm_mgrs, list) {
b7692076
MB		 121 if (strncmp(dev->sb.mmtype, mt->name, NVM_MMTYPE_LEN))
122 continue;
123
762796bc
MB		 124 ret = mt->register_mgr(dev);
125 if (ret < 0) {
126 pr_err("nvm: media mgr failed to init (%d) on dev %s\n",
127 ret, dev->name);
128 return NULL; /* initialization failed */
129 } else if (ret > 0)
130 return mt;
131 }
132
133 return NULL;
134}
135
cd9e9808
MB		 136int nvm_register_mgr(struct nvmm_type *mt)
137{
762796bc 138 struct nvm_dev *dev;
cd9e9808
MB		 139 int ret = 0;
140
141 down_write(&nvm_lock);
762796bc 142 if (nvm_find_mgr_type(mt->name)) {
cd9e9808 143 ret = -EEXIST;
762796bc
MB		 144 goto finish;
145 } else {
cd9e9808 146 list_add(&mt->list, &nvm_mgrs);
762796bc
MB		 147 }
148
149 /* try to register media mgr if any device have none configured */
150 list_for_each_entry(dev, &nvm_devices, devices) {
151 if (dev->mt)
152 continue;
153
154 dev->mt = nvm_init_mgr(dev);
155 }
156finish:
cd9e9808
MB		 157 up_write(&nvm_lock);
158
159 return ret;
160}
161EXPORT_SYMBOL(nvm_register_mgr);
162
163void nvm_unregister_mgr(struct nvmm_type *mt)
164{
165 if (!mt)
166 return;
167
168 down_write(&nvm_lock);
169 list_del(&mt->list);
170 up_write(&nvm_lock);
171}
172EXPORT_SYMBOL(nvm_unregister_mgr);
173
174static struct nvm_dev *nvm_find_nvm_dev(const char *name)
175{
176 struct nvm_dev *dev;
177
178 list_for_each_entry(dev, &nvm_devices, devices)
179 if (!strcmp(name, dev->name))
180 return dev;
181
182 return NULL;
183}
184
ff0e498b
JG		 185struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *dev, struct nvm_lun *lun,
186 unsigned long flags)
187{
188 return dev->mt->get_blk_unlocked(dev, lun, flags);
189}
190EXPORT_SYMBOL(nvm_get_blk_unlocked);
191
192/* Assumes that all valid pages have already been moved on release to bm */
193void nvm_put_blk_unlocked(struct nvm_dev *dev, struct nvm_block *blk)
194{
195 return dev->mt->put_blk_unlocked(dev, blk);
196}
197EXPORT_SYMBOL(nvm_put_blk_unlocked);
198
cd9e9808
MB		 199struct nvm_block *nvm_get_blk(struct nvm_dev *dev, struct nvm_lun *lun,
200 unsigned long flags)
201{
202 return dev->mt->get_blk(dev, lun, flags);
203}
204EXPORT_SYMBOL(nvm_get_blk);
205
206/* Assumes that all valid pages have already been moved on release to bm */
207void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
208{
209 return dev->mt->put_blk(dev, blk);
210}
211EXPORT_SYMBOL(nvm_put_blk);
212
213int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
214{
215 return dev->mt->submit_io(dev, rqd);
216}
217EXPORT_SYMBOL(nvm_submit_io);
218
219int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk)
220{
221 return dev->mt->erase_blk(dev, blk, 0);
222}
223EXPORT_SYMBOL(nvm_erase_blk);
224
069368e9
MB		 225void nvm_addr_to_generic_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
226{
227 int i;
228
229 if (rqd->nr_pages > 1) {
230 for (i = 0; i < rqd->nr_pages; i++)
231 rqd->ppa_list[i] = dev_to_generic_addr(dev,
232 rqd->ppa_list[i]);
233 } else {
234 rqd->ppa_addr = dev_to_generic_addr(dev, rqd->ppa_addr);
235 }
236}
237EXPORT_SYMBOL(nvm_addr_to_generic_mode);
238
239void nvm_generic_to_addr_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
240{
241 int i;
242
243 if (rqd->nr_pages > 1) {
244 for (i = 0; i < rqd->nr_pages; i++)
245 rqd->ppa_list[i] = generic_to_dev_addr(dev,
246 rqd->ppa_list[i]);
247 } else {
248 rqd->ppa_addr = generic_to_dev_addr(dev, rqd->ppa_addr);
249 }
250}
251EXPORT_SYMBOL(nvm_generic_to_addr_mode);
252
abd805ec
MB		 253int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
254 struct ppa_addr *ppas, int nr_ppas)
069368e9 255{
abd805ec
MB		 256 int i, plane_cnt, pl_idx;
257
258 if (dev->plane_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
259 rqd->nr_pages = 1;
260 rqd->ppa_addr = ppas[0];
069368e9 261
069368e9 262 return 0;
abd805ec 263 }
069368e9 264
d5bdec8d 265 plane_cnt = dev->plane_mode;
abd805ec 266 rqd->nr_pages = plane_cnt * nr_ppas;
069368e9 267
abd805ec
MB		 268 if (dev->ops->max_phys_sect < rqd->nr_pages)
269 return -EINVAL;
270
271 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
272 if (!rqd->ppa_list) {
273 pr_err("nvm: failed to allocate dma memory\n");
274 return -ENOMEM;
275 }
276
556755e9
MB		 277 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
278 for (i = 0; i < nr_ppas; i++) {
abd805ec 279 ppas[i].g.pl = pl_idx;
556755e9 280 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppas[i];
069368e9
MB		 281 }
282 }
283
abd805ec
MB		 284 return 0;
285}
286EXPORT_SYMBOL(nvm_set_rqd_ppalist);
287
288void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
289{
290 if (!rqd->ppa_list)
291 return;
292
293 nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
294}
295EXPORT_SYMBOL(nvm_free_rqd_ppalist);
296
81e681d3 297int nvm_erase_ppa(struct nvm_dev *dev, struct ppa_addr *ppas, int nr_ppas)
abd805ec
MB		 298{
299 struct nvm_rq rqd;
300 int ret;
301
302 if (!dev->ops->erase_block)
303 return 0;
304
305 memset(&rqd, 0, sizeof(struct nvm_rq));
306
81e681d3 307 ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas);
abd805ec
MB		 308 if (ret)
309 return ret;
310
069368e9
MB		 311 nvm_generic_to_addr_mode(dev, &rqd);
312
313 ret = dev->ops->erase_block(dev, &rqd);
314
abd805ec 315 nvm_free_rqd_ppalist(dev, &rqd);
069368e9
MB		 316
317 return ret;
318}
319EXPORT_SYMBOL(nvm_erase_ppa);
320
91276162
MB		 321void nvm_end_io(struct nvm_rq *rqd, int error)
322{
72d256ec
MB		 323 rqd->error = error;
324 rqd->end_io(rqd);
91276162
MB		 325}
326EXPORT_SYMBOL(nvm_end_io);
327
09719b62 328static void nvm_end_io_sync(struct nvm_rq *rqd)
91276162
MB		 329{
330 struct completion *waiting = rqd->wait;
331
332 rqd->wait = NULL;
333
334 complete(waiting);
335}
336
1145e635
MB		 337int __nvm_submit_ppa(struct nvm_dev *dev, struct nvm_rq *rqd, int opcode,
338 int flags, void *buf, int len)
09719b62
MB		 339{
340 DECLARE_COMPLETION_ONSTACK(wait);
09719b62
MB		 341 struct bio *bio;
342 int ret;
343 unsigned long hang_check;
344
345 bio = bio_map_kern(dev->q, buf, len, GFP_KERNEL);
346 if (IS_ERR_OR_NULL(bio))
347 return -ENOMEM;
348
1145e635 349 nvm_generic_to_addr_mode(dev, rqd);
09719b62 350
1145e635
MB		 351 rqd->dev = dev;
352 rqd->opcode = opcode;
353 rqd->flags = flags;
354 rqd->bio = bio;
355 rqd->wait = &wait;
356 rqd->end_io = nvm_end_io_sync;
09719b62 357
1145e635 358 ret = dev->ops->submit_io(dev, rqd);
ecfb40c6 359 if (ret) {
ecfb40c6
MB		 360 bio_put(bio);
361 return ret;
362 }
09719b62
MB		 363
364 /* Prevent hang_check timer from firing at us during very long I/O */
365 hang_check = sysctl_hung_task_timeout_secs;
366 if (hang_check)
367 while (!wait_for_completion_io_timeout(&wait, hang_check * (HZ/2)));
368 else
369 wait_for_completion_io(&wait);
370
1145e635
MB		 371 return rqd->error;
372}
373
374/**
375 * nvm_submit_ppa_list - submit user-defined ppa list to device. The user must
376 * take to free ppa list if necessary.
377 * @dev: device
378 * @ppa_list: user created ppa_list
379 * @nr_ppas: length of ppa_list
380 * @opcode: device opcode
381 * @flags: device flags
382 * @buf: data buffer
383 * @len: data buffer length
384 */
385int nvm_submit_ppa_list(struct nvm_dev *dev, struct ppa_addr *ppa_list,
386 int nr_ppas, int opcode, int flags, void *buf, int len)
387{
388 struct nvm_rq rqd;
389
390 if (dev->ops->max_phys_sect < nr_ppas)
391 return -EINVAL;
392
393 memset(&rqd, 0, sizeof(struct nvm_rq));
394
395 rqd.nr_pages = nr_ppas;
396 if (nr_ppas > 1)
397 rqd.ppa_list = ppa_list;
398 else
399 rqd.ppa_addr = ppa_list[0];
400
401 return __nvm_submit_ppa(dev, &rqd, opcode, flags, buf, len);
402}
403EXPORT_SYMBOL(nvm_submit_ppa_list);
404
405/**
406 * nvm_submit_ppa - submit PPAs to device. PPAs will automatically be unfolded
407 * as single, dual, quad plane PPAs depending on device type.
408 * @dev: device
409 * @ppa: user created ppa_list
410 * @nr_ppas: length of ppa_list
411 * @opcode: device opcode
412 * @flags: device flags
413 * @buf: data buffer
414 * @len: data buffer length
415 */
416int nvm_submit_ppa(struct nvm_dev *dev, struct ppa_addr *ppa, int nr_ppas,
417 int opcode, int flags, void *buf, int len)
418{
419 struct nvm_rq rqd;
420 int ret;
421
422 memset(&rqd, 0, sizeof(struct nvm_rq));
423 ret = nvm_set_rqd_ppalist(dev, &rqd, ppa, nr_ppas);
424 if (ret)
425 return ret;
426
427 ret = __nvm_submit_ppa(dev, &rqd, opcode, flags, buf, len);
428
09719b62
MB		 429 nvm_free_rqd_ppalist(dev, &rqd);
430
1145e635 431 return ret;
09719b62
MB		 432}
433EXPORT_SYMBOL(nvm_submit_ppa);
434
22e8c976
MB		 435/*
436 * folds a bad block list from its plane representation to its virtual
437 * block representation. The fold is done in place and reduced size is
438 * returned.
439 *
440 * If any of the planes status are bad or grown bad block, the virtual block
441 * is marked bad. If not bad, the first plane state acts as the block state.
442 */
443int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
444{
445 int blk, offset, pl, blktype;
446
447 if (nr_blks != dev->blks_per_lun * dev->plane_mode)
448 return -EINVAL;
449
450 for (blk = 0; blk < dev->blks_per_lun; blk++) {
451 offset = blk * dev->plane_mode;
452 blktype = blks[offset];
453
454 /* Bad blocks on any planes take precedence over other types */
455 for (pl = 0; pl < dev->plane_mode; pl++) {
456 if (blks[offset + pl] &
457 (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
458 blktype = blks[offset + pl];
459 break;
460 }
461 }
462
463 blks[blk] = blktype;
464 }
465
466 return dev->blks_per_lun;
467}
468EXPORT_SYMBOL(nvm_bb_tbl_fold);
469
ca5927e7
MB		 470static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
471{
472 int i;
473
474 dev->lps_per_blk = dev->pgs_per_blk;
475 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
476 if (!dev->lptbl)
477 return -ENOMEM;
478
479 /* Just a linear array */
480 for (i = 0; i < dev->lps_per_blk; i++)
481 dev->lptbl[i] = i;
482
483 return 0;
484}
485
486static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
487{
488 int i, p;
489 struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
490
491 if (!mlc->num_pairs)
492 return 0;
493
494 dev->lps_per_blk = mlc->num_pairs;
495 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
496 if (!dev->lptbl)
497 return -ENOMEM;
498
499 /* The lower page table encoding consists of a list of bytes, where each
500 * has a lower and an upper half. The first half byte maintains the
501 * increment value and every value after is an offset added to the
502 * previous incrementation value */
503 dev->lptbl[0] = mlc->pairs[0] & 0xF;
504 for (i = 1; i < dev->lps_per_blk; i++) {
505 p = mlc->pairs[i >> 1];
506 if (i & 0x1) /* upper */
507 dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
508 else /* lower */
509 dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
510 }
511
512 return 0;
513}
514
cd9e9808
MB		 515static int nvm_core_init(struct nvm_dev *dev)
516{
517 struct nvm_id *id = &dev->identity;
518 struct nvm_id_group *grp = &id->groups[0];
7f7c5d03 519 int ret;
cd9e9808
MB		 520
521 /* device values */
522 dev->nr_chnls = grp->num_ch;
523 dev->luns_per_chnl = grp->num_lun;
524 dev->pgs_per_blk = grp->num_pg;
525 dev->blks_per_lun = grp->num_blk;
526 dev->nr_planes = grp->num_pln;
4891d120
MB		 527 dev->fpg_size = grp->fpg_sz;
528 dev->pfpg_size = grp->fpg_sz * grp->num_pln;
cd9e9808
MB		 529 dev->sec_size = grp->csecs;
530 dev->oob_size = grp->sos;
531 dev->sec_per_pg = grp->fpg_sz / grp->csecs;
f9a99950 532 dev->mccap = grp->mccap;
7386af27 533 memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
cd9e9808
MB		 534
535 dev->plane_mode = NVM_PLANE_SINGLE;
536 dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
537
538 if (grp->mpos & 0x020202)
539 dev->plane_mode = NVM_PLANE_DOUBLE;
540 if (grp->mpos & 0x040404)
541 dev->plane_mode = NVM_PLANE_QUAD;
542
7f7c5d03
MB		 543 if (grp->mtype != 0) {
544 pr_err("nvm: memory type not supported\n");
545 return -EINVAL;
546 }
547
cd9e9808
MB		 548 /* calculated values */
549 dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
550 dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
551 dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
552 dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
553
ed2a92a6 554 dev->total_secs = dev->nr_luns * dev->sec_per_lun;
da1e2849
WT		 555 dev->lun_map = kcalloc(BITS_TO_LONGS(dev->nr_luns),
556 sizeof(unsigned long), GFP_KERNEL);
557 if (!dev->lun_map)
558 return -ENOMEM;
7f7c5d03
MB		 559
560 switch (grp->fmtype) {
561 case NVM_ID_FMTYPE_SLC:
562 if (nvm_init_slc_tbl(dev, grp)) {
563 ret = -ENOMEM;
564 goto err_fmtype;
565 }
566 break;
567 case NVM_ID_FMTYPE_MLC:
568 if (nvm_init_mlc_tbl(dev, grp)) {
569 ret = -ENOMEM;
570 goto err_fmtype;
571 }
572 break;
573 default:
574 pr_err("nvm: flash type not supported\n");
575 ret = -EINVAL;
576 goto err_fmtype;
577 }
578
e3eb3799 579 mutex_init(&dev->mlock);
4c9dacb8 580 spin_lock_init(&dev->lock);
cd9e9808
MB		 581
582 return 0;
7f7c5d03
MB		 583err_fmtype:
584 kfree(dev->lun_map);
585 return ret;
cd9e9808
MB		 586}
587
588static void nvm_free(struct nvm_dev *dev)
589{
590 if (!dev)
591 return;
592
593 if (dev->mt)
594 dev->mt->unregister_mgr(dev);
ca5927e7
MB		 595
596 kfree(dev->lptbl);
7f7c5d03 597 kfree(dev->lun_map);
cd9e9808
MB		 598}
599
600static int nvm_init(struct nvm_dev *dev)
601{
480fc0db 602 int ret = -EINVAL;
cd9e9808
MB		 603
604 if (!dev->q || !dev->ops)
480fc0db 605 return ret;
cd9e9808 606
16f26c3a 607 if (dev->ops->identity(dev, &dev->identity)) {
cd9e9808 608 pr_err("nvm: device could not be identified\n");
cd9e9808
MB		 609 goto err;
610 }
611
612 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
613 dev->identity.ver_id, dev->identity.vmnt,
614 dev->identity.cgrps);
615
616 if (dev->identity.ver_id != 1) {
617 pr_err("nvm: device not supported by kernel.");
618 goto err;
619 }
620
621 if (dev->identity.cgrps != 1) {
622 pr_err("nvm: only one group configuration supported.");
623 goto err;
624 }
625
626 ret = nvm_core_init(dev);
627 if (ret) {
628 pr_err("nvm: could not initialize core structures.\n");
629 goto err;
630 }
631
cd9e9808
MB		 632 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
633 dev->name, dev->sec_per_pg, dev->nr_planes,
634 dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
635 dev->nr_chnls);
636 return 0;
637err:
cd9e9808
MB		 638 pr_err("nvm: failed to initialize nvm\n");
639 return ret;
640}
641
642static void nvm_exit(struct nvm_dev *dev)
643{
644 if (dev->ppalist_pool)
645 dev->ops->destroy_dma_pool(dev->ppalist_pool);
646 nvm_free(dev);
647
648 pr_info("nvm: successfully unloaded\n");
649}
650
651int nvm_register(struct request_queue *q, char *disk_name,
652 struct nvm_dev_ops *ops)
653{
654 struct nvm_dev *dev;
655 int ret;
656
657 if (!ops->identity)
658 return -EINVAL;
659
660 dev = kzalloc(sizeof(struct nvm_dev), GFP_KERNEL);
661 if (!dev)
662 return -ENOMEM;
663
664 dev->q = q;
665 dev->ops = ops;
666 strncpy(dev->name, disk_name, DISK_NAME_LEN);
667
668 ret = nvm_init(dev);
669 if (ret)
670 goto err_init;
671
d160147b
WT		 672 if (dev->ops->max_phys_sect > 256) {
673 pr_info("nvm: max sectors supported is 256.\n");
674 ret = -EINVAL;
675 goto err_init;
676 }
677
cd9e9808 678 if (dev->ops->max_phys_sect > 1) {
16f26c3a 679 dev->ppalist_pool = dev->ops->create_dma_pool(dev, "ppalist");
cd9e9808
MB		 680 if (!dev->ppalist_pool) {
681 pr_err("nvm: could not create ppa pool\n");
93e70c1f
MB		 682 ret = -ENOMEM;
683 goto err_init;
cd9e9808 684 }
cd9e9808
MB		 685 }
686
bf643185
MB		 687 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
688 ret = nvm_get_sysblock(dev, &dev->sb);
689 if (!ret)
690 pr_err("nvm: device not initialized.\n");
691 else if (ret < 0)
692 pr_err("nvm: err (%d) on device initialization\n", ret);
693 }
b7692076 694
762796bc 695 /* register device with a supported media manager */
edad2e66 696 down_write(&nvm_lock);
b7692076
MB		 697 if (ret > 0)
698 dev->mt = nvm_init_mgr(dev);
edad2e66
MB		 699 list_add(&dev->devices, &nvm_devices);
700 up_write(&nvm_lock);
701
cd9e9808
MB		 702 return 0;
703err_init:
da1e2849 704 kfree(dev->lun_map);
cd9e9808
MB		 705 kfree(dev);
706 return ret;
707}
708EXPORT_SYMBOL(nvm_register);
709
710void nvm_unregister(char *disk_name)
711{
d0a712ce 712 struct nvm_dev *dev;
cd9e9808 713
d0a712ce
WT		 714 down_write(&nvm_lock);
715 dev = nvm_find_nvm_dev(disk_name);
cd9e9808
MB		 716 if (!dev) {
717 pr_err("nvm: could not find device %s to unregister\n",
718 disk_name);
d0a712ce 719 up_write(&nvm_lock);
cd9e9808
MB		 720 return;
721 }
722
cd9e9808
MB		 723 list_del(&dev->devices);
724 up_write(&nvm_lock);
c1480ad5
MB		 725
726 nvm_exit(dev);
727 kfree(dev);
cd9e9808
MB		 728}
729EXPORT_SYMBOL(nvm_unregister);
730
731static const struct block_device_operations nvm_fops = {
732 .owner = THIS_MODULE,
733};
734
735static int nvm_create_target(struct nvm_dev *dev,
736 struct nvm_ioctl_create *create)
737{
738 struct nvm_ioctl_create_simple *s = &create->conf.s;
739 struct request_queue *tqueue;
cd9e9808
MB		 740 struct gendisk *tdisk;
741 struct nvm_tgt_type *tt;
742 struct nvm_target *t;
743 void *targetdata;
cd9e9808
MB		 744
745 if (!dev->mt) {
762796bc
MB		 746 pr_info("nvm: device has no media manager registered.\n");
747 return -ENODEV;
cd9e9808
MB		 748 }
749
762796bc 750 down_write(&nvm_lock);
cd9e9808
MB		 751 tt = nvm_find_target_type(create->tgttype);
752 if (!tt) {
753 pr_err("nvm: target type %s not found\n", create->tgttype);
d0a712ce 754 up_write(&nvm_lock);
cd9e9808
MB		 755 return -EINVAL;
756 }
757
6f8645cb
SL		 758 t = nvm_find_target(create->tgtname);
759 if (t) {
760 pr_err("nvm: target name already exists.\n");
761 up_write(&nvm_lock);
762 return -EINVAL;
cd9e9808
MB		 763 }
764 up_write(&nvm_lock);
765
766 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
767 if (!t)
768 return -ENOMEM;
769
770 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
771 if (!tqueue)
772 goto err_t;
773 blk_queue_make_request(tqueue, tt->make_rq);
774
775 tdisk = alloc_disk(0);
776 if (!tdisk)
777 goto err_queue;
778
779 sprintf(tdisk->disk_name, "%s", create->tgtname);
780 tdisk->flags = GENHD_FL_EXT_DEVT;
781 tdisk->major = 0;
782 tdisk->first_minor = 0;
783 tdisk->fops = &nvm_fops;
784 tdisk->queue = tqueue;
785
786 targetdata = tt->init(dev, tdisk, s->lun_begin, s->lun_end);
787 if (IS_ERR(targetdata))
788 goto err_init;
789
790 tdisk->private_data = targetdata;
791 tqueue->queuedata = targetdata;
792
793 blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
794
795 set_capacity(tdisk, tt->capacity(targetdata));
796 add_disk(tdisk);
797
798 t->type = tt;
799 t->disk = tdisk;
800
801 down_write(&nvm_lock);
6f8645cb 802 list_add_tail(&t->list, &nvm_targets);
cd9e9808
MB		 803 up_write(&nvm_lock);
804
805 return 0;
806err_init:
807 put_disk(tdisk);
808err_queue:
809 blk_cleanup_queue(tqueue);
810err_t:
811 kfree(t);
812 return -ENOMEM;
813}
814
815static void nvm_remove_target(struct nvm_target *t)
816{
817 struct nvm_tgt_type *tt = t->type;
818 struct gendisk *tdisk = t->disk;
819 struct request_queue *q = tdisk->queue;
820
821 lockdep_assert_held(&nvm_lock);
822
823 del_gendisk(tdisk);
d09f9581
JG		 824 blk_cleanup_queue(q);
825
cd9e9808
MB		 826 if (tt->exit)
827 tt->exit(tdisk->private_data);
828
cd9e9808
MB		 829 put_disk(tdisk);
830
831 list_del(&t->list);
832 kfree(t);
833}
834
835static int __nvm_configure_create(struct nvm_ioctl_create *create)
836{
837 struct nvm_dev *dev;
838 struct nvm_ioctl_create_simple *s;
839
d0a712ce 840 down_write(&nvm_lock);
cd9e9808 841 dev = nvm_find_nvm_dev(create->dev);
d0a712ce 842 up_write(&nvm_lock);
cd9e9808
MB		 843 if (!dev) {
844 pr_err("nvm: device not found\n");
845 return -EINVAL;
846 }
847
848 if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
849 pr_err("nvm: config type not valid\n");
850 return -EINVAL;
851 }
852 s = &create->conf.s;
853
854 if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
855 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
856 s->lun_begin, s->lun_end, dev->nr_luns);
857 return -EINVAL;
858 }
859
860 return nvm_create_target(dev, create);
861}
862
863static int __nvm_configure_remove(struct nvm_ioctl_remove *remove)
864{
6f8645cb 865 struct nvm_target *t;
cd9e9808
MB		 866
867 down_write(&nvm_lock);
6f8645cb
SL		 868 t = nvm_find_target(remove->tgtname);
869 if (!t) {
cd9e9808 870 pr_err("nvm: target \"%s\" doesn't exist.\n", remove->tgtname);
6f8645cb 871 up_write(&nvm_lock);
cd9e9808
MB		 872 return -EINVAL;
873 }
874
6f8645cb
SL		 875 nvm_remove_target(t);
876 up_write(&nvm_lock);
877
cd9e9808
MB		 878 return 0;
879}
880
881#ifdef CONFIG_NVM_DEBUG
882static int nvm_configure_show(const char *val)
883{
884 struct nvm_dev *dev;
885 char opcode, devname[DISK_NAME_LEN];
886 int ret;
887
888 ret = sscanf(val, "%c %32s", &opcode, devname);
889 if (ret != 2) {
890 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
891 return -EINVAL;
892 }
893
d0a712ce 894 down_write(&nvm_lock);
cd9e9808 895 dev = nvm_find_nvm_dev(devname);
d0a712ce 896 up_write(&nvm_lock);
cd9e9808
MB		 897 if (!dev) {
898 pr_err("nvm: device not found\n");
899 return -EINVAL;
900 }
901
902 if (!dev->mt)
903 return 0;
904
2fde0e48 905 dev->mt->lun_info_print(dev);
cd9e9808
MB		 906
907 return 0;
908}
909
910static int nvm_configure_remove(const char *val)
911{
912 struct nvm_ioctl_remove remove;
913 char opcode;
914 int ret;
915
916 ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
917 if (ret != 2) {
918 pr_err("nvm: invalid command. Use \"d targetname\".\n");
919 return -EINVAL;
920 }
921
922 remove.flags = 0;
923
924 return __nvm_configure_remove(&remove);
925}
926
927static int nvm_configure_create(const char *val)
928{
929 struct nvm_ioctl_create create;
930 char opcode;
931 int lun_begin, lun_end, ret;
932
933 ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
934 create.tgtname, create.tgttype,
935 &lun_begin, &lun_end);
936 if (ret != 6) {
937 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
938 return -EINVAL;
939 }
940
941 create.flags = 0;
942 create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
943 create.conf.s.lun_begin = lun_begin;
944 create.conf.s.lun_end = lun_end;
945
946 return __nvm_configure_create(&create);
947}
948
949
950/* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
951static int nvm_configure_by_str_event(const char *val,
952 const struct kernel_param *kp)
953{
954 char opcode;
955 int ret;
956
957 ret = sscanf(val, "%c", &opcode);
958 if (ret != 1) {
959 pr_err("nvm: string must have the format of \"cmd ...\"\n");
960 return -EINVAL;
961 }
962
963 switch (opcode) {
964 case 'a':
965 return nvm_configure_create(val);
966 case 'd':
967 return nvm_configure_remove(val);
968 case 's':
969 return nvm_configure_show(val);
970 default:
971 pr_err("nvm: invalid command\n");
972 return -EINVAL;
973 }
974
975 return 0;
976}
977
978static int nvm_configure_get(char *buf, const struct kernel_param *kp)
979{
5e422cff 980 int sz;
cd9e9808
MB		 981 struct nvm_dev *dev;
982
5e422cff 983 sz = sprintf(buf, "available devices:\n");
cd9e9808
MB		 984 down_write(&nvm_lock);
985 list_for_each_entry(dev, &nvm_devices, devices) {
5e422cff 986 if (sz > 4095 - DISK_NAME_LEN - 2)
cd9e9808 987 break;
5e422cff 988 sz += sprintf(buf + sz, " %32s\n", dev->name);
cd9e9808
MB		 989 }
990 up_write(&nvm_lock);
991
5e422cff 992 return sz;
cd9e9808
MB		 993}
994
995static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
996 .set = nvm_configure_by_str_event,
997 .get = nvm_configure_get,
998};
999
1000#undef MODULE_PARAM_PREFIX
1001#define MODULE_PARAM_PREFIX "lnvm."
1002
1003module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
1004 0644);
1005
1006#endif /* CONFIG_NVM_DEBUG */
1007
1008static long nvm_ioctl_info(struct file *file, void __user *arg)
1009{
1010 struct nvm_ioctl_info *info;
1011 struct nvm_tgt_type *tt;
1012 int tgt_iter = 0;
1013
1014 if (!capable(CAP_SYS_ADMIN))
1015 return -EPERM;
1016
1017 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1018 if (IS_ERR(info))
1019 return -EFAULT;
1020
1021 info->version[0] = NVM_VERSION_MAJOR;
1022 info->version[1] = NVM_VERSION_MINOR;
1023 info->version[2] = NVM_VERSION_PATCH;
1024
1025 down_write(&nvm_lock);
6063fe39 1026 list_for_each_entry(tt, &nvm_tgt_types, list) {
cd9e9808
MB		 1027 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1028
1029 tgt->version[0] = tt->version[0];
1030 tgt->version[1] = tt->version[1];
1031 tgt->version[2] = tt->version[2];
1032 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1033
1034 tgt_iter++;
1035 }
1036
1037 info->tgtsize = tgt_iter;
1038 up_write(&nvm_lock);
1039
76e25081
SM		 1040 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1041 kfree(info);
cd9e9808 1042 return -EFAULT;
76e25081 1043 }
cd9e9808
MB		 1044
1045 kfree(info);
1046 return 0;
1047}
1048
1049static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1050{
1051 struct nvm_ioctl_get_devices *devices;
1052 struct nvm_dev *dev;
1053 int i = 0;
1054
1055 if (!capable(CAP_SYS_ADMIN))
1056 return -EPERM;
1057
1058 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1059 if (!devices)
1060 return -ENOMEM;
1061
1062 down_write(&nvm_lock);
1063 list_for_each_entry(dev, &nvm_devices, devices) {
1064 struct nvm_ioctl_device_info *info = &devices->info[i];
1065
1066 sprintf(info->devname, "%s", dev->name);
1067 if (dev->mt) {
1068 info->bmversion[0] = dev->mt->version[0];
1069 info->bmversion[1] = dev->mt->version[1];
1070 info->bmversion[2] = dev->mt->version[2];
1071 sprintf(info->bmname, "%s", dev->mt->name);
1072 } else {
1073 sprintf(info->bmname, "none");
1074 }
1075
1076 i++;
1077 if (i > 31) {
1078 pr_err("nvm: max 31 devices can be reported.\n");
1079 break;
1080 }
1081 }
1082 up_write(&nvm_lock);
1083
1084 devices->nr_devices = i;
1085
76e25081
SM		 1086 if (copy_to_user(arg, devices,
1087 sizeof(struct nvm_ioctl_get_devices))) {
1088 kfree(devices);
cd9e9808 1089 return -EFAULT;
76e25081 1090 }
cd9e9808
MB		 1091
1092 kfree(devices);
1093 return 0;
1094}
1095
1096static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1097{
1098 struct nvm_ioctl_create create;
1099
1100 if (!capable(CAP_SYS_ADMIN))
1101 return -EPERM;
1102
1103 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1104 return -EFAULT;
1105
1106 create.dev[DISK_NAME_LEN - 1] = '\0';
1107 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1108 create.tgtname[DISK_NAME_LEN - 1] = '\0';
1109
1110 if (create.flags != 0) {
1111 pr_err("nvm: no flags supported\n");
1112 return -EINVAL;
1113 }
1114
1115 return __nvm_configure_create(&create);
1116}
1117
1118static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1119{
1120 struct nvm_ioctl_remove remove;
1121
1122 if (!capable(CAP_SYS_ADMIN))
1123 return -EPERM;
1124
1125 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1126 return -EFAULT;
1127
1128 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1129
1130 if (remove.flags != 0) {
1131 pr_err("nvm: no flags supported\n");
1132 return -EINVAL;
1133 }
1134
1135 return __nvm_configure_remove(&remove);
1136}
1137
55696154
MB		 1138static void nvm_setup_nvm_sb_info(struct nvm_sb_info *info)
1139{
1140 info->seqnr = 1;
1141 info->erase_cnt = 0;
1142 info->version = 1;
1143}
1144
1145static long __nvm_ioctl_dev_init(struct nvm_ioctl_dev_init *init)
1146{
1147 struct nvm_dev *dev;
1148 struct nvm_sb_info info;
b7692076 1149 int ret;
55696154
MB		 1150
1151 down_write(&nvm_lock);
1152 dev = nvm_find_nvm_dev(init->dev);
1153 up_write(&nvm_lock);
1154 if (!dev) {
1155 pr_err("nvm: device not found\n");
1156 return -EINVAL;
1157 }
1158
1159 nvm_setup_nvm_sb_info(&info);
1160
1161 strncpy(info.mmtype, init->mmtype, NVM_MMTYPE_LEN);
1162 info.fs_ppa.ppa = -1;
1163
bf643185
MB		 1164 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
1165 ret = nvm_init_sysblock(dev, &info);
1166 if (ret)
1167 return ret;
1168 }
b7692076
MB		 1169
1170 memcpy(&dev->sb, &info, sizeof(struct nvm_sb_info));
1171
1172 down_write(&nvm_lock);
1173 dev->mt = nvm_init_mgr(dev);
1174 up_write(&nvm_lock);
1175
1176 return 0;
55696154
MB		 1177}
1178
1179static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1180{
1181 struct nvm_ioctl_dev_init init;
1182
1183 if (!capable(CAP_SYS_ADMIN))
1184 return -EPERM;
1185
1186 if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1187 return -EFAULT;
1188
1189 if (init.flags != 0) {
1190 pr_err("nvm: no flags supported\n");
1191 return -EINVAL;
1192 }
1193
1194 init.dev[DISK_NAME_LEN - 1] = '\0';
1195
1196 return __nvm_ioctl_dev_init(&init);
1197}
1198
8b4970c4
MB		 1199static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1200{
1201 struct nvm_ioctl_dev_factory fact;
1202 struct nvm_dev *dev;
1203
1204 if (!capable(CAP_SYS_ADMIN))
1205 return -EPERM;
1206
1207 if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1208 return -EFAULT;
1209
1210 fact.dev[DISK_NAME_LEN - 1] = '\0';
1211
1212 if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1213 return -EINVAL;
1214
1215 down_write(&nvm_lock);
1216 dev = nvm_find_nvm_dev(fact.dev);
1217 up_write(&nvm_lock);
1218 if (!dev) {
1219 pr_err("nvm: device not found\n");
1220 return -EINVAL;
1221 }
1222
1223 if (dev->mt) {
1224 dev->mt->unregister_mgr(dev);
1225 dev->mt = NULL;
1226 }
1227
bf643185
MB		 1228 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT)
1229 return nvm_dev_factory(dev, fact.flags);
1230
1231 return 0;
8b4970c4
MB		 1232}
1233
cd9e9808
MB		 1234static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1235{
1236 void __user *argp = (void __user *)arg;
1237
1238 switch (cmd) {
1239 case NVM_INFO:
1240 return nvm_ioctl_info(file, argp);
1241 case NVM_GET_DEVICES:
1242 return nvm_ioctl_get_devices(file, argp);
1243 case NVM_DEV_CREATE:
1244 return nvm_ioctl_dev_create(file, argp);
1245 case NVM_DEV_REMOVE:
1246 return nvm_ioctl_dev_remove(file, argp);
55696154
MB		 1247 case NVM_DEV_INIT:
1248 return nvm_ioctl_dev_init(file, argp);
8b4970c4
MB		 1249 case NVM_DEV_FACTORY:
1250 return nvm_ioctl_dev_factory(file, argp);
cd9e9808
MB		 1251 }
1252 return 0;
1253}
1254
1255static const struct file_operations _ctl_fops = {
1256 .open = nonseekable_open,
1257 .unlocked_ioctl = nvm_ctl_ioctl,
1258 .owner = THIS_MODULE,
1259 .llseek = noop_llseek,
1260};
1261
1262static struct miscdevice _nvm_misc = {
1263 .minor = MISC_DYNAMIC_MINOR,
1264 .name = "lightnvm",
1265 .nodename = "lightnvm/control",
1266 .fops = &_ctl_fops,
1267};
1268
1269MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
1270
1271static int __init nvm_mod_init(void)
1272{
1273 int ret;
1274
1275 ret = misc_register(&_nvm_misc);
1276 if (ret)
1277 pr_err("nvm: misc_register failed for control device");
1278
1279 return ret;
1280}
1281
1282static void __exit nvm_mod_exit(void)
1283{
1284 misc_deregister(&_nvm_misc);
1285}
1286
1287MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
1288MODULE_LICENSE("GPL v2");
1289MODULE_VERSION("0.1");
1290module_init(nvm_mod_init);
1291module_exit(nvm_mod_exit);
Linux 6.x block layer and io_uring tree(s)