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 NVME_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 /*
 150  * Common request structure for NVMe passthrough.  All drivers must have
 151  * this structure as the first member of their request-private data.
 152  */
 153 struct nvme_request {
 154         struct nvme_command     *cmd;
 155         union nvme_result       result;
 156         u8                      retries;
 157         u8                      flags;
 158         u16                     status;
 159         struct nvme_ctrl        *ctrl;
 160 };
 161
 162 /*
 163  * Mark a bio as coming in through the mpath node.
 164  */
 165 #define REQ_NVME_MPATH          REQ_DRV
 166
 167 enum {
 168         NVME_REQ_CANCELLED              = (1 << 0),
 169         NVME_REQ_USERCMD                = (1 << 1),
 170 };
 171
 172 static inline struct nvme_request *nvme_req(struct request *req)
 173 {
 174         return blk_mq_rq_to_pdu(req);
 175 }
 176
 177 static inline u16 nvme_req_qid(struct request *req)
 178 {
 179         if (!req->q->queuedata)
 180                 return 0;
 181
 182         return req->mq_hctx->queue_num + 1;
 183 }
 184
 185 /* The below value is the specific amount of delay needed before checking
 186  * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 187  * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 188  * found empirically.
 189  */
 190 #define NVME_QUIRK_DELAY_AMOUNT         2300
 191
 192 /*
 193  * enum nvme_ctrl_state: Controller state
 194  *
 195  * @NVME_CTRL_NEW:              New controller just allocated, initial state
 196  * @NVME_CTRL_LIVE:             Controller is connected and I/O capable
 197  * @NVME_CTRL_RESETTING:        Controller is resetting (or scheduled reset)
 198  * @NVME_CTRL_CONNECTING:       Controller is disconnected, now connecting the
 199  *                              transport
 200  * @NVME_CTRL_DELETING:         Controller is deleting (or scheduled deletion)
 201  * @NVME_CTRL_DELETING_NOIO:    Controller is deleting and I/O is not
 202  *                              disabled/failed immediately. This state comes
 203  *                              after all async event processing took place and
 204  *                              before ns removal and the controller deletion
 205  *                              progress
 206  * @NVME_CTRL_DEAD:             Controller is non-present/unresponsive during
 207  *                              shutdown or removal. In this case we forcibly
 208  *                              kill all inflight I/O as they have no chance to
 209  *                              complete
 210  */
 211 enum nvme_ctrl_state {
 212         NVME_CTRL_NEW,
 213         NVME_CTRL_LIVE,
 214         NVME_CTRL_RESETTING,
 215         NVME_CTRL_CONNECTING,
 216         NVME_CTRL_DELETING,
 217         NVME_CTRL_DELETING_NOIO,
 218         NVME_CTRL_DEAD,
 219 };
 220
 221 struct nvme_fault_inject {
 222 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 223         struct fault_attr attr;
 224         struct dentry *parent;
 225         bool dont_retry;        /* DNR, do not retry */
 226         u16 status;             /* status code */
 227 #endif
 228 };
 229
 230 struct nvme_ctrl {
 231         bool comp_seen;
 232         enum nvme_ctrl_state state;
 233         bool identified;
 234         spinlock_t lock;
 235         struct mutex scan_lock;
 236         const struct nvme_ctrl_ops *ops;
 237         struct request_queue *admin_q;
 238         struct request_queue *connect_q;
 239         struct request_queue *fabrics_q;
 240         struct device *dev;
 241         int instance;
 242         int numa_node;
 243         struct blk_mq_tag_set *tagset;
 244         struct blk_mq_tag_set *admin_tagset;
 245         struct list_head namespaces;
 246         struct rw_semaphore namespaces_rwsem;
 247         struct device ctrl_device;
 248         struct device *device;  /* char device */
 249         struct cdev cdev;
 250         struct work_struct reset_work;
 251         struct work_struct delete_work;
 252         wait_queue_head_t state_wq;
 253
 254         struct nvme_subsystem *subsys;
 255         struct list_head subsys_entry;
 256
 257         struct opal_dev *opal_dev;
 258
 259         char name[12];
 260         u16 cntlid;
 261
 262         u32 ctrl_config;
 263         u16 mtfa;
 264         u32 queue_count;
 265
 266         u64 cap;
 267         u32 max_hw_sectors;
 268         u32 max_segments;
 269         u32 max_integrity_segments;
 270 #ifdef CONFIG_BLK_DEV_ZONED
 271         u32 max_zone_append;
 272 #endif
 273         u16 crdt[3];
 274         u16 oncs;
 275         u16 oacs;
 276         u16 nssa;
 277         u16 nr_streams;
 278         u16 sqsize;
 279         u32 max_namespaces;
 280         atomic_t abort_limit;
 281         u8 vwc;
 282         u32 vs;
 283         u32 sgls;
 284         u16 kas;
 285         u8 npss;
 286         u8 apsta;
 287         u16 wctemp;
 288         u16 cctemp;
 289         u32 oaes;
 290         u32 aen_result;
 291         u32 ctratt;
 292         unsigned int shutdown_timeout;
 293         unsigned int kato;
 294         bool subsystem;
 295         unsigned long quirks;
 296         struct nvme_id_power_state psd[32];
 297         struct nvme_effects_log *effects;
 298         struct xarray cels;
 299         struct work_struct scan_work;
 300         struct work_struct async_event_work;
 301         struct delayed_work ka_work;
 302         struct delayed_work failfast_work;
 303         struct nvme_command ka_cmd;
 304         struct work_struct fw_act_work;
 305         unsigned long events;
 306
 307 #ifdef CONFIG_NVME_MULTIPATH
 308         /* asymmetric namespace access: */
 309         u8 anacap;
 310         u8 anatt;
 311         u32 anagrpmax;
 312         u32 nanagrpid;
 313         struct mutex ana_lock;
 314         struct nvme_ana_rsp_hdr *ana_log_buf;
 315         size_t ana_log_size;
 316         struct timer_list anatt_timer;
 317         struct work_struct ana_work;
 318 #endif
 319
 320         /* Power saving configuration */
 321         u64 ps_max_latency_us;
 322         bool apst_enabled;
 323
 324         /* PCIe only: */
 325         u32 hmpre;
 326         u32 hmmin;
 327         u32 hmminds;
 328         u16 hmmaxd;
 329
 330         /* Fabrics only */
 331         u32 ioccsz;
 332         u32 iorcsz;
 333         u16 icdoff;
 334         u16 maxcmd;
 335         int nr_reconnects;
 336         unsigned long flags;
 337 #define NVME_CTRL_FAILFAST_EXPIRED      0
 338         struct nvmf_ctrl_options *opts;
 339
 340         struct page *discard_page;
 341         unsigned long discard_page_busy;
 342
 343         struct nvme_fault_inject fault_inject;
 344 };
 345
 346 enum nvme_iopolicy {
 347         NVME_IOPOLICY_NUMA,
 348         NVME_IOPOLICY_RR,
 349 };
 350
 351 struct nvme_subsystem {
 352         int                     instance;
 353         struct device           dev;
 354         /*
 355          * Because we unregister the device on the last put we need
 356          * a separate refcount.
 357          */
 358         struct kref             ref;
 359         struct list_head        entry;
 360         struct mutex            lock;
 361         struct list_head        ctrls;
 362         struct list_head        nsheads;
 363         char                    subnqn[NVMF_NQN_SIZE];
 364         char                    serial[20];
 365         char                    model[40];
 366         char                    firmware_rev[8];
 367         u8                      cmic;
 368         u16                     vendor_id;
 369         u16                     awupf;  /* 0's based awupf value. */
 370         struct ida              ns_ida;
 371 #ifdef CONFIG_NVME_MULTIPATH
 372         enum nvme_iopolicy      iopolicy;
 373 #endif
 374 };
 375
 376 /*
 377  * Container structure for uniqueue namespace identifiers.
 378  */
 379 struct nvme_ns_ids {
 380         u8      eui64[8];
 381         u8      nguid[16];
 382         uuid_t  uuid;
 383         u8      csi;
 384 };
 385
 386 /*
 387  * Anchor structure for namespaces.  There is one for each namespace in a
 388  * NVMe subsystem that any of our controllers can see, and the namespace
 389  * structure for each controller is chained of it.  For private namespaces
 390  * there is a 1:1 relation to our namespace structures, that is ->list
 391  * only ever has a single entry for private namespaces.
 392  */
 393 struct nvme_ns_head {
 394         struct list_head        list;
 395         struct srcu_struct      srcu;
 396         struct nvme_subsystem   *subsys;
 397         unsigned                ns_id;
 398         struct nvme_ns_ids      ids;
 399         struct list_head        entry;
 400         struct kref             ref;
 401         bool                    shared;
 402         int                     instance;
 403         struct nvme_effects_log *effects;
 404 #ifdef CONFIG_NVME_MULTIPATH
 405         struct gendisk          *disk;
 406         struct bio_list         requeue_list;
 407         spinlock_t              requeue_lock;
 408         struct work_struct      requeue_work;
 409         struct mutex            lock;
 410         unsigned long           flags;
 411 #define NVME_NSHEAD_DISK_LIVE   0
 412         struct nvme_ns __rcu    *current_path[];
 413 #endif
 414 };
 415
 416 enum nvme_ns_features {
 417         NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
 418         NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
 419 };
 420
 421 struct nvme_ns {
 422         struct list_head list;
 423
 424         struct nvme_ctrl *ctrl;
 425         struct request_queue *queue;
 426         struct gendisk *disk;
 427 #ifdef CONFIG_NVME_MULTIPATH
 428         enum nvme_ana_state ana_state;
 429         u32 ana_grpid;
 430 #endif
 431         struct list_head siblings;
 432         struct nvm_dev *ndev;
 433         struct kref kref;
 434         struct nvme_ns_head *head;
 435
 436         int lba_shift;
 437         u16 ms;
 438         u16 sgs;
 439         u32 sws;
 440         u8 pi_type;
 441 #ifdef CONFIG_BLK_DEV_ZONED
 442         u64 zsze;
 443 #endif
 444         unsigned long features;
 445         unsigned long flags;
 446 #define NVME_NS_REMOVING        0
 447 #define NVME_NS_DEAD            1
 448 #define NVME_NS_ANA_PENDING     2
 449 #define NVME_NS_FORCE_RO        3
 450
 451         struct nvme_fault_inject fault_inject;
 452
 453 };
 454
 455 /* NVMe ns supports metadata actions by the controller (generate/strip) */
 456 static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
 457 {
 458         return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
 459 }
 460
 461 struct nvme_ctrl_ops {
 462         const char *name;
 463         struct module *module;
 464         unsigned int flags;
 465 #define NVME_F_FABRICS                  (1 << 0)
 466 #define NVME_F_METADATA_SUPPORTED       (1 << 1)
 467 #define NVME_F_PCI_P2PDMA               (1 << 2)
 468         int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 469         int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 470         int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 471         void (*free_ctrl)(struct nvme_ctrl *ctrl);
 472         void (*submit_async_event)(struct nvme_ctrl *ctrl);
 473         void (*delete_ctrl)(struct nvme_ctrl *ctrl);
 474         int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
 475 };
 476
 477 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 478 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 479                             const char *dev_name);
 480 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
 481 void nvme_should_fail(struct request *req);
 482 #else
 483 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 484                                           const char *dev_name)
 485 {
 486 }
 487 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
 488 {
 489 }
 490 static inline void nvme_should_fail(struct request *req) {}
 491 #endif
 492
 493 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 494 {
 495         if (!ctrl->subsystem)
 496                 return -ENOTTY;
 497         return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
 498 }
 499
 500 /*
 501  * Convert a 512B sector number to a device logical block number.
 502  */
 503 static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector)
 504 {
 505         return sector >> (ns->lba_shift - SECTOR_SHIFT);
 506 }
 507
 508 /*
 509  * Convert a device logical block number to a 512B sector number.
 510  */
 511 static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba)
 512 {
 513         return lba << (ns->lba_shift - SECTOR_SHIFT);
 514 }
 515
 516 /*
 517  * Convert byte length to nvme's 0-based num dwords
 518  */
 519 static inline u32 nvme_bytes_to_numd(size_t len)
 520 {
 521         return (len >> 2) - 1;
 522 }
 523
 524 static inline bool nvme_is_ana_error(u16 status)
 525 {
 526         switch (status & 0x7ff) {
 527         case NVME_SC_ANA_TRANSITION:
 528         case NVME_SC_ANA_INACCESSIBLE:
 529         case NVME_SC_ANA_PERSISTENT_LOSS:
 530                 return true;
 531         default:
 532                 return false;
 533         }
 534 }
 535
 536 static inline bool nvme_is_path_error(u16 status)
 537 {
 538         /* check for a status code type of 'path related status' */
 539         return (status & 0x700) == 0x300;
 540 }
 541
 542 /*
 543  * Fill in the status and result information from the CQE, and then figure out
 544  * if blk-mq will need to use IPI magic to complete the request, and if yes do
 545  * so.  If not let the caller complete the request without an indirect function
 546  * call.
 547  */
 548 static inline bool nvme_try_complete_req(struct request *req, __le16 status,
 549                 union nvme_result result)
 550 {
 551         struct nvme_request *rq = nvme_req(req);
 552
 553         rq->status = le16_to_cpu(status) >> 1;
 554         rq->result = result;
 555         /* inject error when permitted by fault injection framework */
 556         nvme_should_fail(req);
 557         if (unlikely(blk_should_fake_timeout(req->q)))
 558                 return true;
 559         return blk_mq_complete_request_remote(req);
 560 }
 561
 562 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
 563 {
 564         get_device(ctrl->device);
 565 }
 566
 567 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
 568 {
 569         put_device(ctrl->device);
 570 }
 571
 572 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
 573 {
 574         return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH;
 575 }
 576
 577 void nvme_complete_rq(struct request *req);
 578 bool nvme_cancel_request(struct request *req, void *data, bool reserved);
 579 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
 580                 enum nvme_ctrl_state new_state);
 581 bool nvme_wait_reset(struct nvme_ctrl *ctrl);
 582 int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
 583 int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
 584 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
 585 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 586                 const struct nvme_ctrl_ops *ops, unsigned long quirks);
 587 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 588 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
 589 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
 590 int nvme_init_identify(struct nvme_ctrl *ctrl);
 591
 592 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 593
 594 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
 595                 bool send);
 596
 597 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
 598                 volatile union nvme_result *res);
 599
 600 void nvme_stop_queues(struct nvme_ctrl *ctrl);
 601 void nvme_start_queues(struct nvme_ctrl *ctrl);
 602 void nvme_kill_queues(struct nvme_ctrl *ctrl);
 603 void nvme_sync_queues(struct nvme_ctrl *ctrl);
 604 void nvme_sync_io_queues(struct nvme_ctrl *ctrl);
 605 void nvme_unfreeze(struct nvme_ctrl *ctrl);
 606 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
 607 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
 608 void nvme_start_freeze(struct nvme_ctrl *ctrl);
 609
 610 #define NVME_QID_ANY -1
 611 struct request *nvme_alloc_request(struct request_queue *q,
 612                 struct nvme_command *cmd, blk_mq_req_flags_t flags);
 613 void nvme_cleanup_cmd(struct request *req);
 614 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
 615                 struct nvme_command *cmd);
 616 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 617                 void *buf, unsigned bufflen);
 618 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 619                 union nvme_result *result, void *buffer, unsigned bufflen,
 620                 unsigned timeout, int qid, int at_head,
 621                 blk_mq_req_flags_t flags, bool poll);
 622 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
 623                       unsigned int dword11, void *buffer, size_t buflen,
 624                       u32 *result);
 625 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
 626                       unsigned int dword11, void *buffer, size_t buflen,
 627                       u32 *result);
 628 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 629 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
 630 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
 631 int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
 632 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
 633
 634 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
 635                 void *log, size_t size, u64 offset);
 636 struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
 637                 struct nvme_ns_head **head, int *srcu_idx);
 638 void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx);
 639
 640 extern const struct attribute_group *nvme_ns_id_attr_groups[];
 641 extern const struct block_device_operations nvme_ns_head_ops;
 642
 643 #ifdef CONFIG_NVME_MULTIPATH
 644 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
 645 {
 646         return ctrl->ana_log_buf != NULL;
 647 }
 648
 649 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
 650 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
 651 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
 652 void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
 653                         struct nvme_ctrl *ctrl, int *flags);
 654 void nvme_failover_req(struct request *req);
 655 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
 656 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
 657 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
 658 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
 659 int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
 660 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
 661 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
 662 bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
 663 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
 664 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
 665 blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
 666
 667 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
 668 {
 669         struct nvme_ns_head *head = ns->head;
 670
 671         if (head->disk && list_empty(&head->list))
 672                 kblockd_schedule_work(&head->requeue_work);
 673 }
 674
 675 static inline void nvme_trace_bio_complete(struct request *req)
 676 {
 677         struct nvme_ns *ns = req->q->queuedata;
 678
 679         if (req->cmd_flags & REQ_NVME_MPATH)
 680                 trace_block_bio_complete(ns->head->disk->queue, req->bio);
 681 }
 682
 683 extern struct device_attribute dev_attr_ana_grpid;
 684 extern struct device_attribute dev_attr_ana_state;
 685 extern struct device_attribute subsys_attr_iopolicy;
 686
 687 #else
 688 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
 689 {
 690         return false;
 691 }
 692 /*
 693  * Without the multipath code enabled, multiple controller per subsystems are
 694  * visible as devices and thus we cannot use the subsystem instance.
 695  */
 696 static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
 697                                       struct nvme_ctrl *ctrl, int *flags)
 698 {
 699         sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
 700 }
 701
 702 static inline void nvme_failover_req(struct request *req)
 703 {
 704 }
 705 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
 706 {
 707 }
 708 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
 709                 struct nvme_ns_head *head)
 710 {
 711         return 0;
 712 }
 713 static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
 714                 struct nvme_id_ns *id)
 715 {
 716 }
 717 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
 718 {
 719 }
 720 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
 721 {
 722         return false;
 723 }
 724 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
 725 {
 726 }
 727 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
 728 {
 729 }
 730 static inline void nvme_trace_bio_complete(struct request *req)
 731 {
 732 }
 733 static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
 734                 struct nvme_id_ctrl *id)
 735 {
 736         if (ctrl->subsys->cmic & (1 << 3))
 737                 dev_warn(ctrl->device,
 738 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
 739         return 0;
 740 }
 741 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
 742 {
 743 }
 744 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
 745 {
 746 }
 747 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
 748 {
 749 }
 750 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
 751 {
 752 }
 753 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
 754 {
 755 }
 756 #endif /* CONFIG_NVME_MULTIPATH */
 757
 758 int nvme_revalidate_zones(struct nvme_ns *ns);
 759 #ifdef CONFIG_BLK_DEV_ZONED
 760 int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf);
 761 int nvme_report_zones(struct gendisk *disk, sector_t sector,
 762                       unsigned int nr_zones, report_zones_cb cb, void *data);
 763
 764 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
 765                                        struct nvme_command *cmnd,
 766                                        enum nvme_zone_mgmt_action action);
 767 #else
 768 #define nvme_report_zones NULL
 769
 770 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
 771                 struct request *req, struct nvme_command *cmnd,
 772                 enum nvme_zone_mgmt_action action)
 773 {
 774         return BLK_STS_NOTSUPP;
 775 }
 776
 777 static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf)
 778 {
 779         dev_warn(ns->ctrl->device,
 780                  "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n");
 781         return -EPROTONOSUPPORT;
 782 }
 783 #endif
 784
 785 #ifdef CONFIG_NVM
 786 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
 787 void nvme_nvm_unregister(struct nvme_ns *ns);
 788 extern const struct attribute_group nvme_nvm_attr_group;
 789 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
 790 #else
 791 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
 792                                     int node)
 793 {
 794         return 0;
 795 }
 796
 797 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
 798 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
 799                                                         unsigned long arg)
 800 {
 801         return -ENOTTY;
 802 }
 803 #endif /* CONFIG_NVM */
 804
 805 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
 806 {
 807         return dev_to_disk(dev)->private_data;
 808 }
 809
 810 #ifdef CONFIG_NVME_HWMON
 811 int nvme_hwmon_init(struct nvme_ctrl *ctrl);
 812 #else
 813 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl)
 814 {
 815         return 0;
 816 }
 817 #endif
 818
 819 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
 820                          u8 opcode);
 821 void nvme_execute_passthru_rq(struct request *rq);
 822 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file);
 823 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid);
 824 void nvme_put_ns(struct nvme_ns *ns);
 825
 826 #endif /* _NVME_H */