lightnvm: move rq->error to nvm_rq->error
[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
33static LIST_HEAD(nvm_targets);
34static LIST_HEAD(nvm_mgrs);
35static LIST_HEAD(nvm_devices);
36static DECLARE_RWSEM(nvm_lock);
37
38static struct nvm_tgt_type *nvm_find_target_type(const char *name)
39{
40 struct nvm_tgt_type *tt;
41
42 list_for_each_entry(tt, &nvm_targets, list)
43 if (!strcmp(name, tt->name))
44 return tt;
45
46 return NULL;
47}
48
49int nvm_register_target(struct nvm_tgt_type *tt)
50{
51 int ret = 0;
52
53 down_write(&nvm_lock);
54 if (nvm_find_target_type(tt->name))
55 ret = -EEXIST;
56 else
57 list_add(&tt->list, &nvm_targets);
58 up_write(&nvm_lock);
59
60 return ret;
61}
62EXPORT_SYMBOL(nvm_register_target);
63
64void nvm_unregister_target(struct nvm_tgt_type *tt)
65{
66 if (!tt)
67 return;
68
69 down_write(&nvm_lock);
70 list_del(&tt->list);
71 up_write(&nvm_lock);
72}
73EXPORT_SYMBOL(nvm_unregister_target);
74
75void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
76 dma_addr_t *dma_handler)
77{
16f26c3a 78 return dev->ops->dev_dma_alloc(dev, dev->ppalist_pool, mem_flags,
cd9e9808
MB
79 dma_handler);
80}
81EXPORT_SYMBOL(nvm_dev_dma_alloc);
82
83void nvm_dev_dma_free(struct nvm_dev *dev, void *ppa_list,
84 dma_addr_t dma_handler)
85{
86 dev->ops->dev_dma_free(dev->ppalist_pool, ppa_list, dma_handler);
87}
88EXPORT_SYMBOL(nvm_dev_dma_free);
89
90static struct nvmm_type *nvm_find_mgr_type(const char *name)
91{
92 struct nvmm_type *mt;
93
94 list_for_each_entry(mt, &nvm_mgrs, list)
95 if (!strcmp(name, mt->name))
96 return mt;
97
98 return NULL;
99}
100
762796bc
MB
101struct nvmm_type *nvm_init_mgr(struct nvm_dev *dev)
102{
103 struct nvmm_type *mt;
104 int ret;
105
106 lockdep_assert_held(&nvm_lock);
107
108 list_for_each_entry(mt, &nvm_mgrs, list) {
109 ret = mt->register_mgr(dev);
110 if (ret < 0) {
111 pr_err("nvm: media mgr failed to init (%d) on dev %s\n",
112 ret, dev->name);
113 return NULL; /* initialization failed */
114 } else if (ret > 0)
115 return mt;
116 }
117
118 return NULL;
119}
120
cd9e9808
MB
121int nvm_register_mgr(struct nvmm_type *mt)
122{
762796bc 123 struct nvm_dev *dev;
cd9e9808
MB
124 int ret = 0;
125
126 down_write(&nvm_lock);
762796bc 127 if (nvm_find_mgr_type(mt->name)) {
cd9e9808 128 ret = -EEXIST;
762796bc
MB
129 goto finish;
130 } else {
cd9e9808 131 list_add(&mt->list, &nvm_mgrs);
762796bc
MB
132 }
133
134 /* try to register media mgr if any device have none configured */
135 list_for_each_entry(dev, &nvm_devices, devices) {
136 if (dev->mt)
137 continue;
138
139 dev->mt = nvm_init_mgr(dev);
140 }
141finish:
cd9e9808
MB
142 up_write(&nvm_lock);
143
144 return ret;
145}
146EXPORT_SYMBOL(nvm_register_mgr);
147
148void nvm_unregister_mgr(struct nvmm_type *mt)
149{
150 if (!mt)
151 return;
152
153 down_write(&nvm_lock);
154 list_del(&mt->list);
155 up_write(&nvm_lock);
156}
157EXPORT_SYMBOL(nvm_unregister_mgr);
158
159static struct nvm_dev *nvm_find_nvm_dev(const char *name)
160{
161 struct nvm_dev *dev;
162
163 list_for_each_entry(dev, &nvm_devices, devices)
164 if (!strcmp(name, dev->name))
165 return dev;
166
167 return NULL;
168}
169
170struct nvm_block *nvm_get_blk(struct nvm_dev *dev, struct nvm_lun *lun,
171 unsigned long flags)
172{
173 return dev->mt->get_blk(dev, lun, flags);
174}
175EXPORT_SYMBOL(nvm_get_blk);
176
177/* Assumes that all valid pages have already been moved on release to bm */
178void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
179{
180 return dev->mt->put_blk(dev, blk);
181}
182EXPORT_SYMBOL(nvm_put_blk);
183
184int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
185{
186 return dev->mt->submit_io(dev, rqd);
187}
188EXPORT_SYMBOL(nvm_submit_io);
189
190int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk)
191{
192 return dev->mt->erase_blk(dev, blk, 0);
193}
194EXPORT_SYMBOL(nvm_erase_blk);
195
069368e9
MB
196void nvm_addr_to_generic_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
197{
198 int i;
199
200 if (rqd->nr_pages > 1) {
201 for (i = 0; i < rqd->nr_pages; i++)
202 rqd->ppa_list[i] = dev_to_generic_addr(dev,
203 rqd->ppa_list[i]);
204 } else {
205 rqd->ppa_addr = dev_to_generic_addr(dev, rqd->ppa_addr);
206 }
207}
208EXPORT_SYMBOL(nvm_addr_to_generic_mode);
209
210void nvm_generic_to_addr_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
211{
212 int i;
213
214 if (rqd->nr_pages > 1) {
215 for (i = 0; i < rqd->nr_pages; i++)
216 rqd->ppa_list[i] = generic_to_dev_addr(dev,
217 rqd->ppa_list[i]);
218 } else {
219 rqd->ppa_addr = generic_to_dev_addr(dev, rqd->ppa_addr);
220 }
221}
222EXPORT_SYMBOL(nvm_generic_to_addr_mode);
223
abd805ec
MB
224int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
225 struct ppa_addr *ppas, int nr_ppas)
069368e9 226{
abd805ec
MB
227 int i, plane_cnt, pl_idx;
228
229 if (dev->plane_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
230 rqd->nr_pages = 1;
231 rqd->ppa_addr = ppas[0];
069368e9 232
069368e9 233 return 0;
abd805ec 234 }
069368e9 235
abd805ec
MB
236 plane_cnt = (1 << dev->plane_mode);
237 rqd->nr_pages = plane_cnt * nr_ppas;
069368e9 238
abd805ec
MB
239 if (dev->ops->max_phys_sect < rqd->nr_pages)
240 return -EINVAL;
241
242 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
243 if (!rqd->ppa_list) {
244 pr_err("nvm: failed to allocate dma memory\n");
245 return -ENOMEM;
246 }
247
556755e9
MB
248 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
249 for (i = 0; i < nr_ppas; i++) {
abd805ec 250 ppas[i].g.pl = pl_idx;
556755e9 251 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppas[i];
069368e9
MB
252 }
253 }
254
abd805ec
MB
255 return 0;
256}
257EXPORT_SYMBOL(nvm_set_rqd_ppalist);
258
259void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
260{
261 if (!rqd->ppa_list)
262 return;
263
264 nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
265}
266EXPORT_SYMBOL(nvm_free_rqd_ppalist);
267
81e681d3 268int nvm_erase_ppa(struct nvm_dev *dev, struct ppa_addr *ppas, int nr_ppas)
abd805ec
MB
269{
270 struct nvm_rq rqd;
271 int ret;
272
273 if (!dev->ops->erase_block)
274 return 0;
275
276 memset(&rqd, 0, sizeof(struct nvm_rq));
277
81e681d3 278 ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas);
abd805ec
MB
279 if (ret)
280 return ret;
281
069368e9
MB
282 nvm_generic_to_addr_mode(dev, &rqd);
283
284 ret = dev->ops->erase_block(dev, &rqd);
285
abd805ec 286 nvm_free_rqd_ppalist(dev, &rqd);
069368e9
MB
287
288 return ret;
289}
290EXPORT_SYMBOL(nvm_erase_ppa);
291
91276162
MB
292void nvm_end_io(struct nvm_rq *rqd, int error)
293{
72d256ec
MB
294 rqd->error = error;
295 rqd->end_io(rqd);
91276162
MB
296}
297EXPORT_SYMBOL(nvm_end_io);
298
299static void nvm_end_io_sync(struct nvm_rq *rqd, int errors)
300{
301 struct completion *waiting = rqd->wait;
302
303 rqd->wait = NULL;
304
305 complete(waiting);
306}
307
cd9e9808
MB
308static int nvm_core_init(struct nvm_dev *dev)
309{
310 struct nvm_id *id = &dev->identity;
311 struct nvm_id_group *grp = &id->groups[0];
312
313 /* device values */
314 dev->nr_chnls = grp->num_ch;
315 dev->luns_per_chnl = grp->num_lun;
316 dev->pgs_per_blk = grp->num_pg;
317 dev->blks_per_lun = grp->num_blk;
318 dev->nr_planes = grp->num_pln;
319 dev->sec_size = grp->csecs;
320 dev->oob_size = grp->sos;
321 dev->sec_per_pg = grp->fpg_sz / grp->csecs;
7386af27 322 memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
cd9e9808
MB
323
324 dev->plane_mode = NVM_PLANE_SINGLE;
325 dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
326
4264c980
MB
327 if (grp->mtype != 0) {
328 pr_err("nvm: memory type not supported\n");
329 return -EINVAL;
330 }
331
332 if (grp->fmtype != 0 && grp->fmtype != 1) {
333 pr_err("nvm: flash type not supported\n");
334 return -EINVAL;
335 }
336
cd9e9808
MB
337 if (grp->mpos & 0x020202)
338 dev->plane_mode = NVM_PLANE_DOUBLE;
339 if (grp->mpos & 0x040404)
340 dev->plane_mode = NVM_PLANE_QUAD;
341
342 /* calculated values */
343 dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
344 dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
345 dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
346 dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
347
348 dev->total_blocks = dev->nr_planes *
349 dev->blks_per_lun *
350 dev->luns_per_chnl *
351 dev->nr_chnls;
352 dev->total_pages = dev->total_blocks * dev->pgs_per_blk;
353 INIT_LIST_HEAD(&dev->online_targets);
354
355 return 0;
356}
357
358static void nvm_free(struct nvm_dev *dev)
359{
360 if (!dev)
361 return;
362
363 if (dev->mt)
364 dev->mt->unregister_mgr(dev);
cd9e9808
MB
365}
366
367static int nvm_init(struct nvm_dev *dev)
368{
480fc0db 369 int ret = -EINVAL;
cd9e9808
MB
370
371 if (!dev->q || !dev->ops)
480fc0db 372 return ret;
cd9e9808 373
16f26c3a 374 if (dev->ops->identity(dev, &dev->identity)) {
cd9e9808 375 pr_err("nvm: device could not be identified\n");
cd9e9808
MB
376 goto err;
377 }
378
379 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
380 dev->identity.ver_id, dev->identity.vmnt,
381 dev->identity.cgrps);
382
383 if (dev->identity.ver_id != 1) {
384 pr_err("nvm: device not supported by kernel.");
385 goto err;
386 }
387
388 if (dev->identity.cgrps != 1) {
389 pr_err("nvm: only one group configuration supported.");
390 goto err;
391 }
392
393 ret = nvm_core_init(dev);
394 if (ret) {
395 pr_err("nvm: could not initialize core structures.\n");
396 goto err;
397 }
398
cd9e9808
MB
399 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
400 dev->name, dev->sec_per_pg, dev->nr_planes,
401 dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
402 dev->nr_chnls);
403 return 0;
404err:
cd9e9808
MB
405 pr_err("nvm: failed to initialize nvm\n");
406 return ret;
407}
408
409static void nvm_exit(struct nvm_dev *dev)
410{
411 if (dev->ppalist_pool)
412 dev->ops->destroy_dma_pool(dev->ppalist_pool);
413 nvm_free(dev);
414
415 pr_info("nvm: successfully unloaded\n");
416}
417
418int nvm_register(struct request_queue *q, char *disk_name,
419 struct nvm_dev_ops *ops)
420{
421 struct nvm_dev *dev;
422 int ret;
423
424 if (!ops->identity)
425 return -EINVAL;
426
427 dev = kzalloc(sizeof(struct nvm_dev), GFP_KERNEL);
428 if (!dev)
429 return -ENOMEM;
430
431 dev->q = q;
432 dev->ops = ops;
433 strncpy(dev->name, disk_name, DISK_NAME_LEN);
434
435 ret = nvm_init(dev);
436 if (ret)
437 goto err_init;
438
d160147b
WT
439 if (dev->ops->max_phys_sect > 256) {
440 pr_info("nvm: max sectors supported is 256.\n");
441 ret = -EINVAL;
442 goto err_init;
443 }
444
cd9e9808 445 if (dev->ops->max_phys_sect > 1) {
16f26c3a 446 dev->ppalist_pool = dev->ops->create_dma_pool(dev, "ppalist");
cd9e9808
MB
447 if (!dev->ppalist_pool) {
448 pr_err("nvm: could not create ppa pool\n");
93e70c1f
MB
449 ret = -ENOMEM;
450 goto err_init;
cd9e9808 451 }
cd9e9808
MB
452 }
453
762796bc 454 /* register device with a supported media manager */
edad2e66 455 down_write(&nvm_lock);
762796bc 456 dev->mt = nvm_init_mgr(dev);
edad2e66
MB
457 list_add(&dev->devices, &nvm_devices);
458 up_write(&nvm_lock);
459
cd9e9808
MB
460 return 0;
461err_init:
462 kfree(dev);
463 return ret;
464}
465EXPORT_SYMBOL(nvm_register);
466
467void nvm_unregister(char *disk_name)
468{
d0a712ce 469 struct nvm_dev *dev;
cd9e9808 470
d0a712ce
WT
471 down_write(&nvm_lock);
472 dev = nvm_find_nvm_dev(disk_name);
cd9e9808
MB
473 if (!dev) {
474 pr_err("nvm: could not find device %s to unregister\n",
475 disk_name);
d0a712ce 476 up_write(&nvm_lock);
cd9e9808
MB
477 return;
478 }
479
cd9e9808
MB
480 list_del(&dev->devices);
481 up_write(&nvm_lock);
c1480ad5
MB
482
483 nvm_exit(dev);
484 kfree(dev);
cd9e9808
MB
485}
486EXPORT_SYMBOL(nvm_unregister);
487
488static const struct block_device_operations nvm_fops = {
489 .owner = THIS_MODULE,
490};
491
492static int nvm_create_target(struct nvm_dev *dev,
493 struct nvm_ioctl_create *create)
494{
495 struct nvm_ioctl_create_simple *s = &create->conf.s;
496 struct request_queue *tqueue;
cd9e9808
MB
497 struct gendisk *tdisk;
498 struct nvm_tgt_type *tt;
499 struct nvm_target *t;
500 void *targetdata;
cd9e9808
MB
501
502 if (!dev->mt) {
762796bc
MB
503 pr_info("nvm: device has no media manager registered.\n");
504 return -ENODEV;
cd9e9808
MB
505 }
506
762796bc 507 down_write(&nvm_lock);
cd9e9808
MB
508 tt = nvm_find_target_type(create->tgttype);
509 if (!tt) {
510 pr_err("nvm: target type %s not found\n", create->tgttype);
d0a712ce 511 up_write(&nvm_lock);
cd9e9808
MB
512 return -EINVAL;
513 }
514
cd9e9808
MB
515 list_for_each_entry(t, &dev->online_targets, list) {
516 if (!strcmp(create->tgtname, t->disk->disk_name)) {
517 pr_err("nvm: target name already exists.\n");
518 up_write(&nvm_lock);
519 return -EINVAL;
520 }
521 }
522 up_write(&nvm_lock);
523
524 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
525 if (!t)
526 return -ENOMEM;
527
528 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
529 if (!tqueue)
530 goto err_t;
531 blk_queue_make_request(tqueue, tt->make_rq);
532
533 tdisk = alloc_disk(0);
534 if (!tdisk)
535 goto err_queue;
536
537 sprintf(tdisk->disk_name, "%s", create->tgtname);
538 tdisk->flags = GENHD_FL_EXT_DEVT;
539 tdisk->major = 0;
540 tdisk->first_minor = 0;
541 tdisk->fops = &nvm_fops;
542 tdisk->queue = tqueue;
543
544 targetdata = tt->init(dev, tdisk, s->lun_begin, s->lun_end);
545 if (IS_ERR(targetdata))
546 goto err_init;
547
548 tdisk->private_data = targetdata;
549 tqueue->queuedata = targetdata;
550
551 blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
552
553 set_capacity(tdisk, tt->capacity(targetdata));
554 add_disk(tdisk);
555
556 t->type = tt;
557 t->disk = tdisk;
558
559 down_write(&nvm_lock);
560 list_add_tail(&t->list, &dev->online_targets);
561 up_write(&nvm_lock);
562
563 return 0;
564err_init:
565 put_disk(tdisk);
566err_queue:
567 blk_cleanup_queue(tqueue);
568err_t:
569 kfree(t);
570 return -ENOMEM;
571}
572
573static void nvm_remove_target(struct nvm_target *t)
574{
575 struct nvm_tgt_type *tt = t->type;
576 struct gendisk *tdisk = t->disk;
577 struct request_queue *q = tdisk->queue;
578
579 lockdep_assert_held(&nvm_lock);
580
581 del_gendisk(tdisk);
d09f9581
JG
582 blk_cleanup_queue(q);
583
cd9e9808
MB
584 if (tt->exit)
585 tt->exit(tdisk->private_data);
586
cd9e9808
MB
587 put_disk(tdisk);
588
589 list_del(&t->list);
590 kfree(t);
591}
592
593static int __nvm_configure_create(struct nvm_ioctl_create *create)
594{
595 struct nvm_dev *dev;
596 struct nvm_ioctl_create_simple *s;
597
d0a712ce 598 down_write(&nvm_lock);
cd9e9808 599 dev = nvm_find_nvm_dev(create->dev);
d0a712ce 600 up_write(&nvm_lock);
cd9e9808
MB
601 if (!dev) {
602 pr_err("nvm: device not found\n");
603 return -EINVAL;
604 }
605
606 if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
607 pr_err("nvm: config type not valid\n");
608 return -EINVAL;
609 }
610 s = &create->conf.s;
611
612 if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
613 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
614 s->lun_begin, s->lun_end, dev->nr_luns);
615 return -EINVAL;
616 }
617
618 return nvm_create_target(dev, create);
619}
620
621static int __nvm_configure_remove(struct nvm_ioctl_remove *remove)
622{
623 struct nvm_target *t = NULL;
624 struct nvm_dev *dev;
625 int ret = -1;
626
627 down_write(&nvm_lock);
628 list_for_each_entry(dev, &nvm_devices, devices)
629 list_for_each_entry(t, &dev->online_targets, list) {
630 if (!strcmp(remove->tgtname, t->disk->disk_name)) {
631 nvm_remove_target(t);
632 ret = 0;
633 break;
634 }
635 }
636 up_write(&nvm_lock);
637
638 if (ret) {
639 pr_err("nvm: target \"%s\" doesn't exist.\n", remove->tgtname);
640 return -EINVAL;
641 }
642
643 return 0;
644}
645
646#ifdef CONFIG_NVM_DEBUG
647static int nvm_configure_show(const char *val)
648{
649 struct nvm_dev *dev;
650 char opcode, devname[DISK_NAME_LEN];
651 int ret;
652
653 ret = sscanf(val, "%c %32s", &opcode, devname);
654 if (ret != 2) {
655 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
656 return -EINVAL;
657 }
658
d0a712ce 659 down_write(&nvm_lock);
cd9e9808 660 dev = nvm_find_nvm_dev(devname);
d0a712ce 661 up_write(&nvm_lock);
cd9e9808
MB
662 if (!dev) {
663 pr_err("nvm: device not found\n");
664 return -EINVAL;
665 }
666
667 if (!dev->mt)
668 return 0;
669
2fde0e48 670 dev->mt->lun_info_print(dev);
cd9e9808
MB
671
672 return 0;
673}
674
675static int nvm_configure_remove(const char *val)
676{
677 struct nvm_ioctl_remove remove;
678 char opcode;
679 int ret;
680
681 ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
682 if (ret != 2) {
683 pr_err("nvm: invalid command. Use \"d targetname\".\n");
684 return -EINVAL;
685 }
686
687 remove.flags = 0;
688
689 return __nvm_configure_remove(&remove);
690}
691
692static int nvm_configure_create(const char *val)
693{
694 struct nvm_ioctl_create create;
695 char opcode;
696 int lun_begin, lun_end, ret;
697
698 ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
699 create.tgtname, create.tgttype,
700 &lun_begin, &lun_end);
701 if (ret != 6) {
702 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
703 return -EINVAL;
704 }
705
706 create.flags = 0;
707 create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
708 create.conf.s.lun_begin = lun_begin;
709 create.conf.s.lun_end = lun_end;
710
711 return __nvm_configure_create(&create);
712}
713
714
715/* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
716static int nvm_configure_by_str_event(const char *val,
717 const struct kernel_param *kp)
718{
719 char opcode;
720 int ret;
721
722 ret = sscanf(val, "%c", &opcode);
723 if (ret != 1) {
724 pr_err("nvm: string must have the format of \"cmd ...\"\n");
725 return -EINVAL;
726 }
727
728 switch (opcode) {
729 case 'a':
730 return nvm_configure_create(val);
731 case 'd':
732 return nvm_configure_remove(val);
733 case 's':
734 return nvm_configure_show(val);
735 default:
736 pr_err("nvm: invalid command\n");
737 return -EINVAL;
738 }
739
740 return 0;
741}
742
743static int nvm_configure_get(char *buf, const struct kernel_param *kp)
744{
745 int sz = 0;
746 char *buf_start = buf;
747 struct nvm_dev *dev;
748
749 buf += sprintf(buf, "available devices:\n");
750 down_write(&nvm_lock);
751 list_for_each_entry(dev, &nvm_devices, devices) {
752 if (sz > 4095 - DISK_NAME_LEN)
753 break;
754 buf += sprintf(buf, " %32s\n", dev->name);
755 }
756 up_write(&nvm_lock);
757
758 return buf - buf_start - 1;
759}
760
761static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
762 .set = nvm_configure_by_str_event,
763 .get = nvm_configure_get,
764};
765
766#undef MODULE_PARAM_PREFIX
767#define MODULE_PARAM_PREFIX "lnvm."
768
769module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
770 0644);
771
772#endif /* CONFIG_NVM_DEBUG */
773
774static long nvm_ioctl_info(struct file *file, void __user *arg)
775{
776 struct nvm_ioctl_info *info;
777 struct nvm_tgt_type *tt;
778 int tgt_iter = 0;
779
780 if (!capable(CAP_SYS_ADMIN))
781 return -EPERM;
782
783 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
784 if (IS_ERR(info))
785 return -EFAULT;
786
787 info->version[0] = NVM_VERSION_MAJOR;
788 info->version[1] = NVM_VERSION_MINOR;
789 info->version[2] = NVM_VERSION_PATCH;
790
791 down_write(&nvm_lock);
792 list_for_each_entry(tt, &nvm_targets, list) {
793 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
794
795 tgt->version[0] = tt->version[0];
796 tgt->version[1] = tt->version[1];
797 tgt->version[2] = tt->version[2];
798 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
799
800 tgt_iter++;
801 }
802
803 info->tgtsize = tgt_iter;
804 up_write(&nvm_lock);
805
76e25081
SM
806 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
807 kfree(info);
cd9e9808 808 return -EFAULT;
76e25081 809 }
cd9e9808
MB
810
811 kfree(info);
812 return 0;
813}
814
815static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
816{
817 struct nvm_ioctl_get_devices *devices;
818 struct nvm_dev *dev;
819 int i = 0;
820
821 if (!capable(CAP_SYS_ADMIN))
822 return -EPERM;
823
824 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
825 if (!devices)
826 return -ENOMEM;
827
828 down_write(&nvm_lock);
829 list_for_each_entry(dev, &nvm_devices, devices) {
830 struct nvm_ioctl_device_info *info = &devices->info[i];
831
832 sprintf(info->devname, "%s", dev->name);
833 if (dev->mt) {
834 info->bmversion[0] = dev->mt->version[0];
835 info->bmversion[1] = dev->mt->version[1];
836 info->bmversion[2] = dev->mt->version[2];
837 sprintf(info->bmname, "%s", dev->mt->name);
838 } else {
839 sprintf(info->bmname, "none");
840 }
841
842 i++;
843 if (i > 31) {
844 pr_err("nvm: max 31 devices can be reported.\n");
845 break;
846 }
847 }
848 up_write(&nvm_lock);
849
850 devices->nr_devices = i;
851
76e25081
SM
852 if (copy_to_user(arg, devices,
853 sizeof(struct nvm_ioctl_get_devices))) {
854 kfree(devices);
cd9e9808 855 return -EFAULT;
76e25081 856 }
cd9e9808
MB
857
858 kfree(devices);
859 return 0;
860}
861
862static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
863{
864 struct nvm_ioctl_create create;
865
866 if (!capable(CAP_SYS_ADMIN))
867 return -EPERM;
868
869 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
870 return -EFAULT;
871
872 create.dev[DISK_NAME_LEN - 1] = '\0';
873 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
874 create.tgtname[DISK_NAME_LEN - 1] = '\0';
875
876 if (create.flags != 0) {
877 pr_err("nvm: no flags supported\n");
878 return -EINVAL;
879 }
880
881 return __nvm_configure_create(&create);
882}
883
884static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
885{
886 struct nvm_ioctl_remove remove;
887
888 if (!capable(CAP_SYS_ADMIN))
889 return -EPERM;
890
891 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
892 return -EFAULT;
893
894 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
895
896 if (remove.flags != 0) {
897 pr_err("nvm: no flags supported\n");
898 return -EINVAL;
899 }
900
901 return __nvm_configure_remove(&remove);
902}
903
904static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
905{
906 void __user *argp = (void __user *)arg;
907
908 switch (cmd) {
909 case NVM_INFO:
910 return nvm_ioctl_info(file, argp);
911 case NVM_GET_DEVICES:
912 return nvm_ioctl_get_devices(file, argp);
913 case NVM_DEV_CREATE:
914 return nvm_ioctl_dev_create(file, argp);
915 case NVM_DEV_REMOVE:
916 return nvm_ioctl_dev_remove(file, argp);
917 }
918 return 0;
919}
920
921static const struct file_operations _ctl_fops = {
922 .open = nonseekable_open,
923 .unlocked_ioctl = nvm_ctl_ioctl,
924 .owner = THIS_MODULE,
925 .llseek = noop_llseek,
926};
927
928static struct miscdevice _nvm_misc = {
929 .minor = MISC_DYNAMIC_MINOR,
930 .name = "lightnvm",
931 .nodename = "lightnvm/control",
932 .fops = &_ctl_fops,
933};
934
935MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
936
937static int __init nvm_mod_init(void)
938{
939 int ret;
940
941 ret = misc_register(&_nvm_misc);
942 if (ret)
943 pr_err("nvm: misc_register failed for control device");
944
945 return ret;
946}
947
948static void __exit nvm_mod_exit(void)
949{
950 misc_deregister(&_nvm_misc);
951}
952
953MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
954MODULE_LICENSE("GPL v2");
955MODULE_VERSION("0.1");
956module_init(nvm_mod_init);
957module_exit(nvm_mod_exit);