pci.c 93.3 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
M
Matthew Wilcox 已提交
2 3
/*
 * NVM Express device driver
4
 * Copyright (c) 2011-2014, Intel Corporation.
M
Matthew Wilcox 已提交
5 6
 */

7
#include <linux/acpi.h>
K
Keith Busch 已提交
8
#include <linux/aer.h>
9
#include <linux/async.h>
M
Matthew Wilcox 已提交
10
#include <linux/blkdev.h>
M
Matias Bjørling 已提交
11
#include <linux/blk-mq.h>
12
#include <linux/blk-mq-pci.h>
13
#include <linux/blk-integrity.h>
14
#include <linux/dmi.h>
M
Matthew Wilcox 已提交
15 16 17
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/io.h>
18
#include <linux/memremap.h>
M
Matthew Wilcox 已提交
19 20
#include <linux/mm.h>
#include <linux/module.h>
21
#include <linux/mutex.h>
22
#include <linux/once.h>
M
Matthew Wilcox 已提交
23
#include <linux/pci.h>
24
#include <linux/suspend.h>
K
Keith Busch 已提交
25
#include <linux/t10-pi.h>
M
Matthew Wilcox 已提交
26
#include <linux/types.h>
27
#include <linux/io-64-nonatomic-lo-hi.h>
28
#include <linux/io-64-nonatomic-hi-lo.h>
29
#include <linux/sed-opal.h>
30
#include <linux/pci-p2pdma.h>
31

Y
yupeng 已提交
32
#include "trace.h"
33 34
#include "nvme.h"

35
#define SQ_SIZE(q)	((q)->q_depth << (q)->sqes)
36
#define CQ_SIZE(q)	((q)->q_depth * sizeof(struct nvme_completion))
37

C
Chaitanya Kulkarni 已提交
38
#define SGES_PER_PAGE	(PAGE_SIZE / sizeof(struct nvme_sgl_desc))
39

40 41 42 43 44 45 46
/*
 * These can be higher, but we need to ensure that any command doesn't
 * require an sg allocation that needs more than a page of data.
 */
#define NVME_MAX_KB_SZ	4096
#define NVME_MAX_SEGS	127

47
static int use_threaded_interrupts;
48
module_param(use_threaded_interrupts, int, 0444);
49

50
static bool use_cmb_sqes = true;
51
module_param(use_cmb_sqes, bool, 0444);
52 53
MODULE_PARM_DESC(use_cmb_sqes, "use controller's memory buffer for I/O SQes");

54 55 56 57
static unsigned int max_host_mem_size_mb = 128;
module_param(max_host_mem_size_mb, uint, 0444);
MODULE_PARM_DESC(max_host_mem_size_mb,
	"Maximum Host Memory Buffer (HMB) size per controller (in MiB)");
58

C
Chaitanya Kulkarni 已提交
59 60 61 62 63 64
static unsigned int sgl_threshold = SZ_32K;
module_param(sgl_threshold, uint, 0644);
MODULE_PARM_DESC(sgl_threshold,
		"Use SGLs when average request segment size is larger or equal to "
		"this size. Use 0 to disable SGLs.");

65 66
#define NVME_PCI_MIN_QUEUE_SIZE 2
#define NVME_PCI_MAX_QUEUE_SIZE 4095
67 68 69
static int io_queue_depth_set(const char *val, const struct kernel_param *kp);
static const struct kernel_param_ops io_queue_depth_ops = {
	.set = io_queue_depth_set,
70
	.get = param_get_uint,
71 72
};

73
static unsigned int io_queue_depth = 1024;
74
module_param_cb(io_queue_depth, &io_queue_depth_ops, &io_queue_depth, 0644);
75
MODULE_PARM_DESC(io_queue_depth, "set io queue depth, should >= 2 and < 4096");
76

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
static int io_queue_count_set(const char *val, const struct kernel_param *kp)
{
	unsigned int n;
	int ret;

	ret = kstrtouint(val, 10, &n);
	if (ret != 0 || n > num_possible_cpus())
		return -EINVAL;
	return param_set_uint(val, kp);
}

static const struct kernel_param_ops io_queue_count_ops = {
	.set = io_queue_count_set,
	.get = param_get_uint,
};

93
static unsigned int write_queues;
94
module_param_cb(write_queues, &io_queue_count_ops, &write_queues, 0644);
95 96 97 98
MODULE_PARM_DESC(write_queues,
	"Number of queues to use for writes. If not set, reads and writes "
	"will share a queue set.");

99
static unsigned int poll_queues;
100
module_param_cb(poll_queues, &io_queue_count_ops, &poll_queues, 0644);
J
Jens Axboe 已提交
101 102
MODULE_PARM_DESC(poll_queues, "Number of queues to use for polled IO.");

103 104 105 106
static bool noacpi;
module_param(noacpi, bool, 0444);
MODULE_PARM_DESC(noacpi, "disable acpi bios quirks");

107 108
struct nvme_dev;
struct nvme_queue;
109

110
static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown);
111
static bool __nvme_disable_io_queues(struct nvme_dev *dev, u8 opcode);
112

113 114 115 116
/*
 * Represents an NVM Express device.  Each nvme_dev is a PCI function.
 */
struct nvme_dev {
117
	struct nvme_queue *queues;
118 119 120 121 122 123 124 125
	struct blk_mq_tag_set tagset;
	struct blk_mq_tag_set admin_tagset;
	u32 __iomem *dbs;
	struct device *dev;
	struct dma_pool *prp_page_pool;
	struct dma_pool *prp_small_pool;
	unsigned online_queues;
	unsigned max_qid;
126
	unsigned io_queues[HCTX_MAX_TYPES];
127
	unsigned int num_vecs;
128
	u32 q_depth;
129
	int io_sqes;
130 131
	u32 db_stride;
	void __iomem *bar;
132
	unsigned long bar_mapped_size;
133
	struct work_struct remove_work;
134
	struct mutex shutdown_lock;
135 136
	bool subsystem;
	u64 cmb_size;
137
	bool cmb_use_sqes;
138
	u32 cmbsz;
139
	u32 cmbloc;
140
	struct nvme_ctrl ctrl;
141
	u32 last_ps;
142
	bool hmb;
143

144 145
	mempool_t *iod_mempool;

146
	/* shadow doorbell buffer support: */
147 148 149 150
	u32 *dbbuf_dbs;
	dma_addr_t dbbuf_dbs_dma_addr;
	u32 *dbbuf_eis;
	dma_addr_t dbbuf_eis_dma_addr;
151 152 153 154

	/* host memory buffer support: */
	u64 host_mem_size;
	u32 nr_host_mem_descs;
155
	dma_addr_t host_mem_descs_dma;
156 157
	struct nvme_host_mem_buf_desc *host_mem_descs;
	void **host_mem_desc_bufs;
158 159 160
	unsigned int nr_allocated_queues;
	unsigned int nr_write_queues;
	unsigned int nr_poll_queues;
161 162

	bool attrs_added;
K
Keith Busch 已提交
163
};
164

165 166
static int io_queue_depth_set(const char *val, const struct kernel_param *kp)
{
167 168
	return param_set_uint_minmax(val, kp, NVME_PCI_MIN_QUEUE_SIZE,
			NVME_PCI_MAX_QUEUE_SIZE);
169 170
}

171 172 173 174 175 176 177 178 179 180
static inline unsigned int sq_idx(unsigned int qid, u32 stride)
{
	return qid * 2 * stride;
}

static inline unsigned int cq_idx(unsigned int qid, u32 stride)
{
	return (qid * 2 + 1) * stride;
}

181 182 183 184 185
static inline struct nvme_dev *to_nvme_dev(struct nvme_ctrl *ctrl)
{
	return container_of(ctrl, struct nvme_dev, ctrl);
}

M
Matthew Wilcox 已提交
186 187 188 189 190
/*
 * An NVM Express queue.  Each device has at least two (one for admin
 * commands and one for I/O commands).
 */
struct nvme_queue {
M
Matthew Wilcox 已提交
191
	struct nvme_dev *dev;
192
	spinlock_t sq_lock;
193
	void *sq_cmds;
194 195
	 /* only used for poll queues: */
	spinlock_t cq_poll_lock ____cacheline_aligned_in_smp;
K
Keith Busch 已提交
196
	struct nvme_completion *cqes;
M
Matthew Wilcox 已提交
197 198 199
	dma_addr_t sq_dma_addr;
	dma_addr_t cq_dma_addr;
	u32 __iomem *q_db;
200
	u32 q_depth;
201
	u16 cq_vector;
M
Matthew Wilcox 已提交
202
	u16 sq_tail;
203
	u16 last_sq_tail;
M
Matthew Wilcox 已提交
204
	u16 cq_head;
K
Keith Busch 已提交
205
	u16 qid;
206
	u8 cq_phase;
207
	u8 sqes;
208 209
	unsigned long flags;
#define NVMEQ_ENABLED		0
210
#define NVMEQ_SQ_CMB		1
211
#define NVMEQ_DELETE_ERROR	2
212
#define NVMEQ_POLLED		3
213 214 215 216
	u32 *dbbuf_sq_db;
	u32 *dbbuf_cq_db;
	u32 *dbbuf_sq_ei;
	u32 *dbbuf_cq_ei;
217
	struct completion delete_done;
M
Matthew Wilcox 已提交
218 219
};

220
/*
221 222 223 224
 * The nvme_iod describes the data in an I/O.
 *
 * The sg pointer contains the list of PRP/SGL chunk allocations in addition
 * to the actual struct scatterlist.
225 226
 */
struct nvme_iod {
227
	struct nvme_request req;
228
	struct nvme_command cmd;
C
Christoph Hellwig 已提交
229
	struct nvme_queue *nvmeq;
C
Chaitanya Kulkarni 已提交
230
	bool use_sgl;
C
Christoph Hellwig 已提交
231
	int aborted;
232 233 234
	int npages;		/* In the PRP list. 0 means small pool in use */
	int nents;		/* Used in scatterlist */
	dma_addr_t first_dma;
235
	unsigned int dma_len;	/* length of single DMA segment mapping */
236
	dma_addr_t meta_dma;
C
Christoph Hellwig 已提交
237
	struct scatterlist *sg;
M
Matthew Wilcox 已提交
238 239
};

240
static inline unsigned int nvme_dbbuf_size(struct nvme_dev *dev)
241
{
242
	return dev->nr_allocated_queues * 8 * dev->db_stride;
243 244 245 246
}

static int nvme_dbbuf_dma_alloc(struct nvme_dev *dev)
{
247
	unsigned int mem_size = nvme_dbbuf_size(dev);
248

249 250 251 252 253 254 255
	if (dev->dbbuf_dbs) {
		/*
		 * Clear the dbbuf memory so the driver doesn't observe stale
		 * values from the previous instantiation.
		 */
		memset(dev->dbbuf_dbs, 0, mem_size);
		memset(dev->dbbuf_eis, 0, mem_size);
256
		return 0;
257
	}
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

	dev->dbbuf_dbs = dma_alloc_coherent(dev->dev, mem_size,
					    &dev->dbbuf_dbs_dma_addr,
					    GFP_KERNEL);
	if (!dev->dbbuf_dbs)
		return -ENOMEM;
	dev->dbbuf_eis = dma_alloc_coherent(dev->dev, mem_size,
					    &dev->dbbuf_eis_dma_addr,
					    GFP_KERNEL);
	if (!dev->dbbuf_eis) {
		dma_free_coherent(dev->dev, mem_size,
				  dev->dbbuf_dbs, dev->dbbuf_dbs_dma_addr);
		dev->dbbuf_dbs = NULL;
		return -ENOMEM;
	}

	return 0;
}

static void nvme_dbbuf_dma_free(struct nvme_dev *dev)
{
279
	unsigned int mem_size = nvme_dbbuf_size(dev);
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

	if (dev->dbbuf_dbs) {
		dma_free_coherent(dev->dev, mem_size,
				  dev->dbbuf_dbs, dev->dbbuf_dbs_dma_addr);
		dev->dbbuf_dbs = NULL;
	}
	if (dev->dbbuf_eis) {
		dma_free_coherent(dev->dev, mem_size,
				  dev->dbbuf_eis, dev->dbbuf_eis_dma_addr);
		dev->dbbuf_eis = NULL;
	}
}

static void nvme_dbbuf_init(struct nvme_dev *dev,
			    struct nvme_queue *nvmeq, int qid)
{
	if (!dev->dbbuf_dbs || !qid)
		return;

	nvmeq->dbbuf_sq_db = &dev->dbbuf_dbs[sq_idx(qid, dev->db_stride)];
	nvmeq->dbbuf_cq_db = &dev->dbbuf_dbs[cq_idx(qid, dev->db_stride)];
	nvmeq->dbbuf_sq_ei = &dev->dbbuf_eis[sq_idx(qid, dev->db_stride)];
	nvmeq->dbbuf_cq_ei = &dev->dbbuf_eis[cq_idx(qid, dev->db_stride)];
}

305 306 307 308 309 310 311 312 313 314 315
static void nvme_dbbuf_free(struct nvme_queue *nvmeq)
{
	if (!nvmeq->qid)
		return;

	nvmeq->dbbuf_sq_db = NULL;
	nvmeq->dbbuf_cq_db = NULL;
	nvmeq->dbbuf_sq_ei = NULL;
	nvmeq->dbbuf_cq_ei = NULL;
}

316 317
static void nvme_dbbuf_set(struct nvme_dev *dev)
{
318
	struct nvme_command c = { };
319
	unsigned int i;
320 321 322 323 324 325 326 327 328

	if (!dev->dbbuf_dbs)
		return;

	c.dbbuf.opcode = nvme_admin_dbbuf;
	c.dbbuf.prp1 = cpu_to_le64(dev->dbbuf_dbs_dma_addr);
	c.dbbuf.prp2 = cpu_to_le64(dev->dbbuf_eis_dma_addr);

	if (nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0)) {
329
		dev_warn(dev->ctrl.device, "unable to set dbbuf\n");
330 331
		/* Free memory and continue on */
		nvme_dbbuf_dma_free(dev);
332 333 334

		for (i = 1; i <= dev->online_queues; i++)
			nvme_dbbuf_free(&dev->queues[i]);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
	}
}

static inline int nvme_dbbuf_need_event(u16 event_idx, u16 new_idx, u16 old)
{
	return (u16)(new_idx - event_idx - 1) < (u16)(new_idx - old);
}

/* Update dbbuf and return true if an MMIO is required */
static bool nvme_dbbuf_update_and_check_event(u16 value, u32 *dbbuf_db,
					      volatile u32 *dbbuf_ei)
{
	if (dbbuf_db) {
		u16 old_value;

		/*
		 * Ensure that the queue is written before updating
		 * the doorbell in memory
		 */
		wmb();

		old_value = *dbbuf_db;
		*dbbuf_db = value;

359 360 361 362 363 364 365 366
		/*
		 * Ensure that the doorbell is updated before reading the event
		 * index from memory.  The controller needs to provide similar
		 * ordering to ensure the envent index is updated before reading
		 * the doorbell.
		 */
		mb();

367 368 369 370 371
		if (!nvme_dbbuf_need_event(*dbbuf_ei, value, old_value))
			return false;
	}

	return true;
M
Matthew Wilcox 已提交
372 373
}

374 375 376 377 378
/*
 * Will slightly overestimate the number of pages needed.  This is OK
 * as it only leads to a small amount of wasted memory for the lifetime of
 * the I/O.
 */
379
static int nvme_pci_npages_prp(void)
380
{
381
	unsigned nprps = DIV_ROUND_UP(NVME_MAX_KB_SZ + NVME_CTRL_PAGE_SIZE,
382
				      NVME_CTRL_PAGE_SIZE);
383 384 385
	return DIV_ROUND_UP(8 * nprps, PAGE_SIZE - 8);
}

C
Chaitanya Kulkarni 已提交
386 387 388 389
/*
 * Calculates the number of pages needed for the SGL segments. For example a 4k
 * page can accommodate 256 SGL descriptors.
 */
390
static int nvme_pci_npages_sgl(void)
391
{
392 393
	return DIV_ROUND_UP(NVME_MAX_SEGS * sizeof(struct nvme_sgl_desc),
			PAGE_SIZE);
C
Christoph Hellwig 已提交
394
}
395

396
static size_t nvme_pci_iod_alloc_size(void)
C
Christoph Hellwig 已提交
397
{
398
	size_t npages = max(nvme_pci_npages_prp(), nvme_pci_npages_sgl());
C
Chaitanya Kulkarni 已提交
399

400 401
	return sizeof(__le64 *) * npages +
		sizeof(struct scatterlist) * NVME_MAX_SEGS;
C
Christoph Hellwig 已提交
402
}
403

M
Matias Bjørling 已提交
404 405
static int nvme_admin_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
				unsigned int hctx_idx)
406
{
M
Matias Bjørling 已提交
407
	struct nvme_dev *dev = data;
408
	struct nvme_queue *nvmeq = &dev->queues[0];
M
Matias Bjørling 已提交
409

410 411 412
	WARN_ON(hctx_idx != 0);
	WARN_ON(dev->admin_tagset.tags[0] != hctx->tags);

M
Matias Bjørling 已提交
413 414
	hctx->driver_data = nvmeq;
	return 0;
415 416
}

M
Matias Bjørling 已提交
417 418
static int nvme_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
			  unsigned int hctx_idx)
M
Matthew Wilcox 已提交
419
{
M
Matias Bjørling 已提交
420
	struct nvme_dev *dev = data;
421
	struct nvme_queue *nvmeq = &dev->queues[hctx_idx + 1];
M
Matias Bjørling 已提交
422

423
	WARN_ON(dev->tagset.tags[hctx_idx] != hctx->tags);
M
Matias Bjørling 已提交
424 425
	hctx->driver_data = nvmeq;
	return 0;
M
Matthew Wilcox 已提交
426 427
}

428 429 430
static int nvme_pci_init_request(struct blk_mq_tag_set *set,
		struct request *req, unsigned int hctx_idx,
		unsigned int numa_node)
M
Matthew Wilcox 已提交
431
{
432
	struct nvme_dev *dev = set->driver_data;
C
Christoph Hellwig 已提交
433
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
434
	int queue_idx = (set == &dev->tagset) ? hctx_idx + 1 : 0;
435
	struct nvme_queue *nvmeq = &dev->queues[queue_idx];
M
Matias Bjørling 已提交
436 437

	BUG_ON(!nvmeq);
C
Christoph Hellwig 已提交
438
	iod->nvmeq = nvmeq;
439 440

	nvme_req(req)->ctrl = &dev->ctrl;
441
	nvme_req(req)->cmd = &iod->cmd;
M
Matias Bjørling 已提交
442 443 444
	return 0;
}

445 446 447 448 449 450 451 452 453
static int queue_irq_offset(struct nvme_dev *dev)
{
	/* if we have more than 1 vec, admin queue offsets us by 1 */
	if (dev->num_vecs > 1)
		return 1;

	return 0;
}

454 455 456
static int nvme_pci_map_queues(struct blk_mq_tag_set *set)
{
	struct nvme_dev *dev = set->driver_data;
457 458 459 460 461 462 463 464
	int i, qoff, offset;

	offset = queue_irq_offset(dev);
	for (i = 0, qoff = 0; i < set->nr_maps; i++) {
		struct blk_mq_queue_map *map = &set->map[i];

		map->nr_queues = dev->io_queues[i];
		if (!map->nr_queues) {
465
			BUG_ON(i == HCTX_TYPE_DEFAULT);
466
			continue;
467 468
		}

J
Jens Axboe 已提交
469 470 471 472
		/*
		 * The poll queue(s) doesn't have an IRQ (and hence IRQ
		 * affinity), so use the regular blk-mq cpu mapping
		 */
473
		map->queue_offset = qoff;
474
		if (i != HCTX_TYPE_POLL && offset)
J
Jens Axboe 已提交
475 476 477
			blk_mq_pci_map_queues(map, to_pci_dev(dev->dev), offset);
		else
			blk_mq_map_queues(map);
478 479 480 481 482
		qoff += map->nr_queues;
		offset += map->nr_queues;
	}

	return 0;
483 484
}

