2 * Copyright (C) 2015 IT University of Copenhagen. All rights reserved.
3 * Initial release: Matias Bjorling <m@bjorling.me>
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.
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.
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,
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>
30 #include <uapi/linux/lightnvm.h>
32 static LIST_HEAD(nvm_targets
);
33 static LIST_HEAD(nvm_mgrs
);
34 static LIST_HEAD(nvm_devices
);
35 static DECLARE_RWSEM(nvm_lock
);
37 static struct nvm_tgt_type
*nvm_find_target_type(const char *name
)
39 struct nvm_tgt_type
*tt
;
41 list_for_each_entry(tt
, &nvm_targets
, list
)
42 if (!strcmp(name
, tt
->name
))
48 int nvm_register_target(struct nvm_tgt_type
*tt
)
52 down_write(&nvm_lock
);
53 if (nvm_find_target_type(tt
->name
))
56 list_add(&tt
->list
, &nvm_targets
);
61 EXPORT_SYMBOL(nvm_register_target
);
63 void nvm_unregister_target(struct nvm_tgt_type
*tt
)
68 down_write(&nvm_lock
);
72 EXPORT_SYMBOL(nvm_unregister_target
);
74 void *nvm_dev_dma_alloc(struct nvm_dev
*dev
, gfp_t mem_flags
,
75 dma_addr_t
*dma_handler
)
77 return dev
->ops
->dev_dma_alloc(dev
->q
, dev
->ppalist_pool
, mem_flags
,
80 EXPORT_SYMBOL(nvm_dev_dma_alloc
);
82 void nvm_dev_dma_free(struct nvm_dev
*dev
, void *ppa_list
,
83 dma_addr_t dma_handler
)
85 dev
->ops
->dev_dma_free(dev
->ppalist_pool
, ppa_list
, dma_handler
);
87 EXPORT_SYMBOL(nvm_dev_dma_free
);
89 static struct nvmm_type
*nvm_find_mgr_type(const char *name
)
93 list_for_each_entry(mt
, &nvm_mgrs
, list
)
94 if (!strcmp(name
, mt
->name
))
100 int nvm_register_mgr(struct nvmm_type
*mt
)
104 down_write(&nvm_lock
);
105 if (nvm_find_mgr_type(mt
->name
))
108 list_add(&mt
->list
, &nvm_mgrs
);
113 EXPORT_SYMBOL(nvm_register_mgr
);
115 void nvm_unregister_mgr(struct nvmm_type
*mt
)
120 down_write(&nvm_lock
);
124 EXPORT_SYMBOL(nvm_unregister_mgr
);
126 static struct nvm_dev
*nvm_find_nvm_dev(const char *name
)
130 list_for_each_entry(dev
, &nvm_devices
, devices
)
131 if (!strcmp(name
, dev
->name
))
137 struct nvm_block
*nvm_get_blk(struct nvm_dev
*dev
, struct nvm_lun
*lun
,
140 return dev
->mt
->get_blk(dev
, lun
, flags
);
142 EXPORT_SYMBOL(nvm_get_blk
);
144 /* Assumes that all valid pages have already been moved on release to bm */
145 void nvm_put_blk(struct nvm_dev
*dev
, struct nvm_block
*blk
)
147 return dev
->mt
->put_blk(dev
, blk
);
149 EXPORT_SYMBOL(nvm_put_blk
);
151 int nvm_submit_io(struct nvm_dev
*dev
, struct nvm_rq
*rqd
)
153 return dev
->mt
->submit_io(dev
, rqd
);
155 EXPORT_SYMBOL(nvm_submit_io
);
157 int nvm_erase_blk(struct nvm_dev
*dev
, struct nvm_block
*blk
)
159 return dev
->mt
->erase_blk(dev
, blk
, 0);
161 EXPORT_SYMBOL(nvm_erase_blk
);
163 static int nvm_core_init(struct nvm_dev
*dev
)
165 struct nvm_id
*id
= &dev
->identity
;
166 struct nvm_id_group
*grp
= &id
->groups
[0];
169 dev
->nr_chnls
= grp
->num_ch
;
170 dev
->luns_per_chnl
= grp
->num_lun
;
171 dev
->pgs_per_blk
= grp
->num_pg
;
172 dev
->blks_per_lun
= grp
->num_blk
;
173 dev
->nr_planes
= grp
->num_pln
;
174 dev
->sec_size
= grp
->csecs
;
175 dev
->oob_size
= grp
->sos
;
176 dev
->sec_per_pg
= grp
->fpg_sz
/ grp
->csecs
;
177 dev
->addr_mode
= id
->ppat
;
178 dev
->addr_format
= id
->ppaf
;
180 dev
->plane_mode
= NVM_PLANE_SINGLE
;
181 dev
->max_rq_size
= dev
->ops
->max_phys_sect
* dev
->sec_size
;
183 if (grp
->mtype
!= 0) {
184 pr_err("nvm: memory type not supported\n");
188 if (grp
->fmtype
!= 0 && grp
->fmtype
!= 1) {
189 pr_err("nvm: flash type not supported\n");
193 if (grp
->mpos
& 0x020202)
194 dev
->plane_mode
= NVM_PLANE_DOUBLE
;
195 if (grp
->mpos
& 0x040404)
196 dev
->plane_mode
= NVM_PLANE_QUAD
;
198 /* calculated values */
199 dev
->sec_per_pl
= dev
->sec_per_pg
* dev
->nr_planes
;
200 dev
->sec_per_blk
= dev
->sec_per_pl
* dev
->pgs_per_blk
;
201 dev
->sec_per_lun
= dev
->sec_per_blk
* dev
->blks_per_lun
;
202 dev
->nr_luns
= dev
->luns_per_chnl
* dev
->nr_chnls
;
204 dev
->total_blocks
= dev
->nr_planes
*
208 dev
->total_pages
= dev
->total_blocks
* dev
->pgs_per_blk
;
209 INIT_LIST_HEAD(&dev
->online_targets
);
214 static void nvm_free(struct nvm_dev
*dev
)
220 dev
->mt
->unregister_mgr(dev
);
223 static int nvm_init(struct nvm_dev
*dev
)
225 struct nvmm_type
*mt
;
228 if (!dev
->q
|| !dev
->ops
)
231 if (dev
->ops
->identity(dev
->q
, &dev
->identity
)) {
232 pr_err("nvm: device could not be identified\n");
237 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
238 dev
->identity
.ver_id
, dev
->identity
.vmnt
,
239 dev
->identity
.cgrps
);
241 if (dev
->identity
.ver_id
!= 1) {
242 pr_err("nvm: device not supported by kernel.");
246 if (dev
->identity
.cgrps
!= 1) {
247 pr_err("nvm: only one group configuration supported.");
251 ret
= nvm_core_init(dev
);
253 pr_err("nvm: could not initialize core structures.\n");
257 /* register with device with a supported manager */
258 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
259 ret
= mt
->register_mgr(dev
);
261 goto err
; /* initialization failed */
264 break; /* successfully initialized */
269 pr_info("nvm: no compatible manager found.\n");
273 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
274 dev
->name
, dev
->sec_per_pg
, dev
->nr_planes
,
275 dev
->pgs_per_blk
, dev
->blks_per_lun
, dev
->nr_luns
,
280 pr_err("nvm: failed to initialize nvm\n");
284 static void nvm_exit(struct nvm_dev
*dev
)
286 if (dev
->ppalist_pool
)
287 dev
->ops
->destroy_dma_pool(dev
->ppalist_pool
);
290 pr_info("nvm: successfully unloaded\n");
293 int nvm_register(struct request_queue
*q
, char *disk_name
,
294 struct nvm_dev_ops
*ops
)
302 dev
= kzalloc(sizeof(struct nvm_dev
), GFP_KERNEL
);
308 strncpy(dev
->name
, disk_name
, DISK_NAME_LEN
);
314 if (dev
->ops
->max_phys_sect
> 1) {
315 dev
->ppalist_pool
= dev
->ops
->create_dma_pool(dev
->q
,
317 if (!dev
->ppalist_pool
) {
318 pr_err("nvm: could not create ppa pool\n");
321 } else if (dev
->ops
->max_phys_sect
> 256) {
322 pr_info("nvm: max sectors supported is 256.\n");
326 down_write(&nvm_lock
);
327 list_add(&dev
->devices
, &nvm_devices
);
335 EXPORT_SYMBOL(nvm_register
);
337 void nvm_unregister(char *disk_name
)
339 struct nvm_dev
*dev
= nvm_find_nvm_dev(disk_name
);
342 pr_err("nvm: could not find device %s to unregister\n",
347 down_write(&nvm_lock
);
348 list_del(&dev
->devices
);
354 EXPORT_SYMBOL(nvm_unregister
);
356 static const struct block_device_operations nvm_fops
= {
357 .owner
= THIS_MODULE
,
360 static int nvm_create_target(struct nvm_dev
*dev
,
361 struct nvm_ioctl_create
*create
)
363 struct nvm_ioctl_create_simple
*s
= &create
->conf
.s
;
364 struct request_queue
*tqueue
;
365 struct nvmm_type
*mt
;
366 struct gendisk
*tdisk
;
367 struct nvm_tgt_type
*tt
;
368 struct nvm_target
*t
;
373 /* register with device with a supported NVM manager */
374 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
375 ret
= mt
->register_mgr(dev
);
377 return ret
; /* initialization failed */
380 break; /* successfully initialized */
385 pr_info("nvm: no compatible nvm manager found.\n");
390 tt
= nvm_find_target_type(create
->tgttype
);
392 pr_err("nvm: target type %s not found\n", create
->tgttype
);
396 down_write(&nvm_lock
);
397 list_for_each_entry(t
, &dev
->online_targets
, list
) {
398 if (!strcmp(create
->tgtname
, t
->disk
->disk_name
)) {
399 pr_err("nvm: target name already exists.\n");
406 t
= kmalloc(sizeof(struct nvm_target
), GFP_KERNEL
);
410 tqueue
= blk_alloc_queue_node(GFP_KERNEL
, dev
->q
->node
);
413 blk_queue_make_request(tqueue
, tt
->make_rq
);
415 tdisk
= alloc_disk(0);
419 sprintf(tdisk
->disk_name
, "%s", create
->tgtname
);
420 tdisk
->flags
= GENHD_FL_EXT_DEVT
;
422 tdisk
->first_minor
= 0;
423 tdisk
->fops
= &nvm_fops
;
424 tdisk
->queue
= tqueue
;
426 targetdata
= tt
->init(dev
, tdisk
, s
->lun_begin
, s
->lun_end
);
427 if (IS_ERR(targetdata
))
430 tdisk
->private_data
= targetdata
;
431 tqueue
->queuedata
= targetdata
;
433 blk_queue_max_hw_sectors(tqueue
, 8 * dev
->ops
->max_phys_sect
);
435 set_capacity(tdisk
, tt
->capacity(targetdata
));
441 down_write(&nvm_lock
);
442 list_add_tail(&t
->list
, &dev
->online_targets
);
449 blk_cleanup_queue(tqueue
);
455 static void nvm_remove_target(struct nvm_target
*t
)
457 struct nvm_tgt_type
*tt
= t
->type
;
458 struct gendisk
*tdisk
= t
->disk
;
459 struct request_queue
*q
= tdisk
->queue
;
461 lockdep_assert_held(&nvm_lock
);
465 tt
->exit(tdisk
->private_data
);
467 blk_cleanup_queue(q
);
475 static int __nvm_configure_create(struct nvm_ioctl_create
*create
)
478 struct nvm_ioctl_create_simple
*s
;
480 dev
= nvm_find_nvm_dev(create
->dev
);
482 pr_err("nvm: device not found\n");
486 if (create
->conf
.type
!= NVM_CONFIG_TYPE_SIMPLE
) {
487 pr_err("nvm: config type not valid\n");
492 if (s
->lun_begin
> s
->lun_end
|| s
->lun_end
> dev
->nr_luns
) {
493 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
494 s
->lun_begin
, s
->lun_end
, dev
->nr_luns
);
498 return nvm_create_target(dev
, create
);
501 static int __nvm_configure_remove(struct nvm_ioctl_remove
*remove
)
503 struct nvm_target
*t
= NULL
;
507 down_write(&nvm_lock
);
508 list_for_each_entry(dev
, &nvm_devices
, devices
)
509 list_for_each_entry(t
, &dev
->online_targets
, list
) {
510 if (!strcmp(remove
->tgtname
, t
->disk
->disk_name
)) {
511 nvm_remove_target(t
);
519 pr_err("nvm: target \"%s\" doesn't exist.\n", remove
->tgtname
);
526 #ifdef CONFIG_NVM_DEBUG
527 static int nvm_configure_show(const char *val
)
530 char opcode
, devname
[DISK_NAME_LEN
];
533 ret
= sscanf(val
, "%c %32s", &opcode
, devname
);
535 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
539 dev
= nvm_find_nvm_dev(devname
);
541 pr_err("nvm: device not found\n");
548 dev
->mt
->free_blocks_print(dev
);
553 static int nvm_configure_remove(const char *val
)
555 struct nvm_ioctl_remove remove
;
559 ret
= sscanf(val
, "%c %256s", &opcode
, remove
.tgtname
);
561 pr_err("nvm: invalid command. Use \"d targetname\".\n");
567 return __nvm_configure_remove(&remove
);
570 static int nvm_configure_create(const char *val
)
572 struct nvm_ioctl_create create
;
574 int lun_begin
, lun_end
, ret
;
576 ret
= sscanf(val
, "%c %256s %256s %48s %u:%u", &opcode
, create
.dev
,
577 create
.tgtname
, create
.tgttype
,
578 &lun_begin
, &lun_end
);
580 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
585 create
.conf
.type
= NVM_CONFIG_TYPE_SIMPLE
;
586 create
.conf
.s
.lun_begin
= lun_begin
;
587 create
.conf
.s
.lun_end
= lun_end
;
589 return __nvm_configure_create(&create
);
593 /* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
594 static int nvm_configure_by_str_event(const char *val
,
595 const struct kernel_param
*kp
)
600 ret
= sscanf(val
, "%c", &opcode
);
602 pr_err("nvm: string must have the format of \"cmd ...\"\n");
608 return nvm_configure_create(val
);
610 return nvm_configure_remove(val
);
612 return nvm_configure_show(val
);
614 pr_err("nvm: invalid command\n");
621 static int nvm_configure_get(char *buf
, const struct kernel_param
*kp
)
624 char *buf_start
= buf
;
627 buf
+= sprintf(buf
, "available devices:\n");
628 down_write(&nvm_lock
);
629 list_for_each_entry(dev
, &nvm_devices
, devices
) {
630 if (sz
> 4095 - DISK_NAME_LEN
)
632 buf
+= sprintf(buf
, " %32s\n", dev
->name
);
636 return buf
- buf_start
- 1;
639 static const struct kernel_param_ops nvm_configure_by_str_event_param_ops
= {
640 .set
= nvm_configure_by_str_event
,
641 .get
= nvm_configure_get
,
644 #undef MODULE_PARAM_PREFIX
645 #define MODULE_PARAM_PREFIX "lnvm."
647 module_param_cb(configure_debug
, &nvm_configure_by_str_event_param_ops
, NULL
,
650 #endif /* CONFIG_NVM_DEBUG */
652 static long nvm_ioctl_info(struct file
*file
, void __user
*arg
)
654 struct nvm_ioctl_info
*info
;
655 struct nvm_tgt_type
*tt
;
658 if (!capable(CAP_SYS_ADMIN
))
661 info
= memdup_user(arg
, sizeof(struct nvm_ioctl_info
));
665 info
->version
[0] = NVM_VERSION_MAJOR
;
666 info
->version
[1] = NVM_VERSION_MINOR
;
667 info
->version
[2] = NVM_VERSION_PATCH
;
669 down_write(&nvm_lock
);
670 list_for_each_entry(tt
, &nvm_targets
, list
) {
671 struct nvm_ioctl_info_tgt
*tgt
= &info
->tgts
[tgt_iter
];
673 tgt
->version
[0] = tt
->version
[0];
674 tgt
->version
[1] = tt
->version
[1];
675 tgt
->version
[2] = tt
->version
[2];
676 strncpy(tgt
->tgtname
, tt
->name
, NVM_TTYPE_NAME_MAX
);
681 info
->tgtsize
= tgt_iter
;
684 if (copy_to_user(arg
, info
, sizeof(struct nvm_ioctl_info
)))
691 static long nvm_ioctl_get_devices(struct file
*file
, void __user
*arg
)
693 struct nvm_ioctl_get_devices
*devices
;
697 if (!capable(CAP_SYS_ADMIN
))
700 devices
= kzalloc(sizeof(struct nvm_ioctl_get_devices
), GFP_KERNEL
);
704 down_write(&nvm_lock
);
705 list_for_each_entry(dev
, &nvm_devices
, devices
) {
706 struct nvm_ioctl_device_info
*info
= &devices
->info
[i
];
708 sprintf(info
->devname
, "%s", dev
->name
);
710 info
->bmversion
[0] = dev
->mt
->version
[0];
711 info
->bmversion
[1] = dev
->mt
->version
[1];
712 info
->bmversion
[2] = dev
->mt
->version
[2];
713 sprintf(info
->bmname
, "%s", dev
->mt
->name
);
715 sprintf(info
->bmname
, "none");
720 pr_err("nvm: max 31 devices can be reported.\n");
726 devices
->nr_devices
= i
;
728 if (copy_to_user(arg
, devices
, sizeof(struct nvm_ioctl_get_devices
)))
735 static long nvm_ioctl_dev_create(struct file
*file
, void __user
*arg
)
737 struct nvm_ioctl_create create
;
739 if (!capable(CAP_SYS_ADMIN
))
742 if (copy_from_user(&create
, arg
, sizeof(struct nvm_ioctl_create
)))
745 create
.dev
[DISK_NAME_LEN
- 1] = '\0';
746 create
.tgttype
[NVM_TTYPE_NAME_MAX
- 1] = '\0';
747 create
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
749 if (create
.flags
!= 0) {
750 pr_err("nvm: no flags supported\n");
754 return __nvm_configure_create(&create
);
757 static long nvm_ioctl_dev_remove(struct file
*file
, void __user
*arg
)
759 struct nvm_ioctl_remove remove
;
761 if (!capable(CAP_SYS_ADMIN
))
764 if (copy_from_user(&remove
, arg
, sizeof(struct nvm_ioctl_remove
)))
767 remove
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
769 if (remove
.flags
!= 0) {
770 pr_err("nvm: no flags supported\n");
774 return __nvm_configure_remove(&remove
);
777 static long nvm_ctl_ioctl(struct file
*file
, uint cmd
, unsigned long arg
)
779 void __user
*argp
= (void __user
*)arg
;
783 return nvm_ioctl_info(file
, argp
);
784 case NVM_GET_DEVICES
:
785 return nvm_ioctl_get_devices(file
, argp
);
787 return nvm_ioctl_dev_create(file
, argp
);
789 return nvm_ioctl_dev_remove(file
, argp
);
794 static const struct file_operations _ctl_fops
= {
795 .open
= nonseekable_open
,
796 .unlocked_ioctl
= nvm_ctl_ioctl
,
797 .owner
= THIS_MODULE
,
798 .llseek
= noop_llseek
,
801 static struct miscdevice _nvm_misc
= {
802 .minor
= MISC_DYNAMIC_MINOR
,
804 .nodename
= "lightnvm/control",
808 MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR
);
810 static int __init
nvm_mod_init(void)
814 ret
= misc_register(&_nvm_misc
);
816 pr_err("nvm: misc_register failed for control device");
821 static void __exit
nvm_mod_exit(void)
823 misc_deregister(&_nvm_misc
);
826 MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
827 MODULE_LICENSE("GPL v2");
828 MODULE_VERSION("0.1");
829 module_init(nvm_mod_init
);
830 module_exit(nvm_mod_exit
);