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