485 486 487 488
/*
 * Write sq tail if we are asked to, or if the next command would wrap.
 */
static inline void nvme_write_sq_db(struct nvme_queue *nvmeq, bool write_sq)
489
{
490 491 492 493 494 495 496 497 498
	if (!write_sq) {
		u16 next_tail = nvmeq->sq_tail + 1;

		if (next_tail == nvmeq->q_depth)
			next_tail = 0;
		if (next_tail != nvmeq->last_sq_tail)
			return;
	}

499 500 501
	if (nvme_dbbuf_update_and_check_event(nvmeq->sq_tail,
			nvmeq->dbbuf_sq_db, nvmeq->dbbuf_sq_ei))
		writel(nvmeq->sq_tail, nvmeq->q_db);
502
	nvmeq->last_sq_tail = nvmeq->sq_tail;
503 504
}

505 506
static inline void nvme_sq_copy_cmd(struct nvme_queue *nvmeq,
				    struct nvme_command *cmd)
M
Matthew Wilcox 已提交
507
{
508
	memcpy(nvmeq->sq_cmds + (nvmeq->sq_tail << nvmeq->sqes),
509
		absolute_pointer(cmd), sizeof(*cmd));
510 511
	if (++nvmeq->sq_tail == nvmeq->q_depth)
		nvmeq->sq_tail = 0;
512 513 514 515 516 517 518
}

static void nvme_commit_rqs(struct blk_mq_hw_ctx *hctx)
{
	struct nvme_queue *nvmeq = hctx->driver_data;

	spin_lock(&nvmeq->sq_lock);
519 520
	if (nvmeq->sq_tail != nvmeq->last_sq_tail)
		nvme_write_sq_db(nvmeq, true);
521
	spin_unlock(&nvmeq->sq_lock);
M
Matthew Wilcox 已提交
522 523
}

C
Chaitanya Kulkarni 已提交
524
static void **nvme_pci_iod_list(struct request *req)
M
Matthew Wilcox 已提交
525
{
C
Christoph Hellwig 已提交
526
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
C
Chaitanya Kulkarni 已提交
527
	return (void **)(iod->sg + blk_rq_nr_phys_segments(req));
M
Matthew Wilcox 已提交
528 529
}

530 531 532
static inline bool nvme_pci_use_sgls(struct nvme_dev *dev, struct request *req)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
533
	int nseg = blk_rq_nr_phys_segments(req);
534 535
	unsigned int avg_seg_size;

536
	avg_seg_size = DIV_ROUND_UP(blk_rq_payload_bytes(req), nseg);
537

538
	if (!nvme_ctrl_sgl_supported(&dev->ctrl))
539 540 541 542 543 544 545 546
		return false;
	if (!iod->nvmeq->qid)
		return false;
	if (!sgl_threshold || avg_seg_size < sgl_threshold)
		return false;
	return true;
}

547
static void nvme_free_prps(struct nvme_dev *dev, struct request *req)
M
Matthew Wilcox 已提交
548
{
549
	const int last_prp = NVME_CTRL_PAGE_SIZE / sizeof(__le64) - 1;
550 551
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	dma_addr_t dma_addr = iod->first_dma;
552 553
	int i;

554 555 556 557 558 559
	for (i = 0; i < iod->npages; i++) {
		__le64 *prp_list = nvme_pci_iod_list(req)[i];
		dma_addr_t next_dma_addr = le64_to_cpu(prp_list[last_prp]);

		dma_pool_free(dev->prp_page_pool, prp_list, dma_addr);
		dma_addr = next_dma_addr;
560
	}
561
}
562

563 564 565 566 567 568
static void nvme_free_sgls(struct nvme_dev *dev, struct request *req)
{
	const int last_sg = SGES_PER_PAGE - 1;
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	dma_addr_t dma_addr = iod->first_dma;
	int i;
569

570 571 572
	for (i = 0; i < iod->npages; i++) {
		struct nvme_sgl_desc *sg_list = nvme_pci_iod_list(req)[i];
		dma_addr_t next_dma_addr = le64_to_cpu((sg_list[last_sg]).addr);
573

574 575 576 577
		dma_pool_free(dev->prp_page_pool, sg_list, dma_addr);
		dma_addr = next_dma_addr;
	}
}
C
Chaitanya Kulkarni 已提交
578

579 580 581
static void nvme_unmap_sg(struct nvme_dev *dev, struct request *req)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
C
Chaitanya Kulkarni 已提交
582

583 584 585 586 587 588
	if (is_pci_p2pdma_page(sg_page(iod->sg)))
		pci_p2pdma_unmap_sg(dev->dev, iod->sg, iod->nents,
				    rq_dma_dir(req));
	else
		dma_unmap_sg(dev->dev, iod->sg, iod->nents, rq_dma_dir(req));
}
C
Chaitanya Kulkarni 已提交
589

590 591 592
static void nvme_unmap_data(struct nvme_dev *dev, struct request *req)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
C
Chaitanya Kulkarni 已提交
593

594 595 596 597
	if (iod->dma_len) {
		dma_unmap_page(dev->dev, iod->first_dma, iod->dma_len,
			       rq_dma_dir(req));
		return;
598
	}
599

600 601 602 603 604 605 606 607 608 609
	WARN_ON_ONCE(!iod->nents);

	nvme_unmap_sg(dev, req);
	if (iod->npages == 0)
		dma_pool_free(dev->prp_small_pool, nvme_pci_iod_list(req)[0],
			      iod->first_dma);
	else if (iod->use_sgl)
		nvme_free_sgls(dev, req);
	else
		nvme_free_prps(dev, req);
610
	mempool_free(iod->sg, dev->iod_mempool);
K
Keith Busch 已提交
611 612
}

613 614 615 616 617 618 619 620 621 622 623 624 625 626
static void nvme_print_sgl(struct scatterlist *sgl, int nents)
{
	int i;
	struct scatterlist *sg;

	for_each_sg(sgl, sg, nents, i) {
		dma_addr_t phys = sg_phys(sg);
		pr_warn("sg[%d] phys_addr:%pad offset:%d length:%d "
			"dma_address:%pad dma_length:%d\n",
			i, &phys, sg->offset, sg->length, &sg_dma_address(sg),
			sg_dma_len(sg));
	}
}

C
Chaitanya Kulkarni 已提交
627 628
static blk_status_t nvme_pci_setup_prps(struct nvme_dev *dev,
		struct request *req, struct nvme_rw_command *cmnd)
M
Matthew Wilcox 已提交
629
{
C
Christoph Hellwig 已提交
630
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
631
	struct dma_pool *pool;
632
	int length = blk_rq_payload_bytes(req);
633
	struct scatterlist *sg = iod->sg;
M
Matthew Wilcox 已提交
634 635
	int dma_len = sg_dma_len(sg);
	u64 dma_addr = sg_dma_address(sg);
636
	int offset = dma_addr & (NVME_CTRL_PAGE_SIZE - 1);
637
	__le64 *prp_list;
C
Chaitanya Kulkarni 已提交
638
	void **list = nvme_pci_iod_list(req);
639
	dma_addr_t prp_dma;
640
	int nprps, i;
M
Matthew Wilcox 已提交
641

642
	length -= (NVME_CTRL_PAGE_SIZE - offset);
643 644
	if (length <= 0) {
		iod->first_dma = 0;
C
Chaitanya Kulkarni 已提交
645
		goto done;
646
	}
M
Matthew Wilcox 已提交
647

648
	dma_len -= (NVME_CTRL_PAGE_SIZE - offset);
M
Matthew Wilcox 已提交
649
	if (dma_len) {
650
		dma_addr += (NVME_CTRL_PAGE_SIZE - offset);
M
Matthew Wilcox 已提交
651 652 653 654 655 656
	} else {
		sg = sg_next(sg);
		dma_addr = sg_dma_address(sg);
		dma_len = sg_dma_len(sg);
	}

657
	if (length <= NVME_CTRL_PAGE_SIZE) {
658
		iod->first_dma = dma_addr;
C
Chaitanya Kulkarni 已提交
659
		goto done;
660 661
	}

662
	nprps = DIV_ROUND_UP(length, NVME_CTRL_PAGE_SIZE);
663 664
	if (nprps <= (256 / 8)) {
		pool = dev->prp_small_pool;
665
		iod->npages = 0;
666 667
	} else {
		pool = dev->prp_page_pool;
668
		iod->npages = 1;
669 670
	}

671
	prp_list = dma_pool_alloc(pool, GFP_ATOMIC, &prp_dma);
672
	if (!prp_list) {
673
		iod->first_dma = dma_addr;
674
		iod->npages = -1;
675
		return BLK_STS_RESOURCE;
676
	}
677 678
	list[0] = prp_list;
	iod->first_dma = prp_dma;
679 680
	i = 0;
	for (;;) {
681
		if (i == NVME_CTRL_PAGE_SIZE >> 3) {
682
			__le64 *old_prp_list = prp_list;
683
			prp_list = dma_pool_alloc(pool, GFP_ATOMIC, &prp_dma);
684
			if (!prp_list)
685
				goto free_prps;
686
			list[iod->npages++] = prp_list;
687 688 689
			prp_list[0] = old_prp_list[i - 1];
			old_prp_list[i - 1] = cpu_to_le64(prp_dma);
			i = 1;
690 691
		}
		prp_list[i++] = cpu_to_le64(dma_addr);
692 693 694
		dma_len -= NVME_CTRL_PAGE_SIZE;
		dma_addr += NVME_CTRL_PAGE_SIZE;
		length -= NVME_CTRL_PAGE_SIZE;
695 696 697 698
		if (length <= 0)
			break;
		if (dma_len > 0)
			continue;
699 700
		if (unlikely(dma_len < 0))
			goto bad_sgl;
701 702 703
		sg = sg_next(sg);
		dma_addr = sg_dma_address(sg);
		dma_len = sg_dma_len(sg);
M
Matthew Wilcox 已提交
704
	}
C
Chaitanya Kulkarni 已提交
705 706 707
done:
	cmnd->dptr.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
	cmnd->dptr.prp2 = cpu_to_le64(iod->first_dma);
708
	return BLK_STS_OK;
709 710 711 712
free_prps:
	nvme_free_prps(dev, req);
	return BLK_STS_RESOURCE;
bad_sgl:
713 714 715
	WARN(DO_ONCE(nvme_print_sgl, iod->sg, iod->nents),
			"Invalid SGL for payload:%d nents:%d\n",
			blk_rq_payload_bytes(req), iod->nents);
716
	return BLK_STS_IOERR;
M
Matthew Wilcox 已提交
717 718
}

C
Chaitanya Kulkarni 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
static void nvme_pci_sgl_set_data(struct nvme_sgl_desc *sge,
		struct scatterlist *sg)
{
	sge->addr = cpu_to_le64(sg_dma_address(sg));
	sge->length = cpu_to_le32(sg_dma_len(sg));
	sge->type = NVME_SGL_FMT_DATA_DESC << 4;
}

static void nvme_pci_sgl_set_seg(struct nvme_sgl_desc *sge,
		dma_addr_t dma_addr, int entries)
{
	sge->addr = cpu_to_le64(dma_addr);
	if (entries < SGES_PER_PAGE) {
		sge->length = cpu_to_le32(entries * sizeof(*sge));
		sge->type = NVME_SGL_FMT_LAST_SEG_DESC << 4;
	} else {
		sge->length = cpu_to_le32(PAGE_SIZE);
		sge->type = NVME_SGL_FMT_SEG_DESC << 4;
	}
}

static blk_status_t nvme_pci_setup_sgls(struct nvme_dev *dev,
741
		struct request *req, struct nvme_rw_command *cmd, int entries)
C
Chaitanya Kulkarni 已提交
742 743 744 745 746 747
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	struct dma_pool *pool;
	struct nvme_sgl_desc *sg_list;
	struct scatterlist *sg = iod->sg;
	dma_addr_t sgl_dma;
748
	int i = 0;
C
Chaitanya Kulkarni 已提交
749 750 751 752

	/* setting the transfer type as SGL */
	cmd->flags = NVME_CMD_SGL_METABUF;

753
	if (entries == 1) {
C
Chaitanya Kulkarni 已提交
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
		nvme_pci_sgl_set_data(&cmd->dptr.sgl, sg);
		return BLK_STS_OK;
	}

	if (entries <= (256 / sizeof(struct nvme_sgl_desc))) {
		pool = dev->prp_small_pool;
		iod->npages = 0;
	} else {
		pool = dev->prp_page_pool;
		iod->npages = 1;
	}

	sg_list = dma_pool_alloc(pool, GFP_ATOMIC, &sgl_dma);
	if (!sg_list) {
		iod->npages = -1;
		return BLK_STS_RESOURCE;
	}

	nvme_pci_iod_list(req)[0] = sg_list;
	iod->first_dma = sgl_dma;

	nvme_pci_sgl_set_seg(&cmd->dptr.sgl, sgl_dma, entries);

	do {
		if (i == SGES_PER_PAGE) {
			struct nvme_sgl_desc *old_sg_desc = sg_list;
			struct nvme_sgl_desc *link = &old_sg_desc[i - 1];

			sg_list = dma_pool_alloc(pool, GFP_ATOMIC, &sgl_dma);
			if (!sg_list)
784
				goto free_sgls;
C
Chaitanya Kulkarni 已提交
785 786 787 788 789 790 791 792 793

			i = 0;
			nvme_pci_iod_list(req)[iod->npages++] = sg_list;
			sg_list[i++] = *link;
			nvme_pci_sgl_set_seg(link, sgl_dma, entries);
		}

		nvme_pci_sgl_set_data(&sg_list[i++], sg);
		sg = sg_next(sg);
794
	} while (--entries > 0);
C
Chaitanya Kulkarni 已提交
795 796

	return BLK_STS_OK;
797 798 799
free_sgls:
	nvme_free_sgls(dev, req);
	return BLK_STS_RESOURCE;
C
Chaitanya Kulkarni 已提交
800 801
}

802 803 804 805 806
static blk_status_t nvme_setup_prp_simple(struct nvme_dev *dev,
		struct request *req, struct nvme_rw_command *cmnd,
		struct bio_vec *bv)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
807 808
	unsigned int offset = bv->bv_offset & (NVME_CTRL_PAGE_SIZE - 1);
	unsigned int first_prp_len = NVME_CTRL_PAGE_SIZE - offset;
809 810 811 812 813 814 815 816 817

	iod->first_dma = dma_map_bvec(dev->dev, bv, rq_dma_dir(req), 0);
	if (dma_mapping_error(dev->dev, iod->first_dma))
		return BLK_STS_RESOURCE;
	iod->dma_len = bv->bv_len;

	cmnd->dptr.prp1 = cpu_to_le64(iod->first_dma);
	if (bv->bv_len > first_prp_len)
		cmnd->dptr.prp2 = cpu_to_le64(iod->first_dma + first_prp_len);
818
	return BLK_STS_OK;
819 820
}

821 822 823 824 825 826 827 828 829 830 831
static blk_status_t nvme_setup_sgl_simple(struct nvme_dev *dev,
		struct request *req, struct nvme_rw_command *cmnd,
		struct bio_vec *bv)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);

	iod->first_dma = dma_map_bvec(dev->dev, bv, rq_dma_dir(req), 0);
	if (dma_mapping_error(dev->dev, iod->first_dma))
		return BLK_STS_RESOURCE;
	iod->dma_len = bv->bv_len;

832
	cmnd->flags = NVME_CMD_SGL_METABUF;
833 834 835
	cmnd->dptr.sgl.addr = cpu_to_le64(iod->first_dma);
	cmnd->dptr.sgl.length = cpu_to_le32(iod->dma_len);
	cmnd->dptr.sgl.type = NVME_SGL_FMT_DATA_DESC << 4;
836
	return BLK_STS_OK;
837 838
}

839
static blk_status_t nvme_map_data(struct nvme_dev *dev, struct request *req,
840
		struct nvme_command *cmnd)
841
{
C
Christoph Hellwig 已提交
842
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
843
	blk_status_t ret = BLK_STS_RESOURCE;
844
	int nr_mapped;
845

846 847 848 849
	if (blk_rq_nr_phys_segments(req) == 1) {
		struct bio_vec bv = req_bvec(req);

		if (!is_pci_p2pdma_page(bv.bv_page)) {
850
			if (bv.bv_offset + bv.bv_len <= NVME_CTRL_PAGE_SIZE * 2)
851 852
				return nvme_setup_prp_simple(dev, req,
							     &cmnd->rw, &bv);
853

854
			if (iod->nvmeq->qid && sgl_threshold &&
855
			    nvme_ctrl_sgl_supported(&dev->ctrl))
856 857
				return nvme_setup_sgl_simple(dev, req,
							     &cmnd->rw, &bv);
858 859 860 861
		}
	}

	iod->dma_len = 0;
862 863 864
	iod->sg = mempool_alloc(dev->iod_mempool, GFP_ATOMIC);
	if (!iod->sg)
		return BLK_STS_RESOURCE;
865
	sg_init_table(iod->sg, blk_rq_nr_phys_segments(req));
866
	iod->nents = blk_rq_map_sg(req->q, req, iod->sg);
C
Christoph Hellwig 已提交
867
	if (!iod->nents)
868
		goto out_free_sg;
869

870
	if (is_pci_p2pdma_page(sg_page(iod->sg)))
871 872
		nr_mapped = pci_p2pdma_map_sg_attrs(dev->dev, iod->sg,
				iod->nents, rq_dma_dir(req), DMA_ATTR_NO_WARN);
873 874
	else
		nr_mapped = dma_map_sg_attrs(dev->dev, iod->sg, iod->nents,
875
					     rq_dma_dir(req), DMA_ATTR_NO_WARN);
876
	if (!nr_mapped)
877
		goto out_free_sg;
878

879
	iod->use_sgl = nvme_pci_use_sgls(dev, req);
880
	if (iod->use_sgl)
881
		ret = nvme_pci_setup_sgls(dev, req, &cmnd->rw, nr_mapped);
C
Chaitanya Kulkarni 已提交
882 883
	else
		ret = nvme_pci_setup_prps(dev, req, &cmnd->rw);
884
	if (ret != BLK_STS_OK)
885 886 887 888 889 890 891
		goto out_unmap_sg;
	return BLK_STS_OK;

out_unmap_sg:
	nvme_unmap_sg(dev, req);
out_free_sg:
	mempool_free(iod->sg, dev->iod_mempool);
892 893
	return ret;
}
894

895 896 897 898
static blk_status_t nvme_map_metadata(struct nvme_dev *dev, struct request *req,
		struct nvme_command *cmnd)
{
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
M
Matthew Wilcox 已提交
899

900 901 902 903 904
	iod->meta_dma = dma_map_bvec(dev->dev, rq_integrity_vec(req),
			rq_dma_dir(req), 0);
	if (dma_mapping_error(dev->dev, iod->meta_dma))
		return BLK_STS_IOERR;
	cmnd->rw.metadata = cpu_to_le64(iod->meta_dma);
905
	return BLK_STS_OK;
M
Matthew Wilcox 已提交
906 907
}

