xref: /linux/drivers/nvme/host/pci.c (revision 8ebbaf8835c62d7541a6226672a6c2e8e6a5428a)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * NVM Express device driver
4  * Copyright (c) 2011-2014, Intel Corporation.
5  */
6 
7 #include <linux/acpi.h>
8 #include <linux/async.h>
9 #include <linux/blkdev.h>
10 #include <linux/blk-mq-dma.h>
11 #include <linux/blk-integrity.h>
12 #include <linux/dmi.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
15 #include <linux/io.h>
16 #include <linux/kstrtox.h>
17 #include <linux/memremap.h>
18 #include <linux/mm.h>
19 #include <linux/module.h>
20 #include <linux/mutex.h>
21 #include <linux/nodemask.h>
22 #include <linux/once.h>
23 #include <linux/pci.h>
24 #include <linux/suspend.h>
25 #include <linux/t10-pi.h>
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 
31 #include "trace.h"
32 #include "nvme.h"
33 #include "pci-dmabuf.h"
34 
35 #define SQ_SIZE(q)	((q)->q_depth << (q)->sqes)
36 #define CQ_SIZE(q)	((q)->q_depth * sizeof(struct nvme_completion))
37 
38 /* Optimisation for I/Os between 4k and 128k */
39 #define NVME_SMALL_POOL_SIZE	256
40 
41 /*
42  * Arbitrary upper bound.
43  */
44 #define NVME_MAX_BYTES		SZ_8M
45 #define NVME_MAX_NR_DESCRIPTORS	5
46 
47 /*
48  * For data SGLs we support a single descriptors worth of SGL entries.
49  * For PRPs, segments don't matter at all.
50  */
51 #define NVME_MAX_SEGS \
52 	(NVME_CTRL_PAGE_SIZE / sizeof(struct nvme_sgl_desc))
53 
54 /*
55  * For metadata SGLs, only the small descriptor is supported, and the first
56  * entry is the segment descriptor, which for the data pointer sits in the SQE.
57  */
58 #define NVME_MAX_META_SEGS \
59 	((NVME_SMALL_POOL_SIZE / sizeof(struct nvme_sgl_desc)) - 1)
60 
61 /*
62  * The last entry is used to link to the next descriptor.
63  */
64 #define PRPS_PER_PAGE \
65 	(((NVME_CTRL_PAGE_SIZE / sizeof(__le64))) - 1)
66 
67 /*
68  * I/O could be non-aligned both at the beginning and end.
69  */
70 #define MAX_PRP_RANGE \
71 	(NVME_MAX_BYTES + 2 * (NVME_CTRL_PAGE_SIZE - 1))
72 
73 static_assert(MAX_PRP_RANGE / NVME_CTRL_PAGE_SIZE <=
74 	(1 /* prp1 */ + NVME_MAX_NR_DESCRIPTORS * PRPS_PER_PAGE));
75 
76 struct quirk_entry {
77 	u16 vendor_id;
78 	u16 dev_id;
79 	u32 enabled_quirks;
80 	u32 disabled_quirks;
81 };
82 
83 static int use_threaded_interrupts;
84 module_param(use_threaded_interrupts, int, 0444);
85 
86 static bool use_cmb_sqes = true;
87 module_param(use_cmb_sqes, bool, 0444);
88 MODULE_PARM_DESC(use_cmb_sqes, "use controller's memory buffer for I/O SQes");
89 
90 static unsigned int max_host_mem_size_mb = 128;
91 module_param(max_host_mem_size_mb, uint, 0444);
92 MODULE_PARM_DESC(max_host_mem_size_mb,
93 	"Maximum Host Memory Buffer (HMB) size per controller (in MiB)");
94 
95 static unsigned int sgl_threshold = SZ_32K;
96 module_param(sgl_threshold, uint, 0644);
97 MODULE_PARM_DESC(sgl_threshold,
98 		"Use SGLs when average request segment size is larger or equal to "
99 		"this size. Use 0 to disable SGLs.");
100 
101 #define NVME_PCI_MIN_QUEUE_SIZE 2
102 #define NVME_PCI_MAX_QUEUE_SIZE 4095
103 static int io_queue_depth_set(const char *val, const struct kernel_param *kp);
104 static const struct kernel_param_ops io_queue_depth_ops = {
105 	.set = io_queue_depth_set,
106 	.get = param_get_uint,
107 };
108 
109 static unsigned int io_queue_depth = 1024;
110 module_param_cb(io_queue_depth, &io_queue_depth_ops, &io_queue_depth, 0644);
111 MODULE_PARM_DESC(io_queue_depth, "set io queue depth, should >= 2 and < 4096");
112 
113 static struct quirk_entry *nvme_pci_quirk_list;
114 static unsigned int nvme_pci_quirk_count;
115 
116 /* Helper to parse individual quirk names */
117 static int nvme_parse_quirk_names(char *quirk_str, struct quirk_entry *entry)
118 {
119 	int i;
120 	size_t field_len;
121 	bool disabled, found;
122 	char *p = quirk_str, *field;
123 
124 	while ((field = strsep(&p, ",")) && *field) {
125 		disabled = false;
126 		found = false;
127 
128 		if (*field == '^') {
129 			/* Skip the '^' character */
130 			disabled = true;
131 			field++;
132 		}
133 
134 		field_len = strlen(field);
135 		for (i = 0; i < 32; i++) {
136 			unsigned int bit = 1U << i;
137 			char *q_name = nvme_quirk_name(bit);
138 			size_t q_len = strlen(q_name);
139 
140 			if (!strcmp(q_name, "unknown"))
141 				break;
142 
143 			if (!strcmp(q_name, field) &&
144 				    q_len == field_len) {
145 				if (disabled)
146 					entry->disabled_quirks |= bit;
147 				else
148 					entry->enabled_quirks |= bit;
149 				found = true;
150 				break;
151 			}
152 		}
153 
154 		if (!found) {
155 			pr_err("nvme: unrecognized quirk %s\n", field);
156 			return -EINVAL;
157 		}
158 	}
159 	return 0;
160 }
161 
162 /* Helper to parse a single VID:DID:quirk_names entry */
163 static int nvme_parse_quirk_entry(char *s, struct quirk_entry *entry)
164 {
165 	char *field;
166 
167 	field = strsep(&s, ":");
168 	if (!field || kstrtou16(field, 16, &entry->vendor_id))
169 		return -EINVAL;
170 
171 	field = strsep(&s, ":");
172 	if (!field || kstrtou16(field, 16, &entry->dev_id))
173 		return -EINVAL;
174 
175 	field = strsep(&s, ":");
176 	if (!field)
177 		return -EINVAL;
178 
179 	return nvme_parse_quirk_names(field, entry);
180 }
181 
182 static int quirks_param_set(const char *value, const struct kernel_param *kp)
183 {
184 	int count, err, i;
185 	struct quirk_entry *qlist;
186 	char *field, *val, *sep_ptr;
187 
188 	err = param_set_copystring(value, kp);
189 	if (err)
190 		return err;
191 
192 	val = kstrdup(value, GFP_KERNEL);
193 	if (!val)
194 		return -ENOMEM;
195 
196 	if (!*val)
197 		goto out_free_val;
198 
199 	count = 1;
200 	for (i = 0; val[i]; i++) {
201 		if (val[i] == '-')
202 			count++;
203 	}
204 
205 	qlist = kzalloc_objs(*qlist, count);
206 	if (!qlist) {
207 		err = -ENOMEM;
208 		goto out_free_val;
209 	}
210 
211 	i = 0;
212 	sep_ptr = val;
213 	while ((field = strsep(&sep_ptr, "-"))) {
214 		if (nvme_parse_quirk_entry(field, &qlist[i])) {
215 			pr_err("nvme: failed to parse quirk string %s\n",
216 				value);
217 			err = -EINVAL;
218 			goto out_free_qlist;
219 		}
220 
221 		i++;
222 	}
223 
224 	kfree(nvme_pci_quirk_list);
225 	nvme_pci_quirk_count = count;
226 	nvme_pci_quirk_list  = qlist;
227 	goto out_free_val;
228 
229 out_free_qlist:
230 	kfree(qlist);
231 out_free_val:
232 	kfree(val);
233 	return err;
234 }
235 
236 static char quirks_param[256];
237 static const struct kernel_param_ops quirks_param_ops = {
238 	.set = quirks_param_set,
239 	.get = param_get_string,
240 };
241 
242 static struct kparam_string quirks_param_string = {
243 	.maxlen = sizeof(quirks_param),
244 	.string = quirks_param,
245 };
246 
247 device_param_cb(quirks, &quirks_param_ops, &quirks_param_string, 0444);
248 MODULE_PARM_DESC(quirks, "Enable/disable NVMe quirks by specifying "
249 						"quirks=VID:DID:quirk_names");
250 
251 static int io_queue_count_set(const char *val, const struct kernel_param *kp)
252 {
253 	unsigned int n;
254 	int ret;
255 
256 	ret = kstrtouint(val, 10, &n);
257 	if (ret != 0 || n > blk_mq_num_possible_queues(0))
258 		return -EINVAL;
259 	return param_set_uint(val, kp);
260 }
261 
262 static const struct kernel_param_ops io_queue_count_ops = {
263 	.set = io_queue_count_set,
264 	.get = param_get_uint,
265 };
266 
267 static unsigned int write_queues;
268 module_param_cb(write_queues, &io_queue_count_ops, &write_queues, 0644);
269 MODULE_PARM_DESC(write_queues,
270 	"Number of queues to use for writes. If not set, reads and writes "
271 	"will share a queue set.");
272 
273 static unsigned int poll_queues;
274 module_param_cb(poll_queues, &io_queue_count_ops, &poll_queues, 0644);
275 MODULE_PARM_DESC(poll_queues, "Number of queues to use for polled IO.");
276 
277 static bool noacpi;
278 module_param(noacpi, bool, 0444);
279 MODULE_PARM_DESC(noacpi, "disable acpi bios quirks");
280 
281 struct nvme_dev;
282 struct nvme_queue;
283 
284 static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown);
285 static void nvme_delete_io_queues(struct nvme_dev *dev);
286 static void nvme_update_attrs(struct nvme_dev *dev);
287 
288 struct nvme_descriptor_pools {
289 	struct dma_pool *large;
290 	struct dma_pool *small;
291 };
292 
293 /*
294  * Represents an NVM Express device.  Each nvme_dev is a PCI function.
295  */
296 struct nvme_dev {
297 	struct nvme_queue *queues;
298 	struct blk_mq_tag_set tagset;
299 	struct blk_mq_tag_set admin_tagset;
300 	u32 __iomem *dbs;
301 	struct device *dev;
302 	unsigned online_queues;
303 	unsigned max_qid;
304 	unsigned io_queues[HCTX_MAX_TYPES];
305 	unsigned int num_vecs;
306 	u32 q_depth;
307 	int io_sqes;
308 	u32 db_stride;
309 	void __iomem *bar;
310 	unsigned long bar_mapped_size;
311 	struct mutex shutdown_lock;
312 	bool subsystem;
313 	u64 cmb_size;
314 	bool cmb_use_sqes;
315 	u32 cmbsz;
316 	u32 cmbloc;
317 	struct nvme_ctrl ctrl;
318 	u32 last_ps;
319 	bool hmb;
320 	struct sg_table *hmb_sgt;
321 	mempool_t *dmavec_mempool;
322 	struct nvme_dma_buf_list dmabufs;
323 
324 	/* shadow doorbell buffer support: */
325 	__le32 *dbbuf_dbs;
326 	dma_addr_t dbbuf_dbs_dma_addr;
327 	__le32 *dbbuf_eis;
328 	dma_addr_t dbbuf_eis_dma_addr;
329 
330 	/* host memory buffer support: */
331 	u64 host_mem_size;
332 	u32 nr_host_mem_descs;
333 	u32 host_mem_descs_size;
334 	dma_addr_t host_mem_descs_dma;
335 	struct nvme_host_mem_buf_desc *host_mem_descs;
336 	void **host_mem_desc_bufs;
337 	unsigned int nr_allocated_queues;
338 	unsigned int nr_write_queues;
339 	unsigned int nr_poll_queues;
340 	struct nvme_descriptor_pools descriptor_pools[];
341 };
342 
343 static int io_queue_depth_set(const char *val, const struct kernel_param *kp)
344 {
345 	return param_set_uint_minmax(val, kp, NVME_PCI_MIN_QUEUE_SIZE,
346 			NVME_PCI_MAX_QUEUE_SIZE);
347 }
348 
349 static inline unsigned int sq_idx(unsigned int qid, u32 stride)
350 {
351 	return qid * 2 * stride;
352 }
353 
354 static inline unsigned int cq_idx(unsigned int qid, u32 stride)
355 {
356 	return (qid * 2 + 1) * stride;
357 }
358 
359 static inline struct nvme_dev *to_nvme_dev(struct nvme_ctrl *ctrl)
360 {
361 	return container_of(ctrl, struct nvme_dev, ctrl);
362 }
363 
364 /*
365  * An NVM Express queue.  Each device has at least two (one for admin
366  * commands and one for I/O commands).
367  */
368 struct nvme_queue {
369 	struct nvme_dev *dev;
370 	struct nvme_descriptor_pools descriptor_pools;
371 	spinlock_t sq_lock;
372 	void *sq_cmds
373 		__guarded_by(&sq_lock);
374 	 /* only used for poll queues: */
375 	spinlock_t cq_poll_lock ____cacheline_aligned_in_smp;
376 	struct nvme_completion *cqes;
377 	dma_addr_t sq_dma_addr;
378 	dma_addr_t cq_dma_addr;
379 	u32 __iomem *q_db;
380 	u32 q_depth;
381 	u16 cq_vector;
382 	u16 cq_head;
383 	u16 sq_tail
384 		__guarded_by(&sq_lock);
385 	u16 last_sq_tail
386 		__guarded_by(&sq_lock);
387 	u16 qid;
388 	u8 cq_phase;
389 	u8 sqes;
390 	unsigned long flags;
391 #define NVMEQ_ENABLED		0
392 #define NVMEQ_SQ_CMB		1
393 #define NVMEQ_DELETE_ERROR	2
394 #define NVMEQ_POLLED		3
395 	__le32 *dbbuf_sq_db;
396 	__le32 *dbbuf_cq_db;
397 	__le32 *dbbuf_sq_ei;
398 	__le32 *dbbuf_cq_ei;
399 	struct completion delete_done;
400 };
401 
402 /* bits for iod->flags */
403 enum nvme_iod_flags {
404 	/* this command has been aborted by the timeout handler */
405 	IOD_ABORTED		= 1U << 0,
406 
407 	/* uses the small descriptor pool */
408 	IOD_SMALL_DESCRIPTOR	= 1U << 1,
409 
410 	/* single segment dma mapping */
411 	IOD_SINGLE_SEGMENT	= 1U << 2,
412 
413 	/* Data payload contains p2p memory */
414 	IOD_DATA_P2P		= 1U << 3,
415 
416 	/* Metadata contains p2p memory */
417 	IOD_META_P2P		= 1U << 4,
418 
419 	/* Data payload contains MMIO memory */
420 	IOD_DATA_MMIO		= 1U << 5,
421 
422 	/* Metadata contains MMIO memory */
423 	IOD_META_MMIO		= 1U << 6,
424 
425 	/* Metadata using non-coalesced MPTR */
426 	IOD_SINGLE_META_SEGMENT	= 1U << 7,
427 };
428 
429 struct nvme_dma_vec {
430 	dma_addr_t addr;
431 	unsigned int len;
432 };
433 
434 /*
435  * The nvme_iod describes the data in an I/O.
436  */
437 struct nvme_iod {
438 	struct nvme_request req;
439 	struct nvme_command cmd;
440 	u8 flags;
441 	u8 nr_descriptors;
442 
443 	size_t total_len;
444 	struct dma_iova_state dma_state;
445 	void *descriptors[NVME_MAX_NR_DESCRIPTORS];
446 	struct nvme_dma_vec *dma_vecs;
447 	unsigned int nr_dma_vecs;
448 
449 	dma_addr_t meta_dma;
450 	size_t meta_total_len;
451 	struct dma_iova_state meta_dma_state;
452 	struct nvme_sgl_desc *meta_descriptor;
453 };
454 
455 static inline unsigned int nvme_dbbuf_size(struct nvme_dev *dev)
456 {
457 	return dev->nr_allocated_queues * 8 * dev->db_stride;
458 }
459 
460 static void nvme_dbbuf_dma_alloc(struct nvme_dev *dev)
461 {
462 	unsigned int mem_size = nvme_dbbuf_size(dev);
463 
464 	if (!(dev->ctrl.oacs & NVME_CTRL_OACS_DBBUF_SUPP))
465 		return;
466 
467 	if (dev->dbbuf_dbs) {
468 		/*
469 		 * Clear the dbbuf memory so the driver doesn't observe stale
470 		 * values from the previous instantiation.
471 		 */
472 		memset(dev->dbbuf_dbs, 0, mem_size);
473 		memset(dev->dbbuf_eis, 0, mem_size);
474 		return;
475 	}
476 
477 	dev->dbbuf_dbs = dma_alloc_coherent(dev->dev, mem_size,
478 					    &dev->dbbuf_dbs_dma_addr,
479 					    GFP_KERNEL);
480 	if (!dev->dbbuf_dbs)
481 		goto fail;
482 	dev->dbbuf_eis = dma_alloc_coherent(dev->dev, mem_size,
483 					    &dev->dbbuf_eis_dma_addr,
484 					    GFP_KERNEL);
485 	if (!dev->dbbuf_eis)
486 		goto fail_free_dbbuf_dbs;
487 	return;
488 
489 fail_free_dbbuf_dbs:
490 	dma_free_coherent(dev->dev, mem_size, dev->dbbuf_dbs,
491 			  dev->dbbuf_dbs_dma_addr);
492 	dev->dbbuf_dbs = NULL;
493 fail:
494 	dev_warn(dev->dev, "unable to allocate dma for dbbuf\n");
495 }
496 
497 static void nvme_dbbuf_dma_free(struct nvme_dev *dev)
498 {
499 	unsigned int mem_size = nvme_dbbuf_size(dev);
500 
501 	if (dev->dbbuf_dbs) {
502 		dma_free_coherent(dev->dev, mem_size,
503 				  dev->dbbuf_dbs, dev->dbbuf_dbs_dma_addr);
504 		dev->dbbuf_dbs = NULL;
505 	}
506 	if (dev->dbbuf_eis) {
507 		dma_free_coherent(dev->dev, mem_size,
508 				  dev->dbbuf_eis, dev->dbbuf_eis_dma_addr);
509 		dev->dbbuf_eis = NULL;
510 	}
511 }
512 
513 static void nvme_dbbuf_init(struct nvme_dev *dev,
514 			    struct nvme_queue *nvmeq, int qid)
515 {
516 	if (!dev->dbbuf_dbs || !qid)
517 		return;
518 
519 	nvmeq->dbbuf_sq_db = &dev->dbbuf_dbs[sq_idx(qid, dev->db_stride)];
520 	nvmeq->dbbuf_cq_db = &dev->dbbuf_dbs[cq_idx(qid, dev->db_stride)];
521 	nvmeq->dbbuf_sq_ei = &dev->dbbuf_eis[sq_idx(qid, dev->db_stride)];
522 	nvmeq->dbbuf_cq_ei = &dev->dbbuf_eis[cq_idx(qid, dev->db_stride)];
523 }
524 
525 static void nvme_dbbuf_free(struct nvme_queue *nvmeq)
526 {
527 	if (!nvmeq->qid)
528 		return;
529 
530 	nvmeq->dbbuf_sq_db = NULL;
531 	nvmeq->dbbuf_cq_db = NULL;
532 	nvmeq->dbbuf_sq_ei = NULL;
533 	nvmeq->dbbuf_cq_ei = NULL;
534 }
535 
536 static void nvme_dbbuf_set(struct nvme_dev *dev)
537 {
538 	struct nvme_command c = { };
539 	unsigned int i;
540 
541 	if (!dev->dbbuf_dbs)
542 		return;
543 
544 	c.dbbuf.opcode = nvme_admin_dbbuf;
545 	c.dbbuf.prp1 = cpu_to_le64(dev->dbbuf_dbs_dma_addr);
546 	c.dbbuf.prp2 = cpu_to_le64(dev->dbbuf_eis_dma_addr);
547 
548 	if (nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0)) {
549 		dev_warn(dev->ctrl.device, "unable to set dbbuf\n");
550 		/* Free memory and continue on */
551 		nvme_dbbuf_dma_free(dev);
552 
553 		for (i = 1; i < dev->online_queues; i++)
554 			nvme_dbbuf_free(&dev->queues[i]);
555 	}
556 }
557 
558 static inline int nvme_dbbuf_need_event(u16 event_idx, u16 new_idx, u16 old)
559 {
560 	return (u16)(new_idx - event_idx - 1) < (u16)(new_idx - old);
561 }
562 
563 /* Update dbbuf and return true if an MMIO is required */
564 static bool nvme_dbbuf_update_and_check_event(u16 value, __le32 *dbbuf_db,
565 					      volatile __le32 *dbbuf_ei)
566 {
567 	if (dbbuf_db) {
568 		u16 old_value, event_idx;
569 
570 		/*
571 		 * Ensure that the queue is written before updating
572 		 * the doorbell in memory
573 		 */
574 		wmb();
575 
576 		old_value = le32_to_cpu(*dbbuf_db);
577 		*dbbuf_db = cpu_to_le32(value);
578 
579 		/*
580 		 * Ensure that the doorbell is updated before reading the event
581 		 * index from memory.  The controller needs to provide similar
582 		 * ordering to ensure the event index is updated before reading
583 		 * the doorbell.
584 		 */
585 		mb();
586 
587 		event_idx = le32_to_cpu(*dbbuf_ei);
588 		if (!nvme_dbbuf_need_event(event_idx, value, old_value))
589 			return false;
590 	}
591 
592 	return true;
593 }
594 
595 static struct nvme_descriptor_pools *
596 nvme_setup_descriptor_pools(struct nvme_dev *dev, int numa_node)
597 {
598 	struct nvme_descriptor_pools *pools;
599 	size_t small_align = NVME_SMALL_POOL_SIZE;
600 
601 	if (numa_node == NUMA_NO_NODE)
602 		numa_node = 0;
603 
604 	pools = &dev->descriptor_pools[numa_node];
605 
606 	if (pools->small)
607 		return pools; /* already initialized */
608 
609 	pools->large = dma_pool_create_node("nvme descriptor page", dev->dev,
610 			NVME_CTRL_PAGE_SIZE, NVME_CTRL_PAGE_SIZE, 0, numa_node);
611 	if (!pools->large)
612 		return ERR_PTR(-ENOMEM);
613 
614 	if (dev->ctrl.quirks & NVME_QUIRK_DMAPOOL_ALIGN_512)
615 		small_align = 512;
616 
617 	pools->small = dma_pool_create_node("nvme descriptor small", dev->dev,
618 			NVME_SMALL_POOL_SIZE, small_align, 0, numa_node);
619 	if (!pools->small) {
620 		dma_pool_destroy(pools->large);
621 		pools->large = NULL;
622 		return ERR_PTR(-ENOMEM);
623 	}
624 
625 	return pools;
626 }
627 
628 static void nvme_release_descriptor_pools(struct nvme_dev *dev)
629 {
630 	unsigned i;
631 
632 	for (i = 0; i < nr_node_ids; i++) {
633 		struct nvme_descriptor_pools *pools = &dev->descriptor_pools[i];
634 
635 		dma_pool_destroy(pools->large);
636 		dma_pool_destroy(pools->small);
637 	}
638 }
639 
640 static int nvme_init_hctx_common(struct blk_mq_hw_ctx *hctx, void *data,
641 		unsigned qid)
642 {
643 	struct nvme_dev *dev = to_nvme_dev(data);
644 	struct nvme_queue *nvmeq = &dev->queues[qid];
645 	struct nvme_descriptor_pools *pools;
646 	struct blk_mq_tags *tags;
647 
648 	tags = qid ? dev->tagset.tags[qid - 1] : dev->admin_tagset.tags[0];
649 	WARN_ON(tags != hctx->tags);
650 	pools = nvme_setup_descriptor_pools(dev, hctx->numa_node);
651 	if (IS_ERR(pools))
652 		return PTR_ERR(pools);
653 
654 	nvmeq->descriptor_pools = *pools;
655 	hctx->driver_data = nvmeq;
656 	return 0;
657 }
658 
659 static int nvme_admin_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
660 				unsigned int hctx_idx)
661 {
662 	WARN_ON(hctx_idx != 0);
663 	return nvme_init_hctx_common(hctx, data, 0);
664 }
665 
666 static int nvme_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
667 			     unsigned int hctx_idx)
668 {
669 	return nvme_init_hctx_common(hctx, data, hctx_idx + 1);
670 }
671 
672 static int nvme_pci_init_request(struct blk_mq_tag_set *set,
673 		struct request *req, unsigned int hctx_idx,
674 		int numa_node)
675 {
676 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
677 
678 	nvme_req(req)->ctrl = set->driver_data;
679 	nvme_req(req)->cmd = &iod->cmd;
680 	return 0;
681 }
682 
683 static int queue_irq_offset(struct nvme_dev *dev)
684 {
685 	/* if we have more than 1 vec, admin queue offsets us by 1 */
686 	if (dev->num_vecs > 1)
687 		return 1;
688 
689 	return 0;
690 }
691 
692 static void nvme_pci_map_queues(struct blk_mq_tag_set *set)
693 {
694 	struct nvme_dev *dev = to_nvme_dev(set->driver_data);
695 	int i, qoff, offset;
696 
697 	offset = queue_irq_offset(dev);
698 	for (i = 0, qoff = 0; i < set->nr_maps; i++) {
699 		struct blk_mq_queue_map *map = &set->map[i];
700 
701 		map->nr_queues = dev->io_queues[i];
702 		if (!map->nr_queues) {
703 			BUG_ON(i == HCTX_TYPE_DEFAULT);
704 			continue;
705 		}
706 
707 		/*
708 		 * The poll queue(s) doesn't have an IRQ (and hence IRQ
709 		 * affinity), so use the regular blk-mq cpu mapping
710 		 */
711 		map->queue_offset = qoff;
712 		if (i != HCTX_TYPE_POLL && offset)
713 			blk_mq_map_hw_queues(map, dev->dev, offset);
714 		else
715 			blk_mq_map_queues(map);
716 		qoff += map->nr_queues;
717 		offset += map->nr_queues;
718 	}
719 }
720 
721 /*
722  * Write sq tail if we are asked to, or if the next command would wrap.
723  */
724 static inline void nvme_write_sq_db(struct nvme_queue *nvmeq, bool write_sq)
725 	__must_hold(&nvmeq->sq_lock)
726 {
727 	if (!write_sq) {
728 		u16 next_tail = nvmeq->sq_tail + 1;
729 
730 		if (next_tail == nvmeq->q_depth)
731 			next_tail = 0;
732 		if (next_tail != nvmeq->last_sq_tail)
733 			return;
734 	}
735 
736 	if (nvme_dbbuf_update_and_check_event(nvmeq->sq_tail,
737 			nvmeq->dbbuf_sq_db, nvmeq->dbbuf_sq_ei))
738 		writel(nvmeq->sq_tail, nvmeq->q_db);
739 	nvmeq->last_sq_tail = nvmeq->sq_tail;
740 }
741 
742 static inline void nvme_sq_copy_cmd(struct nvme_queue *nvmeq,
743 				    struct nvme_command *cmd)
744 	__must_hold(&nvmeq->sq_lock)
745 {
746 	memcpy(nvmeq->sq_cmds + (nvmeq->sq_tail << nvmeq->sqes),
747 		absolute_pointer(cmd), sizeof(*cmd));
748 	if (++nvmeq->sq_tail == nvmeq->q_depth)
749 		nvmeq->sq_tail = 0;
750 }
751 
752 static void nvme_commit_rqs(struct blk_mq_hw_ctx *hctx)
753 {
754 	struct nvme_queue *nvmeq = hctx->driver_data;
755 
756 	spin_lock(&nvmeq->sq_lock);
757 	if (nvmeq->sq_tail != nvmeq->last_sq_tail)
758 		nvme_write_sq_db(nvmeq, true);
759 	spin_unlock(&nvmeq->sq_lock);
760 }
761 
762 enum nvme_use_sgl {
763 	SGL_UNSUPPORTED,
764 	SGL_SUPPORTED,
765 	SGL_FORCED,
766 };
767 
768 static inline bool nvme_pci_metadata_use_sgls(struct request *req)
769 {
770 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
771 	struct nvme_dev *dev = nvmeq->dev;
772 
773 	if (!nvme_ctrl_meta_sgl_supported(&dev->ctrl))
774 		return false;
775 	return req->nr_integrity_segments > 1 ||
776 		nvme_req(req)->flags & NVME_REQ_USERCMD;
777 }
778 
779 static inline enum nvme_use_sgl nvme_pci_use_sgls(struct nvme_dev *dev,
780 		struct request *req)
781 {
782 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
783 
784 	if (nvmeq->qid && nvme_ctrl_sgl_supported(&dev->ctrl)) {
785 		/*
786 		 * When the controller is capable of using SGL, there are
787 		 * several conditions that we force to use it:
788 		 *
789 		 * 1. A request containing page gaps within the controller's
790 		 *    mask can not use the PRP format.
791 		 *
792 		 * 2. User commands use SGL because that lets the device
793 		 *    validate the requested transfer lengths.
794 		 *
795 		 * 3. Multiple integrity segments must use SGL as that's the
796 		 *    only way to describe such a command in NVMe.
797 		 */
798 		if (req_phys_gap_mask(req) & (NVME_CTRL_PAGE_SIZE - 1) ||
799 		    nvme_req(req)->flags & NVME_REQ_USERCMD ||
800 		    req->nr_integrity_segments > 1)
801 			return SGL_FORCED;
802 		return SGL_SUPPORTED;
803 	}
804 
805 	return SGL_UNSUPPORTED;
806 }
807 
808 static unsigned int nvme_pci_avg_seg_size(struct request *req)
809 {
810 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
811 	unsigned int nseg;
812 
813 	if (blk_rq_dma_map_coalesce(&iod->dma_state))
814 		nseg = 1;
815 	else
816 		nseg = blk_rq_nr_phys_segments(req);
817 	return DIV_ROUND_UP(blk_rq_payload_bytes(req), nseg);
818 }
819 
820 static inline struct dma_pool *nvme_dma_pool(struct nvme_queue *nvmeq,
821 		struct nvme_iod *iod)
822 {
823 	if (iod->flags & IOD_SMALL_DESCRIPTOR)
824 		return nvmeq->descriptor_pools.small;
825 	return nvmeq->descriptor_pools.large;
826 }
827 
828 static inline bool nvme_pci_cmd_use_meta_sgl(struct nvme_command *cmd)
829 {
830 	return (cmd->common.flags & NVME_CMD_SGL_ALL) == NVME_CMD_SGL_METASEG;
831 }
832 
833 static inline bool nvme_pci_cmd_use_sgl(struct nvme_command *cmd)
834 {
835 	return cmd->common.flags &
836 		(NVME_CMD_SGL_METABUF | NVME_CMD_SGL_METASEG);
837 }
838 
839 static inline dma_addr_t nvme_pci_first_desc_dma_addr(struct nvme_command *cmd)
840 {
841 	if (nvme_pci_cmd_use_sgl(cmd))
842 		return le64_to_cpu(cmd->common.dptr.sgl.addr);
843 	return le64_to_cpu(cmd->common.dptr.prp2);
844 }
845 
846 static void nvme_free_descriptors(struct request *req)
847 {
848 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
849 	const int last_prp = NVME_CTRL_PAGE_SIZE / sizeof(__le64) - 1;
850 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
851 	dma_addr_t dma_addr = nvme_pci_first_desc_dma_addr(&iod->cmd);
852 	int i;
853 
854 	if (iod->nr_descriptors == 1) {
855 		dma_pool_free(nvme_dma_pool(nvmeq, iod), iod->descriptors[0],
856 				dma_addr);
857 		return;
858 	}
859 
860 	for (i = 0; i < iod->nr_descriptors; i++) {
861 		__le64 *prp_list = iod->descriptors[i];
862 		dma_addr_t next_dma_addr = le64_to_cpu(prp_list[last_prp]);
863 
864 		dma_pool_free(nvmeq->descriptor_pools.large, prp_list,
865 				dma_addr);
866 		dma_addr = next_dma_addr;
867 	}
868 }
869 
870 static blk_status_t nvme_rq_setup_dmabuf_map(struct request *req,
871 		struct nvme_queue *nvmeq)
872 {
873 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
874 	struct nvme_dmabuf_map *map = nvme_req_to_map(req);
875 	unsigned bvec_done = req->bio->bi_iter.bi_offset;
876 	unsigned map_idx = bvec_done / NVME_CTRL_PAGE_SIZE;
877 	unsigned offset = bvec_done & (NVME_CTRL_PAGE_SIZE - 1);
878 	int length = blk_rq_payload_bytes(req) - (NVME_CTRL_PAGE_SIZE - offset);
879 	dma_addr_t *dma_list = map->dma_list;
880 	u64 prp1_dma = dma_list[map_idx++] + offset;
881 	u64 dma_addr, prp2_dma;
882 	dma_addr_t prp_dma;
883 	__le64 *prp_list;
884 	unsigned i;
885 
886 	if (length <= 0) {
887 		prp2_dma = 0;
888 		goto done;
889 	}
890 
891 	if (length <= NVME_CTRL_PAGE_SIZE) {
892 		prp2_dma = dma_list[map_idx];
893 		goto done;
894 	}
895 
896 	if (DIV_ROUND_UP(length, NVME_CTRL_PAGE_SIZE) <=
897 	    NVME_SMALL_POOL_SIZE / sizeof(__le64))
898 		iod->flags |= IOD_SMALL_DESCRIPTOR;
899 
900 	prp_list = dma_pool_alloc(nvme_dma_pool(nvmeq, iod), GFP_ATOMIC,
901 			&prp_dma);
902 	if (!prp_list)
903 		return BLK_STS_RESOURCE;
904 
905 	iod->descriptors[iod->nr_descriptors++] = prp_list;
906 	prp2_dma = prp_dma;
907 	i = 0;
908 	for (;;) {
909 		if (i == NVME_CTRL_PAGE_SIZE >> 3) {
910 			__le64 *old_prp_list = prp_list;
911 
912 			prp_list = dma_pool_alloc(nvmeq->descriptor_pools.large,
913 					GFP_ATOMIC, &prp_dma);
914 			if (!prp_list)
915 				goto free_prps;
916 			iod->descriptors[iod->nr_descriptors++] = prp_list;
917 			prp_list[0] = old_prp_list[i - 1];
918 			old_prp_list[i - 1] = cpu_to_le64(prp_dma);
919 			i = 1;
920 		}
921 
922 		dma_addr = dma_list[map_idx++];
923 		prp_list[i++] = cpu_to_le64(dma_addr);
924 
925 		length -= NVME_CTRL_PAGE_SIZE;
926 		if (length <= 0)
927 			break;
928 	}
929 done:
930 	iod->cmd.common.dptr.prp1 = cpu_to_le64(prp1_dma);
931 	iod->cmd.common.dptr.prp2 = cpu_to_le64(prp2_dma);
932 	return BLK_STS_OK;
933 free_prps:
934 	iod->cmd.common.dptr.prp1 = cpu_to_le64(prp1_dma);
935 	iod->cmd.common.dptr.prp2 = cpu_to_le64(prp2_dma);
936 	nvme_free_descriptors(req);
937 	return BLK_STS_RESOURCE;
938 }
939 
940 static void nvme_free_prps(struct request *req, unsigned int attrs)
941 {
942 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
943 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
944 	unsigned int i;
945 
946 	for (i = 0; i < iod->nr_dma_vecs; i++)
947 		dma_unmap_phys(nvmeq->dev->dev, iod->dma_vecs[i].addr,
948 			       iod->dma_vecs[i].len, rq_dma_dir(req), attrs);
949 	mempool_free(iod->dma_vecs, nvmeq->dev->dmavec_mempool);
950 }
951 
952 static void nvme_free_sgls(struct request *req, struct nvme_sgl_desc *sge,
953 		struct nvme_sgl_desc *sg_list, unsigned int attrs)
954 {
955 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
956 	enum dma_data_direction dir = rq_dma_dir(req);
957 	unsigned int len = le32_to_cpu(sge->length);
958 	struct device *dma_dev = nvmeq->dev->dev;
959 	unsigned int i;
960 
961 	if (sge->type == (NVME_SGL_FMT_DATA_DESC << 4)) {
962 		dma_unmap_phys(dma_dev, le64_to_cpu(sge->addr), len, dir,
963 			       attrs);
964 		return;
965 	}
966 
967 	for (i = 0; i < len / sizeof(*sg_list); i++)
968 		dma_unmap_phys(dma_dev, le64_to_cpu(sg_list[i].addr),
969 			le32_to_cpu(sg_list[i].length), dir, attrs);
970 }
971 
972 static void nvme_unmap_metadata(struct request *req)
973 {
974 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
975 	enum pci_p2pdma_map_type map = PCI_P2PDMA_MAP_NONE;
976 	enum dma_data_direction dir = rq_dma_dir(req);
977 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
978 	struct device *dma_dev = nvmeq->dev->dev;
979 	struct nvme_sgl_desc *sge = iod->meta_descriptor;
980 	unsigned int attrs = 0;
981 
982 	if (iod->flags & IOD_SINGLE_META_SEGMENT) {
983 		dma_unmap_page(dma_dev, iod->meta_dma,
984 			       rq_integrity_vec(req).bv_len,
985 			       rq_dma_dir(req));
986 		return;
987 	}
988 
989 	if (iod->flags & IOD_META_P2P)
990 		map = PCI_P2PDMA_MAP_BUS_ADDR;
991 	else if (iod->flags & IOD_META_MMIO) {
992 		map = PCI_P2PDMA_MAP_THRU_HOST_BRIDGE;
993 		attrs |= DMA_ATTR_MMIO;
994 	}
995 
996 	if (!blk_rq_dma_unmap(req, dma_dev, &iod->meta_dma_state,
997 			      iod->meta_total_len, map)) {
998 		if (nvme_pci_cmd_use_meta_sgl(&iod->cmd))
999 			nvme_free_sgls(req, sge, &sge[1], attrs);
1000 		else
1001 			dma_unmap_phys(dma_dev, iod->meta_dma,
1002 				       iod->meta_total_len, dir, attrs);
1003 	}
1004 
1005 	if (iod->meta_descriptor)
1006 		dma_pool_free(nvmeq->descriptor_pools.small,
1007 			      iod->meta_descriptor, iod->meta_dma);
1008 }
1009 
1010 static void nvme_unmap_data(struct request *req)
1011 {
1012 	enum pci_p2pdma_map_type map = PCI_P2PDMA_MAP_NONE;
1013 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1014 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1015 	struct device *dma_dev = nvmeq->dev->dev;
1016 	unsigned int attrs = 0;
1017 
1018 	if (blk_mq_rq_is_dmabuf(req))
1019 		goto out_free_desc;
1020 
1021 	if (iod->flags & IOD_SINGLE_SEGMENT) {
1022 		static_assert(offsetof(union nvme_data_ptr, prp1) ==
1023 				offsetof(union nvme_data_ptr, sgl.addr));
1024 		dma_unmap_page(dma_dev, le64_to_cpu(iod->cmd.common.dptr.prp1),
1025 				iod->total_len, rq_dma_dir(req));
1026 		return;
1027 	}
1028 
1029 	if (iod->flags & IOD_DATA_P2P)
1030 		map = PCI_P2PDMA_MAP_BUS_ADDR;
1031 	else if (iod->flags & IOD_DATA_MMIO) {
1032 		map = PCI_P2PDMA_MAP_THRU_HOST_BRIDGE;
1033 		attrs |= DMA_ATTR_MMIO;
1034 	}
1035 
1036 	if (!blk_rq_dma_unmap(req, dma_dev, &iod->dma_state, iod->total_len,
1037 			      map)) {
1038 		if (nvme_pci_cmd_use_sgl(&iod->cmd))
1039 			nvme_free_sgls(req, &iod->cmd.common.dptr.sgl,
1040 			               iod->descriptors[0], attrs);
1041 		else
1042 			nvme_free_prps(req, attrs);
1043 	}
1044 
1045 out_free_desc:
1046 	if (iod->nr_descriptors)
1047 		nvme_free_descriptors(req);
1048 }
1049 
1050 static bool nvme_pci_prp_save_mapping(struct request *req,
1051 				      struct device *dma_dev,
1052 				      struct blk_dma_iter *iter)
1053 {
1054 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1055 
1056 	if (dma_use_iova(&iod->dma_state) || !dma_need_unmap(dma_dev) ||
1057 	    (iod->flags & IOD_DATA_P2P))
1058 		return true;
1059 
1060 	if (!iod->nr_dma_vecs) {
1061 		struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1062 
1063 		iod->dma_vecs = mempool_alloc(nvmeq->dev->dmavec_mempool,
1064 				GFP_ATOMIC);
1065 		if (!iod->dma_vecs) {
1066 			iter->status = BLK_STS_RESOURCE;
1067 			return false;
1068 		}
1069 	}
1070 
1071 	iod->dma_vecs[iod->nr_dma_vecs].addr = iter->addr;
1072 	iod->dma_vecs[iod->nr_dma_vecs].len = iter->len;
1073 	iod->nr_dma_vecs++;
1074 	return true;
1075 }
1076 
1077 static bool nvme_pci_prp_iter_next(struct request *req, struct device *dma_dev,
1078 		struct blk_dma_iter *iter)
1079 {
1080 	if (iter->len)
1081 		return true;
1082 	if (!blk_rq_dma_map_iter_next(req, dma_dev, iter))
1083 		return false;
1084 	return nvme_pci_prp_save_mapping(req, dma_dev, iter);
1085 }
1086 
1087 static void nvme_unmap_iter(struct request *req, struct blk_dma_iter *iter,
1088 			    struct dma_iova_state *state)
1089 {
1090 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1091 	struct device *dev = nvmeq->dev->dev;
1092 
1093 	if (!blk_rq_dma_unmap(req, dev, state, iter->len, iter->p2pdma.map)) {
1094 		unsigned int attrs = 0;
1095 
1096 		if (iter->p2pdma.map == PCI_P2PDMA_MAP_THRU_HOST_BRIDGE)
1097 			attrs |= DMA_ATTR_MMIO;
1098 
1099 		dma_unmap_phys(dev, iter->addr, iter->len, rq_dma_dir(req),
1100 			       attrs);
1101 	}
1102 }
1103 
1104 static blk_status_t nvme_pci_setup_data_prp(struct request *req,
1105 		struct blk_dma_iter *iter)
1106 {
1107 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1108 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1109 	unsigned int length = blk_rq_payload_bytes(req);
1110 	dma_addr_t prp1_dma, prp2_dma = 0;
1111 	unsigned int prp_len, i;
1112 	__le64 *prp_list;
1113 
1114 	if (!nvme_pci_prp_save_mapping(req, nvmeq->dev->dev, iter)) {
1115 		nvme_unmap_iter(req, iter, &iod->dma_state);
1116 		return iter->status;
1117 	}
1118 
1119 	/*
1120 	 * PRP1 always points to the start of the DMA transfers.
1121 	 *
1122 	 * This is the only PRP (except for the list entries) that could be
1123 	 * non-aligned.
1124 	 */
1125 	prp1_dma = iter->addr;
1126 	prp_len = min(length, NVME_CTRL_PAGE_SIZE -
1127 			(iter->addr & (NVME_CTRL_PAGE_SIZE - 1)));
1128 	iod->total_len += prp_len;
1129 	iter->addr += prp_len;
1130 	iter->len -= prp_len;
1131 	length -= prp_len;
1132 	if (!length)
1133 		goto done;
1134 
1135 	if (!nvme_pci_prp_iter_next(req, nvmeq->dev->dev, iter)) {
1136 		if (WARN_ON_ONCE(!iter->status))
1137 			goto bad_sgl;
1138 		goto done;
1139 	}
1140 
1141 	/*
1142 	 * PRP2 is usually a list, but can point to data if all data to be
1143 	 * transferred fits into PRP1 + PRP2:
1144 	 */
1145 	if (length <= NVME_CTRL_PAGE_SIZE) {
1146 		prp2_dma = iter->addr;
1147 		iod->total_len += length;
1148 		goto done;
1149 	}
1150 
1151 	if (DIV_ROUND_UP(length, NVME_CTRL_PAGE_SIZE) <=
1152 	    NVME_SMALL_POOL_SIZE / sizeof(__le64))
1153 		iod->flags |= IOD_SMALL_DESCRIPTOR;
1154 
1155 	prp_list = dma_pool_alloc(nvme_dma_pool(nvmeq, iod), GFP_ATOMIC,
1156 			&prp2_dma);
1157 	if (!prp_list) {
1158 		iter->status = BLK_STS_RESOURCE;
1159 		goto done;
1160 	}
1161 	iod->descriptors[iod->nr_descriptors++] = prp_list;
1162 
1163 	i = 0;
1164 	for (;;) {
1165 		prp_list[i++] = cpu_to_le64(iter->addr);
1166 		prp_len = min(length, NVME_CTRL_PAGE_SIZE);
1167 		if (WARN_ON_ONCE(iter->len < prp_len))
1168 			goto bad_sgl;
1169 
1170 		iod->total_len += prp_len;
1171 		iter->addr += prp_len;
1172 		iter->len -= prp_len;
1173 		length -= prp_len;
1174 		if (!length)
1175 			break;
1176 
1177 		if (!nvme_pci_prp_iter_next(req, nvmeq->dev->dev, iter)) {
1178 			if (WARN_ON_ONCE(!iter->status))
1179 				goto bad_sgl;
1180 			goto done;
1181 		}
1182 
1183 		/*
1184 		 * If we've filled the entire descriptor, allocate a new that is
1185 		 * pointed to be the last entry in the previous PRP list.  To
1186 		 * accommodate for that move the last actual entry to the new
1187 		 * descriptor.
1188 		 */
1189 		if (i == NVME_CTRL_PAGE_SIZE >> 3) {
1190 			__le64 *old_prp_list = prp_list;
1191 			dma_addr_t prp_list_dma;
1192 
1193 			prp_list = dma_pool_alloc(nvmeq->descriptor_pools.large,
1194 					GFP_ATOMIC, &prp_list_dma);
1195 			if (!prp_list) {
1196 				iter->status = BLK_STS_RESOURCE;
1197 				goto done;
1198 			}
1199 			iod->descriptors[iod->nr_descriptors++] = prp_list;
1200 
1201 			prp_list[0] = old_prp_list[i - 1];
1202 			old_prp_list[i - 1] = cpu_to_le64(prp_list_dma);
1203 			i = 1;
1204 		}
1205 	}
1206 
1207 done:
1208 	/*
1209 	 * nvme_unmap_data uses the DPT field in the SQE to tear down the
1210 	 * mapping, so initialize it even for failures.
1211 	 */
1212 	iod->cmd.common.dptr.prp1 = cpu_to_le64(prp1_dma);
1213 	iod->cmd.common.dptr.prp2 = cpu_to_le64(prp2_dma);
1214 	if (unlikely(iter->status))
1215 		nvme_unmap_data(req);
1216 	return iter->status;
1217 
1218 bad_sgl:
1219 	dev_err_once(nvmeq->dev->dev,
1220 		"Incorrectly formed request for payload:%d nents:%d\n",
1221 		blk_rq_payload_bytes(req), blk_rq_nr_phys_segments(req));
1222 	nvme_unmap_data(req);
1223 	return BLK_STS_IOERR;
1224 }
1225 
1226 static void nvme_pci_sgl_set_data(struct nvme_sgl_desc *sge,
1227 		dma_addr_t addr, u32 len)
1228 {
1229 	sge->addr = cpu_to_le64(addr);
1230 	sge->length = cpu_to_le32(len);
1231 	sge->type = NVME_SGL_FMT_DATA_DESC << 4;
1232 }
1233 
1234 static void nvme_pci_dma_iter_set_sgl(struct nvme_sgl_desc *sge,
1235 		struct blk_dma_iter *iter)
1236 {
1237 	nvme_pci_sgl_set_data(sge, iter->addr, iter->len);
1238 }
1239 
1240 static void nvme_pci_sgl_set_seg(struct nvme_sgl_desc *sge,
1241 		dma_addr_t dma_addr, int entries)
1242 {
1243 	sge->addr = cpu_to_le64(dma_addr);
1244 	sge->length = cpu_to_le32(entries * sizeof(*sge));
1245 	sge->type = NVME_SGL_FMT_LAST_SEG_DESC << 4;
1246 }
1247 
1248 static unsigned int nvme_pci_dmabuf_sgl_nents(struct request *req)
1249 {
1250 	struct bio *bio = req->bio;
1251 	struct nvme_dmabuf_map *map = to_nvme_dmabuf_map(bio->bi_dmabuf_map);
1252 	struct scatterlist *sg;
1253 	unsigned long tmp;
1254 	size_t offset = bio->bi_iter.bi_offset;
1255 	size_t remaining = blk_rq_payload_bytes(req);
1256 	unsigned int nents = 0;
1257 
1258 	for_each_sgtable_dma_sg(map->sgt, sg, tmp) {
1259 		size_t sg_len = sg_dma_len(sg);
1260 
1261 		if (!remaining)
1262 			break;
1263 		if (offset >= sg_len) {
1264 			offset -= sg_len;
1265 			continue;
1266 		}
1267 
1268 		sg_len -= offset;
1269 		offset = 0;
1270 
1271 		do {
1272 			size_t chunk = min(remaining, sg_len);
1273 
1274 			nents++;
1275 			sg_len -= chunk;
1276 			remaining -= chunk;
1277 		} while (sg_len && remaining);
1278 	}
1279 
1280 	if (unlikely(remaining))
1281 		return 0;
1282 
1283 	return nents;
1284 }
1285 
1286 static blk_status_t nvme_rq_setup_dmabuf_sgl(struct request *req,
1287 		struct nvme_queue *nvmeq, unsigned int entries)
1288 {
1289 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1290 	struct nvme_dmabuf_map *map = nvme_req_to_map(req);
1291 	size_t length = blk_rq_payload_bytes(req);
1292 	struct nvme_sgl_desc *sg_list = &iod->cmd.common.dptr.sgl;
1293 	size_t offset = req->bio->bi_iter.bi_offset;
1294 	bool pooled = entries > 1;
1295 	dma_addr_t sgl_dma = 0;
1296 	unsigned int mapped = 0;
1297 	unsigned long tmp;
1298 	struct scatterlist *sg;
1299 	size_t remaining = length;
1300 
1301 	if (!entries)
1302 		return BLK_STS_IOERR;
1303 
1304 	iod->cmd.common.flags = NVME_CMD_SGL_METABUF;
1305 	iod->total_len = length;
1306 
1307 	/* entries == 1 fits in the inline descriptor; more needs a pool. */
1308 	if (pooled) {
1309 		if (entries <= NVME_SMALL_POOL_SIZE / sizeof(*sg_list))
1310 			iod->flags |= IOD_SMALL_DESCRIPTOR;
1311 
1312 		sg_list = dma_pool_alloc(nvme_dma_pool(nvmeq, iod), GFP_ATOMIC,
1313 					 &sgl_dma);
1314 		if (!sg_list)
1315 			return BLK_STS_RESOURCE;
1316 		iod->descriptors[iod->nr_descriptors++] = sg_list;
1317 	}
1318 
1319 	for_each_sgtable_dma_sg(map->sgt, sg, tmp) {
1320 		size_t sg_len = sg_dma_len(sg);
1321 		dma_addr_t addr = sg_dma_address(sg);
1322 
1323 		if (!remaining)
1324 			break;
1325 		if (offset >= sg_len) {
1326 			offset -= sg_len;
1327 			continue;
1328 		}
1329 
1330 		addr += offset;
1331 		sg_len -= offset;
1332 		offset = 0;
1333 
1334 		do {
1335 			u32 chunk = min_t(size_t, remaining, sg_len);
1336 
1337 			if (WARN_ON_ONCE(mapped == entries))
1338 				goto err_free;
1339 			nvme_pci_sgl_set_data(&sg_list[mapped++], addr, chunk);
1340 
1341 			addr += chunk;
1342 			sg_len -= chunk;
1343 			remaining -= chunk;
1344 		} while (sg_len && remaining);
1345 	}
1346 
1347 	if (unlikely(remaining))
1348 		goto err_free;
1349 
1350 	if (pooled)
1351 		nvme_pci_sgl_set_seg(&iod->cmd.common.dptr.sgl, sgl_dma,
1352 				     mapped);
1353 	return BLK_STS_OK;
1354 err_free:
1355 	if (pooled) {
1356 		iod->nr_descriptors--;
1357 		dma_pool_free(nvme_dma_pool(nvmeq, iod), sg_list, sgl_dma);
1358 	}
1359 	return BLK_STS_IOERR;
1360 }
1361 
1362 static blk_status_t nvme_rq_setup_dmabuf(struct request *req,
1363 		struct nvme_queue *nvmeq, enum nvme_use_sgl use_sgl)
1364 {
1365 	unsigned int entries;
1366 	size_t avg_seg;
1367 
1368 	if (use_sgl == SGL_UNSUPPORTED)
1369 		return nvme_rq_setup_dmabuf_map(req, nvmeq);
1370 
1371 	entries = nvme_pci_dmabuf_sgl_nents(req);
1372 
1373 	if (use_sgl == SGL_FORCED)
1374 		return nvme_rq_setup_dmabuf_sgl(req, nvmeq, entries);
1375 
1376 	avg_seg = entries ?
1377 		DIV_ROUND_UP(blk_rq_payload_bytes(req), entries) : 0;
1378 	if (sgl_threshold && avg_seg >= sgl_threshold)
1379 		return nvme_rq_setup_dmabuf_sgl(req, nvmeq, entries);
1380 
1381 	return nvme_rq_setup_dmabuf_map(req, nvmeq);
1382 }
1383 
1384 static blk_status_t nvme_pci_setup_data_sgl(struct request *req,
1385 		struct blk_dma_iter *iter)
1386 {
1387 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1388 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1389 	unsigned int entries = blk_rq_nr_phys_segments(req);
1390 	struct nvme_sgl_desc *sg_list;
1391 	dma_addr_t sgl_dma;
1392 	unsigned int mapped = 0;
1393 
1394 	/* set the transfer type as SGL */
1395 	iod->cmd.common.flags = NVME_CMD_SGL_METABUF;
1396 
1397 	if (entries == 1 || blk_rq_dma_map_coalesce(&iod->dma_state)) {
1398 		nvme_pci_dma_iter_set_sgl(&iod->cmd.common.dptr.sgl, iter);
1399 		iod->total_len += iter->len;
1400 		return BLK_STS_OK;
1401 	}
1402 
1403 	if (entries <= NVME_SMALL_POOL_SIZE / sizeof(*sg_list))
1404 		iod->flags |= IOD_SMALL_DESCRIPTOR;
1405 
1406 	sg_list = dma_pool_alloc(nvme_dma_pool(nvmeq, iod), GFP_ATOMIC,
1407 			&sgl_dma);
1408 	if (!sg_list) {
1409 		nvme_unmap_iter(req, iter, &iod->dma_state);
1410 		return BLK_STS_RESOURCE;
1411 	}
1412 
1413 	iod->descriptors[iod->nr_descriptors++] = sg_list;
1414 
1415 	do {
1416 		if (WARN_ON_ONCE(mapped == entries)) {
1417 			iter->status = BLK_STS_IOERR;
1418 			break;
1419 		}
1420 		nvme_pci_dma_iter_set_sgl(&sg_list[mapped++], iter);
1421 		iod->total_len += iter->len;
1422 	} while (blk_rq_dma_map_iter_next(req, nvmeq->dev->dev, iter));
1423 
1424 	nvme_pci_sgl_set_seg(&iod->cmd.common.dptr.sgl, sgl_dma, mapped);
1425 	if (unlikely(iter->status))
1426 		nvme_unmap_data(req);
1427 	return iter->status;
1428 }
1429 
1430 static blk_status_t nvme_pci_setup_data_simple(struct request *req,
1431 		enum nvme_use_sgl use_sgl)
1432 {
1433 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1434 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1435 	struct bio_vec bv = req_bvec(req);
1436 	unsigned int prp1_offset = bv.bv_offset & (NVME_CTRL_PAGE_SIZE - 1);
1437 	bool prp_possible = prp1_offset + bv.bv_len <= NVME_CTRL_PAGE_SIZE * 2;
1438 	dma_addr_t dma_addr;
1439 
1440 	if (!use_sgl && !prp_possible)
1441 		return BLK_STS_AGAIN;
1442 	if (is_pci_p2pdma_page(bv.bv_page))
1443 		return BLK_STS_AGAIN;
1444 
1445 	dma_addr = dma_map_bvec(nvmeq->dev->dev, &bv, rq_dma_dir(req), 0);
1446 	if (dma_mapping_error(nvmeq->dev->dev, dma_addr))
1447 		return BLK_STS_RESOURCE;
1448 	iod->total_len = bv.bv_len;
1449 	iod->flags |= IOD_SINGLE_SEGMENT;
1450 
1451 	if (use_sgl == SGL_FORCED || !prp_possible) {
1452 		iod->cmd.common.flags = NVME_CMD_SGL_METABUF;
1453 		iod->cmd.common.dptr.sgl.addr = cpu_to_le64(dma_addr);
1454 		iod->cmd.common.dptr.sgl.length = cpu_to_le32(bv.bv_len);
1455 		iod->cmd.common.dptr.sgl.type = NVME_SGL_FMT_DATA_DESC << 4;
1456 	} else {
1457 		unsigned int first_prp_len = NVME_CTRL_PAGE_SIZE - prp1_offset;
1458 
1459 		iod->cmd.common.dptr.prp1 = cpu_to_le64(dma_addr);
1460 		iod->cmd.common.dptr.prp2 = 0;
1461 		if (bv.bv_len > first_prp_len)
1462 			iod->cmd.common.dptr.prp2 =
1463 				cpu_to_le64(dma_addr + first_prp_len);
1464 	}
1465 
1466 	return BLK_STS_OK;
1467 }
1468 
1469 static blk_status_t nvme_map_data(struct request *req)
1470 {
1471 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1472 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1473 	struct nvme_dev *dev = nvmeq->dev;
1474 	enum nvme_use_sgl use_sgl = nvme_pci_use_sgls(dev, req);
1475 	struct blk_dma_iter iter;
1476 	blk_status_t ret;
1477 
1478 	if (blk_mq_rq_is_dmabuf(req))
1479 		return nvme_rq_setup_dmabuf(req, nvmeq, use_sgl);
1480 
1481 	/*
1482 	 * Try to skip the DMA iterator for single segment requests, as that
1483 	 * significantly improves performances for small I/O sizes.
1484 	 */
1485 	if (blk_rq_nr_phys_segments(req) == 1) {
1486 		ret = nvme_pci_setup_data_simple(req, use_sgl);
1487 		if (ret != BLK_STS_AGAIN)
1488 			return ret;
1489 	}
1490 
1491 	if (!blk_rq_dma_map_iter_start(req, dev->dev, &iod->dma_state, &iter))
1492 		return iter.status;
1493 
1494 	switch (iter.p2pdma.map) {
1495 	case PCI_P2PDMA_MAP_BUS_ADDR:
1496 		iod->flags |= IOD_DATA_P2P;
1497 		break;
1498 	case PCI_P2PDMA_MAP_THRU_HOST_BRIDGE:
1499 		iod->flags |= IOD_DATA_MMIO;
1500 		break;
1501 	case PCI_P2PDMA_MAP_NONE:
1502 		break;
1503 	default:
1504 		return BLK_STS_RESOURCE;
1505 	}
1506 
1507 	if (use_sgl == SGL_FORCED ||
1508 	    (use_sgl == SGL_SUPPORTED &&
1509 	     (sgl_threshold && nvme_pci_avg_seg_size(req) >= sgl_threshold)))
1510 		return nvme_pci_setup_data_sgl(req, &iter);
1511 	return nvme_pci_setup_data_prp(req, &iter);
1512 }
1513 
1514 static blk_status_t nvme_pci_setup_meta_iter(struct request *req)
1515 {
1516 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1517 	unsigned int entries = req->nr_integrity_segments;
1518 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1519 	struct nvme_dev *dev = nvmeq->dev;
1520 	struct nvme_sgl_desc *sg_list;
1521 	struct blk_dma_iter iter;
1522 	dma_addr_t sgl_dma;
1523 	int i = 0;
1524 
1525 	if (!blk_rq_integrity_dma_map_iter_start(req, dev->dev,
1526 						&iod->meta_dma_state, &iter))
1527 		return iter.status;
1528 
1529 	switch (iter.p2pdma.map) {
1530 	case PCI_P2PDMA_MAP_BUS_ADDR:
1531 		iod->flags |= IOD_META_P2P;
1532 		break;
1533 	case PCI_P2PDMA_MAP_THRU_HOST_BRIDGE:
1534 		iod->flags |= IOD_META_MMIO;
1535 		break;
1536 	case PCI_P2PDMA_MAP_NONE:
1537 		break;
1538 	default:
1539 		return BLK_STS_RESOURCE;
1540 	}
1541 
1542 	if (blk_rq_dma_map_coalesce(&iod->meta_dma_state))
1543 		entries = 1;
1544 
1545 	/*
1546 	 * The NVMe MPTR descriptor has an implicit length that the host and
1547 	 * device must agree on to avoid data/memory corruption. We trust the
1548 	 * kernel allocated correctly based on the format's parameters, so use
1549 	 * the more efficient MPTR to avoid extra dma pool allocations for the
1550 	 * SGL indirection.
1551 	 *
1552 	 * But for user commands, we don't necessarily know what they do, so
1553 	 * the driver can't validate the metadata buffer size. The SGL
1554 	 * descriptor provides an explicit length, so we're relying on that
1555 	 * mechanism to catch any misunderstandings between the application and
1556 	 * device.
1557 	 *
1558 	 * P2P DMA also needs to use the blk_dma_iter method, so mptr setup
1559 	 * leverages this routine when that happens.
1560 	 */
1561 	if (!nvme_ctrl_meta_sgl_supported(&dev->ctrl) ||
1562 	    (entries == 1 && !(nvme_req(req)->flags & NVME_REQ_USERCMD))) {
1563 		iod->cmd.common.metadata = cpu_to_le64(iter.addr);
1564 		iod->meta_total_len = iter.len;
1565 		iod->meta_dma = iter.addr;
1566 		iod->meta_descriptor = NULL;
1567 		return BLK_STS_OK;
1568 	}
1569 
1570 	sg_list = dma_pool_alloc(nvmeq->descriptor_pools.small, GFP_ATOMIC,
1571 			&sgl_dma);
1572 	if (!sg_list) {
1573 		nvme_unmap_iter(req, &iter, &iod->meta_dma_state);
1574 		return BLK_STS_RESOURCE;
1575 	}
1576 
1577 	iod->meta_descriptor = sg_list;
1578 	iod->meta_dma = sgl_dma;
1579 	iod->cmd.common.flags = NVME_CMD_SGL_METASEG;
1580 	iod->cmd.common.metadata = cpu_to_le64(sgl_dma);
1581 	if (entries == 1) {
1582 		iod->meta_total_len = iter.len;
1583 		nvme_pci_dma_iter_set_sgl(sg_list, &iter);
1584 		return BLK_STS_OK;
1585 	}
1586 
1587 	sgl_dma += sizeof(*sg_list);
1588 	do {
1589 		nvme_pci_dma_iter_set_sgl(&sg_list[++i], &iter);
1590 		iod->meta_total_len += iter.len;
1591 	} while (blk_rq_integrity_dma_map_iter_next(req, dev->dev, &iter));
1592 
1593 	nvme_pci_sgl_set_seg(sg_list, sgl_dma, i);
1594 	if (unlikely(iter.status))
1595 		nvme_unmap_metadata(req);
1596 	return iter.status;
1597 }
1598 
1599 static blk_status_t nvme_pci_setup_meta_mptr(struct request *req)
1600 {
1601 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1602 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
1603 	struct bio_vec bv = rq_integrity_vec(req);
1604 
1605 	if (is_pci_p2pdma_page(bv.bv_page))
1606 		return nvme_pci_setup_meta_iter(req);
1607 
1608 	iod->meta_dma = dma_map_bvec(nvmeq->dev->dev, &bv, rq_dma_dir(req), 0);
1609 	if (dma_mapping_error(nvmeq->dev->dev, iod->meta_dma))
1610 		return BLK_STS_IOERR;
1611 	iod->cmd.common.metadata = cpu_to_le64(iod->meta_dma);
1612 	iod->flags |= IOD_SINGLE_META_SEGMENT;
1613 	return BLK_STS_OK;
1614 }
1615 
1616 static blk_status_t nvme_map_metadata(struct request *req)
1617 {
1618 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1619 
1620 	if ((iod->cmd.common.flags & NVME_CMD_SGL_METABUF) &&
1621 	    nvme_pci_metadata_use_sgls(req))
1622 		return nvme_pci_setup_meta_iter(req);
1623 	return nvme_pci_setup_meta_mptr(req);
1624 }
1625 
1626 static blk_status_t nvme_prep_rq(struct request *req)
1627 {
1628 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1629 	blk_status_t ret;
1630 
1631 	iod->flags = 0;
1632 	iod->nr_descriptors = 0;
1633 	iod->total_len = 0;
1634 	iod->meta_total_len = 0;
1635 	iod->nr_dma_vecs = 0;
1636 
1637 	ret = nvme_setup_cmd(req->q->queuedata, req);
1638 	if (ret)
1639 		return ret;
1640 
1641 	if (blk_rq_nr_phys_segments(req)) {
1642 		ret = nvme_map_data(req);
1643 		if (ret)
1644 			goto out_free_cmd;
1645 	}
1646 
1647 	if (blk_integrity_rq(req)) {
1648 		ret = nvme_map_metadata(req);
1649 		if (ret)
1650 			goto out_unmap_data;
1651 	}
1652 
1653 	nvme_start_request(req);
1654 	return BLK_STS_OK;
1655 out_unmap_data:
1656 	if (blk_rq_nr_phys_segments(req))
1657 		nvme_unmap_data(req);
1658 out_free_cmd:
1659 	nvme_cleanup_cmd(req);
1660 	return ret;
1661 }
1662 
1663 static blk_status_t nvme_queue_rq(struct blk_mq_hw_ctx *hctx,
1664 			 const struct blk_mq_queue_data *bd)
1665 {
1666 	struct nvme_queue *nvmeq = hctx->driver_data;
1667 	struct nvme_dev *dev = nvmeq->dev;
1668 	struct request *req = bd->rq;
1669 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1670 	blk_status_t ret;
1671 
1672 	/*
1673 	 * We should not need to do this, but we're still using this to
1674 	 * ensure we can drain requests on a dying queue.
1675 	 */
1676 	if (unlikely(!test_bit(NVMEQ_ENABLED, &nvmeq->flags)))
1677 		return BLK_STS_IOERR;
1678 
1679 	if (unlikely(!nvme_check_ready(&dev->ctrl, req, true)))
1680 		return nvme_fail_nonready_command(&dev->ctrl, req);
1681 
1682 	ret = nvme_prep_rq(req);
1683 	if (unlikely(ret))
1684 		return ret;
1685 	spin_lock(&nvmeq->sq_lock);
1686 	nvme_sq_copy_cmd(nvmeq, &iod->cmd);
1687 	nvme_write_sq_db(nvmeq, bd->last);
1688 	spin_unlock(&nvmeq->sq_lock);
1689 	return BLK_STS_OK;
1690 }
1691 
1692 static void nvme_submit_cmds(struct nvme_queue *nvmeq, struct rq_list *rqlist)
1693 {
1694 	struct request *req;
1695 
1696 	if (rq_list_empty(rqlist))
1697 		return;
1698 
1699 	spin_lock(&nvmeq->sq_lock);
1700 	while ((req = rq_list_pop(rqlist))) {
1701 		struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1702 
1703 		nvme_sq_copy_cmd(nvmeq, &iod->cmd);
1704 	}
1705 	nvme_write_sq_db(nvmeq, true);
1706 	spin_unlock(&nvmeq->sq_lock);
1707 }
1708 
1709 static bool nvme_prep_rq_batch(struct nvme_queue *nvmeq, struct request *req)
1710 {
1711 	/*
1712 	 * We should not need to do this, but we're still using this to
1713 	 * ensure we can drain requests on a dying queue.
1714 	 */
1715 	if (unlikely(!test_bit(NVMEQ_ENABLED, &nvmeq->flags)))
1716 		return false;
1717 	if (unlikely(!nvme_check_ready(&nvmeq->dev->ctrl, req, true)))
1718 		return false;
1719 
1720 	return nvme_prep_rq(req) == BLK_STS_OK;
1721 }
1722 
1723 static void nvme_queue_rqs(struct rq_list *rqlist)
1724 {
1725 	struct rq_list submit_list = { };
1726 	struct rq_list requeue_list = { };
1727 	struct nvme_queue *nvmeq = NULL;
1728 	struct request *req;
1729 
1730 	while ((req = rq_list_pop(rqlist))) {
1731 		if (nvmeq && nvmeq != req->mq_hctx->driver_data)
1732 			nvme_submit_cmds(nvmeq, &submit_list);
1733 		nvmeq = req->mq_hctx->driver_data;
1734 
1735 		if (nvme_prep_rq_batch(nvmeq, req))
1736 			rq_list_add_tail(&submit_list, req);
1737 		else
1738 			rq_list_add_tail(&requeue_list, req);
1739 	}
1740 
1741 	if (nvmeq)
1742 		nvme_submit_cmds(nvmeq, &submit_list);
1743 	*rqlist = requeue_list;
1744 }
1745 
1746 static __always_inline void nvme_pci_unmap_rq(struct request *req)
1747 {
1748 	if (blk_integrity_rq(req))
1749 		nvme_unmap_metadata(req);
1750 	if (blk_rq_nr_phys_segments(req))
1751 		nvme_unmap_data(req);
1752 }
1753 
1754 static void nvme_pci_complete_rq(struct request *req)
1755 {
1756 	nvme_pci_unmap_rq(req);
1757 	nvme_complete_rq(req);
1758 }
1759 
1760 static void nvme_pci_complete_batch(struct io_comp_batch *iob)
1761 {
1762 	nvme_complete_batch(iob, nvme_pci_unmap_rq);
1763 }
1764 
1765 /* We read the CQE phase first to check if the rest of the entry is valid */
1766 static inline bool nvme_cqe_pending(struct nvme_queue *nvmeq)
1767 {
1768 	struct nvme_completion *hcqe = &nvmeq->cqes[nvmeq->cq_head];
1769 
1770 	return (le16_to_cpu(READ_ONCE(hcqe->status)) & 1) == nvmeq->cq_phase;
1771 }
1772 
1773 static inline void nvme_ring_cq_doorbell(struct nvme_queue *nvmeq)
1774 {
1775 	u16 head = nvmeq->cq_head;
1776 
1777 	if (nvme_dbbuf_update_and_check_event(head, nvmeq->dbbuf_cq_db,
1778 					      nvmeq->dbbuf_cq_ei))
1779 		writel(head, nvmeq->q_db + nvmeq->dev->db_stride);
1780 }
1781 
1782 static inline struct blk_mq_tags *nvme_queue_tagset(struct nvme_queue *nvmeq)
1783 {
1784 	if (!nvmeq->qid)
1785 		return nvmeq->dev->admin_tagset.tags[0];
1786 	return nvmeq->dev->tagset.tags[nvmeq->qid - 1];
1787 }
1788 
1789 static inline void nvme_handle_cqe(struct nvme_queue *nvmeq,
1790 				   struct io_comp_batch *iob, u16 idx)
1791 {
1792 	struct nvme_completion *cqe = &nvmeq->cqes[idx];
1793 	__u16 command_id = READ_ONCE(cqe->command_id);
1794 	struct request *req;
1795 
1796 	/*
1797 	 * AEN requests are special as they don't time out and can
1798 	 * survive any kind of queue freeze and often don't respond to
1799 	 * aborts.  We don't even bother to allocate a struct request
1800 	 * for them but rather special case them here.
1801 	 */
1802 	if (unlikely(nvme_is_aen_req(nvmeq->qid, command_id))) {
1803 		nvme_complete_async_event(&nvmeq->dev->ctrl,
1804 				cqe->status, &cqe->result);
1805 		return;
1806 	}
1807 
1808 	req = nvme_find_rq(nvme_queue_tagset(nvmeq), command_id);
1809 	if (unlikely(!req)) {
1810 		dev_warn_ratelimited(nvmeq->dev->ctrl.device,
1811 				     "invalid id %d completed on queue %d\n",
1812 				     command_id, le16_to_cpu(cqe->sq_id));
1813 		return;
1814 	}
1815 
1816 	/*
1817 	 * Tracing only; annotate a lockless snapshot of nvmeq->sq_tail using
1818 	 * data_race(). This would also help suppress context analysis warning
1819 	 * while accessing nvmeq->sq_tail without acquiring ->sq_lock.
1820 	 */
1821 	trace_nvme_sq(req, cqe->sq_head, data_race(nvmeq->sq_tail));
1822 	if (!nvme_try_complete_req(req, cqe->status, cqe->result) &&
1823 	    !blk_mq_add_to_batch(req, iob,
1824 				 nvme_req(req)->status != NVME_SC_SUCCESS,
1825 				 nvme_pci_complete_batch))
1826 		nvme_pci_complete_rq(req);
1827 }
1828 
1829 static inline void nvme_update_cq_head(struct nvme_queue *nvmeq)
1830 {
1831 	u32 tmp = nvmeq->cq_head + 1;
1832 
1833 	if (tmp == nvmeq->q_depth) {
1834 		nvmeq->cq_head = 0;
1835 		nvmeq->cq_phase ^= 1;
1836 	} else {
1837 		nvmeq->cq_head = tmp;
1838 	}
1839 }
1840 
1841 static inline bool nvme_poll_cq(struct nvme_queue *nvmeq,
1842 			        struct io_comp_batch *iob)
1843 {
1844 	bool found = false;
1845 
1846 	while (nvme_cqe_pending(nvmeq)) {
1847 		found = true;
1848 		/*
1849 		 * load-load control dependency between phase and the rest of
1850 		 * the cqe requires a full read memory barrier
1851 		 */
1852 		dma_rmb();
1853 		nvme_handle_cqe(nvmeq, iob, nvmeq->cq_head);
1854 		nvme_update_cq_head(nvmeq);
1855 	}
1856 
1857 	if (found)
1858 		nvme_ring_cq_doorbell(nvmeq);
1859 	return found;
1860 }
1861 
1862 static irqreturn_t nvme_irq(int irq, void *data)
1863 {
1864 	struct nvme_queue *nvmeq = data;
1865 	DEFINE_IO_COMP_BATCH(iob);
1866 
1867 	if (nvme_poll_cq(nvmeq, &iob)) {
1868 		if (!rq_list_empty(&iob.req_list))
1869 			nvme_pci_complete_batch(&iob);
1870 		return IRQ_HANDLED;
1871 	}
1872 	return IRQ_NONE;
1873 }
1874 
1875 static irqreturn_t nvme_irq_check(int irq, void *data)
1876 {
1877 	struct nvme_queue *nvmeq = data;
1878 
1879 	if (nvme_cqe_pending(nvmeq))
1880 		return IRQ_WAKE_THREAD;
1881 	return IRQ_NONE;
1882 }
1883 
1884 /*
1885  * Poll for completions for any interrupt driven queue
1886  * Can be called from any context.
1887  */
1888 static void nvme_poll_irqdisable(struct nvme_queue *nvmeq)
1889 {
1890 	struct pci_dev *pdev = to_pci_dev(nvmeq->dev->dev);
1891 	int irq;
1892 
1893 	WARN_ON_ONCE(test_bit(NVMEQ_POLLED, &nvmeq->flags));
1894 
1895 	irq = pci_irq_vector(pdev, nvmeq->cq_vector);
1896 	disable_irq(irq);
1897 	spin_lock(&nvmeq->cq_poll_lock);
1898 	nvme_poll_cq(nvmeq, NULL);
1899 	spin_unlock(&nvmeq->cq_poll_lock);
1900 	enable_irq(irq);
1901 }
1902 
1903 static int nvme_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
1904 {
1905 	struct nvme_queue *nvmeq = hctx->driver_data;
1906 	bool found;
1907 
1908 	if (!test_bit(NVMEQ_POLLED, &nvmeq->flags) ||
1909 	    !nvme_cqe_pending(nvmeq))
1910 		return 0;
1911 
1912 	spin_lock(&nvmeq->cq_poll_lock);
1913 	found = nvme_poll_cq(nvmeq, iob);
1914 	spin_unlock(&nvmeq->cq_poll_lock);
1915 
1916 	return found;
1917 }
1918 
1919 static void nvme_pci_submit_async_event(struct nvme_ctrl *ctrl)
1920 {
1921 	struct nvme_dev *dev = to_nvme_dev(ctrl);
1922 	struct nvme_queue *nvmeq = &dev->queues[0];
1923 	struct nvme_command c = { };
1924 
1925 	c.common.opcode = nvme_admin_async_event;
1926 	c.common.command_id = NVME_AQ_BLK_MQ_DEPTH;
1927 
1928 	spin_lock(&nvmeq->sq_lock);
1929 	nvme_sq_copy_cmd(nvmeq, &c);
1930 	nvme_write_sq_db(nvmeq, true);
1931 	spin_unlock(&nvmeq->sq_lock);
1932 }
1933 
1934 static int nvme_pci_subsystem_reset(struct nvme_ctrl *ctrl)
1935 {
1936 	struct nvme_dev *dev = to_nvme_dev(ctrl);
1937 	int ret = 0;
1938 
1939 	/*
1940 	 * Taking the shutdown_lock ensures the BAR mapping is not being
1941 	 * altered by reset_work. Holding this lock before the RESETTING state
1942 	 * change, if successful, also ensures nvme_remove won't be able to
1943 	 * proceed to iounmap until we're done.
1944 	 */
1945 	mutex_lock(&dev->shutdown_lock);
1946 	if (!dev->bar_mapped_size) {
1947 		ret = -ENODEV;
1948 		goto unlock;
1949 	}
1950 
1951 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING)) {
1952 		ret = -EBUSY;
1953 		goto unlock;
1954 	}
1955 
1956 	writel(NVME_SUBSYS_RESET, dev->bar + NVME_REG_NSSR);
1957 
1958 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING) ||
1959 	    !nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
1960 		goto unlock;
1961 
1962 	/*
1963 	 * Read controller status to flush the previous write and trigger a
1964 	 * pcie read error.
1965 	 */
1966 	readl(dev->bar + NVME_REG_CSTS);
1967 unlock:
1968 	mutex_unlock(&dev->shutdown_lock);
1969 	return ret;
1970 }
1971 
1972 static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
1973 {
1974 	struct nvme_command c = { };
1975 
1976 	c.delete_queue.opcode = opcode;
1977 	c.delete_queue.qid = cpu_to_le16(id);
1978 
1979 	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
1980 }
1981 
1982 static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
1983 		struct nvme_queue *nvmeq, s16 vector)
1984 {
1985 	struct nvme_command c = { };
1986 	int flags = NVME_QUEUE_PHYS_CONTIG;
1987 
1988 	if (!test_bit(NVMEQ_POLLED, &nvmeq->flags))
1989 		flags |= NVME_CQ_IRQ_ENABLED;
1990 
1991 	/*
1992 	 * Note: we (ab)use the fact that the prp fields survive if no data
1993 	 * is attached to the request.
1994 	 */
1995 	c.create_cq.opcode = nvme_admin_create_cq;
1996 	c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
1997 	c.create_cq.cqid = cpu_to_le16(qid);
1998 	c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
1999 	c.create_cq.cq_flags = cpu_to_le16(flags);
2000 	c.create_cq.irq_vector = cpu_to_le16(vector);
2001 
2002 	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
2003 }
2004 
2005 static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
2006 						struct nvme_queue *nvmeq)
2007 {
2008 	struct nvme_ctrl *ctrl = &dev->ctrl;
2009 	struct nvme_command c = { };
2010 	int flags = NVME_QUEUE_PHYS_CONTIG;
2011 
2012 	/*
2013 	 * Some drives have a bug that auto-enables WRRU if MEDIUM isn't
2014 	 * set. Since URGENT priority is zeroes, it makes all queues
2015 	 * URGENT.
2016 	 */
2017 	if (ctrl->quirks & NVME_QUIRK_MEDIUM_PRIO_SQ)
2018 		flags |= NVME_SQ_PRIO_MEDIUM;
2019 
2020 	/*
2021 	 * Note: we (ab)use the fact that the prp fields survive if no data
2022 	 * is attached to the request.
2023 	 */
2024 	c.create_sq.opcode = nvme_admin_create_sq;
2025 	c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
2026 	c.create_sq.sqid = cpu_to_le16(qid);
2027 	c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
2028 	c.create_sq.sq_flags = cpu_to_le16(flags);
2029 	c.create_sq.cqid = cpu_to_le16(qid);
2030 
2031 	return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
2032 }
2033 
2034 static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
2035 {
2036 	return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
2037 }
2038 
2039 static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
2040 {
2041 	return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
2042 }
2043 
2044 static enum rq_end_io_ret abort_endio(struct request *req, blk_status_t error,
2045 				      const struct io_comp_batch *iob)
2046 {
2047 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
2048 
2049 	dev_warn(nvmeq->dev->ctrl.device,
2050 		 "Abort status: 0x%x", nvme_req(req)->status);
2051 	atomic_inc(&nvmeq->dev->ctrl.abort_limit);
2052 	blk_mq_free_request(req);
2053 	return RQ_END_IO_NONE;
2054 }
2055 
2056 static bool nvme_should_reset(struct nvme_dev *dev, u32 csts)
2057 {
2058 	/* If true, indicates loss of adapter communication, possibly by a
2059 	 * NVMe Subsystem reset.
2060 	 */
2061 	bool nssro = dev->subsystem && (csts & NVME_CSTS_NSSRO);
2062 
2063 	/* If there is a reset/reinit ongoing, we shouldn't reset again. */
2064 	switch (nvme_ctrl_state(&dev->ctrl)) {
2065 	case NVME_CTRL_RESETTING:
2066 	case NVME_CTRL_CONNECTING:
2067 		return false;
2068 	default:
2069 		break;
2070 	}
2071 
2072 	/* We shouldn't reset unless the controller is on fatal error state
2073 	 * _or_ if we lost the communication with it.
2074 	 */
2075 	if (!(csts & NVME_CSTS_CFS) && !nssro)
2076 		return false;
2077 
2078 	return true;
2079 }
2080 
2081 static void nvme_warn_reset(struct nvme_dev *dev, u32 csts)
2082 {
2083 	/* Read a config register to help see what died. */
2084 	u16 pci_status;
2085 	int result;
2086 
2087 	result = pci_read_config_word(to_pci_dev(dev->dev), PCI_STATUS,
2088 				      &pci_status);
2089 	if (result == PCIBIOS_SUCCESSFUL)
2090 		dev_warn(dev->ctrl.device,
2091 			 "controller is down; will reset: CSTS=0x%x, PCI_STATUS=0x%hx\n",
2092 			 csts, pci_status);
2093 	else
2094 		dev_warn(dev->ctrl.device,
2095 			 "controller is down; will reset: CSTS=0x%x, PCI_STATUS read failed (%d)\n",
2096 			 csts, result);
2097 
2098 	if (csts != ~0)
2099 		return;
2100 
2101 	dev_warn(dev->ctrl.device,
2102 		 "Does your device have a faulty power saving mode enabled?\n");
2103 	dev_warn(dev->ctrl.device,
2104 		 "Try \"nvme_core.default_ps_max_latency_us=0 pcie_aspm=off pcie_port_pm=off\" and report a bug\n");
2105 }
2106 
2107 static enum blk_eh_timer_return nvme_timeout(struct request *req)
2108 {
2109 	struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
2110 	struct nvme_queue *nvmeq = req->mq_hctx->driver_data;
2111 	struct nvme_dev *dev = nvmeq->dev;
2112 	struct request *abort_req;
2113 	struct nvme_command cmd = { };
2114 	struct pci_dev *pdev = to_pci_dev(dev->dev);
2115 	u32 csts = readl(dev->bar + NVME_REG_CSTS);
2116 	u8 opcode;
2117 
2118 	/*
2119 	 * Shutdown the device immediately if we see it is disconnected. This
2120 	 * unblocks PCIe error handling if the nvme driver is waiting in
2121 	 * error_resume for a device that has been removed. We can't unbind the
2122 	 * driver while the driver's error callback is waiting to complete, so
2123 	 * we're relying on a timeout to break that deadlock if a removal
2124 	 * occurs while reset work is running.
2125 	 */
2126 	if (pci_dev_is_disconnected(pdev))
2127 		nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
2128 	if (nvme_state_terminal(&dev->ctrl))
2129 		goto disable;
2130 
2131 	/* If PCI error recovery process is happening, we cannot reset or
2132 	 * the recovery mechanism will surely fail.
2133 	 */
2134 	mb();
2135 	if (pci_channel_offline(pdev))
2136 		return BLK_EH_RESET_TIMER;
2137 
2138 	/*
2139 	 * Reset immediately if the controller is failed
2140 	 */
2141 	if (nvme_should_reset(dev, csts)) {
2142 		nvme_warn_reset(dev, csts);
2143 		goto disable;
2144 	}
2145 
2146 	/*
2147 	 * Did we miss an interrupt?
2148 	 */
2149 	if (test_bit(NVMEQ_POLLED, &nvmeq->flags))
2150 		nvme_poll(req->mq_hctx, NULL);
2151 	else
2152 		nvme_poll_irqdisable(nvmeq);
2153 
2154 	if (blk_mq_rq_state(req) != MQ_RQ_IN_FLIGHT) {
2155 		dev_warn(dev->ctrl.device,
2156 			 "I/O tag %d (%04x) QID %d timeout, completion polled\n",
2157 			 req->tag, nvme_cid(req), nvmeq->qid);
2158 		return BLK_EH_DONE;
2159 	}
2160 
2161 	/*
2162 	 * Shutdown immediately if controller times out while starting. The
2163 	 * reset work will see the pci device disabled when it gets the forced
2164 	 * cancellation error. All outstanding requests are completed on
2165 	 * shutdown, so we return BLK_EH_DONE.
2166 	 */
2167 	switch (nvme_ctrl_state(&dev->ctrl)) {
2168 	case NVME_CTRL_CONNECTING:
2169 		nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
2170 		fallthrough;
2171 	case NVME_CTRL_DELETING:
2172 		dev_warn_ratelimited(dev->ctrl.device,
2173 			 "I/O tag %d (%04x) QID %d timeout, disable controller\n",
2174 			 req->tag, nvme_cid(req), nvmeq->qid);
2175 		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
2176 		nvme_dev_disable(dev, true);
2177 		return BLK_EH_DONE;
2178 	case NVME_CTRL_RESETTING:
2179 		return BLK_EH_RESET_TIMER;
2180 	default:
2181 		break;
2182 	}
2183 
2184 	/*
2185 	 * Shutdown the controller immediately and schedule a reset if the
2186 	 * command was already aborted once before and still hasn't been
2187 	 * returned to the driver, or if this is the admin queue.
2188 	 */
2189 	opcode = nvme_req(req)->cmd->common.opcode;
2190 	if (!nvmeq->qid || (iod->flags & IOD_ABORTED)) {
2191 		dev_warn(dev->ctrl.device,
2192 			 "I/O tag %d (%04x) opcode %#x (%s) QID %d timeout, reset controller\n",
2193 			 req->tag, nvme_cid(req), opcode,
2194 			 nvme_opcode_str(nvmeq->qid, opcode), nvmeq->qid);
2195 		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
2196 		goto disable;
2197 	}
2198 
2199 	if (atomic_dec_return(&dev->ctrl.abort_limit) < 0) {
2200 		atomic_inc(&dev->ctrl.abort_limit);
2201 		return BLK_EH_RESET_TIMER;
2202 	}
2203 	iod->flags |= IOD_ABORTED;
2204 
2205 	cmd.abort.opcode = nvme_admin_abort_cmd;
2206 	cmd.abort.cid = nvme_cid(req);
2207 	cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
2208 
2209 	dev_warn(nvmeq->dev->ctrl.device,
2210 		 "I/O tag %d (%04x) opcode %#x (%s) QID %d timeout, aborting req_op:%s(%u) size:%u\n",
2211 		 req->tag, nvme_cid(req), opcode, nvme_get_opcode_str(opcode),
2212 		 nvmeq->qid, blk_op_str(req_op(req)), req_op(req),
2213 		 blk_rq_bytes(req));
2214 
2215 	abort_req = blk_mq_alloc_request(dev->ctrl.admin_q, nvme_req_op(&cmd),
2216 					 BLK_MQ_REQ_NOWAIT);
2217 	if (IS_ERR(abort_req)) {
2218 		atomic_inc(&dev->ctrl.abort_limit);
2219 		return BLK_EH_RESET_TIMER;
2220 	}
2221 	nvme_init_request(abort_req, &cmd);
2222 
2223 	abort_req->end_io = abort_endio;
2224 	abort_req->end_io_data = NULL;
2225 	blk_execute_rq_nowait(abort_req, false);
2226 
2227 	/*
2228 	 * The aborted req will be completed on receiving the abort req.
2229 	 * We enable the timer again. If hit twice, it'll cause a device reset,
2230 	 * as the device then is in a faulty state.
2231 	 */
2232 	return BLK_EH_RESET_TIMER;
2233 
2234 disable:
2235 	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_RESETTING)) {
2236 		if (nvme_state_terminal(&dev->ctrl))
2237 			nvme_dev_disable(dev, true);
2238 		return BLK_EH_DONE;
2239 	}
2240 
2241 	nvme_dev_disable(dev, false);
2242 	if (nvme_try_sched_reset(&dev->ctrl))
2243 		nvme_unquiesce_io_queues(&dev->ctrl);
2244 	return BLK_EH_DONE;
2245 }
2246 
2247 static void nvme_free_queue(struct nvme_queue *nvmeq)
2248 	__context_unsafe(/* frees queue which is no longer in use */)
2249 {
2250 	dma_free_coherent(nvmeq->dev->dev, CQ_SIZE(nvmeq),
2251 				(void *)nvmeq->cqes, nvmeq->cq_dma_addr);
2252 	if (!nvmeq->sq_cmds)
2253 		return;
2254 
2255 	if (test_and_clear_bit(NVMEQ_SQ_CMB, &nvmeq->flags)) {
2256 		pci_free_p2pmem(to_pci_dev(nvmeq->dev->dev),
2257 				nvmeq->sq_cmds, SQ_SIZE(nvmeq));
2258 	} else {
2259 		dma_free_coherent(nvmeq->dev->dev, SQ_SIZE(nvmeq),
2260 				nvmeq->sq_cmds, nvmeq->sq_dma_addr);
2261 	}
2262 }
2263 
2264 static void nvme_free_queues(struct nvme_dev *dev, int lowest)
2265 {
2266 	int i;
2267 
2268 	for (i = dev->ctrl.queue_count - 1; i >= lowest; i--) {
2269 		dev->ctrl.queue_count--;
2270 		nvme_free_queue(&dev->queues[i]);
2271 	}
2272 }
2273 
2274 static void nvme_suspend_queue(struct nvme_dev *dev, unsigned int qid)
2275 {
2276 	struct nvme_queue *nvmeq = &dev->queues[qid];
2277 
2278 	if (!test_and_clear_bit(NVMEQ_ENABLED, &nvmeq->flags))
2279 		return;
2280 
2281 	/* ensure that nvme_queue_rq() sees NVMEQ_ENABLED cleared */
2282 	mb();
2283 
2284 	nvmeq->dev->online_queues--;
2285 	if (!nvmeq->qid && nvmeq->dev->ctrl.admin_q)
2286 		nvme_quiesce_admin_queue(&nvmeq->dev->ctrl);
2287 	if (!test_and_clear_bit(NVMEQ_POLLED, &nvmeq->flags))
2288 		pci_free_irq(to_pci_dev(dev->dev), nvmeq->cq_vector, nvmeq);
2289 }
2290 
2291 static void nvme_suspend_io_queues(struct nvme_dev *dev)
2292 {
2293 	int i;
2294 
2295 	for (i = dev->ctrl.queue_count - 1; i > 0; i--)
2296 		nvme_suspend_queue(dev, i);
2297 }
2298 
2299 /*
2300  * Called only on a device that has been disabled and after all other threads
2301  * that can check this device's completion queues have synced, except
2302  * nvme_poll(). This is the last chance for the driver to see a natural
2303  * completion before nvme_cancel_request() terminates all incomplete requests.
2304  */
2305 static void nvme_reap_pending_cqes(struct nvme_dev *dev)
2306 {
2307 	int i;
2308 
2309 	for (i = dev->ctrl.queue_count - 1; i > 0; i--) {
2310 		spin_lock(&dev->queues[i].cq_poll_lock);
2311 		nvme_poll_cq(&dev->queues[i], NULL);
2312 		spin_unlock(&dev->queues[i].cq_poll_lock);
2313 	}
2314 }
2315 
2316 static int nvme_cmb_qdepth(struct nvme_dev *dev, int nr_io_queues,
2317 				int entry_size)
2318 {
2319 	int q_depth = dev->q_depth;
2320 	unsigned q_size_aligned = roundup(q_depth * entry_size,
2321 					  NVME_CTRL_PAGE_SIZE);
2322 
2323 	if (q_size_aligned * nr_io_queues > dev->cmb_size) {
2324 		u64 mem_per_q = div_u64(dev->cmb_size, nr_io_queues);
2325 
2326 		mem_per_q = round_down(mem_per_q, NVME_CTRL_PAGE_SIZE);
2327 		q_depth = div_u64(mem_per_q, entry_size);
2328 
2329 		/*
2330 		 * Ensure the reduced q_depth is above some threshold where it
2331 		 * would be better to map queues in system memory with the
2332 		 * original depth
2333 		 */
2334 		if (q_depth < 64)
2335 			return -ENOMEM;
2336 	}
2337 
2338 	return q_depth;
2339 }
2340 
2341 static int nvme_alloc_sq_cmds(struct nvme_dev *dev, struct nvme_queue *nvmeq,
2342 				int qid)
2343 	__context_unsafe(/* safe to allocate sq_cmds without any protection */)
2344 {
2345 	struct pci_dev *pdev = to_pci_dev(dev->dev);
2346 
2347 	if (qid && dev->cmb_use_sqes && (dev->cmbsz & NVME_CMBSZ_SQS)) {
2348 		nvmeq->sq_cmds = pci_alloc_p2pmem(pdev, SQ_SIZE(nvmeq));
2349 		if (nvmeq->sq_cmds) {
2350 			nvmeq->sq_dma_addr = pci_p2pmem_virt_to_bus(pdev,
2351 							nvmeq->sq_cmds);
2352 			if (nvmeq->sq_dma_addr) {
2353 				set_bit(NVMEQ_SQ_CMB, &nvmeq->flags);
2354 				return 0;
2355 			}
2356 
2357 			pci_free_p2pmem(pdev, nvmeq->sq_cmds, SQ_SIZE(nvmeq));
2358 		}
2359 	}
2360 
2361 	nvmeq->sq_cmds = dma_alloc_coherent(dev->dev, SQ_SIZE(nvmeq),
2362 				&nvmeq->sq_dma_addr, GFP_KERNEL);
2363 	if (!nvmeq->sq_cmds)
2364 		return -ENOMEM;
2365 	return 0;
2366 }
2367 
2368 static int nvme_alloc_queue(struct nvme_dev *dev, int qid, int depth)
2369 {
2370 	struct nvme_queue *nvmeq = &dev->queues[qid];
2371 
2372 	if (dev->ctrl.queue_count > qid)
2373 		return 0;
2374 
2375 	nvmeq->sqes = qid ? dev->io_sqes : NVME_ADM_SQES;
2376 	nvmeq->q_depth = depth;
2377 	nvmeq->cqes = dma_alloc_coherent(dev->dev, CQ_SIZE(nvmeq),
2378 					 &nvmeq->cq_dma_addr, GFP_KERNEL);
2379 	if (!nvmeq->cqes)
2380 		goto free_nvmeq;
2381 
2382 	if (nvme_alloc_sq_cmds(dev, nvmeq, qid))
2383 		goto free_cqdma;
2384 
2385 	nvmeq->dev = dev;
2386 	spin_lock_init(&nvmeq->sq_lock);
2387 	spin_lock_init(&nvmeq->cq_poll_lock);
2388 	nvmeq->cq_head = 0;
2389 	nvmeq->cq_phase = 1;
2390 	nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
2391 	nvmeq->qid = qid;
2392 	dev->ctrl.queue_count++;
2393 
2394 	return 0;
2395 
2396  free_cqdma:
2397 	dma_free_coherent(dev->dev, CQ_SIZE(nvmeq), (void *)nvmeq->cqes,
2398 			  nvmeq->cq_dma_addr);
2399  free_nvmeq:
2400 	return -ENOMEM;
2401 }
2402 
2403 static int queue_request_irq(struct nvme_queue *nvmeq)
2404 {
2405 	struct pci_dev *pdev = to_pci_dev(nvmeq->dev->dev);
2406 	int nr = nvmeq->dev->ctrl.instance;
2407 
2408 	if (use_threaded_interrupts) {
2409 		return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq_check,
2410 				nvme_irq, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
2411 	} else {
2412 		return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq,
2413 				NULL, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
2414 	}
2415 }
2416 
2417 static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid)
2418 	__context_unsafe(/* initialize unpublished/lock-guarded variables */)
2419 {
2420 	struct nvme_dev *dev = nvmeq->dev;
2421 
2422 	nvmeq->sq_tail = 0;
2423 	nvmeq->last_sq_tail = 0;
2424 	nvmeq->cq_head = 0;
2425 	nvmeq->cq_phase = 1;
2426 	nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
2427 	memset((void *)nvmeq->cqes, 0, CQ_SIZE(nvmeq));
2428 	nvme_dbbuf_init(dev, nvmeq, qid);
2429 	dev->online_queues++;
2430 	wmb(); /* ensure the first interrupt sees the initialization */
2431 }
2432 
2433 /*
2434  * Try getting shutdown_lock while setting up IO queues.
2435  */
2436 static int nvme_setup_io_queues_trylock(struct nvme_dev *dev)
2437 	__cond_acquires(0, &dev->shutdown_lock)
2438 {
2439 	/*
2440 	 * Give up if the lock is being held by nvme_dev_disable.
2441 	 */
2442 	if (!mutex_trylock(&dev->shutdown_lock))
2443 		return -ENODEV;
2444 
2445 	/*
2446 	 * Controller is in wrong state, fail early.
2447 	 */
2448 	if (nvme_ctrl_state(&dev->ctrl) != NVME_CTRL_CONNECTING) {
2449 		mutex_unlock(&dev->shutdown_lock);
2450 		return -ENODEV;
2451 	}
2452 
2453 	return 0;
2454 }
2455 
2456 static int nvme_create_queue(struct nvme_queue *nvmeq, int qid, bool polled)
2457 {
2458 	struct nvme_dev *dev = nvmeq->dev;
2459 	int result;
2460 	u16 vector = 0;
2461 
2462 	clear_bit(NVMEQ_DELETE_ERROR, &nvmeq->flags);
2463 
2464 	/*
2465 	 * A queue's vector matches the queue identifier unless the controller
2466 	 * has only one vector available.
2467 	 */
2468 	if (!polled)
2469 		vector = dev->num_vecs == 1 ? 0 : qid;
2470 	else
2471 		set_bit(NVMEQ_POLLED, &nvmeq->flags);
2472 
2473 	result = adapter_alloc_cq(dev, qid, nvmeq, vector);
2474 	if (result)
2475 		return result;
2476 
2477 	result = adapter_alloc_sq(dev, qid, nvmeq);
2478 	if (result < 0)
2479 		return result;
2480 	if (result)
2481 		goto release_cq;
2482 
2483 	nvmeq->cq_vector = vector;
2484 
2485 	result = nvme_setup_io_queues_trylock(dev);
2486 	if (result)
2487 		return result;
2488 	nvme_init_queue(nvmeq, qid);
2489 	if (!polled) {
2490 		result = queue_request_irq(nvmeq);
2491 		if (result < 0)
2492 			goto release_sq;
2493 	}
2494 
2495 	set_bit(NVMEQ_ENABLED, &nvmeq->flags);
2496 	mutex_unlock(&dev->shutdown_lock);
2497 	return result;
2498 
2499 release_sq:
2500 	dev->online_queues--;
2501 	mutex_unlock(&dev->shutdown_lock);
2502 	adapter_delete_sq(dev, qid);
2503 release_cq:
2504 	adapter_delete_cq(dev, qid);
2505 	return result;
2506 }
2507 
2508 static const struct blk_mq_ops nvme_mq_admin_ops = {
2509 	.queue_rq	= nvme_queue_rq,
2510 	.complete	= nvme_pci_complete_rq,
2511 	.commit_rqs	= nvme_commit_rqs,
2512 	.init_hctx	= nvme_admin_init_hctx,
2513 	.init_request	= nvme_pci_init_request,
2514 	.timeout	= nvme_timeout,
2515 };
2516 
2517 static const struct blk_mq_ops nvme_mq_ops = {
2518 	.queue_rq	= nvme_queue_rq,
2519 	.queue_rqs	= nvme_queue_rqs,
2520 	.complete	= nvme_pci_complete_rq,
2521 	.commit_rqs	= nvme_commit_rqs,
2522 	.init_hctx	= nvme_init_hctx,
2523 	.init_request	= nvme_pci_init_request,
2524 	.map_queues	= nvme_pci_map_queues,
2525 	.timeout	= nvme_timeout,
2526 	.poll		= nvme_poll,
2527 };
2528 
2529 static void nvme_dev_remove_admin(struct nvme_dev *dev)
2530 {
2531 	if (dev->ctrl.admin_q && !blk_queue_dying(dev->ctrl.admin_q)) {
2532 		/*
2533 		 * If the controller was reset during removal, it's possible
2534 		 * user requests may be waiting on a stopped queue. Start the
2535 		 * queue to flush these to completion.
2536 		 */
2537 		nvme_unquiesce_admin_queue(&dev->ctrl);
2538 		nvme_remove_admin_tag_set(&dev->ctrl);
2539 	}
2540 }
2541 
2542 static unsigned long db_bar_size(struct nvme_dev *dev, unsigned nr_io_queues)
2543 {
2544 	return NVME_REG_DBS + ((nr_io_queues + 1) * 8 * dev->db_stride);
2545 }
2546 
2547 static int nvme_remap_bar(struct nvme_dev *dev, unsigned long size)
2548 {
2549 	struct pci_dev *pdev = to_pci_dev(dev->dev);
2550 
2551 	if (size <= dev->bar_mapped_size)
2552 		return 0;
2553 	if (size > pci_resource_len(pdev, 0))
2554 		return -ENOMEM;
2555 	if (dev->bar)
2556 		iounmap(dev->bar);
2557 	dev->bar = ioremap(pci_resource_start(pdev, 0), size);
2558 	if (!dev->bar) {
2559 		dev->bar_mapped_size = 0;
2560 		return -ENOMEM;
2561 	}
2562 	dev->bar_mapped_size = size;
2563 	dev->dbs = dev->bar + NVME_REG_DBS;
2564 
2565 	return 0;
2566 }
2567 
2568 static int nvme_pci_configure_admin_queue(struct nvme_dev *dev)
2569 {
2570 	int result;
2571 	u32 aqa;
2572 	struct nvme_queue *nvmeq;
2573 
2574 	result = nvme_remap_bar(dev, db_bar_size(dev, 0));
2575 	if (result < 0)
2576 		return result;
2577 
2578 	dev->subsystem = readl(dev->bar + NVME_REG_VS) >= NVME_VS(1, 1, 0) ?
2579 				NVME_CAP_NSSRC(dev->ctrl.cap) : 0;
2580 
2581 	if (dev->subsystem &&
2582 	    (readl(dev->bar + NVME_REG_CSTS) & NVME_CSTS_NSSRO))
2583 		writel(NVME_CSTS_NSSRO, dev->bar + NVME_REG_CSTS);
2584 
2585 	/*
2586 	 * If the device has been passed off to us in an enabled state, just
2587 	 * clear the enabled bit.  The spec says we should set the 'shutdown
2588 	 * notification bits', but doing so may cause the device to complete
2589 	 * commands to the admin queue ... and we don't know what memory that
2590 	 * might be pointing at!
2591 	 */
2592 	result = nvme_disable_ctrl(&dev->ctrl, false);
2593 	if (result < 0) {
2594 		struct pci_dev *pdev = to_pci_dev(dev->dev);
2595 
2596 		/*
2597 		 * The NVMe Controller Reset method did not get an expected
2598 		 * CSTS.RDY transition, so something with the device appears to
2599 		 * be stuck. Use the lower level and bigger hammer PCIe
2600 		 * Function Level Reset to attempt restoring the device to its
2601 		 * initial state, and try again.
2602 		 */
2603 		result = pcie_reset_flr(pdev, false);
2604 		if (result < 0)
2605 			return result;
2606 
2607 		pci_restore_state(pdev);
2608 		result = nvme_disable_ctrl(&dev->ctrl, false);
2609 		if (result < 0)
2610 			return result;
2611 
2612 		dev_info(dev->ctrl.device,
2613 			"controller reset completed after pcie flr\n");
2614 	}
2615 
2616 	result = nvme_alloc_queue(dev, 0, NVME_AQ_DEPTH);
2617 	if (result)
2618 		return result;
2619 
2620 	dev->ctrl.numa_node = dev_to_node(dev->dev);
2621 
2622 	nvmeq = &dev->queues[0];
2623 	aqa = nvmeq->q_depth - 1;
2624 	aqa |= aqa << 16;
2625 
2626 	writel(aqa, dev->bar + NVME_REG_AQA);
2627 	lo_hi_writeq(nvmeq->sq_dma_addr, dev->bar + NVME_REG_ASQ);
2628 	lo_hi_writeq(nvmeq->cq_dma_addr, dev->bar + NVME_REG_ACQ);
2629 
2630 	result = nvme_enable_ctrl(&dev->ctrl);
2631 	if (result)
2632 		return result;
2633 
2634 	nvmeq->cq_vector = 0;
2635 	nvme_init_queue(nvmeq, 0);
2636 	result = queue_request_irq(nvmeq);
2637 	if (result) {
2638 		dev->online_queues--;
2639 		nvme_disable_ctrl(&dev->ctrl, false);
2640 		return result;
2641 	}
2642 
2643 	set_bit(NVMEQ_ENABLED, &nvmeq->flags);
2644 	return result;
2645 }
2646 
2647 static int nvme_create_io_queues(struct nvme_dev *dev)
2648 {
2649 	unsigned i, max, rw_queues;
2650 	int ret = 0;
2651 
2652 	for (i = dev->ctrl.queue_count; i <= dev->max_qid; i++) {
2653 		if (nvme_alloc_queue(dev, i, dev->q_depth)) {
2654 			ret = -ENOMEM;
2655 			break;
2656 		}
2657 	}
2658 
2659 	max = min(dev->max_qid, dev->ctrl.queue_count - 1);
2660 	if (max != 1 && dev->io_queues[HCTX_TYPE_POLL]) {
2661 		rw_queues = dev->io_queues[HCTX_TYPE_DEFAULT] +
2662 				dev->io_queues[HCTX_TYPE_READ];
2663 	} else {
2664 		rw_queues = max;
2665 	}
2666 
2667 	for (i = dev->online_queues; i <= max; i++) {
2668 		bool polled = i > rw_queues;
2669 
2670 		ret = nvme_create_queue(&dev->queues[i], i, polled);
2671 		if (ret)
2672 			break;
2673 	}
2674 
2675 	/*
2676 	 * Ignore failing Create SQ/CQ commands, we can continue with less
2677 	 * than the desired amount of queues, and even a controller without
2678 	 * I/O queues can still be used to issue admin commands.  This might
2679 	 * be useful to upgrade a buggy firmware for example.
2680 	 */
2681 	return ret >= 0 ? 0 : ret;
2682 }
2683 
2684 static u64 nvme_cmb_size_unit(struct nvme_dev *dev)
2685 {
2686 	u8 szu = (dev->cmbsz >> NVME_CMBSZ_SZU_SHIFT) & NVME_CMBSZ_SZU_MASK;
2687 
2688 	return 1ULL << (12 + 4 * szu);
2689 }
2690 
2691 static u32 nvme_cmb_size(struct nvme_dev *dev)
2692 {
2693 	return (dev->cmbsz >> NVME_CMBSZ_SZ_SHIFT) & NVME_CMBSZ_SZ_MASK;
2694 }
2695 
2696 static void nvme_map_cmb(struct nvme_dev *dev)
2697 {
2698 	u64 size, offset;
2699 	resource_size_t bar_size;
2700 	struct pci_dev *pdev = to_pci_dev(dev->dev);
2701 	int bar;
2702 
2703 	if (dev->cmb_size)
2704 		return;
2705 
2706 	if (NVME_CAP_CMBS(dev->ctrl.cap))
2707 		writel(NVME_CMBMSC_CRE, dev->bar + NVME_REG_CMBMSC);
2708 
2709 	dev->cmbsz = readl(dev->bar + NVME_REG_CMBSZ);
2710 	if (!dev->cmbsz)
2711 		return;
2712 	dev->cmbloc = readl(dev->bar + NVME_REG_CMBLOC);
2713 
2714 	size = nvme_cmb_size_unit(dev) * nvme_cmb_size(dev);
2715 	offset = nvme_cmb_size_unit(dev) * NVME_CMB_OFST(dev->cmbloc);
2716 	bar = NVME_CMB_BIR(dev->cmbloc);
2717 	bar_size = pci_resource_len(pdev, bar);
2718 
2719 	if (offset > bar_size)
2720 		return;
2721 
2722 	/*
2723 	 * Controllers may support a CMB size larger than their BAR, for
2724 	 * example, due to being behind a bridge. Reduce the CMB to the
2725 	 * reported size of the BAR
2726 	 */
2727 	size = min(size, bar_size - offset);
2728 
2729 	if (!IS_ALIGNED(size, memremap_compat_align()) ||
2730 	    !IS_ALIGNED(pci_resource_start(pdev, bar),
2731 			memremap_compat_align()))
2732 		return;
2733 
2734 	/*
2735 	 * Tell the controller about the host side address mapping the CMB,
2736 	 * and enable CMB decoding for the NVMe 1.4+ scheme:
2737 	 */
2738 	if (NVME_CAP_CMBS(dev->ctrl.cap)) {
2739 		hi_lo_writeq(NVME_CMBMSC_CRE | NVME_CMBMSC_CMSE |
2740 			     (pci_bus_address(pdev, bar) + offset),
2741 			     dev->bar + NVME_REG_CMBMSC);
2742 	}
2743 
2744 	if (pci_p2pdma_add_resource(pdev, bar, size, offset)) {
2745 		dev_warn(dev->ctrl.device,
2746 			 "failed to register the CMB\n");
2747 		hi_lo_writeq(0, dev->bar + NVME_REG_CMBMSC);
2748 		return;
2749 	}
2750 
2751 	dev->cmb_size = size;
2752 	dev->cmb_use_sqes = use_cmb_sqes && (dev->cmbsz & NVME_CMBSZ_SQS);
2753 
2754 	if ((dev->cmbsz & (NVME_CMBSZ_WDS | NVME_CMBSZ_RDS)) ==
2755 			(NVME_CMBSZ_WDS | NVME_CMBSZ_RDS))
2756 		pci_p2pmem_publish(pdev, true);
2757 }
2758 
2759 static int nvme_set_host_mem(struct nvme_dev *dev, u32 bits)
2760 {
2761 	u32 host_mem_size = dev->host_mem_size >> NVME_CTRL_PAGE_SHIFT;
2762 	u64 dma_addr = dev->host_mem_descs_dma;
2763 	struct nvme_command c = { };
2764 	int ret;
2765 
2766 	c.features.opcode	= nvme_admin_set_features;
2767 	c.features.fid		= cpu_to_le32(NVME_FEAT_HOST_MEM_BUF);
2768 	c.features.dword11	= cpu_to_le32(bits);
2769 	c.features.dword12	= cpu_to_le32(host_mem_size);
2770 	c.features.dword13	= cpu_to_le32(lower_32_bits(dma_addr));
2771 	c.features.dword14	= cpu_to_le32(upper_32_bits(dma_addr));
2772 	c.features.dword15	= cpu_to_le32(dev->nr_host_mem_descs);
2773 
2774 	ret = nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
2775 	if (ret) {
2776 		dev_warn(dev->ctrl.device,
2777 			 "failed to set host mem (err %d, flags %#x).\n",
2778 			 ret, bits);
2779 	} else
2780 		dev->hmb = bits & NVME_HOST_MEM_ENABLE;
2781 
2782 	return ret;
2783 }
2784 
2785 static void nvme_free_host_mem_multi(struct nvme_dev *dev)
2786 {
2787 	int i;
2788 
2789 	for (i = 0; i < dev->nr_host_mem_descs; i++) {
2790 		struct nvme_host_mem_buf_desc *desc = &dev->host_mem_descs[i];
2791 		size_t size = le32_to_cpu(desc->size) * NVME_CTRL_PAGE_SIZE;
2792 
2793 		dma_free_attrs(dev->dev, size, dev->host_mem_desc_bufs[i],
2794 			       le64_to_cpu(desc->addr),
2795 			       DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
2796 	}
2797 
2798 	kfree(dev->host_mem_desc_bufs);
2799 	dev->host_mem_desc_bufs = NULL;
2800 }
2801 
2802 static void nvme_free_host_mem(struct nvme_dev *dev)
2803 {
2804 	if (dev->hmb_sgt) {
2805 		dma_free_noncontiguous(dev->dev, dev->host_mem_size,
2806 				dev->hmb_sgt, DMA_BIDIRECTIONAL);
2807 		dev->hmb_sgt = NULL;
2808 	} else {
2809 		nvme_free_host_mem_multi(dev);
2810 	}
2811 
2812 	dma_free_coherent(dev->dev, dev->host_mem_descs_size,
2813 			dev->host_mem_descs, dev->host_mem_descs_dma);
2814 	dev->host_mem_descs = NULL;
2815 	dev->host_mem_descs_size = 0;
2816 	dev->nr_host_mem_descs = 0;
2817 }
2818 
2819 static int nvme_alloc_host_mem_single(struct nvme_dev *dev, u64 size)
2820 {
2821 	dev->hmb_sgt = dma_alloc_noncontiguous(dev->dev, size,
2822 				DMA_BIDIRECTIONAL, GFP_KERNEL, 0);
2823 	if (!dev->hmb_sgt)
2824 		return -ENOMEM;
2825 
2826 	dev->host_mem_descs = dma_alloc_coherent(dev->dev,
2827 			sizeof(*dev->host_mem_descs), &dev->host_mem_descs_dma,
2828 			GFP_KERNEL);
2829 	if (!dev->host_mem_descs) {
2830 		dma_free_noncontiguous(dev->dev, size, dev->hmb_sgt,
2831 				DMA_BIDIRECTIONAL);
2832 		dev->hmb_sgt = NULL;
2833 		return -ENOMEM;
2834 	}
2835 	dev->host_mem_size = size;
2836 	dev->host_mem_descs_size = sizeof(*dev->host_mem_descs);
2837 	dev->nr_host_mem_descs = 1;
2838 
2839 	dev->host_mem_descs[0].addr =
2840 		cpu_to_le64(dev->hmb_sgt->sgl->dma_address);
2841 	dev->host_mem_descs[0].size = cpu_to_le32(size / NVME_CTRL_PAGE_SIZE);
2842 	return 0;
2843 }
2844 
2845 static int nvme_alloc_host_mem_multi(struct nvme_dev *dev, u64 preferred,
2846 		u32 chunk_size)
2847 {
2848 	struct nvme_host_mem_buf_desc *descs;
2849 	u32 max_entries, len, descs_size;
2850 	dma_addr_t descs_dma;
2851 	int i = 0;
2852 	void **bufs;
2853 	u64 size, tmp;
2854 
2855 	tmp = (preferred + chunk_size - 1);
2856 	do_div(tmp, chunk_size);
2857 	max_entries = tmp;
2858 
2859 	if (dev->ctrl.hmmaxd && dev->ctrl.hmmaxd < max_entries)
2860 		max_entries = dev->ctrl.hmmaxd;
2861 
2862 	descs_size = max_entries * sizeof(*descs);
2863 	descs = dma_alloc_coherent(dev->dev, descs_size, &descs_dma,
2864 			GFP_KERNEL);
2865 	if (!descs)
2866 		goto out;
2867 
2868 	bufs = kzalloc_objs(*bufs, max_entries);
2869 	if (!bufs)
2870 		goto out_free_descs;
2871 
2872 	for (size = 0; size < preferred && i < max_entries; size += len) {
2873 		dma_addr_t dma_addr;
2874 
2875 		len = min_t(u64, chunk_size, preferred - size);
2876 		bufs[i] = dma_alloc_attrs(dev->dev, len, &dma_addr, GFP_KERNEL,
2877 				DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
2878 		if (!bufs[i])
2879 			break;
2880 
2881 		descs[i].addr = cpu_to_le64(dma_addr);
2882 		descs[i].size = cpu_to_le32(len / NVME_CTRL_PAGE_SIZE);
2883 		i++;
2884 	}
2885 
2886 	if (!size)
2887 		goto out_free_bufs;
2888 
2889 	dev->nr_host_mem_descs = i;
2890 	dev->host_mem_size = size;
2891 	dev->host_mem_descs = descs;
2892 	dev->host_mem_descs_dma = descs_dma;
2893 	dev->host_mem_descs_size = descs_size;
2894 	dev->host_mem_desc_bufs = bufs;
2895 	return 0;
2896 
2897 out_free_bufs:
2898 	kfree(bufs);
2899 out_free_descs:
2900 	dma_free_coherent(dev->dev, descs_size, descs, descs_dma);
2901 out:
2902 	dev->host_mem_descs = NULL;
2903 	return -ENOMEM;
2904 }
2905 
2906 static int nvme_alloc_host_mem(struct nvme_dev *dev, u64 min, u64 preferred)
2907 {
2908 	unsigned long dma_merge_boundary = dma_get_merge_boundary(dev->dev);
2909 	u64 min_chunk = min_t(u64, preferred, PAGE_SIZE * MAX_ORDER_NR_PAGES);
2910 	u64 hmminds = max_t(u32, dev->ctrl.hmminds * 4096, PAGE_SIZE * 2);
2911 	u64 chunk_size;
2912 
2913 	/*
2914 	 * If there is an IOMMU that can merge pages, try a virtually
2915 	 * non-contiguous allocation for a single segment first.
2916 	 */
2917 	if (dma_merge_boundary && (PAGE_SIZE & dma_merge_boundary) == 0) {
2918 		if (!nvme_alloc_host_mem_single(dev, preferred))
2919 			return 0;
2920 	}
2921 
2922 	/* start big and work our way down */
2923 	for (chunk_size = min_chunk; chunk_size >= hmminds; chunk_size /= 2) {
2924 		if (!nvme_alloc_host_mem_multi(dev, preferred, chunk_size)) {
2925 			if (!min || dev->host_mem_size >= min)
2926 				return 0;
2927 			nvme_free_host_mem(dev);
2928 		}
2929 	}
2930 
2931 	return -ENOMEM;
2932 }
2933 
2934 static int nvme_setup_host_mem(struct nvme_dev *dev)
2935 {
2936 	u64 max = (u64)max_host_mem_size_mb * SZ_1M;
2937 	u64 preferred = (u64)dev->ctrl.hmpre * 4096;
2938 	u64 min = (u64)dev->ctrl.hmmin * 4096;
2939 	u32 enable_bits = NVME_HOST_MEM_ENABLE;
2940 	int ret;
2941 
2942 	if (!dev->ctrl.hmpre)
2943 		return 0;
2944 
2945 	preferred = min(preferred, max);
2946 	if (min > max) {
2947 		dev_warn(dev->ctrl.device,
2948 			"min host memory (%lld MiB) above limit (%d MiB).\n",
2949 			min >> ilog2(SZ_1M), max_host_mem_size_mb);
2950 		nvme_free_host_mem(dev);
2951 		return 0;
2952 	}
2953 
2954 	/*
2955 	 * If we already have a buffer allocated check if we can reuse it.
2956 	 */
2957 	if (dev->host_mem_descs) {
2958 		if (dev->host_mem_size >= min)
2959 			enable_bits |= NVME_HOST_MEM_RETURN;
2960 		else
2961 			nvme_free_host_mem(dev);
2962 	}
2963 
2964 	if (!dev->host_mem_descs) {
2965 		if (nvme_alloc_host_mem(dev, min, preferred)) {
2966 			dev_warn(dev->ctrl.device,
2967 				"failed to allocate host memory buffer.\n");
2968 			return 0; /* controller must work without HMB */
2969 		}
2970 
2971 		dev_info(dev->ctrl.device,
2972 			"allocated %lld MiB host memory buffer (%u segment%s).\n",
2973 			dev->host_mem_size >> ilog2(SZ_1M),
2974 			dev->nr_host_mem_descs,
2975 			str_plural(dev->nr_host_mem_descs));
2976 	}
2977 
2978 	ret = nvme_set_host_mem(dev, enable_bits);
2979 	if (ret)
2980 		nvme_free_host_mem(dev);
2981 	return ret;
2982 }
2983 
2984 static ssize_t cmb_show(struct device *dev, struct device_attribute *attr,
2985 		char *buf)
2986 {
2987 	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
2988 
2989 	return sysfs_emit(buf, "cmbloc : 0x%08x\ncmbsz  : 0x%08x\n",
2990 		       ndev->cmbloc, ndev->cmbsz);
2991 }
2992 static DEVICE_ATTR_RO(cmb);
2993 
2994 static ssize_t cmbloc_show(struct device *dev, struct device_attribute *attr,
2995 		char *buf)
2996 {
2997 	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
2998 
2999 	return sysfs_emit(buf, "%u\n", ndev->cmbloc);
3000 }
3001 static DEVICE_ATTR_RO(cmbloc);
3002 
3003 static ssize_t cmbsz_show(struct device *dev, struct device_attribute *attr,
3004 		char *buf)
3005 {
3006 	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
3007 
3008 	return sysfs_emit(buf, "%u\n", ndev->cmbsz);
3009 }
3010 static DEVICE_ATTR_RO(cmbsz);
3011 
3012 static ssize_t hmb_show(struct device *dev, struct device_attribute *attr,
3013 			char *buf)
3014 {
3015 	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
3016 
3017 	return sysfs_emit(buf, "%d\n", ndev->hmb);
3018 }
3019 
3020 static ssize_t hmb_store(struct device *dev, struct device_attribute *attr,
3021 			 const char *buf, size_t count)
3022 {
3023 	struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
3024 	bool new;
3025 	int ret;
3026 
3027 	if (kstrtobool(buf, &new) < 0)
3028 		return -EINVAL;
3029 
3030 	if (new == ndev->hmb)
3031 		return count;
3032 
3033 	if (new) {
3034 		ret = nvme_setup_host_mem(ndev);
3035 	} else {
3036 		ret = nvme_set_host_mem(ndev, 0);
3037 		if (!ret)
3038 			nvme_free_host_mem(ndev);
3039 	}
3040 
3041 	if (ret < 0)
3042 		return ret;
3043 
3044 	return count;
3045 }
3046 static DEVICE_ATTR_RW(hmb);
3047 
3048 static umode_t nvme_pci_attrs_are_visible(struct kobject *kobj,
3049 		struct attribute *a, int n)
3050 {
3051 	struct nvme_ctrl *ctrl =
3052 		dev_get_drvdata(container_of(kobj, struct device, kobj));
3053 	struct nvme_dev *dev = to_nvme_dev(ctrl);
3054 
3055 	if (a == &dev_attr_cmb.attr ||
3056 	    a == &dev_attr_cmbloc.attr ||
3057 	    a == &dev_attr_cmbsz.attr) {
3058 	    	if (!dev->cmbsz)
3059 			return 0;
3060 	}
3061 	if (a == &dev_attr_hmb.attr && !ctrl->hmpre)
3062 		return 0;
3063 
3064 	return a->mode;
3065 }
3066 
3067 static struct attribute *nvme_pci_attrs[] = {
3068 	&dev_attr_cmb.attr,
3069 	&dev_attr_cmbloc.attr,
3070 	&dev_attr_cmbsz.attr,
3071 	&dev_attr_hmb.attr,
3072 	NULL,
3073 };
3074 
3075 static const struct attribute_group nvme_pci_dev_attrs_group = {
3076 	.attrs		= nvme_pci_attrs,
3077 	.is_visible	= nvme_pci_attrs_are_visible,
3078 };
3079 
3080 static const struct attribute_group *nvme_pci_dev_attr_groups[] = {
3081 	&nvme_dev_attrs_group,
3082 	&nvme_pci_dev_attrs_group,
3083 	&nvme_dev_diag_attrs_group,
3084 	NULL,
3085 };
3086 
3087 static void nvme_update_attrs(struct nvme_dev *dev)
3088 {
3089 	sysfs_update_group(&dev->ctrl.device->kobj, &nvme_pci_dev_attrs_group);
3090 }
3091 
3092 /*
3093  * nirqs is the number of interrupts available for write and read
3094  * queues. The core already reserved an interrupt for the admin queue.
3095  */
3096 static void nvme_calc_irq_sets(struct irq_affinity *affd, unsigned int nrirqs)
3097 {
3098 	struct nvme_dev *dev = affd->priv;
3099 	unsigned int nr_read_queues, nr_write_queues = dev->nr_write_queues;
3100 
3101 	/*
3102 	 * If there is no interrupt available for queues, ensure that
3103 	 * the default queue is set to 1. The affinity set size is
3104 	 * also set to one, but the irq core ignores it for this case.
3105 	 *
3106 	 * If only one interrupt is available or 'write_queue' == 0, combine
3107 	 * write and read queues.
3108 	 *
3109 	 * If 'write_queues' > 0, ensure it leaves room for at least one read
3110 	 * queue.
3111 	 */
3112 	if (!nrirqs) {
3113 		nrirqs = 1;
3114 		nr_read_queues = 0;
3115 	} else if (nrirqs == 1 || !nr_write_queues) {
3116 		nr_read_queues = 0;
3117 	} else if (nr_write_queues >= nrirqs) {
3118 		nr_read_queues = 1;
3119 	} else {
3120 		nr_read_queues = nrirqs - nr_write_queues;
3121 	}
3122 
3123 	dev->io_queues[HCTX_TYPE_DEFAULT] = nrirqs - nr_read_queues;
3124 	affd->set_size[HCTX_TYPE_DEFAULT] = nrirqs - nr_read_queues;
3125 	dev->io_queues[HCTX_TYPE_READ] = nr_read_queues;
3126 	affd->set_size[HCTX_TYPE_READ] = nr_read_queues;
3127 	affd->nr_sets = nr_read_queues ? 2 : 1;
3128 }
3129 
3130 static int nvme_setup_irqs(struct nvme_dev *dev, unsigned int nr_io_queues)
3131 {
3132 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3133 	struct irq_affinity affd = {
3134 		.pre_vectors	= 1,
3135 		.calc_sets	= nvme_calc_irq_sets,
3136 		.priv		= dev,
3137 	};
3138 	unsigned int irq_queues, poll_queues;
3139 	unsigned int flags = PCI_IRQ_ALL_TYPES | PCI_IRQ_AFFINITY;
3140 
3141 	/*
3142 	 * Poll queues don't need interrupts, but we need at least one I/O queue
3143 	 * left over for non-polled I/O.
3144 	 */
3145 	poll_queues = min(dev->nr_poll_queues, nr_io_queues - 1);
3146 	dev->io_queues[HCTX_TYPE_POLL] = poll_queues;
3147 
3148 	/*
3149 	 * Initialize for the single interrupt case, will be updated in
3150 	 * nvme_calc_irq_sets().
3151 	 */
3152 	dev->io_queues[HCTX_TYPE_DEFAULT] = 1;
3153 	dev->io_queues[HCTX_TYPE_READ] = 0;
3154 
3155 	/*
3156 	 * We need interrupts for the admin queue and each non-polled I/O queue,
3157 	 * but some Apple controllers require all queues to use the first
3158 	 * vector.
3159 	 */
3160 	irq_queues = 1;
3161 	if (!(dev->ctrl.quirks & NVME_QUIRK_SINGLE_VECTOR))
3162 		irq_queues += (nr_io_queues - poll_queues);
3163 	if (dev->ctrl.quirks & NVME_QUIRK_BROKEN_MSI)
3164 		flags &= ~PCI_IRQ_MSI;
3165 	return pci_alloc_irq_vectors_affinity(pdev, 1, irq_queues, flags,
3166 					      &affd);
3167 }
3168 
3169 static unsigned int nvme_max_io_queues(struct nvme_dev *dev)
3170 {
3171 	/*
3172 	 * If tags are shared with admin queue (Apple bug), then
3173 	 * make sure we only use one IO queue.
3174 	 */
3175 	if (dev->ctrl.quirks & NVME_QUIRK_SHARED_TAGS)
3176 		return 1;
3177 	return blk_mq_num_possible_queues(0) + dev->nr_write_queues +
3178 		dev->nr_poll_queues;
3179 }
3180 
3181 static int nvme_setup_io_queues(struct nvme_dev *dev)
3182 {
3183 	struct nvme_queue *adminq = &dev->queues[0];
3184 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3185 	unsigned int nr_io_queues;
3186 	unsigned long size;
3187 	int result;
3188 
3189 	/*
3190 	 * Sample the module parameters once at reset time so that we have
3191 	 * stable values to work with.
3192 	 */
3193 	dev->nr_write_queues = write_queues;
3194 	dev->nr_poll_queues = poll_queues;
3195 
3196 	if (dev->ctrl.tagset) {
3197 		/*
3198 		 * The set's maps are allocated only once at initialization
3199 		 * time. We can't add special queues later if their mq_map
3200 		 * wasn't preallocated.
3201 		 */
3202 		if (dev->ctrl.tagset->nr_maps < 3)
3203 			dev->nr_poll_queues = 0;
3204 		if (dev->ctrl.tagset->nr_maps < 2)
3205 			dev->nr_write_queues = 0;
3206 	}
3207 
3208 	/*
3209 	 * The initial number of allocated queue slots may be too large if the
3210 	 * user reduced the special queue parameters. Cap the value to the
3211 	 * number we need for this round.
3212 	 */
3213 	nr_io_queues = min(nvme_max_io_queues(dev),
3214 			   dev->nr_allocated_queues - 1);
3215 	result = nvme_set_queue_count(&dev->ctrl, &nr_io_queues);
3216 	if (result < 0)
3217 		return result;
3218 
3219 	if (nr_io_queues == 0)
3220 		return 0;
3221 
3222 	/*
3223 	 * Free IRQ resources as soon as NVMEQ_ENABLED bit transitions
3224 	 * from set to unset. If there is a window to it is truely freed,
3225 	 * pci_free_irq_vectors() jumping into this window will crash.
3226 	 * And take lock to avoid racing with pci_free_irq_vectors() in
3227 	 * nvme_dev_disable() path.
3228 	 */
3229 	result = nvme_setup_io_queues_trylock(dev);
3230 	if (result)
3231 		return result;
3232 	if (test_and_clear_bit(NVMEQ_ENABLED, &adminq->flags))
3233 		pci_free_irq(pdev, 0, adminq);
3234 
3235 	if (dev->cmb_use_sqes) {
3236 		result = nvme_cmb_qdepth(dev, nr_io_queues,
3237 				sizeof(struct nvme_command));
3238 		if (result > 0) {
3239 			dev->q_depth = result;
3240 			dev->ctrl.sqsize = result - 1;
3241 		} else {
3242 			dev->cmb_use_sqes = false;
3243 		}
3244 	}
3245 
3246 	do {
3247 		size = db_bar_size(dev, nr_io_queues);
3248 		result = nvme_remap_bar(dev, size);
3249 		if (!result)
3250 			break;
3251 		if (!--nr_io_queues) {
3252 			result = -ENOMEM;
3253 			goto out_unlock;
3254 		}
3255 	} while (1);
3256 	adminq->q_db = dev->dbs;
3257 
3258  retry:
3259 	/* Deregister the admin queue's interrupt */
3260 	if (test_and_clear_bit(NVMEQ_ENABLED, &adminq->flags))
3261 		pci_free_irq(pdev, 0, adminq);
3262 
3263 	/*
3264 	 * If we enable msix early due to not intx, disable it again before
3265 	 * setting up the full range we need.
3266 	 */
3267 	pci_free_irq_vectors(pdev);
3268 
3269 	result = nvme_setup_irqs(dev, nr_io_queues);
3270 	if (result <= 0) {
3271 		result = -EIO;
3272 		goto out_unlock;
3273 	}
3274 
3275 	dev->num_vecs = result;
3276 	result = max(result - 1, 1);
3277 	dev->max_qid = result + dev->io_queues[HCTX_TYPE_POLL];
3278 
3279 	/*
3280 	 * Should investigate if there's a performance win from allocating
3281 	 * more queues than interrupt vectors; it might allow the submission
3282 	 * path to scale better, even if the receive path is limited by the
3283 	 * number of interrupts.
3284 	 */
3285 	result = queue_request_irq(adminq);
3286 	if (result)
3287 		goto out_unlock;
3288 	set_bit(NVMEQ_ENABLED, &adminq->flags);
3289 	mutex_unlock(&dev->shutdown_lock);
3290 
3291 	result = nvme_create_io_queues(dev);
3292 	if (result || dev->online_queues < 2)
3293 		return result;
3294 
3295 	if (dev->online_queues - 1 < dev->max_qid) {
3296 		nr_io_queues = dev->online_queues - 1;
3297 		nvme_delete_io_queues(dev);
3298 		result = nvme_setup_io_queues_trylock(dev);
3299 		if (result)
3300 			return result;
3301 		nvme_suspend_io_queues(dev);
3302 		goto retry;
3303 	}
3304 	dev_info(dev->ctrl.device, "%d/%d/%d default/read/poll queues\n",
3305 					dev->io_queues[HCTX_TYPE_DEFAULT],
3306 					dev->io_queues[HCTX_TYPE_READ],
3307 					dev->io_queues[HCTX_TYPE_POLL]);
3308 	return 0;
3309 out_unlock:
3310 	mutex_unlock(&dev->shutdown_lock);
3311 	return result;
3312 }
3313 
3314 static enum rq_end_io_ret nvme_del_queue_end(struct request *req,
3315 					     blk_status_t error,
3316 					     const struct io_comp_batch *iob)
3317 {
3318 	struct nvme_queue *nvmeq = req->end_io_data;
3319 
3320 	blk_mq_free_request(req);
3321 	complete(&nvmeq->delete_done);
3322 	return RQ_END_IO_NONE;
3323 }
3324 
3325 static enum rq_end_io_ret nvme_del_cq_end(struct request *req,
3326 					  blk_status_t error,
3327 					  const struct io_comp_batch *iob)
3328 {
3329 	struct nvme_queue *nvmeq = req->end_io_data;
3330 
3331 	if (error)
3332 		set_bit(NVMEQ_DELETE_ERROR, &nvmeq->flags);
3333 
3334 	return nvme_del_queue_end(req, error, iob);
3335 }
3336 
3337 static int nvme_delete_queue(struct nvme_queue *nvmeq, u8 opcode)
3338 {
3339 	struct request_queue *q = nvmeq->dev->ctrl.admin_q;
3340 	struct request *req;
3341 	struct nvme_command cmd = { };
3342 
3343 	cmd.delete_queue.opcode = opcode;
3344 	cmd.delete_queue.qid = cpu_to_le16(nvmeq->qid);
3345 
3346 	req = blk_mq_alloc_request(q, nvme_req_op(&cmd), BLK_MQ_REQ_NOWAIT);
3347 	if (IS_ERR(req))
3348 		return PTR_ERR(req);
3349 	nvme_init_request(req, &cmd);
3350 
3351 	if (opcode == nvme_admin_delete_cq)
3352 		req->end_io = nvme_del_cq_end;
3353 	else
3354 		req->end_io = nvme_del_queue_end;
3355 	req->end_io_data = nvmeq;
3356 
3357 	init_completion(&nvmeq->delete_done);
3358 	blk_execute_rq_nowait(req, false);
3359 	return 0;
3360 }
3361 
3362 static bool __nvme_delete_io_queues(struct nvme_dev *dev, u8 opcode)
3363 {
3364 	int nr_queues = dev->online_queues - 1, sent = 0;
3365 	unsigned long timeout;
3366 
3367  retry:
3368 	timeout = dev->ctrl.admin_timeout;
3369 	while (nr_queues > 0) {
3370 		if (nvme_delete_queue(&dev->queues[nr_queues], opcode))
3371 			break;
3372 		nr_queues--;
3373 		sent++;
3374 	}
3375 	while (sent) {
3376 		struct nvme_queue *nvmeq = &dev->queues[nr_queues + sent];
3377 
3378 		timeout = wait_for_completion_io_timeout(&nvmeq->delete_done,
3379 				timeout);
3380 		if (timeout == 0)
3381 			return false;
3382 
3383 		sent--;
3384 		if (nr_queues)
3385 			goto retry;
3386 	}
3387 	return true;
3388 }
3389 
3390 static void nvme_delete_io_queues(struct nvme_dev *dev)
3391 {
3392 	if (__nvme_delete_io_queues(dev, nvme_admin_delete_sq))
3393 		__nvme_delete_io_queues(dev, nvme_admin_delete_cq);
3394 }
3395 
3396 static unsigned int nvme_pci_nr_maps(struct nvme_dev *dev)
3397 {
3398 	if (dev->io_queues[HCTX_TYPE_POLL])
3399 		return 3;
3400 	if (dev->io_queues[HCTX_TYPE_READ])
3401 		return 2;
3402 	return 1;
3403 }
3404 
3405 static bool nvme_pci_update_nr_queues(struct nvme_dev *dev)
3406 {
3407 	if (!dev->ctrl.tagset) {
3408 		nvme_alloc_io_tag_set(&dev->ctrl, &dev->tagset, &nvme_mq_ops,
3409 				nvme_pci_nr_maps(dev), sizeof(struct nvme_iod));
3410 		return true;
3411 	}
3412 
3413 	/* Give up if we are racing with nvme_dev_disable() */
3414 	if (!mutex_trylock(&dev->shutdown_lock))
3415 		return false;
3416 
3417 	/* Check if nvme_dev_disable() has been executed already */
3418 	if (!dev->online_queues) {
3419 		mutex_unlock(&dev->shutdown_lock);
3420 		return false;
3421 	}
3422 
3423 	blk_mq_update_nr_hw_queues(&dev->tagset, dev->online_queues - 1);
3424 	/* free previously allocated queues that are no longer usable */
3425 	nvme_free_queues(dev, dev->online_queues);
3426 	mutex_unlock(&dev->shutdown_lock);
3427 	return true;
3428 }
3429 
3430 static int nvme_pci_enable(struct nvme_dev *dev)
3431 {
3432 	int result = -ENOMEM;
3433 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3434 	unsigned int flags = PCI_IRQ_ALL_TYPES;
3435 
3436 	if (pci_enable_device_mem(pdev))
3437 		return result;
3438 
3439 	pci_set_master(pdev);
3440 
3441 	if (readl(dev->bar + NVME_REG_CSTS) == -1) {
3442 		dev_dbg(dev->ctrl.device, "reading CSTS register failed\n");
3443 		result = -ENODEV;
3444 		goto disable;
3445 	}
3446 
3447 	/*
3448 	 * Some devices and/or platforms don't advertise or work with INTx
3449 	 * interrupts. Pre-enable a single MSIX or MSI vec for setup. We'll
3450 	 * adjust this later.
3451 	 */
3452 	if (dev->ctrl.quirks & NVME_QUIRK_BROKEN_MSI)
3453 		flags &= ~PCI_IRQ_MSI;
3454 	result = pci_alloc_irq_vectors(pdev, 1, 1, flags);
3455 	if (result < 0)
3456 		goto disable;
3457 
3458 	dev->ctrl.cap = lo_hi_readq(dev->bar + NVME_REG_CAP);
3459 
3460 	dev->q_depth = min_t(u32, NVME_CAP_MQES(dev->ctrl.cap) + 1,
3461 				io_queue_depth);
3462 	dev->db_stride = 1 << NVME_CAP_STRIDE(dev->ctrl.cap);
3463 	dev->dbs = dev->bar + 4096;
3464 
3465 	/*
3466 	 * Some Apple controllers require a non-standard SQE size.
3467 	 * Interestingly they also seem to ignore the CC:IOSQES register
3468 	 * so we don't bother updating it here.
3469 	 */
3470 	if (dev->ctrl.quirks & NVME_QUIRK_128_BYTES_SQES)
3471 		dev->io_sqes = 7;
3472 	else
3473 		dev->io_sqes = NVME_NVM_IOSQES;
3474 
3475 	if (dev->ctrl.quirks & NVME_QUIRK_QDEPTH_ONE) {
3476 		dev->q_depth = 2;
3477 	} else if (pdev->vendor == PCI_VENDOR_ID_SAMSUNG &&
3478 		   (pdev->device == 0xa821 || pdev->device == 0xa822) &&
3479 		   NVME_CAP_MQES(dev->ctrl.cap) == 0) {
3480 		dev->q_depth = 64;
3481 		dev_err(dev->ctrl.device, "detected PM1725 NVMe controller, "
3482                         "set queue depth=%u\n", dev->q_depth);
3483 	}
3484 
3485 	/*
3486 	 * Controllers with the shared tags quirk need the IO queue to be
3487 	 * big enough so that we get 32 tags for the admin queue
3488 	 */
3489 	if ((dev->ctrl.quirks & NVME_QUIRK_SHARED_TAGS) &&
3490 	    (dev->q_depth < (NVME_AQ_DEPTH + 2))) {
3491 		dev->q_depth = NVME_AQ_DEPTH + 2;
3492 		dev_warn(dev->ctrl.device, "IO queue depth clamped to %d\n",
3493 			 dev->q_depth);
3494 	}
3495 	dev->ctrl.sqsize = dev->q_depth - 1; /* 0's based queue depth */
3496 
3497 	nvme_map_cmb(dev);
3498 
3499 	pci_save_state(pdev);
3500 
3501 	result = nvme_pci_configure_admin_queue(dev);
3502 	if (result)
3503 		goto free_irq;
3504 	return result;
3505 
3506  free_irq:
3507 	pci_free_irq_vectors(pdev);
3508  disable:
3509 	pci_disable_device(pdev);
3510 	return result;
3511 }
3512 
3513 static void nvme_dev_unmap(struct nvme_dev *dev)
3514 {
3515 	if (dev->bar)
3516 		iounmap(dev->bar);
3517 	pci_release_mem_regions(to_pci_dev(dev->dev));
3518 }
3519 
3520 static bool nvme_pci_ctrl_is_dead(struct nvme_dev *dev)
3521 {
3522 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3523 	u32 csts;
3524 
3525 	if (!pci_is_enabled(pdev) || !pci_device_is_present(pdev))
3526 		return true;
3527 	if (pdev->error_state != pci_channel_io_normal)
3528 		return true;
3529 
3530 	csts = readl(dev->bar + NVME_REG_CSTS);
3531 	return (csts & NVME_CSTS_CFS) || !(csts & NVME_CSTS_RDY);
3532 }
3533 
3534 static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown)
3535 {
3536 	enum nvme_ctrl_state state = nvme_ctrl_state(&dev->ctrl);
3537 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3538 	bool dead;
3539 
3540 	mutex_lock(&dev->shutdown_lock);
3541 	dead = nvme_pci_ctrl_is_dead(dev);
3542 	if (state == NVME_CTRL_LIVE || state == NVME_CTRL_RESETTING) {
3543 		if (pci_is_enabled(pdev))
3544 			nvme_start_freeze(&dev->ctrl);
3545 		/*
3546 		 * Give the controller a chance to complete all entered requests
3547 		 * if doing a safe shutdown.
3548 		 */
3549 		if (!dead && shutdown)
3550 			nvme_wait_freeze_timeout(&dev->ctrl);
3551 	}
3552 
3553 	nvme_quiesce_io_queues(&dev->ctrl);
3554 
3555 	if (!dead && dev->ctrl.queue_count > 0) {
3556 		nvme_delete_io_queues(dev);
3557 		nvme_disable_ctrl(&dev->ctrl, shutdown);
3558 		nvme_poll_irqdisable(&dev->queues[0]);
3559 	}
3560 	nvme_suspend_io_queues(dev);
3561 	nvme_suspend_queue(dev, 0);
3562 	pci_free_irq_vectors(pdev);
3563 	if (pci_is_enabled(pdev))
3564 		pci_disable_device(pdev);
3565 	nvme_reap_pending_cqes(dev);
3566 
3567 	nvme_cancel_tagset(&dev->ctrl);
3568 	nvme_cancel_admin_tagset(&dev->ctrl);
3569 
3570 	/*
3571 	 * The driver will not be starting up queues again if shutting down so
3572 	 * must flush all entered requests to their failed completion to avoid
3573 	 * deadlocking blk-mq hot-cpu notifier.
3574 	 */
3575 	if (shutdown) {
3576 		nvme_unquiesce_io_queues(&dev->ctrl);
3577 		if (dev->ctrl.admin_q && !blk_queue_dying(dev->ctrl.admin_q))
3578 			nvme_unquiesce_admin_queue(&dev->ctrl);
3579 	}
3580 	mutex_unlock(&dev->shutdown_lock);
3581 }
3582 
3583 static int nvme_disable_prepare_reset(struct nvme_dev *dev, bool shutdown)
3584 {
3585 	if (!nvme_wait_reset(&dev->ctrl))
3586 		return -EBUSY;
3587 	nvme_dev_disable(dev, shutdown);
3588 	return 0;
3589 }
3590 
3591 static int nvme_pci_alloc_iod_mempool(struct nvme_dev *dev)
3592 {
3593 	size_t alloc_size = sizeof(struct nvme_dma_vec) * NVME_MAX_SEGS;
3594 
3595 	dev->dmavec_mempool = mempool_create_node(1,
3596 			mempool_kmalloc, mempool_kfree,
3597 			(void *)alloc_size, GFP_KERNEL,
3598 			dev_to_node(dev->dev));
3599 	if (!dev->dmavec_mempool)
3600 		return -ENOMEM;
3601 	return 0;
3602 }
3603 
3604 static void nvme_free_tagset(struct nvme_dev *dev)
3605 {
3606 	if (dev->tagset.tags)
3607 		nvme_remove_io_tag_set(&dev->ctrl);
3608 	dev->ctrl.tagset = NULL;
3609 }
3610 
3611 /* pairs with nvme_pci_alloc_dev */
3612 static void nvme_pci_free_ctrl(struct nvme_ctrl *ctrl)
3613 {
3614 	struct nvme_dev *dev = to_nvme_dev(ctrl);
3615 
3616 	nvme_free_tagset(dev);
3617 	put_device(dev->dev);
3618 	kfree(dev->queues);
3619 	kfree(dev);
3620 }
3621 
3622 static void nvme_reset_work(struct work_struct *work)
3623 {
3624 	struct nvme_dev *dev =
3625 		container_of(work, struct nvme_dev, ctrl.reset_work);
3626 	bool was_suspend = !!(dev->ctrl.ctrl_config & NVME_CC_SHN_NORMAL);
3627 	int result;
3628 
3629 	if (nvme_ctrl_state(&dev->ctrl) != NVME_CTRL_RESETTING) {
3630 		dev_warn(dev->ctrl.device, "ctrl state %d is not RESETTING\n",
3631 			 dev->ctrl.state);
3632 		result = -ENODEV;
3633 		goto out;
3634 	}
3635 
3636 	/*
3637 	 * If we're called to reset a live controller first shut it down before
3638 	 * moving on.
3639 	 */
3640 	if (dev->ctrl.ctrl_config & NVME_CC_ENABLE)
3641 		nvme_dev_disable(dev, false);
3642 	nvme_sync_queues(&dev->ctrl);
3643 
3644 	mutex_lock(&dev->shutdown_lock);
3645 	result = nvme_pci_enable(dev);
3646 	if (result)
3647 		goto out_unlock;
3648 	nvme_unquiesce_admin_queue(&dev->ctrl);
3649 	mutex_unlock(&dev->shutdown_lock);
3650 
3651 	/*
3652 	 * Introduce CONNECTING state from nvme-fc/rdma transports to mark the
3653 	 * initializing procedure here.
3654 	 */
3655 	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_CONNECTING)) {
3656 		dev_warn(dev->ctrl.device,
3657 			"failed to mark controller CONNECTING\n");
3658 		result = -EBUSY;
3659 		goto out;
3660 	}
3661 
3662 	result = nvme_init_ctrl_finish(&dev->ctrl, was_suspend);
3663 	if (result)
3664 		goto out;
3665 
3666 	if (nvme_ctrl_meta_sgl_supported(&dev->ctrl))
3667 		dev->ctrl.max_integrity_segments = NVME_MAX_META_SEGS;
3668 	else
3669 		dev->ctrl.max_integrity_segments = 1;
3670 
3671 	nvme_dbbuf_dma_alloc(dev);
3672 
3673 	result = nvme_setup_host_mem(dev);
3674 	if (result < 0)
3675 		goto out;
3676 
3677 	nvme_update_attrs(dev);
3678 
3679 	result = nvme_setup_io_queues(dev);
3680 	if (result)
3681 		goto out;
3682 
3683 	/*
3684 	 * Freeze and update the number of I/O queues as those might have
3685 	 * changed.  If there are no I/O queues left after this reset, keep the
3686 	 * controller around but remove all namespaces.
3687 	 */
3688 	if (dev->online_queues > 1) {
3689 		nvme_dbbuf_set(dev);
3690 		nvme_unquiesce_io_queues(&dev->ctrl);
3691 		nvme_wait_freeze(&dev->ctrl);
3692 		if (!nvme_pci_update_nr_queues(dev))
3693 			goto out;
3694 		nvme_unfreeze(&dev->ctrl);
3695 	} else {
3696 		dev_warn(dev->ctrl.device, "IO queues lost\n");
3697 		nvme_mark_namespaces_dead(&dev->ctrl);
3698 		nvme_unquiesce_io_queues(&dev->ctrl);
3699 		nvme_remove_namespaces(&dev->ctrl);
3700 		nvme_free_tagset(dev);
3701 	}
3702 
3703 	/*
3704 	 * If only admin queue live, keep it to do further investigation or
3705 	 * recovery.
3706 	 */
3707 	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_LIVE)) {
3708 		dev_warn(dev->ctrl.device,
3709 			"failed to mark controller live state\n");
3710 		result = -ENODEV;
3711 		goto out;
3712 	}
3713 
3714 	nvme_start_ctrl(&dev->ctrl);
3715 	return;
3716 
3717  out_unlock:
3718 	mutex_unlock(&dev->shutdown_lock);
3719  out:
3720 	/*
3721 	 * Set state to deleting now to avoid blocking nvme_wait_reset(), which
3722 	 * may be holding this pci_dev's device lock.
3723 	 */
3724 	dev_warn(dev->ctrl.device, "Disabling device after reset failure: %d\n",
3725 		 result);
3726 	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
3727 	nvme_dev_disable(dev, true);
3728 	nvme_sync_queues(&dev->ctrl);
3729 	nvme_mark_namespaces_dead(&dev->ctrl);
3730 	nvme_unquiesce_io_queues(&dev->ctrl);
3731 	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DEAD);
3732 }
3733 
3734 static int nvme_pci_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val)
3735 {
3736 	*val = readl(to_nvme_dev(ctrl)->bar + off);
3737 	return 0;
3738 }
3739 
3740 static int nvme_pci_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val)
3741 {
3742 	writel(val, to_nvme_dev(ctrl)->bar + off);
3743 	return 0;
3744 }
3745 
3746 static int nvme_pci_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val)
3747 {
3748 	*val = lo_hi_readq(to_nvme_dev(ctrl)->bar + off);
3749 	return 0;
3750 }
3751 
3752 static int nvme_pci_get_address(struct nvme_ctrl *ctrl, char *buf, int size)
3753 {
3754 	struct pci_dev *pdev = to_pci_dev(to_nvme_dev(ctrl)->dev);
3755 
3756 	return snprintf(buf, size, "%s\n", dev_name(&pdev->dev));
3757 }
3758 
3759 static void nvme_pci_print_device_info(struct nvme_ctrl *ctrl)
3760 {
3761 	struct pci_dev *pdev = to_pci_dev(to_nvme_dev(ctrl)->dev);
3762 	struct nvme_subsystem *subsys = ctrl->subsys;
3763 
3764 	dev_err(ctrl->device,
3765 		"VID:DID %04x:%04x model:%.*s firmware:%.*s\n",
3766 		pdev->vendor, pdev->device,
3767 		nvme_strlen(subsys->model, sizeof(subsys->model)),
3768 		subsys->model, nvme_strlen(subsys->firmware_rev,
3769 					   sizeof(subsys->firmware_rev)),
3770 		subsys->firmware_rev);
3771 }
3772 
3773 static bool nvme_pci_supports_pci_p2pdma(struct nvme_ctrl *ctrl)
3774 {
3775 	struct nvme_dev *dev = to_nvme_dev(ctrl);
3776 
3777 	return dma_pci_p2pdma_supported(dev->dev);
3778 }
3779 
3780 static unsigned long nvme_pci_get_virt_boundary(struct nvme_ctrl *ctrl,
3781 						bool is_admin)
3782 {
3783 	if (!nvme_ctrl_sgl_supported(ctrl) || is_admin)
3784 		return NVME_CTRL_PAGE_SIZE - 1;
3785 	return 0;
3786 }
3787 
3788 static int nvme_pci_init_dma_buf_io_ctx(struct nvme_ctrl *ctrl,
3789 		struct dma_buf_io_ctx *ctx)
3790 {
3791 	struct nvme_dev *dev = to_nvme_dev(ctrl);
3792 
3793 	return nvme_init_dma_buf_io_ctx(ctrl, &dev->dmabufs, ctx);
3794 }
3795 
3796 static const struct nvme_ctrl_ops nvme_pci_ctrl_ops = {
3797 	.name			= "pcie",
3798 	.module			= THIS_MODULE,
3799 	.flags			= NVME_F_METADATA_SUPPORTED,
3800 	.dev_attr_groups	= nvme_pci_dev_attr_groups,
3801 	.reg_read32		= nvme_pci_reg_read32,
3802 	.reg_write32		= nvme_pci_reg_write32,
3803 	.reg_read64		= nvme_pci_reg_read64,
3804 	.free_ctrl		= nvme_pci_free_ctrl,
3805 	.submit_async_event	= nvme_pci_submit_async_event,
3806 	.subsystem_reset	= nvme_pci_subsystem_reset,
3807 	.get_address		= nvme_pci_get_address,
3808 	.print_device_info	= nvme_pci_print_device_info,
3809 	.supports_pci_p2pdma	= nvme_pci_supports_pci_p2pdma,
3810 	.get_virt_boundary	= nvme_pci_get_virt_boundary,
3811 	.init_dma_buf_io_ctx	= nvme_pci_init_dma_buf_io_ctx,
3812 };
3813 
3814 static int nvme_dev_map(struct nvme_dev *dev)
3815 {
3816 	struct pci_dev *pdev = to_pci_dev(dev->dev);
3817 
3818 	if (pci_request_mem_regions(pdev, "nvme"))
3819 		return -ENODEV;
3820 
3821 	if (nvme_remap_bar(dev, NVME_REG_DBS + 4096))
3822 		goto release;
3823 
3824 	return 0;
3825   release:
3826 	pci_release_mem_regions(pdev);
3827 	return -ENODEV;
3828 }
3829 
3830 static unsigned long check_vendor_combination_bug(struct pci_dev *pdev)
3831 {
3832 	if (pdev->vendor == 0x144d && pdev->device == 0xa802) {
3833 		/*
3834 		 * Several Samsung devices seem to drop off the PCIe bus
3835 		 * randomly when APST is on and uses the deepest sleep state.
3836 		 * This has been observed on a Samsung "SM951 NVMe SAMSUNG
3837 		 * 256GB", a "PM951 NVMe SAMSUNG 512GB", and a "Samsung SSD
3838 		 * 950 PRO 256GB", but it seems to be restricted to two Dell
3839 		 * laptops.
3840 		 */
3841 		if (dmi_match(DMI_SYS_VENDOR, "Dell Inc.") &&
3842 		    (dmi_match(DMI_PRODUCT_NAME, "XPS 15 9550") ||
3843 		     dmi_match(DMI_PRODUCT_NAME, "Precision 5510")))
3844 			return NVME_QUIRK_NO_DEEPEST_PS;
3845 	} else if (pdev->vendor == 0x144d && pdev->device == 0xa804) {
3846 		/*
3847 		 * Samsung SSD 960 EVO drops off the PCIe bus after system
3848 		 * suspend on a Ryzen board, ASUS PRIME B350M-A, as well as
3849 		 * within few minutes after bootup on a Coffee Lake board -
3850 		 * ASUS PRIME Z370-A
3851 		 */
3852 		if (dmi_match(DMI_BOARD_VENDOR, "ASUSTeK COMPUTER INC.") &&
3853 		    (dmi_match(DMI_BOARD_NAME, "PRIME B350M-A") ||
3854 		     dmi_match(DMI_BOARD_NAME, "PRIME Z370-A")))
3855 			return NVME_QUIRK_NO_APST;
3856 	} else if ((pdev->vendor == 0x144d && (pdev->device == 0xa801 ||
3857 		    pdev->device == 0xa808 || pdev->device == 0xa809)) ||
3858 		   (pdev->vendor == 0x1e0f && pdev->device == 0x0001)) {
3859 		/*
3860 		 * Forcing to use host managed nvme power settings for
3861 		 * lowest idle power with quick resume latency on
3862 		 * Samsung and Toshiba SSDs based on suspend behavior
3863 		 * on Coffee Lake board for LENOVO C640
3864 		 */
3865 		if ((dmi_match(DMI_BOARD_VENDOR, "LENOVO")) &&
3866 		     dmi_match(DMI_BOARD_NAME, "LNVNB161216"))
3867 			return NVME_QUIRK_SIMPLE_SUSPEND;
3868 	} else if (pdev->vendor == 0x2646 && (pdev->device == 0x2263 ||
3869 		   pdev->device == 0x500f)) {
3870 		/*
3871 		 * Exclude some Kingston NV1 and A2000 devices from
3872 		 * NVME_QUIRK_SIMPLE_SUSPEND. Do a full suspend to save a
3873 		 * lot of energy with s2idle sleep on some TUXEDO platforms.
3874 		 */
3875 		if (dmi_match(DMI_BOARD_NAME, "NS5X_NS7XAU") ||
3876 		    dmi_match(DMI_BOARD_NAME, "NS5x_7xAU") ||
3877 		    dmi_match(DMI_BOARD_NAME, "NS5x_7xPU") ||
3878 		    dmi_match(DMI_BOARD_NAME, "PH4PRX1_PH6PRX1"))
3879 			return NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND;
3880 	} else if (pdev->vendor == 0x144d && pdev->device == 0xa80d) {
3881 		/*
3882 		 * Exclude Samsung 990 Evo from NVME_QUIRK_SIMPLE_SUSPEND
3883 		 * because of high power consumption (> 2 Watt) in s2idle
3884 		 * sleep. Only some boards with Intel CPU are affected.
3885 		 * (Note for testing: Samsung 990 Evo Plus has same PCI ID)
3886 		 */
3887 		if (dmi_match(DMI_BOARD_NAME, "DN50Z-140HC-YD") ||
3888 		    dmi_match(DMI_BOARD_NAME, "GMxPXxx") ||
3889 		    dmi_match(DMI_BOARD_NAME, "GXxMRXx") ||
3890 		    dmi_match(DMI_BOARD_NAME, "NS5X_NS7XAU") ||
3891 		    dmi_match(DMI_BOARD_NAME, "PH4PG31") ||
3892 		    dmi_match(DMI_BOARD_NAME, "PH4PRX1_PH6PRX1") ||
3893 		    dmi_match(DMI_BOARD_NAME, "PH6PG01_PH6PG71"))
3894 			return NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND;
3895 	}
3896 
3897 	/*
3898 	 * NVMe SSD drops off the PCIe bus after system idle
3899 	 * for 10 hours on a Lenovo N60z board.
3900 	 */
3901 	if (dmi_match(DMI_BOARD_NAME, "LXKT-ZXEG-N6"))
3902 		return NVME_QUIRK_NO_APST;
3903 
3904 	return 0;
3905 }
3906 
3907 static struct quirk_entry *detect_dynamic_quirks(struct pci_dev *pdev)
3908 {
3909 	int i;
3910 
3911 	for (i = 0; i < nvme_pci_quirk_count; i++)
3912 		if (pdev->vendor == nvme_pci_quirk_list[i].vendor_id &&
3913 		    pdev->device == nvme_pci_quirk_list[i].dev_id)
3914 			return &nvme_pci_quirk_list[i];
3915 
3916 	return NULL;
3917 }
3918 
3919 static struct nvme_dev *nvme_pci_alloc_dev(struct pci_dev *pdev,
3920 		const struct pci_device_id *id)
3921 {
3922 	unsigned long quirks = id->driver_data;
3923 	int node = dev_to_node(&pdev->dev);
3924 	struct nvme_dev *dev;
3925 	struct quirk_entry *qentry;
3926 	int ret = -ENOMEM;
3927 
3928 	dev = kzalloc_node(struct_size(dev, descriptor_pools, nr_node_ids),
3929 			GFP_KERNEL, node);
3930 	if (!dev)
3931 		return ERR_PTR(-ENOMEM);
3932 	INIT_WORK(&dev->ctrl.reset_work, nvme_reset_work);
3933 	mutex_init(&dev->shutdown_lock);
3934 	nvme_init_buf_list(&dev->dmabufs);
3935 
3936 	dev->nr_write_queues = write_queues;
3937 	dev->nr_poll_queues = poll_queues;
3938 	dev->nr_allocated_queues = nvme_max_io_queues(dev) + 1;
3939 	dev->queues = kcalloc_node(dev->nr_allocated_queues,
3940 			sizeof(struct nvme_queue), GFP_KERNEL, node);
3941 	if (!dev->queues)
3942 		goto out_free_dev;
3943 
3944 	dev->dev = get_device(&pdev->dev);
3945 
3946 	quirks |= check_vendor_combination_bug(pdev);
3947 	if (!noacpi &&
3948 	    !(quirks & NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND) &&
3949 	    acpi_storage_d3(&pdev->dev)) {
3950 		/*
3951 		 * Some systems use a bios work around to ask for D3 on
3952 		 * platforms that support kernel managed suspend.
3953 		 */
3954 		dev_info(&pdev->dev,
3955 			 "platform quirk: setting simple suspend\n");
3956 		quirks |= NVME_QUIRK_SIMPLE_SUSPEND;
3957 	}
3958 	qentry = detect_dynamic_quirks(pdev);
3959 	if (qentry) {
3960 		quirks |= qentry->enabled_quirks;
3961 		quirks &= ~qentry->disabled_quirks;
3962 	}
3963 	ret = nvme_init_ctrl(&dev->ctrl, &pdev->dev, &nvme_pci_ctrl_ops,
3964 			     quirks);
3965 	if (ret)
3966 		goto out_put_device;
3967 
3968 	if (dev->ctrl.quirks & NVME_QUIRK_DMA_ADDRESS_BITS_48)
3969 		dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(48));
3970 	else
3971 		dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
3972 	dma_set_min_align_mask(&pdev->dev, NVME_CTRL_PAGE_SIZE - 1);
3973 	dma_set_max_seg_size(&pdev->dev, 0xffffffff);
3974 
3975 	/*
3976 	 * Limit the max command size to prevent iod->sg allocations going
3977 	 * over a single page.
3978 	 */
3979 	dev->ctrl.max_hw_sectors = min_t(u32,
3980 			NVME_MAX_BYTES >> SECTOR_SHIFT,
3981 			dma_max_mapping_size(&pdev->dev) >> SECTOR_SHIFT);
3982 	dev->ctrl.max_segments = NVME_MAX_SEGS;
3983 	dev->ctrl.max_integrity_segments = 1;
3984 	return dev;
3985 
3986 out_put_device:
3987 	put_device(dev->dev);
3988 	kfree(dev->queues);
3989 out_free_dev:
3990 	kfree(dev);
3991 	return ERR_PTR(ret);
3992 }
3993 
3994 static int nvme_probe(struct pci_dev *pdev, const struct pci_device_id *id)
3995 {
3996 	struct nvme_dev *dev;
3997 	int result = -ENOMEM;
3998 
3999 	dev = nvme_pci_alloc_dev(pdev, id);
4000 	if (IS_ERR(dev))
4001 		return PTR_ERR(dev);
4002 
4003 	result = nvme_add_ctrl(&dev->ctrl);
4004 	if (result)
4005 		goto out_put_ctrl;
4006 
4007 	result = nvme_dev_map(dev);
4008 	if (result)
4009 		goto out_uninit_ctrl;
4010 
4011 	result = nvme_pci_alloc_iod_mempool(dev);
4012 	if (result)
4013 		goto out_dev_unmap;
4014 
4015 	dev_info(dev->ctrl.device, "pci function %s\n", dev_name(&pdev->dev));
4016 
4017 	result = nvme_pci_enable(dev);
4018 	if (result)
4019 		goto out_release_iod_mempool;
4020 
4021 	result = nvme_alloc_admin_tag_set(&dev->ctrl, &dev->admin_tagset,
4022 				&nvme_mq_admin_ops, sizeof(struct nvme_iod));
4023 	if (result)
4024 		goto out_disable;
4025 
4026 	/*
4027 	 * Mark the controller as connecting before sending admin commands to
4028 	 * allow the timeout handler to do the right thing.
4029 	 */
4030 	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_CONNECTING)) {
4031 		dev_warn(dev->ctrl.device,
4032 			"failed to mark controller CONNECTING\n");
4033 		result = -EBUSY;
4034 		goto out_disable;
4035 	}
4036 
4037 	result = nvme_init_ctrl_finish(&dev->ctrl, false);
4038 	if (result)
4039 		goto out_disable;
4040 
4041 	if (nvme_ctrl_meta_sgl_supported(&dev->ctrl))
4042 		dev->ctrl.max_integrity_segments = NVME_MAX_META_SEGS;
4043 	else
4044 		dev->ctrl.max_integrity_segments = 1;
4045 
4046 	nvme_dbbuf_dma_alloc(dev);
4047 
4048 	result = nvme_setup_host_mem(dev);
4049 	if (result < 0)
4050 		goto out_disable;
4051 
4052 	nvme_update_attrs(dev);
4053 
4054 	result = nvme_setup_io_queues(dev);
4055 	if (result)
4056 		goto out_disable;
4057 
4058 	if (dev->online_queues > 1) {
4059 		nvme_alloc_io_tag_set(&dev->ctrl, &dev->tagset, &nvme_mq_ops,
4060 				nvme_pci_nr_maps(dev), sizeof(struct nvme_iod));
4061 		nvme_dbbuf_set(dev);
4062 	}
4063 
4064 	if (!dev->ctrl.tagset)
4065 		dev_warn(dev->ctrl.device, "IO queues not created\n");
4066 
4067 	if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_LIVE)) {
4068 		dev_warn(dev->ctrl.device,
4069 			"failed to mark controller live state\n");
4070 		result = -ENODEV;
4071 		goto out_disable;
4072 	}
4073 
4074 	pci_set_drvdata(pdev, dev);
4075 
4076 	nvme_start_ctrl(&dev->ctrl);
4077 	nvme_put_ctrl(&dev->ctrl);
4078 	flush_work(&dev->ctrl.scan_work);
4079 	return 0;
4080 
4081 out_disable:
4082 	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
4083 	nvme_dev_disable(dev, true);
4084 	nvme_free_host_mem(dev);
4085 	nvme_dev_remove_admin(dev);
4086 	nvme_dbbuf_dma_free(dev);
4087 	nvme_free_queues(dev, 0);
4088 	nvme_release_descriptor_pools(dev);
4089 out_release_iod_mempool:
4090 	mempool_destroy(dev->dmavec_mempool);
4091 out_dev_unmap:
4092 	nvme_dev_unmap(dev);
4093 out_uninit_ctrl:
4094 	nvme_uninit_ctrl(&dev->ctrl);
4095 out_put_ctrl:
4096 	nvme_put_ctrl(&dev->ctrl);
4097 	dev_err_probe(&pdev->dev, result, "probe failed\n");
4098 	return result;
4099 }
4100 
4101 static void nvme_reset_prepare(struct pci_dev *pdev)
4102 {
4103 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4104 
4105 	/*
4106 	 * We don't need to check the return value from waiting for the reset
4107 	 * state as pci_dev device lock is held, making it impossible to race
4108 	 * with ->remove().
4109 	 */
4110 	nvme_disable_prepare_reset(dev, false);
4111 	nvme_sync_queues(&dev->ctrl);
4112 }
4113 
4114 static void nvme_reset_done(struct pci_dev *pdev)
4115 {
4116 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4117 
4118 	if (!nvme_try_sched_reset(&dev->ctrl))
4119 		flush_work(&dev->ctrl.reset_work);
4120 }
4121 
4122 static void nvme_shutdown(struct pci_dev *pdev)
4123 {
4124 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4125 
4126 	nvme_disable_prepare_reset(dev, true);
4127 }
4128 
4129 /*
4130  * The driver's remove may be called on a device in a partially initialized
4131  * state. This function must not have any dependencies on the device state in
4132  * order to proceed.
4133  */
4134 static void nvme_remove(struct pci_dev *pdev)
4135 {
4136 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4137 
4138 	nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
4139 	pci_set_drvdata(pdev, NULL);
4140 
4141 	if (!pci_device_is_present(pdev)) {
4142 		nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DEAD);
4143 		nvme_dev_disable(dev, true);
4144 	}
4145 
4146 	flush_work(&dev->ctrl.reset_work);
4147 	nvme_stop_ctrl(&dev->ctrl);
4148 	nvme_remove_namespaces(&dev->ctrl);
4149 	nvme_dev_disable(dev, true);
4150 	nvme_pci_remove_dmabuf(&dev->dmabufs);
4151 	nvme_free_host_mem(dev);
4152 	nvme_dev_remove_admin(dev);
4153 	nvme_dbbuf_dma_free(dev);
4154 	nvme_free_queues(dev, 0);
4155 	mempool_destroy(dev->dmavec_mempool);
4156 	nvme_release_descriptor_pools(dev);
4157 	nvme_dev_unmap(dev);
4158 	nvme_uninit_ctrl(&dev->ctrl);
4159 }
4160 
4161 #ifdef CONFIG_PM_SLEEP
4162 static int nvme_get_power_state(struct nvme_ctrl *ctrl, u32 *ps)
4163 {
4164 	return nvme_get_features(ctrl, NVME_FEAT_POWER_MGMT, 0, NULL, 0, ps);
4165 }
4166 
4167 static int nvme_set_power_state(struct nvme_ctrl *ctrl, u32 ps)
4168 {
4169 	return nvme_set_features(ctrl, NVME_FEAT_POWER_MGMT, ps, NULL, 0, NULL);
4170 }
4171 
4172 static int nvme_resume(struct device *dev)
4173 {
4174 	struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
4175 	struct nvme_ctrl *ctrl = &ndev->ctrl;
4176 
4177 	if (ndev->last_ps == U32_MAX ||
4178 	    nvme_set_power_state(ctrl, ndev->last_ps) != 0)
4179 		goto reset;
4180 	if (ctrl->hmpre && nvme_setup_host_mem(ndev))
4181 		goto reset;
4182 
4183 	return 0;
4184 reset:
4185 	return nvme_try_sched_reset(ctrl);
4186 }
4187 
4188 static int nvme_suspend(struct device *dev)
4189 {
4190 	struct pci_dev *pdev = to_pci_dev(dev);
4191 	struct nvme_dev *ndev = pci_get_drvdata(pdev);
4192 	struct nvme_ctrl *ctrl = &ndev->ctrl;
4193 	int ret = -EBUSY;
4194 
4195 	ndev->last_ps = U32_MAX;
4196 
4197 	/*
4198 	 * The platform does not remove power for a kernel managed suspend so
4199 	 * use host managed nvme power settings for lowest idle power if
4200 	 * possible. This should have quicker resume latency than a full device
4201 	 * shutdown.  But if the firmware is involved after the suspend or the
4202 	 * platform has any limitation in waking from low power states or the
4203 	 * device does not support any non-default power states, shut down the
4204 	 * device fully.
4205 	 *
4206 	 * If ASPM is not enabled for the device, shut down the device and allow
4207 	 * the PCI bus layer to put it into D3 in order to take the PCIe link
4208 	 * down, so as to allow the platform to achieve its minimum low-power
4209 	 * state (which may not be possible if the link is up).
4210 	 */
4211 	if (!pci_suspend_retains_context(pdev) || !ctrl->npss ||
4212 	    !pcie_aspm_enabled(pdev) ||
4213 	    (ndev->ctrl.quirks & NVME_QUIRK_SIMPLE_SUSPEND))
4214 		return nvme_disable_prepare_reset(ndev, true);
4215 
4216 	nvme_start_freeze(ctrl);
4217 	nvme_wait_freeze(ctrl);
4218 	nvme_sync_queues(ctrl);
4219 
4220 	if (nvme_ctrl_state(ctrl) != NVME_CTRL_LIVE)
4221 		goto unfreeze;
4222 
4223 	/*
4224 	 * Host memory access may not be successful in a system suspend state,
4225 	 * but the specification allows the controller to access memory in a
4226 	 * non-operational power state.
4227 	 */
4228 	if (ndev->hmb) {
4229 		ret = nvme_set_host_mem(ndev, 0);
4230 		if (ret < 0)
4231 			goto unfreeze;
4232 	}
4233 
4234 	ret = nvme_get_power_state(ctrl, &ndev->last_ps);
4235 	if (ret < 0)
4236 		goto unfreeze;
4237 
4238 	/*
4239 	 * A saved state prevents pci pm from generically controlling the
4240 	 * device's power. If we're using protocol specific settings, we don't
4241 	 * want pci interfering.
4242 	 */
4243 	pci_save_state(pdev);
4244 
4245 	ret = nvme_set_power_state(ctrl, ctrl->npss);
4246 	if (ret < 0)
4247 		goto unfreeze;
4248 
4249 	if (ret) {
4250 		/* discard the saved state */
4251 		pci_load_saved_state(pdev, NULL);
4252 
4253 		/*
4254 		 * Clearing npss forces a controller reset on resume. The
4255 		 * correct value will be rediscovered then.
4256 		 */
4257 		ret = nvme_disable_prepare_reset(ndev, true);
4258 		ctrl->npss = 0;
4259 	}
4260 unfreeze:
4261 	nvme_unfreeze(ctrl);
4262 	return ret;
4263 }
4264 
4265 static int nvme_simple_suspend(struct device *dev)
4266 {
4267 	struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
4268 
4269 	return nvme_disable_prepare_reset(ndev, true);
4270 }
4271 
4272 static int nvme_simple_resume(struct device *dev)
4273 {
4274 	struct pci_dev *pdev = to_pci_dev(dev);
4275 	struct nvme_dev *ndev = pci_get_drvdata(pdev);
4276 
4277 	return nvme_try_sched_reset(&ndev->ctrl);
4278 }
4279 
4280 static const struct dev_pm_ops nvme_dev_pm_ops = {
4281 	.suspend	= nvme_suspend,
4282 	.resume		= nvme_resume,
4283 	.freeze		= nvme_simple_suspend,
4284 	.thaw		= nvme_simple_resume,
4285 	.poweroff	= nvme_simple_suspend,
4286 	.restore	= nvme_simple_resume,
4287 };
4288 #endif /* CONFIG_PM_SLEEP */
4289 
4290 static pci_ers_result_t nvme_error_detected(struct pci_dev *pdev,
4291 						pci_channel_state_t state)
4292 {
4293 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4294 
4295 	/*
4296 	 * A frozen channel requires a reset. When detected, this method will
4297 	 * shutdown the controller to quiesce. The controller will be restarted
4298 	 * after the slot reset through driver's slot_reset callback.
4299 	 */
4300 	switch (state) {
4301 	case pci_channel_io_normal:
4302 		return PCI_ERS_RESULT_CAN_RECOVER;
4303 	case pci_channel_io_frozen:
4304 		dev_warn(dev->ctrl.device,
4305 			"frozen state error detected, reset controller\n");
4306 		if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_RESETTING)) {
4307 			nvme_dev_disable(dev, true);
4308 			return PCI_ERS_RESULT_DISCONNECT;
4309 		}
4310 		nvme_dev_disable(dev, false);
4311 		return PCI_ERS_RESULT_NEED_RESET;
4312 	case pci_channel_io_perm_failure:
4313 		dev_warn(dev->ctrl.device,
4314 			"failure state error detected, request disconnect\n");
4315 		return PCI_ERS_RESULT_DISCONNECT;
4316 	}
4317 	return PCI_ERS_RESULT_NEED_RESET;
4318 }
4319 
4320 static pci_ers_result_t nvme_slot_reset(struct pci_dev *pdev)
4321 {
4322 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4323 
4324 	dev_info(dev->ctrl.device, "restart after slot reset\n");
4325 	pci_restore_state(pdev);
4326 	if (nvme_try_sched_reset(&dev->ctrl))
4327 		nvme_unquiesce_io_queues(&dev->ctrl);
4328 	return PCI_ERS_RESULT_RECOVERED;
4329 }
4330 
4331 static void nvme_error_resume(struct pci_dev *pdev)
4332 {
4333 	struct nvme_dev *dev = pci_get_drvdata(pdev);
4334 
4335 	flush_work(&dev->ctrl.reset_work);
4336 }
4337 
4338 static const struct pci_error_handlers nvme_err_handler = {
4339 	.error_detected	= nvme_error_detected,
4340 	.slot_reset	= nvme_slot_reset,
4341 	.resume		= nvme_error_resume,
4342 	.reset_prepare	= nvme_reset_prepare,
4343 	.reset_done	= nvme_reset_done,
4344 };
4345 
4346 static const struct pci_device_id nvme_id_table[] = {
4347 	{ PCI_VDEVICE(INTEL, 0x0953),	/* Intel 750/P3500/P3600/P3700 */
4348 		.driver_data = NVME_QUIRK_STRIPE_SIZE |
4349 				NVME_QUIRK_DEALLOCATE_ZEROES, },
4350 	{ PCI_VDEVICE(INTEL, 0x0a53),	/* Intel P3520 */
4351 		.driver_data = NVME_QUIRK_STRIPE_SIZE |
4352 				NVME_QUIRK_DEALLOCATE_ZEROES, },
4353 	{ PCI_VDEVICE(INTEL, 0x0a54),	/* Intel P4500/P4600 */
4354 		.driver_data = NVME_QUIRK_STRIPE_SIZE |
4355 				NVME_QUIRK_IGNORE_DEV_SUBNQN |
4356 				NVME_QUIRK_BOGUS_NID, },
4357 	{ PCI_VDEVICE(INTEL, 0x0a55),	/* Dell Express Flash P4600 */
4358 		.driver_data = NVME_QUIRK_STRIPE_SIZE, },
4359 	{ PCI_VDEVICE(INTEL, 0xf1a5),	/* Intel 600P/P3100 */
4360 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
4361 				NVME_QUIRK_MEDIUM_PRIO_SQ |
4362 				NVME_QUIRK_NO_TEMP_THRESH_CHANGE |
4363 				NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4364 	{ PCI_VDEVICE(INTEL, 0xf1a6),	/* Intel 760p/Pro 7600p */
4365 		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4366 	{ PCI_VDEVICE(INTEL, 0x5845),	/* Qemu emulated controller */
4367 		.driver_data = NVME_QUIRK_IDENTIFY_CNS |
4368 				NVME_QUIRK_DISABLE_WRITE_ZEROES |
4369 				NVME_QUIRK_BOGUS_NID, },
4370 	{ PCI_VDEVICE(REDHAT, 0x0010),	/* Qemu emulated controller */
4371 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4372 	{ PCI_DEVICE(0x1217, 0x8760), /* O2 Micro 64GB Steam Deck */
4373 		.driver_data = NVME_QUIRK_DMAPOOL_ALIGN_512, },
4374 	{ PCI_DEVICE(0x126f, 0x1001),	/* Silicon Motion generic */
4375 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
4376 				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4377 	{ PCI_DEVICE(0x126f, 0x2262),	/* Silicon Motion generic */
4378 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
4379 				NVME_QUIRK_BOGUS_NID, },
4380 	{ PCI_DEVICE(0x126f, 0x2263),	/* Silicon Motion unidentified */
4381 		.driver_data = NVME_QUIRK_NO_NS_DESC_LIST |
4382 				NVME_QUIRK_BOGUS_NID, },
4383 	{ PCI_DEVICE(0x1bb1, 0x0100),   /* Seagate Nytro Flash Storage */
4384 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
4385 				NVME_QUIRK_NO_NS_DESC_LIST, },
4386 	{ PCI_DEVICE(0x1c58, 0x0003),	/* HGST adapter */
4387 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
4388 	{ PCI_DEVICE(0x1c58, 0x0023),	/* WDC SN200 adapter */
4389 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
4390 	{ PCI_DEVICE(0x1c5f, 0x0540),	/* Memblaze Pblaze4 adapter */
4391 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
4392 	{ PCI_DEVICE(0x1c5f, 0x0555),	/* Memblaze Pblaze5 adapter */
4393 		.driver_data = NVME_QUIRK_NO_NS_DESC_LIST, },
4394 	{ PCI_DEVICE(0x144d, 0xa821),   /* Samsung PM1725 */
4395 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
4396 	{ PCI_DEVICE(0x144d, 0xa822),   /* Samsung PM1725a */
4397 		.driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
4398 				NVME_QUIRK_DISABLE_WRITE_ZEROES|
4399 				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4400 	{ PCI_DEVICE(0x15b7, 0x5008),   /* Sandisk SN530 */
4401 		.driver_data = NVME_QUIRK_BROKEN_MSI },
4402 	{ PCI_DEVICE(0x15b7, 0x5009),   /* Sandisk SN550 */
4403 		.driver_data = NVME_QUIRK_BROKEN_MSI |
4404 				NVME_QUIRK_NO_DEEPEST_PS },
4405 	{ PCI_DEVICE(0x1987, 0x5012),	/* Phison E12 */
4406 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4407 	{ PCI_DEVICE(0x1987, 0x5016),	/* Phison E16 */
4408 		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN |
4409 				NVME_QUIRK_BOGUS_NID, },
4410 	{ PCI_DEVICE(0x1987, 0x5019),  /* phison E19 */
4411 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4412 	{ PCI_DEVICE(0x1987, 0x5021),   /* Phison E21 */
4413 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4414 	{ PCI_DEVICE(0x1b4b, 0x1092),	/* Lexar 256 GB SSD */
4415 		.driver_data = NVME_QUIRK_NO_NS_DESC_LIST |
4416 				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4417 	{ PCI_DEVICE(0x1cc1, 0x33f8),   /* ADATA IM2P33F8ABR1 1 TB */
4418 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4419 	{ PCI_DEVICE(0x10ec, 0x5762),   /* ADATA SX6000LNP */
4420 		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN |
4421 				NVME_QUIRK_BOGUS_NID, },
4422 	{ PCI_DEVICE(0x10ec, 0x5763),  /* ADATA SX6000PNP */
4423 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4424 	{ PCI_DEVICE(0x1cc1, 0x8201),   /* ADATA SX8200PNP 512GB */
4425 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS |
4426 				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4427 	 { PCI_DEVICE(0x1344, 0x5407), /* Micron Technology Inc NVMe SSD */
4428 		.driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN },
4429 	 { PCI_DEVICE(0x1344, 0x6001),   /* Micron Nitro NVMe */
4430 		 .driver_data = NVME_QUIRK_BOGUS_NID, },
4431 	{ PCI_DEVICE(0x1344, 0x6004),	/* Micron 4100AT */
4432 		.driver_data = NVME_QUIRK_DMAPOOL_ALIGN_512, },
4433 	{ PCI_DEVICE(0x1c5c, 0x1504),   /* SK Hynix PC400 */
4434 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4435 	{ PCI_DEVICE(0x1c5c, 0x174a),   /* SK Hynix P31 SSD */
4436 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4437 	{ PCI_DEVICE(0x1c5c, 0x1D59),   /* SK Hynix BC901 */
4438 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4439 	{ PCI_DEVICE(0x15b7, 0x2001),   /*  Sandisk Skyhawk */
4440 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4441 	{ PCI_DEVICE(0x1d97, 0x2263),   /* SPCC */
4442 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4443 	{ PCI_DEVICE(0x144d, 0xa80b),   /* Samsung PM9B1 256G and 512G */
4444 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES |
4445 				NVME_QUIRK_BOGUS_NID, },
4446 	{ PCI_DEVICE(0x144d, 0xa809),   /* Samsung MZALQ256HBJD 256G */
4447 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4448 	{ PCI_DEVICE(0x144d, 0xa802),   /* Samsung SM953 */
4449 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4450 	{ PCI_DEVICE(0x1cc4, 0x6303),   /* UMIS RPJTJ512MGE1QDY 512G */
4451 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4452 	{ PCI_DEVICE(0x1cc4, 0x6302),   /* UMIS RPJTJ256MGE1QDY 256G */
4453 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4454 	{ PCI_DEVICE(0x2646, 0x2262),   /* KINGSTON SKC2000 NVMe SSD */
4455 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
4456 	{ PCI_DEVICE(0x2646, 0x2263),   /* KINGSTON A2000 NVMe SSD  */
4457 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
4458 	{ PCI_DEVICE(0x2646, 0x5013),   /* Kingston KC3000, Kingston FURY Renegade */
4459 		.driver_data = NVME_QUIRK_NO_SECONDARY_TEMP_THRESH, },
4460 	{ PCI_DEVICE(0x2646, 0x5018),   /* KINGSTON OM8SFP4xxxxP OS21012 NVMe SSD */
4461 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4462 	{ PCI_DEVICE(0x2646, 0x5016),   /* KINGSTON OM3PGP4xxxxP OS21011 NVMe SSD */
4463 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4464 	{ PCI_DEVICE(0x2646, 0x501A),   /* KINGSTON OM8PGP4xxxxP OS21005 NVMe SSD */
4465 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4466 	{ PCI_DEVICE(0x2646, 0x501B),   /* KINGSTON OM8PGP4xxxxQ OS21005 NVMe SSD */
4467 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4468 	{ PCI_DEVICE(0x2646, 0x501E),   /* KINGSTON OM3PGP4xxxxQ OS21011 NVMe SSD */
4469 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4470 	{ PCI_DEVICE(0x2646, 0x502F),   /* KINGSTON OM3SGP4xxxxK NVMe SSD */
4471 		.driver_data = NVME_QUIRK_DISABLE_WRITE_ZEROES, },
4472 	{ PCI_DEVICE(0x1f40, 0x1202),   /* Netac Technologies Co. NV3000 NVMe SSD */
4473 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4474 	{ PCI_DEVICE(0x1f40, 0x5236),   /* Netac Technologies Co. NV7000 NVMe SSD */
4475 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4476 	{ PCI_DEVICE(0x1e4B, 0x1001),   /* MAXIO MAP1001 */
4477 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4478 	{ PCI_DEVICE(0x1e4B, 0x1002),   /* MAXIO MAP1002 */
4479 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4480 	{ PCI_DEVICE(0x1e4B, 0x1202),   /* MAXIO MAP1202 */
4481 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4482 	{ PCI_DEVICE(0x1e4B, 0x1602),   /* MAXIO MAP1602 */
4483 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4484 	{ PCI_DEVICE(0x1cc1, 0x5350),   /* ADATA XPG GAMMIX S50 */
4485 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4486 	{ PCI_DEVICE(0x1dbe, 0x5216),   /* Acer/INNOGRIT FA100/5216 NVMe SSD */
4487 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4488 	{ PCI_DEVICE(0x1dbe, 0x5236),   /* ADATA XPG GAMMIX S70 */
4489 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4490 	{ PCI_DEVICE(0x1e49, 0x0021),   /* ZHITAI TiPro5000 NVMe SSD */
4491 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
4492 	{ PCI_DEVICE(0x1e49, 0x0041),   /* ZHITAI TiPro7000 NVMe SSD */
4493 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
4494 	{ PCI_DEVICE(0x1fa0, 0x2283),   /* Wodposit WPBSNM8-256GTP */
4495 		.driver_data = NVME_QUIRK_NO_SECONDARY_TEMP_THRESH, },
4496 	{ PCI_DEVICE(0x025e, 0xf1ac),   /* SOLIDIGM  P44 pro SSDPFKKW020X7  */
4497 		.driver_data = NVME_QUIRK_NO_DEEPEST_PS, },
4498 	{ PCI_DEVICE(0xc0a9, 0x540a),   /* Crucial P2 */
4499 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4500 	{ PCI_DEVICE(0x1d97, 0x2263), /* Lexar NM610 */
4501 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4502 	{ PCI_DEVICE(0x1d97, 0x1d97), /* Lexar NM620 */
4503 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4504 	{ PCI_DEVICE(0x1d97, 0x2269), /* Lexar NM760 */
4505 		.driver_data = NVME_QUIRK_BOGUS_NID |
4506 				NVME_QUIRK_IGNORE_DEV_SUBNQN, },
4507 	{ PCI_DEVICE(0x10ec, 0x5763), /* TEAMGROUP T-FORCE CARDEA ZERO Z330 SSD */
4508 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4509 	{ PCI_DEVICE(0x1e4b, 0x1602), /* HS-SSD-FUTURE 2048G  */
4510 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4511 	{ PCI_DEVICE(0x10ec, 0x5765), /* TEAMGROUP MP33 2TB SSD */
4512 		.driver_data = NVME_QUIRK_BOGUS_NID, },
4513 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x0061),
4514 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4515 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x0065),
4516 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4517 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0x8061),
4518 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4519 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd00),
4520 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4521 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd01),
4522 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4523 	{ PCI_DEVICE(PCI_VENDOR_ID_AMAZON, 0xcd02),
4524 		.driver_data = NVME_QUIRK_DMA_ADDRESS_BITS_48, },
4525 	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2001),
4526 		/*
4527 		 * Fix for the Apple controller found in the MacBook8,1 and
4528 		 * some MacBook7,1 to avoid controller resets and data loss.
4529 		 */
4530 		.driver_data = NVME_QUIRK_SINGLE_VECTOR |
4531 				NVME_QUIRK_QDEPTH_ONE },
4532 	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2003) },
4533 	{ PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2005),
4534 		.driver_data = NVME_QUIRK_SINGLE_VECTOR |
4535 				NVME_QUIRK_128_BYTES_SQES |
4536 				NVME_QUIRK_SHARED_TAGS |
4537 				NVME_QUIRK_SKIP_CID_GEN |
4538 				NVME_QUIRK_IDENTIFY_CNS },
4539 	{ PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
4540 	{ 0, }
4541 };
4542 MODULE_DEVICE_TABLE(pci, nvme_id_table);
4543 
4544 static struct pci_driver nvme_driver = {
4545 	.name		= "nvme",
4546 	.id_table	= nvme_id_table,
4547 	.probe		= nvme_probe,
4548 	.remove		= nvme_remove,
4549 	.shutdown	= nvme_shutdown,
4550 	.driver		= {
4551 		.probe_type	= PROBE_PREFER_ASYNCHRONOUS,
4552 #ifdef CONFIG_PM_SLEEP
4553 		.pm		= &nvme_dev_pm_ops,
4554 #endif
4555 	},
4556 	.sriov_configure = pci_sriov_configure_simple,
4557 	.err_handler	= &nvme_err_handler,
4558 };
4559 
4560 static int __init nvme_init(void)
4561 {
4562 	BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
4563 	BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
4564 	BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
4565 	BUILD_BUG_ON(IRQ_AFFINITY_MAX_SETS < 2);
4566 
4567 	return pci_register_driver(&nvme_driver);
4568 }
4569 
4570 static void __exit nvme_exit(void)
4571 {
4572 	kfree(nvme_pci_quirk_list);
4573 	pci_unregister_driver(&nvme_driver);
4574 	flush_workqueue(nvme_wq);
4575 }
4576 
4577 MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
4578 MODULE_LICENSE("GPL");
4579 MODULE_VERSION("1.0");
4580 MODULE_DESCRIPTION("NVMe host PCIe transport driver");
4581 MODULE_IMPORT_NS("DMA_BUF");
4582 module_init(nvme_init);
4583 module_exit(nvme_exit);
4584