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/module.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_mgrs);
  33 static LIST_HEAD(nvm_devices);
  34 static DECLARE_RWSEM(nvm_lock);
  35
  36 struct nvm_tgt_type *nvm_find_target_type(const char *name, int lock)
  37 {
  38         struct nvm_tgt_type *tmp, *tt = NULL;
  39
  40         if (lock)
  41                 down_write(&nvm_tgtt_lock);
  42
  43         list_for_each_entry(tmp, &nvm_tgt_types, list)
  44                 if (!strcmp(name, tmp->name)) {
  45                         tt = tmp;
  46                         break;
  47                 }
  48
  49         if (lock)
  50                 up_write(&nvm_tgtt_lock);
  51         return tt;
  52 }
  53 EXPORT_SYMBOL(nvm_find_target_type);
  54
  55 int nvm_register_tgt_type(struct nvm_tgt_type *tt)
  56 {
  57         int ret = 0;
  58
  59         down_write(&nvm_tgtt_lock);
  60         if (nvm_find_target_type(tt->name, 0))
  61                 ret = -EEXIST;
  62         else
  63                 list_add(&tt->list, &nvm_tgt_types);
  64         up_write(&nvm_tgtt_lock);
  65
  66         return ret;
  67 }
  68 EXPORT_SYMBOL(nvm_register_tgt_type);
  69
  70 void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
  71 {
  72         if (!tt)
  73                 return;
  74
  75         down_write(&nvm_lock);
  76         list_del(&tt->list);
  77         up_write(&nvm_lock);
  78 }
  79 EXPORT_SYMBOL(nvm_unregister_tgt_type);
  80
  81 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
  82                                                         dma_addr_t *dma_handler)
  83 {
  84         return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
  85                                                                 dma_handler);
  86 }
  87 EXPORT_SYMBOL(nvm_dev_dma_alloc);
  88
  89 void nvm_dev_dma_free(struct nvm_dev *dev, void *addr,
  90                                                         dma_addr_t dma_handler)
  91 {
  92         dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
  93 }
  94 EXPORT_SYMBOL(nvm_dev_dma_free);
  95
  96 static struct nvmm_type *nvm_find_mgr_type(const char *name)
  97 {
  98         struct nvmm_type *mt;
  99
 100         list_for_each_entry(mt, &nvm_mgrs, list)
 101                 if (!strcmp(name, mt->name))
 102                         return mt;
 103
 104         return NULL;
 105 }
 106
 107 static struct nvmm_type *nvm_init_mgr(struct nvm_dev *dev)
 108 {
 109         struct nvmm_type *mt;
 110         int ret;
 111
 112         lockdep_assert_held(&nvm_lock);
 113
 114         list_for_each_entry(mt, &nvm_mgrs, list) {
 115                 if (strncmp(dev->sb.mmtype, mt->name, NVM_MMTYPE_LEN))
 116                         continue;
 117
 118                 ret = mt->register_mgr(dev);
 119                 if (ret < 0) {
 120                         pr_err("nvm: media mgr failed to init (%d) on dev %s\n",
 121                                                                 ret, dev->name);
 122                         return NULL; /* initialization failed */
 123                 } else if (ret > 0)
 124                         return mt;
 125         }
 126
 127         return NULL;
 128 }
 129
 130 int nvm_register_mgr(struct nvmm_type *mt)
 131 {
 132         struct nvm_dev *dev;
 133         int ret = 0;
 134
 135         down_write(&nvm_lock);
 136         if (nvm_find_mgr_type(mt->name)) {
 137                 ret = -EEXIST;
 138                 goto finish;
 139         } else {
 140                 list_add(&mt->list, &nvm_mgrs);
 141         }
 142
 143         /* try to register media mgr if any device have none configured */
 144         list_for_each_entry(dev, &nvm_devices, devices) {
 145                 if (dev->mt)
 146                         continue;
 147
 148                 dev->mt = nvm_init_mgr(dev);
 149         }
 150 finish:
 151         up_write(&nvm_lock);
 152
 153         return ret;
 154 }
 155 EXPORT_SYMBOL(nvm_register_mgr);
 156
 157 void nvm_unregister_mgr(struct nvmm_type *mt)
 158 {
 159         if (!mt)
 160                 return;
 161
 162         down_write(&nvm_lock);
 163         list_del(&mt->list);
 164         up_write(&nvm_lock);
 165 }
 166 EXPORT_SYMBOL(nvm_unregister_mgr);
 167
 168 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
 169 {
 170         struct nvm_dev *dev;
 171
 172         list_for_each_entry(dev, &nvm_devices, devices)
 173                 if (!strcmp(name, dev->name))
 174                         return dev;
 175
 176         return NULL;
 177 }
 178
 179 struct nvm_block *nvm_get_blk(struct nvm_dev *dev, struct nvm_lun *lun,
 180                                                         unsigned long flags)
 181 {
 182         return dev->mt->get_blk(dev, lun, flags);
 183 }
 184 EXPORT_SYMBOL(nvm_get_blk);
 185
 186 /* Assumes that all valid pages have already been moved on release to bm */
 187 void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
 188 {
 189         return dev->mt->put_blk(dev, blk);
 190 }
 191 EXPORT_SYMBOL(nvm_put_blk);
 192
 193 void nvm_mark_blk(struct nvm_dev *dev, struct ppa_addr ppa, int type)
 194 {
 195         return dev->mt->mark_blk(dev, ppa, type);
 196 }
 197 EXPORT_SYMBOL(nvm_mark_blk);
 198
 199 int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
 200 {
 201         return dev->mt->submit_io(dev, rqd);
 202 }
 203 EXPORT_SYMBOL(nvm_submit_io);
 204
 205 int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk, int flags)
 206 {
 207         return dev->mt->erase_blk(dev, blk, flags);
 208 }
 209 EXPORT_SYMBOL(nvm_erase_blk);
 210
 211 void nvm_addr_to_generic_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
 212 {
 213         int i;
 214
 215         if (rqd->nr_ppas > 1) {
 216                 for (i = 0; i < rqd->nr_ppas; i++)
 217                         rqd->ppa_list[i] = dev_to_generic_addr(dev,
 218                                                         rqd->ppa_list[i]);
 219         } else {
 220                 rqd->ppa_addr = dev_to_generic_addr(dev, rqd->ppa_addr);
 221         }
 222 }
 223 EXPORT_SYMBOL(nvm_addr_to_generic_mode);
 224
 225 void nvm_generic_to_addr_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
 226 {
 227         int i;
 228
 229         if (rqd->nr_ppas > 1) {
 230                 for (i = 0; i < rqd->nr_ppas; i++)
 231                         rqd->ppa_list[i] = generic_to_dev_addr(dev,
 232                                                         rqd->ppa_list[i]);
 233         } else {
 234                 rqd->ppa_addr = generic_to_dev_addr(dev, rqd->ppa_addr);
 235         }
 236 }
 237 EXPORT_SYMBOL(nvm_generic_to_addr_mode);
 238
 239 int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
 240                         const struct ppa_addr *ppas, int nr_ppas, int vblk)
 241 {
 242         int i, plane_cnt, pl_idx;
 243         struct ppa_addr ppa;
 244
 245         if ((!vblk || dev->plane_mode == NVM_PLANE_SINGLE) && nr_ppas == 1) {
 246                 rqd->nr_ppas = nr_ppas;
 247                 rqd->ppa_addr = ppas[0];
 248
 249                 return 0;
 250         }
 251
 252         rqd->nr_ppas = nr_ppas;
 253         rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
 254         if (!rqd->ppa_list) {
 255                 pr_err("nvm: failed to allocate dma memory\n");
 256                 return -ENOMEM;
 257         }
 258
 259         if (!vblk) {
 260                 for (i = 0; i < nr_ppas; i++)
 261                         rqd->ppa_list[i] = ppas[i];
 262         } else {
 263                 plane_cnt = dev->plane_mode;
 264                 rqd->nr_ppas *= plane_cnt;
 265
 266                 for (i = 0; i < nr_ppas; i++) {
 267                         for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
 268                                 ppa = ppas[i];
 269                                 ppa.g.pl = pl_idx;
 270                                 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
 271                         }
 272                 }
 273         }
 274
 275         return 0;
 276 }
 277 EXPORT_SYMBOL(nvm_set_rqd_ppalist);
 278
 279 void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
 280 {
 281         if (!rqd->ppa_list)
 282                 return;
 283
 284         nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
 285 }
 286 EXPORT_SYMBOL(nvm_free_rqd_ppalist);
 287
 288 int nvm_erase_ppa(struct nvm_dev *dev, struct ppa_addr *ppas, int nr_ppas,
 289                                                                 int flags)
 290 {
 291         struct nvm_rq rqd;
 292         int ret;
 293
 294         if (!dev->ops->erase_block)
 295                 return 0;
 296
 297         memset(&rqd, 0, sizeof(struct nvm_rq));
 298
 299         ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas, 1);
 300         if (ret)
 301                 return ret;
 302
 303         nvm_generic_to_addr_mode(dev, &rqd);
 304
 305         rqd.flags = flags;
 306
 307         ret = dev->ops->erase_block(dev, &rqd);
 308
 309         nvm_free_rqd_ppalist(dev, &rqd);
 310
 311         return ret;
 312 }
 313 EXPORT_SYMBOL(nvm_erase_ppa);
 314
 315 void nvm_end_io(struct nvm_rq *rqd, int error)
 316 {
 317         rqd->error = error;
 318         rqd->end_io(rqd);
 319 }
 320 EXPORT_SYMBOL(nvm_end_io);
 321
 322 static void nvm_end_io_sync(struct nvm_rq *rqd)
 323 {
 324         struct completion *waiting = rqd->wait;
 325
 326         rqd->wait = NULL;
 327
 328         complete(waiting);
 329 }
 330
 331 static int __nvm_submit_ppa(struct nvm_dev *dev, struct nvm_rq *rqd, int opcode,
 332                                                 int flags, void *buf, int len)
 333 {
 334         DECLARE_COMPLETION_ONSTACK(wait);
 335         struct bio *bio;
 336         int ret;
 337         unsigned long hang_check;
 338
 339         bio = bio_map_kern(dev->q, buf, len, GFP_KERNEL);
 340         if (IS_ERR_OR_NULL(bio))
 341                 return -ENOMEM;
 342
 343         nvm_generic_to_addr_mode(dev, rqd);
 344
 345         rqd->dev = dev;
 346         rqd->opcode = opcode;
 347         rqd->flags = flags;
 348         rqd->bio = bio;
 349         rqd->wait = &wait;
 350         rqd->end_io = nvm_end_io_sync;
 351
 352         ret = dev->ops->submit_io(dev, rqd);
 353         if (ret) {
 354                 bio_put(bio);
 355                 return ret;
 356         }
 357
 358         /* Prevent hang_check timer from firing at us during very long I/O */
 359         hang_check = sysctl_hung_task_timeout_secs;
 360         if (hang_check)
 361                 while (!wait_for_completion_io_timeout(&wait,
 362                                                         hang_check * (HZ/2)))
 363                         ;
 364         else
 365                 wait_for_completion_io(&wait);
 366
 367         return rqd->error;
 368 }
 369
 370 /**
 371  * nvm_submit_ppa_list - submit user-defined ppa list to device. The user must
 372  *                       take to free ppa list if necessary.
 373  * @dev:        device
 374  * @ppa_list:   user created ppa_list
 375  * @nr_ppas:    length of ppa_list
 376  * @opcode:     device opcode
 377  * @flags:      device flags
 378  * @buf:        data buffer
 379  * @len:        data buffer length
 380  */
 381 int nvm_submit_ppa_list(struct nvm_dev *dev, struct ppa_addr *ppa_list,
 382                         int nr_ppas, int opcode, int flags, void *buf, int len)
 383 {
 384         struct nvm_rq rqd;
 385
 386         if (dev->ops->max_phys_sect < nr_ppas)
 387                 return -EINVAL;
 388
 389         memset(&rqd, 0, sizeof(struct nvm_rq));
 390
 391         rqd.nr_ppas = nr_ppas;
 392         if (nr_ppas > 1)
 393                 rqd.ppa_list = ppa_list;
 394         else
 395                 rqd.ppa_addr = ppa_list[0];
 396
 397         return __nvm_submit_ppa(dev, &rqd, opcode, flags, buf, len);
 398 }
 399 EXPORT_SYMBOL(nvm_submit_ppa_list);
 400
 401 /**
 402  * nvm_submit_ppa - submit PPAs to device. PPAs will automatically be unfolded
 403  *                  as single, dual, quad plane PPAs depending on device type.
 404  * @dev:        device
 405  * @ppa:        user created ppa_list
 406  * @nr_ppas:    length of ppa_list
 407  * @opcode:     device opcode
 408  * @flags:      device flags
 409  * @buf:        data buffer
 410  * @len:        data buffer length
 411  */
 412 int nvm_submit_ppa(struct nvm_dev *dev, struct ppa_addr *ppa, int nr_ppas,
 413                                 int opcode, int flags, void *buf, int len)
 414 {
 415         struct nvm_rq rqd;
 416         int ret;
 417
 418         memset(&rqd, 0, sizeof(struct nvm_rq));
 419         ret = nvm_set_rqd_ppalist(dev, &rqd, ppa, nr_ppas, 1);
 420         if (ret)
 421                 return ret;
 422
 423         ret = __nvm_submit_ppa(dev, &rqd, opcode, flags, buf, len);
 424
 425         nvm_free_rqd_ppalist(dev, &rqd);
 426
 427         return ret;
 428 }
 429 EXPORT_SYMBOL(nvm_submit_ppa);
 430
 431 /*
 432  * folds a bad block list from its plane representation to its virtual
 433  * block representation. The fold is done in place and reduced size is
 434  * returned.
 435  *
 436  * If any of the planes status are bad or grown bad block, the virtual block
 437  * is marked bad. If not bad, the first plane state acts as the block state.
 438  */
 439 int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
 440 {
 441         int blk, offset, pl, blktype;
 442
 443         if (nr_blks != dev->blks_per_lun * dev->plane_mode)
 444                 return -EINVAL;
 445
 446         for (blk = 0; blk < dev->blks_per_lun; blk++) {
 447                 offset = blk * dev->plane_mode;
 448                 blktype = blks[offset];
 449
 450                 /* Bad blocks on any planes take precedence over other types */
 451                 for (pl = 0; pl < dev->plane_mode; pl++) {
 452                         if (blks[offset + pl] &
 453                                         (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
 454                                 blktype = blks[offset + pl];
 455                                 break;
 456                         }
 457                 }
 458
 459                 blks[blk] = blktype;
 460         }
 461
 462         return dev->blks_per_lun;
 463 }
 464 EXPORT_SYMBOL(nvm_bb_tbl_fold);
 465
 466 int nvm_get_bb_tbl(struct nvm_dev *dev, struct ppa_addr ppa, u8 *blks)
 467 {
 468         ppa = generic_to_dev_addr(dev, ppa);
 469
 470         return dev->ops->get_bb_tbl(dev, ppa, blks);
 471 }
 472 EXPORT_SYMBOL(nvm_get_bb_tbl);
 473
 474 static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
 475 {
 476         int i;
 477
 478         dev->lps_per_blk = dev->pgs_per_blk;
 479         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
 480         if (!dev->lptbl)
 481                 return -ENOMEM;
 482
 483         /* Just a linear array */
 484         for (i = 0; i < dev->lps_per_blk; i++)
 485                 dev->lptbl[i] = i;
 486
 487         return 0;
 488 }
 489
 490 static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
 491 {
 492         int i, p;
 493         struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
 494
 495         if (!mlc->num_pairs)
 496                 return 0;
 497
 498         dev->lps_per_blk = mlc->num_pairs;
 499         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
 500         if (!dev->lptbl)
 501                 return -ENOMEM;
 502
 503         /* The lower page table encoding consists of a list of bytes, where each
 504          * has a lower and an upper half. The first half byte maintains the
 505          * increment value and every value after is an offset added to the
 506          * previous incrementation value
 507          */
 508         dev->lptbl[0] = mlc->pairs[0] & 0xF;
 509         for (i = 1; i < dev->lps_per_blk; i++) {
 510                 p = mlc->pairs[i >> 1];
 511                 if (i & 0x1) /* upper */
 512                         dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
 513                 else /* lower */
 514                         dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
 515         }
 516
 517         return 0;
 518 }
 519
 520 static int nvm_core_init(struct nvm_dev *dev)
 521 {
 522         struct nvm_id *id = &dev->identity;
 523         struct nvm_id_group *grp = &id->groups[0];
 524         int ret;
 525
 526         /* device values */
 527         dev->nr_chnls = grp->num_ch;
 528         dev->luns_per_chnl = grp->num_lun;
 529         dev->pgs_per_blk = grp->num_pg;
 530         dev->blks_per_lun = grp->num_blk;
 531         dev->nr_planes = grp->num_pln;
 532         dev->fpg_size = grp->fpg_sz;
 533         dev->pfpg_size = grp->fpg_sz * grp->num_pln;
 534         dev->sec_size = grp->csecs;
 535         dev->oob_size = grp->sos;
 536         dev->sec_per_pg = grp->fpg_sz / grp->csecs;
 537         dev->mccap = grp->mccap;
 538         memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
 539
 540         dev->plane_mode = NVM_PLANE_SINGLE;
 541         dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
 542
 543         if (grp->mpos & 0x020202)
 544                 dev->plane_mode = NVM_PLANE_DOUBLE;
 545         if (grp->mpos & 0x040404)
 546                 dev->plane_mode = NVM_PLANE_QUAD;
 547
 548         if (grp->mtype != 0) {
 549                 pr_err("nvm: memory type not supported\n");
 550                 return -EINVAL;
 551         }
 552
 553         /* calculated values */
 554         dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
 555         dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
 556         dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
 557         dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
 558
 559         dev->total_secs = dev->nr_luns * dev->sec_per_lun;
 560         dev->lun_map = kcalloc(BITS_TO_LONGS(dev->nr_luns),
 561                                         sizeof(unsigned long), GFP_KERNEL);
 562         if (!dev->lun_map)
 563                 return -ENOMEM;
 564
 565         switch (grp->fmtype) {
 566         case NVM_ID_FMTYPE_SLC:
 567                 if (nvm_init_slc_tbl(dev, grp)) {
 568                         ret = -ENOMEM;
 569                         goto err_fmtype;
 570                 }
 571                 break;
 572         case NVM_ID_FMTYPE_MLC:
 573                 if (nvm_init_mlc_tbl(dev, grp)) {
 574                         ret = -ENOMEM;
 575                         goto err_fmtype;
 576                 }
 577                 break;
 578         default:
 579                 pr_err("nvm: flash type not supported\n");
 580                 ret = -EINVAL;
 581                 goto err_fmtype;
 582         }
 583
 584         mutex_init(&dev->mlock);
 585         spin_lock_init(&dev->lock);
 586
 587         blk_queue_logical_block_size(dev->q, dev->sec_size);
 588
 589         return 0;
 590 err_fmtype:
 591         kfree(dev->lun_map);
 592         return ret;
 593 }
 594
 595 static void nvm_free_mgr(struct nvm_dev *dev)
 596 {
 597         if (!dev->mt)
 598                 return;
 599
 600         dev->mt->unregister_mgr(dev);
 601         dev->mt = NULL;
 602 }
 603
 604 void nvm_free(struct nvm_dev *dev)
 605 {
 606         if (!dev)
 607                 return;
 608
 609         nvm_free_mgr(dev);
 610
 611         if (dev->dma_pool)
 612                 dev->ops->destroy_dma_pool(dev->dma_pool);
 613
 614         kfree(dev->lptbl);
 615         kfree(dev->lun_map);
 616         kfree(dev);
 617 }
 618
 619 static int nvm_init(struct nvm_dev *dev)
 620 {
 621         int ret = -EINVAL;
 622
 623         if (!dev->q || !dev->ops)
 624                 return ret;
 625
 626         if (dev->ops->identity(dev, &dev->identity)) {
 627                 pr_err("nvm: device could not be identified\n");
 628                 goto err;
 629         }
 630
 631         pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
 632                         dev->identity.ver_id, dev->identity.vmnt,
 633                                                         dev->identity.cgrps);
 634
 635         if (dev->identity.ver_id != 1) {
 636                 pr_err("nvm: device not supported by kernel.");
 637                 goto err;
 638         }
 639
 640         if (dev->identity.cgrps != 1) {
 641                 pr_err("nvm: only one group configuration supported.");
 642                 goto err;
 643         }
 644
 645         ret = nvm_core_init(dev);
 646         if (ret) {
 647                 pr_err("nvm: could not initialize core structures.\n");
 648                 goto err;
 649         }
 650
 651         pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
 652                         dev->name, dev->sec_per_pg, dev->nr_planes,
 653                         dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
 654                         dev->nr_chnls);
 655         return 0;
 656 err:
 657         pr_err("nvm: failed to initialize nvm\n");
 658         return ret;
 659 }
 660
 661 struct nvm_dev *nvm_alloc_dev(int node)
 662 {
 663         return kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
 664 }
 665 EXPORT_SYMBOL(nvm_alloc_dev);
 666
 667 int nvm_register(struct nvm_dev *dev)
 668 {
 669         int ret;
 670
 671         ret = nvm_init(dev);
 672         if (ret)
 673                 goto err_init;
 674
 675         if (dev->ops->max_phys_sect > 256) {
 676                 pr_info("nvm: max sectors supported is 256.\n");
 677                 ret = -EINVAL;
 678                 goto err_init;
 679         }
 680
 681         if (dev->ops->max_phys_sect > 1) {
 682                 dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist");
 683                 if (!dev->dma_pool) {
 684                         pr_err("nvm: could not create dma pool\n");
 685                         ret = -ENOMEM;
 686                         goto err_init;
 687                 }
 688         }
 689
 690         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
 691                 ret = nvm_get_sysblock(dev, &dev->sb);
 692                 if (!ret)
 693                         pr_err("nvm: device not initialized.\n");
 694                 else if (ret < 0)
 695                         pr_err("nvm: err (%d) on device initialization\n", ret);
 696         }
 697
 698         /* register device with a supported media manager */
 699         down_write(&nvm_lock);
 700         if (ret > 0)
 701                 dev->mt = nvm_init_mgr(dev);
 702         list_add(&dev->devices, &nvm_devices);
 703         up_write(&nvm_lock);
 704
 705         return 0;
 706 err_init:
 707         kfree(dev->lun_map);
 708         return ret;
 709 }
 710 EXPORT_SYMBOL(nvm_register);
 711
 712 void nvm_unregister(struct nvm_dev *dev)
 713 {
 714         down_write(&nvm_lock);
 715         list_del(&dev->devices);
 716         up_write(&nvm_lock);
 717
 718         nvm_free(dev);
 719 }
 720 EXPORT_SYMBOL(nvm_unregister);
 721
 722 static int __nvm_configure_create(struct nvm_ioctl_create *create)
 723 {
 724         struct nvm_dev *dev;
 725         struct nvm_ioctl_create_simple *s;
 726
 727         down_write(&nvm_lock);
 728         dev = nvm_find_nvm_dev(create->dev);
 729         up_write(&nvm_lock);
 730
 731         if (!dev) {
 732                 pr_err("nvm: device not found\n");
 733                 return -EINVAL;
 734         }
 735
 736         if (!dev->mt) {
 737                 pr_info("nvm: device has no media manager registered.\n");
 738                 return -ENODEV;
 739         }
 740
 741         if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
 742                 pr_err("nvm: config type not valid\n");
 743                 return -EINVAL;
 744         }
 745         s = &create->conf.s;
 746
 747         if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
 748                 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
 749                         s->lun_begin, s->lun_end, dev->nr_luns);
 750                 return -EINVAL;
 751         }
 752
 753         return dev->mt->create_tgt(dev, create);
 754 }
 755
 756 #ifdef CONFIG_NVM_DEBUG
 757 static int nvm_configure_show(const char *val)
 758 {
 759         struct nvm_dev *dev;
 760         char opcode, devname[DISK_NAME_LEN];
 761         int ret;
 762
 763         ret = sscanf(val, "%c %32s", &opcode, devname);
 764         if (ret != 2) {
 765                 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
 766                 return -EINVAL;
 767         }
 768
 769         down_write(&nvm_lock);
 770         dev = nvm_find_nvm_dev(devname);
 771         up_write(&nvm_lock);
 772         if (!dev) {
 773                 pr_err("nvm: device not found\n");
 774                 return -EINVAL;
 775         }
 776
 777         if (!dev->mt)
 778                 return 0;
 779
 780         dev->mt->lun_info_print(dev);
 781
 782         return 0;
 783 }
 784
 785 static int nvm_configure_remove(const char *val)
 786 {
 787         struct nvm_ioctl_remove remove;
 788         struct nvm_dev *dev;
 789         char opcode;
 790         int ret = 0;
 791
 792         ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
 793         if (ret != 2) {
 794                 pr_err("nvm: invalid command. Use \"d targetname\".\n");
 795                 return -EINVAL;
 796         }
 797
 798         remove.flags = 0;
 799
 800         list_for_each_entry(dev, &nvm_devices, devices) {
 801                 ret = dev->mt->remove_tgt(dev, &remove);
 802                 if (!ret)
 803                         break;
 804         }
 805
 806         return ret;
 807 }
 808
 809 static int nvm_configure_create(const char *val)
 810 {
 811         struct nvm_ioctl_create create;
 812         char opcode;
 813         int lun_begin, lun_end, ret;
 814
 815         ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
 816                                                 create.tgtname, create.tgttype,
 817                                                 &lun_begin, &lun_end);
 818         if (ret != 6) {
 819                 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
 820                 return -EINVAL;
 821         }
 822
 823         create.flags = 0;
 824         create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
 825         create.conf.s.lun_begin = lun_begin;
 826         create.conf.s.lun_end = lun_end;
 827
 828         return __nvm_configure_create(&create);
 829 }
 830
 831
 832 /* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
 833 static int nvm_configure_by_str_event(const char *val,
 834                                         const struct kernel_param *kp)
 835 {
 836         char opcode;
 837         int ret;
 838
 839         ret = sscanf(val, "%c", &opcode);
 840         if (ret != 1) {
 841                 pr_err("nvm: string must have the format of \"cmd ...\"\n");
 842                 return -EINVAL;
 843         }
 844
 845         switch (opcode) {
 846         case 'a':
 847                 return nvm_configure_create(val);
 848         case 'd':
 849                 return nvm_configure_remove(val);
 850         case 's':
 851                 return nvm_configure_show(val);
 852         default:
 853                 pr_err("nvm: invalid command\n");
 854                 return -EINVAL;
 855         }
 856
 857         return 0;
 858 }
 859
 860 static int nvm_configure_get(char *buf, const struct kernel_param *kp)
 861 {
 862         int sz;
 863         struct nvm_dev *dev;
 864
 865         sz = sprintf(buf, "available devices:\n");
 866         down_write(&nvm_lock);
 867         list_for_each_entry(dev, &nvm_devices, devices) {
 868                 if (sz > 4095 - DISK_NAME_LEN - 2)
 869                         break;
 870                 sz += sprintf(buf + sz, " %32s\n", dev->name);
 871         }
 872         up_write(&nvm_lock);
 873
 874         return sz;
 875 }
 876
 877 static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
 878         .set    = nvm_configure_by_str_event,
 879         .get    = nvm_configure_get,
 880 };
 881
 882 #undef MODULE_PARAM_PREFIX
 883 #define MODULE_PARAM_PREFIX     "lnvm."
 884
 885 module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
 886                                                                         0644);
 887
 888 #endif /* CONFIG_NVM_DEBUG */
 889
 890 static long nvm_ioctl_info(struct file *file, void __user *arg)
 891 {
 892         struct nvm_ioctl_info *info;
 893         struct nvm_tgt_type *tt;
 894         int tgt_iter = 0;
 895
 896         if (!capable(CAP_SYS_ADMIN))
 897                 return -EPERM;
 898
 899         info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
 900         if (IS_ERR(info))
 901                 return -EFAULT;
 902
 903         info->version[0] = NVM_VERSION_MAJOR;
 904         info->version[1] = NVM_VERSION_MINOR;
 905         info->version[2] = NVM_VERSION_PATCH;
 906
 907         down_write(&nvm_lock);
 908         list_for_each_entry(tt, &nvm_tgt_types, list) {
 909                 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
 910
 911                 tgt->version[0] = tt->version[0];
 912                 tgt->version[1] = tt->version[1];
 913                 tgt->version[2] = tt->version[2];
 914                 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
 915
 916                 tgt_iter++;
 917         }
 918
 919         info->tgtsize = tgt_iter;
 920         up_write(&nvm_lock);
 921
 922         if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
 923                 kfree(info);
 924                 return -EFAULT;
 925         }
 926
 927         kfree(info);
 928         return 0;
 929 }
 930
 931 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
 932 {
 933         struct nvm_ioctl_get_devices *devices;
 934         struct nvm_dev *dev;
 935         int i = 0;
 936
 937         if (!capable(CAP_SYS_ADMIN))
 938                 return -EPERM;
 939
 940         devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
 941         if (!devices)
 942                 return -ENOMEM;
 943
 944         down_write(&nvm_lock);
 945         list_for_each_entry(dev, &nvm_devices, devices) {
 946                 struct nvm_ioctl_device_info *info = &devices->info[i];
 947
 948                 sprintf(info->devname, "%s", dev->name);
 949                 if (dev->mt) {
 950                         info->bmversion[0] = dev->mt->version[0];
 951                         info->bmversion[1] = dev->mt->version[1];
 952                         info->bmversion[2] = dev->mt->version[2];
 953                         sprintf(info->bmname, "%s", dev->mt->name);
 954                 } else {
 955                         sprintf(info->bmname, "none");
 956                 }
 957
 958                 i++;
 959                 if (i > 31) {
 960                         pr_err("nvm: max 31 devices can be reported.\n");
 961                         break;
 962                 }
 963         }
 964         up_write(&nvm_lock);
 965
 966         devices->nr_devices = i;
 967
 968         if (copy_to_user(arg, devices,
 969                          sizeof(struct nvm_ioctl_get_devices))) {
 970                 kfree(devices);
 971                 return -EFAULT;
 972         }
 973
 974         kfree(devices);
 975         return 0;
 976 }
 977
 978 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
 979 {
 980         struct nvm_ioctl_create create;
 981
 982         if (!capable(CAP_SYS_ADMIN))
 983                 return -EPERM;
 984
 985         if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
 986                 return -EFAULT;
 987
 988         create.dev[DISK_NAME_LEN - 1] = '\0';
 989         create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
 990         create.tgtname[DISK_NAME_LEN - 1] = '\0';
 991
 992         if (create.flags != 0) {
 993                 pr_err("nvm: no flags supported\n");
 994                 return -EINVAL;
 995         }
 996
 997         return __nvm_configure_create(&create);
 998 }
 999