J
Jens Axboe 已提交
908
static blk_status_t nvme_prep_rq(struct nvme_dev *dev, struct request *req)
909
{
910
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
911
	blk_status_t ret;
K
Keith Busch 已提交
912

913 914 915 916
	iod->aborted = 0;
	iod->npages = -1;
	iod->nents = 0;

J
Jens Axboe 已提交
917
	ret = nvme_setup_cmd(req->q->queuedata, req);
918
	if (ret)
C
Christoph Hellwig 已提交
919
		return ret;
M
Matias Bjørling 已提交
920

921
	if (blk_rq_nr_phys_segments(req)) {
J
Jens Axboe 已提交
922
		ret = nvme_map_data(dev, req, &iod->cmd);
923
		if (ret)
924
			goto out_free_cmd;
925
	}
M
Matias Bjørling 已提交
926

927
	if (blk_integrity_rq(req)) {
J
Jens Axboe 已提交
928
		ret = nvme_map_metadata(dev, req, &iod->cmd);
929 930 931 932
		if (ret)
			goto out_unmap_data;
	}

933
	blk_mq_start_request(req);
934
	return BLK_STS_OK;
935 936
out_unmap_data:
	nvme_unmap_data(dev, req);
937 938
out_free_cmd:
	nvme_cleanup_cmd(req);
C
Christoph Hellwig 已提交
939
	return ret;
M
Matthew Wilcox 已提交
940
}
K
Keith Busch 已提交
941

J
Jens Axboe 已提交
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
/*
 * NOTE: ns is NULL when called on the admin queue.
 */
static blk_status_t nvme_queue_rq(struct blk_mq_hw_ctx *hctx,
			 const struct blk_mq_queue_data *bd)
{
	struct nvme_queue *nvmeq = hctx->driver_data;
	struct nvme_dev *dev = nvmeq->dev;
	struct request *req = bd->rq;
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	blk_status_t ret;

	/*
	 * We should not need to do this, but we're still using this to
	 * ensure we can drain requests on a dying queue.
	 */
	if (unlikely(!test_bit(NVMEQ_ENABLED, &nvmeq->flags)))
		return BLK_STS_IOERR;

	if (unlikely(!nvme_check_ready(&dev->ctrl, req, true)))
		return nvme_fail_nonready_command(&dev->ctrl, req);

	ret = nvme_prep_rq(dev, req);
	if (unlikely(ret))
		return ret;
	spin_lock(&nvmeq->sq_lock);
	nvme_sq_copy_cmd(nvmeq, &iod->cmd);
	nvme_write_sq_db(nvmeq, bd->last);
	spin_unlock(&nvmeq->sq_lock);
	return BLK_STS_OK;
}

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
static void nvme_submit_cmds(struct nvme_queue *nvmeq, struct request **rqlist)
{
	spin_lock(&nvmeq->sq_lock);
	while (!rq_list_empty(*rqlist)) {
		struct request *req = rq_list_pop(rqlist);
		struct nvme_iod *iod = blk_mq_rq_to_pdu(req);

		nvme_sq_copy_cmd(nvmeq, &iod->cmd);
	}
	nvme_write_sq_db(nvmeq, true);
	spin_unlock(&nvmeq->sq_lock);
}

static bool nvme_prep_rq_batch(struct nvme_queue *nvmeq, struct request *req)
{
	/*
	 * We should not need to do this, but we're still using this to
	 * ensure we can drain requests on a dying queue.
	 */
	if (unlikely(!test_bit(NVMEQ_ENABLED, &nvmeq->flags)))
		return false;
	if (unlikely(!nvme_check_ready(&nvmeq->dev->ctrl, req, true)))
		return false;

	req->mq_hctx->tags->rqs[req->tag] = req;
	return nvme_prep_rq(nvmeq->dev, req) == BLK_STS_OK;
}

static void nvme_queue_rqs(struct request **rqlist)
{
1004
	struct request *req, *next, *prev = NULL;
1005 1006
	struct request *requeue_list = NULL;

1007
	rq_list_for_each_safe(rqlist, req, next) {
1008 1009 1010 1011
		struct nvme_queue *nvmeq = req->mq_hctx->driver_data;

		if (!nvme_prep_rq_batch(nvmeq, req)) {
			/* detach 'req' and add to remainder list */
1012 1013 1014 1015 1016
			rq_list_move(rqlist, &requeue_list, req, prev);

			req = prev;
			if (!req)
				continue;
1017 1018
		}

1019
		if (!next || req->mq_hctx != next->mq_hctx) {
1020
			/* detach rest of list, and submit */
1021
			req->rq_next = NULL;
1022
			nvme_submit_cmds(nvmeq, rqlist);
1023 1024 1025 1026 1027
			*rqlist = next;
			prev = NULL;
		} else
			prev = req;
	}
1028 1029 1030 1031

	*rqlist = requeue_list;
}

1032
static __always_inline void nvme_pci_unmap_rq(struct request *req)
1033
{
C
Christoph Hellwig 已提交
1034
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1035
	struct nvme_dev *dev = iod->nvmeq->dev;
M
Matias Bjørling 已提交
1036

1037 1038 1039
	if (blk_integrity_rq(req))
		dma_unmap_page(dev->dev, iod->meta_dma,
			       rq_integrity_vec(req)->bv_len, rq_data_dir(req));
1040
	if (blk_rq_nr_phys_segments(req))
1041
		nvme_unmap_data(dev, req);
1042 1043 1044 1045 1046
}

static void nvme_pci_complete_rq(struct request *req)
{
	nvme_pci_unmap_rq(req);
1047
	nvme_complete_rq(req);
M
Matthew Wilcox 已提交
1048 1049
}

1050 1051 1052 1053 1054
static void nvme_pci_complete_batch(struct io_comp_batch *iob)
{
	nvme_complete_batch(iob, nvme_pci_unmap_rq);
}

1055
/* We read the CQE phase first to check if the rest of the entry is valid */
1056
static inline bool nvme_cqe_pending(struct nvme_queue *nvmeq)
1057
{
K
Keith Busch 已提交
1058 1059 1060
	struct nvme_completion *hcqe = &nvmeq->cqes[nvmeq->cq_head];

	return (le16_to_cpu(READ_ONCE(hcqe->status)) & 1) == nvmeq->cq_phase;
1061 1062
}

1063
static inline void nvme_ring_cq_doorbell(struct nvme_queue *nvmeq)
M
Matthew Wilcox 已提交
1064
{
1065
	u16 head = nvmeq->cq_head;
1066

1067 1068 1069
	if (nvme_dbbuf_update_and_check_event(head, nvmeq->dbbuf_cq_db,
					      nvmeq->dbbuf_cq_ei))
		writel(head, nvmeq->q_db + nvmeq->dev->db_stride);
1070
}
1071

C
Christoph Hellwig 已提交
1072 1073 1074 1075 1076 1077 1078
static inline struct blk_mq_tags *nvme_queue_tagset(struct nvme_queue *nvmeq)
{
	if (!nvmeq->qid)
		return nvmeq->dev->admin_tagset.tags[0];
	return nvmeq->dev->tagset.tags[nvmeq->qid - 1];
}

1079 1080
static inline void nvme_handle_cqe(struct nvme_queue *nvmeq,
				   struct io_comp_batch *iob, u16 idx)
1081
{
K
Keith Busch 已提交
1082
	struct nvme_completion *cqe = &nvmeq->cqes[idx];
1083
	__u16 command_id = READ_ONCE(cqe->command_id);
1084
	struct request *req;
1085

1086 1087 1088 1089 1090 1091
	/*
	 * AEN requests are special as they don't time out and can
	 * survive any kind of queue freeze and often don't respond to
	 * aborts.  We don't even bother to allocate a struct request
	 * for them but rather special case them here.
	 */
1092
	if (unlikely(nvme_is_aen_req(nvmeq->qid, command_id))) {
1093 1094
		nvme_complete_async_event(&nvmeq->dev->ctrl,
				cqe->status, &cqe->result);
J
Jens Axboe 已提交
1095
		return;
1096
	}
M
Matthew Wilcox 已提交
1097

1098
	req = nvme_find_rq(nvme_queue_tagset(nvmeq), command_id);
1099 1100 1101
	if (unlikely(!req)) {
		dev_warn(nvmeq->dev->ctrl.device,
			"invalid id %d completed on queue %d\n",
1102
			command_id, le16_to_cpu(cqe->sq_id));
1103 1104 1105
		return;
	}

Y
yupeng 已提交
1106
	trace_nvme_sq(req, cqe->sq_head, nvmeq->sq_tail);
1107 1108 1109
	if (!nvme_try_complete_req(req, cqe->status, cqe->result) &&
	    !blk_mq_add_to_batch(req, iob, nvme_req(req)->status,
					nvme_pci_complete_batch))
1110
		nvme_pci_complete_rq(req);
1111
}
M
Matthew Wilcox 已提交
1112

1113 1114
static inline void nvme_update_cq_head(struct nvme_queue *nvmeq)
{
1115
	u32 tmp = nvmeq->cq_head + 1;
1116 1117

	if (tmp == nvmeq->q_depth) {
1118
		nvmeq->cq_head = 0;
1119
		nvmeq->cq_phase ^= 1;
1120 1121
	} else {
		nvmeq->cq_head = tmp;
M
Matthew Wilcox 已提交
1122
	}
J
Jens Axboe 已提交
1123 1124
}

1125 1126
static inline int nvme_poll_cq(struct nvme_queue *nvmeq,
			       struct io_comp_batch *iob)
J
Jens Axboe 已提交
1127
{
1128
	int found = 0;
M
Matthew Wilcox 已提交
1129

1130
	while (nvme_cqe_pending(nvmeq)) {
1131
		found++;
1132 1133 1134 1135 1136
		/*
		 * load-load control dependency between phase and the rest of
		 * the cqe requires a full read memory barrier
		 */
		dma_rmb();
1137
		nvme_handle_cqe(nvmeq, iob, nvmeq->cq_head);
1138
		nvme_update_cq_head(nvmeq);
1139
	}
1140

1141
	if (found)
1142
		nvme_ring_cq_doorbell(nvmeq);
1143
	return found;
M
Matthew Wilcox 已提交
1144 1145 1146
}

static irqreturn_t nvme_irq(int irq, void *data)
1147 1148
{
	struct nvme_queue *nvmeq = data;
1149
	DEFINE_IO_COMP_BATCH(iob);
1150

1151 1152 1153
	if (nvme_poll_cq(nvmeq, &iob)) {
		if (!rq_list_empty(iob.req_list))
			nvme_pci_complete_batch(&iob);
1154
		return IRQ_HANDLED;
1155
	}
1156
	return IRQ_NONE;
1157 1158 1159 1160 1161
}

static irqreturn_t nvme_irq_check(int irq, void *data)
{
	struct nvme_queue *nvmeq = data;
1162

1163
	if (nvme_cqe_pending(nvmeq))
1164 1165
		return IRQ_WAKE_THREAD;
	return IRQ_NONE;
1166 1167
}

1168
/*
1169
 * Poll for completions for any interrupt driven queue
1170 1171
 * Can be called from any context.
 */
1172
static void nvme_poll_irqdisable(struct nvme_queue *nvmeq)
J
Jens Axboe 已提交
1173
{
1174
	struct pci_dev *pdev = to_pci_dev(nvmeq->dev->dev);
J
Jens Axboe 已提交
1175

1176
	WARN_ON_ONCE(test_bit(NVMEQ_POLLED, &nvmeq->flags));
1177

1178
	disable_irq(pci_irq_vector(pdev, nvmeq->cq_vector));
1179
	nvme_poll_cq(nvmeq, NULL);
1180
	enable_irq(pci_irq_vector(pdev, nvmeq->cq_vector));
J
Jens Axboe 已提交
1181 1182
}

1183
static int nvme_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
1184 1185 1186 1187 1188 1189 1190
{
	struct nvme_queue *nvmeq = hctx->driver_data;
	bool found;

	if (!nvme_cqe_pending(nvmeq))
		return 0;

1191
	spin_lock(&nvmeq->cq_poll_lock);
1192
	found = nvme_poll_cq(nvmeq, iob);
1193
	spin_unlock(&nvmeq->cq_poll_lock);
1194 1195 1196 1197

	return found;
}

1198
static void nvme_pci_submit_async_event(struct nvme_ctrl *ctrl)
M
Matthew Wilcox 已提交
1199
{
1200
	struct nvme_dev *dev = to_nvme_dev(ctrl);
1201
	struct nvme_queue *nvmeq = &dev->queues[0];
1202
	struct nvme_command c = { };
M
Matthew Wilcox 已提交
1203

M
Matias Bjørling 已提交
1204
	c.common.opcode = nvme_admin_async_event;
1205
	c.common.command_id = NVME_AQ_BLK_MQ_DEPTH;
1206 1207 1208 1209 1210

	spin_lock(&nvmeq->sq_lock);
	nvme_sq_copy_cmd(nvmeq, &c);
	nvme_write_sq_db(nvmeq, true);
	spin_unlock(&nvmeq->sq_lock);
1211 1212
}

M
Matthew Wilcox 已提交
1213
static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
1214
{
1215
	struct nvme_command c = { };
M
Matthew Wilcox 已提交
1216 1217 1218 1219

	c.delete_queue.opcode = opcode;
	c.delete_queue.qid = cpu_to_le16(id);

1220
	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
M
Matthew Wilcox 已提交
1221 1222 1223
}

static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
1224
		struct nvme_queue *nvmeq, s16 vector)
M
Matthew Wilcox 已提交
1225
{
1226
	struct nvme_command c = { };
J
Jens Axboe 已提交
1227 1228
	int flags = NVME_QUEUE_PHYS_CONTIG;

1229
	if (!test_bit(NVMEQ_POLLED, &nvmeq->flags))
J
Jens Axboe 已提交
1230
		flags |= NVME_CQ_IRQ_ENABLED;
M
Matthew Wilcox 已提交
1231

1232
	/*
M
Minwoo Im 已提交
1233
	 * Note: we (ab)use the fact that the prp fields survive if no data
1234 1235
	 * is attached to the request.
	 */
M
Matthew Wilcox 已提交
1236 1237 1238 1239 1240
	c.create_cq.opcode = nvme_admin_create_cq;
	c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
	c.create_cq.cqid = cpu_to_le16(qid);
	c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
	c.create_cq.cq_flags = cpu_to_le16(flags);
1241
	c.create_cq.irq_vector = cpu_to_le16(vector);
M
Matthew Wilcox 已提交
1242

1243
	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
M
Matthew Wilcox 已提交
1244 1245 1246 1247 1248
}

static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
						struct nvme_queue *nvmeq)
{
1249
	struct nvme_ctrl *ctrl = &dev->ctrl;
1250
	struct nvme_command c = { };
1251
	int flags = NVME_QUEUE_PHYS_CONTIG;
M
Matthew Wilcox 已提交
1252

1253 1254 1255 1256 1257 1258 1259 1260
	/*
	 * Some drives have a bug that auto-enables WRRU if MEDIUM isn't
	 * set. Since URGENT priority is zeroes, it makes all queues
	 * URGENT.
	 */
	if (ctrl->quirks & NVME_QUIRK_MEDIUM_PRIO_SQ)
		flags |= NVME_SQ_PRIO_MEDIUM;

1261
	/*
M
Minwoo Im 已提交
1262
	 * Note: we (ab)use the fact that the prp fields survive if no data
1263 1264
	 * is attached to the request.
	 */
M
Matthew Wilcox 已提交
1265 1266 1267 1268 1269 1270 1271
	c.create_sq.opcode = nvme_admin_create_sq;
	c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
	c.create_sq.sqid = cpu_to_le16(qid);
	c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
	c.create_sq.sq_flags = cpu_to_le16(flags);
	c.create_sq.cqid = cpu_to_le16(qid);

1272
	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
M
Matthew Wilcox 已提交
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
}

static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
{
	return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
}

static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
{
	return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
}

1285
static void abort_endio(struct request *req, blk_status_t error)
1286
{
C
Christoph Hellwig 已提交
1287 1288
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	struct nvme_queue *nvmeq = iod->nvmeq;
1289

1290 1291
	dev_warn(nvmeq->dev->ctrl.device,
		 "Abort status: 0x%x", nvme_req(req)->status);
1292 1293
	atomic_inc(&nvmeq->dev->ctrl.abort_limit);
	blk_mq_free_request(req);
1294 1295
}

K
Keith Busch 已提交
1296 1297 1298 1299 1300 1301 1302
static bool nvme_should_reset(struct nvme_dev *dev, u32 csts)
{
	/* If true, indicates loss of adapter communication, possibly by a
	 * NVMe Subsystem reset.
	 */
	bool nssro = dev->subsystem && (csts & NVME_CSTS_NSSRO);

1303 1304 1305
	/* If there is a reset/reinit ongoing, we shouldn't reset again. */
	switch (dev->ctrl.state) {
	case NVME_CTRL_RESETTING:
1306
	case NVME_CTRL_CONNECTING:
K
Keith Busch 已提交
1307
		return false;
1308 1309 1310
	default:
		break;
	}
K
Keith Busch 已提交
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336

	/* We shouldn't reset unless the controller is on fatal error state
	 * _or_ if we lost the communication with it.
	 */
	if (!(csts & NVME_CSTS_CFS) && !nssro)
		return false;

	return true;
}

static void nvme_warn_reset(struct nvme_dev *dev, u32 csts)
{
	/* Read a config register to help see what died. */
	u16 pci_status;
	int result;

	result = pci_read_config_word(to_pci_dev(dev->dev), PCI_STATUS,
				      &pci_status);
	if (result == PCIBIOS_SUCCESSFUL)
		dev_warn(dev->ctrl.device,
			 "controller is down; will reset: CSTS=0x%x, PCI_STATUS=0x%hx\n",
			 csts, pci_status);
	else
		dev_warn(dev->ctrl.device,
			 "controller is down; will reset: CSTS=0x%x, PCI_STATUS read failed (%d)\n",
			 csts, result);
1337 1338 1339 1340 1341 1342 1343 1344

	if (csts != ~0)
		return;

	dev_warn(dev->ctrl.device,
		 "Does your device have a faulty power saving mode enabled?\n");
	dev_warn(dev->ctrl.device,
		 "Try \"nvme_core.default_ps_max_latency_us=0 pcie_aspm=off\" and report a bug\n");
K
Keith Busch 已提交
1345 1346
}

