drivers/nvme/host/nvme.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (c) 2011-2014, Intel Corporation.
   4  */
   5
   6 #ifndef _NVME_H
   7 #define _NVME_H
   8
   9 #include <linux/nvme.h>
  10 #include <linux/cdev.h>
  11 #include <linux/pci.h>
  12 #include <linux/kref.h>
  13 #include <linux/blk-mq.h>
  14 #include <linux/lightnvm.h>
  15 #include <linux/sed-opal.h>
  16 #include <linux/fault-inject.h>
  17 #include <linux/rcupdate.h>
  18 #include <linux/wait.h>
  19 #include <linux/t10-pi.h>
  20
  21 #include <trace/events/block.h>
  22
  23 extern unsigned int nvme_io_timeout;
  24 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
  25
  26 extern unsigned int admin_timeout;
  27 #define ADMIN_TIMEOUT   (admin_timeout * HZ)
  28
  29 #define NVME_DEFAULT_KATO       5
  30 #define NVME_KATO_GRACE         10
  31
  32 #ifdef CONFIG_ARCH_NO_SG_CHAIN
  33 #define  NVME_INLINE_SG_CNT  0
  34 #define  NVME_INLINE_METADATA_SG_CNT  0
  35 #else
  36 #define  NVME_INLINE_SG_CNT  2
  37 #define  NVME_INLINE_METADATA_SG_CNT  1
  38 #endif
  39
  40 /*
  41  * Default to a 4K page size, with the intention to update this
  42  * path in the future to accommodate architectures with differing
  43  * kernel and IO page sizes.
  44  */
  45 #define NVME_CTRL_PAGE_SHIFT    12
  46 #define NVME_CTRL_PAGE_SIZE     (1 << NVME_CTRL_PAGE_SHIFT)
  47
  48 extern struct workqueue_struct *nvme_wq;
  49 extern struct workqueue_struct *nvme_reset_wq;
  50 extern struct workqueue_struct *nvme_delete_wq;
  51
  52 enum {
  53         NVME_NS_LBA             = 0,
  54         NVME_NS_LIGHTNVM        = 1,
  55 };
  56
  57 /*
  58  * List of workarounds for devices that required behavior not specified in
  59  * the standard.
  60  */
  61 enum nvme_quirks {
  62         /*
  63          * Prefers I/O aligned to a stripe size specified in a vendor
  64          * specific Identify field.
  65          */
  66         NVME_QUIRK_STRIPE_SIZE                  = (1 << 0),
  67
  68         /*
  69          * The controller doesn't handle Identify value others than 0 or 1
  70          * correctly.
  71          */
  72         NVME_QUIRK_IDENTIFY_CNS                 = (1 << 1),
  73
  74         /*
  75          * The controller deterministically returns O's on reads to
  76          * logical blocks that deallocate was called on.
  77          */
  78         NVME_QUIRK_DEALLOCATE_ZEROES            = (1 << 2),
  79
  80         /*
  81          * The controller needs a delay before starts checking the device
  82          * readiness, which is done by reading the NVME_CSTS_RDY bit.
  83          */
  84         NVME_QUIRK_DELAY_BEFORE_CHK_RDY         = (1 << 3),
  85
  86         /*
  87          * APST should not be used.
  88          */
  89         NVME_QUIRK_NO_APST                      = (1 << 4),
  90
  91         /*
  92          * The deepest sleep state should not be used.
  93          */
  94         NVME_QUIRK_NO_DEEPEST_PS                = (1 << 5),
  95
  96         /*
  97          * Supports the LighNVM command set if indicated in vs[1].
  98          */
  99         NVME_QUIRK_LIGHTNVM                     = (1 << 6),
 100
 101         /*
 102          * Set MEDIUM priority on SQ creation
 103          */
 104         NVME_QUIRK_MEDIUM_PRIO_SQ               = (1 << 7),
 105
 106         /*
 107          * Ignore device provided subnqn.
 108          */
 109         NVME_QUIRK_IGNORE_DEV_SUBNQN            = (1 << 8),
 110
 111         /*
 112          * Broken Write Zeroes.
 113          */
 114         NVME_QUIRK_DISABLE_WRITE_ZEROES         = (1 << 9),
 115
 116         /*
 117          * Force simple suspend/resume path.
 118          */
 119         NVME_QUIRK_SIMPLE_SUSPEND               = (1 << 10),
 120
 121         /*
 122          * Use only one interrupt vector for all queues
 123          */
 124         NVME_QUIRK_SINGLE_VECTOR                = (1 << 11),
 125
 126         /*
 127          * Use non-standard 128 bytes SQEs.
 128          */
 129         NVME_QUIRK_128_BYTES_SQES               = (1 << 12),
 130
 131         /*
 132          * Prevent tag overlap between queues
 133          */
 134         NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
 135
 136         /*
 137          * Don't change the value of the temperature threshold feature
 138          */
 139         NVME_QUIRK_NO_TEMP_THRESH_CHANGE        = (1 << 14),
 140
 141         /*
 142          * The controller doesn't handle the Identify Namespace
 143          * Identification Descriptor list subcommand despite claiming
 144          * NVMe 1.3 compliance.
 145          */
 146         NVME_QUIRK_NO_NS_DESC_LIST              = (1 << 15),
 147
 148         /*
 149          * The controller requires the command_id value be be limited, so skip
 150          * encoding the generation sequence number.
 151          */
 152         NVME_QUIRK_SKIP_CID_GEN                 = (1 << 17),
 153
 154         /*
 155          * Reports garbage in the namespace identifiers (eui64, nguid, uuid).
 156          */
 157         NVME_QUIRK_BOGUS_NID                    = (1 << 18),
 158 };
 159
 160 /*
 161  * Common request structure for NVMe passthrough.  All drivers must have
 162  * this structure as the first member of their request-private data.
 163  */
 164 struct nvme_request {
 165         struct nvme_command     *cmd;
 166         union nvme_result       result;
 167         u8                      genctr;
 168         u8                      retries;
 169         u8                      flags;
 170         u16                     status;
 171         struct nvme_ctrl        *ctrl;
 172 };
 173
 174 /*
 175  * Mark a bio as coming in through the mpath node.
 176  */
 177 #define REQ_NVME_MPATH          REQ_DRV
 178
 179 enum {
 180         NVME_REQ_CANCELLED              = (1 << 0),
 181         NVME_REQ_USERCMD                = (1 << 1),
 182 };
 183
 184 static inline struct nvme_request *nvme_req(struct request *req)
 185 {
 186         return blk_mq_rq_to_pdu(req);
 187 }
 188
 189 static inline u16 nvme_req_qid(struct request *req)
 190 {
 191         if (!req->q->queuedata)
 192                 return 0;
 193         return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1;
 194 }
 195
 196 /* The below value is the specific amount of delay needed before checking
 197  * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 198  * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 199  * found empirically.
 200  */
 201 #define NVME_QUIRK_DELAY_AMOUNT         2300
 202
 203 /*
 204  * enum nvme_ctrl_state: Controller state
 205  *
 206  * @NVME_CTRL_NEW:              New controller just allocated, initial state
 207  * @NVME_CTRL_LIVE:             Controller is connected and I/O capable
 208  * @NVME_CTRL_RESETTING:        Controller is resetting (or scheduled reset)
 209  * @NVME_CTRL_CONNECTING:       Controller is disconnected, now connecting the
 210  *                              transport
 211  * @NVME_CTRL_DELETING:         Controller is deleting (or scheduled deletion)
 212  * @NVME_CTRL_DELETING_NOIO:    Controller is deleting and I/O is not
 213  *                              disabled/failed immediately. This state comes
 214  *                              after all async event processing took place and
 215  *                              before ns removal and the controller deletion
 216  *                              progress
 217  * @NVME_CTRL_DEAD:             Controller is non-present/unresponsive during
 218  *                              shutdown or removal. In this case we forcibly
 219  *                              kill all inflight I/O as they have no chance to
 220  *                              complete
 221  */
 222 enum nvme_ctrl_state {
 223         NVME_CTRL_NEW,
 224         NVME_CTRL_LIVE,
 225         NVME_CTRL_RESETTING,
 226         NVME_CTRL_CONNECTING,
 227         NVME_CTRL_DELETING,
 228         NVME_CTRL_DELETING_NOIO,
 229         NVME_CTRL_DEAD,
 230 };
 231
 232 struct nvme_fault_inject {
 233 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 234         struct fault_attr attr;
 235         struct dentry *parent;
 236         bool dont_retry;        /* DNR, do not retry */
 237         u16 status;             /* status code */
 238 #endif
 239 };
 240
 241 struct nvme_ctrl {
 242         bool comp_seen;
 243         enum nvme_ctrl_state state;
 244         bool identified;
 245         spinlock_t lock;
 246         struct mutex scan_lock;
 247         const struct nvme_ctrl_ops *ops;
 248         struct request_queue *admin_q;
 249         struct request_queue *connect_q;
 250         struct request_queue *fabrics_q;
 251         struct device *dev;
 252         int instance;
 253         int numa_node;
 254         struct blk_mq_tag_set *tagset;
 255         struct blk_mq_tag_set *admin_tagset;
 256         struct list_head namespaces;
 257         struct rw_semaphore namespaces_rwsem;
 258         struct device ctrl_device;
 259         struct device *device;  /* char device */
 260 #ifdef CONFIG_NVME_HWMON
 261         struct device *hwmon_device;
 262 #endif
 263         struct cdev cdev;
 264         struct work_struct reset_work;
 265         struct work_struct delete_work;
 266         wait_queue_head_t state_wq;
 267
 268         struct nvme_subsystem *subsys;
 269         struct list_head subsys_entry;
 270
 271         struct opal_dev *opal_dev;
 272
 273         char name[12];
 274         u16 cntlid;
 275
 276         u32 ctrl_config;
 277         u16 mtfa;
 278         u32 queue_count;
 279
 280         u64 cap;
 281         u32 max_hw_sectors;
 282         u32 max_segments;
 283         u32 max_integrity_segments;
 284 #ifdef CONFIG_BLK_DEV_ZONED
 285         u32 max_zone_append;
 286 #endif
 287         u16 crdt[3];
 288         u16 oncs;
 289         u16 oacs;
 290         u16 nssa;
 291         u16 nr_streams;
 292         u16 sqsize;
 293         u32 max_namespaces;
 294         atomic_t abort_limit;
 295         u8 vwc;
 296         u32 vs;
 297         u32 sgls;
 298         u16 kas;
 299         u8 npss;
 300         u8 apsta;
 301         u16 wctemp;
 302         u16 cctemp;
 303         u32 oaes;
 304         u32 aen_result;
 305         u32 ctratt;
 306         unsigned int shutdown_timeout;
 307         unsigned int kato;
 308         bool subsystem;
 309         unsigned long quirks;
 310         struct nvme_id_power_state psd[32];
 311         struct nvme_effects_log *effects;
 312         struct xarray cels;
 313         struct work_struct scan_work;
 314         struct work_struct async_event_work;
 315         struct delayed_work ka_work;
 316         struct nvme_command ka_cmd;
 317         struct work_struct fw_act_work;
 318         unsigned long events;
 319
 320 #ifdef CONFIG_NVME_MULTIPATH
 321         /* asymmetric namespace access: */
 322         u8 anacap;
 323         u8 anatt;
 324         u32 anagrpmax;
 325         u32 nanagrpid;
 326         struct mutex ana_lock;
 327         struct nvme_ana_rsp_hdr *ana_log_buf;
 328         size_t ana_log_size;
 329         struct timer_list anatt_timer;
 330         struct work_struct ana_work;
 331 #endif
 332
 333         /* Power saving configuration */
 334         u64 ps_max_latency_us;
 335         bool apst_enabled;
 336
 337         /* PCIe only: */
 338         u32 hmpre;
 339         u32 hmmin;
 340         u32 hmminds;
 341         u16 hmmaxd;
 342
 343         /* Fabrics only */
 344         u32 ioccsz;
 345         u32 iorcsz;
 346         u16 icdoff;
 347         u16 maxcmd;
 348         int nr_reconnects;
 349         struct nvmf_ctrl_options *opts;
 350
 351         struct page *discard_page;
 352         unsigned long discard_page_busy;
 353
 354         struct nvme_fault_inject fault_inject;
 355 };
 356
 357 static inline enum nvme_ctrl_state nvme_ctrl_state(struct nvme_ctrl *ctrl)
 358 {
 359         return READ_ONCE(ctrl->state);
 360 }
 361
 362 enum nvme_iopolicy {
 363         NVME_IOPOLICY_NUMA,
 364         NVME_IOPOLICY_RR,
 365 };
 366
 367 struct nvme_subsystem {
 368         int                     instance;
 369         struct device           dev;
 370         /*
 371          * Because we unregister the device on the last put we need
 372          * a separate refcount.
 373          */
 374         struct kref             ref;
 375         struct list_head        entry;
 376         struct mutex            lock;
 377         struct list_head        ctrls;
 378         struct list_head        nsheads;
 379         char                    subnqn[NVMF_NQN_SIZE];
 380         char                    serial[20];
 381         char                    model[40];
 382         char                    firmware_rev[8];
 383         u8                      cmic;
 384         u16                     vendor_id;
 385         u16                     awupf;  /* 0's based awupf value. */
 386         struct ida              ns_ida;
 387 #ifdef CONFIG_NVME_MULTIPATH
 388         enum nvme_iopolicy      iopolicy;
 389 #endif
 390 };
 391
 392 /*
 393  * Container structure for uniqueue namespace identifiers.
 394  */
 395 struct nvme_ns_ids {
 396         u8      eui64[8];
 397         u8      nguid[16];
 398         uuid_t  uuid;
 399         u8      csi;
 400 };
 401
 402 /*
 403  * Anchor structure for namespaces.  There is one for each namespace in a
 404  * NVMe subsystem that any of our controllers can see, and the namespace
 405  * structure for each controller is chained of it.  For private namespaces
 406  * there is a 1:1 relation to our namespace structures, that is ->list
 407  * only ever has a single entry for private namespaces.
 408  */
 409 struct nvme_ns_head {
 410         struct list_head        list;
 411         struct srcu_struct      srcu;
 412         struct nvme_subsystem   *subsys;
 413         unsigned                ns_id;
 414         struct nvme_ns_ids      ids;
 415         struct list_head        entry;
 416         struct kref             ref;
 417         bool                    shared;
 418         int                     instance;
 419         struct nvme_effects_log *effects;
 420 #ifdef CONFIG_NVME_MULTIPATH
 421         struct gendisk          *disk;
 422         struct bio_list         requeue_list;
 423         spinlock_t              requeue_lock;
 424         struct work_struct      requeue_work;
 425         struct mutex            lock;
 426         unsigned long           flags;
 427 #define NVME_NSHEAD_DISK_LIVE   0
 428         struct nvme_ns __rcu    *current_path[];
 429 #endif
 430 };
 431
 432 enum nvme_ns_features {
 433         NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
 434         NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
 435 };
 436
 437 struct nvme_ns {
 438         struct list_head list;
 439
 440         struct nvme_ctrl *ctrl;
 441         struct request_queue *queue;
 442         struct gendisk *disk;
 443 #ifdef CONFIG_NVME_MULTIPATH
 444         enum nvme_ana_state ana_state;
 445         u32 ana_grpid;
 446 #endif
 447         struct list_head siblings;
 448         struct nvm_dev *ndev;
 449         struct kref kref;
 450         struct nvme_ns_head *head;
 451
 452         int lba_shift;
 453         u16 ms;
 454         u16 sgs;
 455         u32 sws;
 456         u8 pi_type;
 457 #ifdef CONFIG_BLK_DEV_ZONED
 458         u64 zsze;
 459 #endif
 460         unsigned long features;
 461         unsigned long flags;
 462 #define NVME_NS_REMOVING        0
 463 #define NVME_NS_DEAD            1
 464 #define NVME_NS_ANA_PENDING     2
 465
 466         struct nvme_fault_inject fault_inject;
 467
 468 };
 469
 470 /* NVMe ns supports metadata actions by the controller (generate/strip) */
 471 static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
 472 {
 473         return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
 474 }
 475
 476 struct nvme_ctrl_ops {
 477         const char *name;
 478         struct module *module;
 479         unsigned int flags;
 480 #define NVME_F_FABRICS                  (1 << 0)
 481 #define NVME_F_METADATA_SUPPORTED       (1 << 1)
 482 #define NVME_F_PCI_P2PDMA               (1 << 2)
 483         int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 484         int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 485         int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 486         void (*free_ctrl)(struct nvme_ctrl *ctrl);
 487         void (*submit_async_event)(struct nvme_ctrl *ctrl);
 488         void (*delete_ctrl)(struct nvme_ctrl *ctrl);
 489         void (*stop_ctrl)(struct nvme_ctrl *ctrl);
 490         int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
 491 };
 492
 493 /*
 494  * nvme command_id is constructed as such:
 495  * | xxxx | xxxxxxxxxxxx |
 496  *   gen    request tag
 497  */
 498 #define nvme_genctr_mask(gen)                   (gen & 0xf)
 499 #define nvme_cid_install_genctr(gen)            (nvme_genctr_mask(gen) << 12)
 500 #define nvme_genctr_from_cid(cid)               ((cid & 0xf000) >> 12)
 501 #define nvme_tag_from_cid(cid)                  (cid & 0xfff)
 502
 503 static inline u16 nvme_cid(struct request *rq)
 504 {
 505         return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag;
 506 }
 507
 508 static inline struct request *nvme_find_rq(struct blk_mq_tags *tags,
 509                 u16 command_id)
 510 {
 511         u8 genctr = nvme_genctr_from_cid(command_id);
 512         u16 tag = nvme_tag_from_cid(command_id);
 513         struct request *rq;
 514
 515         rq = blk_mq_tag_to_rq(tags, tag);
 516         if (unlikely(!rq)) {
 517                 pr_err("could not locate request for tag %#x\n",
 518                         tag);
 519                 return NULL;
 520         }
 521         if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) {
 522                 dev_err(nvme_req(rq)->ctrl->device,
 523                         "request %#x genctr mismatch (got %#x expected %#x)\n",
 524                         tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr));
 525                 return NULL;
 526         }
 527         return rq;
 528 }
 529
 530 static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags,
 531                 u16 command_id)
 532 {
 533         return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id));
 534 }
 535
 536 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 537 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 538                             const char *dev_name);
 539 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
 540 void nvme_should_fail(struct request *req);
 541 #else
 542 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 543                                           const char *dev_name)
 544 {
 545 }
 546 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
 547 {
 548 }
 549 static inline void nvme_should_fail(struct request *req) {}
 550 #endif
 551
 552 bool nvme_wait_reset(struct nvme_ctrl *ctrl);
 553 int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
 554
 555 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 556 {
 557         int ret;
 558
 559         if (!ctrl->subsystem)
 560                 return -ENOTTY;
 561         if (!nvme_wait_reset(ctrl))
 562                 return -EBUSY;
 563
 564         ret = ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
 565         if (ret)
 566                 return ret;
 567
 568         return nvme_try_sched_reset(ctrl);
 569 }
 570
 571 /*
 572  * Convert a 512B sector number to a device logical block number.
 573  */
 574 static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector)
 575 {
 576         return sector >> (ns->lba_shift - SECTOR_SHIFT);
 577 }
 578
 579 /*
 580  * Convert a device logical block number to a 512B sector number.
 581  */
 582 static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba)
 583 {
 584         return lba << (ns->lba_shift - SECTOR_SHIFT);
 585 }
 586
 587 /*
 588  * Convert byte length to nvme's 0-based num dwords
 589  */
 590 static inline u32 nvme_bytes_to_numd(size_t len)
 591 {
 592         return (len >> 2) - 1;
 593 }
 594
 595 static inline bool nvme_is_ana_error(u16 status)
 596 {
 597         switch (status & 0x7ff) {
 598         case NVME_SC_ANA_TRANSITION:
 599         case NVME_SC_ANA_INACCESSIBLE:
 600         case NVME_SC_ANA_PERSISTENT_LOSS:
 601                 return true;
 602         default:
 603                 return false;
 604         }
 605 }
 606
 607 static inline bool nvme_is_path_error(u16 status)
 608 {
 609         /* check for a status code type of 'path related status' */
 610         return (status & 0x700) == 0x300;
 611 }
 612
 613 /*
 614  * Fill in the status and result information from the CQE, and then figure out
 615  * if blk-mq will need to use IPI magic to complete the request, and if yes do
 616  * so.  If not let the caller complete the request without an indirect function
 617  * call.
 618  */
 619 static inline bool nvme_try_complete_req(struct request *req, __le16 status,
 620                 union nvme_result result)
 621 {
 622         struct nvme_request *rq = nvme_req(req);
 623
 624         rq->status = le16_to_cpu(status) >> 1;
 625         rq->result = result;
 626         /* inject error when permitted by fault injection framework */
 627         nvme_should_fail(req);
 628         if (unlikely(blk_should_fake_timeout(req->q)))
 629                 return true;
 630         return blk_mq_complete_request_remote(req);
 631 }
 632
 633 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
 634 {
 635         get_device(ctrl->device);
 636 }
 637
 638 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
 639 {
 640         put_device(ctrl->device);
 641 }
 642
 643 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
 644 {
 645         return !qid &&
 646                 nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH;
 647 }
 648
 649 void nvme_complete_rq(struct request *req);
 650 bool nvme_cancel_request(struct request *req, void *data, bool reserved);
 651 void nvme_cancel_tagset(struct nvme_ctrl *ctrl);
 652 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl);
 653 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
 654                 enum nvme_ctrl_state new_state);
 655 int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
 656 int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
 657 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
 658 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 659                 const struct nvme_ctrl_ops *ops, unsigned long quirks);
 660 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 661 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
 662 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
 663 int nvme_init_identify(struct nvme_ctrl *ctrl);
 664
 665 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 666
 667 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
 668                 bool send);
 669
 670 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
 671                 volatile union nvme_result *res);
 672
 673 void nvme_stop_queues(struct nvme_ctrl *ctrl);
 674 void nvme_start_queues(struct nvme_ctrl *ctrl);
 675 void nvme_kill_queues(struct nvme_ctrl *ctrl);
 676 void nvme_sync_queues(struct nvme_ctrl *ctrl);
 677 void nvme_sync_io_queues(struct nvme_ctrl *ctrl);
 678 void nvme_unfreeze(struct nvme_ctrl *ctrl);
 679 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
 680 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
 681 void nvme_start_freeze(struct nvme_ctrl *ctrl);
 682
 683 #define NVME_QID_ANY -1
 684 struct request *nvme_alloc_request(struct request_queue *q,
 685                 struct nvme_command *cmd, blk_mq_req_flags_t flags);
 686 struct request *nvme_alloc_request_qid(struct request_queue *q,
 687                 struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
 688 void nvme_cleanup_cmd(struct request *req);
 689 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
 690                 struct nvme_command *cmd);
 691 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 692                 void *buf, unsigned bufflen);
 693 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 694                 union nvme_result *result, void *buffer, unsigned bufflen,
 695                 unsigned timeout, int qid, int at_head,
 696                 blk_mq_req_flags_t flags, bool poll);
 697 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
 698                       unsigned int dword11, void *buffer, size_t buflen,
 699                       u32 *result);
 700 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
 701                       unsigned int dword11, void *buffer, size_t buflen,
 702                       u32 *result);
 703 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 704 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
 705 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
 706 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
 707 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
 708
 709 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
 710                 void *log, size_t size, u64 offset);
 711 struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
 712                 struct nvme_ns_head **head, int *srcu_idx);
 713 void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx);
 714
 715 extern const struct attribute_group *nvme_ns_id_attr_groups[];
 716 extern const struct block_device_operations nvme_ns_head_ops;
 717
 718 #ifdef CONFIG_NVME_MULTIPATH
 719 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
 720 {
 721         return ctrl->ana_log_buf != NULL;
 722 }
 723
 724 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
 725 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
 726 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
 727 void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
 728                         struct nvme_ctrl *ctrl, int *flags);
 729 void nvme_failover_req(struct request *req);
 730 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
 731 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
 732 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
 733 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
 734 int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
 735 void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl);
 736 void nvme_mpath_update(struct nvme_ctrl *ctrl);
 737 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
 738 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
 739 bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
 740 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
 741 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
 742 blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
 743
 744 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
 745 {
 746         struct nvme_ns_head *head = ns->head;
 747
 748         if (head->disk && list_empty(&head->list))
 749                 kblockd_schedule_work(&head->requeue_work);
 750 }
 751
 752 static inline void nvme_trace_bio_complete(struct request *req,
 753         blk_status_t status)
 754 {
 755         struct nvme_ns *ns = req->q->queuedata;
 756
 757         if ((req->cmd_flags & REQ_NVME_MPATH) && req->bio)
 758                 trace_block_bio_complete(ns->head->disk->queue, req->bio);
 759 }
 760
 761 extern struct device_attribute dev_attr_ana_grpid;
 762 extern struct device_attribute dev_attr_ana_state;
 763 extern struct device_attribute subsys_attr_iopolicy;
 764
 765 #else
 766 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
 767 {
 768         return false;
 769 }
 770 /*
 771  * Without the multipath code enabled, multiple controller per subsystems are
 772  * visible as devices and thus we cannot use the subsystem instance.
 773  */
 774 static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
 775                                       struct nvme_ctrl *ctrl, int *flags)
 776 {
 777         sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
 778 }
 779
 780 static inline void nvme_failover_req(struct request *req)
 781 {
 782 }
 783 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
 784 {
 785 }
 786 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
 787                 struct nvme_ns_head *head)
 788 {
 789         return 0;
 790 }
 791 static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
 792                 struct nvme_id_ns *id)
 793 {
 794 }
 795 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
 796 {
 797 }
 798 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
 799 {
 800         return false;
 801 }
 802 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
 803 {
 804 }
 805 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
 806 {
 807 }
 808 static inline void nvme_trace_bio_complete(struct request *req,
 809         blk_status_t status)
 810 {
 811 }
 812 static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl)
 813 {
 814 }
 815 static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl,
 816                 struct nvme_id_ctrl *id)
 817 {
 818         if (ctrl->subsys->cmic & (1 << 3))
 819                 dev_warn(ctrl->device,
 820 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
 821         return 0;
 822 }
 823 static inline void nvme_mpath_update(struct nvme_ctrl *ctrl)
 824 {
 825 }
 826 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
 827 {
 828 }
 829 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
 830 {
 831 }
 832 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
 833 {
 834 }
 835 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
 836 {
 837 }
 838 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
 839 {
 840 }
 841 #endif /* CONFIG_NVME_MULTIPATH */
 842
 843 int nvme_revalidate_zones(struct nvme_ns *ns);
 844 #ifdef CONFIG_BLK_DEV_ZONED
 845 int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf);
 846 int nvme_report_zones(struct gendisk *disk, sector_t sector,
 847                       unsigned int nr_zones, report_zones_cb cb, void *data);
 848
 849 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
 850                                        struct nvme_command *cmnd,
 851                                        enum nvme_zone_mgmt_action action);
 852 #else
 853 #define nvme_report_zones NULL
 854
 855 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
 856                 struct request *req, struct nvme_command *cmnd,
 857                 enum nvme_zone_mgmt_action action)
 858 {
 859         return BLK_STS_NOTSUPP;
 860 }
 861
 862 static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf)
 863 {
 864         dev_warn(ns->ctrl->device,
 865                  "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n");
 866         return -EPROTONOSUPPORT;
 867 }
 868 #endif
 869
 870 #ifdef CONFIG_NVM
 871 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
 872 void nvme_nvm_unregister(struct nvme_ns *ns);
 873 extern const struct attribute_group nvme_nvm_attr_group;
 874 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
 875 #else
 876 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
 877                                     int node)
 878 {
 879         return 0;
 880 }
 881
 882 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
 883 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
 884                                                         unsigned long arg)
 885 {
 886         return -ENOTTY;
 887 }
 888 #endif /* CONFIG_NVM */
 889
 890 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
 891 {
 892         return dev_to_disk(dev)->private_data;
 893 }
 894
 895 #ifdef CONFIG_NVME_HWMON
 896 int nvme_hwmon_init(struct nvme_ctrl *ctrl);
 897 void nvme_hwmon_exit(struct nvme_ctrl *ctrl);
 898 #else
 899 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl)
 900 {
 901         return 0;
 902 }
 903
 904 static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl)
 905 {
 906 }
 907 #endif
 908
 909 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
 910                          u8 opcode);
 911 void nvme_execute_passthru_rq(struct request *rq);
 912 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file);
 913 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid);
 914 void nvme_put_ns(struct nvme_ns *ns);
 915
 916 #endif /* _NVME_H */