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 #include <linux/ratelimit_types.h> 20 21 #include <trace/events/block.h> 22 23 extern const struct pr_ops nvme_pr_ops; 24 25 extern unsigned int nvme_io_timeout; 26 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) 27 28 extern unsigned int admin_timeout; 29 #define NVME_ADMIN_TIMEOUT (admin_timeout * HZ) 30 31 #define NVME_DEFAULT_KATO 5 32 33 #ifdef CONFIG_ARCH_NO_SG_CHAIN 34 #define NVME_INLINE_SG_CNT 0 35 #define NVME_INLINE_METADATA_SG_CNT 0 36 #else 37 #define NVME_INLINE_SG_CNT 2 38 #define NVME_INLINE_METADATA_SG_CNT 1 39 #endif 40 41 /* 42 * Default to a 4K page size, with the intention to update this 43 * path in the future to accommodate architectures with differing 44 * kernel and IO page sizes. 45 */ 46 #define NVME_CTRL_PAGE_SHIFT 12 47 #define NVME_CTRL_PAGE_SIZE (1 << NVME_CTRL_PAGE_SHIFT) 48 49 extern struct workqueue_struct *nvme_wq; 50 extern struct workqueue_struct *nvme_reset_wq; 51 extern struct workqueue_struct *nvme_delete_wq; 52 extern struct mutex nvme_subsystems_lock; 53 54 /* 55 * List of workarounds for devices that required behavior not specified in 56 * the standard. 57 */ 58 enum nvme_quirks { 59 /* 60 * Prefers I/O aligned to a stripe size specified in a vendor 61 * specific Identify field. 62 */ 63 NVME_QUIRK_STRIPE_SIZE = (1 << 0), 64 65 /* 66 * The controller doesn't handle Identify value others than 0 or 1 67 * correctly. 68 */ 69 NVME_QUIRK_IDENTIFY_CNS = (1 << 1), 70 71 /* 72 * The controller deterministically returns 0's on reads to 73 * logical blocks that deallocate was called on. 74 */ 75 NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2), 76 77 /* 78 * The controller needs a delay before starts checking the device 79 * readiness, which is done by reading the NVME_CSTS_RDY bit. 80 */ 81 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3), 82 83 /* 84 * APST should not be used. 85 */ 86 NVME_QUIRK_NO_APST = (1 << 4), 87 88 /* 89 * The deepest sleep state should not be used. 90 */ 91 NVME_QUIRK_NO_DEEPEST_PS = (1 << 5), 92 93 /* 94 * Problems seen with concurrent commands 95 */ 96 NVME_QUIRK_QDEPTH_ONE = (1 << 6), 97 98 /* 99 * Set MEDIUM priority on SQ creation 100 */ 101 NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7), 102 103 /* 104 * Ignore device provided subnqn. 105 */ 106 NVME_QUIRK_IGNORE_DEV_SUBNQN = (1 << 8), 107 108 /* 109 * Broken Write Zeroes. 110 */ 111 NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 << 9), 112 113 /* 114 * Force simple suspend/resume path. 115 */ 116 NVME_QUIRK_SIMPLE_SUSPEND = (1 << 10), 117 118 /* 119 * Use only one interrupt vector for all queues 120 */ 121 NVME_QUIRK_SINGLE_VECTOR = (1 << 11), 122 123 /* 124 * Use non-standard 128 bytes SQEs. 125 */ 126 NVME_QUIRK_128_BYTES_SQES = (1 << 12), 127 128 /* 129 * Prevent tag overlap between queues 130 */ 131 NVME_QUIRK_SHARED_TAGS = (1 << 13), 132 133 /* 134 * Don't change the value of the temperature threshold feature 135 */ 136 NVME_QUIRK_NO_TEMP_THRESH_CHANGE = (1 << 14), 137 138 /* 139 * The controller doesn't handle the Identify Namespace 140 * Identification Descriptor list subcommand despite claiming 141 * NVMe 1.3 compliance. 142 */ 143 NVME_QUIRK_NO_NS_DESC_LIST = (1 << 15), 144 145 /* 146 * The controller does not properly handle DMA addresses over 147 * 48 bits. 148 */ 149 NVME_QUIRK_DMA_ADDRESS_BITS_48 = (1 << 16), 150 151 /* 152 * The controller requires the command_id value be limited, so skip 153 * encoding the generation sequence number. 154 */ 155 NVME_QUIRK_SKIP_CID_GEN = (1 << 17), 156 157 /* 158 * Reports garbage in the namespace identifiers (eui64, nguid, uuid). 159 */ 160 NVME_QUIRK_BOGUS_NID = (1 << 18), 161 162 /* 163 * No temperature thresholds for channels other than 0 (Composite). 164 */ 165 NVME_QUIRK_NO_SECONDARY_TEMP_THRESH = (1 << 19), 166 167 /* 168 * Disables simple suspend/resume path. 169 */ 170 NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND = (1 << 20), 171 172 /* 173 * MSI (but not MSI-X) interrupts are broken and never fire. 174 */ 175 NVME_QUIRK_BROKEN_MSI = (1 << 21), 176 177 /* 178 * Align dma pool segment size to 512 bytes 179 */ 180 NVME_QUIRK_DMAPOOL_ALIGN_512 = (1 << 22), 181 182 /* 183 * Admin queue DMA buffers must be page aligned 184 */ 185 NVME_QUIRK_ADMIN_PAGE_ALIGN = (1 << 23), 186 }; 187 188 static inline char *nvme_quirk_name(enum nvme_quirks q) 189 { 190 switch (q) { 191 case NVME_QUIRK_STRIPE_SIZE: 192 return "stripe_size"; 193 case NVME_QUIRK_IDENTIFY_CNS: 194 return "identify_cns"; 195 case NVME_QUIRK_DEALLOCATE_ZEROES: 196 return "deallocate_zeroes"; 197 case NVME_QUIRK_DELAY_BEFORE_CHK_RDY: 198 return "delay_before_chk_rdy"; 199 case NVME_QUIRK_NO_APST: 200 return "no_apst"; 201 case NVME_QUIRK_NO_DEEPEST_PS: 202 return "no_deepest_ps"; 203 case NVME_QUIRK_QDEPTH_ONE: 204 return "qdepth_one"; 205 case NVME_QUIRK_MEDIUM_PRIO_SQ: 206 return "medium_prio_sq"; 207 case NVME_QUIRK_IGNORE_DEV_SUBNQN: 208 return "ignore_dev_subnqn"; 209 case NVME_QUIRK_DISABLE_WRITE_ZEROES: 210 return "disable_write_zeroes"; 211 case NVME_QUIRK_SIMPLE_SUSPEND: 212 return "simple_suspend"; 213 case NVME_QUIRK_SINGLE_VECTOR: 214 return "single_vector"; 215 case NVME_QUIRK_128_BYTES_SQES: 216 return "128_bytes_sqes"; 217 case NVME_QUIRK_SHARED_TAGS: 218 return "shared_tags"; 219 case NVME_QUIRK_NO_TEMP_THRESH_CHANGE: 220 return "no_temp_thresh_change"; 221 case NVME_QUIRK_NO_NS_DESC_LIST: 222 return "no_ns_desc_list"; 223 case NVME_QUIRK_DMA_ADDRESS_BITS_48: 224 return "dma_address_bits_48"; 225 case NVME_QUIRK_SKIP_CID_GEN: 226 return "skip_cid_gen"; 227 case NVME_QUIRK_BOGUS_NID: 228 return "bogus_nid"; 229 case NVME_QUIRK_NO_SECONDARY_TEMP_THRESH: 230 return "no_secondary_temp_thresh"; 231 case NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND: 232 return "force_no_simple_suspend"; 233 case NVME_QUIRK_BROKEN_MSI: 234 return "broken_msi"; 235 case NVME_QUIRK_DMAPOOL_ALIGN_512: 236 return "dmapool_align_512"; 237 case NVME_QUIRK_ADMIN_PAGE_ALIGN: 238 return "admin_page_align"; 239 } 240 241 return "unknown"; 242 } 243 244 /* 245 * Common request structure for NVMe passthrough. All drivers must have 246 * this structure as the first member of their request-private data. 247 */ 248 struct nvme_request { 249 struct nvme_command *cmd; 250 union nvme_result result; 251 u8 genctr; 252 u8 retries; 253 u8 flags; 254 u16 status; 255 #ifdef CONFIG_NVME_MULTIPATH 256 unsigned long start_time; 257 #endif 258 struct nvme_ctrl *ctrl; 259 }; 260 261 /* 262 * Mark a bio as coming in through the mpath node. 263 */ 264 #define REQ_NVME_MPATH REQ_DRV 265 266 enum { 267 NVME_REQ_CANCELLED = (1 << 0), 268 NVME_REQ_USERCMD = (1 << 1), 269 NVME_MPATH_IO_STATS = (1 << 2), 270 NVME_MPATH_CNT_ACTIVE = (1 << 3), 271 }; 272 273 static inline struct nvme_request *nvme_req(struct request *req) 274 { 275 return blk_mq_rq_to_pdu(req); 276 } 277 278 static inline u16 nvme_req_qid(struct request *req) 279 { 280 if (!req->q->queuedata) 281 return 0; 282 283 return req->mq_hctx->queue_num + 1; 284 } 285 286 /* The below value is the specific amount of delay needed before checking 287 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the 288 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was 289 * found empirically. 290 */ 291 #define NVME_QUIRK_DELAY_AMOUNT 2300 292 293 /* 294 * enum nvme_ctrl_state: Controller state 295 * 296 * @NVME_CTRL_NEW: New controller just allocated, initial state 297 * @NVME_CTRL_LIVE: Controller is connected and I/O capable 298 * @NVME_CTRL_RESETTING: Controller is resetting (or scheduled reset) 299 * @NVME_CTRL_CONNECTING: Controller is disconnected, now connecting the 300 * transport 301 * @NVME_CTRL_DELETING: Controller is deleting (or scheduled deletion) 302 * @NVME_CTRL_DELETING_NOIO: Controller is deleting and I/O is not 303 * disabled/failed immediately. This state comes 304 * after all async event processing took place and 305 * before ns removal and the controller deletion 306 * progress 307 * @NVME_CTRL_DEAD: Controller is non-present/unresponsive during 308 * shutdown or removal. In this case we forcibly 309 * kill all inflight I/O as they have no chance to 310 * complete 311 */ 312 enum nvme_ctrl_state { 313 NVME_CTRL_NEW, 314 NVME_CTRL_LIVE, 315 NVME_CTRL_RESETTING, 316 NVME_CTRL_CONNECTING, 317 NVME_CTRL_DELETING, 318 NVME_CTRL_DELETING_NOIO, 319 NVME_CTRL_DEAD, 320 }; 321 322 struct nvme_fault_inject { 323 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 324 struct fault_attr attr; 325 struct dentry *parent; 326 u16 opcode; 327 bool dont_retry; /* DNR, do not retry */ 328 u16 status; /* status code */ 329 #endif 330 }; 331 332 enum nvme_ctrl_flags { 333 NVME_CTRL_FAILFAST_EXPIRED = 0, 334 NVME_CTRL_ADMIN_Q_STOPPED = 1, 335 NVME_CTRL_STARTED_ONCE = 2, 336 NVME_CTRL_STOPPED = 3, 337 NVME_CTRL_SKIP_ID_CNS_CS = 4, 338 NVME_CTRL_DIRTY_CAPABILITY = 5, 339 NVME_CTRL_FROZEN = 6, 340 }; 341 342 struct nvme_ctrl { 343 bool comp_seen; 344 bool identified; 345 bool passthru_err_log_enabled; 346 enum nvme_ctrl_state state; 347 spinlock_t lock; 348 struct mutex scan_lock; 349 const struct nvme_ctrl_ops *ops; 350 struct request_queue *admin_q; 351 struct request_queue *connect_q; 352 struct request_queue *fabrics_q; 353 struct device *dev; 354 int instance; 355 int numa_node; 356 struct blk_mq_tag_set *tagset; 357 struct blk_mq_tag_set *admin_tagset; 358 struct list_head namespaces; 359 struct mutex namespaces_lock; 360 struct srcu_struct srcu; 361 struct device ctrl_device; 362 struct device *device; /* char device */ 363 #ifdef CONFIG_NVME_HWMON 364 struct device *hwmon_device; 365 #endif 366 struct cdev cdev; 367 struct work_struct reset_work; 368 struct work_struct delete_work; 369 wait_queue_head_t state_wq; 370 371 struct nvme_subsystem *subsys; 372 struct list_head subsys_entry 373 __guarded_by(&nvme_subsystems_lock); 374 375 struct opal_dev *opal_dev; 376 377 u16 cntlid; 378 379 u16 mtfa; 380 u32 ctrl_config; 381 u32 queue_count; 382 u32 admin_timeout; 383 u32 io_timeout; 384 385 u64 cap; 386 u32 max_hw_sectors; 387 u32 max_segments; 388 u32 max_integrity_segments; 389 u32 max_zeroes_sectors; 390 #ifdef CONFIG_BLK_DEV_ZONED 391 u32 max_zone_append; 392 #endif 393 u16 crdt[3]; 394 u16 oncs; 395 u8 dmrl; 396 u32 dmrsl; 397 u16 oacs; 398 u16 sqsize; 399 u32 max_namespaces; 400 atomic_t abort_limit; 401 u8 vwc; 402 u32 vs; 403 u32 sgls; 404 u16 kas; 405 u8 npss; 406 u8 apsta; 407 u16 wctemp; 408 u16 cctemp; 409 u32 oaes; 410 u32 aen_result; 411 u32 ctratt; 412 unsigned int shutdown_timeout; 413 unsigned int kato; 414 bool subsystem; 415 unsigned long quirks; 416 struct nvme_id_power_state psd[32]; 417 struct nvme_effects_log *effects; 418 struct work_struct scan_work; 419 struct work_struct async_event_work; 420 struct delayed_work ka_work; 421 struct delayed_work failfast_work; 422 struct nvme_command ka_cmd; 423 unsigned long ka_last_check_time; 424 struct work_struct fw_act_work; 425 unsigned long events; 426 atomic_long_t errors; 427 atomic_long_t nr_reset; 428 429 #ifdef CONFIG_NVME_MULTIPATH 430 /* asymmetric namespace access: */ 431 u8 anacap; 432 u8 anatt; 433 u32 anagrpmax; 434 u32 nanagrpid; 435 struct mutex ana_lock; 436 struct nvme_ana_rsp_hdr *ana_log_buf; 437 size_t ana_log_size; 438 struct timer_list anatt_timer; 439 struct work_struct ana_work; 440 atomic_t nr_active; 441 #endif 442 443 #ifdef CONFIG_NVME_HOST_AUTH 444 struct work_struct dhchap_auth_work; 445 struct mutex dhchap_auth_mutex; 446 struct nvme_dhchap_queue_context *dhchap_ctxs; 447 struct nvme_dhchap_key *host_key; 448 struct nvme_dhchap_key *ctrl_key; 449 u16 transaction; 450 #endif 451 key_serial_t tls_pskid; 452 453 /* Power saving configuration */ 454 u64 ps_max_latency_us; 455 bool apst_enabled; 456 457 /* PCIe only: */ 458 u16 hmmaxd; 459 u32 hmpre; 460 u32 hmmin; 461 u32 hmminds; 462 463 /* Fabrics only */ 464 u32 ioccsz; 465 u32 iorcsz; 466 u16 icdoff; 467 u16 maxcmd; 468 int nr_reconnects; 469 /* accumulate reconenct attempts, as nr_reconnects can reset to zero */ 470 atomic_long_t acc_reconnects; 471 unsigned long flags; 472 struct nvmf_ctrl_options *opts; 473 474 struct page *discard_page; 475 unsigned long discard_page_busy; 476 477 struct nvme_fault_inject fault_inject; 478 479 enum nvme_ctrl_type cntrltype; 480 enum nvme_dctype dctype; 481 482 u16 awupf; /* 0's based value. */ 483 }; 484 485 static inline enum nvme_ctrl_state nvme_ctrl_state(struct nvme_ctrl *ctrl) 486 { 487 return READ_ONCE(ctrl->state); 488 } 489 490 enum nvme_iopolicy { 491 NVME_IOPOLICY_NUMA, 492 NVME_IOPOLICY_RR, 493 NVME_IOPOLICY_QD, 494 }; 495 496 struct nvme_subsystem { 497 int instance; 498 struct device dev; 499 /* 500 * Because we unregister the device on the last put we need 501 * a separate refcount. 502 */ 503 struct kref ref; 504 struct list_head entry 505 __guarded_by(&nvme_subsystems_lock); 506 struct mutex lock; 507 struct list_head ctrls 508 __guarded_by(&nvme_subsystems_lock); 509 struct list_head nsheads 510 __guarded_by(&lock); 511 /* Command effects logs, indexed by CSI and protected by lock. */ 512 struct xarray cels; 513 char subnqn[NVMF_NQN_SIZE]; 514 char serial[20]; 515 char model[40]; 516 char firmware_rev[8]; 517 u8 cmic; 518 enum nvme_subsys_type subtype; 519 u16 vendor_id; 520 struct ida ns_ida; 521 #ifdef CONFIG_NVME_MULTIPATH 522 enum nvme_iopolicy iopolicy; 523 #endif 524 }; 525 526 /* 527 * Container structure for uniqueue namespace identifiers. 528 */ 529 struct nvme_ns_ids { 530 u8 eui64[8]; 531 u8 nguid[16]; 532 uuid_t uuid; 533 u8 csi; 534 }; 535 536 /* 537 * Anchor structure for namespaces. There is one for each namespace in a 538 * NVMe subsystem that any of our controllers can see, and the namespace 539 * structure for each controller is chained of it. For private namespaces 540 * there is a 1:1 relation to our namespace structures, that is ->list 541 * only ever has a single entry for private namespaces. 542 */ 543 struct nvme_ns_head { 544 struct list_head list; 545 struct srcu_struct srcu; 546 struct nvme_subsystem *subsys; 547 struct nvme_ns_ids ids; 548 u8 lba_shift; 549 u16 ms; 550 u16 pi_size; 551 u8 pi_type; 552 u8 guard_type; 553 struct list_head entry; 554 struct kref ref; 555 bool shared; 556 bool rotational; 557 bool passthru_err_log_enabled; 558 struct nvme_effects_log *effects; 559 u64 nuse; 560 unsigned ns_id; 561 int instance; 562 #ifdef CONFIG_BLK_DEV_ZONED 563 u64 zsze; 564 #endif 565 unsigned long features; 566 567 struct ratelimit_state rs_nuse; 568 569 struct cdev cdev; 570 struct device cdev_device; 571 572 struct gendisk *disk; 573 574 u16 nr_plids; 575 u16 *plids; 576 u32 write_stream_granularity; 577 #ifdef CONFIG_NVME_MULTIPATH 578 struct bio_list requeue_list 579 __guarded_by(&requeue_lock); 580 spinlock_t requeue_lock; 581 struct work_struct requeue_work; 582 struct work_struct partition_scan_work; 583 struct mutex lock; 584 unsigned long flags; 585 struct delayed_work remove_work; 586 unsigned int delayed_removal_secs 587 __guarded_by(&subsys->lock); 588 atomic_long_t io_requeue_no_usable_path_count; 589 atomic_long_t io_fail_no_available_path_count; 590 #define NVME_NSHEAD_DISK_LIVE 0 591 #define NVME_NSHEAD_QUEUE_IF_NO_PATH 1 592 #define NVME_NSHEAD_CDEV_LIVE 2 593 #define NVME_NSHEAD_FAIL_ON_CTRL_LOSS 3 594 struct nvme_ns __rcu_guarded *current_path[]; 595 #endif 596 }; 597 598 static inline bool nvme_ns_head_multipath(struct nvme_ns_head *head) 599 { 600 return IS_ENABLED(CONFIG_NVME_MULTIPATH) && head->disk; 601 } 602 603 enum nvme_ns_features { 604 NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */ 605 NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */ 606 NVME_NS_DEAC = 1 << 2, /* DEAC bit in Write Zeroes supported */ 607 }; 608 609 struct nvme_ns { 610 struct list_head list; 611 612 struct nvme_ctrl *ctrl; 613 struct request_queue *queue; 614 struct gendisk *disk; 615 #ifdef CONFIG_NVME_MULTIPATH 616 enum nvme_ana_state ana_state; 617 u32 ana_grpid; 618 atomic_long_t failover; 619 #endif 620 atomic_long_t retries; 621 atomic_long_t errors; 622 struct list_head siblings; 623 struct kref kref; 624 struct nvme_ns_head *head; 625 626 unsigned long flags; 627 #define NVME_NS_REMOVING 0 628 #define NVME_NS_ANA_PENDING 2 629 #define NVME_NS_FORCE_RO 3 630 #define NVME_NS_READY 4 631 #define NVME_NS_SYSFS_ATTR_LINK 5 632 #define NVME_NS_CDEV_LIVE 6 633 634 struct cdev cdev; 635 struct device cdev_device; 636 637 struct nvme_fault_inject fault_inject; 638 }; 639 640 /* NVMe ns supports metadata actions by the controller (generate/strip) */ 641 static inline bool nvme_ns_has_pi(struct nvme_ns_head *head) 642 { 643 return head->pi_type && head->ms == head->pi_size; 644 } 645 646 static inline unsigned long nvme_get_virt_boundary(struct nvme_ctrl *ctrl, 647 bool is_admin) 648 { 649 return NVME_CTRL_PAGE_SIZE - 1; 650 } 651 652 struct nvme_ctrl_ops { 653 const char *name; 654 struct module *module; 655 unsigned int flags; 656 #define NVME_F_FABRICS (1 << 0) 657 #define NVME_F_METADATA_SUPPORTED (1 << 1) 658 #define NVME_F_BLOCKING (1 << 2) 659 660 const struct attribute_group **dev_attr_groups; 661 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 662 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 663 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 664 void (*free_ctrl)(struct nvme_ctrl *ctrl); 665 void (*submit_async_event)(struct nvme_ctrl *ctrl); 666 int (*subsystem_reset)(struct nvme_ctrl *ctrl); 667 void (*delete_ctrl)(struct nvme_ctrl *ctrl); 668 void (*stop_ctrl)(struct nvme_ctrl *ctrl); 669 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); 670 void (*print_device_info)(struct nvme_ctrl *ctrl); 671 bool (*supports_pci_p2pdma)(struct nvme_ctrl *ctrl); 672 int (*init_dma_buf_io_ctx)(struct nvme_ctrl *ctrl, 673 struct dma_buf_io_ctx *ctx); 674 unsigned long (*get_virt_boundary)(struct nvme_ctrl *ctrl, bool is_admin); 675 }; 676 677 /* 678 * nvme command_id is constructed as such: 679 * | xxxx | xxxxxxxxxxxx | 680 * gen request tag 681 */ 682 #define nvme_genctr_mask(gen) (gen & 0xf) 683 #define nvme_cid_install_genctr(gen) (nvme_genctr_mask(gen) << 12) 684 #define nvme_genctr_from_cid(cid) ((cid & 0xf000) >> 12) 685 #define nvme_tag_from_cid(cid) (cid & 0xfff) 686 687 static inline u16 nvme_cid(struct request *rq) 688 { 689 return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag; 690 } 691 692 static inline struct request *nvme_find_rq(struct blk_mq_tags *tags, 693 u16 command_id) 694 { 695 u8 genctr = nvme_genctr_from_cid(command_id); 696 u16 tag = nvme_tag_from_cid(command_id); 697 struct request *rq; 698 699 rq = blk_mq_tag_to_rq(tags, tag); 700 if (unlikely(!rq)) { 701 pr_err_ratelimited("could not locate request for tag %#x\n", 702 tag); 703 return NULL; 704 } 705 if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) { 706 dev_err_ratelimited(nvme_req(rq)->ctrl->device, 707 "request %#x genctr mismatch (got %#x expected %#x)\n", 708 tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr)); 709 return NULL; 710 } 711 return rq; 712 } 713 714 static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags, 715 u16 command_id) 716 { 717 return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id)); 718 } 719 720 /* 721 * Return the length of the string without the space padding 722 */ 723 static inline int nvme_strlen(char *s, int len) 724 { 725 while (s[len - 1] == ' ') 726 len--; 727 return len; 728 } 729 730 static inline void nvme_print_device_info(struct nvme_ctrl *ctrl) 731 { 732 struct nvme_subsystem *subsys = ctrl->subsys; 733 734 if (ctrl->ops->print_device_info) { 735 ctrl->ops->print_device_info(ctrl); 736 return; 737 } 738 739 dev_err(ctrl->device, 740 "VID:%04x model:%.*s firmware:%.*s\n", subsys->vendor_id, 741 nvme_strlen(subsys->model, sizeof(subsys->model)), 742 subsys->model, nvme_strlen(subsys->firmware_rev, 743 sizeof(subsys->firmware_rev)), 744 subsys->firmware_rev); 745 } 746 747 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 748 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 749 const char *dev_name); 750 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject); 751 void nvme_should_fail(struct request *req); 752 #else 753 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 754 const char *dev_name) 755 { 756 } 757 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj) 758 { 759 } 760 static inline void nvme_should_fail(struct request *req) {} 761 #endif 762 763 bool nvme_wait_reset(struct nvme_ctrl *ctrl); 764 int nvme_try_sched_reset(struct nvme_ctrl *ctrl); 765 766 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 767 { 768 if (!ctrl->subsystem || !ctrl->ops->subsystem_reset) 769 return -ENOTTY; 770 return ctrl->ops->subsystem_reset(ctrl); 771 } 772 773 /* 774 * Convert a 512B sector number to a device logical block number. 775 */ 776 static inline u64 nvme_sect_to_lba(struct nvme_ns_head *head, sector_t sector) 777 { 778 return sector >> (head->lba_shift - SECTOR_SHIFT); 779 } 780 781 /* 782 * Convert a device logical block number to a 512B sector number. 783 */ 784 static inline sector_t nvme_lba_to_sect(struct nvme_ns_head *head, u64 lba) 785 { 786 return lba << (head->lba_shift - SECTOR_SHIFT); 787 } 788 789 /* 790 * Convert byte length to nvme's 0-based num dwords 791 */ 792 static inline u32 nvme_bytes_to_numd(size_t len) 793 { 794 return (len >> 2) - 1; 795 } 796 797 /* Decode a 2-byte "0's based"/"0-based" field */ 798 static inline u32 from0based(__le16 value) 799 { 800 return (u32)le16_to_cpu(value) + 1; 801 } 802 803 static inline bool nvme_is_ana_error(u16 status) 804 { 805 switch (status & NVME_SCT_SC_MASK) { 806 case NVME_SC_ANA_TRANSITION: 807 case NVME_SC_ANA_INACCESSIBLE: 808 case NVME_SC_ANA_PERSISTENT_LOSS: 809 return true; 810 default: 811 return false; 812 } 813 } 814 815 static inline bool nvme_is_path_error(u16 status) 816 { 817 /* check for a status code type of 'path related status' */ 818 return (status & NVME_SCT_MASK) == NVME_SCT_PATH; 819 } 820 821 /* 822 * Fill in the status and result information from the CQE, and then figure out 823 * if blk-mq will need to use IPI magic to complete the request, and if yes do 824 * so. If not let the caller complete the request without an indirect function 825 * call. 826 */ 827 static inline bool nvme_try_complete_req(struct request *req, __le16 status, 828 union nvme_result result) 829 { 830 struct nvme_request *rq = nvme_req(req); 831 struct nvme_ctrl *ctrl = rq->ctrl; 832 833 if (!(ctrl->quirks & NVME_QUIRK_SKIP_CID_GEN)) 834 rq->genctr++; 835 836 rq->status = le16_to_cpu(status) >> 1; 837 rq->result = result; 838 /* inject error when permitted by fault injection framework */ 839 nvme_should_fail(req); 840 if (unlikely(blk_should_fake_timeout(req->q))) 841 return true; 842 return blk_mq_complete_request_remote(req); 843 } 844 845 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl) 846 { 847 get_device(ctrl->device); 848 } 849 850 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl) 851 { 852 put_device(ctrl->device); 853 } 854 855 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id) 856 { 857 return !qid && 858 nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH; 859 } 860 861 /* 862 * Returns true for sink states that can't ever transition back to live. 863 */ 864 static inline bool nvme_state_terminal(struct nvme_ctrl *ctrl) 865 { 866 switch (nvme_ctrl_state(ctrl)) { 867 case NVME_CTRL_NEW: 868 case NVME_CTRL_LIVE: 869 case NVME_CTRL_RESETTING: 870 case NVME_CTRL_CONNECTING: 871 return false; 872 case NVME_CTRL_DELETING: 873 case NVME_CTRL_DELETING_NOIO: 874 case NVME_CTRL_DEAD: 875 return true; 876 default: 877 WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state); 878 return true; 879 } 880 } 881 882 void nvme_end_req(struct request *req); 883 void nvme_complete_rq(struct request *req); 884 void nvme_complete_batch_req(struct request *req); 885 886 static __always_inline void nvme_complete_batch(struct io_comp_batch *iob, 887 void (*fn)(struct request *rq)) 888 { 889 struct request *req; 890 891 rq_list_for_each(&iob->req_list, req) { 892 fn(req); 893 nvme_complete_batch_req(req); 894 } 895 blk_mq_end_request_batch(iob); 896 } 897 898 blk_status_t nvme_host_path_error(struct request *req); 899 bool nvme_cancel_request(struct request *req, void *data); 900 void nvme_cancel_tagset(struct nvme_ctrl *ctrl); 901 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl); 902 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 903 enum nvme_ctrl_state new_state); 904 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, bool shutdown); 905 int nvme_enable_ctrl(struct nvme_ctrl *ctrl); 906 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 907 const struct nvme_ctrl_ops *ops, unsigned long quirks); 908 int nvme_add_ctrl(struct nvme_ctrl *ctrl); 909 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 910 void nvme_start_ctrl(struct nvme_ctrl *ctrl); 911 void nvme_stop_ctrl(struct nvme_ctrl *ctrl); 912 int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl, bool was_suspended); 913 int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, 914 const struct blk_mq_ops *ops, unsigned int cmd_size); 915 void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl); 916 int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, 917 const struct blk_mq_ops *ops, unsigned int nr_maps, 918 unsigned int cmd_size); 919 void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl); 920 921 void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 922 923 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, 924 volatile union nvme_result *res); 925 926 void nvme_quiesce_io_queues(struct nvme_ctrl *ctrl); 927 void nvme_unquiesce_io_queues(struct nvme_ctrl *ctrl); 928 void nvme_quiesce_admin_queue(struct nvme_ctrl *ctrl); 929 void nvme_unquiesce_admin_queue(struct nvme_ctrl *ctrl); 930 void nvme_mark_namespaces_dead(struct nvme_ctrl *ctrl); 931 void nvme_sync_queues(struct nvme_ctrl *ctrl); 932 void nvme_sync_io_queues(struct nvme_ctrl *ctrl); 933 void nvme_unfreeze(struct nvme_ctrl *ctrl); 934 void nvme_wait_freeze(struct nvme_ctrl *ctrl); 935 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl); 936 void nvme_start_freeze(struct nvme_ctrl *ctrl); 937 938 static inline enum req_op nvme_req_op(struct nvme_command *cmd) 939 { 940 return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN; 941 } 942 943 #define NVME_QID_ANY -1 944 void nvme_init_request(struct request *req, struct nvme_command *cmd); 945 void nvme_cleanup_cmd(struct request *req); 946 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req); 947 blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl, 948 struct request *req); 949 bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq, 950 bool queue_live, enum nvme_ctrl_state state); 951 952 static inline bool nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq, 953 bool queue_live) 954 { 955 enum nvme_ctrl_state state = nvme_ctrl_state(ctrl); 956 957 if (likely(state == NVME_CTRL_LIVE)) 958 return true; 959 if (ctrl->ops->flags & NVME_F_FABRICS && state == NVME_CTRL_DELETING) 960 return queue_live; 961 return __nvme_check_ready(ctrl, rq, queue_live, state); 962 } 963 964 /* 965 * NSID shall be unique for all shared namespaces, or if at least one of the 966 * following conditions is met: 967 * 1. Namespace Management is supported by the controller 968 * 2. ANA is supported by the controller 969 * 3. NVM Set are supported by the controller 970 * 971 * In other case, private namespace are not required to report a unique NSID. 972 */ 973 static inline bool nvme_is_unique_nsid(struct nvme_ctrl *ctrl, 974 struct nvme_ns_head *head) 975 { 976 return head->shared || 977 (ctrl->oacs & NVME_CTRL_OACS_NS_MNGT_SUPP) || 978 (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) || 979 (ctrl->ctratt & NVME_CTRL_CTRATT_NVM_SETS); 980 } 981 982 /* 983 * Flags for __nvme_submit_sync_cmd() 984 */ 985 typedef __u32 __bitwise nvme_submit_flags_t; 986 987 enum { 988 /* Insert request at the head of the queue */ 989 NVME_SUBMIT_AT_HEAD = (__force nvme_submit_flags_t)(1 << 0), 990 /* Set BLK_MQ_REQ_NOWAIT when allocating request */ 991 NVME_SUBMIT_NOWAIT = (__force nvme_submit_flags_t)(1 << 1), 992 /* Set BLK_MQ_REQ_RESERVED when allocating request */ 993 NVME_SUBMIT_RESERVED = (__force nvme_submit_flags_t)(1 << 2), 994 /* Retry command when NVME_STATUS_DNR is not set in the result */ 995 NVME_SUBMIT_RETRY = (__force nvme_submit_flags_t)(1 << 3), 996 }; 997 998 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 999 void *buf, unsigned bufflen); 1000 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 1001 union nvme_result *result, void *buffer, unsigned bufflen, 1002 int qid, nvme_submit_flags_t flags); 1003 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid, 1004 unsigned int dword11, void *buffer, size_t buflen, 1005 void *result); 1006 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid, 1007 unsigned int dword11, void *buffer, size_t buflen, 1008 void *result); 1009 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 1010 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); 1011 int nvme_reset_ctrl(struct nvme_ctrl *ctrl); 1012 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl); 1013 int nvme_delete_ctrl(struct nvme_ctrl *ctrl); 1014 void nvme_queue_scan(struct nvme_ctrl *ctrl); 1015 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi, 1016 void *log, size_t size, u64 offset); 1017 void nvme_get_ns_head(struct nvme_ns_head *head); 1018 bool nvme_tryget_ns_head(struct nvme_ns_head *head); 1019 void nvme_put_ns_head(struct nvme_ns_head *head); 1020 int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device, 1021 const struct file_operations *fops, struct module *owner, 1022 int ctrl, int head); 1023 void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device); 1024 int nvme_ioctl(struct block_device *bdev, blk_mode_t mode, 1025 unsigned int cmd, unsigned long arg); 1026 long nvme_ns_chr_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 1027 int nvme_ns_head_ioctl(struct block_device *bdev, blk_mode_t mode, 1028 unsigned int cmd, unsigned long arg); 1029 long nvme_ns_head_chr_ioctl(struct file *file, unsigned int cmd, 1030 unsigned long arg); 1031 long nvme_dev_ioctl(struct file *file, unsigned int cmd, 1032 unsigned long arg); 1033 int nvme_ns_chr_uring_cmd_iopoll(struct io_uring_cmd *ioucmd, 1034 struct io_comp_batch *iob, unsigned int poll_flags); 1035 int nvme_ns_chr_uring_cmd(struct io_uring_cmd *ioucmd, 1036 unsigned int issue_flags); 1037 int nvme_ns_head_chr_uring_cmd(struct io_uring_cmd *ioucmd, 1038 unsigned int issue_flags); 1039 int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid, 1040 struct nvme_id_ns **id); 1041 int nvme_getgeo(struct gendisk *disk, struct hd_geometry *geo); 1042 int nvme_dev_uring_cmd(struct io_uring_cmd *ioucmd, unsigned int issue_flags); 1043 1044 extern const struct attribute_group *nvme_ns_attr_groups[]; 1045 extern const struct attribute_group nvme_ns_mpath_attr_group; 1046 extern const struct pr_ops nvme_pr_ops; 1047 extern const struct block_device_operations nvme_ns_head_ops; 1048 extern const struct attribute_group nvme_dev_attrs_group; 1049 extern const struct attribute_group nvme_dev_diag_attrs_group; 1050 extern const struct attribute_group *nvme_subsys_attrs_groups[]; 1051 extern const struct attribute_group *nvme_dev_attr_groups[]; 1052 extern const struct block_device_operations nvme_bdev_ops; 1053 1054 void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl); 1055 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head) 1056 __must_hold_shared(&head->srcu); 1057 #ifdef CONFIG_NVME_MULTIPATH 1058 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 1059 { 1060 return ctrl->ana_log_buf != NULL; 1061 } 1062 1063 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys) 1064 __must_hold(&subsys->lock); 1065 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys) 1066 __must_hold(&subsys->lock); 1067 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys) 1068 __must_hold(&subsys->lock); 1069 void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys); 1070 void nvme_failover_req(struct request *req); 1071 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl); 1072 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head); 1073 void nvme_mpath_add_sysfs_link(struct nvme_ns_head *ns); 1074 void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns); 1075 void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid); 1076 void nvme_mpath_put_disk(struct nvme_ns_head *head); 1077 int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id); 1078 void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl); 1079 void nvme_mpath_update(struct nvme_ctrl *ctrl); 1080 void nvme_mpath_uninit(struct nvme_ctrl *ctrl); 1081 void nvme_mpath_stop(struct nvme_ctrl *ctrl); 1082 bool nvme_mpath_clear_current_path(struct nvme_ns *ns); 1083 void nvme_mpath_revalidate_paths(struct nvme_ns_head *head); 1084 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl); 1085 void nvme_mpath_remove_disk(struct nvme_ns_head *head); 1086 void nvme_mpath_start_request(struct request *rq); 1087 void nvme_mpath_end_request(struct request *rq); 1088 1089 static inline void nvme_trace_bio_complete(struct request *req) 1090 { 1091 struct nvme_ns *ns = req->q->queuedata; 1092 1093 if ((req->cmd_flags & REQ_NVME_MPATH) && req->bio) 1094 trace_block_bio_complete(ns->head->disk->queue, req->bio); 1095 } 1096 1097 extern bool multipath; 1098 extern struct device_attribute dev_attr_ana_grpid; 1099 extern struct device_attribute dev_attr_ana_state; 1100 extern struct device_attribute dev_attr_queue_depth; 1101 extern struct device_attribute dev_attr_numa_nodes; 1102 extern struct device_attribute dev_attr_path_state; 1103 extern struct device_attribute dev_attr_delayed_removal_secs; 1104 extern struct device_attribute dev_attr_fail_on_ctrl_loss; 1105 extern struct device_attribute dev_attr_multipath_failover_count; 1106 extern struct device_attribute dev_attr_io_requeue_no_usable_path_count; 1107 extern struct device_attribute dev_attr_io_fail_no_available_path_count; 1108 extern struct device_attribute subsys_attr_iopolicy; 1109 extern struct device_attribute subsys_attr_iopolicies; 1110 1111 static inline bool nvme_disk_is_ns_head(struct gendisk *disk) 1112 { 1113 return disk->fops == &nvme_ns_head_ops; 1114 } 1115 static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head) 1116 { 1117 if (test_bit(NVME_NSHEAD_QUEUE_IF_NO_PATH, &head->flags)) 1118 return true; 1119 return false; 1120 } 1121 #else 1122 #define multipath false 1123 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 1124 { 1125 return false; 1126 } 1127 static inline void nvme_failover_req(struct request *req) 1128 { 1129 } 1130 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl) 1131 { 1132 } 1133 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, 1134 struct nvme_ns_head *head) 1135 { 1136 return 0; 1137 } 1138 static inline void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid) 1139 { 1140 } 1141 static inline void nvme_mpath_put_disk(struct nvme_ns_head *head) 1142 { 1143 } 1144 static inline void nvme_mpath_add_sysfs_link(struct nvme_ns *ns) 1145 { 1146 } 1147 static inline void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns) 1148 { 1149 } 1150 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns) 1151 { 1152 return false; 1153 } 1154 static inline void nvme_mpath_revalidate_paths(struct nvme_ns_head *head) 1155 { 1156 } 1157 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl) 1158 { 1159 } 1160 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head) 1161 { 1162 } 1163 static inline void nvme_trace_bio_complete(struct request *req) 1164 { 1165 } 1166 static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl) 1167 { 1168 } 1169 static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, 1170 struct nvme_id_ctrl *id) 1171 { 1172 if (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) 1173 dev_warn(ctrl->device, 1174 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n"); 1175 return 0; 1176 } 1177 static inline void nvme_mpath_update(struct nvme_ctrl *ctrl) 1178 { 1179 } 1180 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl) 1181 { 1182 } 1183 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl) 1184 { 1185 } 1186 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys) 1187 { 1188 } 1189 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys) 1190 { 1191 } 1192 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys) 1193 { 1194 } 1195 static inline void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys) 1196 { 1197 } 1198 static inline void nvme_mpath_start_request(struct request *rq) 1199 { 1200 } 1201 static inline void nvme_mpath_end_request(struct request *rq) 1202 { 1203 } 1204 static inline bool nvme_disk_is_ns_head(struct gendisk *disk) 1205 { 1206 return false; 1207 } 1208 static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head) 1209 { 1210 return false; 1211 } 1212 #endif /* CONFIG_NVME_MULTIPATH */ 1213 1214 #if defined(CONFIG_NVME_MULTIPATH) && defined(CONFIG_BLK_DEV_ZONED) 1215 int nvme_mpath_revalidate_zones(struct nvme_ns_head *head); 1216 #else 1217 static inline int nvme_mpath_revalidate_zones(struct nvme_ns_head *head) 1218 { 1219 return 0; 1220 } 1221 #endif 1222 1223 int nvme_ns_get_unique_id(struct nvme_ns *ns, u8 id[16], 1224 enum blk_unique_id type); 1225 1226 struct nvme_zone_info { 1227 u64 zone_size; 1228 unsigned int max_open_zones; 1229 unsigned int max_active_zones; 1230 }; 1231 1232 int nvme_ns_report_zones(struct nvme_ns *ns, sector_t sector, 1233 unsigned int nr_zones, struct blk_report_zones_args *args); 1234 int nvme_query_zone_info(struct nvme_ns *ns, unsigned lbaf, 1235 struct nvme_zone_info *zi); 1236 void nvme_update_zone_info(struct nvme_ns *ns, struct queue_limits *lim, 1237 struct nvme_zone_info *zi); 1238 #ifdef CONFIG_BLK_DEV_ZONED 1239 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req, 1240 struct nvme_command *cmnd, 1241 enum nvme_zone_mgmt_action action); 1242 #else 1243 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, 1244 struct request *req, struct nvme_command *cmnd, 1245 enum nvme_zone_mgmt_action action) 1246 { 1247 return BLK_STS_NOTSUPP; 1248 } 1249 #endif 1250 1251 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) 1252 { 1253 struct gendisk *disk = dev_to_disk(dev); 1254 1255 WARN_ON(nvme_disk_is_ns_head(disk)); 1256 return disk->private_data; 1257 } 1258 1259 #ifdef CONFIG_NVME_HWMON 1260 int nvme_hwmon_init(struct nvme_ctrl *ctrl); 1261 void nvme_hwmon_exit(struct nvme_ctrl *ctrl); 1262 #else 1263 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl) 1264 { 1265 return 0; 1266 } 1267 1268 static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl) 1269 { 1270 } 1271 #endif 1272 1273 static inline void nvme_start_request(struct request *rq) 1274 { 1275 if (rq->cmd_flags & REQ_NVME_MPATH) 1276 nvme_mpath_start_request(rq); 1277 blk_mq_start_request(rq); 1278 } 1279 1280 static inline bool nvme_ctrl_sgl_supported(struct nvme_ctrl *ctrl) 1281 { 1282 return ctrl->sgls & (NVME_CTRL_SGLS_BYTE_ALIGNED | 1283 NVME_CTRL_SGLS_DWORD_ALIGNED); 1284 } 1285 1286 static inline bool nvme_ctrl_meta_sgl_supported(struct nvme_ctrl *ctrl) 1287 { 1288 if (ctrl->ops->flags & NVME_F_FABRICS) 1289 return true; 1290 return ctrl->sgls & NVME_CTRL_SGLS_MSDS; 1291 } 1292 1293 #ifdef CONFIG_NVME_HOST_AUTH 1294 int __init nvme_init_auth(void); 1295 void __exit nvme_exit_auth(void); 1296 int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl); 1297 void nvme_auth_stop(struct nvme_ctrl *ctrl); 1298 int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid); 1299 int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid); 1300 void nvme_auth_free(struct nvme_ctrl *ctrl); 1301 void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl); 1302 #else 1303 static inline int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl) 1304 { 1305 return 0; 1306 } 1307 static inline int __init nvme_init_auth(void) 1308 { 1309 return 0; 1310 } 1311 static inline void __exit nvme_exit_auth(void) 1312 { 1313 } 1314 static inline void nvme_auth_stop(struct nvme_ctrl *ctrl) {}; 1315 static inline int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid) 1316 { 1317 return -EPROTONOSUPPORT; 1318 } 1319 static inline int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid) 1320 { 1321 return -EPROTONOSUPPORT; 1322 } 1323 static inline void nvme_auth_free(struct nvme_ctrl *ctrl) {}; 1324 static inline void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl) {}; 1325 #endif 1326 1327 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1328 u8 opcode); 1329 u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode) 1330 __cond_acquires(nonzero, &ctrl->subsys->lock) 1331 __cond_acquires(nonzero, &ctrl->scan_lock); 1332 1333 int nvme_execute_rq(struct request *rq, bool at_head); 1334 u32 nvme_passthru_end(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u32 effects, 1335 struct nvme_command *cmd, int status) 1336 __cond_releases(nonzero, &ctrl->scan_lock) 1337 __cond_releases(nonzero, &ctrl->subsys->lock); 1338 1339 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file); 1340 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid); 1341 bool nvme_get_ns(struct nvme_ns *ns); 1342 void nvme_put_ns(struct nvme_ns *ns); 1343 1344 static inline bool nvme_multi_css(struct nvme_ctrl *ctrl) 1345 { 1346 return (ctrl->ctrl_config & NVME_CC_CSS_MASK) == NVME_CC_CSS_CSI; 1347 } 1348 1349 #endif /* _NVME_H */ 1350