9bfe0352d0930b5631a339901956b24e05199c4d
[linux-2.6-microblaze.git] / drivers / lightnvm / core.c
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/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>
29
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);
34
35 /* Map between virtual and physical channel and lun */
36 struct nvm_ch_map {
37         int ch_off;
38         int nr_luns;
39         int *lun_offs;
40 };
41
42 struct nvm_dev_map {
43         struct nvm_ch_map *chnls;
44         int nr_chnls;
45 };
46
47 struct nvm_area {
48         struct list_head list;
49         sector_t begin;
50         sector_t end;   /* end is excluded */
51 };
52
53 static struct nvm_target *nvm_find_target(struct nvm_dev *dev, const char *name)
54 {
55         struct nvm_target *tgt;
56
57         list_for_each_entry(tgt, &dev->targets, list)
58                 if (!strcmp(name, tgt->disk->disk_name))
59                         return tgt;
60
61         return NULL;
62 }
63
64 static int nvm_reserve_luns(struct nvm_dev *dev, int lun_begin, int lun_end)
65 {
66         int i;
67
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);
71                         goto err;
72                 }
73         }
74
75         return 0;
76 err:
77         while (--i > lun_begin)
78                 clear_bit(i, dev->lun_map);
79
80         return -EBUSY;
81 }
82
83 static void nvm_release_luns_err(struct nvm_dev *dev, int lun_begin,
84                                  int lun_end)
85 {
86         int i;
87
88         for (i = lun_begin; i <= lun_end; i++)
89                 WARN_ON(!test_and_clear_bit(i, dev->lun_map));
90 }
91
92 static void nvm_remove_tgt_dev(struct nvm_tgt_dev *tgt_dev)
93 {
94         struct nvm_dev *dev = tgt_dev->parent;
95         struct nvm_dev_map *dev_map = tgt_dev->map;
96         int i, j;
97
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;
102
103                 for (j = 0; j < ch_map->nr_luns; j++) {
104                         int lun = j + lun_offs[j];
105                         int lunid = (ch * dev->geo.luns_per_chnl) + lun;
106
107                         WARN_ON(!test_and_clear_bit(lunid, dev->lun_map));
108                 }
109
110                 kfree(ch_map->lun_offs);
111         }
112
113         kfree(dev_map->chnls);
114         kfree(dev_map);
115
116         kfree(tgt_dev->luns);
117         kfree(tgt_dev);
118 }
119
120 static struct nvm_tgt_dev *nvm_create_tgt_dev(struct nvm_dev *dev,
121                                               int lun_begin, int lun_end)
122 {
123         struct nvm_tgt_dev *tgt_dev = NULL;
124         struct nvm_dev_map *dev_rmap = dev->rmap;
125         struct nvm_dev_map *dev_map;
126         struct ppa_addr *luns;
127         int nr_luns = lun_end - lun_begin + 1;
128         int luns_left = nr_luns;
129         int nr_chnls = nr_luns / dev->geo.luns_per_chnl;
130         int nr_chnls_mod = nr_luns % dev->geo.luns_per_chnl;
131         int bch = lun_begin / dev->geo.luns_per_chnl;
132         int blun = lun_begin % dev->geo.luns_per_chnl;
133         int lunid = 0;
134         int lun_balanced = 1;
135         int prev_nr_luns;
136         int i, j;
137
138         nr_chnls = nr_luns / dev->geo.luns_per_chnl;
139         nr_chnls = (nr_chnls_mod == 0) ? nr_chnls : nr_chnls + 1;
140
141         dev_map = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
142         if (!dev_map)
143                 goto err_dev;
144
145         dev_map->chnls = kcalloc(nr_chnls, sizeof(struct nvm_ch_map),
146                                                                 GFP_KERNEL);
147         if (!dev_map->chnls)
148                 goto err_chnls;
149
150         luns = kcalloc(nr_luns, sizeof(struct ppa_addr), GFP_KERNEL);
151         if (!luns)
152                 goto err_luns;
153
154         prev_nr_luns = (luns_left > dev->geo.luns_per_chnl) ?
155                                         dev->geo.luns_per_chnl : luns_left;
156         for (i = 0; i < nr_chnls; i++) {
157                 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[i + bch];
158                 int *lun_roffs = ch_rmap->lun_offs;
159                 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
160                 int *lun_offs;
161                 int luns_in_chnl = (luns_left > dev->geo.luns_per_chnl) ?
162                                         dev->geo.luns_per_chnl : luns_left;
163
164                 if (lun_balanced && prev_nr_luns != luns_in_chnl)
165                         lun_balanced = 0;
166
167                 ch_map->ch_off = ch_rmap->ch_off = bch;
168                 ch_map->nr_luns = luns_in_chnl;
169
170                 lun_offs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
171                 if (!lun_offs)
172                         goto err_ch;
173
174                 for (j = 0; j < luns_in_chnl; j++) {
175                         luns[lunid].ppa = 0;
176                         luns[lunid].g.ch = i;
177                         luns[lunid++].g.lun = j;
178
179                         lun_offs[j] = blun;
180                         lun_roffs[j + blun] = blun;
181                 }
182
183                 ch_map->lun_offs = lun_offs;
184
185                 /* when starting a new channel, lun offset is reset */
186                 blun = 0;
187                 luns_left -= luns_in_chnl;
188         }
189
190         dev_map->nr_chnls = nr_chnls;
191
192         tgt_dev = kmalloc(sizeof(struct nvm_tgt_dev), GFP_KERNEL);
193         if (!tgt_dev)
194                 goto err_ch;
195
196         memcpy(&tgt_dev->geo, &dev->geo, sizeof(struct nvm_geo));
197         /* Target device only owns a portion of the physical device */
198         tgt_dev->geo.nr_chnls = nr_chnls;
199         tgt_dev->geo.nr_luns = nr_luns;
200         tgt_dev->geo.luns_per_chnl = (lun_balanced) ? prev_nr_luns : -1;
201         tgt_dev->total_secs = nr_luns * tgt_dev->geo.sec_per_lun;
202         tgt_dev->q = dev->q;
203         tgt_dev->map = dev_map;
204         tgt_dev->luns = luns;
205         memcpy(&tgt_dev->identity, &dev->identity, sizeof(struct nvm_id));
206
207         tgt_dev->parent = dev;
208
209         return tgt_dev;
210 err_ch:
211         while (--i > 0)
212                 kfree(dev_map->chnls[i].lun_offs);
213         kfree(luns);
214 err_luns:
215         kfree(dev_map->chnls);
216 err_chnls:
217         kfree(dev_map);
218 err_dev:
219         return tgt_dev;
220 }
221
222 static const struct block_device_operations nvm_fops = {
223         .owner          = THIS_MODULE,
224 };
225
226 static int nvm_create_tgt(struct nvm_dev *dev, struct nvm_ioctl_create *create)
227 {
228         struct nvm_ioctl_create_simple *s = &create->conf.s;
229         struct request_queue *tqueue;
230         struct gendisk *tdisk;
231         struct nvm_tgt_type *tt;
232         struct nvm_target *t;
233         struct nvm_tgt_dev *tgt_dev;
234         void *targetdata;
235
236         tt = nvm_find_target_type(create->tgttype, 1);
237         if (!tt) {
238                 pr_err("nvm: target type %s not found\n", create->tgttype);
239                 return -EINVAL;
240         }
241
242         mutex_lock(&dev->mlock);
243         t = nvm_find_target(dev, create->tgtname);
244         if (t) {
245                 pr_err("nvm: target name already exists.\n");
246                 mutex_unlock(&dev->mlock);
247                 return -EINVAL;
248         }
249         mutex_unlock(&dev->mlock);
250
251         if (nvm_reserve_luns(dev, s->lun_begin, s->lun_end))
252                 return -ENOMEM;
253
254         t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
255         if (!t)
256                 goto err_reserve;
257
258         tgt_dev = nvm_create_tgt_dev(dev, s->lun_begin, s->lun_end);
259         if (!tgt_dev) {
260                 pr_err("nvm: could not create target device\n");
261                 goto err_t;
262         }
263
264         tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
265         if (!tqueue)
266                 goto err_dev;
267         blk_queue_make_request(tqueue, tt->make_rq);
268
269         tdisk = alloc_disk(0);
270         if (!tdisk)
271                 goto err_queue;
272
273         sprintf(tdisk->disk_name, "%s", create->tgtname);
274         tdisk->flags = GENHD_FL_EXT_DEVT;
275         tdisk->major = 0;
276         tdisk->first_minor = 0;
277         tdisk->fops = &nvm_fops;
278         tdisk->queue = tqueue;
279
280         targetdata = tt->init(tgt_dev, tdisk);
281         if (IS_ERR(targetdata))
282                 goto err_init;
283
284         tdisk->private_data = targetdata;
285         tqueue->queuedata = targetdata;
286
287         blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
288
289         set_capacity(tdisk, tt->capacity(targetdata));
290         add_disk(tdisk);
291
292         if (tt->sysfs_init && tt->sysfs_init(tdisk))
293                 goto err_sysfs;
294
295         t->type = tt;
296         t->disk = tdisk;
297         t->dev = tgt_dev;
298
299         mutex_lock(&dev->mlock);
300         list_add_tail(&t->list, &dev->targets);
301         mutex_unlock(&dev->mlock);
302
303         return 0;
304 err_sysfs:
305         if (tt->exit)
306                 tt->exit(targetdata);
307 err_init:
308         put_disk(tdisk);
309 err_queue:
310         blk_cleanup_queue(tqueue);
311 err_dev:
312         nvm_remove_tgt_dev(tgt_dev);
313 err_t:
314         kfree(t);
315 err_reserve:
316         nvm_release_luns_err(dev, s->lun_begin, s->lun_end);
317         return -ENOMEM;
318 }
319
320 static void __nvm_remove_target(struct nvm_target *t)
321 {
322         struct nvm_tgt_type *tt = t->type;
323         struct gendisk *tdisk = t->disk;
324         struct request_queue *q = tdisk->queue;
325
326         del_gendisk(tdisk);
327         blk_cleanup_queue(q);
328
329         if (tt->sysfs_exit)
330                 tt->sysfs_exit(tdisk);
331
332         if (tt->exit)
333                 tt->exit(tdisk->private_data);
334
335         nvm_remove_tgt_dev(t->dev);
336         put_disk(tdisk);
337
338         list_del(&t->list);
339         kfree(t);
340 }
341
342 /**
343  * nvm_remove_tgt - Removes a target from the media manager
344  * @dev:        device
345  * @remove:     ioctl structure with target name to remove.
346  *
347  * Returns:
348  * 0: on success
349  * 1: on not found
350  * <0: on error
351  */
352 static int nvm_remove_tgt(struct nvm_dev *dev, struct nvm_ioctl_remove *remove)
353 {
354         struct nvm_target *t;
355
356         mutex_lock(&dev->mlock);
357         t = nvm_find_target(dev, remove->tgtname);
358         if (!t) {
359                 mutex_unlock(&dev->mlock);
360                 return 1;
361         }
362         __nvm_remove_target(t);
363         mutex_unlock(&dev->mlock);
364
365         return 0;
366 }
367
368 static int nvm_register_map(struct nvm_dev *dev)
369 {
370         struct nvm_dev_map *rmap;
371         int i, j;
372
373         rmap = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
374         if (!rmap)
375                 goto err_rmap;
376
377         rmap->chnls = kcalloc(dev->geo.nr_chnls, sizeof(struct nvm_ch_map),
378                                                                 GFP_KERNEL);
379         if (!rmap->chnls)
380                 goto err_chnls;
381
382         for (i = 0; i < dev->geo.nr_chnls; i++) {
383                 struct nvm_ch_map *ch_rmap;
384                 int *lun_roffs;
385                 int luns_in_chnl = dev->geo.luns_per_chnl;
386
387                 ch_rmap = &rmap->chnls[i];
388
389                 ch_rmap->ch_off = -1;
390                 ch_rmap->nr_luns = luns_in_chnl;
391
392                 lun_roffs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
393                 if (!lun_roffs)
394                         goto err_ch;
395
396                 for (j = 0; j < luns_in_chnl; j++)
397                         lun_roffs[j] = -1;
398
399                 ch_rmap->lun_offs = lun_roffs;
400         }
401
402         dev->rmap = rmap;
403
404         return 0;
405 err_ch:
406         while (--i >= 0)
407                 kfree(rmap->chnls[i].lun_offs);
408 err_chnls:
409         kfree(rmap);
410 err_rmap:
411         return -ENOMEM;
412 }
413
414 static void nvm_map_to_dev(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
415 {
416         struct nvm_dev_map *dev_map = tgt_dev->map;
417         struct nvm_ch_map *ch_map = &dev_map->chnls[p->g.ch];
418         int lun_off = ch_map->lun_offs[p->g.lun];
419
420         p->g.ch += ch_map->ch_off;
421         p->g.lun += lun_off;
422 }
423
424 static void nvm_map_to_tgt(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
425 {
426         struct nvm_dev *dev = tgt_dev->parent;
427         struct nvm_dev_map *dev_rmap = dev->rmap;
428         struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[p->g.ch];
429         int lun_roff = ch_rmap->lun_offs[p->g.lun];
430
431         p->g.ch -= ch_rmap->ch_off;
432         p->g.lun -= lun_roff;
433 }
434
435 static void nvm_ppa_tgt_to_dev(struct nvm_tgt_dev *tgt_dev,
436                                 struct ppa_addr *ppa_list, int nr_ppas)
437 {
438         int i;
439
440         for (i = 0; i < nr_ppas; i++) {
441                 nvm_map_to_dev(tgt_dev, &ppa_list[i]);
442                 ppa_list[i] = generic_to_dev_addr(tgt_dev, ppa_list[i]);
443         }
444 }
445
446 static void nvm_ppa_dev_to_tgt(struct nvm_tgt_dev *tgt_dev,
447                                 struct ppa_addr *ppa_list, int nr_ppas)
448 {
449         int i;
450
451         for (i = 0; i < nr_ppas; i++) {
452                 ppa_list[i] = dev_to_generic_addr(tgt_dev, ppa_list[i]);
453                 nvm_map_to_tgt(tgt_dev, &ppa_list[i]);
454         }
455 }
456
457 static void nvm_rq_tgt_to_dev(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
458 {
459         if (rqd->nr_ppas == 1) {
460                 nvm_ppa_tgt_to_dev(tgt_dev, &rqd->ppa_addr, 1);
461                 return;
462         }
463
464         nvm_ppa_tgt_to_dev(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
465 }
466
467 static void nvm_rq_dev_to_tgt(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
468 {
469         if (rqd->nr_ppas == 1) {
470                 nvm_ppa_dev_to_tgt(tgt_dev, &rqd->ppa_addr, 1);
471                 return;
472         }
473
474         nvm_ppa_dev_to_tgt(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
475 }
476
477 void nvm_part_to_tgt(struct nvm_dev *dev, sector_t *entries,
478                      int len)
479 {
480         struct nvm_geo *geo = &dev->geo;
481         struct nvm_dev_map *dev_rmap = dev->rmap;
482         u64 i;
483
484         for (i = 0; i < len; i++) {
485                 struct nvm_ch_map *ch_rmap;
486                 int *lun_roffs;
487                 struct ppa_addr gaddr;
488                 u64 pba = le64_to_cpu(entries[i]);
489                 int off;
490                 u64 diff;
491
492                 if (!pba)
493                         continue;
494
495                 gaddr = linear_to_generic_addr(geo, pba);
496                 ch_rmap = &dev_rmap->chnls[gaddr.g.ch];
497                 lun_roffs = ch_rmap->lun_offs;
498
499                 off = gaddr.g.ch * geo->luns_per_chnl + gaddr.g.lun;
500
501                 diff = ((ch_rmap->ch_off * geo->luns_per_chnl) +
502                                 (lun_roffs[gaddr.g.lun])) * geo->sec_per_lun;
503
504                 entries[i] -= cpu_to_le64(diff);
505         }
506 }
507 EXPORT_SYMBOL(nvm_part_to_tgt);
508
509 struct nvm_tgt_type *nvm_find_target_type(const char *name, int lock)
510 {
511         struct nvm_tgt_type *tmp, *tt = NULL;
512
513         if (lock)
514                 down_write(&nvm_tgtt_lock);
515
516         list_for_each_entry(tmp, &nvm_tgt_types, list)
517                 if (!strcmp(name, tmp->name)) {
518                         tt = tmp;
519                         break;
520                 }
521
522         if (lock)
523                 up_write(&nvm_tgtt_lock);
524         return tt;
525 }
526 EXPORT_SYMBOL(nvm_find_target_type);
527
528 int nvm_register_tgt_type(struct nvm_tgt_type *tt)
529 {
530         int ret = 0;
531
532         down_write(&nvm_tgtt_lock);
533         if (nvm_find_target_type(tt->name, 0))
534                 ret = -EEXIST;
535         else
536                 list_add(&tt->list, &nvm_tgt_types);
537         up_write(&nvm_tgtt_lock);
538
539         return ret;
540 }
541 EXPORT_SYMBOL(nvm_register_tgt_type);
542
543 void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
544 {
545         if (!tt)
546                 return;
547
548         down_write(&nvm_lock);
549         list_del(&tt->list);
550         up_write(&nvm_lock);
551 }
552 EXPORT_SYMBOL(nvm_unregister_tgt_type);
553
554 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
555                                                         dma_addr_t *dma_handler)
556 {
557         return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
558                                                                 dma_handler);
559 }
560 EXPORT_SYMBOL(nvm_dev_dma_alloc);
561
562 void nvm_dev_dma_free(struct nvm_dev *dev, void *addr, dma_addr_t dma_handler)
563 {
564         dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
565 }
566 EXPORT_SYMBOL(nvm_dev_dma_free);
567
568 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
569 {
570         struct nvm_dev *dev;
571
572         list_for_each_entry(dev, &nvm_devices, devices)
573                 if (!strcmp(name, dev->name))
574                         return dev;
575
576         return NULL;
577 }
578
579 int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
580                        int nr_ppas, int type)
581 {
582         struct nvm_dev *dev = tgt_dev->parent;
583         struct nvm_rq rqd;
584         int ret;
585
586         if (nr_ppas > dev->ops->max_phys_sect) {
587                 pr_err("nvm: unable to update all blocks atomically\n");
588                 return -EINVAL;
589         }
590
591         memset(&rqd, 0, sizeof(struct nvm_rq));
592
593         nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas, 1);
594         nvm_rq_tgt_to_dev(tgt_dev, &rqd);
595
596         ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
597         nvm_free_rqd_ppalist(dev, &rqd);
598         if (ret) {
599                 pr_err("nvm: failed bb mark\n");
600                 return -EINVAL;
601         }
602
603         return 0;
604 }
605 EXPORT_SYMBOL(nvm_set_tgt_bb_tbl);
606
607 int nvm_max_phys_sects(struct nvm_tgt_dev *tgt_dev)
608 {
609         struct nvm_dev *dev = tgt_dev->parent;
610
611         return dev->ops->max_phys_sect;
612 }
613 EXPORT_SYMBOL(nvm_max_phys_sects);
614
615 int nvm_submit_io(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
616 {
617         struct nvm_dev *dev = tgt_dev->parent;
618
619         if (!dev->ops->submit_io)
620                 return -ENODEV;
621
622         nvm_rq_tgt_to_dev(tgt_dev, rqd);
623
624         rqd->dev = tgt_dev;
625         return dev->ops->submit_io(dev, rqd);
626 }
627 EXPORT_SYMBOL(nvm_submit_io);
628
629 int nvm_erase_blk(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas, int flags)
630 {
631         struct nvm_dev *dev = tgt_dev->parent;
632         struct nvm_rq rqd;
633         int ret;
634
635         if (!dev->ops->erase_block)
636                 return 0;
637
638         nvm_map_to_dev(tgt_dev, ppas);
639
640         memset(&rqd, 0, sizeof(struct nvm_rq));
641
642         ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, 1, 1);
643         if (ret)
644                 return ret;
645
646         nvm_rq_tgt_to_dev(tgt_dev, &rqd);
647
648         rqd.flags = flags;
649
650         ret = dev->ops->erase_block(dev, &rqd);
651
652         nvm_free_rqd_ppalist(dev, &rqd);
653
654         return ret;
655 }
656 EXPORT_SYMBOL(nvm_erase_blk);
657
658 int nvm_get_l2p_tbl(struct nvm_tgt_dev *tgt_dev, u64 slba, u32 nlb,
659                     nvm_l2p_update_fn *update_l2p, void *priv)
660 {
661         struct nvm_dev *dev = tgt_dev->parent;
662
663         if (!dev->ops->get_l2p_tbl)
664                 return 0;
665
666         return dev->ops->get_l2p_tbl(dev, slba, nlb, update_l2p, priv);
667 }
668 EXPORT_SYMBOL(nvm_get_l2p_tbl);
669
670 int nvm_get_area(struct nvm_tgt_dev *tgt_dev, sector_t *lba, sector_t len)
671 {
672         struct nvm_dev *dev = tgt_dev->parent;
673         struct nvm_geo *geo = &dev->geo;
674         struct nvm_area *area, *prev, *next;
675         sector_t begin = 0;
676         sector_t max_sectors = (geo->sec_size * dev->total_secs) >> 9;
677
678         if (len > max_sectors)
679                 return -EINVAL;
680
681         area = kmalloc(sizeof(struct nvm_area), GFP_KERNEL);
682         if (!area)
683                 return -ENOMEM;
684
685         prev = NULL;
686
687         spin_lock(&dev->lock);
688         list_for_each_entry(next, &dev->area_list, list) {
689                 if (begin + len > next->begin) {
690                         begin = next->end;
691                         prev = next;
692                         continue;
693                 }
694                 break;
695         }
696
697         if ((begin + len) > max_sectors) {
698                 spin_unlock(&dev->lock);
699                 kfree(area);
700                 return -EINVAL;
701         }
702
703         area->begin = *lba = begin;
704         area->end = begin + len;
705
706         if (prev) /* insert into sorted order */
707                 list_add(&area->list, &prev->list);
708         else
709                 list_add(&area->list, &dev->area_list);
710         spin_unlock(&dev->lock);
711
712         return 0;
713 }
714 EXPORT_SYMBOL(nvm_get_area);
715
716 void nvm_put_area(struct nvm_tgt_dev *tgt_dev, sector_t begin)
717 {
718         struct nvm_dev *dev = tgt_dev->parent;
719         struct nvm_area *area;
720
721         spin_lock(&dev->lock);
722         list_for_each_entry(area, &dev->area_list, list) {
723                 if (area->begin != begin)
724                         continue;
725
726                 list_del(&area->list);
727                 spin_unlock(&dev->lock);
728                 kfree(area);
729                 return;
730         }
731         spin_unlock(&dev->lock);
732 }
733 EXPORT_SYMBOL(nvm_put_area);
734
735 int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
736                         const struct ppa_addr *ppas, int nr_ppas, int vblk)
737 {
738         struct nvm_geo *geo = &dev->geo;
739         int i, plane_cnt, pl_idx;
740         struct ppa_addr ppa;
741
742         if ((!vblk || geo->plane_mode == NVM_PLANE_SINGLE) && nr_ppas == 1) {
743                 rqd->nr_ppas = nr_ppas;
744                 rqd->ppa_addr = ppas[0];
745
746                 return 0;
747         }
748
749         rqd->nr_ppas = nr_ppas;
750         rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
751         if (!rqd->ppa_list) {
752                 pr_err("nvm: failed to allocate dma memory\n");
753                 return -ENOMEM;
754         }
755
756         if (!vblk) {
757                 for (i = 0; i < nr_ppas; i++)
758                         rqd->ppa_list[i] = ppas[i];
759         } else {
760                 plane_cnt = geo->plane_mode;
761                 rqd->nr_ppas *= plane_cnt;
762
763                 for (i = 0; i < nr_ppas; i++) {
764                         for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
765                                 ppa = ppas[i];
766                                 ppa.g.pl = pl_idx;
767                                 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
768                         }
769                 }
770         }
771
772         return 0;
773 }
774 EXPORT_SYMBOL(nvm_set_rqd_ppalist);
775
776 void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
777 {
778         if (!rqd->ppa_list)
779                 return;
780
781         nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
782 }
783 EXPORT_SYMBOL(nvm_free_rqd_ppalist);
784
785 void nvm_end_io(struct nvm_rq *rqd)
786 {
787         struct nvm_tgt_dev *tgt_dev = rqd->dev;
788
789         /* Convert address space */
790         if (tgt_dev)
791                 nvm_rq_dev_to_tgt(tgt_dev, rqd);
792
793         if (rqd->end_io)
794                 rqd->end_io(rqd);
795 }
796 EXPORT_SYMBOL(nvm_end_io);
797
798 /*
799  * folds a bad block list from its plane representation to its virtual
800  * block representation. The fold is done in place and reduced size is
801  * returned.
802  *
803  * If any of the planes status are bad or grown bad block, the virtual block
804  * is marked bad. If not bad, the first plane state acts as the block state.
805  */
806 int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
807 {
808         struct nvm_geo *geo = &dev->geo;
809         int blk, offset, pl, blktype;
810
811         if (nr_blks != geo->blks_per_lun * geo->plane_mode)
812                 return -EINVAL;
813
814         for (blk = 0; blk < geo->blks_per_lun; blk++) {
815                 offset = blk * geo->plane_mode;
816                 blktype = blks[offset];
817
818                 /* Bad blocks on any planes take precedence over other types */
819                 for (pl = 0; pl < geo->plane_mode; pl++) {
820                         if (blks[offset + pl] &
821                                         (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
822                                 blktype = blks[offset + pl];
823                                 break;
824                         }
825                 }
826
827                 blks[blk] = blktype;
828         }
829
830         return geo->blks_per_lun;
831 }
832 EXPORT_SYMBOL(nvm_bb_tbl_fold);
833
834 int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
835                        u8 *blks)
836 {
837         struct nvm_dev *dev = tgt_dev->parent;
838
839         nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
840
841         return dev->ops->get_bb_tbl(dev, ppa, blks);
842 }
843 EXPORT_SYMBOL(nvm_get_tgt_bb_tbl);
844
845 static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
846 {
847         struct nvm_geo *geo = &dev->geo;
848         int i;
849
850         dev->lps_per_blk = geo->pgs_per_blk;
851         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
852         if (!dev->lptbl)
853                 return -ENOMEM;
854
855         /* Just a linear array */
856         for (i = 0; i < dev->lps_per_blk; i++)
857                 dev->lptbl[i] = i;
858
859         return 0;
860 }
861
862 static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
863 {
864         int i, p;
865         struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
866
867         if (!mlc->num_pairs)
868                 return 0;
869
870         dev->lps_per_blk = mlc->num_pairs;
871         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
872         if (!dev->lptbl)
873                 return -ENOMEM;
874
875         /* The lower page table encoding consists of a list of bytes, where each
876          * has a lower and an upper half. The first half byte maintains the
877          * increment value and every value after is an offset added to the
878          * previous incrementation value
879          */
880         dev->lptbl[0] = mlc->pairs[0] & 0xF;
881         for (i = 1; i < dev->lps_per_blk; i++) {
882                 p = mlc->pairs[i >> 1];
883                 if (i & 0x1) /* upper */
884                         dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
885                 else /* lower */
886                         dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
887         }
888
889         return 0;
890 }
891
892 static int nvm_core_init(struct nvm_dev *dev)
893 {
894         struct nvm_id *id = &dev->identity;
895         struct nvm_id_group *grp = &id->grp;
896         struct nvm_geo *geo = &dev->geo;
897         int ret;
898
899         /* Whole device values */
900         geo->nr_chnls = grp->num_ch;
901         geo->luns_per_chnl = grp->num_lun;
902
903         /* Generic device values */
904         geo->pgs_per_blk = grp->num_pg;
905         geo->blks_per_lun = grp->num_blk;
906         geo->nr_planes = grp->num_pln;
907         geo->fpg_size = grp->fpg_sz;
908         geo->pfpg_size = grp->fpg_sz * grp->num_pln;
909         geo->sec_size = grp->csecs;
910         geo->oob_size = grp->sos;
911         geo->sec_per_pg = grp->fpg_sz / grp->csecs;
912         geo->mccap = grp->mccap;
913         memcpy(&geo->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
914
915         geo->plane_mode = NVM_PLANE_SINGLE;
916         geo->max_rq_size = dev->ops->max_phys_sect * geo->sec_size;
917
918         if (grp->mpos & 0x020202)
919                 geo->plane_mode = NVM_PLANE_DOUBLE;
920         if (grp->mpos & 0x040404)
921                 geo->plane_mode = NVM_PLANE_QUAD;
922
923         if (grp->mtype != 0) {
924                 pr_err("nvm: memory type not supported\n");
925                 return -EINVAL;
926         }
927
928         /* calculated values */
929         geo->sec_per_pl = geo->sec_per_pg * geo->nr_planes;
930         geo->sec_per_blk = geo->sec_per_pl * geo->pgs_per_blk;
931         geo->sec_per_lun = geo->sec_per_blk * geo->blks_per_lun;
932         geo->nr_luns = geo->luns_per_chnl * geo->nr_chnls;
933
934         dev->total_secs = geo->nr_luns * geo->sec_per_lun;
935         dev->lun_map = kcalloc(BITS_TO_LONGS(geo->nr_luns),
936                                         sizeof(unsigned long), GFP_KERNEL);
937         if (!dev->lun_map)
938                 return -ENOMEM;
939
940         switch (grp->fmtype) {
941         case NVM_ID_FMTYPE_SLC:
942                 if (nvm_init_slc_tbl(dev, grp)) {
943                         ret = -ENOMEM;
944                         goto err_fmtype;
945                 }
946                 break;
947         case NVM_ID_FMTYPE_MLC:
948                 if (nvm_init_mlc_tbl(dev, grp)) {
949                         ret = -ENOMEM;
950                         goto err_fmtype;
951                 }
952                 break;
953         default:
954                 pr_err("nvm: flash type not supported\n");
955                 ret = -EINVAL;
956                 goto err_fmtype;
957         }
958
959         INIT_LIST_HEAD(&dev->area_list);
960         INIT_LIST_HEAD(&dev->targets);
961         mutex_init(&dev->mlock);
962         spin_lock_init(&dev->lock);
963
964         ret = nvm_register_map(dev);
965         if (ret)
966                 goto err_fmtype;
967
968         blk_queue_logical_block_size(dev->q, geo->sec_size);
969         return 0;
970 err_fmtype:
971         kfree(dev->lun_map);
972         return ret;
973 }
974
975 void nvm_free(struct nvm_dev *dev)
976 {
977         if (!dev)
978                 return;
979
980         if (dev->dma_pool)
981                 dev->ops->destroy_dma_pool(dev->dma_pool);
982
983         kfree(dev->rmap);
984         kfree(dev->lptbl);
985         kfree(dev->lun_map);
986         kfree(dev);
987 }
988
989 static int nvm_init(struct nvm_dev *dev)
990 {
991         struct nvm_geo *geo = &dev->geo;
992         int ret = -EINVAL;
993
994         if (dev->ops->identity(dev, &dev->identity)) {
995                 pr_err("nvm: device could not be identified\n");
996                 goto err;
997         }
998
999         pr_debug("nvm: ver:%x nvm_vendor:%x\n",
1000                         dev->identity.ver_id, dev->identity.vmnt);
1001
1002         if (dev->identity.ver_id != 1) {
1003                 pr_err("nvm: device not supported by kernel.");
1004                 goto err;
1005         }
1006
1007         ret = nvm_core_init(dev);
1008         if (ret) {
1009                 pr_err("nvm: could not initialize core structures.\n");
1010                 goto err;
1011         }
1012
1013         pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
1014                         dev->name, geo->sec_per_pg, geo->nr_planes,
1015                         geo->pgs_per_blk, geo->blks_per_lun,
1016                         geo->nr_luns, geo->nr_chnls);
1017         return 0;
1018 err:
1019         pr_err("nvm: failed to initialize nvm\n");
1020         return ret;
1021 }
1022
1023 struct nvm_dev *nvm_alloc_dev(int node)
1024 {
1025         return kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
1026 }
1027 EXPORT_SYMBOL(nvm_alloc_dev);
1028
1029 int nvm_register(struct nvm_dev *dev)
1030 {
1031         int ret;
1032
1033         if (!dev->q || !dev->ops)
1034                 return -EINVAL;
1035
1036         if (dev->ops->max_phys_sect > 256) {
1037                 pr_info("nvm: max sectors supported is 256.\n");
1038                 return -EINVAL;
1039         }
1040
1041         if (dev->ops->max_phys_sect > 1) {
1042                 dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist");
1043                 if (!dev->dma_pool) {
1044                         pr_err("nvm: could not create dma pool\n");
1045                         return -ENOMEM;
1046                 }
1047         }
1048
1049         ret = nvm_init(dev);
1050         if (ret)
1051                 goto err_init;
1052
1053         /* register device with a supported media manager */
1054         down_write(&nvm_lock);
1055         list_add(&dev->devices, &nvm_devices);
1056         up_write(&nvm_lock);
1057
1058         return 0;
1059 err_init:
1060         dev->ops->destroy_dma_pool(dev->dma_pool);
1061         return ret;
1062 }
1063 EXPORT_SYMBOL(nvm_register);
1064
1065 void nvm_unregister(struct nvm_dev *dev)
1066 {
1067         struct nvm_target *t, *tmp;
1068
1069         mutex_lock(&dev->mlock);
1070         list_for_each_entry_safe(t, tmp, &dev->targets, list) {
1071                 if (t->dev->parent != dev)
1072                         continue;
1073                 __nvm_remove_target(t);
1074         }
1075         mutex_unlock(&dev->mlock);
1076
1077         down_write(&nvm_lock);
1078         list_del(&dev->devices);
1079         up_write(&nvm_lock);
1080
1081         nvm_free(dev);
1082 }
1083 EXPORT_SYMBOL(nvm_unregister);
1084
1085 static int __nvm_configure_create(struct nvm_ioctl_create *create)
1086 {
1087         struct nvm_dev *dev;
1088         struct nvm_ioctl_create_simple *s;
1089
1090         down_write(&nvm_lock);
1091         dev = nvm_find_nvm_dev(create->dev);
1092         up_write(&nvm_lock);
1093
1094         if (!dev) {
1095                 pr_err("nvm: device not found\n");
1096                 return -EINVAL;
1097         }
1098
1099         if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
1100                 pr_err("nvm: config type not valid\n");
1101                 return -EINVAL;
1102         }
1103         s = &create->conf.s;
1104
1105         if (s->lun_begin > s->lun_end || s->lun_end > dev->geo.nr_luns) {
1106                 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
1107                         s->lun_begin, s->lun_end, dev->geo.nr_luns);
1108                 return -EINVAL;
1109         }
1110
1111         return nvm_create_tgt(dev, create);
1112 }
1113
1114 static long nvm_ioctl_info(struct file *file, void __user *arg)
1115 {
1116         struct nvm_ioctl_info *info;
1117         struct nvm_tgt_type *tt;
1118         int tgt_iter = 0;
1119
1120         if (!capable(CAP_SYS_ADMIN))
1121                 return -EPERM;
1122
1123         info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1124         if (IS_ERR(info))
1125                 return -EFAULT;
1126
1127         info->version[0] = NVM_VERSION_MAJOR;
1128         info->version[1] = NVM_VERSION_MINOR;
1129         info->version[2] = NVM_VERSION_PATCH;
1130
1131         down_write(&nvm_lock);
1132         list_for_each_entry(tt, &nvm_tgt_types, list) {
1133                 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1134
1135                 tgt->version[0] = tt->version[0];
1136                 tgt->version[1] = tt->version[1];
1137                 tgt->version[2] = tt->version[2];
1138                 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1139
1140                 tgt_iter++;
1141         }
1142
1143         info->tgtsize = tgt_iter;
1144         up_write(&nvm_lock);
1145
1146         if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1147                 kfree(info);
1148                 return -EFAULT;
1149         }
1150
1151         kfree(info);
1152         return 0;
1153 }
1154
1155 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1156 {
1157         struct nvm_ioctl_get_devices *devices;
1158         struct nvm_dev *dev;
1159         int i = 0;
1160
1161         if (!capable(CAP_SYS_ADMIN))
1162                 return -EPERM;
1163
1164         devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1165         if (!devices)
1166                 return -ENOMEM;
1167
1168         down_write(&nvm_lock);
1169         list_for_each_entry(dev, &nvm_devices, devices) {
1170                 struct nvm_ioctl_device_info *info = &devices->info[i];
1171
1172                 sprintf(info->devname, "%s", dev->name);
1173
1174                 /* kept for compatibility */
1175                 info->bmversion[0] = 1;
1176                 info->bmversion[1] = 0;
1177                 info->bmversion[2] = 0;
1178                 sprintf(info->bmname, "%s", "gennvm");
1179                 i++;
1180
1181                 if (i > 31) {
1182                         pr_err("nvm: max 31 devices can be reported.\n");
1183                         break;
1184                 }
1185         }
1186         up_write(&nvm_lock);
1187
1188         devices->nr_devices = i;
1189
1190         if (copy_to_user(arg, devices,
1191                          sizeof(struct nvm_ioctl_get_devices))) {
1192                 kfree(devices);
1193                 return -EFAULT;
1194         }
1195
1196         kfree(devices);
1197         return 0;
1198 }
1199
1200 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1201 {
1202         struct nvm_ioctl_create create;
1203
1204         if (!capable(CAP_SYS_ADMIN))
1205                 return -EPERM;
1206
1207         if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1208                 return -EFAULT;
1209
1210         create.dev[DISK_NAME_LEN - 1] = '\0';
1211         create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1212         create.tgtname[DISK_NAME_LEN - 1] = '\0';
1213
1214         if (create.flags != 0) {
1215                 pr_err("nvm: no flags supported\n");
1216                 return -EINVAL;
1217         }
1218
1219         return __nvm_configure_create(&create);
1220 }
1221
1222 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1223 {
1224         struct nvm_ioctl_remove remove;
1225         struct nvm_dev *dev;
1226         int ret = 0;
1227
1228         if (!capable(CAP_SYS_ADMIN))
1229                 return -EPERM;
1230
1231         if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1232                 return -EFAULT;
1233
1234         remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1235
1236         if (remove.flags != 0) {
1237                 pr_err("nvm: no flags supported\n");
1238                 return -EINVAL;
1239         }
1240
1241         list_for_each_entry(dev, &nvm_devices, devices) {
1242                 ret = nvm_remove_tgt(dev, &remove);
1243                 if (!ret)
1244                         break;
1245         }
1246
1247         return ret;
1248 }
1249
1250 /* kept for compatibility reasons */
1251 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1252 {
1253         struct nvm_ioctl_dev_init init;
1254
1255         if (!capable(CAP_SYS_ADMIN))
1256                 return -EPERM;
1257
1258         if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1259                 return -EFAULT;
1260
1261         if (init.flags != 0) {
1262                 pr_err("nvm: no flags supported\n");
1263                 return -EINVAL;
1264         }
1265
1266         return 0;
1267 }
1268
1269 /* Kept for compatibility reasons */
1270 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1271 {
1272         struct nvm_ioctl_dev_factory fact;
1273
1274         if (!capable(CAP_SYS_ADMIN))
1275                 return -EPERM;
1276
1277         if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1278                 return -EFAULT;
1279
1280         fact.dev[DISK_NAME_LEN - 1] = '\0';
1281
1282         if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1283                 return -EINVAL;
1284
1285         return 0;
1286 }
1287
1288 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1289 {
1290         void __user *argp = (void __user *)arg;
1291
1292         switch (cmd) {
1293         case NVM_INFO:
1294                 return nvm_ioctl_info(file, argp);
1295         case NVM_GET_DEVICES:
1296                 return nvm_ioctl_get_devices(file, argp);
1297         case NVM_DEV_CREATE:
1298                 return nvm_ioctl_dev_create(file, argp);
1299         case NVM_DEV_REMOVE:
1300                 return nvm_ioctl_dev_remove(file, argp);
1301         case NVM_DEV_INIT:
1302                 return nvm_ioctl_dev_init(file, argp);
1303         case NVM_DEV_FACTORY:
1304                 return nvm_ioctl_dev_factory(file, argp);
1305         }
1306         return 0;
1307 }
1308
1309 static const struct file_operations _ctl_fops = {
1310         .open = nonseekable_open,
1311         .unlocked_ioctl = nvm_ctl_ioctl,
1312         .owner = THIS_MODULE,
1313         .llseek  = noop_llseek,
1314 };
1315
1316 static struct miscdevice _nvm_misc = {
1317         .minor          = MISC_DYNAMIC_MINOR,
1318         .name           = "lightnvm",
1319         .nodename       = "lightnvm/control",
1320         .fops           = &_ctl_fops,
1321 };
1322 builtin_misc_device(_nvm_misc);