nvme.h 9.79 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * Copyright (c) 2011-2014, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#ifndef _NVME_H
#define _NVME_H

#include <linux/nvme.h>
#include <linux/pci.h>
#include <linux/kref.h>
#include <linux/blk-mq.h>
21
#include <linux/lightnvm.h>
22
#include <linux/sed-opal.h>
23

24 25 26 27 28 29 30 31 32 33
enum {
	/*
	 * Driver internal status code for commands that were cancelled due
	 * to timeouts or controller shutdown.  The value is negative so
	 * that it a) doesn't overlap with the unsigned hardware error codes,
	 * and b) can easily be tested for.
	 */
	NVME_SC_CANCELLED		= -EINTR,
};

34 35 36
extern unsigned char nvme_io_timeout;
#define NVME_IO_TIMEOUT	(nvme_io_timeout * HZ)

37 38 39
extern unsigned char admin_timeout;
#define ADMIN_TIMEOUT	(admin_timeout * HZ)

40 41 42
extern unsigned char shutdown_timeout;
#define SHUTDOWN_TIMEOUT	(shutdown_timeout * HZ)

Sagi Grimberg's avatar
Sagi Grimberg committed
43 44 45
#define NVME_DEFAULT_KATO	5
#define NVME_KATO_GRACE		10

Keith Busch's avatar
Keith Busch committed
46 47
extern unsigned int nvme_max_retries;

Matias Bjørling's avatar
Matias Bjørling committed
48 49 50 51 52
enum {
	NVME_NS_LBA		= 0,
	NVME_NS_LIGHTNVM	= 1,
};

53
/*
54 55
 * List of workarounds for devices that required behavior not specified in
 * the standard.
56
 */
57 58 59 60 61 62
enum nvme_quirks {
	/*
	 * Prefers I/O aligned to a stripe size specified in a vendor
	 * specific Identify field.
	 */
	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),
63 64 65 66 67 68

	/*
	 * The controller doesn't handle Identify value others than 0 or 1
	 * correctly.
	 */
	NVME_QUIRK_IDENTIFY_CNS			= (1 << 1),
69 70 71 72 73 74

	/*
	 * The controller deterministically returns O's on reads to discarded
	 * logical blocks.
	 */
	NVME_QUIRK_DISCARD_ZEROES		= (1 << 2),
75 76 77 78 79 80

	/*
	 * The controller needs a delay before starts checking the device
	 * readiness, which is done by reading the NVME_CSTS_RDY bit.
	 */
	NVME_QUIRK_DELAY_BEFORE_CHK_RDY		= (1 << 3),
81 82
};

83 84 85 86 87 88 89 90 91 92 93 94 95 96
/*
 * Common request structure for NVMe passthrough.  All drivers must have
 * this structure as the first member of their request-private data.
 */
struct nvme_request {
	struct nvme_command	*cmd;
	union nvme_result	result;
};

static inline struct nvme_request *nvme_req(struct request *req)
{
	return blk_mq_rq_to_pdu(req);
}

97 98 99 100 101 102 103
/* The below value is the specific amount of delay needed before checking
 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 * found empirically.
 */
#define NVME_QUIRK_DELAY_AMOUNT		2000

104 105 106 107
enum nvme_ctrl_state {
	NVME_CTRL_NEW,
	NVME_CTRL_LIVE,
	NVME_CTRL_RESETTING,
108
	NVME_CTRL_RECONNECTING,
109
	NVME_CTRL_DELETING,
110
	NVME_CTRL_DEAD,
111 112
};

113
struct nvme_ctrl {
114
	enum nvme_ctrl_state state;
115
	bool identified;
116
	spinlock_t lock;
117
	const struct nvme_ctrl_ops *ops;
118
	struct request_queue *admin_q;
119
	struct request_queue *connect_q;
120
	struct device *dev;
121
	struct kref kref;
122
	int instance;
123
	struct blk_mq_tag_set *tagset;
124
	struct list_head namespaces;
125
	struct mutex namespaces_mutex;
126
	struct device *device;	/* char device */
127
	struct list_head node;
128
	struct ida ns_ida;
129

130
	struct opal_dev *opal_dev;
131

132 133 134 135
	char name[12];
	char serial[20];
	char model[40];
	char firmware_rev[8];
Christoph Hellwig's avatar
Christoph Hellwig committed
136
	u16 cntlid;
137 138 139 140

	u32 ctrl_config;

	u32 page_size;
141 142
	u32 max_hw_sectors;
	u16 oncs;
143
	u16 vid;
144
	u16 oacs;
145
	atomic_t abort_limit;
146 147
	u8 event_limit;
	u8 vwc;
148
	u32 vs;
149
	u32 sgls;
Sagi Grimberg's avatar
Sagi Grimberg committed
150 151
	u16 kas;
	unsigned int kato;
152
	bool subsystem;
153
	unsigned long quirks;
154
	struct work_struct scan_work;
155
	struct work_struct async_event_work;
Sagi Grimberg's avatar
Sagi Grimberg committed
156
	struct delayed_work ka_work;
157 158 159 160 161 162 163 164

	/* Fabrics only */
	u16 sqsize;
	u32 ioccsz;
	u32 iorcsz;
	u16 icdoff;
	u16 maxcmd;
	struct nvmf_ctrl_options *opts;
165 166 167 168 169 170 171 172
};

/*
 * An NVM Express namespace is equivalent to a SCSI LUN
 */
