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