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