2 * Copyright (c) 2011-2014, Intel Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 #include <linux/nvme.h>
18 #include <linux/cdev.h>
19 #include <linux/pci.h>
20 #include <linux/kref.h>
21 #include <linux/blk-mq.h>
22 #include <linux/lightnvm.h>
23 #include <linux/sed-opal.h>
25 extern unsigned int nvme_io_timeout
;
26 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
28 extern unsigned int admin_timeout
;
29 #define ADMIN_TIMEOUT (admin_timeout * HZ)
31 #define NVME_DEFAULT_KATO 5
32 #define NVME_KATO_GRACE 10
34 extern struct workqueue_struct
*nvme_wq
;
42 * List of workarounds for devices that required behavior not specified in
47 * Prefers I/O aligned to a stripe size specified in a vendor
48 * specific Identify field.
50 NVME_QUIRK_STRIPE_SIZE
= (1 << 0),
53 * The controller doesn't handle Identify value others than 0 or 1
56 NVME_QUIRK_IDENTIFY_CNS
= (1 << 1),
59 * The controller deterministically returns O's on reads to
60 * logical blocks that deallocate was called on.
62 NVME_QUIRK_DEALLOCATE_ZEROES
= (1 << 2),
65 * The controller needs a delay before starts checking the device
66 * readiness, which is done by reading the NVME_CSTS_RDY bit.
68 NVME_QUIRK_DELAY_BEFORE_CHK_RDY
= (1 << 3),
71 * APST should not be used.
73 NVME_QUIRK_NO_APST
= (1 << 4),
76 * The deepest sleep state should not be used.
78 NVME_QUIRK_NO_DEEPEST_PS
= (1 << 5),
81 * Supports the LighNVM command set if indicated in vs[1].
83 NVME_QUIRK_LIGHTNVM
= (1 << 6),
87 * Common request structure for NVMe passthrough. All drivers must have
88 * this structure as the first member of their request-private data.
91 struct nvme_command
*cmd
;
92 union nvme_result result
;
99 NVME_REQ_CANCELLED
= (1 << 0),
102 static inline struct nvme_request
*nvme_req(struct request
*req
)
104 return blk_mq_rq_to_pdu(req
);
107 /* The below value is the specific amount of delay needed before checking
108 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
109 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
112 #define NVME_QUIRK_DELAY_AMOUNT 2000
114 enum nvme_ctrl_state
{
118 NVME_CTRL_RECONNECTING
,
124 enum nvme_ctrl_state state
;
127 const struct nvme_ctrl_ops
*ops
;
128 struct request_queue
*admin_q
;
129 struct request_queue
*connect_q
;
132 struct blk_mq_tag_set
*tagset
;
133 struct blk_mq_tag_set
*admin_tagset
;
134 struct list_head namespaces
;
135 struct mutex namespaces_mutex
;
136 struct device ctrl_device
;
137 struct device
*device
; /* char device */
140 struct work_struct reset_work
;
141 struct work_struct delete_work
;
143 struct opal_dev
*opal_dev
;
148 char firmware_rev
[8];
149 char subnqn
[NVMF_NQN_SIZE
];
164 atomic_t abort_limit
;
171 unsigned int shutdown_timeout
;
174 unsigned long quirks
;
175 struct nvme_id_power_state psd
[32];
176 struct nvme_effects_log
*effects
;
177 struct work_struct scan_work
;
178 struct work_struct async_event_work
;
179 struct delayed_work ka_work
;
180 struct work_struct fw_act_work
;
182 /* Power saving configuration */
183 u64 ps_max_latency_us
;
199 struct nvmf_ctrl_options
*opts
;
203 struct list_head list
;
205 struct nvme_ctrl
*ctrl
;
206 struct request_queue
*queue
;
207 struct gendisk
*disk
;
208 struct nvm_dev
*ndev
;
224 #define NVME_NS_REMOVING 0
225 #define NVME_NS_DEAD 1
229 struct nvme_ctrl_ops
{
231 struct module
*module
;
233 #define NVME_F_FABRICS (1 << 0)
234 #define NVME_F_METADATA_SUPPORTED (1 << 1)
235 int (*reg_read32
)(struct nvme_ctrl
*ctrl
, u32 off
, u32
*val
);
236 int (*reg_write32
)(struct nvme_ctrl
*ctrl
, u32 off
, u32 val
);
237 int (*reg_read64
)(struct nvme_ctrl
*ctrl
, u32 off
, u64
*val
);
238 void (*free_ctrl
)(struct nvme_ctrl
*ctrl
);
239 void (*submit_async_event
)(struct nvme_ctrl
*ctrl
);
240 void (*delete_ctrl
)(struct nvme_ctrl
*ctrl
);
241 int (*get_address
)(struct nvme_ctrl
*ctrl
, char *buf
, int size
);
242 int (*reinit_request
)(void *data
, struct request
*rq
);
245 static inline bool nvme_ctrl_ready(struct nvme_ctrl
*ctrl
)
249 if (ctrl
->ops
->reg_read32(ctrl
, NVME_REG_CSTS
, &val
))
251 return val
& NVME_CSTS_RDY
;
254 static inline int nvme_reset_subsystem(struct nvme_ctrl
*ctrl
)
256 if (!ctrl
->subsystem
)
258 return ctrl
->ops
->reg_write32(ctrl
, NVME_REG_NSSR
, 0x4E564D65);
261 static inline u64
nvme_block_nr(struct nvme_ns
*ns
, sector_t sector
)
263 return (sector
>> (ns
->lba_shift
- 9));
266 static inline void nvme_cleanup_cmd(struct request
*req
)
268 if (req
->rq_flags
& RQF_SPECIAL_PAYLOAD
) {
269 kfree(page_address(req
->special_vec
.bv_page
) +
270 req
->special_vec
.bv_offset
);
274 static inline void nvme_end_request(struct request
*req
, __le16 status
,
275 union nvme_result result
)
277 struct nvme_request
*rq
= nvme_req(req
);
279 rq
->status
= le16_to_cpu(status
) >> 1;
281 blk_mq_complete_request(req
);
284 static inline void nvme_get_ctrl(struct nvme_ctrl
*ctrl
)
286 get_device(ctrl
->device
);
289 static inline void nvme_put_ctrl(struct nvme_ctrl
*ctrl
)
291 put_device(ctrl
->device
);
294 void nvme_complete_rq(struct request
*req
);
295 void nvme_cancel_request(struct request
*req
, void *data
, bool reserved
);
296 bool nvme_change_ctrl_state(struct nvme_ctrl
*ctrl
,
297 enum nvme_ctrl_state new_state
);
298 int nvme_disable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
);
299 int nvme_enable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
);
300 int nvme_shutdown_ctrl(struct nvme_ctrl
*ctrl
);
301 int nvme_init_ctrl(struct nvme_ctrl
*ctrl
, struct device
*dev
,
302 const struct nvme_ctrl_ops
*ops
, unsigned long quirks
);
303 void nvme_uninit_ctrl(struct nvme_ctrl
*ctrl
);
304 void nvme_start_ctrl(struct nvme_ctrl
*ctrl
);
305 void nvme_stop_ctrl(struct nvme_ctrl
*ctrl
);
306 void nvme_put_ctrl(struct nvme_ctrl
*ctrl
);
307 int nvme_init_identify(struct nvme_ctrl
*ctrl
);
309 void nvme_queue_scan(struct nvme_ctrl
*ctrl
);
310 void nvme_remove_namespaces(struct nvme_ctrl
*ctrl
);
312 int nvme_sec_submit(void *data
, u16 spsp
, u8 secp
, void *buffer
, size_t len
,
315 void nvme_complete_async_event(struct nvme_ctrl
*ctrl
, __le16 status
,
316 union nvme_result
*res
);
318 void nvme_stop_queues(struct nvme_ctrl
*ctrl
);
319 void nvme_start_queues(struct nvme_ctrl
*ctrl
);
320 void nvme_kill_queues(struct nvme_ctrl
*ctrl
);
321 void nvme_unfreeze(struct nvme_ctrl
*ctrl
);
322 void nvme_wait_freeze(struct nvme_ctrl
*ctrl
);
323 void nvme_wait_freeze_timeout(struct nvme_ctrl
*ctrl
, long timeout
);
324 void nvme_start_freeze(struct nvme_ctrl
*ctrl
);
325 int nvme_reinit_tagset(struct nvme_ctrl
*ctrl
, struct blk_mq_tag_set
*set
);
327 #define NVME_QID_ANY -1
328 struct request
*nvme_alloc_request(struct request_queue
*q
,
329 struct nvme_command
*cmd
, unsigned int flags
, int qid
);
330 blk_status_t
nvme_setup_cmd(struct nvme_ns
*ns
, struct request
*req
,
331 struct nvme_command
*cmd
);
332 int nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
333 void *buf
, unsigned bufflen
);
334 int __nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
335 union nvme_result
*result
, void *buffer
, unsigned bufflen
,
336 unsigned timeout
, int qid
, int at_head
, int flags
);
337 int nvme_set_queue_count(struct nvme_ctrl
*ctrl
, int *count
);
338 void nvme_start_keep_alive(struct nvme_ctrl
*ctrl
);
339 void nvme_stop_keep_alive(struct nvme_ctrl
*ctrl
);
340 int nvme_reset_ctrl(struct nvme_ctrl
*ctrl
);
341 int nvme_delete_ctrl(struct nvme_ctrl
*ctrl
);
342 int nvme_delete_ctrl_sync(struct nvme_ctrl
*ctrl
);
345 int nvme_nvm_register(struct nvme_ns
*ns
, char *disk_name
, int node
);
346 void nvme_nvm_unregister(struct nvme_ns
*ns
);
347 int nvme_nvm_register_sysfs(struct nvme_ns
*ns
);
348 void nvme_nvm_unregister_sysfs(struct nvme_ns
*ns
);
349 int nvme_nvm_ioctl(struct nvme_ns
*ns
, unsigned int cmd
, unsigned long arg
);
351 static inline int nvme_nvm_register(struct nvme_ns
*ns
, char *disk_name
,
357 static inline void nvme_nvm_unregister(struct nvme_ns
*ns
) {};
358 static inline int nvme_nvm_register_sysfs(struct nvme_ns
*ns
)
362 static inline void nvme_nvm_unregister_sysfs(struct nvme_ns
*ns
) {};
363 static inline int nvme_nvm_ioctl(struct nvme_ns
*ns
, unsigned int cmd
,
368 #endif /* CONFIG_NVM */
370 static inline struct nvme_ns
*nvme_get_ns_from_dev(struct device
*dev
)
372 return dev_to_disk(dev
)->private_data
;
375 int __init
nvme_core_init(void);
376 void nvme_core_exit(void);