1347
static enum blk_eh_timer_return nvme_timeout(struct request *req, bool reserved)
K
Keith Busch 已提交
1348
{
C
Christoph Hellwig 已提交
1349 1350
	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
	struct nvme_queue *nvmeq = iod->nvmeq;
K
Keith Busch 已提交
1351
	struct nvme_dev *dev = nvmeq->dev;
M
Matias Bjørling 已提交
1352
	struct request *abort_req;
1353
	struct nvme_command cmd = { };
K
Keith Busch 已提交
1354 1355
	u32 csts = readl(dev->bar + NVME_REG_CSTS);

W
Wen Xiong 已提交
1356 1357 1358 1359 1360 1361 1362
	/* If PCI error recovery process is happening, we cannot reset or
	 * the recovery mechanism will surely fail.
	 */
	mb();
	if (pci_channel_offline(to_pci_dev(dev->dev)))
		return BLK_EH_RESET_TIMER;

K
Keith Busch 已提交
1363 1364 1365 1366 1367 1368
	/*
	 * Reset immediately if the controller is failed
	 */
	if (nvme_should_reset(dev, csts)) {
		nvme_warn_reset(dev, csts);
		nvme_dev_disable(dev, false);
1369
		nvme_reset_ctrl(&dev->ctrl);
1370
		return BLK_EH_DONE;
K
Keith Busch 已提交
1371
	}
K
Keith Busch 已提交
1372

K
Keith Busch 已提交
1373 1374 1375
	/*
	 * Did we miss an interrupt?
	 */
1376
	if (test_bit(NVMEQ_POLLED, &nvmeq->flags))
1377
		nvme_poll(req->mq_hctx, NULL);
1378 1379 1380
	else
		nvme_poll_irqdisable(nvmeq);

1381
	if (blk_mq_request_completed(req)) {
K
Keith Busch 已提交
1382 1383 1384
		dev_warn(dev->ctrl.device,
			 "I/O %d QID %d timeout, completion polled\n",
			 req->tag, nvmeq->qid);
1385
		return BLK_EH_DONE;
K
Keith Busch 已提交
1386 1387
	}

1388
	/*
1389 1390 1391
	 * Shutdown immediately if controller times out while starting. The
	 * reset work will see the pci device disabled when it gets the forced
	 * cancellation error. All outstanding requests are completed on
1392
	 * shutdown, so we return BLK_EH_DONE.
1393
	 */
1394 1395
	switch (dev->ctrl.state) {
	case NVME_CTRL_CONNECTING:
1396
		nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
1397
		fallthrough;
1398
	case NVME_CTRL_DELETING:
1399
		dev_warn_ratelimited(dev->ctrl.device,
1400 1401
			 "I/O %d QID %d timeout, disable controller\n",
			 req->tag, nvmeq->qid);
1402
		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
1403
		nvme_dev_disable(dev, true);
1404
		return BLK_EH_DONE;
1405 1406
	case NVME_CTRL_RESETTING:
		return BLK_EH_RESET_TIMER;
1407 1408
	default:
		break;
K
Keith Busch 已提交
1409 1410
	}

1411
	/*
B
Baolin Wang 已提交
1412 1413 1414
	 * Shutdown the controller immediately and schedule a reset if the
	 * command was already aborted once before and still hasn't been
	 * returned to the driver, or if this is the admin queue.
1415
	 */
C
Christoph Hellwig 已提交
1416
	if (!nvmeq->qid || iod->aborted) {
1417
		dev_warn(dev->ctrl.device,
1418 1419
			 "I/O %d QID %d timeout, reset controller\n",
			 req->tag, nvmeq->qid);
1420
		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
1421
		nvme_dev_disable(dev, false);
1422
		nvme_reset_ctrl(&dev->ctrl);
K
Keith Busch 已提交
1423

1424
		return BLK_EH_DONE;
K
Keith Busch 已提交
1425 1426
	}

1427
	if (atomic_dec_return(&dev->ctrl.abort_limit) < 0) {
1428
		atomic_inc(&dev->ctrl.abort_limit);
1429
		return BLK_EH_RESET_TIMER;
1430
	}
1431
	iod->aborted = 1;
M
Matias Bjørling 已提交
1432

K
Keith Busch 已提交
1433
	cmd.abort.opcode = nvme_admin_abort_cmd;
K
Keith Busch 已提交
1434
	cmd.abort.cid = nvme_cid(req);
K
Keith Busch 已提交
1435 1436
	cmd.abort.sqid = cpu_to_le16(nvmeq->qid);

1437 1438 1439
	dev_warn(nvmeq->dev->ctrl.device,
		"I/O %d QID %d timeout, aborting\n",
		 req->tag, nvmeq->qid);
1440

1441 1442
	abort_req = blk_mq_alloc_request(dev->ctrl.admin_q, nvme_req_op(&cmd),
					 BLK_MQ_REQ_NOWAIT);
1443 1444 1445 1446
	if (IS_ERR(abort_req)) {
		atomic_inc(&dev->ctrl.abort_limit);
		return BLK_EH_RESET_TIMER;
	}
1447
	nvme_init_request(abort_req, &cmd);
1448

1449
	abort_req->end_io = abort_endio;
1450
	abort_req->end_io_data = NULL;
1451
	abort_req->rq_flags |= RQF_QUIET;
1452
	blk_execute_rq_nowait(abort_req, false);
K
Keith Busch 已提交
1453

1454 1455 1456 1457 1458 1459
	/*
	 * The aborted req will be completed on receiving the abort req.
	 * We enable the timer again. If hit twice, it'll cause a device reset,
	 * as the device then is in a faulty state.
	 */
	return BLK_EH_RESET_TIMER;
K
Keith Busch 已提交
1460 1461
}

M
Matias Bjørling 已提交
1462 1463
static void nvme_free_queue(struct nvme_queue *nvmeq)
{
1464
	dma_free_coherent(nvmeq->dev->dev, CQ_SIZE(nvmeq),
1465
				(void *)nvmeq->cqes, nvmeq->cq_dma_addr);
1466 1467
	if (!nvmeq->sq_cmds)
		return;
1468

1469
	if (test_and_clear_bit(NVMEQ_SQ_CMB, &nvmeq->flags)) {
1470
		pci_free_p2pmem(to_pci_dev(nvmeq->dev->dev),
1471
				nvmeq->sq_cmds, SQ_SIZE(nvmeq));
1472
	} else {
1473
		dma_free_coherent(nvmeq->dev->dev, SQ_SIZE(nvmeq),
1474
				nvmeq->sq_cmds, nvmeq->sq_dma_addr);
1475
	}
1476 1477
}

1478
static void nvme_free_queues(struct nvme_dev *dev, int lowest)
1479 1480 1481
{
	int i;

1482 1483
	for (i = dev->ctrl.queue_count - 1; i >= lowest; i--) {
		dev->ctrl.queue_count--;
1484
		nvme_free_queue(&dev->queues[i]);
1485
	}
1486 1487
}

K
Keith Busch 已提交
1488 1489
/**
 * nvme_suspend_queue - put queue into suspended state
1490
 * @nvmeq: queue to suspend
K
Keith Busch 已提交
1491 1492
 */
static int nvme_suspend_queue(struct nvme_queue *nvmeq)
M
Matthew Wilcox 已提交
1493
{
1494
	if (!test_and_clear_bit(NVMEQ_ENABLED, &nvmeq->flags))
K
Keith Busch 已提交
1495
		return 1;
1496

1497
	/* ensure that nvme_queue_rq() sees NVMEQ_ENABLED cleared */
1498
	mb();
1499

1500
	nvmeq->dev->online_queues--;
1501
	if (!nvmeq->qid && nvmeq->dev->ctrl.admin_q)
1502
		nvme_stop_admin_queue(&nvmeq->dev->ctrl);
1503 1504
	if (!test_and_clear_bit(NVMEQ_POLLED, &nvmeq->flags))
		pci_free_irq(to_pci_dev(nvmeq->dev->dev), nvmeq->cq_vector, nvmeq);
K
Keith Busch 已提交
1505 1506
	return 0;
}
M
Matthew Wilcox 已提交
1507

1508 1509 1510 1511 1512 1513 1514 1515
static void nvme_suspend_io_queues(struct nvme_dev *dev)
{
	int i;

	for (i = dev->ctrl.queue_count - 1; i > 0; i--)
		nvme_suspend_queue(&dev->queues[i]);
}

1516
static void nvme_disable_admin_queue(struct nvme_dev *dev, bool shutdown)
K
Keith Busch 已提交
1517
{
1518
	struct nvme_queue *nvmeq = &dev->queues[0];
K
Keith Busch 已提交
1519

1520 1521 1522
	if (shutdown)
		nvme_shutdown_ctrl(&dev->ctrl);
	else
1523
		nvme_disable_ctrl(&dev->ctrl);
1524

1525
	nvme_poll_irqdisable(nvmeq);
M
Matthew Wilcox 已提交
1526 1527
}

1528 1529
/*
 * Called only on a device that has been disabled and after all other threads
1530 1531 1532
 * that can check this device's completion queues have synced, except
 * nvme_poll(). This is the last chance for the driver to see a natural
 * completion before nvme_cancel_request() terminates all incomplete requests.
1533 1534 1535 1536 1537
 */
static void nvme_reap_pending_cqes(struct nvme_dev *dev)
{
	int i;

1538 1539
	for (i = dev->ctrl.queue_count - 1; i > 0; i--) {
		spin_lock(&dev->queues[i].cq_poll_lock);
1540
		nvme_poll_cq(&dev->queues[i], NULL);
1541 1542
		spin_unlock(&dev->queues[i].cq_poll_lock);
	}
1543 1544
}

1545 1546 1547 1548
static int nvme_cmb_qdepth(struct nvme_dev *dev, int nr_io_queues,
				int entry_size)
{
	int q_depth = dev->q_depth;
1549
	unsigned q_size_aligned = roundup(q_depth * entry_size,
1550
					  NVME_CTRL_PAGE_SIZE);
1551 1552

	if (q_size_aligned * nr_io_queues > dev->cmb_size) {
1553
		u64 mem_per_q = div_u64(dev->cmb_size, nr_io_queues);
1554

1555
		mem_per_q = round_down(mem_per_q, NVME_CTRL_PAGE_SIZE);
1556
		q_depth = div_u64(mem_per_q, entry_size);
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570

		/*
		 * Ensure the reduced q_depth is above some threshold where it
		 * would be better to map queues in system memory with the
		 * original depth
		 */
		if (q_depth < 64)
			return -ENOMEM;
	}

	return q_depth;
}

static int nvme_alloc_sq_cmds(struct nvme_dev *dev, struct nvme_queue *nvmeq,
1571
				int qid)
1572
{
1573 1574 1575
	struct pci_dev *pdev = to_pci_dev(dev->dev);

	if (qid && dev->cmb_use_sqes && (dev->cmbsz & NVME_CMBSZ_SQS)) {
1576
		nvmeq->sq_cmds = pci_alloc_p2pmem(pdev, SQ_SIZE(nvmeq));
1577 1578 1579 1580 1581 1582 1583 1584
		if (nvmeq->sq_cmds) {
			nvmeq->sq_dma_addr = pci_p2pmem_virt_to_bus(pdev,
							nvmeq->sq_cmds);
			if (nvmeq->sq_dma_addr) {
				set_bit(NVMEQ_SQ_CMB, &nvmeq->flags);
				return 0;
			}

1585
			pci_free_p2pmem(pdev, nvmeq->sq_cmds, SQ_SIZE(nvmeq));
1586
		}
1587
	}
1588

1589
	nvmeq->sq_cmds = dma_alloc_coherent(dev->dev, SQ_SIZE(nvmeq),
1590
				&nvmeq->sq_dma_addr, GFP_KERNEL);
1591 1592
	if (!nvmeq->sq_cmds)
		return -ENOMEM;
1593 1594 1595
	return 0;
}

1596
static int nvme_alloc_queue(struct nvme_dev *dev, int qid, int depth)
M
Matthew Wilcox 已提交
1597
{
1598
	struct nvme_queue *nvmeq = &dev->queues[qid];
M
Matthew Wilcox 已提交
1599

1600 1601
	if (dev->ctrl.queue_count > qid)
		return 0;
M
Matthew Wilcox 已提交
1602

1603
	nvmeq->sqes = qid ? dev->io_sqes : NVME_ADM_SQES;
1604 1605
	nvmeq->q_depth = depth;
	nvmeq->cqes = dma_alloc_coherent(dev->dev, CQ_SIZE(nvmeq),
1606
					 &nvmeq->cq_dma_addr, GFP_KERNEL);
M
Matthew Wilcox 已提交
1607 1608 1609
	if (!nvmeq->cqes)
		goto free_nvmeq;

1610
	if (nvme_alloc_sq_cmds(dev, nvmeq, qid))
M
Matthew Wilcox 已提交
1611 1612
		goto free_cqdma;

M
Matthew Wilcox 已提交
1613
	nvmeq->dev = dev;
1614
	spin_lock_init(&nvmeq->sq_lock);
1615
	spin_lock_init(&nvmeq->cq_poll_lock);
M
Matthew Wilcox 已提交
1616
	nvmeq->cq_head = 0;
M
Matthew Wilcox 已提交
1617
	nvmeq->cq_phase = 1;
1618
	nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
K
Keith Busch 已提交
1619
	nvmeq->qid = qid;
1620
	dev->ctrl.queue_count++;
1621

1622
	return 0;
M
Matthew Wilcox 已提交
1623 1624

 free_cqdma:
1625 1626
	dma_free_coherent(dev->dev, CQ_SIZE(nvmeq), (void *)nvmeq->cqes,
			  nvmeq->cq_dma_addr);
M
Matthew Wilcox 已提交
1627
 free_nvmeq:
1628
	return -ENOMEM;
M
Matthew Wilcox 已提交
1629 1630
}

1631
static int queue_request_irq(struct nvme_queue *nvmeq)
1632
{
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
	struct pci_dev *pdev = to_pci_dev(nvmeq->dev->dev);
	int nr = nvmeq->dev->ctrl.instance;

	if (use_threaded_interrupts) {
		return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq_check,
				nvme_irq, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
	} else {
		return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq,
				NULL, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
	}
1643 1644
}

1645
static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid)
M
Matthew Wilcox 已提交
1646
{
1647
	struct nvme_dev *dev = nvmeq->dev;
M
Matthew Wilcox 已提交
1648

1649
	nvmeq->sq_tail = 0;
1650
	nvmeq->last_sq_tail = 0;
1651 1652
	nvmeq->cq_head = 0;
	nvmeq->cq_phase = 1;
1653
	nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
1654
	memset((void *)nvmeq->cqes, 0, CQ_SIZE(nvmeq));
1655
	nvme_dbbuf_init(dev, nvmeq, qid);
K
Keith Busch 已提交
1656
	dev->online_queues++;
1657
	wmb(); /* ensure the first interrupt sees the initialization */
1658 1659
}

1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
/*
 * Try getting shutdown_lock while setting up IO queues.
 */
static int nvme_setup_io_queues_trylock(struct nvme_dev *dev)
{
	/*
	 * Give up if the lock is being held by nvme_dev_disable.
	 */
	if (!mutex_trylock(&dev->shutdown_lock))
		return -ENODEV;

	/*
	 * Controller is in wrong state, fail early.
	 */
	if (dev->ctrl.state != NVME_CTRL_CONNECTING) {
		mutex_unlock(&dev->shutdown_lock);
		return -ENODEV;
	}

	return 0;
}

J
Jens Axboe 已提交
1682
static int nvme_create_queue(struct nvme_queue *nvmeq, int qid, bool polled)
1683 1684 1685
{
	struct nvme_dev *dev = nvmeq->dev;
	int result;
1686
	u16 vector = 0;
1687

1688 1689
	clear_bit(NVMEQ_DELETE_ERROR, &nvmeq->flags);

1690 1691 1692 1693
	/*
	 * A queue's vector matches the queue identifier unless the controller
	 * has only one vector available.
	 */
J
Jens Axboe 已提交
1694 1695 1696
	if (!polled)
		vector = dev->num_vecs == 1 ? 0 : qid;
	else
1697
		set_bit(NVMEQ_POLLED, &nvmeq->flags);
J
Jens Axboe 已提交
1698

1699
	result = adapter_alloc_cq(dev, qid, nvmeq, vector);
K
Keith Busch 已提交
1700 1701
	if (result)
		return result;
M
Matthew Wilcox 已提交
1702 1703 1704

	result = adapter_alloc_sq(dev, qid, nvmeq);
	if (result < 0)
K
Keith Busch 已提交
1705
		return result;
1706
	if (result)
M
Matthew Wilcox 已提交
1707 1708
		goto release_cq;

1709
	nvmeq->cq_vector = vector;
J
Jens Axboe 已提交
1710

1711 1712 1713 1714
	result = nvme_setup_io_queues_trylock(dev);
	if (result)
		return result;
	nvme_init_queue(nvmeq, qid);
1715
	if (!polled) {
J
Jens Axboe 已提交
1716 1717 1718 1719
		result = queue_request_irq(nvmeq);
		if (result < 0)
			goto release_sq;
	}
M
Matthew Wilcox 已提交
1720

1721
	set_bit(NVMEQ_ENABLED, &nvmeq->flags);
1722
	mutex_unlock(&dev->shutdown_lock);
1723
	return result;
M
Matthew Wilcox 已提交
1724

1725
release_sq:
1726
	dev->online_queues--;
1727
	mutex_unlock(&dev->shutdown_lock);
M
Matthew Wilcox 已提交
1728
	adapter_delete_sq(dev, qid);
1729
release_cq:
M
Matthew Wilcox 已提交
1730
	adapter_delete_cq(dev, qid);
1731
	return result;
M
Matthew Wilcox 已提交
1732 1733
}

1734
static const struct blk_mq_ops nvme_mq_admin_ops = {
1735
	.queue_rq	= nvme_queue_rq,
1736
	.complete	= nvme_pci_complete_rq,
M
Matias Bjørling 已提交
1737
	.init_hctx	= nvme_admin_init_hctx,
1738
	.init_request	= nvme_pci_init_request,
M
Matias Bjørling 已提交
1739 1740 1741
	.timeout	= nvme_timeout,
};

1742
static const struct blk_mq_ops nvme_mq_ops = {
1743
	.queue_rq	= nvme_queue_rq,
1744
	.queue_rqs	= nvme_queue_rqs,
1745 1746 1747
	.complete	= nvme_pci_complete_rq,
	.commit_rqs	= nvme_commit_rqs,
	.init_hctx	= nvme_init_hctx,
1748
	.init_request	= nvme_pci_init_request,
1749 1750 1751
	.map_queues	= nvme_pci_map_queues,
	.timeout	= nvme_timeout,
	.poll		= nvme_poll,
1752 1753
};

1754 1755
static void nvme_dev_remove_admin(struct nvme_dev *dev)
{
1756
	if (dev->ctrl.admin_q && !blk_queue_dying(dev->ctrl.admin_q)) {
1757 1758 1759 1760 1761
		/*
		 * If the controller was reset during removal, it's possible
		 * user requests may be waiting on a stopped queue. Start the
		 * queue to flush these to completion.
		 */
1762
		nvme_start_admin_queue(&dev->ctrl);
1763
		blk_cleanup_queue(dev->ctrl.admin_q);
1764 1765 1766 1767
		blk_mq_free_tag_set(&dev->admin_tagset);
	}
}

M
Matias Bjørling 已提交
1768 1769
static int nvme_alloc_admin_tags(struct nvme_dev *dev)
{
1770
	if (!dev->ctrl.admin_q) {
M
Matias Bjørling 已提交
1771 1772
		dev->admin_tagset.ops = &nvme_mq_admin_ops;
		dev->admin_tagset.nr_hw_queues = 1;
K
Keith Busch 已提交
1773

K
Keith Busch 已提交
1774
		dev->admin_tagset.queue_depth = NVME_AQ_MQ_TAG_DEPTH;
1775
		dev->admin_tagset.timeout = NVME_ADMIN_TIMEOUT;
1776
		dev->admin_tagset.numa_node = dev->ctrl.numa_node;
1777
		dev->admin_tagset.cmd_size = sizeof(struct nvme_iod);
1778
		dev->admin_tagset.flags = BLK_MQ_F_NO_SCHED;
M
Matias Bjørling 已提交
1779 1780 1781 1782
		dev->admin_tagset.driver_data = dev;

		if (blk_mq_alloc_tag_set(&dev->admin_tagset))
			return -ENOMEM;
1783
		dev->ctrl.admin_tagset = &dev->admin_tagset;
M
Matias Bjørling 已提交
1784

1785 1786
		dev->ctrl.admin_q = blk_mq_init_queue(&dev->admin_tagset);
		if (IS_ERR(dev->ctrl.admin_q)) {
M
Matias Bjørling 已提交
1787
			blk_mq_free_tag_set(&dev->admin_tagset);
1788
			dev->ctrl.admin_q = NULL;
M
Matias Bjørling 已提交
1789 1790
			return -ENOMEM;
		}
1791
		if (!blk_get_queue(dev->ctrl.admin_q)) {
1792
			nvme_dev_remove_admin(dev);
1793
			dev->ctrl.admin_q = NULL;
1794 1795
			return -ENODEV;
		}
K
Keith Busch 已提交
1796
	} else
1797
		nvme_start_admin_queue(&dev->ctrl);
M
Matias Bjørling 已提交
1798 1799 1800 1801

	return 0;
}

