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 memcpy(&dev
->ppaf
, &id
->ppaf
, sizeof(struct nvm_addr_format
));
179 dev
->plane_mode
= NVM_PLANE_SINGLE
;
180 dev
->max_rq_size
= dev
->ops
->max_phys_sect
* dev
->sec_size
;
182 if (grp
->mtype
!= 0) {
183 pr_err("nvm: memory type not supported\n");
187 if (grp
->fmtype
!= 0 && grp
->fmtype
!= 1) {
188 pr_err("nvm: flash type not supported\n");
192 if (grp
->mpos
& 0x020202)
193 dev
->plane_mode
= NVM_PLANE_DOUBLE
;
194 if (grp
->mpos
& 0x040404)
195 dev
->plane_mode
= NVM_PLANE_QUAD
;
197 /* calculated values */
198 dev
->sec_per_pl
= dev
->sec_per_pg
* dev
->nr_planes
;
199 dev
->sec_per_blk
= dev
->sec_per_pl
* dev
->pgs_per_blk
;
200 dev
->sec_per_lun
= dev
->sec_per_blk
* dev
->blks_per_lun
;
201 dev
->nr_luns
= dev
->luns_per_chnl
* dev
->nr_chnls
;
203 dev
->total_blocks
= dev
->nr_planes
*
207 dev
->total_pages
= dev
->total_blocks
* dev
->pgs_per_blk
;
208 INIT_LIST_HEAD(&dev
->online_targets
);
213 static void nvm_free(struct nvm_dev
*dev
)
219 dev
->mt
->unregister_mgr(dev
);
222 static int nvm_init(struct nvm_dev
*dev
)
224 struct nvmm_type
*mt
;
227 if (!dev
->q
|| !dev
->ops
)
230 if (dev
->ops
->identity(dev
->q
, &dev
->identity
)) {
231 pr_err("nvm: device could not be identified\n");
235 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
236 dev
->identity
.ver_id
, dev
->identity
.vmnt
,
237 dev
->identity
.cgrps
);
239 if (dev
->identity
.ver_id
!= 1) {
240 pr_err("nvm: device not supported by kernel.");
244 if (dev
->identity
.cgrps
!= 1) {
245 pr_err("nvm: only one group configuration supported.");
249 ret
= nvm_core_init(dev
);
251 pr_err("nvm: could not initialize core structures.\n");
255 /* register with device with a supported manager */
256 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
257 ret
= mt
->register_mgr(dev
);
259 goto err
; /* initialization failed */
262 break; /* successfully initialized */
267 pr_info("nvm: no compatible manager found.\n");
271 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
272 dev
->name
, dev
->sec_per_pg
, dev
->nr_planes
,
273 dev
->pgs_per_blk
, dev
->blks_per_lun
, dev
->nr_luns
,
277 pr_err("nvm: failed to initialize nvm\n");
281 static void nvm_exit(struct nvm_dev
*dev
)
283 if (dev
->ppalist_pool
)
284 dev
->ops
->destroy_dma_pool(dev
->ppalist_pool
);
287 pr_info("nvm: successfully unloaded\n");
290 int nvm_register(struct request_queue
*q
, char *disk_name
,
291 struct nvm_dev_ops
*ops
)
299 dev
= kzalloc(sizeof(struct nvm_dev
), GFP_KERNEL
);
305 strncpy(dev
->name
, disk_name
, DISK_NAME_LEN
);
311 if (dev
->ops
->max_phys_sect
> 1) {
312 dev
->ppalist_pool
= dev
->ops
->create_dma_pool(dev
->q
,
314 if (!dev
->ppalist_pool
) {
315 pr_err("nvm: could not create ppa pool\n");
319 } else if (dev
->ops
->max_phys_sect
> 256) {
320 pr_info("nvm: max sectors supported is 256.\n");
325 down_write(&nvm_lock
);
326 list_add(&dev
->devices
, &nvm_devices
);
334 EXPORT_SYMBOL(nvm_register
);
336 void nvm_unregister(char *disk_name
)
338 struct nvm_dev
*dev
= nvm_find_nvm_dev(disk_name
);
341 pr_err("nvm: could not find device %s to unregister\n",
346 down_write(&nvm_lock
);
347 list_del(&dev
->devices
);
353 EXPORT_SYMBOL(nvm_unregister
);
355 static const struct block_device_operations nvm_fops
= {
356 .owner
= THIS_MODULE
,
359 static int nvm_create_target(struct nvm_dev
*dev
,
360 struct nvm_ioctl_create
*create
)
362 struct nvm_ioctl_create_simple
*s
= &create
->conf
.s
;
363 struct request_queue
*tqueue
;
364 struct nvmm_type
*mt
;
365 struct gendisk
*tdisk
;
366 struct nvm_tgt_type
*tt
;
367 struct nvm_target
*t
;
372 /* register with device with a supported NVM manager */
373 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
374 ret
= mt
->register_mgr(dev
);
376 return ret
; /* initialization failed */
379 break; /* successfully initialized */
384 pr_info("nvm: no compatible nvm manager found.\n");
389 tt
= nvm_find_target_type(create
->tgttype
);
391 pr_err("nvm: target type %s not found\n", create
->tgttype
);
395 down_write(&nvm_lock
);
396 list_for_each_entry(t
, &dev
->online_targets
, list
) {
397 if (!strcmp(create
->tgtname
, t
->disk
->disk_name
)) {
398 pr_err("nvm: target name already exists.\n");
405 t
= kmalloc(sizeof(struct nvm_target
), GFP_KERNEL
);
409 tqueue
= blk_alloc_queue_node(GFP_KERNEL
, dev
->q
->node
);
412 blk_queue_make_request(tqueue
, tt
->make_rq
);
414 tdisk
= alloc_disk(0);
418 sprintf(tdisk
->disk_name
, "%s", create
->tgtname
);
419 tdisk
->flags
= GENHD_FL_EXT_DEVT
;
421 tdisk
->first_minor
= 0;
422 tdisk
->fops
= &nvm_fops
;
423 tdisk
->queue
= tqueue
;
425 targetdata
= tt
->init(dev
, tdisk
, s
->lun_begin
, s
->lun_end
);
426 if (IS_ERR(targetdata
))
429 tdisk
->private_data
= targetdata
;
430 tqueue
->queuedata
= targetdata
;
432 blk_queue_max_hw_sectors(tqueue
, 8 * dev
->ops
->max_phys_sect
);
434 set_capacity(tdisk
, tt
->capacity(targetdata
));
440 down_write(&nvm_lock
);
441 list_add_tail(&t
->list
, &dev
->online_targets
);
448 blk_cleanup_queue(tqueue
);
454 static void nvm_remove_target(struct nvm_target
*t
)
456 struct nvm_tgt_type
*tt
= t
->type
;
457 struct gendisk
*tdisk
= t
->disk
;
458 struct request_queue
*q
= tdisk
->queue
;
460 lockdep_assert_held(&nvm_lock
);
463 blk_cleanup_queue(q
);
466 tt
->exit(tdisk
->private_data
);
474 static int __nvm_configure_create(struct nvm_ioctl_create
*create
)
477 struct nvm_ioctl_create_simple
*s
;
479 dev
= nvm_find_nvm_dev(create
->dev
);
481 pr_err("nvm: device not found\n");
485 if (create
->conf
.type
!= NVM_CONFIG_TYPE_SIMPLE
) {
486 pr_err("nvm: config type not valid\n");
491 if (s
->lun_begin
> s
->lun_end
|| s
->lun_end
> dev
->nr_luns
) {
492 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
493 s
->lun_begin
, s
->lun_end
, dev
->nr_luns
);
497 return nvm_create_target(dev
, create
);
500 static int __nvm_configure_remove(struct nvm_ioctl_remove
*remove
)
502 struct nvm_target
*t
= NULL
;
506 down_write(&nvm_lock
);
507 list_for_each_entry(dev
, &nvm_devices
, devices
)
508 list_for_each_entry(t
, &dev
->online_targets
, list
) {
509 if (!strcmp(remove
->tgtname
, t
->disk
->disk_name
)) {
510 nvm_remove_target(t
);
518 pr_err("nvm: target \"%s\" doesn't exist.\n", remove
->tgtname
);
525 #ifdef CONFIG_NVM_DEBUG
526 static int nvm_configure_show(const char *val
)
529 char opcode
, devname
[DISK_NAME_LEN
];
532 ret
= sscanf(val
, "%c %32s", &opcode
, devname
);
534 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
538 dev
= nvm_find_nvm_dev(devname
);
540 pr_err("nvm: device not found\n");
547 dev
->mt
->free_blocks_print(dev
);
552 static int nvm_configure_remove(const char *val
)
554 struct nvm_ioctl_remove remove
;
558 ret
= sscanf(val
, "%c %256s", &opcode
, remove
.tgtname
);
560 pr_err("nvm: invalid command. Use \"d targetname\".\n");
566 return __nvm_configure_remove(&remove
);
569 static int nvm_configure_create(const char *val
)
571 struct nvm_ioctl_create create
;
573 int lun_begin
, lun_end
, ret
;
575 ret
= sscanf(val
, "%c %256s %256s %48s %u:%u", &opcode
, create
.dev
,
576 create
.tgtname
, create
.tgttype
,
577 &lun_begin
, &lun_end
);
579 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
584 create
.conf
.type
= NVM_CONFIG_TYPE_SIMPLE
;
585 create
.conf
.s
.lun_begin
= lun_begin
;
586 create
.conf
.s
.lun_end
= lun_end
;
588 return __nvm_configure_create(&create
);
592 /* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
593 static int nvm_configure_by_str_event(const char *val
,
594 const struct kernel_param
*kp
)
599 ret
= sscanf(val
, "%c", &opcode
);
601 pr_err("nvm: string must have the format of \"cmd ...\"\n");
607 return nvm_configure_create(val
);
609 return nvm_configure_remove(val
);
611 return nvm_configure_show(val
);
613 pr_err("nvm: invalid command\n");
620 static int nvm_configure_get(char *buf
, const struct kernel_param
*kp
)
623 char *buf_start
= buf
;
626 buf
+= sprintf(buf
, "available devices:\n");
627 down_write(&nvm_lock
);
628 list_for_each_entry(dev
, &nvm_devices
, devices
) {
629 if (sz
> 4095 - DISK_NAME_LEN
)
631 buf
+= sprintf(buf
, " %32s\n", dev
->name
);
635 return buf
- buf_start
- 1;
638 static const struct kernel_param_ops nvm_configure_by_str_event_param_ops
= {
639 .set
= nvm_configure_by_str_event
,
640 .get
= nvm_configure_get
,
643 #undef MODULE_PARAM_PREFIX
644 #define MODULE_PARAM_PREFIX "lnvm."
646 module_param_cb(configure_debug
, &nvm_configure_by_str_event_param_ops
, NULL
,
649 #endif /* CONFIG_NVM_DEBUG */
651 static long nvm_ioctl_info(struct file
*file
, void __user
*arg
)
653 struct nvm_ioctl_info
*info
;
654 struct nvm_tgt_type
*tt
;
657 if (!capable(CAP_SYS_ADMIN
))
660 info
= memdup_user(arg
, sizeof(struct nvm_ioctl_info
));
664 info
->version
[0] = NVM_VERSION_MAJOR
;
665 info
->version
[1] = NVM_VERSION_MINOR
;
666 info
->version
[2] = NVM_VERSION_PATCH
;
668 down_write(&nvm_lock
);
669 list_for_each_entry(tt
, &nvm_targets
, list
) {
670 struct nvm_ioctl_info_tgt
*tgt
= &info
->tgts
[tgt_iter
];
672 tgt
->version
[0] = tt
->version
[0];
673 tgt
->version
[1] = tt
->version
[1];
674 tgt
->version
[2] = tt
->version
[2];
675 strncpy(tgt
->tgtname
, tt
->name
, NVM_TTYPE_NAME_MAX
);
680 info
->tgtsize
= tgt_iter
;
683 if (copy_to_user(arg
, info
, sizeof(struct nvm_ioctl_info
)))
690 static long nvm_ioctl_get_devices(struct file
*file
, void __user
*arg
)
692 struct nvm_ioctl_get_devices
*devices
;
696 if (!capable(CAP_SYS_ADMIN
))
699 devices
= kzalloc(sizeof(struct nvm_ioctl_get_devices
), GFP_KERNEL
);
703 down_write(&nvm_lock
);
704 list_for_each_entry(dev
, &nvm_devices
, devices
) {
705 struct nvm_ioctl_device_info
*info
= &devices
->info
[i
];
707 sprintf(info
->devname
, "%s", dev
->name
);
709 info
->bmversion
[0] = dev
->mt
->version
[0];
710 info
->bmversion
[1] = dev
->mt
->version
[1];
711 info
->bmversion
[2] = dev
->mt
->version
[2];
712 sprintf(info
->bmname
, "%s", dev
->mt
->name
);
714 sprintf(info
->bmname
, "none");
719 pr_err("nvm: max 31 devices can be reported.\n");
725 devices
->nr_devices
= i
;
727 if (copy_to_user(arg
, devices
, sizeof(struct nvm_ioctl_get_devices
)))
734 static long nvm_ioctl_dev_create(struct file
*file
, void __user
*arg
)
736 struct nvm_ioctl_create create
;
738 if (!capable(CAP_SYS_ADMIN
))
741 if (copy_from_user(&create
, arg
, sizeof(struct nvm_ioctl_create
)))
744 create
.dev
[DISK_NAME_LEN
- 1] = '\0';
745 create
.tgttype
[NVM_TTYPE_NAME_MAX
- 1] = '\0';
746 create
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
748 if (create
.flags
!= 0) {
749 pr_err("nvm: no flags supported\n");
753 return __nvm_configure_create(&create
);
756 static long nvm_ioctl_dev_remove(struct file
*file
, void __user
*arg
)
758 struct nvm_ioctl_remove remove
;
760 if (!capable(CAP_SYS_ADMIN
))
763 if (copy_from_user(&remove
, arg
, sizeof(struct nvm_ioctl_remove
)))
766 remove
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
768 if (remove
.flags
!= 0) {
769 pr_err("nvm: no flags supported\n");
773 return __nvm_configure_remove(&remove
);
776 static long nvm_ctl_ioctl(struct file
*file
, uint cmd
, unsigned long arg
)
778 void __user
*argp
= (void __user
*)arg
;
782 return nvm_ioctl_info(file
, argp
);
783 case NVM_GET_DEVICES
:
784 return nvm_ioctl_get_devices(file
, argp
);
786 return nvm_ioctl_dev_create(file
, argp
);
788 return nvm_ioctl_dev_remove(file
, argp
);
793 static const struct file_operations _ctl_fops
= {
794 .open
= nonseekable_open
,
795 .unlocked_ioctl
= nvm_ctl_ioctl
,
796 .owner
= THIS_MODULE
,
797 .llseek
= noop_llseek
,
800 static struct miscdevice _nvm_misc
= {
801 .minor
= MISC_DYNAMIC_MINOR
,
803 .nodename
= "lightnvm/control",
807 MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR
);
809 static int __init
nvm_mod_init(void)
813 ret
= misc_register(&_nvm_misc
);
815 pr_err("nvm: misc_register failed for control device");
820 static void __exit
nvm_mod_exit(void)
822 misc_deregister(&_nvm_misc
);
825 MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
826 MODULE_LICENSE("GPL v2");
827 MODULE_VERSION("0.1");
828 module_init(nvm_mod_init
);
829 module_exit(nvm_mod_exit
);