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