1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
static unsigned long db_bar_size(struct nvme_dev *dev, unsigned nr_io_queues)
{
	return NVME_REG_DBS + ((nr_io_queues + 1) * 8 * dev->db_stride);
}

static int nvme_remap_bar(struct nvme_dev *dev, unsigned long size)
{
	struct pci_dev *pdev = to_pci_dev(dev->dev);

	if (size <= dev->bar_mapped_size)
		return 0;
	if (size > pci_resource_len(pdev, 0))
		return -ENOMEM;
	if (dev->bar)
		iounmap(dev->bar);
	dev->bar = ioremap(pci_resource_start(pdev, 0), size);
	if (!dev->bar) {
		dev->bar_mapped_size = 0;
		return -ENOMEM;
	}
	dev->bar_mapped_size = size;
	dev->dbs = dev->bar + NVME_REG_DBS;

	return 0;
}

1828
static int nvme_pci_configure_admin_queue(struct nvme_dev *dev)
M
Matthew Wilcox 已提交
1829
{
1830
	int result;
M
Matthew Wilcox 已提交
1831 1832 1833
	u32 aqa;
	struct nvme_queue *nvmeq;

1834 1835 1836 1837
	result = nvme_remap_bar(dev, db_bar_size(dev, 0));
	if (result < 0)
		return result;

1838
	dev->subsystem = readl(dev->bar + NVME_REG_VS) >= NVME_VS(1, 1, 0) ?
1839
				NVME_CAP_NSSRC(dev->ctrl.cap) : 0;
1840

1841 1842 1843
	if (dev->subsystem &&
	    (readl(dev->bar + NVME_REG_CSTS) & NVME_CSTS_NSSRO))
		writel(NVME_CSTS_NSSRO, dev->bar + NVME_REG_CSTS);
1844

1845
	result = nvme_disable_ctrl(&dev->ctrl);
1846 1847
	if (result < 0)
		return result;
M
Matthew Wilcox 已提交
1848

1849
	result = nvme_alloc_queue(dev, 0, NVME_AQ_DEPTH);
1850 1851
	if (result)
		return result;
M
Matthew Wilcox 已提交
1852

1853 1854
	dev->ctrl.numa_node = dev_to_node(dev->dev);

1855
	nvmeq = &dev->queues[0];
M
Matthew Wilcox 已提交
1856 1857 1858
	aqa = nvmeq->q_depth - 1;
	aqa |= aqa << 16;

1859 1860 1861
	writel(aqa, dev->bar + NVME_REG_AQA);
	lo_hi_writeq(nvmeq->sq_dma_addr, dev->bar + NVME_REG_ASQ);
	lo_hi_writeq(nvmeq->cq_dma_addr, dev->bar + NVME_REG_ACQ);
M
Matthew Wilcox 已提交
1862

1863
	result = nvme_enable_ctrl(&dev->ctrl);
1864
	if (result)
K
Keith Busch 已提交
1865
		return result;
M
Matias Bjørling 已提交
1866

K
Keith Busch 已提交
1867
	nvmeq->cq_vector = 0;
1868
	nvme_init_queue(nvmeq, 0);
1869
	result = queue_request_irq(nvmeq);
1870
	if (result) {
1871
		dev->online_queues--;
K
Keith Busch 已提交
1872
		return result;
1873
	}
1874

1875
	set_bit(NVMEQ_ENABLED, &nvmeq->flags);
M
Matthew Wilcox 已提交
1876 1877 1878
	return result;
}

1879
static int nvme_create_io_queues(struct nvme_dev *dev)
K
Keith Busch 已提交
1880
{
J
Jens Axboe 已提交
1881
	unsigned i, max, rw_queues;
1882
	int ret = 0;
K
Keith Busch 已提交
1883

1884
	for (i = dev->ctrl.queue_count; i <= dev->max_qid; i++) {
1885
		if (nvme_alloc_queue(dev, i, dev->q_depth)) {
1886
			ret = -ENOMEM;
K
Keith Busch 已提交
1887
			break;
1888 1889
		}
	}
K
Keith Busch 已提交
1890

1891
	max = min(dev->max_qid, dev->ctrl.queue_count - 1);
1892 1893 1894
	if (max != 1 && dev->io_queues[HCTX_TYPE_POLL]) {
		rw_queues = dev->io_queues[HCTX_TYPE_DEFAULT] +
				dev->io_queues[HCTX_TYPE_READ];
J
Jens Axboe 已提交
1895 1896 1897 1898
	} else {
		rw_queues = max;
	}

1899
	for (i = dev->online_queues; i <= max; i++) {
J
Jens Axboe 已提交
1900 1901 1902
		bool polled = i > rw_queues;

		ret = nvme_create_queue(&dev->queues[i], i, polled);
K
Keith Busch 已提交
1903
		if (ret)
K
Keith Busch 已提交
1904
			break;
M
Matthew Wilcox 已提交
1905
	}
1906 1907 1908

	/*
	 * Ignore failing Create SQ/CQ commands, we can continue with less
1909 1910
	 * than the desired amount of queues, and even a controller without
	 * I/O queues can still be used to issue admin commands.  This might
1911 1912 1913
	 * be useful to upgrade a buggy firmware for example.
	 */
	return ret >= 0 ? 0 : ret;
M
Matthew Wilcox 已提交
1914 1915
}

1916
static u64 nvme_cmb_size_unit(struct nvme_dev *dev)
1917
{
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
	u8 szu = (dev->cmbsz >> NVME_CMBSZ_SZU_SHIFT) & NVME_CMBSZ_SZU_MASK;

	return 1ULL << (12 + 4 * szu);
}

static u32 nvme_cmb_size(struct nvme_dev *dev)
{
	return (dev->cmbsz >> NVME_CMBSZ_SZ_SHIFT) & NVME_CMBSZ_SZ_MASK;
}

1928
static void nvme_map_cmb(struct nvme_dev *dev)
1929
{
1930
	u64 size, offset;
1931 1932
	resource_size_t bar_size;
	struct pci_dev *pdev = to_pci_dev(dev->dev);
1933
	int bar;
1934

1935 1936 1937
	if (dev->cmb_size)
		return;

1938 1939 1940
	if (NVME_CAP_CMBS(dev->ctrl.cap))
		writel(NVME_CMBMSC_CRE, dev->bar + NVME_REG_CMBMSC);

1941
	dev->cmbsz = readl(dev->bar + NVME_REG_CMBSZ);
1942 1943
	if (!dev->cmbsz)
		return;
1944
	dev->cmbloc = readl(dev->bar + NVME_REG_CMBLOC);
1945

1946 1947
	size = nvme_cmb_size_unit(dev) * nvme_cmb_size(dev);
	offset = nvme_cmb_size_unit(dev) * NVME_CMB_OFST(dev->cmbloc);
1948 1949
	bar = NVME_CMB_BIR(dev->cmbloc);
	bar_size = pci_resource_len(pdev, bar);
1950 1951

	if (offset > bar_size)
1952
		return;
1953

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
	/*
	 * Tell the controller about the host side address mapping the CMB,
	 * and enable CMB decoding for the NVMe 1.4+ scheme:
	 */
	if (NVME_CAP_CMBS(dev->ctrl.cap)) {
		hi_lo_writeq(NVME_CMBMSC_CRE | NVME_CMBMSC_CMSE |
			     (pci_bus_address(pdev, bar) + offset),
			     dev->bar + NVME_REG_CMBMSC);
	}

1964 1965 1966 1967 1968 1969 1970 1971
	/*
	 * Controllers may support a CMB size larger than their BAR,
	 * for example, due to being behind a bridge. Reduce the CMB to
	 * the reported size of the BAR
	 */
	if (size > bar_size - offset)
		size = bar_size - offset;

1972 1973 1974
	if (pci_p2pdma_add_resource(pdev, bar, size, offset)) {
		dev_warn(dev->ctrl.device,
			 "failed to register the CMB\n");
1975
		return;
1976 1977
	}

1978
	dev->cmb_size = size;
1979 1980 1981 1982 1983
	dev->cmb_use_sqes = use_cmb_sqes && (dev->cmbsz & NVME_CMBSZ_SQS);

	if ((dev->cmbsz & (NVME_CMBSZ_WDS | NVME_CMBSZ_RDS)) ==
			(NVME_CMBSZ_WDS | NVME_CMBSZ_RDS))
		pci_p2pmem_publish(pdev, true);
1984 1985
}

1986 1987
static int nvme_set_host_mem(struct nvme_dev *dev, u32 bits)
{
1988
	u32 host_mem_size = dev->host_mem_size >> NVME_CTRL_PAGE_SHIFT;
1989
	u64 dma_addr = dev->host_mem_descs_dma;
1990
	struct nvme_command c = { };
1991 1992 1993 1994 1995
	int ret;

	c.features.opcode	= nvme_admin_set_features;
	c.features.fid		= cpu_to_le32(NVME_FEAT_HOST_MEM_BUF);
	c.features.dword11	= cpu_to_le32(bits);
1996
	c.features.dword12	= cpu_to_le32(host_mem_size);
1997 1998 1999 2000 2001 2002 2003 2004 2005
	c.features.dword13	= cpu_to_le32(lower_32_bits(dma_addr));
	c.features.dword14	= cpu_to_le32(upper_32_bits(dma_addr));
	c.features.dword15	= cpu_to_le32(dev->nr_host_mem_descs);

	ret = nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
	if (ret) {
		dev_warn(dev->ctrl.device,
			 "failed to set host mem (err %d, flags %#x).\n",
			 ret, bits);
2006 2007 2008
	} else
		dev->hmb = bits & NVME_HOST_MEM_ENABLE;

2009 2010 2011 2012 2013 2014 2015 2016 2017
	return ret;
}

static void nvme_free_host_mem(struct nvme_dev *dev)
{
	int i;

	for (i = 0; i < dev->nr_host_mem_descs; i++) {
		struct nvme_host_mem_buf_desc *desc = &dev->host_mem_descs[i];
2018
		size_t size = le32_to_cpu(desc->size) * NVME_CTRL_PAGE_SIZE;
2019

2020 2021 2022
		dma_free_attrs(dev->dev, size, dev->host_mem_desc_bufs[i],
			       le64_to_cpu(desc->addr),
			       DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
2023 2024 2025 2026
	}

	kfree(dev->host_mem_desc_bufs);
	dev->host_mem_desc_bufs = NULL;
2027 2028 2029
	dma_free_coherent(dev->dev,
			dev->nr_host_mem_descs * sizeof(*dev->host_mem_descs),
			dev->host_mem_descs, dev->host_mem_descs_dma);
2030
	dev->host_mem_descs = NULL;
2031
	dev->nr_host_mem_descs = 0;
2032 2033
}

2034 2035
static int __nvme_alloc_host_mem(struct nvme_dev *dev, u64 preferred,
		u32 chunk_size)
K
Keith Busch 已提交
2036
{
2037
	struct nvme_host_mem_buf_desc *descs;
2038
	u32 max_entries, len;
2039
	dma_addr_t descs_dma;
2040
	int i = 0;
2041
	void **bufs;
2042
	u64 size, tmp;
2043 2044 2045 2046

	tmp = (preferred + chunk_size - 1);
	do_div(tmp, chunk_size);
	max_entries = tmp;
2047 2048 2049 2050

	if (dev->ctrl.hmmaxd && dev->ctrl.hmmaxd < max_entries)
		max_entries = dev->ctrl.hmmaxd;

2051 2052
	descs = dma_alloc_coherent(dev->dev, max_entries * sizeof(*descs),
				   &descs_dma, GFP_KERNEL);
2053 2054 2055 2056 2057 2058 2059
	if (!descs)
		goto out;

	bufs = kcalloc(max_entries, sizeof(*bufs), GFP_KERNEL);
	if (!bufs)
		goto out_free_descs;

2060
	for (size = 0; size < preferred && i < max_entries; size += len) {
2061 2062
		dma_addr_t dma_addr;

2063
		len = min_t(u64, chunk_size, preferred - size);
2064 2065 2066 2067 2068 2069
		bufs[i] = dma_alloc_attrs(dev->dev, len, &dma_addr, GFP_KERNEL,
				DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
		if (!bufs[i])
			break;

		descs[i].addr = cpu_to_le64(dma_addr);
2070
		descs[i].size = cpu_to_le32(len / NVME_CTRL_PAGE_SIZE);
2071 2072 2073
		i++;
	}

2074
	if (!size)
2075 2076 2077 2078 2079
		goto out_free_bufs;

	dev->nr_host_mem_descs = i;
	dev->host_mem_size = size;
	dev->host_mem_descs = descs;
2080
	dev->host_mem_descs_dma = descs_dma;
2081 2082 2083 2084 2085
	dev->host_mem_desc_bufs = bufs;
	return 0;

out_free_bufs:
	while (--i >= 0) {
2086
		size_t size = le32_to_cpu(descs[i].size) * NVME_CTRL_PAGE_SIZE;
2087

2088 2089 2090
		dma_free_attrs(dev->dev, size, bufs[i],
			       le64_to_cpu(descs[i].addr),
			       DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
2091 2092 2093 2094
	}

	kfree(bufs);
out_free_descs:
2095 2096
	dma_free_coherent(dev->dev, max_entries * sizeof(*descs), descs,
			descs_dma);
2097 2098 2099 2100 2101
out:
	dev->host_mem_descs = NULL;
	return -ENOMEM;
}

2102 2103
static int nvme_alloc_host_mem(struct nvme_dev *dev, u64 min, u64 preferred)
{
2104 2105 2106
	u64 min_chunk = min_t(u64, preferred, PAGE_SIZE * MAX_ORDER_NR_PAGES);
	u64 hmminds = max_t(u32, dev->ctrl.hmminds * 4096, PAGE_SIZE * 2);
	u64 chunk_size;
2107 2108

	/* start big and work our way down */
2109
	for (chunk_size = min_chunk; chunk_size >= hmminds; chunk_size /= 2) {
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
		if (!__nvme_alloc_host_mem(dev, preferred, chunk_size)) {
			if (!min || dev->host_mem_size >= min)
				return 0;
			nvme_free_host_mem(dev);
		}
	}

	return -ENOMEM;
}

2120
static int nvme_setup_host_mem(struct nvme_dev *dev)
2121 2122 2123 2124 2125
{
	u64 max = (u64)max_host_mem_size_mb * SZ_1M;
	u64 preferred = (u64)dev->ctrl.hmpre * 4096;
	u64 min = (u64)dev->ctrl.hmmin * 4096;
	u32 enable_bits = NVME_HOST_MEM_ENABLE;
2126
	int ret;
2127 2128 2129 2130 2131 2132 2133

	preferred = min(preferred, max);
	if (min > max) {
		dev_warn(dev->ctrl.device,
			"min host memory (%lld MiB) above limit (%d MiB).\n",
			min >> ilog2(SZ_1M), max_host_mem_size_mb);
		nvme_free_host_mem(dev);
2134
		return 0;
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
	}

	/*
	 * If we already have a buffer allocated check if we can reuse it.
	 */
	if (dev->host_mem_descs) {
		if (dev->host_mem_size >= min)
			enable_bits |= NVME_HOST_MEM_RETURN;
		else
			nvme_free_host_mem(dev);
	}

	if (!dev->host_mem_descs) {
2148 2149 2150
		if (nvme_alloc_host_mem(dev, min, preferred)) {
			dev_warn(dev->ctrl.device,
				"failed to allocate host memory buffer.\n");
2151
			return 0; /* controller must work without HMB */
2152 2153 2154 2155 2156
		}

		dev_info(dev->ctrl.device,
			"allocated %lld MiB host memory buffer.\n",
			dev->host_mem_size >> ilog2(SZ_1M));
2157 2158
	}

2159 2160
	ret = nvme_set_host_mem(dev, enable_bits);
	if (ret)
2161
		nvme_free_host_mem(dev);
2162
	return ret;
K
Keith Busch 已提交
2163 2164
}

2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
static ssize_t cmb_show(struct device *dev, struct device_attribute *attr,
		char *buf)
{
	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));

	return sysfs_emit(buf, "cmbloc : x%08x\ncmbsz  : x%08x\n",
		       ndev->cmbloc, ndev->cmbsz);
}
static DEVICE_ATTR_RO(cmb);

2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192
static ssize_t cmbloc_show(struct device *dev, struct device_attribute *attr,
		char *buf)
{
	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));

	return sysfs_emit(buf, "%u\n", ndev->cmbloc);
}
static DEVICE_ATTR_RO(cmbloc);

static ssize_t cmbsz_show(struct device *dev, struct device_attribute *attr,
		char *buf)
{
	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));

	return sysfs_emit(buf, "%u\n", ndev->cmbsz);
}
static DEVICE_ATTR_RO(cmbsz);

2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
static ssize_t hmb_show(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));

	return sysfs_emit(buf, "%d\n", ndev->hmb);
}

static ssize_t hmb_store(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count)
{
	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
	bool new;
	int ret;

	if (strtobool(buf, &new) < 0)
		return -EINVAL;

	if (new == ndev->hmb)
		return count;

	if (new) {
		ret = nvme_setup_host_mem(ndev);
	} else {
		ret = nvme_set_host_mem(ndev, 0);
		if (!ret)
			nvme_free_host_mem(ndev);
	}

	if (ret < 0)
		return ret;

	return count;
}
static DEVICE_ATTR_RW(hmb);

2229 2230 2231 2232 2233 2234 2235
static umode_t nvme_pci_attrs_are_visible(struct kobject *kobj,
		struct attribute *a, int n)
{
	struct nvme_ctrl *ctrl =
		dev_get_drvdata(container_of(kobj, struct device, kobj));
	struct nvme_dev *dev = to_nvme_dev(ctrl);

2236 2237 2238 2239 2240 2241
	if (a == &dev_attr_cmb.attr ||
	    a == &dev_attr_cmbloc.attr ||
	    a == &dev_attr_cmbsz.attr) {
	    	if (!dev->cmbsz)
			return 0;
	}
2242 2243 2244
	if (a == &dev_attr_hmb.attr && !ctrl->hmpre)
		return 0;

2245 2246 2247 2248 2249
	return a->mode;
}

static struct attribute *nvme_pci_attrs[] = {
	&dev_attr_cmb.attr,
2250 2251
	&dev_attr_cmbloc.attr,
	&dev_attr_cmbsz.attr,
2252
	&dev_attr_hmb.attr,
2253 2254 2255 2256 2257 2258 2259 2260
	NULL,
};

static const struct attribute_group nvme_pci_attr_group = {
	.attrs		= nvme_pci_attrs,
	.is_visible	= nvme_pci_attrs_are_visible,
};

2261 2262 2263 2264 2265
/*
 * nirqs is the number of interrupts available for write and read
 * queues. The core already reserved an interrupt for the admin queue.
 */
