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