drivers/nvme/host/lightnvm.c

   1 /*
   2  * nvme-lightnvm.c - LightNVM NVMe device
   3  *
   4  * Copyright (C) 2014-2015 IT University of Copenhagen
   5  * Initial release: Matias Bjorling <mb@lightnvm.io>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License version
   9  * 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; see the file COPYING.  If not, write to
  18  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
  19  * USA.
  20  *
  21  */
  22
  23 #include "nvme.h"
  24
  25 #include <linux/nvme.h>
  26 #include <linux/bitops.h>
  27 #include <linux/lightnvm.h>
  28 #include <linux/vmalloc.h>
  29
  30 enum nvme_nvm_admin_opcode {
  31         nvme_nvm_admin_identity         = 0xe2,
  32         nvme_nvm_admin_get_l2p_tbl      = 0xea,
  33         nvme_nvm_admin_get_bb_tbl       = 0xf2,
  34         nvme_nvm_admin_set_bb_tbl       = 0xf1,
  35 };
  36
  37 struct nvme_nvm_hb_rw {
  38         __u8                    opcode;
  39         __u8                    flags;
  40         __u16                   command_id;
  41         __le32                  nsid;
  42         __u64                   rsvd2;
  43         __le64                  metadata;
  44         __le64                  prp1;
  45         __le64                  prp2;
  46         __le64                  spba;
  47         __le16                  length;
  48         __le16                  control;
  49         __le32                  dsmgmt;
  50         __le64                  slba;
  51 };
  52
  53 struct nvme_nvm_ph_rw {
  54         __u8                    opcode;
  55         __u8                    flags;
  56         __u16                   command_id;
  57         __le32                  nsid;
  58         __u64                   rsvd2;
  59         __le64                  metadata;
  60         __le64                  prp1;
  61         __le64                  prp2;
  62         __le64                  spba;
  63         __le16                  length;
  64         __le16                  control;
  65         __le32                  dsmgmt;
  66         __le64                  resv;
  67 };
  68
  69 struct nvme_nvm_identity {
  70         __u8                    opcode;
  71         __u8                    flags;
  72         __u16                   command_id;
  73         __le32                  nsid;
  74         __u64                   rsvd[2];
  75         __le64                  prp1;
  76         __le64                  prp2;
  77         __le32                  chnl_off;
  78         __u32                   rsvd11[5];
  79 };
  80
  81 struct nvme_nvm_l2ptbl {
  82         __u8                    opcode;
  83         __u8                    flags;
  84         __u16                   command_id;
  85         __le32                  nsid;
  86         __le32                  cdw2[4];
  87         __le64                  prp1;
  88         __le64                  prp2;
  89         __le64                  slba;
  90         __le32                  nlb;
  91         __le16                  cdw14[6];
  92 };
  93
  94 struct nvme_nvm_getbbtbl {
  95         __u8                    opcode;
  96         __u8                    flags;
  97         __u16                   command_id;
  98         __le32                  nsid;
  99         __u64                   rsvd[2];
 100         __le64                  prp1;
 101         __le64                  prp2;
 102         __le64                  spba;
 103         __u32                   rsvd4[4];
 104 };
 105
 106 struct nvme_nvm_setbbtbl {
 107         __u8                    opcode;
 108         __u8                    flags;
 109         __u16                   command_id;
 110         __le32                  nsid;
 111         __le64                  rsvd[2];
 112         __le64                  prp1;
 113         __le64                  prp2;
 114         __le64                  spba;
 115         __le16                  nlb;
 116         __u8                    value;
 117         __u8                    rsvd3;
 118         __u32                   rsvd4[3];
 119 };
 120
 121 struct nvme_nvm_erase_blk {
 122         __u8                    opcode;
 123         __u8                    flags;
 124         __u16                   command_id;
 125         __le32                  nsid;
 126         __u64                   rsvd[2];
 127         __le64                  prp1;
 128         __le64                  prp2;
 129         __le64                  spba;
 130         __le16                  length;
 131         __le16                  control;
 132         __le32                  dsmgmt;
 133         __le64                  resv;
 134 };
 135
 136 struct nvme_nvm_command {
 137         union {
 138                 struct nvme_common_command common;
 139                 struct nvme_nvm_identity identity;
 140                 struct nvme_nvm_hb_rw hb_rw;
 141                 struct nvme_nvm_ph_rw ph_rw;
 142                 struct nvme_nvm_l2ptbl l2p;
 143                 struct nvme_nvm_getbbtbl get_bb;
 144                 struct nvme_nvm_setbbtbl set_bb;
 145                 struct nvme_nvm_erase_blk erase;
 146         };
 147 };
 148
 149 #define NVME_NVM_LP_MLC_PAIRS 886
 150 struct nvme_nvm_lp_mlc {
 151         __le16                  num_pairs;
 152         __u8                    pairs[NVME_NVM_LP_MLC_PAIRS];
 153 };
 154
 155 struct nvme_nvm_lp_tbl {
 156         __u8                    id[8];
 157         struct nvme_nvm_lp_mlc  mlc;
 158 };
 159
 160 struct nvme_nvm_id_group {
 161         __u8                    mtype;
 162         __u8                    fmtype;
 163         __le16                  res16;
 164         __u8                    num_ch;
 165         __u8                    num_lun;
 166         __u8                    num_pln;
 167         __u8                    rsvd1;
 168         __le16                  num_blk;
 169         __le16                  num_pg;
 170         __le16                  fpg_sz;
 171         __le16                  csecs;
 172         __le16                  sos;
 173         __le16                  rsvd2;
 174         __le32                  trdt;
 175         __le32                  trdm;
 176         __le32                  tprt;
 177         __le32                  tprm;
 178         __le32                  tbet;
 179         __le32                  tbem;
 180         __le32                  mpos;
 181         __le32                  mccap;
 182         __le16                  cpar;
 183         __u8                    reserved[10];
 184         struct nvme_nvm_lp_tbl lptbl;
 185 } __packed;
 186
 187 struct nvme_nvm_addr_format {
 188         __u8                    ch_offset;
 189         __u8                    ch_len;
 190         __u8                    lun_offset;
 191         __u8                    lun_len;
 192         __u8                    pln_offset;
 193         __u8                    pln_len;
 194         __u8                    blk_offset;
 195         __u8                    blk_len;
 196         __u8                    pg_offset;
 197         __u8                    pg_len;
 198         __u8                    sect_offset;
 199         __u8                    sect_len;
 200         __u8                    res[4];
 201 } __packed;
 202
 203 struct nvme_nvm_id {
 204         __u8                    ver_id;
 205         __u8                    vmnt;
 206         __u8                    cgrps;
 207         __u8                    res;
 208         __le32                  cap;
 209         __le32                  dom;
 210         struct nvme_nvm_addr_format ppaf;
 211         __u8                    resv[228];
 212         struct nvme_nvm_id_group groups[4];
 213 } __packed;
 214
 215 struct nvme_nvm_bb_tbl {
 216         __u8    tblid[4];
 217         __le16  verid;
 218         __le16  revid;
 219         __le32  rvsd1;
 220         __le32  tblks;
 221         __le32  tfact;
 222         __le32  tgrown;
 223         __le32  tdresv;
 224         __le32  thresv;
 225         __le32  rsvd2[8];
 226         __u8    blk[0];
 227 };
 228
 229 /*
 230  * Check we didn't inadvertently grow the command struct
 231  */
 232 static inline void _nvme_nvm_check_size(void)
 233 {
 234         BUILD_BUG_ON(sizeof(struct nvme_nvm_identity) != 64);
 235         BUILD_BUG_ON(sizeof(struct nvme_nvm_hb_rw) != 64);
 236         BUILD_BUG_ON(sizeof(struct nvme_nvm_ph_rw) != 64);
 237         BUILD_BUG_ON(sizeof(struct nvme_nvm_getbbtbl) != 64);
 238         BUILD_BUG_ON(sizeof(struct nvme_nvm_setbbtbl) != 64);
 239         BUILD_BUG_ON(sizeof(struct nvme_nvm_l2ptbl) != 64);
 240         BUILD_BUG_ON(sizeof(struct nvme_nvm_erase_blk) != 64);
 241         BUILD_BUG_ON(sizeof(struct nvme_nvm_id_group) != 960);
 242         BUILD_BUG_ON(sizeof(struct nvme_nvm_addr_format) != 128);
 243         BUILD_BUG_ON(sizeof(struct nvme_nvm_id) != 4096);
 244         BUILD_BUG_ON(sizeof(struct nvme_nvm_bb_tbl) != 512);
 245 }
 246
 247 static int init_grps(struct nvm_id *nvm_id, struct nvme_nvm_id *nvme_nvm_id)
 248 {
 249         struct nvme_nvm_id_group *src;
 250         struct nvm_id_group *dst;
 251         int i, end;
 252
 253         end = min_t(u32, 4, nvm_id->cgrps);
 254
 255         for (i = 0; i < end; i++) {
 256                 src = &nvme_nvm_id->groups[i];
 257                 dst = &nvm_id->groups[i];
 258
 259                 dst->mtype = src->mtype;
 260                 dst->fmtype = src->fmtype;
 261                 dst->num_ch = src->num_ch;
 262                 dst->num_lun = src->num_lun;
 263                 dst->num_pln = src->num_pln;
 264
 265                 dst->num_pg = le16_to_cpu(src->num_pg);
 266                 dst->num_blk = le16_to_cpu(src->num_blk);
 267                 dst->fpg_sz = le16_to_cpu(src->fpg_sz);
 268                 dst->csecs = le16_to_cpu(src->csecs);
 269                 dst->sos = le16_to_cpu(src->sos);
 270
 271                 dst->trdt = le32_to_cpu(src->trdt);
 272                 dst->trdm = le32_to_cpu(src->trdm);
 273                 dst->tprt = le32_to_cpu(src->tprt);
 274                 dst->tprm = le32_to_cpu(src->tprm);
 275                 dst->tbet = le32_to_cpu(src->tbet);
 276                 dst->tbem = le32_to_cpu(src->tbem);
 277                 dst->mpos = le32_to_cpu(src->mpos);
 278                 dst->mccap = le32_to_cpu(src->mccap);
 279
 280                 dst->cpar = le16_to_cpu(src->cpar);
 281
 282                 if (dst->fmtype == NVM_ID_FMTYPE_MLC) {
 283                         memcpy(dst->lptbl.id, src->lptbl.id, 8);
 284                         dst->lptbl.mlc.num_pairs =
 285                                         le16_to_cpu(src->lptbl.mlc.num_pairs);
 286
 287                         if (dst->lptbl.mlc.num_pairs > NVME_NVM_LP_MLC_PAIRS) {
 288                                 pr_err("nvm: number of MLC pairs not supported\n");
 289                                 return -EINVAL;
 290                         }
 291
 292                         memcpy(dst->lptbl.mlc.pairs, src->lptbl.mlc.pairs,
 293                                                 dst->lptbl.mlc.num_pairs);
 294                 }
 295         }
 296
 297         return 0;
 298 }
 299
 300 static int nvme_nvm_identity(struct nvm_dev *nvmdev, struct nvm_id *nvm_id)
 301 {
 302         struct nvme_ns *ns = nvmdev->q->queuedata;
 303         struct nvme_nvm_id *nvme_nvm_id;
 304         struct nvme_nvm_command c = {};
 305         int ret;
 306
 307         c.identity.opcode = nvme_nvm_admin_identity;
 308         c.identity.nsid = cpu_to_le32(ns->ns_id);
 309         c.identity.chnl_off = 0;
 310
 311         nvme_nvm_id = kmalloc(sizeof(struct nvme_nvm_id), GFP_KERNEL);
 312         if (!nvme_nvm_id)
 313                 return -ENOMEM;
 314
 315         ret = nvme_submit_sync_cmd(ns->ctrl->admin_q, (struct nvme_command *)&c,
 316                                 nvme_nvm_id, sizeof(struct nvme_nvm_id));
 317         if (ret) {
 318                 ret = -EIO;
 319                 goto out;
 320         }
 321
 322         nvm_id->ver_id = nvme_nvm_id->ver_id;
 323         nvm_id->vmnt = nvme_nvm_id->vmnt;
 324         nvm_id->cgrps = nvme_nvm_id->cgrps;
 325         nvm_id->cap = le32_to_cpu(nvme_nvm_id->cap);
 326         nvm_id->dom = le32_to_cpu(nvme_nvm_id->dom);
 327         memcpy(&nvm_id->ppaf, &nvme_nvm_id->ppaf,
 328                                         sizeof(struct nvme_nvm_addr_format));
 329
 330         ret = init_grps(nvm_id, nvme_nvm_id);
 331 out:
 332         kfree(nvme_nvm_id);
 333         return ret;
 334 }
 335
 336 static int nvme_nvm_get_l2p_tbl(struct nvm_dev *nvmdev, u64 slba, u32 nlb,
 337                                 nvm_l2p_update_fn *update_l2p, void *priv)
 338 {
 339         struct nvme_ns *ns = nvmdev->q->queuedata;
 340         struct nvme_nvm_command c = {};
 341         u32 len = queue_max_hw_sectors(ns->ctrl->admin_q) << 9;
 342         u32 nlb_pr_rq = len / sizeof(u64);
 343         u64 cmd_slba = slba;
 344         void *entries;
 345         int ret = 0;
 346
 347         c.l2p.opcode = nvme_nvm_admin_get_l2p_tbl;
 348         c.l2p.nsid = cpu_to_le32(ns->ns_id);
 349         entries = kmalloc(len, GFP_KERNEL);
 350         if (!entries)
 351                 return -ENOMEM;
 352
 353         while (nlb) {
 354                 u32 cmd_nlb = min(nlb_pr_rq, nlb);
 355                 u64 elba = slba + cmd_nlb;
 356
 357                 c.l2p.slba = cpu_to_le64(cmd_slba);
 358                 c.l2p.nlb = cpu_to_le32(cmd_nlb);
 359
 360                 ret = nvme_submit_sync_cmd(ns->ctrl->admin_q,
 361                                 (struct nvme_command *)&c, entries, len);
 362                 if (ret) {
 363                         dev_err(ns->ctrl->device,
 364                                 "L2P table transfer failed (%d)\n", ret);
 365                         ret = -EIO;
 366                         goto out;
 367                 }
 368
 369                 if (unlikely(elba > nvmdev->total_secs)) {
 370                         pr_err("nvm: L2P data from device is out of bounds!\n");
 371                         return -EINVAL;
 372                 }
 373
 374                 /* Transform physical address to target address space */
 375                 nvm_part_to_tgt(nvmdev, entries, cmd_nlb);
 376
 377                 if (update_l2p(cmd_slba, cmd_nlb, entries, priv)) {
 378                         ret = -EINTR;
 379                         goto out;
 380                 }
 381
 382                 cmd_slba += cmd_nlb;
 383                 nlb -= cmd_nlb;
 384         }
 385
 386 out:
 387         kfree(entries);
 388         return ret;
 389 }
 390
 391 static int nvme_nvm_get_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr ppa,
 392                                                                 u8 *blks)
 393 {
 394         struct request_queue *q = nvmdev->q;
 395         struct nvm_geo *geo = &nvmdev->geo;
 396         struct nvme_ns *ns = q->queuedata;
 397         struct nvme_ctrl *ctrl = ns->ctrl;
 398         struct nvme_nvm_command c = {};
 399         struct nvme_nvm_bb_tbl *bb_tbl;
 400         int nr_blks = geo->blks_per_lun * geo->plane_mode;
 401         int tblsz = sizeof(struct nvme_nvm_bb_tbl) + nr_blks;
 402         int ret = 0;
 403
 404         c.get_bb.opcode = nvme_nvm_admin_get_bb_tbl;
 405         c.get_bb.nsid = cpu_to_le32(ns->ns_id);
 406         c.get_bb.spba = cpu_to_le64(ppa.ppa);
 407
 408         bb_tbl = kzalloc(tblsz, GFP_KERNEL);
 409         if (!bb_tbl)
 410                 return -ENOMEM;
 411
 412         ret = nvme_submit_sync_cmd(ctrl->admin_q, (struct nvme_command *)&c,
 413                                                                 bb_tbl, tblsz);
 414         if (ret) {
 415                 dev_err(ctrl->device, "get bad block table failed (%d)\n", ret);
 416                 ret = -EIO;
 417                 goto out;
 418         }
 419
 420         if (bb_tbl->tblid[0] != 'B' || bb_tbl->tblid[1] != 'B' ||
 421                 bb_tbl->tblid[2] != 'L' || bb_tbl->tblid[3] != 'T') {
 422                 dev_err(ctrl->device, "bbt format mismatch\n");
 423                 ret = -EINVAL;
 424                 goto out;
 425         }
 426
 427         if (le16_to_cpu(bb_tbl->verid) != 1) {
 428                 ret = -EINVAL;
 429                 dev_err(ctrl->device, "bbt version not supported\n");
 430                 goto out;
 431         }
 432
 433         if (le32_to_cpu(bb_tbl->tblks) != nr_blks) {
 434                 ret = -EINVAL;
 435                 dev_err(ctrl->device,
 436                                 "bbt unsuspected blocks returned (%u!=%u)",
 437                                 le32_to_cpu(bb_tbl->tblks), nr_blks);
 438                 goto out;
 439         }
 440
 441         memcpy(blks, bb_tbl->blk, geo->blks_per_lun * geo->plane_mode);
 442 out:
 443         kfree(bb_tbl);
 444         return ret;
 445 }
 446
 447 static int nvme_nvm_set_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr *ppas,
 448                                                         int nr_ppas, int type)
 449 {
 450         struct nvme_ns *ns = nvmdev->q->queuedata;
 451         struct nvme_nvm_command c = {};
 452         int ret = 0;
 453
 454         c.set_bb.opcode = nvme_nvm_admin_set_bb_tbl;
 455         c.set_bb.nsid = cpu_to_le32(ns->ns_id);
 456         c.set_bb.spba = cpu_to_le64(ppas->ppa);
 457         c.set_bb.nlb = cpu_to_le16(nr_ppas - 1);
 458         c.set_bb.value = type;
 459
 460         ret = nvme_submit_sync_cmd(ns->ctrl->admin_q, (struct nvme_command *)&c,
 461                                                                 NULL, 0);
 462         if (ret)
 463                 dev_err(ns->ctrl->device, "set bad block table failed (%d)\n",
 464                                                                         ret);
 465         return ret;
 466 }
 467
 468 static inline void nvme_nvm_rqtocmd(struct request *rq, struct nvm_rq *rqd,
 469                                 struct nvme_ns *ns, struct nvme_nvm_command *c)
 470 {
 471         c->ph_rw.opcode = rqd->opcode;
 472         c->ph_rw.nsid = cpu_to_le32(ns->ns_id);
 473         c->ph_rw.spba = cpu_to_le64(rqd->ppa_addr.ppa);
 474         c->ph_rw.metadata = cpu_to_le64(rqd->dma_meta_list);
 475         c->ph_rw.control = cpu_to_le16(rqd->flags);
 476         c->ph_rw.length = cpu_to_le16(rqd->nr_ppas - 1);
 477
 478         if (rqd->opcode == NVM_OP_HBWRITE || rqd->opcode == NVM_OP_HBREAD)
 479                 c->hb_rw.slba = cpu_to_le64(nvme_block_nr(ns,
 480                                         rqd->bio->bi_iter.bi_sector));
 481 }
 482
 483 static void nvme_nvm_end_io(struct request *rq, int error)
 484 {
 485         struct nvm_rq *rqd = rq->end_io_data;
 486
 487         rqd->ppa_status = nvme_req(rq)->result.u64;
 488         nvm_end_io(rqd, error);
 489
 490         kfree(nvme_req(rq)->cmd);
 491         blk_mq_free_request(rq);
 492 }
 493
 494 static int nvme_nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
 495 {
 496         struct request_queue *q = dev->q;
 497         struct nvme_ns *ns = q->queuedata;
 498         struct request *rq;
 499         struct bio *bio = rqd->bio;
 500         struct nvme_nvm_command *cmd;
 501
 502         cmd = kzalloc(sizeof(struct nvme_nvm_command), GFP_KERNEL);
 503         if (!cmd)
 504                 return -ENOMEM;
 505
 506         rq = nvme_alloc_request(q, (struct nvme_command *)cmd, 0, NVME_QID_ANY);
 507         if (IS_ERR(rq)) {
 508                 kfree(cmd);
 509                 return -ENOMEM;
 510         }
 511         rq->cmd_flags &= ~REQ_FAILFAST_DRIVER;
 512
 513         rq->ioprio = bio_prio(bio);
 514         if (bio_has_data(bio))
 515                 rq->nr_phys_segments = bio_phys_segments(q, bio);
 516
 517         rq->__data_len = bio->bi_iter.bi_size;
 518         rq->bio = rq->biotail = bio;
 519
 520         nvme_nvm_rqtocmd(rq, rqd, ns, cmd);
 521
 522         rq->end_io_data = rqd;
 523
 524         blk_execute_rq_nowait(q, NULL, rq, 0, nvme_nvm_end_io);
 525
 526         return 0;
 527 }
 528
 529 static int nvme_nvm_erase_block(struct nvm_dev *dev, struct nvm_rq *rqd)
 530 {
 531         struct request_queue *q = dev->q;
 532         struct nvme_ns *ns = q->queuedata;
 533         struct nvme_nvm_command c = {};
 534
 535         c.erase.opcode = NVM_OP_ERASE;
 536         c.erase.nsid = cpu_to_le32(ns->ns_id);
 537         c.erase.spba = cpu_to_le64(rqd->ppa_addr.ppa);
 538         c.erase.length = cpu_to_le16(rqd->nr_ppas - 1);
 539         c.erase.control = cpu_to_le16(rqd->flags);
 540
 541         return nvme_submit_sync_cmd(q, (struct nvme_command *)&c, NULL, 0);
 542 }
 543
 544 static void *nvme_nvm_create_dma_pool(struct nvm_dev *nvmdev, char *name)
 545 {
 546         struct nvme_ns *ns = nvmdev->q->queuedata;
 547
 548         return dma_pool_create(name, ns->ctrl->dev, PAGE_SIZE, PAGE_SIZE, 0);
 549 }
 550
 551 static void nvme_nvm_destroy_dma_pool(void *pool)
 552 {
 553         struct dma_pool *dma_pool = pool;
 554
 555         dma_pool_destroy(dma_pool);
 556 }
 557
 558 static void *nvme_nvm_dev_dma_alloc(struct nvm_dev *dev, void *pool,
 559                                     gfp_t mem_flags, dma_addr_t *dma_handler)
 560 {
 561         return dma_pool_alloc(pool, mem_flags, dma_handler);
 562 }
 563
 564 static void nvme_nvm_dev_dma_free(void *pool, void *addr,
 565                                                         dma_addr_t dma_handler)
 566 {
 567         dma_pool_free(pool, addr, dma_handler);
 568 }
 569
 570 static struct nvm_dev_ops nvme_nvm_dev_ops = {
 571         .identity               = nvme_nvm_identity,
 572
 573         .get_l2p_tbl            = nvme_nvm_get_l2p_tbl,
 574
 575         .get_bb_tbl             = nvme_nvm_get_bb_tbl,
 576         .set_bb_tbl             = nvme_nvm_set_bb_tbl,
 577
 578         .submit_io              = nvme_nvm_submit_io,
 579         .erase_block            = nvme_nvm_erase_block,
 580
 581         .create_dma_pool        = nvme_nvm_create_dma_pool,
 582         .destroy_dma_pool       = nvme_nvm_destroy_dma_pool,
 583         .dev_dma_alloc          = nvme_nvm_dev_dma_alloc,
 584         .dev_dma_free           = nvme_nvm_dev_dma_free,
 585
 586         .max_phys_sect          = 64,
 587 };
 588
 589 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node)
 590 {
 591         struct request_queue *q = ns->queue;
 592         struct nvm_dev *dev;
 593
 594         dev = nvm_alloc_dev(node);
 595         if (!dev)
 596                 return -ENOMEM;
 597
 598         dev->q = q;
 599         memcpy(dev->name, disk_name, DISK_NAME_LEN);
 600         dev->ops = &nvme_nvm_dev_ops;
 601         dev->private_data = ns;
 602         ns->ndev = dev;
 603
 604         return nvm_register(dev);
 605 }
 606
 607 void nvme_nvm_unregister(struct nvme_ns *ns)
 608 {
 609         nvm_unregister(ns->ndev);
 610 }
 611
 612 static ssize_t nvm_dev_attr_show(struct device *dev,
 613                                  struct device_attribute *dattr, char *page)
 614 {
 615         struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
 616         struct nvm_dev *ndev = ns->ndev;
 617         struct nvm_id *id;
 618         struct nvm_id_group *grp;
 619         struct attribute *attr;
 620
 621         if (!ndev)
 622                 return 0;
 623
 624         id = &ndev->identity;
 625         grp = &id->groups[0];
 626         attr = &dattr->attr;
 627
 628         if (strcmp(attr->name, "version") == 0) {
 629                 return scnprintf(page, PAGE_SIZE, "%u\n", id->ver_id);
 630         } else if (strcmp(attr->name, "vendor_opcode") == 0) {
 631                 return scnprintf(page, PAGE_SIZE, "%u\n", id->vmnt);
 632         } else if (strcmp(attr->name, "capabilities") == 0) {
 633                 return scnprintf(page, PAGE_SIZE, "%u\n", id->cap);
 634         } else if (strcmp(attr->name, "device_mode") == 0) {
 635                 return scnprintf(page, PAGE_SIZE, "%u\n", id->dom);
 636         /* kept for compatibility */
 637         } else if (strcmp(attr->name, "media_manager") == 0) {
 638                 return scnprintf(page, PAGE_SIZE, "%s\n", "gennvm");
 639         } else if (strcmp(attr->name, "ppa_format") == 0) {
 640                 return scnprintf(page, PAGE_SIZE,
 641                         "0x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x\n",
 642                         id->ppaf.ch_offset, id->ppaf.ch_len,
 643                         id->ppaf.lun_offset, id->ppaf.lun_len,
 644                         id->ppaf.pln_offset, id->ppaf.pln_len,
 645                         id->ppaf.blk_offset, id->ppaf.blk_len,
 646                         id->ppaf.pg_offset, id->ppaf.pg_len,
 647                         id->ppaf.sect_offset, id->ppaf.sect_len);
 648         } else if (strcmp(attr->name, "media_type") == 0) {     /* u8 */
 649                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->mtype);
 650         } else if (strcmp(attr->name, "flash_media_type") == 0) {
 651                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->fmtype);
 652         } else if (strcmp(attr->name, "num_channels") == 0) {
 653                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->num_ch);
 654         } else if (strcmp(attr->name, "num_luns") == 0) {
 655                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->num_lun);
 656         } else if (strcmp(attr->name, "num_planes") == 0) {
 657                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->num_pln);
 658         } else if (strcmp(attr->name, "num_blocks") == 0) {     /* u16 */
 659                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->num_blk);
 660         } else if (strcmp(attr->name, "num_pages") == 0) {
 661                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->num_pg);
 662         } else if (strcmp(attr->name, "page_size") == 0) {
 663                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->fpg_sz);
 664         } else if (strcmp(attr->name, "hw_sector_size") == 0) {
 665                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->csecs);
 666         } else if (strcmp(attr->name, "oob_sector_size") == 0) {/* u32 */
 667                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->sos);
 668         } else if (strcmp(attr->name, "read_typ") == 0) {
 669                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->trdt);
 670         } else if (strcmp(attr->name, "read_max") == 0) {
 671                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->trdm);
 672         } else if (strcmp(attr->name, "prog_typ") == 0) {
 673                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->tprt);
 674         } else if (strcmp(attr->name, "prog_max") == 0) {
 675                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->tprm);
 676         } else if (strcmp(attr->name, "erase_typ") == 0) {
 677                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->tbet);
 678         } else if (strcmp(attr->name, "erase_max") == 0) {
 679                 return scnprintf(page, PAGE_SIZE, "%u\n", grp->tbem);
 680         } else if (strcmp(attr->name, "multiplane_modes") == 0) {
 681                 return scnprintf(page, PAGE_SIZE, "0x%08x\n", grp->mpos);
 682         } else if (strcmp(attr->name, "media_capabilities") == 0) {
 683                 return scnprintf(page, PAGE_SIZE, "0x%08x\n", grp->mccap);
 684         } else if (strcmp(attr->name, "max_phys_secs") == 0) {
 685                 return scnprintf(page, PAGE_SIZE, "%u\n",
 686                                 ndev->ops->max_phys_sect);
 687         } else {
 688                 return scnprintf(page,
 689                                  PAGE_SIZE,
 690                                  "Unhandled attr(%s) in `nvm_dev_attr_show`\n",
 691                                  attr->name);
 692         }
 693 }
 694
 695 #define NVM_DEV_ATTR_RO(_name)                                          \
 696         DEVICE_ATTR(_name, S_IRUGO, nvm_dev_attr_show, NULL)
 697
 698 static NVM_DEV_ATTR_RO(version);
 699 static NVM_DEV_ATTR_RO(vendor_opcode);
 700 static NVM_DEV_ATTR_RO(capabilities);
 701 static NVM_DEV_ATTR_RO(device_mode);
 702 static NVM_DEV_ATTR_RO(ppa_format);
 703 static NVM_DEV_ATTR_RO(media_manager);
 704
 705 static NVM_DEV_ATTR_RO(media_type);
 706 static NVM_DEV_ATTR_RO(flash_media_type);
 707 static NVM_DEV_ATTR_RO(num_channels);
 708 static NVM_DEV_ATTR_RO(num_luns);
 709 static NVM_DEV_ATTR_RO(num_planes);
 710 static NVM_DEV_ATTR_RO(num_blocks);
 711 static NVM_DEV_ATTR_RO(num_pages);
 712 static NVM_DEV_ATTR_RO(page_size);
 713 static NVM_DEV_ATTR_RO(hw_sector_size);
 714 static NVM_DEV_ATTR_RO(oob_sector_size);
 715 static NVM_DEV_ATTR_RO(read_typ);
 716 static NVM_DEV_ATTR_RO(read_max);
 717 static NVM_DEV_ATTR_RO(prog_typ);
 718 static NVM_DEV_ATTR_RO(prog_max);
 719 static NVM_DEV_ATTR_RO(erase_typ);
 720 static NVM_DEV_ATTR_RO(erase_max);
 721 static NVM_DEV_ATTR_RO(multiplane_modes);
 722 static NVM_DEV_ATTR_RO(media_capabilities);
 723 static NVM_DEV_ATTR_RO(max_phys_secs);
 724
 725 static struct attribute *nvm_dev_attrs[] = {
 726         &dev_attr_version.attr,
 727         &dev_attr_vendor_opcode.attr,
 728         &dev_attr_capabilities.attr,
 729         &dev_attr_device_mode.attr,
 730         &dev_attr_media_manager.attr,
 731
 732         &dev_attr_ppa_format.attr,
 733         &dev_attr_media_type.attr,
 734         &dev_attr_flash_media_type.attr,
 735         &dev_attr_num_channels.attr,
 736         &dev_attr_num_luns.attr,
 737         &dev_attr_num_planes.attr,
 738         &dev_attr_num_blocks.attr,
 739         &dev_attr_num_pages.attr,
 740         &dev_attr_page_size.attr,
 741         &dev_attr_hw_sector_size.attr,
 742         &dev_attr_oob_sector_size.attr,
 743         &dev_attr_read_typ.attr,
 744         &dev_attr_read_max.attr,
 745         &dev_attr_prog_typ.attr,
 746         &dev_attr_prog_max.attr,
 747         &dev_attr_erase_typ.attr,
 748         &dev_attr_erase_max.attr,
 749         &dev_attr_multiplane_modes.attr,
 750         &dev_attr_media_capabilities.attr,
 751         &dev_attr_max_phys_secs.attr,
 752         NULL,
 753 };
 754
 755 static const struct attribute_group nvm_dev_attr_group = {
 756         .name           = "lightnvm",
 757         .attrs          = nvm_dev_attrs,
 758 };
 759
 760 int nvme_nvm_register_sysfs(struct nvme_ns *ns)
 761 {
 762         return sysfs_create_group(&disk_to_dev(ns->disk)->kobj,
 763                                         &nvm_dev_attr_group);
 764 }
 765
 766 void nvme_nvm_unregister_sysfs(struct nvme_ns *ns)
 767 {
 768         sysfs_remove_group(&disk_to_dev(ns->disk)->kobj,
 769                                         &nvm_dev_attr_group);
 770 }
 771
 772 /* move to shared place when used in multiple places. */
 773 #define PCI_VENDOR_ID_CNEX 0x1d1d
 774 #define PCI_DEVICE_ID_CNEX_WL 0x2807
 775 #define PCI_DEVICE_ID_CNEX_QEMU 0x1f1f
 776
 777 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
 778 {
 779         struct nvme_ctrl *ctrl = ns->ctrl;
 780         /* XXX: this is poking into PCI structures from generic code! */
 781         struct pci_dev *pdev = to_pci_dev(ctrl->dev);
 782
 783         /* QEMU NVMe simulator - PCI ID + Vendor specific bit */
 784         if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
 785                                 pdev->device == PCI_DEVICE_ID_CNEX_QEMU &&
 786                                                         id->vs[0] == 0x1)
 787                 return 1;
 788
 789         /* CNEX Labs - PCI ID + Vendor specific bit */
 790         if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
 791                                 pdev->device == PCI_DEVICE_ID_CNEX_WL &&
 792                                                         id->vs[0] == 0x1)
 793                 return 1;
 794
 795         return 0;
 796 }