157dacad5SJay Sternberg /* 257dacad5SJay Sternberg * Copyright (c) 2011-2014, Intel Corporation. 357dacad5SJay Sternberg * 457dacad5SJay Sternberg * This program is free software; you can redistribute it and/or modify it 557dacad5SJay Sternberg * under the terms and conditions of the GNU General Public License, 657dacad5SJay Sternberg * version 2, as published by the Free Software Foundation. 757dacad5SJay Sternberg * 857dacad5SJay Sternberg * This program is distributed in the hope it will be useful, but WITHOUT 957dacad5SJay Sternberg * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1057dacad5SJay Sternberg * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 1157dacad5SJay Sternberg * more details. 1257dacad5SJay Sternberg */ 1357dacad5SJay Sternberg 1457dacad5SJay Sternberg #ifndef _NVME_H 1557dacad5SJay Sternberg #define _NVME_H 1657dacad5SJay Sternberg 1757dacad5SJay Sternberg #include <linux/nvme.h> 18a6a5149bSChristoph Hellwig #include <linux/cdev.h> 1957dacad5SJay Sternberg #include <linux/pci.h> 2057dacad5SJay Sternberg #include <linux/kref.h> 2157dacad5SJay Sternberg #include <linux/blk-mq.h> 22b0b4e09cSMatias Bjørling #include <linux/lightnvm.h> 23a98e58e5SScott Bauer #include <linux/sed-opal.h> 24b9e03857SThomas Tai #include <linux/fault-inject.h> 25978628ecSJohannes Thumshirn #include <linux/rcupdate.h> 2657dacad5SJay Sternberg 278ae4e447SMarc Olson extern unsigned int nvme_io_timeout; 2857dacad5SJay Sternberg #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) 2957dacad5SJay Sternberg 308ae4e447SMarc Olson extern unsigned int admin_timeout; 3121d34711SChristoph Hellwig #define ADMIN_TIMEOUT (admin_timeout * HZ) 3221d34711SChristoph Hellwig 33038bd4cbSSagi Grimberg #define NVME_DEFAULT_KATO 5 34038bd4cbSSagi Grimberg #define NVME_KATO_GRACE 10 35038bd4cbSSagi Grimberg 369a6327d2SSagi Grimberg extern struct workqueue_struct *nvme_wq; 37b227c59bSRoy Shterman extern struct workqueue_struct *nvme_reset_wq; 38b227c59bSRoy Shterman extern struct workqueue_struct *nvme_delete_wq; 399a6327d2SSagi Grimberg 40ca064085SMatias Bjørling enum { 41ca064085SMatias Bjørling NVME_NS_LBA = 0, 42ca064085SMatias Bjørling NVME_NS_LIGHTNVM = 1, 43ca064085SMatias Bjørling }; 44ca064085SMatias Bjørling 4557dacad5SJay Sternberg /* 46106198edSChristoph Hellwig * List of workarounds for devices that required behavior not specified in 47106198edSChristoph Hellwig * the standard. 4857dacad5SJay Sternberg */ 49106198edSChristoph Hellwig enum nvme_quirks { 50106198edSChristoph Hellwig /* 51106198edSChristoph Hellwig * Prefers I/O aligned to a stripe size specified in a vendor 52106198edSChristoph Hellwig * specific Identify field. 53106198edSChristoph Hellwig */ 54106198edSChristoph Hellwig NVME_QUIRK_STRIPE_SIZE = (1 << 0), 55540c801cSKeith Busch 56540c801cSKeith Busch /* 57540c801cSKeith Busch * The controller doesn't handle Identify value others than 0 or 1 58540c801cSKeith Busch * correctly. 59540c801cSKeith Busch */ 60540c801cSKeith Busch NVME_QUIRK_IDENTIFY_CNS = (1 << 1), 6108095e70SKeith Busch 6208095e70SKeith Busch /* 63e850fd16SChristoph Hellwig * The controller deterministically returns O's on reads to 64e850fd16SChristoph Hellwig * logical blocks that deallocate was called on. 6508095e70SKeith Busch */ 66e850fd16SChristoph Hellwig NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2), 6754adc010SGuilherme G. Piccoli 6854adc010SGuilherme G. Piccoli /* 6954adc010SGuilherme G. Piccoli * The controller needs a delay before starts checking the device 7054adc010SGuilherme G. Piccoli * readiness, which is done by reading the NVME_CSTS_RDY bit. 7154adc010SGuilherme G. Piccoli */ 7254adc010SGuilherme G. Piccoli NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3), 73c5552fdeSAndy Lutomirski 74c5552fdeSAndy Lutomirski /* 75c5552fdeSAndy Lutomirski * APST should not be used. 76c5552fdeSAndy Lutomirski */ 77c5552fdeSAndy Lutomirski NVME_QUIRK_NO_APST = (1 << 4), 78ff5350a8SAndy Lutomirski 79ff5350a8SAndy Lutomirski /* 80ff5350a8SAndy Lutomirski * The deepest sleep state should not be used. 81ff5350a8SAndy Lutomirski */ 82ff5350a8SAndy Lutomirski NVME_QUIRK_NO_DEEPEST_PS = (1 << 5), 83608cc4b1SChristoph Hellwig 84608cc4b1SChristoph Hellwig /* 85608cc4b1SChristoph Hellwig * Supports the LighNVM command set if indicated in vs[1]. 86608cc4b1SChristoph Hellwig */ 87608cc4b1SChristoph Hellwig NVME_QUIRK_LIGHTNVM = (1 << 6), 88106198edSChristoph Hellwig }; 89106198edSChristoph Hellwig 90d49187e9SChristoph Hellwig /* 91d49187e9SChristoph Hellwig * Common request structure for NVMe passthrough. All drivers must have 92d49187e9SChristoph Hellwig * this structure as the first member of their request-private data. 93d49187e9SChristoph Hellwig */ 94d49187e9SChristoph Hellwig struct nvme_request { 95d49187e9SChristoph Hellwig struct nvme_command *cmd; 96d49187e9SChristoph Hellwig union nvme_result result; 9744e44b29SChristoph Hellwig u8 retries; 9827fa9bc5SChristoph Hellwig u8 flags; 9927fa9bc5SChristoph Hellwig u16 status; 10027fa9bc5SChristoph Hellwig }; 10127fa9bc5SChristoph Hellwig 10232acab31SChristoph Hellwig /* 10332acab31SChristoph Hellwig * Mark a bio as coming in through the mpath node. 10432acab31SChristoph Hellwig */ 10532acab31SChristoph Hellwig #define REQ_NVME_MPATH REQ_DRV 10632acab31SChristoph Hellwig 10727fa9bc5SChristoph Hellwig enum { 10827fa9bc5SChristoph Hellwig NVME_REQ_CANCELLED = (1 << 0), 109bb06ec31SJames Smart NVME_REQ_USERCMD = (1 << 1), 110d49187e9SChristoph Hellwig }; 111d49187e9SChristoph Hellwig 112d49187e9SChristoph Hellwig static inline struct nvme_request *nvme_req(struct request *req) 113d49187e9SChristoph Hellwig { 114d49187e9SChristoph Hellwig return blk_mq_rq_to_pdu(req); 115d49187e9SChristoph Hellwig } 116d49187e9SChristoph Hellwig 11754adc010SGuilherme G. Piccoli /* The below value is the specific amount of delay needed before checking 11854adc010SGuilherme G. Piccoli * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the 11954adc010SGuilherme G. Piccoli * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was 12054adc010SGuilherme G. Piccoli * found empirically. 12154adc010SGuilherme G. Piccoli */ 1228c97eeccSJeff Lien #define NVME_QUIRK_DELAY_AMOUNT 2300 12354adc010SGuilherme G. Piccoli 124bb8d261eSChristoph Hellwig enum nvme_ctrl_state { 125bb8d261eSChristoph Hellwig NVME_CTRL_NEW, 126bb8d261eSChristoph Hellwig NVME_CTRL_LIVE, 1272b1b7e78SJianchao Wang NVME_CTRL_ADMIN_ONLY, /* Only admin queue live */ 128bb8d261eSChristoph Hellwig NVME_CTRL_RESETTING, 129ad6a0a52SMax Gurtovoy NVME_CTRL_CONNECTING, 130bb8d261eSChristoph Hellwig NVME_CTRL_DELETING, 1310ff9d4e1SKeith Busch NVME_CTRL_DEAD, 132bb8d261eSChristoph Hellwig }; 133bb8d261eSChristoph Hellwig 1341c63dc66SChristoph Hellwig struct nvme_ctrl { 135bb8d261eSChristoph Hellwig enum nvme_ctrl_state state; 136bd4da3abSAndy Lutomirski bool identified; 137bb8d261eSChristoph Hellwig spinlock_t lock; 1381c63dc66SChristoph Hellwig const struct nvme_ctrl_ops *ops; 13957dacad5SJay Sternberg struct request_queue *admin_q; 14007bfcd09SChristoph Hellwig struct request_queue *connect_q; 14157dacad5SJay Sternberg struct device *dev; 14257dacad5SJay Sternberg int instance; 1435bae7f73SChristoph Hellwig struct blk_mq_tag_set *tagset; 14434b6c231SSagi Grimberg struct blk_mq_tag_set *admin_tagset; 1455bae7f73SChristoph Hellwig struct list_head namespaces; 146765cc031SJianchao Wang struct rw_semaphore namespaces_rwsem; 147d22524a4SChristoph Hellwig struct device ctrl_device; 1485bae7f73SChristoph Hellwig struct device *device; /* char device */ 149a6a5149bSChristoph Hellwig struct cdev cdev; 150d86c4d8eSChristoph Hellwig struct work_struct reset_work; 151c5017e85SChristoph Hellwig struct work_struct delete_work; 1521c63dc66SChristoph Hellwig 153ab9e00ccSChristoph Hellwig struct nvme_subsystem *subsys; 154ab9e00ccSChristoph Hellwig struct list_head subsys_entry; 155ab9e00ccSChristoph Hellwig 1564f1244c8SChristoph Hellwig struct opal_dev *opal_dev; 157a98e58e5SScott Bauer 15857dacad5SJay Sternberg char name[12]; 15976e3914aSChristoph Hellwig u16 cntlid; 1605fd4ce1bSChristoph Hellwig 1615fd4ce1bSChristoph Hellwig u32 ctrl_config; 162b6dccf7fSArnav Dawn u16 mtfa; 163d858e5f0SSagi Grimberg u32 queue_count; 1645fd4ce1bSChristoph Hellwig 16520d0dfe6SSagi Grimberg u64 cap; 1665fd4ce1bSChristoph Hellwig u32 page_size; 16757dacad5SJay Sternberg u32 max_hw_sectors; 16857dacad5SJay Sternberg u16 oncs; 1698a9ae523SScott Bauer u16 oacs; 170f5d11840SJens Axboe u16 nssa; 171f5d11840SJens Axboe u16 nr_streams; 1726bf25d16SChristoph Hellwig atomic_t abort_limit; 17357dacad5SJay Sternberg u8 vwc; 174f3ca80fcSChristoph Hellwig u32 vs; 17507bfcd09SChristoph Hellwig u32 sgls; 176038bd4cbSSagi Grimberg u16 kas; 177c5552fdeSAndy Lutomirski u8 npss; 178c5552fdeSAndy Lutomirski u8 apsta; 179c0561f82SHannes Reinecke u32 oaes; 180e3d7874dSKeith Busch u32 aen_result; 18107fbd32aSMartin K. Petersen unsigned int shutdown_timeout; 182038bd4cbSSagi Grimberg unsigned int kato; 183f3ca80fcSChristoph Hellwig bool subsystem; 184106198edSChristoph Hellwig unsigned long quirks; 185c5552fdeSAndy Lutomirski struct nvme_id_power_state psd[32]; 18684fef62dSKeith Busch struct nvme_effects_log *effects; 1875955be21SChristoph Hellwig struct work_struct scan_work; 188f866fc42SChristoph Hellwig struct work_struct async_event_work; 189038bd4cbSSagi Grimberg struct delayed_work ka_work; 1900a34e466SRoland Dreier struct nvme_command ka_cmd; 191b6dccf7fSArnav Dawn struct work_struct fw_act_work; 19207bfcd09SChristoph Hellwig 193c5552fdeSAndy Lutomirski /* Power saving configuration */ 194c5552fdeSAndy Lutomirski u64 ps_max_latency_us; 19576a5af84SKai-Heng Feng bool apst_enabled; 196c5552fdeSAndy Lutomirski 197044a9df1SChristoph Hellwig /* PCIe only: */ 198fe6d53c9SChristoph Hellwig u32 hmpre; 199fe6d53c9SChristoph Hellwig u32 hmmin; 200044a9df1SChristoph Hellwig u32 hmminds; 201044a9df1SChristoph Hellwig u16 hmmaxd; 202fe6d53c9SChristoph Hellwig 20307bfcd09SChristoph Hellwig /* Fabrics only */ 20407bfcd09SChristoph Hellwig u16 sqsize; 20507bfcd09SChristoph Hellwig u32 ioccsz; 20607bfcd09SChristoph Hellwig u32 iorcsz; 20707bfcd09SChristoph Hellwig u16 icdoff; 20807bfcd09SChristoph Hellwig u16 maxcmd; 209fdf9dfa8SSagi Grimberg int nr_reconnects; 21007bfcd09SChristoph Hellwig struct nvmf_ctrl_options *opts; 21157dacad5SJay Sternberg }; 21257dacad5SJay Sternberg 213ab9e00ccSChristoph Hellwig struct nvme_subsystem { 214ab9e00ccSChristoph Hellwig int instance; 215ab9e00ccSChristoph Hellwig struct device dev; 216ab9e00ccSChristoph Hellwig /* 217ab9e00ccSChristoph Hellwig * Because we unregister the device on the last put we need 218ab9e00ccSChristoph Hellwig * a separate refcount. 219ab9e00ccSChristoph Hellwig */ 220ab9e00ccSChristoph Hellwig struct kref ref; 221ab9e00ccSChristoph Hellwig struct list_head entry; 222ab9e00ccSChristoph Hellwig struct mutex lock; 223ab9e00ccSChristoph Hellwig struct list_head ctrls; 224ed754e5dSChristoph Hellwig struct list_head nsheads; 225ab9e00ccSChristoph Hellwig char subnqn[NVMF_NQN_SIZE]; 226ab9e00ccSChristoph Hellwig char serial[20]; 227ab9e00ccSChristoph Hellwig char model[40]; 228ab9e00ccSChristoph Hellwig char firmware_rev[8]; 229ab9e00ccSChristoph Hellwig u8 cmic; 230ab9e00ccSChristoph Hellwig u16 vendor_id; 231ed754e5dSChristoph Hellwig struct ida ns_ida; 232ab9e00ccSChristoph Hellwig }; 233ab9e00ccSChristoph Hellwig 234002fab04SChristoph Hellwig /* 235002fab04SChristoph Hellwig * Container structure for uniqueue namespace identifiers. 236002fab04SChristoph Hellwig */ 237002fab04SChristoph Hellwig struct nvme_ns_ids { 238002fab04SChristoph Hellwig u8 eui64[8]; 239002fab04SChristoph Hellwig u8 nguid[16]; 240002fab04SChristoph Hellwig uuid_t uuid; 241002fab04SChristoph Hellwig }; 242002fab04SChristoph Hellwig 243ed754e5dSChristoph Hellwig /* 244ed754e5dSChristoph Hellwig * Anchor structure for namespaces. There is one for each namespace in a 245ed754e5dSChristoph Hellwig * NVMe subsystem that any of our controllers can see, and the namespace 246ed754e5dSChristoph Hellwig * structure for each controller is chained of it. For private namespaces 247ed754e5dSChristoph Hellwig * there is a 1:1 relation to our namespace structures, that is ->list 248ed754e5dSChristoph Hellwig * only ever has a single entry for private namespaces. 249ed754e5dSChristoph Hellwig */ 250ed754e5dSChristoph Hellwig struct nvme_ns_head { 25132acab31SChristoph Hellwig #ifdef CONFIG_NVME_MULTIPATH 25232acab31SChristoph Hellwig struct gendisk *disk; 25332acab31SChristoph Hellwig struct nvme_ns __rcu *current_path; 25432acab31SChristoph Hellwig struct bio_list requeue_list; 25532acab31SChristoph Hellwig spinlock_t requeue_lock; 25632acab31SChristoph Hellwig struct work_struct requeue_work; 25732acab31SChristoph Hellwig #endif 258ed754e5dSChristoph Hellwig struct list_head list; 259ed754e5dSChristoph Hellwig struct srcu_struct srcu; 260ed754e5dSChristoph Hellwig struct nvme_subsystem *subsys; 261ed754e5dSChristoph Hellwig unsigned ns_id; 262ed754e5dSChristoph Hellwig struct nvme_ns_ids ids; 263ed754e5dSChristoph Hellwig struct list_head entry; 264ed754e5dSChristoph Hellwig struct kref ref; 265ed754e5dSChristoph Hellwig int instance; 266ed754e5dSChristoph Hellwig }; 267ed754e5dSChristoph Hellwig 268b9e03857SThomas Tai #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 269b9e03857SThomas Tai struct nvme_fault_inject { 270b9e03857SThomas Tai struct fault_attr attr; 271b9e03857SThomas Tai struct dentry *parent; 272b9e03857SThomas Tai bool dont_retry; /* DNR, do not retry */ 273b9e03857SThomas Tai u16 status; /* status code */ 274b9e03857SThomas Tai }; 275b9e03857SThomas Tai #endif 276b9e03857SThomas Tai 27757dacad5SJay Sternberg struct nvme_ns { 27857dacad5SJay Sternberg struct list_head list; 27957dacad5SJay Sternberg 2801c63dc66SChristoph Hellwig struct nvme_ctrl *ctrl; 28157dacad5SJay Sternberg struct request_queue *queue; 28257dacad5SJay Sternberg struct gendisk *disk; 283ed754e5dSChristoph Hellwig struct list_head siblings; 284b0b4e09cSMatias Bjørling struct nvm_dev *ndev; 28557dacad5SJay Sternberg struct kref kref; 286ed754e5dSChristoph Hellwig struct nvme_ns_head *head; 28757dacad5SJay Sternberg 28857dacad5SJay Sternberg int lba_shift; 28957dacad5SJay Sternberg u16 ms; 290f5d11840SJens Axboe u16 sgs; 291f5d11840SJens Axboe u32 sws; 29257dacad5SJay Sternberg bool ext; 29357dacad5SJay Sternberg u8 pi_type; 294646017a6SKeith Busch unsigned long flags; 295646017a6SKeith Busch #define NVME_NS_REMOVING 0 29669d9a99cSKeith Busch #define NVME_NS_DEAD 1 29757eeaf8eSChristoph Hellwig u16 noiob; 298b9e03857SThomas Tai 299b9e03857SThomas Tai #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 300b9e03857SThomas Tai struct nvme_fault_inject fault_inject; 301b9e03857SThomas Tai #endif 302b9e03857SThomas Tai 30357dacad5SJay Sternberg }; 30457dacad5SJay Sternberg 3051c63dc66SChristoph Hellwig struct nvme_ctrl_ops { 3061a353d85SMing Lin const char *name; 307e439bb12SSagi Grimberg struct module *module; 308d3d5b87dSChristoph Hellwig unsigned int flags; 309d3d5b87dSChristoph Hellwig #define NVME_F_FABRICS (1 << 0) 310c81bfba9SChristoph Hellwig #define NVME_F_METADATA_SUPPORTED (1 << 1) 3111c63dc66SChristoph Hellwig int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 3125fd4ce1bSChristoph Hellwig int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 3137fd8930fSChristoph Hellwig int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 3141673f1f0SChristoph Hellwig void (*free_ctrl)(struct nvme_ctrl *ctrl); 315ad22c355SKeith Busch void (*submit_async_event)(struct nvme_ctrl *ctrl); 316c5017e85SChristoph Hellwig void (*delete_ctrl)(struct nvme_ctrl *ctrl); 3171a353d85SMing Lin int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); 31831b84460SSagi Grimberg int (*reinit_request)(void *data, struct request *rq); 319b435eceaSNitzan Carmi void (*stop_ctrl)(struct nvme_ctrl *ctrl); 32057dacad5SJay Sternberg }; 32157dacad5SJay Sternberg 322b9e03857SThomas Tai #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 323b9e03857SThomas Tai void nvme_fault_inject_init(struct nvme_ns *ns); 324b9e03857SThomas Tai void nvme_fault_inject_fini(struct nvme_ns *ns); 325b9e03857SThomas Tai void nvme_should_fail(struct request *req); 326b9e03857SThomas Tai #else 327b9e03857SThomas Tai static inline void nvme_fault_inject_init(struct nvme_ns *ns) {} 328b9e03857SThomas Tai static inline void nvme_fault_inject_fini(struct nvme_ns *ns) {} 329b9e03857SThomas Tai static inline void nvme_should_fail(struct request *req) {} 330b9e03857SThomas Tai #endif 331b9e03857SThomas Tai 3321c63dc66SChristoph Hellwig static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl) 3331c63dc66SChristoph Hellwig { 3341c63dc66SChristoph Hellwig u32 val = 0; 3351c63dc66SChristoph Hellwig 3361c63dc66SChristoph Hellwig if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val)) 3371c63dc66SChristoph Hellwig return false; 3381c63dc66SChristoph Hellwig return val & NVME_CSTS_RDY; 3391c63dc66SChristoph Hellwig } 3401c63dc66SChristoph Hellwig 341f3ca80fcSChristoph Hellwig static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 342f3ca80fcSChristoph Hellwig { 343f3ca80fcSChristoph Hellwig if (!ctrl->subsystem) 344f3ca80fcSChristoph Hellwig return -ENOTTY; 345f3ca80fcSChristoph Hellwig return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65); 346f3ca80fcSChristoph Hellwig } 347f3ca80fcSChristoph Hellwig 34857dacad5SJay Sternberg static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector) 34957dacad5SJay Sternberg { 35057dacad5SJay Sternberg return (sector >> (ns->lba_shift - 9)); 35157dacad5SJay Sternberg } 35257dacad5SJay Sternberg 3536904242dSMing Lin static inline void nvme_cleanup_cmd(struct request *req) 3546904242dSMing Lin { 355f9d03f96SChristoph Hellwig if (req->rq_flags & RQF_SPECIAL_PAYLOAD) { 356f9d03f96SChristoph Hellwig kfree(page_address(req->special_vec.bv_page) + 357f9d03f96SChristoph Hellwig req->special_vec.bv_offset); 358f9d03f96SChristoph Hellwig } 3596904242dSMing Lin } 3606904242dSMing Lin 36127fa9bc5SChristoph Hellwig static inline void nvme_end_request(struct request *req, __le16 status, 36227fa9bc5SChristoph Hellwig union nvme_result result) 36315a190f7SChristoph Hellwig { 36427fa9bc5SChristoph Hellwig struct nvme_request *rq = nvme_req(req); 36527fa9bc5SChristoph Hellwig 36627fa9bc5SChristoph Hellwig rq->status = le16_to_cpu(status) >> 1; 36727fa9bc5SChristoph Hellwig rq->result = result; 368b9e03857SThomas Tai /* inject error when permitted by fault injection framework */ 369b9e03857SThomas Tai nvme_should_fail(req); 37008e0029aSChristoph Hellwig blk_mq_complete_request(req); 37115a190f7SChristoph Hellwig } 37215a190f7SChristoph Hellwig 373d22524a4SChristoph Hellwig static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl) 374d22524a4SChristoph Hellwig { 375d22524a4SChristoph Hellwig get_device(ctrl->device); 376d22524a4SChristoph Hellwig } 377d22524a4SChristoph Hellwig 378d22524a4SChristoph Hellwig static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl) 379d22524a4SChristoph Hellwig { 380d22524a4SChristoph Hellwig put_device(ctrl->device); 381d22524a4SChristoph Hellwig } 382d22524a4SChristoph Hellwig 38377f02a7aSChristoph Hellwig void nvme_complete_rq(struct request *req); 384c55a2fd4SMing Lin void nvme_cancel_request(struct request *req, void *data, bool reserved); 385bb8d261eSChristoph Hellwig bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 386bb8d261eSChristoph Hellwig enum nvme_ctrl_state new_state); 3875fd4ce1bSChristoph Hellwig int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 3885fd4ce1bSChristoph Hellwig int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 3895fd4ce1bSChristoph Hellwig int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl); 390f3ca80fcSChristoph Hellwig int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 391f3ca80fcSChristoph Hellwig const struct nvme_ctrl_ops *ops, unsigned long quirks); 39253029b04SKeith Busch void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 393d09f2b45SSagi Grimberg void nvme_start_ctrl(struct nvme_ctrl *ctrl); 394d09f2b45SSagi Grimberg void nvme_stop_ctrl(struct nvme_ctrl *ctrl); 3951673f1f0SChristoph Hellwig void nvme_put_ctrl(struct nvme_ctrl *ctrl); 3967fd8930fSChristoph Hellwig int nvme_init_identify(struct nvme_ctrl *ctrl); 3975bae7f73SChristoph Hellwig 3985955be21SChristoph Hellwig void nvme_queue_scan(struct nvme_ctrl *ctrl); 3995bae7f73SChristoph Hellwig void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 4001673f1f0SChristoph Hellwig 4014f1244c8SChristoph Hellwig int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len, 4024f1244c8SChristoph Hellwig bool send); 403a98e58e5SScott Bauer 4047bf58533SChristoph Hellwig void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, 405287a63ebSChristoph Hellwig volatile union nvme_result *res); 406f866fc42SChristoph Hellwig 40725646264SKeith Busch void nvme_stop_queues(struct nvme_ctrl *ctrl); 40825646264SKeith Busch void nvme_start_queues(struct nvme_ctrl *ctrl); 40969d9a99cSKeith Busch void nvme_kill_queues(struct nvme_ctrl *ctrl); 410302ad8ccSKeith Busch void nvme_unfreeze(struct nvme_ctrl *ctrl); 411302ad8ccSKeith Busch void nvme_wait_freeze(struct nvme_ctrl *ctrl); 412302ad8ccSKeith Busch void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout); 413302ad8ccSKeith Busch void nvme_start_freeze(struct nvme_ctrl *ctrl); 41431b84460SSagi Grimberg int nvme_reinit_tagset(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set); 415363c9aacSSagi Grimberg 416eb71f435SChristoph Hellwig #define NVME_QID_ANY -1 4174160982eSChristoph Hellwig struct request *nvme_alloc_request(struct request_queue *q, 4189a95e4efSBart Van Assche struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid); 419fc17b653SChristoph Hellwig blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req, 4208093f7caSMing Lin struct nvme_command *cmd); 42157dacad5SJay Sternberg int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 42257dacad5SJay Sternberg void *buf, unsigned bufflen); 42357dacad5SJay Sternberg int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 424d49187e9SChristoph Hellwig union nvme_result *result, void *buffer, unsigned bufflen, 4259a95e4efSBart Van Assche unsigned timeout, int qid, int at_head, 4269a95e4efSBart Van Assche blk_mq_req_flags_t flags); 4279a0be7abSChristoph Hellwig int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 428038bd4cbSSagi Grimberg void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); 429d86c4d8eSChristoph Hellwig int nvme_reset_ctrl(struct nvme_ctrl *ctrl); 43079c48ccfSSagi Grimberg int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl); 431c5017e85SChristoph Hellwig int nvme_delete_ctrl(struct nvme_ctrl *ctrl); 432c5017e85SChristoph Hellwig int nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl); 43357dacad5SJay Sternberg 434d558fb51SMatias Bjørling int nvme_get_log_ext(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 4357ec6074fSMatias Bjørling u8 log_page, void *log, size_t size, u64 offset); 436d558fb51SMatias Bjørling 4375b85b826SChristoph Hellwig extern const struct attribute_group nvme_ns_id_attr_group; 43832acab31SChristoph Hellwig extern const struct block_device_operations nvme_ns_head_ops; 43932acab31SChristoph Hellwig 44032acab31SChristoph Hellwig #ifdef CONFIG_NVME_MULTIPATH 441a785dbccSKeith Busch void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns, 442a785dbccSKeith Busch struct nvme_ctrl *ctrl, int *flags); 44332acab31SChristoph Hellwig void nvme_failover_req(struct request *req); 444908e4564SKeith Busch bool nvme_req_needs_failover(struct request *req, blk_status_t error); 44532acab31SChristoph Hellwig void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl); 44632acab31SChristoph Hellwig int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head); 44732acab31SChristoph Hellwig void nvme_mpath_add_disk(struct nvme_ns_head *head); 44832acab31SChristoph Hellwig void nvme_mpath_remove_disk(struct nvme_ns_head *head); 44932acab31SChristoph Hellwig 45032acab31SChristoph Hellwig static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns) 45132acab31SChristoph Hellwig { 45232acab31SChristoph Hellwig struct nvme_ns_head *head = ns->head; 45332acab31SChristoph Hellwig 454978628ecSJohannes Thumshirn if (head && ns == rcu_access_pointer(head->current_path)) 45532acab31SChristoph Hellwig rcu_assign_pointer(head->current_path, NULL); 45632acab31SChristoph Hellwig } 45732acab31SChristoph Hellwig struct nvme_ns *nvme_find_path(struct nvme_ns_head *head); 458479a322fSSagi Grimberg 459479a322fSSagi Grimberg static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) 460479a322fSSagi Grimberg { 461479a322fSSagi Grimberg struct nvme_ns_head *head = ns->head; 462479a322fSSagi Grimberg 463479a322fSSagi Grimberg if (head->disk && list_empty(&head->list)) 464479a322fSSagi Grimberg kblockd_schedule_work(&head->requeue_work); 465479a322fSSagi Grimberg } 466479a322fSSagi Grimberg 46732acab31SChristoph Hellwig #else 468a785dbccSKeith Busch /* 469a785dbccSKeith Busch * Without the multipath code enabled, multiple controller per subsystems are 470a785dbccSKeith Busch * visible as devices and thus we cannot use the subsystem instance. 471a785dbccSKeith Busch */ 472a785dbccSKeith Busch static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns, 473a785dbccSKeith Busch struct nvme_ctrl *ctrl, int *flags) 474a785dbccSKeith Busch { 475a785dbccSKeith Busch sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance); 476a785dbccSKeith Busch } 477a785dbccSKeith Busch 47832acab31SChristoph Hellwig static inline void nvme_failover_req(struct request *req) 47932acab31SChristoph Hellwig { 48032acab31SChristoph Hellwig } 481908e4564SKeith Busch static inline bool nvme_req_needs_failover(struct request *req, 482908e4564SKeith Busch blk_status_t error) 48332acab31SChristoph Hellwig { 48432acab31SChristoph Hellwig return false; 48532acab31SChristoph Hellwig } 48632acab31SChristoph Hellwig static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl) 48732acab31SChristoph Hellwig { 48832acab31SChristoph Hellwig } 48932acab31SChristoph Hellwig static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, 49032acab31SChristoph Hellwig struct nvme_ns_head *head) 49132acab31SChristoph Hellwig { 49232acab31SChristoph Hellwig return 0; 49332acab31SChristoph Hellwig } 49432acab31SChristoph Hellwig static inline void nvme_mpath_add_disk(struct nvme_ns_head *head) 49532acab31SChristoph Hellwig { 49632acab31SChristoph Hellwig } 49732acab31SChristoph Hellwig static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head) 49832acab31SChristoph Hellwig { 49932acab31SChristoph Hellwig } 50032acab31SChristoph Hellwig static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns) 50132acab31SChristoph Hellwig { 50232acab31SChristoph Hellwig } 503479a322fSSagi Grimberg static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) 504479a322fSSagi Grimberg { 505479a322fSSagi Grimberg } 50632acab31SChristoph Hellwig #endif /* CONFIG_NVME_MULTIPATH */ 50732acab31SChristoph Hellwig 508c4699e70SKeith Busch #ifdef CONFIG_NVM 50996257a8aSMatias Bjørling void nvme_nvm_update_nvm_info(struct nvme_ns *ns); 5103dc87dd0SMatias Bjørling int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node); 511b0b4e09cSMatias Bjørling void nvme_nvm_unregister(struct nvme_ns *ns); 5123dc87dd0SMatias Bjørling int nvme_nvm_register_sysfs(struct nvme_ns *ns); 5133dc87dd0SMatias Bjørling void nvme_nvm_unregister_sysfs(struct nvme_ns *ns); 51484d4add7SMatias Bjørling int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg); 515c4699e70SKeith Busch #else 51696257a8aSMatias Bjørling static inline void nvme_nvm_update_nvm_info(struct nvme_ns *ns) {}; 517b0b4e09cSMatias Bjørling static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, 5183dc87dd0SMatias Bjørling int node) 519c4699e70SKeith Busch { 520c4699e70SKeith Busch return 0; 521c4699e70SKeith Busch } 522c4699e70SKeith Busch 523b0b4e09cSMatias Bjørling static inline void nvme_nvm_unregister(struct nvme_ns *ns) {}; 5243dc87dd0SMatias Bjørling static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns) 5253dc87dd0SMatias Bjørling { 5263dc87dd0SMatias Bjørling return 0; 5273dc87dd0SMatias Bjørling } 5283dc87dd0SMatias Bjørling static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {}; 52984d4add7SMatias Bjørling static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, 53084d4add7SMatias Bjørling unsigned long arg) 53184d4add7SMatias Bjørling { 53284d4add7SMatias Bjørling return -ENOTTY; 53384d4add7SMatias Bjørling } 5343dc87dd0SMatias Bjørling #endif /* CONFIG_NVM */ 5353dc87dd0SMatias Bjørling 53640267efdSSimon A. F. Lund static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) 53740267efdSSimon A. F. Lund { 53840267efdSSimon A. F. Lund return dev_to_disk(dev)->private_data; 53940267efdSSimon A. F. Lund } 540ca064085SMatias Bjørling 5415bae7f73SChristoph Hellwig int __init nvme_core_init(void); 5425bae7f73SChristoph Hellwig void nvme_core_exit(void); 5435bae7f73SChristoph Hellwig 54457dacad5SJay Sternberg #endif /* _NVME_H */ 545