static void nvme_calc_irq_sets(struct irq_affinity *affd, unsigned int nrirqs)
2266
{
2267
	struct nvme_dev *dev = affd->priv;
2268
	unsigned int nr_read_queues, nr_write_queues = dev->nr_write_queues;
2269 2270

	/*
B
Baolin Wang 已提交
2271
	 * If there is no interrupt available for queues, ensure that
2272 2273 2274 2275 2276 2277 2278 2279
	 * the default queue is set to 1. The affinity set size is
	 * also set to one, but the irq core ignores it for this case.
	 *
	 * If only one interrupt is available or 'write_queue' == 0, combine
	 * write and read queues.
	 *
	 * If 'write_queues' > 0, ensure it leaves room for at least one read
	 * queue.
2280
	 */
2281 2282 2283
	if (!nrirqs) {
		nrirqs = 1;
		nr_read_queues = 0;
2284
	} else if (nrirqs == 1 || !nr_write_queues) {
2285
		nr_read_queues = 0;
2286
	} else if (nr_write_queues >= nrirqs) {
2287
		nr_read_queues = 1;
2288
	} else {
2289
		nr_read_queues = nrirqs - nr_write_queues;
2290
	}
2291 2292 2293 2294 2295 2296

	dev->io_queues[HCTX_TYPE_DEFAULT] = nrirqs - nr_read_queues;
	affd->set_size[HCTX_TYPE_DEFAULT] = nrirqs - nr_read_queues;
	dev->io_queues[HCTX_TYPE_READ] = nr_read_queues;
	affd->set_size[HCTX_TYPE_READ] = nr_read_queues;
	affd->nr_sets = nr_read_queues ? 2 : 1;
2297 2298
}

2299
static int nvme_setup_irqs(struct nvme_dev *dev, unsigned int nr_io_queues)
2300 2301 2302
{
	struct pci_dev *pdev = to_pci_dev(dev->dev);
	struct irq_affinity affd = {
2303
		.pre_vectors	= 1,
2304 2305
		.calc_sets	= nvme_calc_irq_sets,
		.priv		= dev,
2306
	};
2307
	unsigned int irq_queues, poll_queues;
2308 2309

	/*
2310 2311
	 * Poll queues don't need interrupts, but we need at least one I/O queue
	 * left over for non-polled I/O.
2312
	 */
2313 2314
	poll_queues = min(dev->nr_poll_queues, nr_io_queues - 1);
	dev->io_queues[HCTX_TYPE_POLL] = poll_queues;
2315

2316 2317 2318 2319
	/*
	 * Initialize for the single interrupt case, will be updated in
	 * nvme_calc_irq_sets().
	 */
2320 2321
	dev->io_queues[HCTX_TYPE_DEFAULT] = 1;
	dev->io_queues[HCTX_TYPE_READ] = 0;
2322

2323
	/*
2324 2325 2326
	 * We need interrupts for the admin queue and each non-polled I/O queue,
	 * but some Apple controllers require all queues to use the first
	 * vector.
2327
	 */
2328 2329 2330
	irq_queues = 1;
	if (!(dev->ctrl.quirks & NVME_QUIRK_SINGLE_VECTOR))
		irq_queues += (nr_io_queues - poll_queues);
2331 2332
	return pci_alloc_irq_vectors_affinity(pdev, 1, irq_queues,
			      PCI_IRQ_ALL_TYPES | PCI_IRQ_AFFINITY, &affd);
2333 2334
}

2335 2336 2337 2338 2339 2340
static void nvme_disable_io_queues(struct nvme_dev *dev)
{
	if (__nvme_disable_io_queues(dev, nvme_admin_delete_sq))
		__nvme_disable_io_queues(dev, nvme_admin_delete_cq);
}

2341 2342
static unsigned int nvme_max_io_queues(struct nvme_dev *dev)
{
2343 2344 2345 2346 2347 2348
	/*
	 * If tags are shared with admin queue (Apple bug), then
	 * make sure we only use one IO queue.
	 */
	if (dev->ctrl.quirks & NVME_QUIRK_SHARED_TAGS)
		return 1;
2349 2350 2351
	return num_possible_cpus() + dev->nr_write_queues + dev->nr_poll_queues;
}

2352
static int nvme_setup_io_queues(struct nvme_dev *dev)
M
Matthew Wilcox 已提交
2353
{
2354
	struct nvme_queue *adminq = &dev->queues[0];
2355
	struct pci_dev *pdev = to_pci_dev(dev->dev);
2356
	unsigned int nr_io_queues;
2357
	unsigned long size;
2358
	int result;
M
Matthew Wilcox 已提交
2359

2360 2361 2362 2363 2364 2365
	/*
	 * Sample the module parameters once at reset time so that we have
	 * stable values to work with.
	 */
	dev->nr_write_queues = write_queues;
	dev->nr_poll_queues = poll_queues;
2366

2367
	nr_io_queues = dev->nr_allocated_queues - 1;
C
Christoph Hellwig 已提交
2368 2369
	result = nvme_set_queue_count(&dev->ctrl, &nr_io_queues);
	if (result < 0)
M
Matthew Wilcox 已提交
2370
		return result;
C
Christoph Hellwig 已提交
2371

2372
	if (nr_io_queues == 0)
2373
		return 0;
2374

2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
	/*
	 * Free IRQ resources as soon as NVMEQ_ENABLED bit transitions
	 * from set to unset. If there is a window to it is truely freed,
	 * pci_free_irq_vectors() jumping into this window will crash.
	 * And take lock to avoid racing with pci_free_irq_vectors() in
	 * nvme_dev_disable() path.
	 */
	result = nvme_setup_io_queues_trylock(dev);
	if (result)
		return result;
	if (test_and_clear_bit(NVMEQ_ENABLED, &adminq->flags))
		pci_free_irq(pdev, 0, adminq);
M
Matthew Wilcox 已提交
2387

2388
	if (dev->cmb_use_sqes) {
2389 2390 2391 2392 2393
		result = nvme_cmb_qdepth(dev, nr_io_queues,
				sizeof(struct nvme_command));
		if (result > 0)
			dev->q_depth = result;
		else
2394
			dev->cmb_use_sqes = false;
2395 2396
	}

2397 2398 2399 2400 2401
	do {
		size = db_bar_size(dev, nr_io_queues);
		result = nvme_remap_bar(dev, size);
		if (!result)
			break;
2402 2403 2404 2405
		if (!--nr_io_queues) {
			result = -ENOMEM;
			goto out_unlock;
		}
2406 2407
	} while (1);
	adminq->q_db = dev->dbs;
2408

2409
 retry:
K
Keith Busch 已提交
2410
	/* Deregister the admin queue's interrupt */
2411 2412
	if (test_and_clear_bit(NVMEQ_ENABLED, &adminq->flags))
		pci_free_irq(pdev, 0, adminq);
K
Keith Busch 已提交
2413

2414 2415 2416 2417
	/*
	 * If we enable msix early due to not intx, disable it again before
	 * setting up the full range we need.
	 */
2418
	pci_free_irq_vectors(pdev);
2419 2420

	result = nvme_setup_irqs(dev, nr_io_queues);
2421 2422 2423 2424
	if (result <= 0) {
		result = -EIO;
		goto out_unlock;
	}
2425

2426
	dev->num_vecs = result;
J
Jens Axboe 已提交
2427
	result = max(result - 1, 1);
2428
	dev->max_qid = result + dev->io_queues[HCTX_TYPE_POLL];
R
Ramachandra Rao Gajula 已提交
2429

2430 2431 2432 2433 2434 2435
	/*
	 * Should investigate if there's a performance win from allocating
	 * more queues than interrupt vectors; it might allow the submission
	 * path to scale better, even if the receive path is limited by the
	 * number of interrupts.
	 */
2436
	result = queue_request_irq(adminq);
2437
	if (result)
2438
		goto out_unlock;
2439
	set_bit(NVMEQ_ENABLED, &adminq->flags);
2440
	mutex_unlock(&dev->shutdown_lock);
2441 2442 2443 2444 2445 2446 2447 2448

	result = nvme_create_io_queues(dev);
	if (result || dev->online_queues < 2)
		return result;

	if (dev->online_queues - 1 < dev->max_qid) {
		nr_io_queues = dev->online_queues - 1;
		nvme_disable_io_queues(dev);
2449 2450 2451
		result = nvme_setup_io_queues_trylock(dev);
		if (result)
			return result;
2452 2453 2454 2455 2456 2457 2458 2459
		nvme_suspend_io_queues(dev);
		goto retry;
	}
	dev_info(dev->ctrl.device, "%d/%d/%d default/read/poll queues\n",
					dev->io_queues[HCTX_TYPE_DEFAULT],
					dev->io_queues[HCTX_TYPE_READ],
					dev->io_queues[HCTX_TYPE_POLL]);
	return 0;
2460 2461 2462
out_unlock:
	mutex_unlock(&dev->shutdown_lock);
	return result;
M
Matthew Wilcox 已提交
2463 2464
}

2465
static void nvme_del_queue_end(struct request *req, blk_status_t error)
K
Keith Busch 已提交
2466
{
K
Keith Busch 已提交
2467
	struct nvme_queue *nvmeq = req->end_io_data;
2468

K
Keith Busch 已提交
2469
	blk_mq_free_request(req);
2470
	complete(&nvmeq->delete_done);
K
Keith Busch 已提交
2471 2472
}

2473
static void nvme_del_cq_end(struct request *req, blk_status_t error)
K
Keith Busch 已提交
2474
{
K
Keith Busch 已提交
2475
	struct nvme_queue *nvmeq = req->end_io_data;
K
Keith Busch 已提交
2476

2477 2478
	if (error)
		set_bit(NVMEQ_DELETE_ERROR, &nvmeq->flags);
K
Keith Busch 已提交
2479 2480

	nvme_del_queue_end(req, error);
K
Keith Busch 已提交
2481 2482
}

K
Keith Busch 已提交
2483
static int nvme_delete_queue(struct nvme_queue *nvmeq, u8 opcode)
2484
{
K
Keith Busch 已提交
2485 2486
	struct request_queue *q = nvmeq->dev->ctrl.admin_q;
	struct request *req;
2487
	struct nvme_command cmd = { };
2488

K
Keith Busch 已提交
2489 2490
	cmd.delete_queue.opcode = opcode;
	cmd.delete_queue.qid = cpu_to_le16(nvmeq->qid);
2491

2492
	req = blk_mq_alloc_request(q, nvme_req_op(&cmd), BLK_MQ_REQ_NOWAIT);
K
Keith Busch 已提交
2493 2494
	if (IS_ERR(req))
		return PTR_ERR(req);
2495
	nvme_init_request(req, &cmd);
2496

2497 2498 2499 2500
	if (opcode == nvme_admin_delete_cq)
		req->end_io = nvme_del_cq_end;
	else
		req->end_io = nvme_del_queue_end;
K
Keith Busch 已提交
2501 2502
	req->end_io_data = nvmeq;

2503
	init_completion(&nvmeq->delete_done);
2504
	req->rq_flags |= RQF_QUIET;
2505
	blk_execute_rq_nowait(req, false);
K
Keith Busch 已提交
2506
	return 0;
2507 2508
}

2509
static bool __nvme_disable_io_queues(struct nvme_dev *dev, u8 opcode)
K
Keith Busch 已提交
2510
{
2511
	int nr_queues = dev->online_queues - 1, sent = 0;
K
Keith Busch 已提交
2512
	unsigned long timeout;
K
Keith Busch 已提交
2513

K
Keith Busch 已提交
2514
 retry:
2515
	timeout = NVME_ADMIN_TIMEOUT;
2516 2517 2518 2519 2520
	while (nr_queues > 0) {
		if (nvme_delete_queue(&dev->queues[nr_queues], opcode))
			break;
		nr_queues--;
		sent++;
K
Keith Busch 已提交
2521
	}
2522 2523 2524 2525
	while (sent) {
		struct nvme_queue *nvmeq = &dev->queues[nr_queues + sent];

		timeout = wait_for_completion_io_timeout(&nvmeq->delete_done,
2526 2527 2528
				timeout);
		if (timeout == 0)
			return false;
2529 2530

		sent--;
2531 2532 2533 2534
		if (nr_queues)
			goto retry;
	}
	return true;
K
Keith Busch 已提交
2535 2536
}

K
Keith Busch 已提交
2537
static void nvme_dev_add(struct nvme_dev *dev)
M
Matthew Wilcox 已提交
2538
{
2539 2540
	int ret;

2541
	if (!dev->ctrl.tagset) {
2542
		dev->tagset.ops = &nvme_mq_ops;
2543
		dev->tagset.nr_hw_queues = dev->online_queues - 1;
2544
		dev->tagset.nr_maps = 2; /* default + read */
2545 2546
		if (dev->io_queues[HCTX_TYPE_POLL])
			dev->tagset.nr_maps++;
2547
		dev->tagset.timeout = NVME_IO_TIMEOUT;
2548
		dev->tagset.numa_node = dev->ctrl.numa_node;
2549 2550
		dev->tagset.queue_depth = min_t(unsigned int, dev->q_depth,
						BLK_MQ_MAX_DEPTH) - 1;
2551
		dev->tagset.cmd_size = sizeof(struct nvme_iod);
2552 2553
		dev->tagset.flags = BLK_MQ_F_SHOULD_MERGE;
		dev->tagset.driver_data = dev;
M
Matthew Wilcox 已提交
2554

2555 2556 2557 2558 2559 2560 2561 2562
		/*
		 * Some Apple controllers requires tags to be unique
		 * across admin and IO queue, so reserve the first 32
		 * tags of the IO queue.
		 */
		if (dev->ctrl.quirks & NVME_QUIRK_SHARED_TAGS)
			dev->tagset.reserved_tags = NVME_AQ_DEPTH;

2563 2564 2565 2566
		ret = blk_mq_alloc_tag_set(&dev->tagset);
		if (ret) {
			dev_warn(dev->ctrl.device,
				"IO queues tagset allocation failed %d\n", ret);
K
Keith Busch 已提交
2567
			return;
2568
		}
2569
		dev->ctrl.tagset = &dev->tagset;
2570 2571 2572 2573 2574
	} else {
		blk_mq_update_nr_hw_queues(&dev->tagset, dev->online_queues - 1);

		/* Free previously allocated queues that are no longer usable */
		nvme_free_queues(dev, dev->online_queues);
2575
	}
2576

2577
	nvme_dbbuf_set(dev);
M
Matthew Wilcox 已提交
2578 2579
}

2580
static int nvme_pci_enable(struct nvme_dev *dev)
2581
{
2582
	int result = -ENOMEM;
2583
	struct pci_dev *pdev = to_pci_dev(dev->dev);
2584
	int dma_address_bits = 64;
2585 2586 2587 2588 2589 2590

	if (pci_enable_device_mem(pdev))
		return result;

	pci_set_master(pdev);

2591 2592 2593
	if (dev->ctrl.quirks & NVME_QUIRK_DMA_ADDRESS_BITS_48)
		dma_address_bits = 48;
	if (dma_set_mask_and_coherent(dev->dev, DMA_BIT_MASK(dma_address_bits)))
2594
		goto disable;
2595

2596
	if (readl(dev->bar + NVME_REG_CSTS) == -1) {
K
Keith Busch 已提交
2597
		result = -ENODEV;
2598
		goto disable;
K
Keith Busch 已提交
2599
	}
2600 2601

	/*
2602 2603 2604
	 * Some devices and/or platforms don't advertise or work with INTx
	 * interrupts. Pre-enable a single MSIX or MSI vec for setup. We'll
	 * adjust this later.
2605
	 */
2606 2607 2608
	result = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_ALL_TYPES);
	if (result < 0)
		return result;
2609

2610
	dev->ctrl.cap = lo_hi_readq(dev->bar + NVME_REG_CAP);
2611

2612
	dev->q_depth = min_t(u32, NVME_CAP_MQES(dev->ctrl.cap) + 1,
2613
				io_queue_depth);
2614
	dev->ctrl.sqsize = dev->q_depth - 1; /* 0's based queue depth */
2615
	dev->db_stride = 1 << NVME_CAP_STRIDE(dev->ctrl.cap);
2616
	dev->dbs = dev->bar + 4096;
2617

2618 2619 2620 2621 2622 2623 2624 2625 2626
	/*
	 * Some Apple controllers require a non-standard SQE size.
	 * Interestingly they also seem to ignore the CC:IOSQES register
	 * so we don't bother updating it here.
	 */
	if (dev->ctrl.quirks & NVME_QUIRK_128_BYTES_SQES)
		dev->io_sqes = 7;
	else
		dev->io_sqes = NVME_NVM_IOSQES;
2627 2628 2629 2630 2631 2632 2633

	/*
	 * Temporary fix for the Apple controller found in the MacBook8,1 and
	 * some MacBook7,1 to avoid controller resets and data loss.
	 */
	if (pdev->vendor == PCI_VENDOR_ID_APPLE && pdev->device == 0x2001) {
		dev->q_depth = 2;
2634 2635
		dev_warn(dev->ctrl.device, "detected Apple NVMe controller, "
			"set queue depth=%u to work around controller resets\n",
2636
			dev->q_depth);
2637 2638
	} else if (pdev->vendor == PCI_VENDOR_ID_SAMSUNG &&
		   (pdev->device == 0xa821 || pdev->device == 0xa822) &&
2639
		   NVME_CAP_MQES(dev->ctrl.cap) == 0) {
2640 2641 2642
		dev->q_depth = 64;
		dev_err(dev->ctrl.device, "detected PM1725 NVMe controller, "
                        "set queue depth=%u\n", dev->q_depth);
2643 2644
	}

2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
	/*
	 * Controllers with the shared tags quirk need the IO queue to be
	 * big enough so that we get 32 tags for the admin queue
	 */
	if ((dev->ctrl.quirks & NVME_QUIRK_SHARED_TAGS) &&
	    (dev->q_depth < (NVME_AQ_DEPTH + 2))) {
		dev->q_depth = NVME_AQ_DEPTH + 2;
		dev_warn(dev->ctrl.device, "IO queue depth clamped to %d\n",
			 dev->q_depth);
	}


2657
	nvme_map_cmb(dev);
2658

K
Keith Busch 已提交
2659 2660
	pci_enable_pcie_error_reporting(pdev);
	pci_save_state(pdev);
2661 2662 2663 2664 2665 2666 2667 2668
	return 0;

 disable:
	pci_disable_device(pdev);
	return result;
}

static void nvme_dev_unmap(struct nvme_dev *dev)
2669 2670 2671
{
	if (dev->bar)
		iounmap(dev->bar);
2672
	pci_release_mem_regions(to_pci_dev(dev->dev));
2673 2674 2675
}

static void nvme_pci_disable(struct nvme_dev *dev)
2676
{
2677 2678
	struct pci_dev *pdev = to_pci_dev(dev->dev);

2679
	pci_free_irq_vectors(pdev);
2680

K
Keith Busch 已提交
2681 2682
	if (pci_is_enabled(pdev)) {
		pci_disable_pcie_error_reporting(pdev);
2683
		pci_disable_device(pdev);
K
Keith Busch 已提交
2684 2685 2686
	}
}

