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 * The controller does not properly handle DMA addresses over 150 * 48 bits. 151 */ 152 NVME_QUIRK_DMA_ADDRESS_BITS_48 = (1 << 16), 153 }; 154 155 /* 156 * Common request structure for NVMe passthrough. All drivers must have 157 * this structure as the first member of their request-private data. 158 */ 159 struct nvme_request { 160 struct nvme_command *cmd; 161 union nvme_result result; 162 u8 retries; 163 u8 flags; 164 u16 status; 165 struct nvme_ctrl *ctrl; 166 }; 167 168 /* 169 * Mark a bio as coming in through the mpath node. 170 */ 171 #define REQ_NVME_MPATH REQ_DRV 172 173 enum { 174 NVME_REQ_CANCELLED = (1 << 0), 175 NVME_REQ_USERCMD = (1 << 1), 176 }; 177 178 static inline struct nvme_request *nvme_req(struct request *req) 179 { 180 return blk_mq_rq_to_pdu(req); 181 } 182 183 static inline u16 nvme_req_qid(struct request *req) 184 { 185 if (!req->q->queuedata) 186 return 0; 187 188 return req->mq_hctx->queue_num + 1; 189 } 190 191 /* The below value is the specific amount of delay needed before checking 192 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the 193 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was 194 * found empirically. 195 */ 196 #define NVME_QUIRK_DELAY_AMOUNT 2300 197 198 /* 199 * enum nvme_ctrl_state: Controller state 200 * 201 * @NVME_CTRL_NEW: New controller just allocated, initial state 202 * @NVME_CTRL_LIVE: Controller is connected and I/O capable 203 * @NVME_CTRL_RESETTING: Controller is resetting (or scheduled reset) 204 * @NVME_CTRL_CONNECTING: Controller is disconnected, now connecting the 205 * transport 206 * @NVME_CTRL_DELETING: Controller is deleting (or scheduled deletion) 207 * @NVME_CTRL_DELETING_NOIO: Controller is deleting and I/O is not 208 * disabled/failed immediately. This state comes 209 * after all async event processing took place and 210 * before ns removal and the controller deletion 211 * progress 212 * @NVME_CTRL_DEAD: Controller is non-present/unresponsive during 213 * shutdown or removal. In this case we forcibly 214 * kill all inflight I/O as they have no chance to 215 * complete 216 */ 217 enum nvme_ctrl_state { 218 NVME_CTRL_NEW, 219 NVME_CTRL_LIVE, 220 NVME_CTRL_RESETTING, 221 NVME_CTRL_CONNECTING, 222 NVME_CTRL_DELETING, 223 NVME_CTRL_DELETING_NOIO, 224 NVME_CTRL_DEAD, 225 }; 226 227 struct nvme_fault_inject { 228 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 229 struct fault_attr attr; 230 struct dentry *parent; 231 bool dont_retry; /* DNR, do not retry */ 232 u16 status; /* status code */ 233 #endif 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 #ifdef CONFIG_NVME_HWMON 256 struct device *hwmon_device; 257 #endif 258 struct cdev cdev; 259 struct work_struct reset_work; 260 struct work_struct delete_work; 261 wait_queue_head_t state_wq; 262 263 struct nvme_subsystem *subsys; 264 struct list_head subsys_entry; 265 266 struct opal_dev *opal_dev; 267 268 char name[12]; 269 u16 cntlid; 270 271 u32 ctrl_config; 272 u16 mtfa; 273 u32 queue_count; 274 275 u64 cap; 276 u32 max_hw_sectors; 277 u32 max_segments; 278 u32 max_integrity_segments; 279 u32 max_discard_sectors; 280 u32 max_discard_segments; 281 u32 max_zeroes_sectors; 282 #ifdef CONFIG_BLK_DEV_ZONED 283 u32 max_zone_append; 284 #endif 285 u16 crdt[3]; 286 u16 oncs; 287 u16 oacs; 288 u16 nssa; 289 u16 nr_streams; 290 u16 sqsize; 291 u32 max_namespaces; 292 atomic_t abort_limit; 293 u8 vwc; 294 u32 vs; 295 u32 sgls; 296 u16 kas; 297 u8 npss; 298 u8 apsta; 299 u16 wctemp; 300 u16 cctemp; 301 u32 oaes; 302 u32 aen_result; 303 u32 ctratt; 304 unsigned int shutdown_timeout; 305 unsigned int kato; 306 bool subsystem; 307 unsigned long quirks; 308 struct nvme_id_power_state psd[32]; 309 struct nvme_effects_log *effects; 310 struct xarray cels; 311 struct work_struct scan_work; 312 struct work_struct async_event_work; 313 struct delayed_work ka_work; 314 struct delayed_work failfast_work; 315 struct nvme_command ka_cmd; 316 struct work_struct fw_act_work; 317 unsigned long events; 318 319 #ifdef CONFIG_NVME_MULTIPATH 320 /* asymmetric namespace access: */ 321 u8 anacap; 322 u8 anatt; 323 u32 anagrpmax; 324 u32 nanagrpid; 325 struct mutex ana_lock; 326 struct nvme_ana_rsp_hdr *ana_log_buf; 327 size_t ana_log_size; 328 struct timer_list anatt_timer; 329 struct work_struct ana_work; 330 #endif 331 332 /* Power saving configuration */ 333 u64 ps_max_latency_us; 334 bool apst_enabled; 335 336 /* PCIe only: */ 337 u32 hmpre; 338 u32 hmmin; 339 u32 hmminds; 340 u16 hmmaxd; 341 342 /* Fabrics only */ 343 u32 ioccsz; 344 u32 iorcsz; 345 u16 icdoff; 346 u16 maxcmd; 347 int nr_reconnects; 348 unsigned long flags; 349 #define NVME_CTRL_FAILFAST_EXPIRED 0 350 struct nvmf_ctrl_options *opts; 351 352 struct page *discard_page; 353 unsigned long discard_page_busy; 354 355 struct nvme_fault_inject fault_inject; 356 }; 357 358 enum nvme_iopolicy { 359 NVME_IOPOLICY_NUMA, 360 NVME_IOPOLICY_RR, 361 }; 362 363 struct nvme_subsystem { 364 int instance; 365 struct device dev; 366 /* 367 * Because we unregister the device on the last put we need 368 * a separate refcount. 369 */ 370 struct kref ref; 371 struct list_head entry; 372 struct mutex lock; 373 struct list_head ctrls; 374 struct list_head nsheads; 375 char subnqn[NVMF_NQN_SIZE]; 376 char serial[20]; 377 char model[40]; 378 char firmware_rev[8]; 379 u8 cmic; 380 u16 vendor_id; 381 u16 awupf; /* 0's based awupf value. */ 382 struct ida ns_ida; 383 #ifdef CONFIG_NVME_MULTIPATH 384 enum nvme_iopolicy iopolicy; 385 #endif 386 }; 387 388 /* 389 * Container structure for uniqueue namespace identifiers. 390 */ 391 struct nvme_ns_ids { 392 u8 eui64[8]; 393 u8 nguid[16]; 394 uuid_t uuid; 395 u8 csi; 396 }; 397 398 /* 399 * Anchor structure for namespaces. There is one for each namespace in a 400 * NVMe subsystem that any of our controllers can see, and the namespace 401 * structure for each controller is chained of it. For private namespaces 402 * there is a 1:1 relation to our namespace structures, that is ->list 403 * only ever has a single entry for private namespaces. 404 */ 405 struct nvme_ns_head { 406 struct list_head list; 407 struct srcu_struct srcu; 408 struct nvme_subsystem *subsys; 409 unsigned ns_id; 410 struct nvme_ns_ids ids; 411 struct list_head entry; 412 struct kref ref; 413 bool shared; 414 int instance; 415 struct nvme_effects_log *effects; 416 struct gendisk *disk; 417 #ifdef CONFIG_NVME_MULTIPATH 418 struct bio_list requeue_list; 419 spinlock_t requeue_lock; 420 struct work_struct requeue_work; 421 struct mutex lock; 422 unsigned long flags; 423 #define NVME_NSHEAD_DISK_LIVE 0 424 struct nvme_ns __rcu *current_path[]; 425 #endif 426 }; 427 428 static inline bool nvme_ns_head_multipath(struct nvme_ns_head *head) 429 { 430 return IS_ENABLED(CONFIG_NVME_MULTIPATH) && head->disk; 431 } 432 433 enum nvme_ns_features { 434 NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */ 435 NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */ 436 }; 437 438 struct nvme_ns { 439 struct list_head list; 440 441 struct nvme_ctrl *ctrl; 442 struct request_queue *queue; 443 struct gendisk *disk; 444 #ifdef CONFIG_NVME_MULTIPATH 445 enum nvme_ana_state ana_state; 446 u32 ana_grpid; 447 #endif 448 struct list_head siblings; 449 struct nvm_dev *ndev; 450 struct kref kref; 451 struct nvme_ns_head *head; 452 453 int lba_shift; 454 u16 ms; 455 u16 sgs; 456 u32 sws; 457 u8 pi_type; 458 #ifdef CONFIG_BLK_DEV_ZONED 459 u64 zsze; 460 #endif 461 unsigned long features; 462 unsigned long flags; 463 #define NVME_NS_REMOVING 0 464 #define NVME_NS_DEAD 1 465 #define NVME_NS_ANA_PENDING 2 466 #define NVME_NS_FORCE_RO 3 467 468 struct nvme_fault_inject fault_inject; 469 470 }; 471 472 /* NVMe ns supports metadata actions by the controller (generate/strip) */ 473 static inline bool nvme_ns_has_pi(struct nvme_ns *ns) 474 { 475 return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple); 476 } 477 478 struct nvme_ctrl_ops { 479 const char *name; 480 struct module *module; 481 unsigned int flags; 482 #define NVME_F_FABRICS (1 << 0) 483 #define NVME_F_METADATA_SUPPORTED (1 << 1) 484 #define NVME_F_PCI_P2PDMA (1 << 2) 485 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 486 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 487 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 488 void (*free_ctrl)(struct nvme_ctrl *ctrl); 489 void (*submit_async_event)(struct nvme_ctrl *ctrl); 490 void (*delete_ctrl)(struct nvme_ctrl *ctrl); 491 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); 492 }; 493 494 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 495 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 496 const char *dev_name); 497 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject); 498 void nvme_should_fail(struct request *req); 499 #else 500 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 501 const char *dev_name) 502 { 503 } 504 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj) 505 { 506 } 507 static inline void nvme_should_fail(struct request *req) {} 508 #endif 509 510 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 511 { 512 if (!ctrl->subsystem) 513 return -ENOTTY; 514 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65); 515 } 516 517 /* 518 * Convert a 512B sector number to a device logical block number. 519 */ 520 static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector) 521 { 522 return sector >> (ns->lba_shift - SECTOR_SHIFT); 523 } 524 525 /* 526 * Convert a device logical block number to a 512B sector number. 527 */ 528 static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba) 529 { 530 return lba << (ns->lba_shift - SECTOR_SHIFT); 531 } 532 533 /* 534 * Convert byte length to nvme's 0-based num dwords 535 */ 536 static inline u32 nvme_bytes_to_numd(size_t len) 537 { 538 return (len >> 2) - 1; 539 } 540 541 static inline bool nvme_is_ana_error(u16 status) 542 { 543 switch (status & 0x7ff) { 544 case NVME_SC_ANA_TRANSITION: 545 case NVME_SC_ANA_INACCESSIBLE: 546 case NVME_SC_ANA_PERSISTENT_LOSS: 547 return true; 548 default: 549 return false; 550 } 551 } 552 553 static inline bool nvme_is_path_error(u16 status) 554 { 555 /* check for a status code type of 'path related status' */ 556 return (status & 0x700) == 0x300; 557 } 558 559 /* 560 * Fill in the status and result information from the CQE, and then figure out 561 * if blk-mq will need to use IPI magic to complete the request, and if yes do 562 * so. If not let the caller complete the request without an indirect function 563 * call. 564 */ 565 static inline bool nvme_try_complete_req(struct request *req, __le16 status, 566 union nvme_result result) 567 { 568 struct nvme_request *rq = nvme_req(req); 569 570 rq->status = le16_to_cpu(status) >> 1; 571 rq->result = result; 572 /* inject error when permitted by fault injection framework */ 573 nvme_should_fail(req); 574 if (unlikely(blk_should_fake_timeout(req->q))) 575 return true; 576 return blk_mq_complete_request_remote(req); 577 } 578 579 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl) 580 { 581 get_device(ctrl->device); 582 } 583 584 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl) 585 { 586 put_device(ctrl->device); 587 } 588 589 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id) 590 { 591 return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH; 592 } 593 594 void nvme_complete_rq(struct request *req); 595 blk_status_t nvme_host_path_error(struct request *req); 596 bool nvme_cancel_request(struct request *req, void *data, bool reserved); 597 void nvme_cancel_tagset(struct nvme_ctrl *ctrl); 598 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl); 599 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 600 enum nvme_ctrl_state new_state); 601 bool nvme_wait_reset(struct nvme_ctrl *ctrl); 602 int nvme_disable_ctrl(struct nvme_ctrl *ctrl); 603 int nvme_enable_ctrl(struct nvme_ctrl *ctrl); 604 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl); 605 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 606 const struct nvme_ctrl_ops *ops, unsigned long quirks); 607 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 608 void nvme_start_ctrl(struct nvme_ctrl *ctrl); 609 void nvme_stop_ctrl(struct nvme_ctrl *ctrl); 610 int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl); 611 612 void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 613 614 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len, 615 bool send); 616 617 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, 618 volatile union nvme_result *res); 619 620 void nvme_stop_queues(struct nvme_ctrl *ctrl); 621 void nvme_start_queues(struct nvme_ctrl *ctrl); 622 void nvme_kill_queues(struct nvme_ctrl *ctrl); 623 void nvme_sync_queues(struct nvme_ctrl *ctrl); 624 void nvme_sync_io_queues(struct nvme_ctrl *ctrl); 625 void nvme_unfreeze(struct nvme_ctrl *ctrl); 626 void nvme_wait_freeze(struct nvme_ctrl *ctrl); 627 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout); 628 void nvme_start_freeze(struct nvme_ctrl *ctrl); 629 630 #define NVME_QID_ANY -1 631 struct request *nvme_alloc_request(struct request_queue *q, 632 struct nvme_command *cmd, blk_mq_req_flags_t flags); 633 void nvme_cleanup_cmd(struct request *req); 634 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req); 635 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 636 void *buf, unsigned bufflen); 637 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 638 union nvme_result *result, void *buffer, unsigned bufflen, 639 unsigned timeout, int qid, int at_head, 640 blk_mq_req_flags_t flags, bool poll); 641 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid, 642 unsigned int dword11, void *buffer, size_t buflen, 643 u32 *result); 644 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid, 645 unsigned int dword11, void *buffer, size_t buflen, 646 u32 *result); 647 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 648 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); 649 int nvme_reset_ctrl(struct nvme_ctrl *ctrl); 650 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl); 651 int nvme_try_sched_reset(struct nvme_ctrl *ctrl); 652 int nvme_delete_ctrl(struct nvme_ctrl *ctrl); 653 void nvme_queue_scan(struct nvme_ctrl *ctrl); 654 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi, 655 void *log, size_t size, u64 offset); 656 struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk, 657 struct nvme_ns_head **head, int *srcu_idx); 658 void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx); 659 bool nvme_tryget_ns_head(struct nvme_ns_head *head); 660 void nvme_put_ns_head(struct nvme_ns_head *head); 661 struct nvme_ctrl *nvme_find_get_live_ctrl(struct nvme_subsystem *subsys); 662 int nvme_ioctl(struct block_device *bdev, fmode_t mode, 663 unsigned int cmd, unsigned long arg); 664 int nvme_ns_head_ioctl(struct block_device *bdev, fmode_t mode, 665 unsigned int cmd, unsigned long arg); 666 long nvme_dev_ioctl(struct file *file, unsigned int cmd, 667 unsigned long arg); 668 int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo); 669 670 extern const struct attribute_group *nvme_ns_id_attr_groups[]; 671 extern const struct pr_ops nvme_pr_ops; 672 extern const struct block_device_operations nvme_ns_head_ops; 673 674 #ifdef CONFIG_NVME_MULTIPATH 675 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 676 { 677 return ctrl->ana_log_buf != NULL; 678 } 679 680 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys); 681 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys); 682 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys); 683 bool nvme_mpath_set_disk_name(struct nvme_ns *ns, char *disk_name, int *flags); 684 void nvme_failover_req(struct request *req); 685 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl); 686 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head); 687 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id); 688 void nvme_mpath_remove_disk(struct nvme_ns_head *head); 689 int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id); 690 void nvme_mpath_uninit(struct nvme_ctrl *ctrl); 691 void nvme_mpath_stop(struct nvme_ctrl *ctrl); 692 bool nvme_mpath_clear_current_path(struct nvme_ns *ns); 693 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl); 694 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head); 695 696 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) 697 { 698 struct nvme_ns_head *head = ns->head; 699 700 if (head->disk && list_empty(&head->list)) 701 kblockd_schedule_work(&head->requeue_work); 702 } 703 704 static inline void nvme_trace_bio_complete(struct request *req) 705 { 706 struct nvme_ns *ns = req->q->queuedata; 707 708 if (req->cmd_flags & REQ_NVME_MPATH) 709 trace_block_bio_complete(ns->head->disk->queue, req->bio); 710 } 711 712 extern struct device_attribute dev_attr_ana_grpid; 713 extern struct device_attribute dev_attr_ana_state; 714 extern struct device_attribute subsys_attr_iopolicy; 715 716 #else 717 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 718 { 719 return false; 720 } 721 static inline bool nvme_mpath_set_disk_name(struct nvme_ns *ns, char *disk_name, 722 int *flags) 723 { 724 return false; 725 } 726 static inline void nvme_failover_req(struct request *req) 727 { 728 } 729 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl) 730 { 731 } 732 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, 733 struct nvme_ns_head *head) 734 { 735 return 0; 736 } 737 static inline void nvme_mpath_add_disk(struct nvme_ns *ns, 738 struct nvme_id_ns *id) 739 { 740 } 741 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head) 742 { 743 } 744 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns) 745 { 746 return false; 747 } 748 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl) 749 { 750 } 751 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) 752 { 753 } 754 static inline void nvme_trace_bio_complete(struct request *req) 755 { 756 } 757 static inline int nvme_mpath_init(struct nvme_ctrl *ctrl, 758 struct nvme_id_ctrl *id) 759 { 760 if (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) 761 dev_warn(ctrl->device, 762 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n"); 763 return 0; 764 } 765 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl) 766 { 767 } 768 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl) 769 { 770 } 771 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys) 772 { 773 } 774 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys) 775 { 776 } 777 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys) 778 { 779 } 780 #endif /* CONFIG_NVME_MULTIPATH */ 781 782 int nvme_revalidate_zones(struct nvme_ns *ns); 783 #ifdef CONFIG_BLK_DEV_ZONED 784 int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf); 785 int nvme_report_zones(struct gendisk *disk, sector_t sector, 786 unsigned int nr_zones, report_zones_cb cb, void *data); 787 788 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req, 789 struct nvme_command *cmnd, 790 enum nvme_zone_mgmt_action action); 791 #else 792 #define nvme_report_zones NULL 793 794 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, 795 struct request *req, struct nvme_command *cmnd, 796 enum nvme_zone_mgmt_action action) 797 { 798 return BLK_STS_NOTSUPP; 799 } 800 801 static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf) 802 { 803 dev_warn(ns->ctrl->device, 804 "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n"); 805 return -EPROTONOSUPPORT; 806 } 807 #endif 808 809 #ifdef CONFIG_NVM 810 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node); 811 void nvme_nvm_unregister(struct nvme_ns *ns); 812 extern const struct attribute_group nvme_nvm_attr_group; 813 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, void __user *argp); 814 #else 815 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, 816 int node) 817 { 818 return 0; 819 } 820 821 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {}; 822 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, 823 void __user *argp) 824 { 825 return -ENOTTY; 826 } 827 #endif /* CONFIG_NVM */ 828 829 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) 830 { 831 return dev_to_disk(dev)->private_data; 832 } 833 834 #ifdef CONFIG_NVME_HWMON 835 int nvme_hwmon_init(struct nvme_ctrl *ctrl); 836 void nvme_hwmon_exit(struct nvme_ctrl *ctrl); 837 #else 838 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl) 839 { 840 return 0; 841 } 842 843 static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl) 844 { 845 } 846 #endif 847 848 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 849 u8 opcode); 850 void nvme_execute_passthru_rq(struct request *rq); 851 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file); 852 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid); 853 void nvme_put_ns(struct nvme_ns *ns); 854 855 #endif /* _NVME_H */ 856