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/list.h>
22 #include <linux/types.h>
23 #include <linux/sem.h>
24 #include <linux/bitmap.h>
25 #include <linux/moduleparam.h>
26 #include <linux/miscdevice.h>
27 #include <linux/lightnvm.h>
28 #include <linux/sched/sysctl.h>
30 static LIST_HEAD(nvm_tgt_types);
31 static DECLARE_RWSEM(nvm_tgtt_lock);
32 static LIST_HEAD(nvm_devices);
33 static DECLARE_RWSEM(nvm_lock);
35 /* Map between virtual and physical channel and lun */
43 struct nvm_ch_map *chnls;
48 struct list_head list;
50 sector_t end; /* end is excluded */
53 static struct nvm_target *nvm_find_target(struct nvm_dev *dev, const char *name)
55 struct nvm_target *tgt;
57 list_for_each_entry(tgt, &dev->targets, list)
58 if (!strcmp(name, tgt->disk->disk_name))
64 static int nvm_reserve_luns(struct nvm_dev *dev, int lun_begin, int lun_end)
68 for (i = lun_begin; i <= lun_end; i++) {
69 if (test_and_set_bit(i, dev->lun_map)) {
70 pr_err("nvm: lun %d already allocated\n", i);
77 while (--i >= lun_begin)
78 clear_bit(i, dev->lun_map);
83 static void nvm_release_luns_err(struct nvm_dev *dev, int lun_begin,
88 for (i = lun_begin; i <= lun_end; i++)
89 WARN_ON(!test_and_clear_bit(i, dev->lun_map));
92 static void nvm_remove_tgt_dev(struct nvm_tgt_dev *tgt_dev, int clear)
94 struct nvm_dev *dev = tgt_dev->parent;
95 struct nvm_dev_map *dev_map = tgt_dev->map;
98 for (i = 0; i < dev_map->nr_chnls; i++) {
99 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
100 int *lun_offs = ch_map->lun_offs;
101 int ch = i + ch_map->ch_off;
104 for (j = 0; j < ch_map->nr_luns; j++) {
105 int lun = j + lun_offs[j];
106 int lunid = (ch * dev->geo.luns_per_chnl) + lun;
108 WARN_ON(!test_and_clear_bit(lunid,
113 kfree(ch_map->lun_offs);
116 kfree(dev_map->chnls);
119 kfree(tgt_dev->luns);
123 static struct nvm_tgt_dev *nvm_create_tgt_dev(struct nvm_dev *dev,
124 int lun_begin, int lun_end)
126 struct nvm_tgt_dev *tgt_dev = NULL;
127 struct nvm_dev_map *dev_rmap = dev->rmap;
128 struct nvm_dev_map *dev_map;
129 struct ppa_addr *luns;
130 int nr_luns = lun_end - lun_begin + 1;
131 int luns_left = nr_luns;
132 int nr_chnls = nr_luns / dev->geo.luns_per_chnl;
133 int nr_chnls_mod = nr_luns % dev->geo.luns_per_chnl;
134 int bch = lun_begin / dev->geo.luns_per_chnl;
135 int blun = lun_begin % dev->geo.luns_per_chnl;
137 int lun_balanced = 1;
141 nr_chnls = nr_luns / dev->geo.luns_per_chnl;
142 nr_chnls = (nr_chnls_mod == 0) ? nr_chnls : nr_chnls + 1;
144 dev_map = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
148 dev_map->chnls = kcalloc(nr_chnls, sizeof(struct nvm_ch_map),
153 luns = kcalloc(nr_luns, sizeof(struct ppa_addr), GFP_KERNEL);
157 prev_nr_luns = (luns_left > dev->geo.luns_per_chnl) ?
158 dev->geo.luns_per_chnl : luns_left;
159 for (i = 0; i < nr_chnls; i++) {
160 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[i + bch];
161 int *lun_roffs = ch_rmap->lun_offs;
162 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
164 int luns_in_chnl = (luns_left > dev->geo.luns_per_chnl) ?
165 dev->geo.luns_per_chnl : luns_left;
167 if (lun_balanced && prev_nr_luns != luns_in_chnl)
170 ch_map->ch_off = ch_rmap->ch_off = bch;
171 ch_map->nr_luns = luns_in_chnl;
173 lun_offs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
177 for (j = 0; j < luns_in_chnl; j++) {
179 luns[lunid].g.ch = i;
180 luns[lunid++].g.lun = j;
183 lun_roffs[j + blun] = blun;
186 ch_map->lun_offs = lun_offs;
188 /* when starting a new channel, lun offset is reset */
190 luns_left -= luns_in_chnl;
193 dev_map->nr_chnls = nr_chnls;
195 tgt_dev = kmalloc(sizeof(struct nvm_tgt_dev), GFP_KERNEL);
199 memcpy(&tgt_dev->geo, &dev->geo, sizeof(struct nvm_geo));
200 /* Target device only owns a portion of the physical device */
201 tgt_dev->geo.nr_chnls = nr_chnls;
202 tgt_dev->geo.nr_luns = nr_luns;
203 tgt_dev->geo.luns_per_chnl = (lun_balanced) ? prev_nr_luns : -1;
204 tgt_dev->total_secs = nr_luns * tgt_dev->geo.sec_per_lun;
206 tgt_dev->map = dev_map;
207 tgt_dev->luns = luns;
208 memcpy(&tgt_dev->identity, &dev->identity, sizeof(struct nvm_id));
210 tgt_dev->parent = dev;
215 kfree(dev_map->chnls[i].lun_offs);
218 kfree(dev_map->chnls);
225 static const struct block_device_operations nvm_fops = {
226 .owner = THIS_MODULE,
229 static int nvm_create_tgt(struct nvm_dev *dev, struct nvm_ioctl_create *create)
231 struct nvm_ioctl_create_simple *s = &create->conf.s;
232 struct request_queue *tqueue;
233 struct gendisk *tdisk;
234 struct nvm_tgt_type *tt;
235 struct nvm_target *t;
236 struct nvm_tgt_dev *tgt_dev;
240 tt = nvm_find_target_type(create->tgttype, 1);
242 pr_err("nvm: target type %s not found\n", create->tgttype);
246 mutex_lock(&dev->mlock);
247 t = nvm_find_target(dev, create->tgtname);
249 pr_err("nvm: target name already exists.\n");
250 mutex_unlock(&dev->mlock);
253 mutex_unlock(&dev->mlock);
255 if (nvm_reserve_luns(dev, s->lun_begin, s->lun_end))
258 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
264 tgt_dev = nvm_create_tgt_dev(dev, s->lun_begin, s->lun_end);
266 pr_err("nvm: could not create target device\n");
271 tdisk = alloc_disk(0);
277 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
282 blk_queue_make_request(tqueue, tt->make_rq);
284 strlcpy(tdisk->disk_name, create->tgtname, sizeof(tdisk->disk_name));
285 tdisk->flags = GENHD_FL_EXT_DEVT;
287 tdisk->first_minor = 0;
288 tdisk->fops = &nvm_fops;
289 tdisk->queue = tqueue;
291 targetdata = tt->init(tgt_dev, tdisk, create->flags);
292 if (IS_ERR(targetdata)) {
293 ret = PTR_ERR(targetdata);
297 tdisk->private_data = targetdata;
298 tqueue->queuedata = targetdata;
300 blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
302 set_capacity(tdisk, tt->capacity(targetdata));
305 if (tt->sysfs_init && tt->sysfs_init(tdisk)) {
314 mutex_lock(&dev->mlock);
315 list_add_tail(&t->list, &dev->targets);
316 mutex_unlock(&dev->mlock);
321 tt->exit(targetdata);
323 blk_cleanup_queue(tqueue);
328 nvm_remove_tgt_dev(tgt_dev, 0);
332 nvm_release_luns_err(dev, s->lun_begin, s->lun_end);
336 static void __nvm_remove_target(struct nvm_target *t)
338 struct nvm_tgt_type *tt = t->type;
339 struct gendisk *tdisk = t->disk;
340 struct request_queue *q = tdisk->queue;
343 blk_cleanup_queue(q);
346 tt->sysfs_exit(tdisk);
349 tt->exit(tdisk->private_data);
351 nvm_remove_tgt_dev(t->dev, 1);
359 * nvm_remove_tgt - Removes a target from the media manager
361 * @remove: ioctl structure with target name to remove.
368 static int nvm_remove_tgt(struct nvm_dev *dev, struct nvm_ioctl_remove *remove)
370 struct nvm_target *t;
372 mutex_lock(&dev->mlock);
373 t = nvm_find_target(dev, remove->tgtname);
375 mutex_unlock(&dev->mlock);
378 __nvm_remove_target(t);
379 mutex_unlock(&dev->mlock);
384 static int nvm_register_map(struct nvm_dev *dev)
386 struct nvm_dev_map *rmap;
389 rmap = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
393 rmap->chnls = kcalloc(dev->geo.nr_chnls, sizeof(struct nvm_ch_map),
398 for (i = 0; i < dev->geo.nr_chnls; i++) {
399 struct nvm_ch_map *ch_rmap;
401 int luns_in_chnl = dev->geo.luns_per_chnl;
403 ch_rmap = &rmap->chnls[i];
405 ch_rmap->ch_off = -1;
406 ch_rmap->nr_luns = luns_in_chnl;
408 lun_roffs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
412 for (j = 0; j < luns_in_chnl; j++)
415 ch_rmap->lun_offs = lun_roffs;
423 kfree(rmap->chnls[i].lun_offs);
430 static void nvm_unregister_map(struct nvm_dev *dev)
432 struct nvm_dev_map *rmap = dev->rmap;
435 for (i = 0; i < dev->geo.nr_chnls; i++)
436 kfree(rmap->chnls[i].lun_offs);
442 static void nvm_map_to_dev(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
444 struct nvm_dev_map *dev_map = tgt_dev->map;
445 struct nvm_ch_map *ch_map = &dev_map->chnls[p->g.ch];
446 int lun_off = ch_map->lun_offs[p->g.lun];
448 p->g.ch += ch_map->ch_off;
452 static void nvm_map_to_tgt(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
454 struct nvm_dev *dev = tgt_dev->parent;
455 struct nvm_dev_map *dev_rmap = dev->rmap;
456 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[p->g.ch];
457 int lun_roff = ch_rmap->lun_offs[p->g.lun];
459 p->g.ch -= ch_rmap->ch_off;
460 p->g.lun -= lun_roff;
463 static void nvm_ppa_tgt_to_dev(struct nvm_tgt_dev *tgt_dev,
464 struct ppa_addr *ppa_list, int nr_ppas)
468 for (i = 0; i < nr_ppas; i++) {
469 nvm_map_to_dev(tgt_dev, &ppa_list[i]);
470 ppa_list[i] = generic_to_dev_addr(tgt_dev, ppa_list[i]);
474 static void nvm_ppa_dev_to_tgt(struct nvm_tgt_dev *tgt_dev,
475 struct ppa_addr *ppa_list, int nr_ppas)
479 for (i = 0; i < nr_ppas; i++) {
480 ppa_list[i] = dev_to_generic_addr(tgt_dev, ppa_list[i]);
481 nvm_map_to_tgt(tgt_dev, &ppa_list[i]);
485 static void nvm_rq_tgt_to_dev(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
487 if (rqd->nr_ppas == 1) {
488 nvm_ppa_tgt_to_dev(tgt_dev, &rqd->ppa_addr, 1);
492 nvm_ppa_tgt_to_dev(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
495 static void nvm_rq_dev_to_tgt(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
497 if (rqd->nr_ppas == 1) {
498 nvm_ppa_dev_to_tgt(tgt_dev, &rqd->ppa_addr, 1);
502 nvm_ppa_dev_to_tgt(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
505 void nvm_part_to_tgt(struct nvm_dev *dev, sector_t *entries,
508 struct nvm_geo *geo = &dev->geo;
509 struct nvm_dev_map *dev_rmap = dev->rmap;
512 for (i = 0; i < len; i++) {
513 struct nvm_ch_map *ch_rmap;
515 struct ppa_addr gaddr;
516 u64 pba = le64_to_cpu(entries[i]);
522 gaddr = linear_to_generic_addr(geo, pba);
523 ch_rmap = &dev_rmap->chnls[gaddr.g.ch];
524 lun_roffs = ch_rmap->lun_offs;
526 diff = ((ch_rmap->ch_off * geo->luns_per_chnl) +
527 (lun_roffs[gaddr.g.lun])) * geo->sec_per_lun;
529 entries[i] -= cpu_to_le64(diff);
532 EXPORT_SYMBOL(nvm_part_to_tgt);
534 struct nvm_tgt_type *nvm_find_target_type(const char *name, int lock)
536 struct nvm_tgt_type *tmp, *tt = NULL;
539 down_write(&nvm_tgtt_lock);
541 list_for_each_entry(tmp, &nvm_tgt_types, list)
542 if (!strcmp(name, tmp->name)) {
548 up_write(&nvm_tgtt_lock);
551 EXPORT_SYMBOL(nvm_find_target_type);
553 int nvm_register_tgt_type(struct nvm_tgt_type *tt)
557 down_write(&nvm_tgtt_lock);
558 if (nvm_find_target_type(tt->name, 0))
561 list_add(&tt->list, &nvm_tgt_types);
562 up_write(&nvm_tgtt_lock);
566 EXPORT_SYMBOL(nvm_register_tgt_type);
568 void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
573 down_write(&nvm_lock);
577 EXPORT_SYMBOL(nvm_unregister_tgt_type);
579 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
580 dma_addr_t *dma_handler)
582 return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
585 EXPORT_SYMBOL(nvm_dev_dma_alloc);
587 void nvm_dev_dma_free(struct nvm_dev *dev, void *addr, dma_addr_t dma_handler)
589 dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
591 EXPORT_SYMBOL(nvm_dev_dma_free);
593 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
597 list_for_each_entry(dev, &nvm_devices, devices)
598 if (!strcmp(name, dev->name))
604 int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
605 int nr_ppas, int type)
607 struct nvm_dev *dev = tgt_dev->parent;
611 if (nr_ppas > dev->ops->max_phys_sect) {
612 pr_err("nvm: unable to update all blocks atomically\n");
616 memset(&rqd, 0, sizeof(struct nvm_rq));
618 nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas, 1);
619 nvm_rq_tgt_to_dev(tgt_dev, &rqd);
621 ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
622 nvm_free_rqd_ppalist(tgt_dev, &rqd);
624 pr_err("nvm: failed bb mark\n");
630 EXPORT_SYMBOL(nvm_set_tgt_bb_tbl);
632 int nvm_max_phys_sects(struct nvm_tgt_dev *tgt_dev)
634 struct nvm_dev *dev = tgt_dev->parent;
636 return dev->ops->max_phys_sect;
638 EXPORT_SYMBOL(nvm_max_phys_sects);
640 int nvm_submit_io(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
642 struct nvm_dev *dev = tgt_dev->parent;
644 if (!dev->ops->submit_io)
647 nvm_rq_tgt_to_dev(tgt_dev, rqd);
650 return dev->ops->submit_io(dev, rqd);
652 EXPORT_SYMBOL(nvm_submit_io);
654 static void nvm_end_io_sync(struct nvm_rq *rqd)
656 struct completion *waiting = rqd->private;
661 int nvm_erase_sync(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
664 struct nvm_geo *geo = &tgt_dev->geo;
667 DECLARE_COMPLETION_ONSTACK(wait);
669 memset(&rqd, 0, sizeof(struct nvm_rq));
671 rqd.opcode = NVM_OP_ERASE;
672 rqd.end_io = nvm_end_io_sync;
674 rqd.flags = geo->plane_mode >> 1;
676 ret = nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas, 1);
680 ret = nvm_submit_io(tgt_dev, &rqd);
682 pr_err("rrpr: erase I/O submission failed: %d\n", ret);
685 wait_for_completion_io(&wait);
688 nvm_free_rqd_ppalist(tgt_dev, &rqd);
692 EXPORT_SYMBOL(nvm_erase_sync);
694 int nvm_get_l2p_tbl(struct nvm_tgt_dev *tgt_dev, u64 slba, u32 nlb,
695 nvm_l2p_update_fn *update_l2p, void *priv)
697 struct nvm_dev *dev = tgt_dev->parent;
699 if (!dev->ops->get_l2p_tbl)
702 return dev->ops->get_l2p_tbl(dev, slba, nlb, update_l2p, priv);
704 EXPORT_SYMBOL(nvm_get_l2p_tbl);
706 int nvm_get_area(struct nvm_tgt_dev *tgt_dev, sector_t *lba, sector_t len)
708 struct nvm_dev *dev = tgt_dev->parent;
709 struct nvm_geo *geo = &dev->geo;
710 struct nvm_area *area, *prev, *next;
712 sector_t max_sectors = (geo->sec_size * dev->total_secs) >> 9;
714 if (len > max_sectors)
717 area = kmalloc(sizeof(struct nvm_area), GFP_KERNEL);
723 spin_lock(&dev->lock);
724 list_for_each_entry(next, &dev->area_list, list) {
725 if (begin + len > next->begin) {
733 if ((begin + len) > max_sectors) {
734 spin_unlock(&dev->lock);
739 area->begin = *lba = begin;
740 area->end = begin + len;
742 if (prev) /* insert into sorted order */
743 list_add(&area->list, &prev->list);
745 list_add(&area->list, &dev->area_list);
746 spin_unlock(&dev->lock);
750 EXPORT_SYMBOL(nvm_get_area);
752 void nvm_put_area(struct nvm_tgt_dev *tgt_dev, sector_t begin)
754 struct nvm_dev *dev = tgt_dev->parent;
755 struct nvm_area *area;
757 spin_lock(&dev->lock);
758 list_for_each_entry(area, &dev->area_list, list) {
759 if (area->begin != begin)
762 list_del(&area->list);
763 spin_unlock(&dev->lock);
767 spin_unlock(&dev->lock);
769 EXPORT_SYMBOL(nvm_put_area);
771 int nvm_set_rqd_ppalist(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd,
772 const struct ppa_addr *ppas, int nr_ppas, int vblk)
774 struct nvm_dev *dev = tgt_dev->parent;
775 struct nvm_geo *geo = &tgt_dev->geo;
776 int i, plane_cnt, pl_idx;
779 if ((!vblk || geo->plane_mode == NVM_PLANE_SINGLE) && nr_ppas == 1) {
780 rqd->nr_ppas = nr_ppas;
781 rqd->ppa_addr = ppas[0];
786 rqd->nr_ppas = nr_ppas;
787 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
788 if (!rqd->ppa_list) {
789 pr_err("nvm: failed to allocate dma memory\n");
794 for (i = 0; i < nr_ppas; i++)
795 rqd->ppa_list[i] = ppas[i];
797 plane_cnt = geo->plane_mode;
798 rqd->nr_ppas *= plane_cnt;
800 for (i = 0; i < nr_ppas; i++) {
801 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
804 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
811 EXPORT_SYMBOL(nvm_set_rqd_ppalist);
813 void nvm_free_rqd_ppalist(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
818 nvm_dev_dma_free(tgt_dev->parent, rqd->ppa_list, rqd->dma_ppa_list);
820 EXPORT_SYMBOL(nvm_free_rqd_ppalist);
822 void nvm_end_io(struct nvm_rq *rqd)
824 struct nvm_tgt_dev *tgt_dev = rqd->dev;
826 /* Convert address space */
828 nvm_rq_dev_to_tgt(tgt_dev, rqd);
833 EXPORT_SYMBOL(nvm_end_io);
836 * folds a bad block list from its plane representation to its virtual
837 * block representation. The fold is done in place and reduced size is
840 * If any of the planes status are bad or grown bad block, the virtual block
841 * is marked bad. If not bad, the first plane state acts as the block state.
843 int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
845 struct nvm_geo *geo = &dev->geo;
846 int blk, offset, pl, blktype;
848 if (nr_blks != geo->blks_per_lun * geo->plane_mode)
851 for (blk = 0; blk < geo->blks_per_lun; blk++) {
852 offset = blk * geo->plane_mode;
853 blktype = blks[offset];
855 /* Bad blocks on any planes take precedence over other types */
856 for (pl = 0; pl < geo->plane_mode; pl++) {
857 if (blks[offset + pl] &
858 (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
859 blktype = blks[offset + pl];
867 return geo->blks_per_lun;
869 EXPORT_SYMBOL(nvm_bb_tbl_fold);
871 int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
874 struct nvm_dev *dev = tgt_dev->parent;
876 nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
878 return dev->ops->get_bb_tbl(dev, ppa, blks);
880 EXPORT_SYMBOL(nvm_get_tgt_bb_tbl);
882 static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
884 struct nvm_geo *geo = &dev->geo;
887 dev->lps_per_blk = geo->pgs_per_blk;
888 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
892 /* Just a linear array */
893 for (i = 0; i < dev->lps_per_blk; i++)
899 static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
902 struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
907 dev->lps_per_blk = mlc->num_pairs;
908 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
912 /* The lower page table encoding consists of a list of bytes, where each
913 * has a lower and an upper half. The first half byte maintains the
914 * increment value and every value after is an offset added to the
915 * previous incrementation value
917 dev->lptbl[0] = mlc->pairs[0] & 0xF;
918 for (i = 1; i < dev->lps_per_blk; i++) {
919 p = mlc->pairs[i >> 1];
920 if (i & 0x1) /* upper */
921 dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
923 dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
929 static int nvm_core_init(struct nvm_dev *dev)
931 struct nvm_id *id = &dev->identity;
932 struct nvm_id_group *grp = &id->grp;
933 struct nvm_geo *geo = &dev->geo;
936 /* Whole device values */
937 geo->nr_chnls = grp->num_ch;
938 geo->luns_per_chnl = grp->num_lun;
940 /* Generic device values */
941 geo->pgs_per_blk = grp->num_pg;
942 geo->blks_per_lun = grp->num_blk;
943 geo->nr_planes = grp->num_pln;
944 geo->fpg_size = grp->fpg_sz;
945 geo->pfpg_size = grp->fpg_sz * grp->num_pln;
946 geo->sec_size = grp->csecs;
947 geo->oob_size = grp->sos;
948 geo->sec_per_pg = grp->fpg_sz / grp->csecs;
949 geo->mccap = grp->mccap;
950 memcpy(&geo->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
952 geo->plane_mode = NVM_PLANE_SINGLE;
953 geo->max_rq_size = dev->ops->max_phys_sect * geo->sec_size;
955 if (grp->mpos & 0x020202)
956 geo->plane_mode = NVM_PLANE_DOUBLE;
957 if (grp->mpos & 0x040404)
958 geo->plane_mode = NVM_PLANE_QUAD;
960 if (grp->mtype != 0) {
961 pr_err("nvm: memory type not supported\n");
965 /* calculated values */
966 geo->sec_per_pl = geo->sec_per_pg * geo->nr_planes;
967 geo->sec_per_blk = geo->sec_per_pl * geo->pgs_per_blk;
968 geo->sec_per_lun = geo->sec_per_blk * geo->blks_per_lun;
969 geo->nr_luns = geo->luns_per_chnl * geo->nr_chnls;
971 dev->total_secs = geo->nr_luns * geo->sec_per_lun;
972 dev->lun_map = kcalloc(BITS_TO_LONGS(geo->nr_luns),
973 sizeof(unsigned long), GFP_KERNEL);
977 switch (grp->fmtype) {
978 case NVM_ID_FMTYPE_SLC:
979 if (nvm_init_slc_tbl(dev, grp)) {
984 case NVM_ID_FMTYPE_MLC:
985 if (nvm_init_mlc_tbl(dev, grp)) {
991 pr_err("nvm: flash type not supported\n");
996 INIT_LIST_HEAD(&dev->area_list);
997 INIT_LIST_HEAD(&dev->targets);
998 mutex_init(&dev->mlock);
999 spin_lock_init(&dev->lock);
1001 ret = nvm_register_map(dev);
1005 blk_queue_logical_block_size(dev->q, geo->sec_size);
1008 kfree(dev->lun_map);
1012 static void nvm_free(struct nvm_dev *dev)
1018 dev->ops->destroy_dma_pool(dev->dma_pool);
1020 nvm_unregister_map(dev);
1022 kfree(dev->lun_map);
1026 static int nvm_init(struct nvm_dev *dev)
1028 struct nvm_geo *geo = &dev->geo;
1031 if (dev->ops->identity(dev, &dev->identity)) {
1032 pr_err("nvm: device could not be identified\n");
1036 pr_debug("nvm: ver:%x nvm_vendor:%x\n",
1037 dev->identity.ver_id, dev->identity.vmnt);
1039 if (dev->identity.ver_id != 1) {
1040 pr_err("nvm: device not supported by kernel.");
1044 ret = nvm_core_init(dev);
1046 pr_err("nvm: could not initialize core structures.\n");
1050 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
1051 dev->name, geo->sec_per_pg, geo->nr_planes,
1052 geo->pgs_per_blk, geo->blks_per_lun,
1053 geo->nr_luns, geo->nr_chnls);
1056 pr_err("nvm: failed to initialize nvm\n");
1060 struct nvm_dev *nvm_alloc_dev(int node)
1062 return kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
1064 EXPORT_SYMBOL(nvm_alloc_dev);
1066 int nvm_register(struct nvm_dev *dev)
1070 if (!dev->q || !dev->ops)
1073 if (dev->ops->max_phys_sect > 256) {
1074 pr_info("nvm: max sectors supported is 256.\n");
1078 if (dev->ops->max_phys_sect > 1) {
1079 dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist");
1080 if (!dev->dma_pool) {
1081 pr_err("nvm: could not create dma pool\n");
1086 ret = nvm_init(dev);
1090 /* register device with a supported media manager */
1091 down_write(&nvm_lock);
1092 list_add(&dev->devices, &nvm_devices);
1093 up_write(&nvm_lock);
1097 dev->ops->destroy_dma_pool(dev->dma_pool);
1100 EXPORT_SYMBOL(nvm_register);
1102 void nvm_unregister(struct nvm_dev *dev)
1104 struct nvm_target *t, *tmp;
1106 mutex_lock(&dev->mlock);
1107 list_for_each_entry_safe(t, tmp, &dev->targets, list) {
1108 if (t->dev->parent != dev)
1110 __nvm_remove_target(t);
1112 mutex_unlock(&dev->mlock);
1114 down_write(&nvm_lock);
1115 list_del(&dev->devices);
1116 up_write(&nvm_lock);
1120 EXPORT_SYMBOL(nvm_unregister);
1122 static int __nvm_configure_create(struct nvm_ioctl_create *create)
1124 struct nvm_dev *dev;
1125 struct nvm_ioctl_create_simple *s;
1127 down_write(&nvm_lock);
1128 dev = nvm_find_nvm_dev(create->dev);
1129 up_write(&nvm_lock);
1132 pr_err("nvm: device not found\n");
1136 if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
1137 pr_err("nvm: config type not valid\n");
1140 s = &create->conf.s;
1142 if (s->lun_begin == -1 && s->lun_end == -1) {
1144 s->lun_end = dev->geo.nr_luns - 1;
1147 if (s->lun_begin > s->lun_end || s->lun_end >= dev->geo.nr_luns) {
1148 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
1149 s->lun_begin, s->lun_end, dev->geo.nr_luns - 1);
1153 return nvm_create_tgt(dev, create);
1156 static long nvm_ioctl_info(struct file *file, void __user *arg)
1158 struct nvm_ioctl_info *info;
1159 struct nvm_tgt_type *tt;
1162 if (!capable(CAP_SYS_ADMIN))
1165 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1169 info->version[0] = NVM_VERSION_MAJOR;
1170 info->version[1] = NVM_VERSION_MINOR;
1171 info->version[2] = NVM_VERSION_PATCH;
1173 down_write(&nvm_lock);
1174 list_for_each_entry(tt, &nvm_tgt_types, list) {
1175 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1177 tgt->version[0] = tt->version[0];
1178 tgt->version[1] = tt->version[1];
1179 tgt->version[2] = tt->version[2];
1180 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1185 info->tgtsize = tgt_iter;
1186 up_write(&nvm_lock);
1188 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1197 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1199 struct nvm_ioctl_get_devices *devices;
1200 struct nvm_dev *dev;
1203 if (!capable(CAP_SYS_ADMIN))
1206 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1210 down_write(&nvm_lock);
1211 list_for_each_entry(dev, &nvm_devices, devices) {
1212 struct nvm_ioctl_device_info *info = &devices->info[i];
1214 strlcpy(info->devname, dev->name, sizeof(info->devname));
1216 /* kept for compatibility */
1217 info->bmversion[0] = 1;
1218 info->bmversion[1] = 0;
1219 info->bmversion[2] = 0;
1220 strlcpy(info->bmname, "gennvm", sizeof(info->bmname));
1224 pr_err("nvm: max 31 devices can be reported.\n");
1228 up_write(&nvm_lock);
1230 devices->nr_devices = i;
1232 if (copy_to_user(arg, devices,
1233 sizeof(struct nvm_ioctl_get_devices))) {
1242 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1244 struct nvm_ioctl_create create;
1246 if (!capable(CAP_SYS_ADMIN))
1249 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1252 create.dev[DISK_NAME_LEN - 1] = '\0';
1253 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1254 create.tgtname[DISK_NAME_LEN - 1] = '\0';
1256 if (create.flags != 0) {
1257 __u32 flags = create.flags;
1259 /* Check for valid flags */
1260 if (flags & NVM_TARGET_FACTORY)
1261 flags &= ~NVM_TARGET_FACTORY;
1264 pr_err("nvm: flag not supported\n");
1269 return __nvm_configure_create(&create);
1272 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1274 struct nvm_ioctl_remove remove;
1275 struct nvm_dev *dev;
1278 if (!capable(CAP_SYS_ADMIN))
1281 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1284 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1286 if (remove.flags != 0) {
1287 pr_err("nvm: no flags supported\n");
1291 list_for_each_entry(dev, &nvm_devices, devices) {
1292 ret = nvm_remove_tgt(dev, &remove);
1300 /* kept for compatibility reasons */
1301 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1303 struct nvm_ioctl_dev_init init;
1305 if (!capable(CAP_SYS_ADMIN))
1308 if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1311 if (init.flags != 0) {
1312 pr_err("nvm: no flags supported\n");
1319 /* Kept for compatibility reasons */
1320 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1322 struct nvm_ioctl_dev_factory fact;
1324 if (!capable(CAP_SYS_ADMIN))
1327 if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1330 fact.dev[DISK_NAME_LEN - 1] = '\0';
1332 if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1338 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1340 void __user *argp = (void __user *)arg;
1344 return nvm_ioctl_info(file, argp);
1345 case NVM_GET_DEVICES:
1346 return nvm_ioctl_get_devices(file, argp);
1347 case NVM_DEV_CREATE:
1348 return nvm_ioctl_dev_create(file, argp);
1349 case NVM_DEV_REMOVE:
1350 return nvm_ioctl_dev_remove(file, argp);
1352 return nvm_ioctl_dev_init(file, argp);
1353 case NVM_DEV_FACTORY:
1354 return nvm_ioctl_dev_factory(file, argp);
1359 static const struct file_operations _ctl_fops = {
1360 .open = nonseekable_open,
1361 .unlocked_ioctl = nvm_ctl_ioctl,
1362 .owner = THIS_MODULE,
1363 .llseek = noop_llseek,
1366 static struct miscdevice _nvm_misc = {
1367 .minor = MISC_DYNAMIC_MINOR,
1369 .nodename = "lightnvm/control",
1372 builtin_misc_device(_nvm_misc);