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