2687
static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown)
M
Matthew Wilcox 已提交
2688
{
2689
	bool dead = true, freeze = false;
K
Keith Busch 已提交
2690
	struct pci_dev *pdev = to_pci_dev(dev->dev);
2691

2692
	mutex_lock(&dev->shutdown_lock);
2693
	if (pci_device_is_present(pdev) && pci_is_enabled(pdev)) {
K
Keith Busch 已提交
2694 2695
		u32 csts = readl(dev->bar + NVME_REG_CSTS);

K
Keith Busch 已提交
2696
		if (dev->ctrl.state == NVME_CTRL_LIVE ||
2697 2698
		    dev->ctrl.state == NVME_CTRL_RESETTING) {
			freeze = true;
K
Keith Busch 已提交
2699
			nvme_start_freeze(&dev->ctrl);
2700
		}
K
Keith Busch 已提交
2701 2702
		dead = !!((csts & NVME_CSTS_CFS) || !(csts & NVME_CSTS_RDY) ||
			pdev->error_state  != pci_channel_io_normal);
2703
	}
2704

K
Keith Busch 已提交
2705 2706 2707 2708
	/*
	 * Give the controller a chance to complete all entered requests if
	 * doing a safe shutdown.
	 */
2709 2710
	if (!dead && shutdown && freeze)
		nvme_wait_freeze_timeout(&dev->ctrl, NVME_IO_TIMEOUT);
2711 2712

	nvme_stop_queues(&dev->ctrl);
2713

2714
	if (!dead && dev->ctrl.queue_count > 0) {
2715
		nvme_disable_io_queues(dev);
2716
		nvme_disable_admin_queue(dev, shutdown);
K
Keith Busch 已提交
2717
	}
2718 2719
	nvme_suspend_io_queues(dev);
	nvme_suspend_queue(&dev->queues[0]);
2720
	nvme_pci_disable(dev);
2721
	nvme_reap_pending_cqes(dev);
2722

2723 2724
	blk_mq_tagset_busy_iter(&dev->tagset, nvme_cancel_request, &dev->ctrl);
	blk_mq_tagset_busy_iter(&dev->admin_tagset, nvme_cancel_request, &dev->ctrl);
2725 2726
	blk_mq_tagset_wait_completed_request(&dev->tagset);
	blk_mq_tagset_wait_completed_request(&dev->admin_tagset);
K
Keith Busch 已提交
2727 2728 2729 2730 2731 2732

	/*
	 * The driver will not be starting up queues again if shutting down so
	 * must flush all entered requests to their failed completion to avoid
	 * deadlocking blk-mq hot-cpu notifier.
	 */
2733
	if (shutdown) {
K
Keith Busch 已提交
2734
		nvme_start_queues(&dev->ctrl);
2735
		if (dev->ctrl.admin_q && !blk_queue_dying(dev->ctrl.admin_q))
2736
			nvme_start_admin_queue(&dev->ctrl);
2737
	}
2738
	mutex_unlock(&dev->shutdown_lock);
M
Matthew Wilcox 已提交
2739 2740
}

2741 2742 2743 2744 2745 2746 2747 2748
static int nvme_disable_prepare_reset(struct nvme_dev *dev, bool shutdown)
{
	if (!nvme_wait_reset(&dev->ctrl))
		return -EBUSY;
	nvme_dev_disable(dev, shutdown);
	return 0;
}

M
Matthew Wilcox 已提交
2749 2750
static int nvme_setup_prp_pools(struct nvme_dev *dev)
{
2751
	dev->prp_page_pool = dma_pool_create("prp list page", dev->dev,
C
Christoph Hellwig 已提交
2752 2753
						NVME_CTRL_PAGE_SIZE,
						NVME_CTRL_PAGE_SIZE, 0);
M
Matthew Wilcox 已提交
2754 2755 2756
	if (!dev->prp_page_pool)
		return -ENOMEM;

2757
	/* Optimisation for I/Os between 4k and 128k */
2758
	dev->prp_small_pool = dma_pool_create("prp list 256", dev->dev,
2759 2760 2761 2762 2763
						256, 256, 0);
	if (!dev->prp_small_pool) {
		dma_pool_destroy(dev->prp_page_pool);
		return -ENOMEM;
	}
M
Matthew Wilcox 已提交
2764 2765 2766 2767 2768 2769
	return 0;
}

static void nvme_release_prp_pools(struct nvme_dev *dev)
{
	dma_pool_destroy(dev->prp_page_pool);
2770
	dma_pool_destroy(dev->prp_small_pool);
M
Matthew Wilcox 已提交
2771 2772
}

2773 2774 2775 2776 2777 2778 2779
static void nvme_free_tagset(struct nvme_dev *dev)
{
	if (dev->tagset.tags)
		blk_mq_free_tag_set(&dev->tagset);
	dev->ctrl.tagset = NULL;
}

2780
static void nvme_pci_free_ctrl(struct nvme_ctrl *ctrl)
2781
{
2782
	struct nvme_dev *dev = to_nvme_dev(ctrl);
2783

2784
	nvme_dbbuf_dma_free(dev);
2785
	nvme_free_tagset(dev);
2786 2787
	if (dev->ctrl.admin_q)
		blk_put_queue(dev->ctrl.admin_q);
2788
	free_opal_dev(dev->ctrl.opal_dev);
2789
	mempool_destroy(dev->iod_mempool);
2790 2791
	put_device(dev->dev);
	kfree(dev->queues);
2792 2793 2794
	kfree(dev);
}

2795
static void nvme_remove_dead_ctrl(struct nvme_dev *dev)
2796
{
2797 2798 2799 2800 2801
	/*
	 * Set state to deleting now to avoid blocking nvme_wait_reset(), which
	 * may be holding this pci_dev's device lock.
	 */
	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
2802
	nvme_get_ctrl(&dev->ctrl);
2803
	nvme_dev_disable(dev, false);
2804
	nvme_kill_queues(&dev->ctrl);
2805
	if (!queue_work(nvme_wq, &dev->remove_work))
2806 2807 2808
		nvme_put_ctrl(&dev->ctrl);
}

2809
static void nvme_reset_work(struct work_struct *work)
2810
{
2811 2812
	struct nvme_dev *dev =
		container_of(work, struct nvme_dev, ctrl.reset_work);
2813
	bool was_suspend = !!(dev->ctrl.ctrl_config & NVME_CC_SHN_NORMAL);
2814
	int result;
2815

2816 2817 2818
	if (dev->ctrl.state != NVME_CTRL_RESETTING) {
		dev_warn(dev->ctrl.device, "ctrl state %d is not RESETTING\n",
			 dev->ctrl.state);
2819
		result = -ENODEV;
2820
		goto out;
2821
	}
2822

2823 2824 2825 2826
	/*
	 * If we're called to reset a live controller first shut it down before
	 * moving on.
	 */
2827
	if (dev->ctrl.ctrl_config & NVME_CC_ENABLE)
2828
		nvme_dev_disable(dev, false);
K
Keith Busch 已提交
2829
	nvme_sync_queues(&dev->ctrl);
2830

2831
	mutex_lock(&dev->shutdown_lock);
2832
	result = nvme_pci_enable(dev);
2833
	if (result)
2834
		goto out_unlock;
2835

2836
	result = nvme_pci_configure_admin_queue(dev);
2837
	if (result)
2838
		goto out_unlock;
2839

K
Keith Busch 已提交
2840 2841
	result = nvme_alloc_admin_tags(dev);
	if (result)
2842
		goto out_unlock;
2843

2844 2845 2846 2847
	/*
	 * Limit the max command size to prevent iod->sg allocations going
	 * over a single page.
	 */
2848 2849
	dev->ctrl.max_hw_sectors = min_t(u32,
		NVME_MAX_KB_SZ << 1, dma_max_mapping_size(dev->dev) >> 9);
2850
	dev->ctrl.max_segments = NVME_MAX_SEGS;
2851 2852 2853 2854 2855

	/*
	 * Don't limit the IOMMU merged segment size.
	 */
	dma_set_max_seg_size(dev->dev, 0xffffffff);
J
Jianxiong Gao 已提交
2856
	dma_set_min_align_mask(dev->dev, NVME_CTRL_PAGE_SIZE - 1);
2857

2858 2859 2860 2861 2862 2863 2864 2865 2866
	mutex_unlock(&dev->shutdown_lock);

	/*
	 * Introduce CONNECTING state from nvme-fc/rdma transports to mark the
	 * initializing procedure here.
	 */
	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_CONNECTING)) {
		dev_warn(dev->ctrl.device,
			"failed to mark controller CONNECTING\n");
2867
		result = -EBUSY;
2868 2869
		goto out;
	}
2870

2871 2872 2873 2874 2875 2876
	/*
	 * We do not support an SGL for metadata (yet), so we are limited to a
	 * single integrity segment for the separate metadata pointer.
	 */
	dev->ctrl.max_integrity_segments = 1;

2877
	result = nvme_init_ctrl_finish(&dev->ctrl);
2878
	if (result)
2879
		goto out;
2880

2881 2882 2883 2884 2885 2886 2887 2888 2889
	if (dev->ctrl.oacs & NVME_CTRL_OACS_SEC_SUPP) {
		if (!dev->ctrl.opal_dev)
			dev->ctrl.opal_dev =
				init_opal_dev(&dev->ctrl, &nvme_sec_submit);
		else if (was_suspend)
			opal_unlock_from_suspend(dev->ctrl.opal_dev);
	} else {
		free_opal_dev(dev->ctrl.opal_dev);
		dev->ctrl.opal_dev = NULL;
2890
	}
2891

2892 2893 2894 2895 2896 2897 2898
	if (dev->ctrl.oacs & NVME_CTRL_OACS_DBBUF_SUPP) {
		result = nvme_dbbuf_dma_alloc(dev);
		if (result)
			dev_warn(dev->dev,
				 "unable to allocate dma for dbbuf\n");
	}

2899 2900 2901 2902 2903
	if (dev->ctrl.hmpre) {
		result = nvme_setup_host_mem(dev);
		if (result < 0)
			goto out;
	}
2904

2905
	result = nvme_setup_io_queues(dev);
2906
	if (result)
2907
		goto out;
2908

2909 2910 2911 2912
	/*
	 * Keep the controller around but remove all namespaces if we don't have
	 * any working I/O queue.
	 */
2913
	if (dev->online_queues < 2) {
2914
		dev_warn(dev->ctrl.device, "IO queues not created\n");
2915
		nvme_kill_queues(&dev->ctrl);
2916
		nvme_remove_namespaces(&dev->ctrl);
2917
		nvme_free_tagset(dev);
2918
	} else {
2919
		nvme_start_queues(&dev->ctrl);
K
Keith Busch 已提交
2920
		nvme_wait_freeze(&dev->ctrl);
K
Keith Busch 已提交
2921
		nvme_dev_add(dev);
K
Keith Busch 已提交
2922
		nvme_unfreeze(&dev->ctrl);
2923 2924
	}

2925 2926 2927 2928
	/*
	 * If only admin queue live, keep it to do further investigation or
	 * recovery.
	 */
K
Keith Busch 已提交
2929
	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_LIVE)) {
2930
		dev_warn(dev->ctrl.device,
K
Keith Busch 已提交
2931
			"failed to mark controller live state\n");
2932
		result = -ENODEV;
2933 2934
		goto out;
	}
2935

2936 2937 2938 2939
	if (!dev->attrs_added && !sysfs_create_group(&dev->ctrl.device->kobj,
			&nvme_pci_attr_group))
		dev->attrs_added = true;

2940
	nvme_start_ctrl(&dev->ctrl);
2941
	return;
2942

2943 2944
 out_unlock:
	mutex_unlock(&dev->shutdown_lock);
2945
 out:
2946 2947 2948 2949
	if (result)
		dev_warn(dev->ctrl.device,
			 "Removing after probe failure status: %d\n", result);
	nvme_remove_dead_ctrl(dev);
2950 2951
}

2952
static void nvme_remove_dead_ctrl_work(struct work_struct *work)
K
Keith Busch 已提交
2953
{
2954
	struct nvme_dev *dev = container_of(work, struct nvme_dev, remove_work);
2955
	struct pci_dev *pdev = to_pci_dev(dev->dev);
K
Keith Busch 已提交
2956 2957

	if (pci_get_drvdata(pdev))
K
Keith Busch 已提交
2958
		device_release_driver(&pdev->dev);
2959
	nvme_put_ctrl(&dev->ctrl);
K
Keith Busch 已提交
2960 2961
}

2962
static int nvme_pci_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val)
T
Tejun Heo 已提交
2963
{
2964
	*val = readl(to_nvme_dev(ctrl)->bar + off);
2965
	return 0;
T
Tejun Heo 已提交
2966 2967
}

2968
static int nvme_pci_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val)
2969
{
2970 2971 2972
	writel(val, to_nvme_dev(ctrl)->bar + off);
	return 0;
}
2973

2974 2975
static int nvme_pci_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val)
{
2976
	*val = lo_hi_readq(to_nvme_dev(ctrl)->bar + off);
2977
	return 0;
2978 2979
}

2980 2981 2982 2983
static int nvme_pci_get_address(struct nvme_ctrl *ctrl, char *buf, int size)
{
	struct pci_dev *pdev = to_pci_dev(to_nvme_dev(ctrl)->dev);

2984
	return snprintf(buf, size, "%s\n", dev_name(&pdev->dev));
2985 2986
}

2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001

static void nvme_pci_print_device_info(struct nvme_ctrl *ctrl)
{
	struct pci_dev *pdev = to_pci_dev(to_nvme_dev(ctrl)->dev);
	struct nvme_subsystem *subsys = ctrl->subsys;

	dev_err(ctrl->device,
		"VID:DID %04x:%04x model:%.*s firmware:%.*s\n",
		pdev->vendor, pdev->device,
		nvme_strlen(subsys->model, sizeof(subsys->model)),
		subsys->model, nvme_strlen(subsys->firmware_rev,
					   sizeof(subsys->firmware_rev)),
		subsys->firmware_rev);
}

3002
static const struct nvme_ctrl_ops nvme_pci_ctrl_ops = {
M
Ming Lin 已提交
3003
	.name			= "pcie",
3004
	.module			= THIS_MODULE,
3005 3006
	.flags			= NVME_F_METADATA_SUPPORTED |
				  NVME_F_PCI_P2PDMA,
3007
	.reg_read32		= nvme_pci_reg_read32,
3008
	.reg_write32		= nvme_pci_reg_write32,
3009
	.reg_read64		= nvme_pci_reg_read64,
3010
	.free_ctrl		= nvme_pci_free_ctrl,
3011
	.submit_async_event	= nvme_pci_submit_async_event,
3012
	.get_address		= nvme_pci_get_address,
3013
	.print_device_info	= nvme_pci_print_device_info,
3014
};
3015

3016 3017 3018 3019
static int nvme_dev_map(struct nvme_dev *dev)
{
	struct pci_dev *pdev = to_pci_dev(dev->dev);

3020
	if (pci_request_mem_regions(pdev, "nvme"))
3021 3022
		return -ENODEV;

3023
	if (nvme_remap_bar(dev, NVME_REG_DBS + 4096))
3024 3025
		goto release;

M
Max Gurtovoy 已提交
3026
	return 0;
3027
  release:
M
Max Gurtovoy 已提交
3028 3029
	pci_release_mem_regions(pdev);
	return -ENODEV;
3030 3031
}

3032
static unsigned long check_vendor_combination_bug(struct pci_dev *pdev)
3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046
{
	if (pdev->vendor == 0x144d && pdev->device == 0xa802) {
		/*
		 * Several Samsung devices seem to drop off the PCIe bus
		 * randomly when APST is on and uses the deepest sleep state.
		 * This has been observed on a Samsung "SM951 NVMe SAMSUNG
		 * 256GB", a "PM951 NVMe SAMSUNG 512GB", and a "Samsung SSD
		 * 950 PRO 256GB", but it seems to be restricted to two Dell
		 * laptops.
		 */
		if (dmi_match(DMI_SYS_VENDOR, "Dell Inc.") &&
		    (dmi_match(DMI_PRODUCT_NAME, "XPS 15 9550") ||
		     dmi_match(DMI_PRODUCT_NAME, "Precision 5510")))
			return NVME_QUIRK_NO_DEEPEST_PS;
3047 3048 3049
	} else if (pdev->vendor == 0x144d && pdev->device == 0xa804) {
		/*
		 * Samsung SSD 960 EVO drops off the PCIe bus after system
3050 3051 3052
		 * suspend on a Ryzen board, ASUS PRIME B350M-A, as well as
		 * within few minutes after bootup on a Coffee Lake board -
		 * ASUS PRIME Z370-A
3053 3054
		 */
		if (dmi_match(DMI_BOARD_VENDOR, "ASUSTeK COMPUTER INC.") &&
3055 3056
		    (dmi_match(DMI_BOARD_NAME, "PRIME B350M-A") ||
		     dmi_match(DMI_BOARD_NAME, "PRIME Z370-A")))
3057
			return NVME_QUIRK_NO_APST;
3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069
	} else if ((pdev->vendor == 0x144d && (pdev->device == 0xa801 ||
		    pdev->device == 0xa808 || pdev->device == 0xa809)) ||
		   (pdev->vendor == 0x1e0f && pdev->device == 0x0001)) {
		/*
		 * Forcing to use host managed nvme power settings for
		 * lowest idle power with quick resume latency on
		 * Samsung and Toshiba SSDs based on suspend behavior
		 * on Coffee Lake board for LENOVO C640
		 */
		if ((dmi_match(DMI_BOARD_VENDOR, "LENOVO")) &&
		     dmi_match(DMI_BOARD_NAME, "LNVNB161216"))
			return NVME_QUIRK_SIMPLE_SUSPEND;
3070 3071 3072 3073 3074
	}

	return 0;
}

3075 3076 3077
static void nvme_async_probe(void *data, async_cookie_t cookie)
{
	struct nvme_dev *dev = data;
3078

3079
	flush_work(&dev->ctrl.reset_work);
3080
	flush_work(&dev->ctrl.scan_work);
3081
	nvme_put_ctrl(&dev->ctrl);
3082 3083
}

3084
static int nvme_probe(struct pci_dev *pdev, const struct pci_device_id *id)
M
Matthew Wilcox 已提交
3085
{
M
Matias Bjørling 已提交
3086
	int node, result = -ENOMEM;
M
Matthew Wilcox 已提交
3087
	struct nvme_dev *dev;
3088
	unsigned long quirks = id->driver_data;
3089
	size_t alloc_size;
M
Matthew Wilcox 已提交
3090

M
Matias Bjørling 已提交
3091 3092
	node = dev_to_node(&pdev->dev);
	if (node == NUMA_NO_NODE)
3093
		set_dev_node(&pdev->dev, first_memory_node);
M
Matias Bjørling 已提交
3094 3095

	dev = kzalloc_node(sizeof(*dev), GFP_KERNEL, node);
M
Matthew Wilcox 已提交
3096 3097
	if (!dev)
		return -ENOMEM;
3098

3099 3100 3101 3102 3103
	dev->nr_write_queues = write_queues;
	dev->nr_poll_queues = poll_queues;
	dev->nr_allocated_queues = nvme_max_io_queues(dev) + 1;
	dev->queues = kcalloc_node(dev->nr_allocated_queues,
			sizeof(struct nvme_queue), GFP_KERNEL, node);
M
Matthew Wilcox 已提交
3104 3105 3106
	if (!dev->queues)
		goto free;

3107
	dev->dev = get_device(&pdev->dev);
K
Keith Busch 已提交
3108
	pci_set_drvdata(pdev, dev);
3109

3110 3111
	result = nvme_dev_map(dev);
	if (result)
3112
		goto put_pci;
3113

3114
	INIT_WORK(&dev->ctrl.reset_work, nvme_reset_work);
3115
	INIT_WORK(&dev->remove_work, nvme_remove_dead_ctrl_work);
3116
	mutex_init(&dev->shutdown_lock);
M
Matthew Wilcox 已提交
3117

M
Matthew Wilcox 已提交
3118 3119
	result = nvme_setup_prp_pools(dev);
	if (result)
3120
		goto unmap;
3121

3122
	quirks |= check_vendor_combination_bug(pdev);
3123

3124
	if (!noacpi && acpi_storage_d3(&pdev->dev)) {
3125 3126 3127 3128 3129 3130 3131 3132 3133
		/*
		 * Some systems use a bios work around to ask for D3 on
		 * platforms that support kernel managed suspend.
		 */
		dev_info(&pdev->dev,
			 "platform quirk: setting simple suspend\n");
		quirks |= NVME_QUIRK_SIMPLE_SUSPEND;
	}

3134 3135 3136 3137
	/*
	 * Double check that our mempool alloc size will cover the biggest
	 * command we support.
	 */
3138
	alloc_size = nvme_pci_iod_alloc_size();
3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149
	WARN_ON_ONCE(alloc_size > PAGE_SIZE);

	dev->iod_mempool = mempool_create_node(1, mempool_kmalloc,
						mempool_kfree,
						(void *) alloc_size,
						GFP_KERNEL, node);
	if (!dev->iod_mempool) {
		result = -ENOMEM;
		goto release_pools;
	}

3150 3151 3152 3153 3154
	result = nvme_init_ctrl(&dev->ctrl, &pdev->dev, &nvme_pci_ctrl_ops,
			quirks);
	if (result)
		goto release_mempool;

3155 3156
	dev_info(dev->ctrl.device, "pci function %s\n", dev_name(&pdev->dev));

3157
	nvme_reset_ctrl(&dev->ctrl);
3158
	async_schedule(nvme_async_probe, dev);
3159

M
Matthew Wilcox 已提交
3160 3161
	return 0;

3162 3163
 release_mempool:
	mempool_destroy(dev->iod_mempool);
3164
 release_pools:
M
Matthew Wilcox 已提交
3165
	nvme_release_prp_pools(dev);
3166 3167
 unmap:
	nvme_dev_unmap(dev);
K
Keith Busch 已提交
3168
 put_pci:
3169
	put_device(dev->dev);
M
Matthew Wilcox 已提交
3170 3171 3172 3173 3174 3175
 free:
	kfree(dev->queues);
	kfree(dev);
	return result;
}