1000 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1001 {
1002         struct nvm_ioctl_remove remove;
1003         struct nvm_dev *dev;
1004         int ret = 0;
1005
1006         if (!capable(CAP_SYS_ADMIN))
1007                 return -EPERM;
1008
1009         if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1010                 return -EFAULT;
1011
1012         remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1013
1014         if (remove.flags != 0) {
1015                 pr_err("nvm: no flags supported\n");
1016                 return -EINVAL;
1017         }
1018
1019         list_for_each_entry(dev, &nvm_devices, devices) {
1020                 ret = dev->mt->remove_tgt(dev, &remove);
1021                 if (!ret)
1022                         break;
1023         }
1024
1025         return ret;
1026 }
1027
1028 static void nvm_setup_nvm_sb_info(struct nvm_sb_info *info)
1029 {
1030         info->seqnr = 1;
1031         info->erase_cnt = 0;
1032         info->version = 1;
1033 }
1034
1035 static long __nvm_ioctl_dev_init(struct nvm_ioctl_dev_init *init)
1036 {
1037         struct nvm_dev *dev;
1038         struct nvm_sb_info info;
1039         int ret;
1040
1041         down_write(&nvm_lock);
1042         dev = nvm_find_nvm_dev(init->dev);
1043         up_write(&nvm_lock);
1044         if (!dev) {
1045                 pr_err("nvm: device not found\n");
1046                 return -EINVAL;
1047         }
1048
1049         nvm_setup_nvm_sb_info(&info);
1050
1051         strncpy(info.mmtype, init->mmtype, NVM_MMTYPE_LEN);
1052         info.fs_ppa.ppa = -1;
1053
1054         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
1055                 ret = nvm_init_sysblock(dev, &info);
1056                 if (ret)
1057                         return ret;
1058         }
1059
1060         memcpy(&dev->sb, &info, sizeof(struct nvm_sb_info));
1061
1062         down_write(&nvm_lock);
1063         dev->mt = nvm_init_mgr(dev);
1064         up_write(&nvm_lock);
1065
1066         return 0;
1067 }
1068
1069 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1070 {
1071         struct nvm_ioctl_dev_init init;
1072
1073         if (!capable(CAP_SYS_ADMIN))
1074                 return -EPERM;
1075
1076         if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1077                 return -EFAULT;
1078
1079         if (init.flags != 0) {
1080                 pr_err("nvm: no flags supported\n");
1081                 return -EINVAL;
1082         }
1083
1084         init.dev[DISK_NAME_LEN - 1] = '\0';
1085
1086         return __nvm_ioctl_dev_init(&init);
1087 }
1088
1089 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1090 {
1091         struct nvm_ioctl_dev_factory fact;
1092         struct nvm_dev *dev;
1093
1094         if (!capable(CAP_SYS_ADMIN))
1095                 return -EPERM;
1096
1097         if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1098                 return -EFAULT;
1099
1100         fact.dev[DISK_NAME_LEN - 1] = '\0';
1101
1102         if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1103                 return -EINVAL;
1104
1105         down_write(&nvm_lock);
1106         dev = nvm_find_nvm_dev(fact.dev);
1107         up_write(&nvm_lock);
1108         if (!dev) {
1109                 pr_err("nvm: device not found\n");
1110                 return -EINVAL;
1111         }
1112
1113         nvm_free_mgr(dev);
1114
1115         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT)
1116                 return nvm_dev_factory(dev, fact.flags);
1117
1118         return 0;
1119 }
1120
1121 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1122 {
1123         void __user *argp = (void __user *)arg;
1124
1125         switch (cmd) {
1126         case NVM_INFO:
1127                 return nvm_ioctl_info(file, argp);
1128         case NVM_GET_DEVICES:
1129                 return nvm_ioctl_get_devices(file, argp);
1130         case NVM_DEV_CREATE:
1131                 return nvm_ioctl_dev_create(file, argp);
1132         case NVM_DEV_REMOVE:
1133                 return nvm_ioctl_dev_remove(file, argp);
1134         case NVM_DEV_INIT:
1135                 return nvm_ioctl_dev_init(file, argp);
1136         case NVM_DEV_FACTORY:
1137                 return nvm_ioctl_dev_factory(file, argp);
1138         }
1139         return 0;
1140 }
1141
1142 static const struct file_operations _ctl_fops = {
1143         .open = nonseekable_open,
1144         .unlocked_ioctl = nvm_ctl_ioctl,
1145         .owner = THIS_MODULE,
1146         .llseek  = noop_llseek,
1147 };
1148
1149 static struct miscdevice _nvm_misc = {
1150         .minor          = MISC_DYNAMIC_MINOR,
1151         .name           = "lightnvm",
1152         .nodename       = "lightnvm/control",
1153         .fops           = &_ctl_fops,
1154 };
1155 module_misc_device(_nvm_misc);
1156
1157 MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
1158
1159 MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
1160 MODULE_LICENSE("GPL v2");
1161 MODULE_VERSION("0.1");