struct nvme_ns {
	struct list_head list;

173
	struct nvme_ctrl *ctrl;
174 175
	struct request_queue *queue;
	struct gendisk *disk;
176
	struct nvm_dev *ndev;
177
	struct kref kref;
178
	int instance;
179

180 181 182
	u8 eui[8];
	u8 uuid[16];

183 184 185 186 187
	unsigned ns_id;
	int lba_shift;
	u16 ms;
	bool ext;
	u8 pi_type;
188 189 190
	unsigned long flags;

#define NVME_NS_REMOVING 0
191
#define NVME_NS_DEAD     1
192

193 194 195 196
	u64 mode_select_num_blocks;
	u32 mode_select_block_len;
};

197
struct nvme_ctrl_ops {
Ming Lin's avatar
Ming Lin committed
198
	const char *name;
199
	struct module *module;
200
	bool is_fabrics;
201
	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
202
	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
203
	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
204
	int (*reset_ctrl)(struct nvme_ctrl *ctrl);
205
	void (*free_ctrl)(struct nvme_ctrl *ctrl);
206
	void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
Ming Lin's avatar
Ming Lin committed
207 208 209
	int (*delete_ctrl)(struct nvme_ctrl *ctrl);
	const char *(*get_subsysnqn)(struct nvme_ctrl *ctrl);
	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
210 211
};

212 213 214 215 216 217 218 219 220
static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
{
	u32 val = 0;

	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
		return false;
	return val & NVME_CSTS_RDY;
}

221 222 223 224 225 226 227
static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
{
	if (!ctrl->subsystem)
		return -ENOTTY;
	return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
}

228 229 230 231 232
static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
{
	return (sector >> (ns->lba_shift - 9));
}

Ming Lin's avatar
Ming Lin committed
233 234
static inline void nvme_cleanup_cmd(struct request *req)
{
235 236 237 238
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
		kfree(page_address(req->special_vec.bv_page) +
		      req->special_vec.bv_offset);
	}
Ming Lin's avatar
Ming Lin committed
239 240
}

241 242 243 244 245 246 247 248 249 250 251 252
static inline int nvme_error_status(u16 status)
{
	switch (status & 0x7ff) {
	case NVME_SC_SUCCESS:
		return 0;
	case NVME_SC_CAP_EXCEEDED:
		return -ENOSPC;
	default:
		return -EIO;
	}
}

253 254 255
static inline bool nvme_req_needs_retry(struct request *req, u16 status)
{
	return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
Keith Busch's avatar
Keith Busch committed
256 257
		(jiffies - req->start_time) < req->timeout &&
		req->retries < nvme_max_retries;
258 259
}

260
void nvme_cancel_request(struct request *req, void *data, bool reserved);
261 262
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state);
263 264 265
int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
266 267
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks);
268
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
269
void nvme_put_ctrl(struct nvme_ctrl *ctrl);
270
int nvme_init_identify(struct nvme_ctrl *ctrl);
271

272
void nvme_queue_scan(struct nvme_ctrl *ctrl);
273
void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
274

275 276
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send);
277

278
#define NVME_NR_AERS	1
279 280
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
		union nvme_result *res);
281 282
void nvme_queue_async_events(struct nvme_ctrl *ctrl);

283 284
void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
285
void nvme_kill_queues(struct nvme_ctrl *ctrl);
286

287
#define NVME_QID_ANY -1
288
struct request *nvme_alloc_request(struct request_queue *q,
289
		struct nvme_command *cmd, unsigned int flags, int qid);
290
void nvme_requeue_req(struct request *req);
Ming Lin's avatar
Ming Lin committed
291 292
int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
		struct nvme_command *cmd);
293 294 295
int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buf, unsigned bufflen);
int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
296
		union nvme_result *result, void *buffer, unsigned bufflen,
297
		unsigned timeout, int qid, int at_head, int flags);
298 299 300
int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
		void __user *ubuffer, unsigned bufflen, u32 *result,
		unsigned timeout);
301 302 303
int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
		void __user *ubuffer, unsigned bufflen,
		void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
304
		u32 *result, unsigned timeout);
305 306
int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
307
		struct nvme_id_ns **id);
308 309
int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
310
		      void *buffer, size_t buflen, u32 *result);
311
int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
312
		      void *buffer, size_t buflen, u32 *result);
313
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
Sagi Grimberg's avatar
Sagi Grimberg committed
314 315
void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
316 317 318 319 320 321 322

struct sg_io_hdr;

int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
int nvme_sg_get_version_num(int __user *ip);

323
#ifdef CONFIG_NVM
Matias Bjørling's avatar
Matias Bjørling committed
324
int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
325
int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
326
void nvme_nvm_unregister(struct nvme_ns *ns);
327 328
int nvme_nvm_register_sysfs(struct nvme_ns *ns);
void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
329
int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
330
#else
331
static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
332
				    int node)
333 334 335 336
{
	return 0;
}

337
static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
338 339 340 341 342
static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
{
	return 0;
}
static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
343 344 345 346
static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	return 0;
}
347 348 349 350 351
static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
							unsigned long arg)
{
	return -ENOTTY;
}
352 353
#endif /* CONFIG_NVM */

354 355 356 357
static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
{
	return dev_to_disk(dev)->private_data;
}
Matias Bjørling's avatar
Matias Bjørling committed
358

359 360 361
int __init nvme_core_init(void);
void nvme_core_exit(void);

362
#endif /* _NVME_H */