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/pci.h>
19 #include <linux/kref.h>
20 #include <linux/blk-mq.h>
21 #include <linux/lightnvm.h>
22 #include <linux/sed-opal.h>
24 extern unsigned char nvme_io_timeout
;
25 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
27 extern unsigned char admin_timeout
;
28 #define ADMIN_TIMEOUT (admin_timeout * HZ)
30 extern unsigned char shutdown_timeout
;
31 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
33 #define NVME_DEFAULT_KATO 5
34 #define NVME_KATO_GRACE 10
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),
82 * Common request structure for NVMe passthrough. All drivers must have
83 * this structure as the first member of their request-private data.
86 struct nvme_command
*cmd
;
87 union nvme_result result
;
94 NVME_REQ_CANCELLED
= (1 << 0),
97 static inline struct nvme_request
*nvme_req(struct request
*req
)
99 return blk_mq_rq_to_pdu(req
);
102 /* The below value is the specific amount of delay needed before checking
103 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
104 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
107 #define NVME_QUIRK_DELAY_AMOUNT 2000
109 enum nvme_ctrl_state
{
113 NVME_CTRL_RECONNECTING
,
119 enum nvme_ctrl_state state
;
122 const struct nvme_ctrl_ops
*ops
;
123 struct request_queue
*admin_q
;
124 struct request_queue
*connect_q
;
128 struct blk_mq_tag_set
*tagset
;
129 struct list_head namespaces
;
130 struct mutex namespaces_mutex
;
131 struct device
*device
; /* char device */
132 struct list_head node
;
135 struct opal_dev
*opal_dev
;
140 char firmware_rev
[8];
150 atomic_t abort_limit
;
160 unsigned long quirks
;
161 struct nvme_id_power_state psd
[32];
162 struct work_struct scan_work
;
163 struct work_struct async_event_work
;
164 struct delayed_work ka_work
;
166 /* Power saving configuration */
167 u64 ps_max_latency_us
;
175 struct nvmf_ctrl_options
*opts
;
179 * An NVM Express namespace is equivalent to a SCSI LUN
182 struct list_head list
;
184 struct nvme_ctrl
*ctrl
;
185 struct request_queue
*queue
;
186 struct gendisk
*disk
;
187 struct nvm_dev
*ndev
;
201 #define NVME_NS_REMOVING 0
202 #define NVME_NS_DEAD 1
204 u64 mode_select_num_blocks
;
205 u32 mode_select_block_len
;
208 struct nvme_ctrl_ops
{
210 struct module
*module
;
212 int (*reg_read32
)(struct nvme_ctrl
*ctrl
, u32 off
, u32
*val
);
213 int (*reg_write32
)(struct nvme_ctrl
*ctrl
, u32 off
, u32 val
);
214 int (*reg_read64
)(struct nvme_ctrl
*ctrl
, u32 off
, u64
*val
);
215 int (*reset_ctrl
)(struct nvme_ctrl
*ctrl
);
216 void (*free_ctrl
)(struct nvme_ctrl
*ctrl
);
217 void (*submit_async_event
)(struct nvme_ctrl
*ctrl
, int aer_idx
);
218 int (*delete_ctrl
)(struct nvme_ctrl
*ctrl
);
219 const char *(*get_subsysnqn
)(struct nvme_ctrl
*ctrl
);
220 int (*get_address
)(struct nvme_ctrl
*ctrl
, char *buf
, int size
);
223 static inline bool nvme_ctrl_ready(struct nvme_ctrl
*ctrl
)
227 if (ctrl
->ops
->reg_read32(ctrl
, NVME_REG_CSTS
, &val
))
229 return val
& NVME_CSTS_RDY
;
232 static inline int nvme_reset_subsystem(struct nvme_ctrl
*ctrl
)
234 if (!ctrl
->subsystem
)
236 return ctrl
->ops
->reg_write32(ctrl
, NVME_REG_NSSR
, 0x4E564D65);
239 static inline u64
nvme_block_nr(struct nvme_ns
*ns
, sector_t sector
)
241 return (sector
>> (ns
->lba_shift
- 9));
244 static inline void nvme_cleanup_cmd(struct request
*req
)
246 if (req
->rq_flags
& RQF_SPECIAL_PAYLOAD
) {
247 kfree(page_address(req
->special_vec
.bv_page
) +
248 req
->special_vec
.bv_offset
);
252 static inline void nvme_end_request(struct request
*req
, __le16 status
,
253 union nvme_result result
)
255 struct nvme_request
*rq
= nvme_req(req
);
257 rq
->status
= le16_to_cpu(status
) >> 1;
259 blk_mq_complete_request(req
);
262 void nvme_complete_rq(struct request
*req
);
263 void nvme_cancel_request(struct request
*req
, void *data
, bool reserved
);
264 bool nvme_change_ctrl_state(struct nvme_ctrl
*ctrl
,
265 enum nvme_ctrl_state new_state
);
266 int nvme_disable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
);
267 int nvme_enable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
);
268 int nvme_shutdown_ctrl(struct nvme_ctrl
*ctrl
);
269 int nvme_init_ctrl(struct nvme_ctrl
*ctrl
, struct device
*dev
,
270 const struct nvme_ctrl_ops
*ops
, unsigned long quirks
);
271 void nvme_uninit_ctrl(struct nvme_ctrl
*ctrl
);
272 void nvme_put_ctrl(struct nvme_ctrl
*ctrl
);
273 int nvme_init_identify(struct nvme_ctrl
*ctrl
);
275 void nvme_queue_scan(struct nvme_ctrl
*ctrl
);
276 void nvme_remove_namespaces(struct nvme_ctrl
*ctrl
);
278 int nvme_sec_submit(void *data
, u16 spsp
, u8 secp
, void *buffer
, size_t len
,
281 #define NVME_NR_AERS 1
282 void nvme_complete_async_event(struct nvme_ctrl
*ctrl
, __le16 status
,
283 union nvme_result
*res
);
284 void nvme_queue_async_events(struct nvme_ctrl
*ctrl
);
286 void nvme_stop_queues(struct nvme_ctrl
*ctrl
);
287 void nvme_start_queues(struct nvme_ctrl
*ctrl
);
288 void nvme_kill_queues(struct nvme_ctrl
*ctrl
);
289 void nvme_unfreeze(struct nvme_ctrl
*ctrl
);
290 void nvme_wait_freeze(struct nvme_ctrl
*ctrl
);
291 void nvme_wait_freeze_timeout(struct nvme_ctrl
*ctrl
, long timeout
);
292 void nvme_start_freeze(struct nvme_ctrl
*ctrl
);
294 #define NVME_QID_ANY -1
295 struct request
*nvme_alloc_request(struct request_queue
*q
,
296 struct nvme_command
*cmd
, unsigned int flags
, int qid
);
297 int nvme_setup_cmd(struct nvme_ns
*ns
, struct request
*req
,
298 struct nvme_command
*cmd
);
299 int nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
300 void *buf
, unsigned bufflen
);
301 int __nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
302 union nvme_result
*result
, void *buffer
, unsigned bufflen
,
303 unsigned timeout
, int qid
, int at_head
, int flags
);
304 int nvme_submit_user_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
305 void __user
*ubuffer
, unsigned bufflen
, u32
*result
,
307 int __nvme_submit_user_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
308 void __user
*ubuffer
, unsigned bufflen
,
309 void __user
*meta_buffer
, unsigned meta_len
, u32 meta_seed
,
310 u32
*result
, unsigned timeout
);
311 int nvme_identify_ctrl(struct nvme_ctrl
*dev
, struct nvme_id_ctrl
**id
);
312 int nvme_identify_ns(struct nvme_ctrl
*dev
, unsigned nsid
,
313 struct nvme_id_ns
**id
);
314 int nvme_get_log_page(struct nvme_ctrl
*dev
, struct nvme_smart_log
**log
);
315 int nvme_get_features(struct nvme_ctrl
*dev
, unsigned fid
, unsigned nsid
,
316 void *buffer
, size_t buflen
, u32
*result
);
317 int nvme_set_features(struct nvme_ctrl
*dev
, unsigned fid
, unsigned dword11
,
318 void *buffer
, size_t buflen
, u32
*result
);
319 int nvme_set_queue_count(struct nvme_ctrl
*ctrl
, int *count
);
320 void nvme_start_keep_alive(struct nvme_ctrl
*ctrl
);
321 void nvme_stop_keep_alive(struct nvme_ctrl
*ctrl
);
325 int nvme_sg_io(struct nvme_ns
*ns
, struct sg_io_hdr __user
*u_hdr
);
326 int nvme_sg_io32(struct nvme_ns
*ns
, unsigned long arg
);
327 int nvme_sg_get_version_num(int __user
*ip
);
330 int nvme_nvm_ns_supported(struct nvme_ns
*ns
, struct nvme_id_ns
*id
);
331 int nvme_nvm_register(struct nvme_ns
*ns
, char *disk_name
, int node
);
332 void nvme_nvm_unregister(struct nvme_ns
*ns
);
333 int nvme_nvm_register_sysfs(struct nvme_ns
*ns
);
334 void nvme_nvm_unregister_sysfs(struct nvme_ns
*ns
);
335 int nvme_nvm_ioctl(struct nvme_ns
*ns
, unsigned int cmd
, unsigned long arg
);
337 static inline int nvme_nvm_register(struct nvme_ns
*ns
, char *disk_name
,
343 static inline void nvme_nvm_unregister(struct nvme_ns
*ns
) {};
344 static inline int nvme_nvm_register_sysfs(struct nvme_ns
*ns
)
348 static inline void nvme_nvm_unregister_sysfs(struct nvme_ns
*ns
) {};
349 static inline int nvme_nvm_ns_supported(struct nvme_ns
*ns
, struct nvme_id_ns
*id
)
353 static inline int nvme_nvm_ioctl(struct nvme_ns
*ns
, unsigned int cmd
,
358 #endif /* CONFIG_NVM */
360 static inline struct nvme_ns
*nvme_get_ns_from_dev(struct device
*dev
)
362 return dev_to_disk(dev
)->private_data
;
365 int __init
nvme_core_init(void);
366 void nvme_core_exit(void);