3176
static void nvme_reset_prepare(struct pci_dev *pdev)
3177
{
K
Keith Busch 已提交
3178
	struct nvme_dev *dev = pci_get_drvdata(pdev);
3179 3180 3181 3182 3183 3184 3185 3186

	/*
	 * We don't need to check the return value from waiting for the reset
	 * state as pci_dev device lock is held, making it impossible to race
	 * with ->remove().
	 */
	nvme_disable_prepare_reset(dev, false);
	nvme_sync_queues(&dev->ctrl);
3187
}
3188

3189 3190
static void nvme_reset_done(struct pci_dev *pdev)
{
3191
	struct nvme_dev *dev = pci_get_drvdata(pdev);
3192 3193 3194

	if (!nvme_try_sched_reset(&dev->ctrl))
		flush_work(&dev->ctrl.reset_work);
3195 3196
}

3197 3198 3199
static void nvme_shutdown(struct pci_dev *pdev)
{
	struct nvme_dev *dev = pci_get_drvdata(pdev);
3200

3201
	nvme_disable_prepare_reset(dev, true);
3202 3203
}

3204 3205 3206 3207 3208 3209 3210
static void nvme_remove_attrs(struct nvme_dev *dev)
{
	if (dev->attrs_added)
		sysfs_remove_group(&dev->ctrl.device->kobj,
				   &nvme_pci_attr_group);
}

3211 3212 3213 3214 3215
/*
 * The driver's remove may be called on a device in a partially initialized
 * state. This function must not have any dependencies on the device state in
 * order to proceed.
 */
3216
static void nvme_remove(struct pci_dev *pdev)
M
Matthew Wilcox 已提交
3217 3218
{
	struct nvme_dev *dev = pci_get_drvdata(pdev);
K
Keith Busch 已提交
3219

3220
	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
K
Keith Busch 已提交
3221
	pci_set_drvdata(pdev, NULL);
3222

3223
	if (!pci_device_is_present(pdev)) {
3224
		nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DEAD);
3225
		nvme_dev_disable(dev, true);
3226
	}
3227

3228
	flush_work(&dev->ctrl.reset_work);
3229 3230
	nvme_stop_ctrl(&dev->ctrl);
	nvme_remove_namespaces(&dev->ctrl);
3231
	nvme_dev_disable(dev, true);
3232
	nvme_remove_attrs(dev);
3233
	nvme_free_host_mem(dev);
M
Matias Bjørling 已提交
3234
	nvme_dev_remove_admin(dev);
3235
	nvme_free_queues(dev, 0);
K
Keith Busch 已提交
3236
	nvme_release_prp_pools(dev);
3237
	nvme_dev_unmap(dev);
3238
	nvme_uninit_ctrl(&dev->ctrl);
M
Matthew Wilcox 已提交
3239 3240
}

3241
#ifdef CONFIG_PM_SLEEP
3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
static int nvme_get_power_state(struct nvme_ctrl *ctrl, u32 *ps)
{
	return nvme_get_features(ctrl, NVME_FEAT_POWER_MGMT, 0, NULL, 0, ps);
}

static int nvme_set_power_state(struct nvme_ctrl *ctrl, u32 ps)
{
	return nvme_set_features(ctrl, NVME_FEAT_POWER_MGMT, ps, NULL, 0, NULL);
}

static int nvme_resume(struct device *dev)
{
	struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
	struct nvme_ctrl *ctrl = &ndev->ctrl;

3257
	if (ndev->last_ps == U32_MAX ||
3258
	    nvme_set_power_state(ctrl, ndev->last_ps) != 0)
3259 3260 3261 3262
		goto reset;
	if (ctrl->hmpre && nvme_setup_host_mem(ndev))
		goto reset;

3263
	return 0;
3264 3265
reset:
	return nvme_try_sched_reset(ctrl);
3266 3267
}

3268 3269 3270 3271
static int nvme_suspend(struct device *dev)
{
	struct pci_dev *pdev = to_pci_dev(dev);
	struct nvme_dev *ndev = pci_get_drvdata(pdev);
3272 3273 3274
	struct nvme_ctrl *ctrl = &ndev->ctrl;
	int ret = -EBUSY;

3275 3276
	ndev->last_ps = U32_MAX;

3277 3278 3279 3280 3281 3282 3283
	/*
	 * The platform does not remove power for a kernel managed suspend so
	 * use host managed nvme power settings for lowest idle power if
	 * possible. This should have quicker resume latency than a full device
	 * shutdown.  But if the firmware is involved after the suspend or the
	 * device does not support any non-default power states, shut down the
	 * device fully.
3284 3285 3286 3287 3288
	 *
	 * If ASPM is not enabled for the device, shut down the device and allow
	 * the PCI bus layer to put it into D3 in order to take the PCIe link
	 * down, so as to allow the platform to achieve its minimum low-power
	 * state (which may not be possible if the link is up).
3289
	 */
3290
	if (pm_suspend_via_firmware() || !ctrl->npss ||
3291
	    !pcie_aspm_enabled(pdev) ||
3292 3293
	    (ndev->ctrl.quirks & NVME_QUIRK_SIMPLE_SUSPEND))
		return nvme_disable_prepare_reset(ndev, true);
3294 3295 3296 3297 3298

	nvme_start_freeze(ctrl);
	nvme_wait_freeze(ctrl);
	nvme_sync_queues(ctrl);

K
Keith Busch 已提交
3299
	if (ctrl->state != NVME_CTRL_LIVE)
3300 3301
		goto unfreeze;

3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312
	/*
	 * Host memory access may not be successful in a system suspend state,
	 * but the specification allows the controller to access memory in a
	 * non-operational power state.
	 */
	if (ndev->hmb) {
		ret = nvme_set_host_mem(ndev, 0);
		if (ret < 0)
			goto unfreeze;
	}

3313 3314 3315 3316
	ret = nvme_get_power_state(ctrl, &ndev->last_ps);
	if (ret < 0)
		goto unfreeze;

3317 3318 3319 3320 3321 3322 3323
	/*
	 * A saved state prevents pci pm from generically controlling the
	 * device's power. If we're using protocol specific settings, we don't
	 * want pci interfering.
	 */
	pci_save_state(pdev);

3324 3325 3326 3327 3328
	ret = nvme_set_power_state(ctrl, ctrl->npss);
	if (ret < 0)
		goto unfreeze;

	if (ret) {
3329 3330 3331
		/* discard the saved state */
		pci_load_saved_state(pdev, NULL);

3332 3333
		/*
		 * Clearing npss forces a controller reset on resume. The
3334
		 * correct value will be rediscovered then.
3335
		 */
3336
		ret = nvme_disable_prepare_reset(ndev, true);
3337 3338 3339 3340 3341 3342 3343 3344 3345 3346
		ctrl->npss = 0;
	}
unfreeze:
	nvme_unfreeze(ctrl);
	return ret;
}

static int nvme_simple_suspend(struct device *dev)
{
	struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
3347

3348
	return nvme_disable_prepare_reset(ndev, true);
3349 3350
}

3351
static int nvme_simple_resume(struct device *dev)
3352 3353 3354 3355
{
	struct pci_dev *pdev = to_pci_dev(dev);
	struct nvme_dev *ndev = pci_get_drvdata(pdev);

3356
	return nvme_try_sched_reset(&ndev->ctrl);
3357 3358
}

3359
static const struct dev_pm_ops nvme_dev_pm_ops = {
3360 3361 3362 3363 3364 3365 3366 3367
	.suspend	= nvme_suspend,
	.resume		= nvme_resume,
	.freeze		= nvme_simple_suspend,
	.thaw		= nvme_simple_resume,
	.poweroff	= nvme_simple_suspend,
	.restore	= nvme_simple_resume,
};
#endif /* CONFIG_PM_SLEEP */
M
Matthew Wilcox 已提交
3368

K
Keith Busch 已提交
3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382
static pci_ers_result_t nvme_error_detected(struct pci_dev *pdev,
						pci_channel_state_t state)
{
	struct nvme_dev *dev = pci_get_drvdata(pdev);

	/*
	 * A frozen channel requires a reset. When detected, this method will
	 * shutdown the controller to quiesce. The controller will be restarted
	 * after the slot reset through driver's slot_reset callback.
	 */
	switch (state) {
	case pci_channel_io_normal:
		return PCI_ERS_RESULT_CAN_RECOVER;
	case pci_channel_io_frozen:
K
Keith Busch 已提交
3383 3384
		dev_warn(dev->ctrl.device,
			"frozen state error detected, reset controller\n");
3385
		nvme_dev_disable(dev, false);
K
Keith Busch 已提交
3386 3387
		return PCI_ERS_RESULT_NEED_RESET;
	case pci_channel_io_perm_failure:
K
Keith Busch 已提交
3388 3389
		dev_warn(dev->ctrl.device,
			"failure state error detected, request disconnect\n");
K
Keith Busch 已提交
3390 3391 3392 3393 3394 3395 3396 3397 3398
		return PCI_ERS_RESULT_DISCONNECT;
	}
	return PCI_ERS_RESULT_NEED_RESET;
}

static pci_ers_result_t nvme_slot_reset(struct pci_dev *pdev)
{
	struct nvme_dev *dev = pci_get_drvdata(pdev);

3399
	dev_info(dev->ctrl.device, "restart after slot reset\n");
K
Keith Busch 已提交
3400
	pci_restore_state(pdev);
3401
	nvme_reset_ctrl(&dev->ctrl);
K
Keith Busch 已提交
3402 3403 3404 3405 3406
	return PCI_ERS_RESULT_RECOVERED;
}

static void nvme_error_resume(struct pci_dev *pdev)
{
K
Keith Busch 已提交
3407 3408 3409
	struct nvme_dev *dev = pci_get_drvdata(pdev);

	flush_work(&dev->ctrl.reset_work);
K
Keith Busch 已提交
3410 3411
}

3412
static const struct pci_error_handlers nvme_err_handler = {
M
Matthew Wilcox 已提交
3413 3414 3415
	.error_detected	= nvme_error_detected,
	.slot_reset	= nvme_slot_reset,
	.resume		= nvme_error_resume,
3416 3417
	.reset_prepare	= nvme_reset_prepare,
	.reset_done	= nvme_reset_done,
M
Matthew Wilcox 已提交
3418 3419
};

3420
static const struct pci_device_id nvme_id_table[] = {
3421
	{ PCI_VDEVICE(INTEL, 0x0953),	/* Intel 750/P3500/P3600/P3700 */
3422
		.driver_data = NVME_QUIRK_STRIPE_SIZE |
3423
				NVME_QUIRK_DEALLOCATE_ZEROES, },
3424
	{ PCI_VDEVICE(INTEL, 0x0a53),	/* Intel P3520 */
3425
		.driver_data = NVME_QUIRK_STRIPE_SIZE |
3426
				NVME_QUIRK_DEALLOCATE_ZEROES, },
3427
	{ PCI_VDEVICE(INTEL, 0x0a54),	/* Intel P4500/P4600 */
3428
		.driver_data = NVME_QUIRK_STRIPE_SIZE |
3429 3430
				NVME_QUIRK_DEALLOCATE_ZEROES |
				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3431
	{ PCI_VDEVICE(INTEL, 0x0a55),	/* Dell Express Flash P4600 */
3432 3433
		.driver_data = NVME_QUIRK_STRIPE_SIZE |
				NVME_QUIRK_DEALLOCATE_ZEROES, },
3434
	{ PCI_VDEVICE(INTEL, 0xf1a5),	/* Intel 600P/P3100 */
3435
		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
3436
				NVME_QUIRK_MEDIUM_PRIO_SQ |
3437 3438
				NVME_QUIRK_NO_TEMP_THRESH_CHANGE |
				NVME_QUIRK_DISABLE_WRITE_ZEROES, },
3439 3440
	{ PCI_VDEVICE(INTEL, 0xf1a6),	/* Intel 760p/Pro 7600p */
		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3441
	{ PCI_VDEVICE(INTEL, 0x5845),	/* Qemu emulated controller */
3442
		.driver_data = NVME_QUIRK_IDENTIFY_CNS |
3443 3444 3445 3446
				NVME_QUIRK_DISABLE_WRITE_ZEROES |
				NVME_QUIRK_BOGUS_NID, },
	{ PCI_VDEVICE(REDHAT, 0x0010),	/* Qemu emulated controller */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3447
	{ PCI_DEVICE(0x126f, 0x2263),	/* Silicon Motion unidentified */
3448 3449
		.driver_data = NVME_QUIRK_NO_NS_DESC_LIST |
				NVME_QUIRK_BOGUS_NID, },
3450
	{ PCI_DEVICE(0x1bb1, 0x0100),   /* Seagate Nytro Flash Storage */
3451 3452
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
				NVME_QUIRK_NO_NS_DESC_LIST, },
3453 3454
	{ PCI_DEVICE(0x1c58, 0x0003),	/* HGST adapter */
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
3455 3456
	{ PCI_DEVICE(0x1c58, 0x0023),	/* WDC SN200 adapter */
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
3457 3458
	{ PCI_DEVICE(0x1c5f, 0x0540),	/* Memblaze Pblaze4 adapter */
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
3459 3460 3461
	{ PCI_DEVICE(0x144d, 0xa821),   /* Samsung PM1725 */
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
	{ PCI_DEVICE(0x144d, 0xa822),   /* Samsung PM1725a */
3462
		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
3463
				NVME_QUIRK_DISABLE_WRITE_ZEROES|
3464
				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3465 3466
	{ PCI_DEVICE(0x1987, 0x5012),	/* Phison E12 */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3467 3468
	{ PCI_DEVICE(0x1987, 0x5016),	/* Phison E16 */
		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3469 3470 3471
	{ PCI_DEVICE(0x1b4b, 0x1092),	/* Lexar 256 GB SSD */
		.driver_data = NVME_QUIRK_NO_NS_DESC_LIST |
				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3472 3473
	{ PCI_DEVICE(0x10ec, 0x5762),   /* ADATA SX6000LNP */
		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3474 3475 3476
	{ PCI_DEVICE(0x1cc1, 0x8201),   /* ADATA SX8200PNP 512GB */
		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
3477 3478
	 { PCI_DEVICE(0x1344, 0x5407), /* Micron Technology Inc NVMe SSD */
		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN },
3479 3480
	{ PCI_DEVICE(0x1c5c, 0x1504),   /* SK Hynix PC400 */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
3481 3482
	{ PCI_DEVICE(0x1c5c, 0x174a),   /* SK Hynix P31 SSD */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3483 3484
	{ PCI_DEVICE(0x15b7, 0x2001),   /*  Sandisk Skyhawk */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
3485 3486
	{ PCI_DEVICE(0x1d97, 0x2263),   /* SPCC */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
3487 3488 3489 3490 3491 3492 3493 3494
	{ PCI_DEVICE(0x144d, 0xa80b),   /* Samsung PM9B1 256G and 512G */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
	{ PCI_DEVICE(0x144d, 0xa809),   /* Samsung MZALQ256HBJD 256G */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
	{ PCI_DEVICE(0x1cc4, 0x6303),   /* UMIS RPJTJ512MGE1QDY 512G */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
	{ PCI_DEVICE(0x1cc4, 0x6302),   /* UMIS RPJTJ256MGE1QDY 256G */
		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
3495 3496
	{ PCI_DEVICE(0x2646, 0x2262),   /* KINGSTON SKC2000 NVMe SSD */
		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
3497 3498
	{ PCI_DEVICE(0x2646, 0x2263),   /* KINGSTON A2000 NVMe SSD  */
		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
3499 3500
	{ PCI_DEVICE(0x1e4B, 0x1001),   /* MAXIO MAP1001 */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3501 3502 3503 3504
	{ PCI_DEVICE(0x1e4B, 0x1002),   /* MAXIO MAP1002 */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
	{ PCI_DEVICE(0x1e4B, 0x1202),   /* MAXIO MAP1202 */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3505 3506
	{ PCI_DEVICE(0x1cc1, 0x5350),   /* ADATA XPG GAMMIX S50 */
		.driver_data = NVME_QUIRK_BOGUS_NID, },
3507 3508
	{ PCI_DEVICE(0x1e49, 0x0041),   /* ZHITAI TiPro7000 NVMe SSD */
		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x0061),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x0065),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x8061),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd00),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd01),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd02),
		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
3521 3522
	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2001),
		.driver_data = NVME_QUIRK_SINGLE_VECTOR },
3523
	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2003) },
3524 3525
	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2005),
		.driver_data = NVME_QUIRK_SINGLE_VECTOR |
3526
				NVME_QUIRK_128_BYTES_SQES |
3527 3528
				NVME_QUIRK_SHARED_TAGS |
				NVME_QUIRK_SKIP_CID_GEN },
3529
	{ PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
M
Matthew Wilcox 已提交
3530 3531 3532 3533 3534 3535 3536 3537
	{ 0, }
};
MODULE_DEVICE_TABLE(pci, nvme_id_table);

static struct pci_driver nvme_driver = {
	.name		= "nvme",
	.id_table	= nvme_id_table,
	.probe		= nvme_probe,
3538
	.remove		= nvme_remove,
3539
	.shutdown	= nvme_shutdown,
3540
#ifdef CONFIG_PM_SLEEP
3541 3542 3543
	.driver		= {
		.pm	= &nvme_dev_pm_ops,
	},
3544
#endif
3545
	.sriov_configure = pci_sriov_configure_simple,
M
Matthew Wilcox 已提交
3546 3547 3548 3549 3550
	.err_handler	= &nvme_err_handler,
};

static int __init nvme_init(void)
{
3551 3552 3553
	BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
3554
	BUILD_BUG_ON(IRQ_AFFINITY_MAX_SETS < 2);
3555

3556
	return pci_register_driver(&nvme_driver);
M
Matthew Wilcox 已提交
3557 3558 3559 3560 3561
}

static void __exit nvme_exit(void)
{
	pci_unregister_driver(&nvme_driver);
3562
	flush_workqueue(nvme_wq);
M
Matthew Wilcox 已提交
3563 3564 3565 3566
}

MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
MODULE_LICENSE("GPL");
3567
MODULE_VERSION("1.0");
M
Matthew Wilcox 已提交
3568 3569
module_init(nvme_init);
module_exit(nvme_exit);