]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/nvme/host/pci.c
nvme-pci: Use host managed power state for suspend
[mirror_ubuntu-bionic-kernel.git] / drivers / nvme / host / pci.c
CommitLineData
b60503ba
MW
1/*
2 * NVM Express device driver
6eb0d698 3 * Copyright (c) 2011-2014, Intel Corporation.
b60503ba
MW
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
b60503ba
MW
13 */
14
a0a3408e 15#include <linux/aer.h>
b60503ba 16#include <linux/blkdev.h>
a4aea562 17#include <linux/blk-mq.h>
dca51e78 18#include <linux/blk-mq-pci.h>
ff5350a8 19#include <linux/dmi.h>
b60503ba
MW
20#include <linux/init.h>
21#include <linux/interrupt.h>
22#include <linux/io.h>
b60503ba
MW
23#include <linux/mm.h>
24#include <linux/module.h>
77bf25ea 25#include <linux/mutex.h>
d0877473 26#include <linux/once.h>
b60503ba 27#include <linux/pci.h>
0b5db994 28#include <linux/suspend.h>
e1e5e564 29#include <linux/t10-pi.h>
b60503ba 30#include <linux/types.h>
2f8e2c87 31#include <linux/io-64-nonatomic-lo-hi.h>
a98e58e5 32#include <linux/sed-opal.h>
797a796a 33
f11bb3e2
CH
34#include "nvme.h"
35
b60503ba
MW
36#define SQ_SIZE(depth) (depth * sizeof(struct nvme_command))
37#define CQ_SIZE(depth) (depth * sizeof(struct nvme_completion))
c965809c 38
a7a7cbe3 39#define SGES_PER_PAGE (PAGE_SIZE / sizeof(struct nvme_sgl_desc))
9d43cf64 40
58ffacb5
MW
41static int use_threaded_interrupts;
42module_param(use_threaded_interrupts, int, 0);
43
8ffaadf7
JD
44static bool use_cmb_sqes = true;
45module_param(use_cmb_sqes, bool, 0644);
46MODULE_PARM_DESC(use_cmb_sqes, "use controller's memory buffer for I/O SQes");
47
87ad72a5
CH
48static unsigned int max_host_mem_size_mb = 128;
49module_param(max_host_mem_size_mb, uint, 0444);
50MODULE_PARM_DESC(max_host_mem_size_mb,
51 "Maximum Host Memory Buffer (HMB) size per controller (in MiB)");
1fa6aead 52
a7a7cbe3
CK
53static unsigned int sgl_threshold = SZ_32K;
54module_param(sgl_threshold, uint, 0644);
55MODULE_PARM_DESC(sgl_threshold,
56 "Use SGLs when average request segment size is larger or equal to "
57 "this size. Use 0 to disable SGLs.");
58
b27c1e68 59static int io_queue_depth_set(const char *val, const struct kernel_param *kp);
60static const struct kernel_param_ops io_queue_depth_ops = {
61 .set = io_queue_depth_set,
62 .get = param_get_int,
63};
64
65static int io_queue_depth = 1024;
66module_param_cb(io_queue_depth, &io_queue_depth_ops, &io_queue_depth, 0644);
67MODULE_PARM_DESC(io_queue_depth, "set io queue depth, should >= 2");
68
1c63dc66
CH
69struct nvme_dev;
70struct nvme_queue;
b3fffdef 71
a0fa9647 72static void nvme_process_cq(struct nvme_queue *nvmeq);
a5cdb68c 73static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown);
d4b4ff8e 74
1c63dc66
CH
75/*
76 * Represents an NVM Express device. Each nvme_dev is a PCI function.
77 */
78struct nvme_dev {
1c63dc66
CH
79 struct nvme_queue **queues;
80 struct blk_mq_tag_set tagset;
81 struct blk_mq_tag_set admin_tagset;
82 u32 __iomem *dbs;
83 struct device *dev;
84 struct dma_pool *prp_page_pool;
85 struct dma_pool *prp_small_pool;
1c63dc66
CH
86 unsigned online_queues;
87 unsigned max_qid;
88 int q_depth;
89 u32 db_stride;
1c63dc66 90 void __iomem *bar;
97f6ef64 91 unsigned long bar_mapped_size;
5c8809e6 92 struct work_struct remove_work;
77bf25ea 93 struct mutex shutdown_lock;
1c63dc66 94 bool subsystem;
1c63dc66 95 void __iomem *cmb;
8969f1f8 96 pci_bus_addr_t cmb_bus_addr;
1c63dc66
CH
97 u64 cmb_size;
98 u32 cmbsz;
202021c1 99 u32 cmbloc;
1c63dc66 100 struct nvme_ctrl ctrl;
db3cbfff 101 struct completion ioq_wait;
0b5db994 102 u32 last_ps;
87ad72a5
CH
103
104 /* shadow doorbell buffer support: */
f9f38e33
HK
105 u32 *dbbuf_dbs;
106 dma_addr_t dbbuf_dbs_dma_addr;
107 u32 *dbbuf_eis;
108 dma_addr_t dbbuf_eis_dma_addr;
87ad72a5
CH
109
110 /* host memory buffer support: */
111 u64 host_mem_size;
112 u32 nr_host_mem_descs;
4033f35d 113 dma_addr_t host_mem_descs_dma;
87ad72a5
CH
114 struct nvme_host_mem_buf_desc *host_mem_descs;
115 void **host_mem_desc_bufs;
4d115420 116};
1fa6aead 117
b27c1e68 118static int io_queue_depth_set(const char *val, const struct kernel_param *kp)
119{
120 int n = 0, ret;
121
122 ret = kstrtoint(val, 10, &n);
123 if (ret != 0 || n < 2)
124 return -EINVAL;
125
126 return param_set_int(val, kp);
127}
128
f9f38e33
HK
129static inline unsigned int sq_idx(unsigned int qid, u32 stride)
130{
131 return qid * 2 * stride;
132}
133
134static inline unsigned int cq_idx(unsigned int qid, u32 stride)
135{
136 return (qid * 2 + 1) * stride;
137}
138
1c63dc66
CH
139static inline struct nvme_dev *to_nvme_dev(struct nvme_ctrl *ctrl)
140{
141 return container_of(ctrl, struct nvme_dev, ctrl);
142}
143
b60503ba
MW
144/*
145 * An NVM Express queue. Each device has at least two (one for admin
146 * commands and one for I/O commands).
147 */
148struct nvme_queue {
149 struct device *q_dmadev;
091b6092 150 struct nvme_dev *dev;
b60503ba
MW
151 spinlock_t q_lock;
152 struct nvme_command *sq_cmds;
8ffaadf7 153 struct nvme_command __iomem *sq_cmds_io;
b60503ba 154 volatile struct nvme_completion *cqes;
42483228 155 struct blk_mq_tags **tags;
b60503ba
MW
156 dma_addr_t sq_dma_addr;
157 dma_addr_t cq_dma_addr;
b60503ba
MW
158 u32 __iomem *q_db;
159 u16 q_depth;
6222d172 160 s16 cq_vector;
b60503ba
MW
161 u16 sq_tail;
162 u16 cq_head;
c30341dc 163 u16 qid;
e9539f47
MW
164 u8 cq_phase;
165 u8 cqe_seen;
f9f38e33
HK
166 u32 *dbbuf_sq_db;
167 u32 *dbbuf_cq_db;
168 u32 *dbbuf_sq_ei;
169 u32 *dbbuf_cq_ei;
b60503ba
MW
170};
171
71bd150c
CH
172/*
173 * The nvme_iod describes the data in an I/O, including the list of PRP
174 * entries. You can't see it in this data structure because C doesn't let
f4800d6d 175 * me express that. Use nvme_init_iod to ensure there's enough space
71bd150c
CH
176 * allocated to store the PRP list.
177 */
178struct nvme_iod {
d49187e9 179 struct nvme_request req;
f4800d6d 180 struct nvme_queue *nvmeq;
a7a7cbe3 181 bool use_sgl;
f4800d6d 182 int aborted;
71bd150c 183 int npages; /* In the PRP list. 0 means small pool in use */
71bd150c
CH
184 int nents; /* Used in scatterlist */
185 int length; /* Of data, in bytes */
186 dma_addr_t first_dma;
bf684057 187 struct scatterlist meta_sg; /* metadata requires single contiguous buffer */
f4800d6d
CH
188 struct scatterlist *sg;
189 struct scatterlist inline_sg[0];
b60503ba
MW
190};
191
192/*
193 * Check we didin't inadvertently grow the command struct
194 */
195static inline void _nvme_check_size(void)
196{
197 BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
198 BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
199 BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
200 BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
201 BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
f8ebf840 202 BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
c30341dc 203 BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
b60503ba 204 BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
0add5e8e
JT
205 BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != NVME_IDENTIFY_DATA_SIZE);
206 BUILD_BUG_ON(sizeof(struct nvme_id_ns) != NVME_IDENTIFY_DATA_SIZE);
b60503ba 207 BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
6ecec745 208 BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512);
f9f38e33
HK
209 BUILD_BUG_ON(sizeof(struct nvme_dbbuf) != 64);
210}
211
212static inline unsigned int nvme_dbbuf_size(u32 stride)
213{
214 return ((num_possible_cpus() + 1) * 8 * stride);
215}
216
217static int nvme_dbbuf_dma_alloc(struct nvme_dev *dev)
218{
219 unsigned int mem_size = nvme_dbbuf_size(dev->db_stride);
220
221 if (dev->dbbuf_dbs)
222 return 0;
223
224 dev->dbbuf_dbs = dma_alloc_coherent(dev->dev, mem_size,
225 &dev->dbbuf_dbs_dma_addr,
226 GFP_KERNEL);
227 if (!dev->dbbuf_dbs)
228 return -ENOMEM;
229 dev->dbbuf_eis = dma_alloc_coherent(dev->dev, mem_size,
230 &dev->dbbuf_eis_dma_addr,
231 GFP_KERNEL);
232 if (!dev->dbbuf_eis) {
233 dma_free_coherent(dev->dev, mem_size,
234 dev->dbbuf_dbs, dev->dbbuf_dbs_dma_addr);
235 dev->dbbuf_dbs = NULL;
236 return -ENOMEM;
237 }
238
239 return 0;
240}
241
242static void nvme_dbbuf_dma_free(struct nvme_dev *dev)
243{
244 unsigned int mem_size = nvme_dbbuf_size(dev->db_stride);
245
246 if (dev->dbbuf_dbs) {
247 dma_free_coherent(dev->dev, mem_size,
248 dev->dbbuf_dbs, dev->dbbuf_dbs_dma_addr);
249 dev->dbbuf_dbs = NULL;
250 }
251 if (dev->dbbuf_eis) {
252 dma_free_coherent(dev->dev, mem_size,
253 dev->dbbuf_eis, dev->dbbuf_eis_dma_addr);
254 dev->dbbuf_eis = NULL;
255 }
256}
257
258static void nvme_dbbuf_init(struct nvme_dev *dev,
259 struct nvme_queue *nvmeq, int qid)
260{
261 if (!dev->dbbuf_dbs || !qid)
262 return;
263
264 nvmeq->dbbuf_sq_db = &dev->dbbuf_dbs[sq_idx(qid, dev->db_stride)];
265 nvmeq->dbbuf_cq_db = &dev->dbbuf_dbs[cq_idx(qid, dev->db_stride)];
266 nvmeq->dbbuf_sq_ei = &dev->dbbuf_eis[sq_idx(qid, dev->db_stride)];
267 nvmeq->dbbuf_cq_ei = &dev->dbbuf_eis[cq_idx(qid, dev->db_stride)];
268}
269
270static void nvme_dbbuf_set(struct nvme_dev *dev)
271{
272 struct nvme_command c;
273
274 if (!dev->dbbuf_dbs)
275 return;
276
277 memset(&c, 0, sizeof(c));
278 c.dbbuf.opcode = nvme_admin_dbbuf;
279 c.dbbuf.prp1 = cpu_to_le64(dev->dbbuf_dbs_dma_addr);
280 c.dbbuf.prp2 = cpu_to_le64(dev->dbbuf_eis_dma_addr);
281
282 if (nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0)) {
9bdcfb10 283 dev_warn(dev->ctrl.device, "unable to set dbbuf\n");
f9f38e33
HK
284 /* Free memory and continue on */
285 nvme_dbbuf_dma_free(dev);
286 }
287}
288
289static inline int nvme_dbbuf_need_event(u16 event_idx, u16 new_idx, u16 old)
290{
291 return (u16)(new_idx - event_idx - 1) < (u16)(new_idx - old);
292}
293
294/* Update dbbuf and return true if an MMIO is required */
295static bool nvme_dbbuf_update_and_check_event(u16 value, u32 *dbbuf_db,
296 volatile u32 *dbbuf_ei)
297{
298 if (dbbuf_db) {
299 u16 old_value;
300
301 /*
302 * Ensure that the queue is written before updating
303 * the doorbell in memory
304 */
305 wmb();
306
307 old_value = *dbbuf_db;
308 *dbbuf_db = value;
309
3041e55f
MW
310 /*
311 * Ensure that the doorbell is updated before reading the event
312 * index from memory. The controller needs to provide similar
313 * ordering to ensure the envent index is updated before reading
314 * the doorbell.
315 */
316 mb();
317
f9f38e33
HK
318 if (!nvme_dbbuf_need_event(*dbbuf_ei, value, old_value))
319 return false;
320 }
321
322 return true;
b60503ba
MW
323}
324
ac3dd5bd
JA
325/*
326 * Max size of iod being embedded in the request payload
327 */
328#define NVME_INT_PAGES 2
5fd4ce1b 329#define NVME_INT_BYTES(dev) (NVME_INT_PAGES * (dev)->ctrl.page_size)
ac3dd5bd
JA
330
331/*
332 * Will slightly overestimate the number of pages needed. This is OK
333 * as it only leads to a small amount of wasted memory for the lifetime of
334 * the I/O.
335 */
336static int nvme_npages(unsigned size, struct nvme_dev *dev)
337{
5fd4ce1b
CH
338 unsigned nprps = DIV_ROUND_UP(size + dev->ctrl.page_size,
339 dev->ctrl.page_size);
ac3dd5bd
JA
340 return DIV_ROUND_UP(8 * nprps, PAGE_SIZE - 8);
341}
342
a7a7cbe3
CK
343/*
344 * Calculates the number of pages needed for the SGL segments. For example a 4k
345 * page can accommodate 256 SGL descriptors.
346 */
347static int nvme_pci_npages_sgl(unsigned int num_seg)
ac3dd5bd 348{
a7a7cbe3 349 return DIV_ROUND_UP(num_seg * sizeof(struct nvme_sgl_desc), PAGE_SIZE);
f4800d6d 350}
ac3dd5bd 351
a7a7cbe3
CK
352static unsigned int nvme_pci_iod_alloc_size(struct nvme_dev *dev,
353 unsigned int size, unsigned int nseg, bool use_sgl)
f4800d6d 354{
a7a7cbe3
CK
355 size_t alloc_size;
356
357 if (use_sgl)
358 alloc_size = sizeof(__le64 *) * nvme_pci_npages_sgl(nseg);
359 else
360 alloc_size = sizeof(__le64 *) * nvme_npages(size, dev);
361
362 return alloc_size + sizeof(struct scatterlist) * nseg;
f4800d6d 363}
ac3dd5bd 364
a7a7cbe3 365static unsigned int nvme_pci_cmd_size(struct nvme_dev *dev, bool use_sgl)
f4800d6d 366{
a7a7cbe3
CK
367 unsigned int alloc_size = nvme_pci_iod_alloc_size(dev,
368 NVME_INT_BYTES(dev), NVME_INT_PAGES,
369 use_sgl);
370
371 return sizeof(struct nvme_iod) + alloc_size;
ac3dd5bd
JA
372}
373
a4aea562
MB
374static int nvme_admin_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
375 unsigned int hctx_idx)
e85248e5 376{
a4aea562
MB
377 struct nvme_dev *dev = data;
378 struct nvme_queue *nvmeq = dev->queues[0];
379
42483228
KB
380 WARN_ON(hctx_idx != 0);
381 WARN_ON(dev->admin_tagset.tags[0] != hctx->tags);
382 WARN_ON(nvmeq->tags);
383
a4aea562 384 hctx->driver_data = nvmeq;
42483228 385 nvmeq->tags = &dev->admin_tagset.tags[0];
a4aea562 386 return 0;
e85248e5
MW
387}
388
4af0e21c
KB
389static void nvme_admin_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
390{
391 struct nvme_queue *nvmeq = hctx->driver_data;
392
393 nvmeq->tags = NULL;
394}
395
a4aea562
MB
396static int nvme_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
397 unsigned int hctx_idx)
b60503ba 398{
a4aea562 399 struct nvme_dev *dev = data;
42483228 400 struct nvme_queue *nvmeq = dev->queues[hctx_idx + 1];
a4aea562 401
42483228
KB
402 if (!nvmeq->tags)
403 nvmeq->tags = &dev->tagset.tags[hctx_idx];
b60503ba 404
42483228 405 WARN_ON(dev->tagset.tags[hctx_idx] != hctx->tags);
a4aea562
MB
406 hctx->driver_data = nvmeq;
407 return 0;
b60503ba
MW
408}
409
d6296d39
CH
410static int nvme_init_request(struct blk_mq_tag_set *set, struct request *req,
411 unsigned int hctx_idx, unsigned int numa_node)
b60503ba 412{
d6296d39 413 struct nvme_dev *dev = set->driver_data;
f4800d6d 414 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
0350815a
CH
415 int queue_idx = (set == &dev->tagset) ? hctx_idx + 1 : 0;
416 struct nvme_queue *nvmeq = dev->queues[queue_idx];
a4aea562
MB
417
418 BUG_ON(!nvmeq);
f4800d6d 419 iod->nvmeq = nvmeq;
a4aea562
MB
420 return 0;
421}
422
dca51e78
CH
423static int nvme_pci_map_queues(struct blk_mq_tag_set *set)
424{
425 struct nvme_dev *dev = set->driver_data;
426
427 return blk_mq_pci_map_queues(set, to_pci_dev(dev->dev));
428}
429
b60503ba 430/**
adf68f21 431 * __nvme_submit_cmd() - Copy a command into a queue and ring the doorbell
b60503ba
MW
432 * @nvmeq: The queue to use
433 * @cmd: The command to send
434 *
435 * Safe to use from interrupt context
436 */
e3f879bf
SB
437static void __nvme_submit_cmd(struct nvme_queue *nvmeq,
438 struct nvme_command *cmd)
b60503ba 439{
a4aea562
MB
440 u16 tail = nvmeq->sq_tail;
441
8ffaadf7
JD
442 if (nvmeq->sq_cmds_io)
443 memcpy_toio(&nvmeq->sq_cmds_io[tail], cmd, sizeof(*cmd));
444 else
445 memcpy(&nvmeq->sq_cmds[tail], cmd, sizeof(*cmd));
446
b60503ba
MW
447 if (++tail == nvmeq->q_depth)
448 tail = 0;
f9f38e33
HK
449 if (nvme_dbbuf_update_and_check_event(tail, nvmeq->dbbuf_sq_db,
450 nvmeq->dbbuf_sq_ei))
451 writel(tail, nvmeq->q_db);
b60503ba 452 nvmeq->sq_tail = tail;
b60503ba
MW
453}
454
a7a7cbe3 455static void **nvme_pci_iod_list(struct request *req)
b60503ba 456{
f4800d6d 457 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
a7a7cbe3 458 return (void **)(iod->sg + blk_rq_nr_phys_segments(req));
b60503ba
MW
459}
460
955b1b5a
MI
461static inline bool nvme_pci_use_sgls(struct nvme_dev *dev, struct request *req)
462{
463 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
20469a37 464 int nseg = blk_rq_nr_phys_segments(req);
955b1b5a
MI
465 unsigned int avg_seg_size;
466
20469a37
KB
467 if (nseg == 0)
468 return false;
469
470 avg_seg_size = DIV_ROUND_UP(blk_rq_payload_bytes(req), nseg);
955b1b5a
MI
471
472 if (!(dev->ctrl.sgls & ((1 << 0) | (1 << 1))))
473 return false;
474 if (!iod->nvmeq->qid)
475 return false;
476 if (!sgl_threshold || avg_seg_size < sgl_threshold)
477 return false;
478 return true;
479}
480
fc17b653 481static blk_status_t nvme_init_iod(struct request *rq, struct nvme_dev *dev)
ac3dd5bd 482{
f4800d6d 483 struct nvme_iod *iod = blk_mq_rq_to_pdu(rq);
f9d03f96 484 int nseg = blk_rq_nr_phys_segments(rq);
b131c61d 485 unsigned int size = blk_rq_payload_bytes(rq);
ac3dd5bd 486
955b1b5a
MI
487 iod->use_sgl = nvme_pci_use_sgls(dev, rq);
488
f4800d6d 489 if (nseg > NVME_INT_PAGES || size > NVME_INT_BYTES(dev)) {
a7a7cbe3
CK
490 size_t alloc_size = nvme_pci_iod_alloc_size(dev, size, nseg,
491 iod->use_sgl);
492
493 iod->sg = kmalloc(alloc_size, GFP_ATOMIC);
f4800d6d 494 if (!iod->sg)
fc17b653 495 return BLK_STS_RESOURCE;
f4800d6d
CH
496 } else {
497 iod->sg = iod->inline_sg;
ac3dd5bd
JA
498 }
499
f4800d6d
CH
500 iod->aborted = 0;
501 iod->npages = -1;
502 iod->nents = 0;
503 iod->length = size;
f80ec966 504
fc17b653 505 return BLK_STS_OK;
ac3dd5bd
JA
506}
507
f4800d6d 508static void nvme_free_iod(struct nvme_dev *dev, struct request *req)
b60503ba 509{
f4800d6d 510 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
a7a7cbe3
CK
511 const int last_prp = dev->ctrl.page_size / sizeof(__le64) - 1;
512 dma_addr_t dma_addr = iod->first_dma, next_dma_addr;
513
eca18b23 514 int i;
eca18b23
MW
515
516 if (iod->npages == 0)
a7a7cbe3
CK
517 dma_pool_free(dev->prp_small_pool, nvme_pci_iod_list(req)[0],
518 dma_addr);
519
eca18b23 520 for (i = 0; i < iod->npages; i++) {
a7a7cbe3
CK
521 void *addr = nvme_pci_iod_list(req)[i];
522
523 if (iod->use_sgl) {
524 struct nvme_sgl_desc *sg_list = addr;
525
526 next_dma_addr =
527 le64_to_cpu((sg_list[SGES_PER_PAGE - 1]).addr);
528 } else {
529 __le64 *prp_list = addr;
530
531 next_dma_addr = le64_to_cpu(prp_list[last_prp]);
532 }
533
534 dma_pool_free(dev->prp_page_pool, addr, dma_addr);
535 dma_addr = next_dma_addr;
eca18b23 536 }
ac3dd5bd 537
f4800d6d
CH
538 if (iod->sg != iod->inline_sg)
539 kfree(iod->sg);
b4ff9c8d
KB
540}
541
52b68d7e 542#ifdef CONFIG_BLK_DEV_INTEGRITY
e1e5e564
KB
543static void nvme_dif_prep(u32 p, u32 v, struct t10_pi_tuple *pi)
544{
545 if (be32_to_cpu(pi->ref_tag) == v)
546 pi->ref_tag = cpu_to_be32(p);
547}
548
549static void nvme_dif_complete(u32 p, u32 v, struct t10_pi_tuple *pi)
550{
551 if (be32_to_cpu(pi->ref_tag) == p)
552 pi->ref_tag = cpu_to_be32(v);
553}
554
555/**
556 * nvme_dif_remap - remaps ref tags to bip seed and physical lba
557 *
558 * The virtual start sector is the one that was originally submitted by the
559 * block layer. Due to partitioning, MD/DM cloning, etc. the actual physical
560 * start sector may be different. Remap protection information to match the
561 * physical LBA on writes, and back to the original seed on reads.
562 *
563 * Type 0 and 3 do not have a ref tag, so no remapping required.
564 */
565static void nvme_dif_remap(struct request *req,
566 void (*dif_swap)(u32 p, u32 v, struct t10_pi_tuple *pi))
567{
568 struct nvme_ns *ns = req->rq_disk->private_data;
569 struct bio_integrity_payload *bip;
570 struct t10_pi_tuple *pi;
571 void *p, *pmap;
572 u32 i, nlb, ts, phys, virt;
573
574 if (!ns->pi_type || ns->pi_type == NVME_NS_DPS_PI_TYPE3)
575 return;
576
577 bip = bio_integrity(req->bio);
578 if (!bip)
579 return;
580
581 pmap = kmap_atomic(bip->bip_vec->bv_page) + bip->bip_vec->bv_offset;
e1e5e564
KB
582
583 p = pmap;
584 virt = bip_get_seed(bip);
585 phys = nvme_block_nr(ns, blk_rq_pos(req));
586 nlb = (blk_rq_bytes(req) >> ns->lba_shift);
ac6fc48c 587 ts = ns->disk->queue->integrity.tuple_size;
e1e5e564
KB
588
589 for (i = 0; i < nlb; i++, virt++, phys++) {
590 pi = (struct t10_pi_tuple *)p;
591 dif_swap(phys, virt, pi);
592 p += ts;
593 }
594 kunmap_atomic(pmap);
595}
52b68d7e
KB
596#else /* CONFIG_BLK_DEV_INTEGRITY */
597static void nvme_dif_remap(struct request *req,
598 void (*dif_swap)(u32 p, u32 v, struct t10_pi_tuple *pi))
599{
600}
601static void nvme_dif_prep(u32 p, u32 v, struct t10_pi_tuple *pi)
602{
603}
604static void nvme_dif_complete(u32 p, u32 v, struct t10_pi_tuple *pi)
605{
606}
52b68d7e
KB
607#endif
608
d0877473
KB
609static void nvme_print_sgl(struct scatterlist *sgl, int nents)
610{
611 int i;
612 struct scatterlist *sg;
613
614 for_each_sg(sgl, sg, nents, i) {
615 dma_addr_t phys = sg_phys(sg);
616 pr_warn("sg[%d] phys_addr:%pad offset:%d length:%d "
617 "dma_address:%pad dma_length:%d\n",
618 i, &phys, sg->offset, sg->length, &sg_dma_address(sg),
619 sg_dma_len(sg));
620 }
621}
622
a7a7cbe3
CK
623static blk_status_t nvme_pci_setup_prps(struct nvme_dev *dev,
624 struct request *req, struct nvme_rw_command *cmnd)
ff22b54f 625{
f4800d6d 626 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
99802a7a 627 struct dma_pool *pool;
b131c61d 628 int length = blk_rq_payload_bytes(req);
eca18b23 629 struct scatterlist *sg = iod->sg;
ff22b54f
MW
630 int dma_len = sg_dma_len(sg);
631 u64 dma_addr = sg_dma_address(sg);
5fd4ce1b 632 u32 page_size = dev->ctrl.page_size;
f137e0f1 633 int offset = dma_addr & (page_size - 1);
e025344c 634 __le64 *prp_list;
a7a7cbe3 635 void **list = nvme_pci_iod_list(req);
e025344c 636 dma_addr_t prp_dma;
eca18b23 637 int nprps, i;
ff22b54f 638
1d090624 639 length -= (page_size - offset);
5228b328
JS
640 if (length <= 0) {
641 iod->first_dma = 0;
a7a7cbe3 642 goto done;
5228b328 643 }
ff22b54f 644
1d090624 645 dma_len -= (page_size - offset);
ff22b54f 646 if (dma_len) {
1d090624 647 dma_addr += (page_size - offset);
ff22b54f
MW
648 } else {
649 sg = sg_next(sg);
650 dma_addr = sg_dma_address(sg);
651 dma_len = sg_dma_len(sg);
652 }
653
1d090624 654 if (length <= page_size) {
edd10d33 655 iod->first_dma = dma_addr;
a7a7cbe3 656 goto done;
e025344c
SMM
657 }
658
1d090624 659 nprps = DIV_ROUND_UP(length, page_size);
99802a7a
MW
660 if (nprps <= (256 / 8)) {
661 pool = dev->prp_small_pool;
eca18b23 662 iod->npages = 0;
99802a7a
MW
663 } else {
664 pool = dev->prp_page_pool;
eca18b23 665 iod->npages = 1;
99802a7a
MW
666 }
667
69d2b571 668 prp_list = dma_pool_alloc(pool, GFP_ATOMIC, &prp_dma);
b77954cb 669 if (!prp_list) {
edd10d33 670 iod->first_dma = dma_addr;
eca18b23 671 iod->npages = -1;
86eea289 672 return BLK_STS_RESOURCE;
b77954cb 673 }
eca18b23
MW
674 list[0] = prp_list;
675 iod->first_dma = prp_dma;
e025344c
SMM
676 i = 0;
677 for (;;) {
1d090624 678 if (i == page_size >> 3) {
e025344c 679 __le64 *old_prp_list = prp_list;
69d2b571 680 prp_list = dma_pool_alloc(pool, GFP_ATOMIC, &prp_dma);
eca18b23 681 if (!prp_list)
86eea289 682 return BLK_STS_RESOURCE;
eca18b23 683 list[iod->npages++] = prp_list;
7523d834
MW
684 prp_list[0] = old_prp_list[i - 1];
685 old_prp_list[i - 1] = cpu_to_le64(prp_dma);
686 i = 1;
e025344c
SMM
687 }
688 prp_list[i++] = cpu_to_le64(dma_addr);
1d090624
KB
689 dma_len -= page_size;
690 dma_addr += page_size;
691 length -= page_size;
e025344c
SMM
692 if (length <= 0)
693 break;
694 if (dma_len > 0)
695 continue;
86eea289
KB
696 if (unlikely(dma_len < 0))
697 goto bad_sgl;
e025344c
SMM
698 sg = sg_next(sg);
699 dma_addr = sg_dma_address(sg);
700 dma_len = sg_dma_len(sg);
ff22b54f
MW
701 }
702
a7a7cbe3
CK
703done:
704 cmnd->dptr.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
705 cmnd->dptr.prp2 = cpu_to_le64(iod->first_dma);
706
86eea289
KB
707 return BLK_STS_OK;
708
709 bad_sgl:
d0877473
KB
710 WARN(DO_ONCE(nvme_print_sgl, iod->sg, iod->nents),
711 "Invalid SGL for payload:%d nents:%d\n",
712 blk_rq_payload_bytes(req), iod->nents);
86eea289 713 return BLK_STS_IOERR;
ff22b54f
MW
714}
715
a7a7cbe3
CK
716static void nvme_pci_sgl_set_data(struct nvme_sgl_desc *sge,
717 struct scatterlist *sg)
718{
719 sge->addr = cpu_to_le64(sg_dma_address(sg));
720 sge->length = cpu_to_le32(sg_dma_len(sg));
721 sge->type = NVME_SGL_FMT_DATA_DESC << 4;
722}
723
724static void nvme_pci_sgl_set_seg(struct nvme_sgl_desc *sge,
725 dma_addr_t dma_addr, int entries)
726{
727 sge->addr = cpu_to_le64(dma_addr);
728 if (entries < SGES_PER_PAGE) {
729 sge->length = cpu_to_le32(entries * sizeof(*sge));
730 sge->type = NVME_SGL_FMT_LAST_SEG_DESC << 4;
731 } else {
732 sge->length = cpu_to_le32(PAGE_SIZE);
733 sge->type = NVME_SGL_FMT_SEG_DESC << 4;
734 }
735}
736
737static blk_status_t nvme_pci_setup_sgls(struct nvme_dev *dev,
b0f2853b 738 struct request *req, struct nvme_rw_command *cmd, int entries)
a7a7cbe3
CK
739{
740 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
a7a7cbe3
CK
741 struct dma_pool *pool;
742 struct nvme_sgl_desc *sg_list;
743 struct scatterlist *sg = iod->sg;
a7a7cbe3 744 dma_addr_t sgl_dma;
b0f2853b 745 int i = 0;
a7a7cbe3 746
a7a7cbe3
CK
747 /* setting the transfer type as SGL */
748 cmd->flags = NVME_CMD_SGL_METABUF;
749
b0f2853b 750 if (entries == 1) {
a7a7cbe3
CK
751 nvme_pci_sgl_set_data(&cmd->dptr.sgl, sg);
752 return BLK_STS_OK;
753 }
754
755 if (entries <= (256 / sizeof(struct nvme_sgl_desc))) {
756 pool = dev->prp_small_pool;
757 iod->npages = 0;
758 } else {
759 pool = dev->prp_page_pool;
760 iod->npages = 1;
761 }
762
763 sg_list = dma_pool_alloc(pool, GFP_ATOMIC, &sgl_dma);
764 if (!sg_list) {
765 iod->npages = -1;
766 return BLK_STS_RESOURCE;
767 }
768
769 nvme_pci_iod_list(req)[0] = sg_list;
770 iod->first_dma = sgl_dma;
771
772 nvme_pci_sgl_set_seg(&cmd->dptr.sgl, sgl_dma, entries);
773
774 do {
775 if (i == SGES_PER_PAGE) {
776 struct nvme_sgl_desc *old_sg_desc = sg_list;
777 struct nvme_sgl_desc *link = &old_sg_desc[i - 1];
778
779 sg_list = dma_pool_alloc(pool, GFP_ATOMIC, &sgl_dma);
780 if (!sg_list)
781 return BLK_STS_RESOURCE;
782
783 i = 0;
784 nvme_pci_iod_list(req)[iod->npages++] = sg_list;
785 sg_list[i++] = *link;
786 nvme_pci_sgl_set_seg(link, sgl_dma, entries);
787 }
788
789 nvme_pci_sgl_set_data(&sg_list[i++], sg);
a7a7cbe3 790 sg = sg_next(sg);
b0f2853b 791 } while (--entries > 0);
a7a7cbe3 792
a7a7cbe3
CK
793 return BLK_STS_OK;
794}
795
fc17b653 796static blk_status_t nvme_map_data(struct nvme_dev *dev, struct request *req,
b131c61d 797 struct nvme_command *cmnd)
d29ec824 798{
f4800d6d 799 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
ba1ca37e
CH
800 struct request_queue *q = req->q;
801 enum dma_data_direction dma_dir = rq_data_dir(req) ?
802 DMA_TO_DEVICE : DMA_FROM_DEVICE;
fc17b653 803 blk_status_t ret = BLK_STS_IOERR;
b0f2853b 804 int nr_mapped;
d29ec824 805
f9d03f96 806 sg_init_table(iod->sg, blk_rq_nr_phys_segments(req));
ba1ca37e
CH
807 iod->nents = blk_rq_map_sg(q, req, iod->sg);
808 if (!iod->nents)
809 goto out;
d29ec824 810
fc17b653 811 ret = BLK_STS_RESOURCE;
b0f2853b
CH
812 nr_mapped = dma_map_sg_attrs(dev->dev, iod->sg, iod->nents, dma_dir,
813 DMA_ATTR_NO_WARN);
814 if (!nr_mapped)
ba1ca37e 815 goto out;
d29ec824 816
955b1b5a 817 if (iod->use_sgl)
b0f2853b 818 ret = nvme_pci_setup_sgls(dev, req, &cmnd->rw, nr_mapped);
a7a7cbe3
CK
819 else
820 ret = nvme_pci_setup_prps(dev, req, &cmnd->rw);
821
86eea289 822 if (ret != BLK_STS_OK)
ba1ca37e 823 goto out_unmap;
0e5e4f0e 824
fc17b653 825 ret = BLK_STS_IOERR;
ba1ca37e
CH
826 if (blk_integrity_rq(req)) {
827 if (blk_rq_count_integrity_sg(q, req->bio) != 1)
828 goto out_unmap;
0e5e4f0e 829
bf684057
CH
830 sg_init_table(&iod->meta_sg, 1);
831 if (blk_rq_map_integrity_sg(q, req->bio, &iod->meta_sg) != 1)
ba1ca37e 832 goto out_unmap;
0e5e4f0e 833
b5d8af5b 834 if (req_op(req) == REQ_OP_WRITE)
ba1ca37e 835 nvme_dif_remap(req, nvme_dif_prep);
0e5e4f0e 836
bf684057 837 if (!dma_map_sg(dev->dev, &iod->meta_sg, 1, dma_dir))
ba1ca37e 838 goto out_unmap;
d29ec824 839 }
00df5cb4 840
ba1ca37e 841 if (blk_integrity_rq(req))
bf684057 842 cmnd->rw.metadata = cpu_to_le64(sg_dma_address(&iod->meta_sg));
fc17b653 843 return BLK_STS_OK;
00df5cb4 844
ba1ca37e
CH
845out_unmap:
846 dma_unmap_sg(dev->dev, iod->sg, iod->nents, dma_dir);
847out:
848 return ret;
00df5cb4
MW
849}
850
f4800d6d 851static void nvme_unmap_data(struct nvme_dev *dev, struct request *req)
b60503ba 852{
f4800d6d 853 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
d4f6c3ab
CH
854 enum dma_data_direction dma_dir = rq_data_dir(req) ?
855 DMA_TO_DEVICE : DMA_FROM_DEVICE;
856
857 if (iod->nents) {
858 dma_unmap_sg(dev->dev, iod->sg, iod->nents, dma_dir);
859 if (blk_integrity_rq(req)) {
b5d8af5b 860 if (req_op(req) == REQ_OP_READ)
d4f6c3ab 861 nvme_dif_remap(req, nvme_dif_complete);
bf684057 862 dma_unmap_sg(dev->dev, &iod->meta_sg, 1, dma_dir);
e1e5e564 863 }
e19b127f 864 }
e1e5e564 865
f9d03f96 866 nvme_cleanup_cmd(req);
f4800d6d 867 nvme_free_iod(dev, req);
d4f6c3ab 868}
b60503ba 869
d29ec824
CH
870/*
871 * NOTE: ns is NULL when called on the admin queue.
872 */
fc17b653 873static blk_status_t nvme_queue_rq(struct blk_mq_hw_ctx *hctx,
a4aea562 874 const struct blk_mq_queue_data *bd)
edd10d33 875{
a4aea562
MB
876 struct nvme_ns *ns = hctx->queue->queuedata;
877 struct nvme_queue *nvmeq = hctx->driver_data;
d29ec824 878 struct nvme_dev *dev = nvmeq->dev;
a4aea562 879 struct request *req = bd->rq;
ba1ca37e 880 struct nvme_command cmnd;
ebe6d874 881 blk_status_t ret;
e1e5e564 882
f9d03f96 883 ret = nvme_setup_cmd(ns, req, &cmnd);
fc17b653 884 if (ret)
f4800d6d 885 return ret;
a4aea562 886
b131c61d 887 ret = nvme_init_iod(req, dev);
fc17b653 888 if (ret)
f9d03f96 889 goto out_free_cmd;
a4aea562 890
fc17b653 891 if (blk_rq_nr_phys_segments(req)) {
b131c61d 892 ret = nvme_map_data(dev, req, &cmnd);
fc17b653
CH
893 if (ret)
894 goto out_cleanup_iod;
895 }
a4aea562 896
aae239e1 897 blk_mq_start_request(req);
a4aea562 898
ba1ca37e 899 spin_lock_irq(&nvmeq->q_lock);
ae1fba20 900 if (unlikely(nvmeq->cq_vector < 0)) {
fc17b653 901 ret = BLK_STS_IOERR;
ae1fba20 902 spin_unlock_irq(&nvmeq->q_lock);
f9d03f96 903 goto out_cleanup_iod;
ae1fba20 904 }
ba1ca37e 905 __nvme_submit_cmd(nvmeq, &cmnd);
a4aea562
MB
906 nvme_process_cq(nvmeq);
907 spin_unlock_irq(&nvmeq->q_lock);
fc17b653 908 return BLK_STS_OK;
f9d03f96 909out_cleanup_iod:
f4800d6d 910 nvme_free_iod(dev, req);
f9d03f96
CH
911out_free_cmd:
912 nvme_cleanup_cmd(req);
ba1ca37e 913 return ret;
b60503ba 914}
e1e5e564 915
77f02a7a 916static void nvme_pci_complete_rq(struct request *req)
eee417b0 917{
f4800d6d 918 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
a4aea562 919
77f02a7a
CH
920 nvme_unmap_data(iod->nvmeq->dev, req);
921 nvme_complete_rq(req);
b60503ba
MW
922}
923
d783e0bd
MR
924/* We read the CQE phase first to check if the rest of the entry is valid */
925static inline bool nvme_cqe_valid(struct nvme_queue *nvmeq, u16 head,
926 u16 phase)
927{
928 return (le16_to_cpu(nvmeq->cqes[head].status) & 1) == phase;
929}
930
eb281c82 931static inline void nvme_ring_cq_doorbell(struct nvme_queue *nvmeq)
b60503ba 932{
eb281c82 933 u16 head = nvmeq->cq_head;
adf68f21 934
eb281c82
SG
935 if (likely(nvmeq->cq_vector >= 0)) {
936 if (nvme_dbbuf_update_and_check_event(head, nvmeq->dbbuf_cq_db,
937 nvmeq->dbbuf_cq_ei))
938 writel(head, nvmeq->q_db + nvmeq->dev->db_stride);
939 }
940}
aae239e1 941
83a12fb7
SG
942static inline void nvme_handle_cqe(struct nvme_queue *nvmeq,
943 struct nvme_completion *cqe)
944{
945 struct request *req;
adf68f21 946
83a12fb7
SG
947 if (unlikely(cqe->command_id >= nvmeq->q_depth)) {
948 dev_warn(nvmeq->dev->ctrl.device,
949 "invalid id %d completed on queue %d\n",
950 cqe->command_id, le16_to_cpu(cqe->sq_id));
951 return;
b60503ba
MW
952 }
953
83a12fb7
SG
954 /*
955 * AEN requests are special as they don't time out and can
956 * survive any kind of queue freeze and often don't respond to
957 * aborts. We don't even bother to allocate a struct request
958 * for them but rather special case them here.
959 */
960 if (unlikely(nvmeq->qid == 0 &&
38dabe21 961 cqe->command_id >= NVME_AQ_BLK_MQ_DEPTH)) {
83a12fb7
SG
962 nvme_complete_async_event(&nvmeq->dev->ctrl,
963 cqe->status, &cqe->result);
a0fa9647 964 return;
83a12fb7 965 }
b60503ba 966
e9d8a0fd 967 nvmeq->cqe_seen = 1;
83a12fb7
SG
968 req = blk_mq_tag_to_rq(*nvmeq->tags, cqe->command_id);
969 nvme_end_request(req, cqe->status, cqe->result);
970}
b60503ba 971
920d13a8
SG
972static inline bool nvme_read_cqe(struct nvme_queue *nvmeq,
973 struct nvme_completion *cqe)
b60503ba 974{
920d13a8
SG
975 if (nvme_cqe_valid(nvmeq, nvmeq->cq_head, nvmeq->cq_phase)) {
976 *cqe = nvmeq->cqes[nvmeq->cq_head];
adf68f21 977
fdcd1de9 978 if (nvmeq->cq_head == nvmeq->q_depth - 1) {
920d13a8
SG
979 nvmeq->cq_head = 0;
980 nvmeq->cq_phase = !nvmeq->cq_phase;
fdcd1de9
HY
981 } else {
982 nvmeq->cq_head++;
b60503ba 983 }
920d13a8 984 return true;
b60503ba 985 }
920d13a8 986 return false;
a0fa9647
JA
987}
988
989static void nvme_process_cq(struct nvme_queue *nvmeq)
990{
920d13a8
SG
991 struct nvme_completion cqe;
992 int consumed = 0;
b60503ba 993
920d13a8
SG
994 while (nvme_read_cqe(nvmeq, &cqe)) {
995 nvme_handle_cqe(nvmeq, &cqe);
996 consumed++;
920d13a8 997 }
eb281c82 998
e9d8a0fd 999 if (consumed)
920d13a8 1000 nvme_ring_cq_doorbell(nvmeq);
b60503ba
MW
1001}
1002
1003static irqreturn_t nvme_irq(int irq, void *data)
58ffacb5
MW
1004{
1005 irqreturn_t result;
1006 struct nvme_queue *nvmeq = data;
1007 spin_lock(&nvmeq->q_lock);
e9539f47
MW
1008 nvme_process_cq(nvmeq);
1009 result = nvmeq->cqe_seen ? IRQ_HANDLED : IRQ_NONE;
1010 nvmeq->cqe_seen = 0;
58ffacb5
MW
1011 spin_unlock(&nvmeq->q_lock);
1012 return result;
1013}
1014
1015static irqreturn_t nvme_irq_check(int irq, void *data)
1016{
1017 struct nvme_queue *nvmeq = data;
d783e0bd
MR
1018 if (nvme_cqe_valid(nvmeq, nvmeq->cq_head, nvmeq->cq_phase))
1019 return IRQ_WAKE_THREAD;
1020 return IRQ_NONE;
58ffacb5
MW
1021}
1022
7776db1c 1023static int __nvme_poll(struct nvme_queue *nvmeq, unsigned int tag)
a0fa9647 1024{
442e19b7
SG
1025 struct nvme_completion cqe;
1026 int found = 0, consumed = 0;
a0fa9647 1027
442e19b7
SG
1028 if (!nvme_cqe_valid(nvmeq, nvmeq->cq_head, nvmeq->cq_phase))
1029 return 0;
a0fa9647 1030
442e19b7
SG
1031 spin_lock_irq(&nvmeq->q_lock);
1032 while (nvme_read_cqe(nvmeq, &cqe)) {
1033 nvme_handle_cqe(nvmeq, &cqe);
1034 consumed++;
1035
1036 if (tag == cqe.command_id) {
1037 found = 1;
1038 break;
1039 }
1040 }
1041
1042 if (consumed)
1043 nvme_ring_cq_doorbell(nvmeq);
1044 spin_unlock_irq(&nvmeq->q_lock);
1045
1046 return found;
a0fa9647
JA
1047}
1048
7776db1c
KB
1049static int nvme_poll(struct blk_mq_hw_ctx *hctx, unsigned int tag)
1050{
1051 struct nvme_queue *nvmeq = hctx->driver_data;
1052
1053 return __nvme_poll(nvmeq, tag);
1054}
1055
ad22c355 1056static void nvme_pci_submit_async_event(struct nvme_ctrl *ctrl)
b60503ba 1057{
f866fc42 1058 struct nvme_dev *dev = to_nvme_dev(ctrl);
9396dec9 1059 struct nvme_queue *nvmeq = dev->queues[0];
a4aea562 1060 struct nvme_command c;
b60503ba 1061
a4aea562
MB
1062 memset(&c, 0, sizeof(c));
1063 c.common.opcode = nvme_admin_async_event;
ad22c355 1064 c.common.command_id = NVME_AQ_BLK_MQ_DEPTH;
3c0cf138 1065
9396dec9 1066 spin_lock_irq(&nvmeq->q_lock);
f866fc42 1067 __nvme_submit_cmd(nvmeq, &c);
9396dec9 1068 spin_unlock_irq(&nvmeq->q_lock);
f705f837
CH
1069}
1070
b60503ba 1071static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
f705f837 1072{
b60503ba
MW
1073 struct nvme_command c;
1074
1075 memset(&c, 0, sizeof(c));
1076 c.delete_queue.opcode = opcode;
1077 c.delete_queue.qid = cpu_to_le16(id);
1078
1c63dc66 1079 return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
b60503ba
MW
1080}
1081
b60503ba
MW
1082static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
1083 struct nvme_queue *nvmeq)
1084{
5750cb1c 1085 struct nvme_ctrl *ctrl = &dev->ctrl;
b60503ba
MW
1086 struct nvme_command c;
1087 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_CQ_IRQ_ENABLED;
1088
5750cb1c
JA
1089 /*
1090 * Some drives have a bug that auto-enables WRRU if MEDIUM isn't
1091 * set. Since URGENT priority is zeroes, it makes all queues
1092 * URGENT.
1093 */
1094 if (ctrl->quirks & NVME_QUIRK_MEDIUM_PRIO_SQ)
1095 flags |= NVME_SQ_PRIO_MEDIUM;
1096
d29ec824 1097 /*
16772ae6 1098 * Note: we (ab)use the fact that the prp fields survive if no data
d29ec824
CH
1099 * is attached to the request.
1100 */
b60503ba
MW
1101 memset(&c, 0, sizeof(c));
1102 c.create_cq.opcode = nvme_admin_create_cq;
1103 c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
1104 c.create_cq.cqid = cpu_to_le16(qid);
1105 c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
1106 c.create_cq.cq_flags = cpu_to_le16(flags);
1107 c.create_cq.irq_vector = cpu_to_le16(nvmeq->cq_vector);
1108
1c63dc66 1109 return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
b60503ba
MW
1110}
1111
1112static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
1113 struct nvme_queue *nvmeq)
1114{
b60503ba 1115 struct nvme_command c;
81c1cd98 1116 int flags = NVME_QUEUE_PHYS_CONTIG;
b60503ba 1117
d29ec824 1118 /*
16772ae6 1119 * Note: we (ab)use the fact that the prp fields survive if no data
d29ec824
CH
1120 * is attached to the request.
1121 */
b60503ba
MW
1122 memset(&c, 0, sizeof(c));
1123 c.create_sq.opcode = nvme_admin_create_sq;
1124 c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
1125 c.create_sq.sqid = cpu_to_le16(qid);
1126 c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
1127 c.create_sq.sq_flags = cpu_to_le16(flags);
1128 c.create_sq.cqid = cpu_to_le16(qid);
1129
1c63dc66 1130 return nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
b60503ba
MW
1131}
1132
1133static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
1134{
1135 return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
1136}
1137
1138static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
1139{
1140 return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
1141}
1142
2a842aca 1143static void abort_endio(struct request *req, blk_status_t error)
bc5fc7e4 1144{
f4800d6d
CH
1145 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1146 struct nvme_queue *nvmeq = iod->nvmeq;
e44ac588 1147
27fa9bc5
CH
1148 dev_warn(nvmeq->dev->ctrl.device,
1149 "Abort status: 0x%x", nvme_req(req)->status);
e7a2a87d 1150 atomic_inc(&nvmeq->dev->ctrl.abort_limit);
e7a2a87d 1151 blk_mq_free_request(req);
bc5fc7e4
MW
1152}
1153
b2a0eb1a
KB
1154static bool nvme_should_reset(struct nvme_dev *dev, u32 csts)
1155{
1156
1157 /* If true, indicates loss of adapter communication, possibly by a
1158 * NVMe Subsystem reset.
1159 */
1160 bool nssro = dev->subsystem && (csts & NVME_CSTS_NSSRO);
1161
1162 /* If there is a reset ongoing, we shouldn't reset again. */
1163 if (dev->ctrl.state == NVME_CTRL_RESETTING)
1164 return false;
1165
1166 /* We shouldn't reset unless the controller is on fatal error state
1167 * _or_ if we lost the communication with it.
1168 */
1169 if (!(csts & NVME_CSTS_CFS) && !nssro)
1170 return false;
1171
b2a0eb1a
KB
1172 return true;
1173}
1174
1175static void nvme_warn_reset(struct nvme_dev *dev, u32 csts)
1176{
1177 /* Read a config register to help see what died. */
1178 u16 pci_status;
1179 int result;
1180
1181 result = pci_read_config_word(to_pci_dev(dev->dev), PCI_STATUS,
1182 &pci_status);
1183 if (result == PCIBIOS_SUCCESSFUL)
1184 dev_warn(dev->ctrl.device,
1185 "controller is down; will reset: CSTS=0x%x, PCI_STATUS=0x%hx\n",
1186 csts, pci_status);
1187 else
1188 dev_warn(dev->ctrl.device,
1189 "controller is down; will reset: CSTS=0x%x, PCI_STATUS read failed (%d)\n",
1190 csts, result);
1191}
1192
31c7c7d2 1193static enum blk_eh_timer_return nvme_timeout(struct request *req, bool reserved)
c30341dc 1194{
f4800d6d
CH
1195 struct nvme_iod *iod = blk_mq_rq_to_pdu(req);
1196 struct nvme_queue *nvmeq = iod->nvmeq;
c30341dc 1197 struct nvme_dev *dev = nvmeq->dev;
a4aea562 1198 struct request *abort_req;
a4aea562 1199 struct nvme_command cmd;
b2a0eb1a
KB
1200 u32 csts = readl(dev->bar + NVME_REG_CSTS);
1201
963e0db6
WX
1202 /* If PCI error recovery process is happening, we cannot reset or
1203 * the recovery mechanism will surely fail.
1204 */
1205 mb();
1206 if (pci_channel_offline(to_pci_dev(dev->dev)))
1207 return BLK_EH_RESET_TIMER;
1208
b2a0eb1a
KB
1209 /*
1210 * Reset immediately if the controller is failed
1211 */
1212 if (nvme_should_reset(dev, csts)) {
1213 nvme_warn_reset(dev, csts);
1214 nvme_dev_disable(dev, false);
d86c4d8e 1215 nvme_reset_ctrl(&dev->ctrl);
b2a0eb1a
KB
1216 return BLK_EH_HANDLED;
1217 }
c30341dc 1218
7776db1c
KB
1219 /*
1220 * Did we miss an interrupt?
1221 */
1222 if (__nvme_poll(nvmeq, req->tag)) {
1223 dev_warn(dev->ctrl.device,
1224 "I/O %d QID %d timeout, completion polled\n",
1225 req->tag, nvmeq->qid);
1226 return BLK_EH_HANDLED;
1227 }
1228
31c7c7d2 1229 /*
fd634f41
CH
1230 * Shutdown immediately if controller times out while starting. The
1231 * reset work will see the pci device disabled when it gets the forced
1232 * cancellation error. All outstanding requests are completed on
1233 * shutdown, so we return BLK_EH_HANDLED.
1234 */
bb8d261e 1235 if (dev->ctrl.state == NVME_CTRL_RESETTING) {
1b3c47c1 1236 dev_warn(dev->ctrl.device,
fd634f41
CH
1237 "I/O %d QID %d timeout, disable controller\n",
1238 req->tag, nvmeq->qid);
a5cdb68c 1239 nvme_dev_disable(dev, false);
27fa9bc5 1240 nvme_req(req)->flags |= NVME_REQ_CANCELLED;
fd634f41 1241 return BLK_EH_HANDLED;
c30341dc
KB
1242 }
1243
fd634f41
CH
1244 /*
1245 * Shutdown the controller immediately and schedule a reset if the
1246 * command was already aborted once before and still hasn't been
1247 * returned to the driver, or if this is the admin queue.
31c7c7d2 1248 */
f4800d6d 1249 if (!nvmeq->qid || iod->aborted) {
1b3c47c1 1250 dev_warn(dev->ctrl.device,
e1569a16
KB
1251 "I/O %d QID %d timeout, reset controller\n",
1252 req->tag, nvmeq->qid);
a5cdb68c 1253 nvme_dev_disable(dev, false);
d86c4d8e 1254 nvme_reset_ctrl(&dev->ctrl);
c30341dc 1255
e1569a16
KB
1256 /*
1257 * Mark the request as handled, since the inline shutdown
1258 * forces all outstanding requests to complete.
1259 */
27fa9bc5 1260 nvme_req(req)->flags |= NVME_REQ_CANCELLED;
e1569a16 1261 return BLK_EH_HANDLED;
c30341dc 1262 }
c30341dc 1263
e7a2a87d 1264 if (atomic_dec_return(&dev->ctrl.abort_limit) < 0) {
6bf25d16 1265 atomic_inc(&dev->ctrl.abort_limit);
31c7c7d2 1266 return BLK_EH_RESET_TIMER;
6bf25d16 1267 }
7bf7d778 1268 iod->aborted = 1;
a4aea562 1269
c30341dc
KB
1270 memset(&cmd, 0, sizeof(cmd));
1271 cmd.abort.opcode = nvme_admin_abort_cmd;
a4aea562 1272 cmd.abort.cid = req->tag;
c30341dc 1273 cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
c30341dc 1274
1b3c47c1
SG
1275 dev_warn(nvmeq->dev->ctrl.device,
1276 "I/O %d QID %d timeout, aborting\n",
1277 req->tag, nvmeq->qid);
e7a2a87d
CH
1278
1279 abort_req = nvme_alloc_request(dev->ctrl.admin_q, &cmd,
eb71f435 1280 BLK_MQ_REQ_NOWAIT, NVME_QID_ANY);
e7a2a87d
CH
1281 if (IS_ERR(abort_req)) {
1282 atomic_inc(&dev->ctrl.abort_limit);
1283 return BLK_EH_RESET_TIMER;
1284 }
1285
1286 abort_req->timeout = ADMIN_TIMEOUT;
1287 abort_req->end_io_data = NULL;
1288 blk_execute_rq_nowait(abort_req->q, NULL, abort_req, 0, abort_endio);
c30341dc 1289
31c7c7d2
CH
1290 /*
1291 * The aborted req will be completed on receiving the abort req.
1292 * We enable the timer again. If hit twice, it'll cause a device reset,
1293 * as the device then is in a faulty state.
1294 */
1295 return BLK_EH_RESET_TIMER;
c30341dc
KB
1296}
1297
a4aea562
MB
1298static void nvme_free_queue(struct nvme_queue *nvmeq)
1299{
9e866774
MW
1300 dma_free_coherent(nvmeq->q_dmadev, CQ_SIZE(nvmeq->q_depth),
1301 (void *)nvmeq->cqes, nvmeq->cq_dma_addr);
8ffaadf7
JD
1302 if (nvmeq->sq_cmds)
1303 dma_free_coherent(nvmeq->q_dmadev, SQ_SIZE(nvmeq->q_depth),
9e866774
MW
1304 nvmeq->sq_cmds, nvmeq->sq_dma_addr);
1305 kfree(nvmeq);
1306}
1307
a1a5ef99 1308static void nvme_free_queues(struct nvme_dev *dev, int lowest)
22404274
KB
1309{
1310 int i;
1311
d858e5f0 1312 for (i = dev->ctrl.queue_count - 1; i >= lowest; i--) {
a4aea562 1313 struct nvme_queue *nvmeq = dev->queues[i];
d858e5f0 1314 dev->ctrl.queue_count--;
a4aea562 1315 dev->queues[i] = NULL;
f435c282 1316 nvme_free_queue(nvmeq);
121c7ad4 1317 }
22404274
KB
1318}
1319
4d115420
KB
1320/**
1321 * nvme_suspend_queue - put queue into suspended state
1322 * @nvmeq - queue to suspend
4d115420
KB
1323 */
1324static int nvme_suspend_queue(struct nvme_queue *nvmeq)
b60503ba 1325{
2b25d981 1326 int vector;
b60503ba 1327
a09115b2 1328 spin_lock_irq(&nvmeq->q_lock);
2b25d981
KB
1329 if (nvmeq->cq_vector == -1) {
1330 spin_unlock_irq(&nvmeq->q_lock);
1331 return 1;
1332 }
0ff199cb 1333 vector = nvmeq->cq_vector;
42f61420 1334 nvmeq->dev->online_queues--;
2b25d981 1335 nvmeq->cq_vector = -1;
a09115b2
MW
1336 spin_unlock_irq(&nvmeq->q_lock);
1337
1c63dc66 1338 if (!nvmeq->qid && nvmeq->dev->ctrl.admin_q)
c81545f9 1339 blk_mq_quiesce_queue(nvmeq->dev->ctrl.admin_q);
6df3dbc8 1340
0ff199cb 1341 pci_free_irq(to_pci_dev(nvmeq->dev->dev), vector, nvmeq);
b60503ba 1342
4d115420
KB
1343 return 0;
1344}
b60503ba 1345
a5cdb68c 1346static void nvme_disable_admin_queue(struct nvme_dev *dev, bool shutdown)
4d115420 1347{
a5cdb68c 1348 struct nvme_queue *nvmeq = dev->queues[0];
4d115420
KB
1349
1350 if (!nvmeq)
1351 return;
1352 if (nvme_suspend_queue(nvmeq))
1353 return;
1354
a5cdb68c
KB
1355 if (shutdown)
1356 nvme_shutdown_ctrl(&dev->ctrl);
1357 else
20d0dfe6 1358 nvme_disable_ctrl(&dev->ctrl, dev->ctrl.cap);
07836e65
KB
1359
1360 spin_lock_irq(&nvmeq->q_lock);
1361 nvme_process_cq(nvmeq);
1362 spin_unlock_irq(&nvmeq->q_lock);
b60503ba
MW
1363}
1364
8ffaadf7
JD
1365static int nvme_cmb_qdepth(struct nvme_dev *dev, int nr_io_queues,
1366 int entry_size)
1367{
1368 int q_depth = dev->q_depth;
5fd4ce1b
CH
1369 unsigned q_size_aligned = roundup(q_depth * entry_size,
1370 dev->ctrl.page_size);
8ffaadf7
JD
1371
1372 if (q_size_aligned * nr_io_queues > dev->cmb_size) {
c45f5c99 1373 u64 mem_per_q = div_u64(dev->cmb_size, nr_io_queues);
5fd4ce1b 1374 mem_per_q = round_down(mem_per_q, dev->ctrl.page_size);
c45f5c99 1375 q_depth = div_u64(mem_per_q, entry_size);
8ffaadf7
JD
1376
1377 /*
1378 * Ensure the reduced q_depth is above some threshold where it
1379 * would be better to map queues in system memory with the
1380 * original depth
1381 */
1382 if (q_depth < 64)
1383 return -ENOMEM;
1384 }
1385
1386 return q_depth;
1387}
1388
1389static int nvme_alloc_sq_cmds(struct nvme_dev *dev, struct nvme_queue *nvmeq,
1390 int qid, int depth)
1391{
57fff717
KB
1392
1393 /* CMB SQEs will be mapped before creation */
1394 if (qid && dev->cmb && use_cmb_sqes && NVME_CMB_SQS(dev->cmbsz))
1395 return 0;
1396
1397 nvmeq->sq_cmds = dma_alloc_coherent(dev->dev, SQ_SIZE(depth),
1398 &nvmeq->sq_dma_addr, GFP_KERNEL);
1399 if (!nvmeq->sq_cmds)
1400 return -ENOMEM;
8ffaadf7
JD
1401
1402 return 0;
1403}
1404
b60503ba 1405static struct nvme_queue *nvme_alloc_queue(struct nvme_dev *dev, int qid,
d3af3ecd 1406 int depth, int node)
b60503ba 1407{
d3af3ecd
SL
1408 struct nvme_queue *nvmeq = kzalloc_node(sizeof(*nvmeq), GFP_KERNEL,
1409 node);
b60503ba
MW
1410 if (!nvmeq)
1411 return NULL;
1412
e75ec752 1413 nvmeq->cqes = dma_zalloc_coherent(dev->dev, CQ_SIZE(depth),
4d51abf9 1414 &nvmeq->cq_dma_addr, GFP_KERNEL);
b60503ba
MW
1415 if (!nvmeq->cqes)
1416 goto free_nvmeq;
b60503ba 1417
8ffaadf7 1418 if (nvme_alloc_sq_cmds(dev, nvmeq, qid, depth))
b60503ba
MW
1419 goto free_cqdma;
1420
e75ec752 1421 nvmeq->q_dmadev = dev->dev;
091b6092 1422 nvmeq->dev = dev;
b60503ba
MW
1423 spin_lock_init(&nvmeq->q_lock);
1424 nvmeq->cq_head = 0;
82123460 1425 nvmeq->cq_phase = 1;
b80d5ccc 1426 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
b60503ba 1427 nvmeq->q_depth = depth;
c30341dc 1428 nvmeq->qid = qid;
758dd7fd 1429 nvmeq->cq_vector = -1;
a4aea562 1430 dev->queues[qid] = nvmeq;
d858e5f0 1431 dev->ctrl.queue_count++;
36a7e993 1432
b60503ba
MW
1433 return nvmeq;
1434
1435 free_cqdma:
e75ec752 1436 dma_free_coherent(dev->dev, CQ_SIZE(depth), (void *)nvmeq->cqes,
b60503ba
MW
1437 nvmeq->cq_dma_addr);
1438 free_nvmeq:
1439 kfree(nvmeq);
1440 return NULL;
1441}
1442
dca51e78 1443static int queue_request_irq(struct nvme_queue *nvmeq)
3001082c 1444{
0ff199cb
CH
1445 struct pci_dev *pdev = to_pci_dev(nvmeq->dev->dev);
1446 int nr = nvmeq->dev->ctrl.instance;
1447
1448 if (use_threaded_interrupts) {
1449 return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq_check,
1450 nvme_irq, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
1451 } else {
1452 return pci_request_irq(pdev, nvmeq->cq_vector, nvme_irq,
1453 NULL, nvmeq, "nvme%dq%d", nr, nvmeq->qid);
1454 }
3001082c
MW
1455}
1456
22404274 1457static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid)
b60503ba 1458{
22404274 1459 struct nvme_dev *dev = nvmeq->dev;
b60503ba 1460
7be50e93 1461 spin_lock_irq(&nvmeq->q_lock);
22404274
KB
1462 nvmeq->sq_tail = 0;
1463 nvmeq->cq_head = 0;
1464 nvmeq->cq_phase = 1;
b80d5ccc 1465 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
22404274 1466 memset((void *)nvmeq->cqes, 0, CQ_SIZE(nvmeq->q_depth));
f9f38e33 1467 nvme_dbbuf_init(dev, nvmeq, qid);
42f61420 1468 dev->online_queues++;
7be50e93 1469 spin_unlock_irq(&nvmeq->q_lock);
22404274
KB
1470}
1471
1472static int nvme_create_queue(struct nvme_queue *nvmeq, int qid)
1473{
1474 struct nvme_dev *dev = nvmeq->dev;
1475 int result;
3f85d50b 1476
57fff717
KB
1477 if (qid && dev->cmb && use_cmb_sqes && NVME_CMB_SQS(dev->cmbsz)) {
1478 unsigned offset = (qid - 1) * roundup(SQ_SIZE(nvmeq->q_depth),
1479 dev->ctrl.page_size);
1480 nvmeq->sq_dma_addr = dev->cmb_bus_addr + offset;
1481 nvmeq->sq_cmds_io = dev->cmb + offset;
1482 }
1483
2b25d981 1484 nvmeq->cq_vector = qid - 1;
b60503ba
MW
1485 result = adapter_alloc_cq(dev, qid, nvmeq);
1486 if (result < 0)
8c410b9f 1487 goto release_vector;
b60503ba
MW
1488
1489 result = adapter_alloc_sq(dev, qid, nvmeq);
1490 if (result < 0)
1491 goto release_cq;
1492
161b8be2 1493 nvme_init_queue(nvmeq, qid);
dca51e78 1494 result = queue_request_irq(nvmeq);
b60503ba
MW
1495 if (result < 0)
1496 goto release_sq;
1497
22404274 1498 return result;
b60503ba
MW
1499
1500 release_sq:
8c410b9f 1501 dev->online_queues--;
b60503ba
MW
1502 adapter_delete_sq(dev, qid);
1503 release_cq:
1504 adapter_delete_cq(dev, qid);
8c410b9f
JW
1505 release_vector:
1506 nvmeq->cq_vector = -1;
22404274 1507 return result;
b60503ba
MW
1508}
1509
f363b089 1510static const struct blk_mq_ops nvme_mq_admin_ops = {
d29ec824 1511 .queue_rq = nvme_queue_rq,
77f02a7a 1512 .complete = nvme_pci_complete_rq,
a4aea562 1513 .init_hctx = nvme_admin_init_hctx,
4af0e21c 1514 .exit_hctx = nvme_admin_exit_hctx,
0350815a 1515 .init_request = nvme_init_request,
a4aea562
MB
1516 .timeout = nvme_timeout,
1517};
1518
f363b089 1519static const struct blk_mq_ops nvme_mq_ops = {
a4aea562 1520 .queue_rq = nvme_queue_rq,
77f02a7a 1521 .complete = nvme_pci_complete_rq,
a4aea562
MB
1522 .init_hctx = nvme_init_hctx,
1523 .init_request = nvme_init_request,
dca51e78 1524 .map_queues = nvme_pci_map_queues,
a4aea562 1525 .timeout = nvme_timeout,
a0fa9647 1526 .poll = nvme_poll,
a4aea562
MB
1527};
1528
ea191d2f
KB
1529static void nvme_dev_remove_admin(struct nvme_dev *dev)
1530{
1c63dc66 1531 if (dev->ctrl.admin_q && !blk_queue_dying(dev->ctrl.admin_q)) {
69d9a99c
KB
1532 /*
1533 * If the controller was reset during removal, it's possible
1534 * user requests may be waiting on a stopped queue. Start the
1535 * queue to flush these to completion.
1536 */
c81545f9 1537 blk_mq_unquiesce_queue(dev->ctrl.admin_q);
1c63dc66 1538 blk_cleanup_queue(dev->ctrl.admin_q);
ea191d2f
KB
1539 blk_mq_free_tag_set(&dev->admin_tagset);
1540 }
1541}
1542
a4aea562
MB
1543static int nvme_alloc_admin_tags(struct nvme_dev *dev)
1544{
1c63dc66 1545 if (!dev->ctrl.admin_q) {
a4aea562
MB
1546 dev->admin_tagset.ops = &nvme_mq_admin_ops;
1547 dev->admin_tagset.nr_hw_queues = 1;
e3e9d50c 1548
38dabe21 1549 dev->admin_tagset.queue_depth = NVME_AQ_MQ_TAG_DEPTH;
a4aea562 1550 dev->admin_tagset.timeout = ADMIN_TIMEOUT;
e75ec752 1551 dev->admin_tagset.numa_node = dev_to_node(dev->dev);
a7a7cbe3 1552 dev->admin_tagset.cmd_size = nvme_pci_cmd_size(dev, false);
d3484991 1553 dev->admin_tagset.flags = BLK_MQ_F_NO_SCHED;
a4aea562
MB
1554 dev->admin_tagset.driver_data = dev;
1555
1556 if (blk_mq_alloc_tag_set(&dev->admin_tagset))
1557 return -ENOMEM;
34b6c231 1558 dev->ctrl.admin_tagset = &dev->admin_tagset;
a4aea562 1559
1c63dc66
CH
1560 dev->ctrl.admin_q = blk_mq_init_queue(&dev->admin_tagset);
1561 if (IS_ERR(dev->ctrl.admin_q)) {
a4aea562
MB
1562 blk_mq_free_tag_set(&dev->admin_tagset);
1563 return -ENOMEM;
1564 }
1c63dc66 1565 if (!blk_get_queue(dev->ctrl.admin_q)) {
ea191d2f 1566 nvme_dev_remove_admin(dev);
1c63dc66 1567 dev->ctrl.admin_q = NULL;
ea191d2f
KB
1568 return -ENODEV;
1569 }
0fb59cbc 1570 } else
c81545f9 1571 blk_mq_unquiesce_queue(dev->ctrl.admin_q);
a4aea562
MB
1572
1573 return 0;
1574}
1575
97f6ef64
XY
1576static unsigned long db_bar_size(struct nvme_dev *dev, unsigned nr_io_queues)
1577{
1578 return NVME_REG_DBS + ((nr_io_queues + 1) * 8 * dev->db_stride);
1579}
1580
1581static int nvme_remap_bar(struct nvme_dev *dev, unsigned long size)
1582{
1583 struct pci_dev *pdev = to_pci_dev(dev->dev);
1584
1585 if (size <= dev->bar_mapped_size)
1586 return 0;
1587 if (size > pci_resource_len(pdev, 0))
1588 return -ENOMEM;
1589 if (dev->bar)
1590 iounmap(dev->bar);
1591 dev->bar = ioremap(pci_resource_start(pdev, 0), size);
1592 if (!dev->bar) {
1593 dev->bar_mapped_size = 0;
1594 return -ENOMEM;
1595 }
1596 dev->bar_mapped_size = size;
1597 dev->dbs = dev->bar + NVME_REG_DBS;
1598
1599 return 0;
1600}
1601
01ad0990 1602static int nvme_pci_configure_admin_queue(struct nvme_dev *dev)
b60503ba 1603{
ba47e386 1604 int result;
b60503ba
MW
1605 u32 aqa;
1606 struct nvme_queue *nvmeq;
1607
97f6ef64
XY
1608 result = nvme_remap_bar(dev, db_bar_size(dev, 0));
1609 if (result < 0)
1610 return result;
1611
8ef2074d 1612 dev->subsystem = readl(dev->bar + NVME_REG_VS) >= NVME_VS(1, 1, 0) ?
20d0dfe6 1613 NVME_CAP_NSSRC(dev->ctrl.cap) : 0;
dfbac8c7 1614
7a67cbea
CH
1615 if (dev->subsystem &&
1616 (readl(dev->bar + NVME_REG_CSTS) & NVME_CSTS_NSSRO))
1617 writel(NVME_CSTS_NSSRO, dev->bar + NVME_REG_CSTS);
dfbac8c7 1618
20d0dfe6 1619 result = nvme_disable_ctrl(&dev->ctrl, dev->ctrl.cap);
ba47e386
MW
1620 if (result < 0)
1621 return result;
b60503ba 1622
a4aea562 1623 nvmeq = dev->queues[0];
cd638946 1624 if (!nvmeq) {
d3af3ecd
SL
1625 nvmeq = nvme_alloc_queue(dev, 0, NVME_AQ_DEPTH,
1626 dev_to_node(dev->dev));
cd638946
KB
1627 if (!nvmeq)
1628 return -ENOMEM;
cd638946 1629 }
b60503ba
MW
1630
1631 aqa = nvmeq->q_depth - 1;
1632 aqa |= aqa << 16;
1633
7a67cbea
CH
1634 writel(aqa, dev->bar + NVME_REG_AQA);
1635 lo_hi_writeq(nvmeq->sq_dma_addr, dev->bar + NVME_REG_ASQ);
1636 lo_hi_writeq(nvmeq->cq_dma_addr, dev->bar + NVME_REG_ACQ);
b60503ba 1637
20d0dfe6 1638 result = nvme_enable_ctrl(&dev->ctrl, dev->ctrl.cap);
025c557a 1639 if (result)
d4875622 1640 return result;
a4aea562 1641
2b25d981 1642 nvmeq->cq_vector = 0;
161b8be2 1643 nvme_init_queue(nvmeq, 0);
dca51e78 1644 result = queue_request_irq(nvmeq);
758dd7fd
JD
1645 if (result) {
1646 nvmeq->cq_vector = -1;
d4875622 1647 return result;
758dd7fd 1648 }
025c557a 1649
b60503ba
MW
1650 return result;
1651}
1652
749941f2 1653static int nvme_create_io_queues(struct nvme_dev *dev)
42f61420 1654{
949928c1 1655 unsigned i, max;
749941f2 1656 int ret = 0;
42f61420 1657
d858e5f0 1658 for (i = dev->ctrl.queue_count; i <= dev->max_qid; i++) {
d3af3ecd
SL
1659 /* vector == qid - 1, match nvme_create_queue */
1660 if (!nvme_alloc_queue(dev, i, dev->q_depth,
1661 pci_irq_get_node(to_pci_dev(dev->dev), i - 1))) {
749941f2 1662 ret = -ENOMEM;
42f61420 1663 break;
749941f2
CH
1664 }
1665 }
42f61420 1666
d858e5f0 1667 max = min(dev->max_qid, dev->ctrl.queue_count - 1);
949928c1 1668 for (i = dev->online_queues; i <= max; i++) {
749941f2 1669 ret = nvme_create_queue(dev->queues[i], i);
d4875622 1670 if (ret)
42f61420 1671 break;
27e8166c 1672 }
749941f2
CH
1673
1674 /*
1675 * Ignore failing Create SQ/CQ commands, we can continue with less
1676 * than the desired aount of queues, and even a controller without
1677 * I/O queues an still be used to issue admin commands. This might
1678 * be useful to upgrade a buggy firmware for example.
1679 */
1680 return ret >= 0 ? 0 : ret;
b60503ba
MW
1681}
1682
202021c1
SB
1683static ssize_t nvme_cmb_show(struct device *dev,
1684 struct device_attribute *attr,
1685 char *buf)
1686{
1687 struct nvme_dev *ndev = to_nvme_dev(dev_get_drvdata(dev));
1688
c965809c 1689 return scnprintf(buf, PAGE_SIZE, "cmbloc : x%08x\ncmbsz : x%08x\n",
202021c1
SB
1690 ndev->cmbloc, ndev->cmbsz);
1691}
1692static DEVICE_ATTR(cmb, S_IRUGO, nvme_cmb_show, NULL);
1693
8ffaadf7
JD
1694static void __iomem *nvme_map_cmb(struct nvme_dev *dev)
1695{
1696 u64 szu, size, offset;
8ffaadf7
JD
1697 resource_size_t bar_size;
1698 struct pci_dev *pdev = to_pci_dev(dev->dev);
1699 void __iomem *cmb;
8969f1f8 1700 int bar;
8ffaadf7 1701
7a67cbea 1702 dev->cmbsz = readl(dev->bar + NVME_REG_CMBSZ);
8ffaadf7
JD
1703 if (!(NVME_CMB_SZ(dev->cmbsz)))
1704 return NULL;
202021c1 1705 dev->cmbloc = readl(dev->bar + NVME_REG_CMBLOC);
8ffaadf7 1706
202021c1
SB
1707 if (!use_cmb_sqes)
1708 return NULL;
8ffaadf7
JD
1709
1710 szu = (u64)1 << (12 + 4 * NVME_CMB_SZU(dev->cmbsz));
1711 size = szu * NVME_CMB_SZ(dev->cmbsz);
202021c1 1712 offset = szu * NVME_CMB_OFST(dev->cmbloc);
8969f1f8
CH
1713 bar = NVME_CMB_BIR(dev->cmbloc);
1714 bar_size = pci_resource_len(pdev, bar);
8ffaadf7
JD
1715
1716 if (offset > bar_size)
1717 return NULL;
1718
1719 /*
1720 * Controllers may support a CMB size larger than their BAR,
1721 * for example, due to being behind a bridge. Reduce the CMB to
1722 * the reported size of the BAR
1723 */
1724 if (size > bar_size - offset)
1725 size = bar_size - offset;
1726
8969f1f8 1727 cmb = ioremap_wc(pci_resource_start(pdev, bar) + offset, size);
8ffaadf7
JD
1728 if (!cmb)
1729 return NULL;
1730
8969f1f8 1731 dev->cmb_bus_addr = pci_bus_address(pdev, bar) + offset;
8ffaadf7
JD
1732 dev->cmb_size = size;
1733 return cmb;
1734}
1735
1736static inline void nvme_release_cmb(struct nvme_dev *dev)
1737{
1738 if (dev->cmb) {
1739 iounmap(dev->cmb);
1740 dev->cmb = NULL;
1c78f773
MG
1741 sysfs_remove_file_from_group(&dev->ctrl.device->kobj,
1742 &dev_attr_cmb.attr, NULL);
1743 dev->cmbsz = 0;
8ffaadf7
JD
1744 }
1745}
1746
87ad72a5
CH
1747static int nvme_set_host_mem(struct nvme_dev *dev, u32 bits)
1748{
4033f35d 1749 u64 dma_addr = dev->host_mem_descs_dma;
87ad72a5 1750 struct nvme_command c;
87ad72a5
CH
1751 int ret;
1752
87ad72a5
CH
1753 memset(&c, 0, sizeof(c));
1754 c.features.opcode = nvme_admin_set_features;
1755 c.features.fid = cpu_to_le32(NVME_FEAT_HOST_MEM_BUF);
1756 c.features.dword11 = cpu_to_le32(bits);
1757 c.features.dword12 = cpu_to_le32(dev->host_mem_size >>
1758 ilog2(dev->ctrl.page_size));
1759 c.features.dword13 = cpu_to_le32(lower_32_bits(dma_addr));
1760 c.features.dword14 = cpu_to_le32(upper_32_bits(dma_addr));
1761 c.features.dword15 = cpu_to_le32(dev->nr_host_mem_descs);
1762
1763 ret = nvme_submit_sync_cmd(dev->ctrl.admin_q, &c, NULL, 0);
1764 if (ret) {
1765 dev_warn(dev->ctrl.device,
1766 "failed to set host mem (err %d, flags %#x).\n",
1767 ret, bits);
1768 }
87ad72a5
CH
1769 return ret;
1770}
1771
1772static void nvme_free_host_mem(struct nvme_dev *dev)
1773{
1774 int i;
1775
1776 for (i = 0; i < dev->nr_host_mem_descs; i++) {
1777 struct nvme_host_mem_buf_desc *desc = &dev->host_mem_descs[i];
1778 size_t size = le32_to_cpu(desc->size) * dev->ctrl.page_size;
1779
1780 dma_free_coherent(dev->dev, size, dev->host_mem_desc_bufs[i],
1781 le64_to_cpu(desc->addr));
1782 }
1783
1784 kfree(dev->host_mem_desc_bufs);
1785 dev->host_mem_desc_bufs = NULL;
4033f35d
CH
1786 dma_free_coherent(dev->dev,
1787 dev->nr_host_mem_descs * sizeof(*dev->host_mem_descs),
1788 dev->host_mem_descs, dev->host_mem_descs_dma);
87ad72a5 1789 dev->host_mem_descs = NULL;
7e5dd57e 1790 dev->nr_host_mem_descs = 0;
87ad72a5
CH
1791}
1792
92dc6895
CH
1793static int __nvme_alloc_host_mem(struct nvme_dev *dev, u64 preferred,
1794 u32 chunk_size)
9d713c2b 1795{
87ad72a5 1796 struct nvme_host_mem_buf_desc *descs;
92dc6895 1797 u32 max_entries, len;
4033f35d 1798 dma_addr_t descs_dma;
2ee0e4ed 1799 int i = 0;
87ad72a5 1800 void **bufs;
2ee0e4ed 1801 u64 size = 0, tmp;
87ad72a5 1802
87ad72a5
CH
1803 tmp = (preferred + chunk_size - 1);
1804 do_div(tmp, chunk_size);
1805 max_entries = tmp;
044a9df1
CH
1806
1807 if (dev->ctrl.hmmaxd && dev->ctrl.hmmaxd < max_entries)
1808 max_entries = dev->ctrl.hmmaxd;
1809
4033f35d
CH
1810 descs = dma_zalloc_coherent(dev->dev, max_entries * sizeof(*descs),
1811 &descs_dma, GFP_KERNEL);
87ad72a5
CH
1812 if (!descs)
1813 goto out;
1814
1815 bufs = kcalloc(max_entries, sizeof(*bufs), GFP_KERNEL);
1816 if (!bufs)
1817 goto out_free_descs;
1818
244a8fe4 1819 for (size = 0; size < preferred && i < max_entries; size += len) {
87ad72a5
CH
1820 dma_addr_t dma_addr;
1821
50cdb7c6 1822 len = min_t(u64, chunk_size, preferred - size);
87ad72a5
CH
1823 bufs[i] = dma_alloc_attrs(dev->dev, len, &dma_addr, GFP_KERNEL,
1824 DMA_ATTR_NO_KERNEL_MAPPING | DMA_ATTR_NO_WARN);
1825 if (!bufs[i])
1826 break;
1827
1828 descs[i].addr = cpu_to_le64(dma_addr);
1829 descs[i].size = cpu_to_le32(len / dev->ctrl.page_size);
1830 i++;
1831 }
1832
92dc6895 1833 if (!size)
87ad72a5 1834 goto out_free_bufs;
87ad72a5 1835
87ad72a5
CH
1836 dev->nr_host_mem_descs = i;
1837 dev->host_mem_size = size;
1838 dev->host_mem_descs = descs;
4033f35d 1839 dev->host_mem_descs_dma = descs_dma;
87ad72a5
CH
1840 dev->host_mem_desc_bufs = bufs;
1841 return 0;
1842
1843out_free_bufs:
1844 while (--i >= 0) {
1845 size_t size = le32_to_cpu(descs[i].size) * dev->ctrl.page_size;
1846
1847 dma_free_coherent(dev->dev, size, bufs[i],
1848 le64_to_cpu(descs[i].addr));
1849 }
1850
1851 kfree(bufs);
1852out_free_descs:
4033f35d
CH
1853 dma_free_coherent(dev->dev, max_entries * sizeof(*descs), descs,
1854 descs_dma);
87ad72a5 1855out:
87ad72a5
CH
1856 dev->host_mem_descs = NULL;
1857 return -ENOMEM;
1858}
1859
92dc6895
CH
1860static int nvme_alloc_host_mem(struct nvme_dev *dev, u64 min, u64 preferred)
1861{
1862 u32 chunk_size;
1863
1864 /* start big and work our way down */
30f92d62 1865 for (chunk_size = min_t(u64, preferred, PAGE_SIZE * MAX_ORDER_NR_PAGES);
044a9df1 1866 chunk_size >= max_t(u32, dev->ctrl.hmminds * 4096, PAGE_SIZE * 2);
92dc6895
CH
1867 chunk_size /= 2) {
1868 if (!__nvme_alloc_host_mem(dev, preferred, chunk_size)) {
1869 if (!min || dev->host_mem_size >= min)
1870 return 0;
1871 nvme_free_host_mem(dev);
1872 }
1873 }
1874
1875 return -ENOMEM;
1876}
1877
9620cfba 1878static int nvme_setup_host_mem(struct nvme_dev *dev)
87ad72a5
CH
1879{
1880 u64 max = (u64)max_host_mem_size_mb * SZ_1M;
1881 u64 preferred = (u64)dev->ctrl.hmpre * 4096;
1882 u64 min = (u64)dev->ctrl.hmmin * 4096;
1883 u32 enable_bits = NVME_HOST_MEM_ENABLE;
9620cfba 1884 int ret = 0;
87ad72a5
CH
1885
1886 preferred = min(preferred, max);
1887 if (min > max) {
1888 dev_warn(dev->ctrl.device,
1889 "min host memory (%lld MiB) above limit (%d MiB).\n",
1890 min >> ilog2(SZ_1M), max_host_mem_size_mb);
1891 nvme_free_host_mem(dev);
9620cfba 1892 return 0;
87ad72a5
CH
1893 }
1894
1895 /*
1896 * If we already have a buffer allocated check if we can reuse it.
1897 */
1898 if (dev->host_mem_descs) {
1899 if (dev->host_mem_size >= min)
1900 enable_bits |= NVME_HOST_MEM_RETURN;
1901 else
1902 nvme_free_host_mem(dev);
1903 }
1904
1905 if (!dev->host_mem_descs) {
92dc6895
CH
1906 if (nvme_alloc_host_mem(dev, min, preferred)) {
1907 dev_warn(dev->ctrl.device,
1908 "failed to allocate host memory buffer.\n");
9620cfba 1909 return 0; /* controller must work without HMB */
92dc6895
CH
1910 }
1911
1912 dev_info(dev->ctrl.device,
1913 "allocated %lld MiB host memory buffer.\n",
1914 dev->host_mem_size >> ilog2(SZ_1M));
87ad72a5
CH
1915 }
1916
9620cfba
CH
1917 ret = nvme_set_host_mem(dev, enable_bits);
1918 if (ret)
87ad72a5 1919 nvme_free_host_mem(dev);
9620cfba 1920 return ret;
9d713c2b
KB
1921}
1922
8d85fce7 1923static int nvme_setup_io_queues(struct nvme_dev *dev)
b60503ba 1924{
a4aea562 1925 struct nvme_queue *adminq = dev->queues[0];
e75ec752 1926 struct pci_dev *pdev = to_pci_dev(dev->dev);
97f6ef64
XY
1927 int result, nr_io_queues;
1928 unsigned long size;
b60503ba 1929
77aa379d 1930 nr_io_queues = num_possible_cpus();
9a0be7ab
CH
1931 result = nvme_set_queue_count(&dev->ctrl, &nr_io_queues);
1932 if (result < 0)
1b23484b 1933 return result;
9a0be7ab 1934
f5fa90dc 1935 if (nr_io_queues == 0)
a5229050 1936 return 0;
b60503ba 1937
8ffaadf7
JD
1938 if (dev->cmb && NVME_CMB_SQS(dev->cmbsz)) {
1939 result = nvme_cmb_qdepth(dev, nr_io_queues,
1940 sizeof(struct nvme_command));
1941 if (result > 0)
1942 dev->q_depth = result;
1943 else
1944 nvme_release_cmb(dev);
1945 }
1946
97f6ef64
XY
1947 do {
1948 size = db_bar_size(dev, nr_io_queues);
1949 result = nvme_remap_bar(dev, size);
1950 if (!result)
1951 break;
1952 if (!--nr_io_queues)
1953 return -ENOMEM;
1954 } while (1);
1955 adminq->q_db = dev->dbs;
f1938f6e 1956
9d713c2b 1957 /* Deregister the admin queue's interrupt */
0ff199cb 1958 pci_free_irq(pdev, 0, adminq);
9d713c2b 1959
e32efbfc
JA
1960 /*
1961 * If we enable msix early due to not intx, disable it again before
1962 * setting up the full range we need.
1963 */
dca51e78
CH
1964 pci_free_irq_vectors(pdev);
1965 nr_io_queues = pci_alloc_irq_vectors(pdev, 1, nr_io_queues,
1966 PCI_IRQ_ALL_TYPES | PCI_IRQ_AFFINITY);
1967 if (nr_io_queues <= 0)
1968 return -EIO;
1969 dev->max_qid = nr_io_queues;
fa08a396 1970
063a8096
MW
1971 /*
1972 * Should investigate if there's a performance win from allocating
1973 * more queues than interrupt vectors; it might allow the submission
1974 * path to scale better, even if the receive path is limited by the
1975 * number of interrupts.
1976 */
063a8096 1977
dca51e78 1978 result = queue_request_irq(adminq);
758dd7fd
JD
1979 if (result) {
1980 adminq->cq_vector = -1;
d4875622 1981 return result;
758dd7fd 1982 }
749941f2 1983 return nvme_create_io_queues(dev);
b60503ba
MW
1984}
1985
2a842aca 1986static void nvme_del_queue_end(struct request *req, blk_status_t error)
a5768aa8 1987{
db3cbfff 1988 struct nvme_queue *nvmeq = req->end_io_data;
b5875222 1989
db3cbfff
KB
1990 blk_mq_free_request(req);
1991 complete(&nvmeq->dev->ioq_wait);
a5768aa8
KB
1992}
1993
2a842aca 1994static void nvme_del_cq_end(struct request *req, blk_status_t error)
a5768aa8 1995{
db3cbfff 1996 struct nvme_queue *nvmeq = req->end_io_data;
a5768aa8 1997
db3cbfff
KB
1998 if (!error) {
1999 unsigned long flags;
2000
2e39e0f6
ML
2001 /*
2002 * We might be called with the AQ q_lock held
2003 * and the I/O queue q_lock should always
2004 * nest inside the AQ one.
2005 */
2006 spin_lock_irqsave_nested(&nvmeq->q_lock, flags,
2007 SINGLE_DEPTH_NESTING);
db3cbfff
KB
2008 nvme_process_cq(nvmeq);
2009 spin_unlock_irqrestore(&nvmeq->q_lock, flags);
a5768aa8 2010 }
db3cbfff
KB
2011
2012 nvme_del_queue_end(req, error);
a5768aa8
KB
2013}
2014
db3cbfff 2015static int nvme_delete_queue(struct nvme_queue *nvmeq, u8 opcode)
bda4e0fb 2016{
db3cbfff
KB
2017 struct request_queue *q = nvmeq->dev->ctrl.admin_q;
2018 struct request *req;
2019 struct nvme_command cmd;
bda4e0fb 2020
db3cbfff
KB
2021 memset(&cmd, 0, sizeof(cmd));
2022 cmd.delete_queue.opcode = opcode;
2023 cmd.delete_queue.qid = cpu_to_le16(nvmeq->qid);
bda4e0fb 2024
eb71f435 2025 req = nvme_alloc_request(q, &cmd, BLK_MQ_REQ_NOWAIT, NVME_QID_ANY);
db3cbfff
KB
2026 if (IS_ERR(req))
2027 return PTR_ERR(req);
bda4e0fb 2028
db3cbfff
KB
2029 req->timeout = ADMIN_TIMEOUT;
2030 req->end_io_data = nvmeq;
2031
2032 blk_execute_rq_nowait(q, NULL, req, false,
2033 opcode == nvme_admin_delete_cq ?
2034 nvme_del_cq_end : nvme_del_queue_end);
2035 return 0;
bda4e0fb
KB
2036}
2037
70659060 2038static void nvme_disable_io_queues(struct nvme_dev *dev, int queues)
a5768aa8 2039{
70659060 2040 int pass;
db3cbfff
KB
2041 unsigned long timeout;
2042 u8 opcode = nvme_admin_delete_sq;
a5768aa8 2043
db3cbfff 2044 for (pass = 0; pass < 2; pass++) {
014a0d60 2045 int sent = 0, i = queues;
db3cbfff
KB
2046
2047 reinit_completion(&dev->ioq_wait);
2048 retry:
2049 timeout = ADMIN_TIMEOUT;
c21377f8
GKB
2050 for (; i > 0; i--, sent++)
2051 if (nvme_delete_queue(dev->queues[i], opcode))
db3cbfff 2052 break;
c21377f8 2053
db3cbfff
KB
2054 while (sent--) {
2055 timeout = wait_for_completion_io_timeout(&dev->ioq_wait, timeout);
2056 if (timeout == 0)
2057 return;
2058 if (i)
2059 goto retry;
2060 }
2061 opcode = nvme_admin_delete_cq;
2062 }
a5768aa8
KB
2063}
2064
422ef0c7
MW
2065/*
2066 * Return: error value if an error occurred setting up the queues or calling
2067 * Identify Device. 0 if these succeeded, even if adding some of the
2068 * namespaces failed. At the moment, these failures are silent. TBD which
2069 * failures should be reported.
2070 */
8d85fce7 2071static int nvme_dev_add(struct nvme_dev *dev)
b60503ba 2072{
5bae7f73 2073 if (!dev->ctrl.tagset) {
ffe7704d
KB
2074 dev->tagset.ops = &nvme_mq_ops;
2075 dev->tagset.nr_hw_queues = dev->online_queues - 1;
2076 dev->tagset.timeout = NVME_IO_TIMEOUT;
2077 dev->tagset.numa_node = dev_to_node(dev->dev);
2078 dev->tagset.queue_depth =
a4aea562 2079 min_t(int, dev->q_depth, BLK_MQ_MAX_DEPTH) - 1;
a7a7cbe3
CK
2080 dev->tagset.cmd_size = nvme_pci_cmd_size(dev, false);
2081 if ((dev->ctrl.sgls & ((1 << 0) | (1 << 1))) && sgl_threshold) {
2082 dev->tagset.cmd_size = max(dev->tagset.cmd_size,
2083 nvme_pci_cmd_size(dev, true));
2084 }
ffe7704d
KB
2085 dev->tagset.flags = BLK_MQ_F_SHOULD_MERGE;
2086 dev->tagset.driver_data = dev;
b60503ba 2087
ffe7704d
KB
2088 if (blk_mq_alloc_tag_set(&dev->tagset))
2089 return 0;
5bae7f73 2090 dev->ctrl.tagset = &dev->tagset;
f9f38e33
HK
2091
2092 nvme_dbbuf_set(dev);
949928c1
KB
2093 } else {
2094 blk_mq_update_nr_hw_queues(&dev->tagset, dev->online_queues - 1);
2095
2096 /* Free previously allocated queues that are no longer usable */
2097 nvme_free_queues(dev, dev->online_queues);
ffe7704d 2098 }
949928c1 2099
e1e5e564 2100 return 0;
b60503ba
MW
2101}
2102
b00a726a 2103static int nvme_pci_enable(struct nvme_dev *dev)
0877cb0d 2104{
b00a726a 2105 int result = -ENOMEM;
e75ec752 2106 struct pci_dev *pdev = to_pci_dev(dev->dev);
0877cb0d
KB
2107
2108 if (pci_enable_device_mem(pdev))
2109 return result;
2110
0877cb0d 2111 pci_set_master(pdev);
0877cb0d 2112
e75ec752
CH
2113 if (dma_set_mask_and_coherent(dev->dev, DMA_BIT_MASK(64)) &&
2114 dma_set_mask_and_coherent(dev->dev, DMA_BIT_MASK(32)))
052d0efa 2115 goto disable;
0877cb0d 2116
7a67cbea 2117 if (readl(dev->bar + NVME_REG_CSTS) == -1) {
0e53d180 2118 result = -ENODEV;
b00a726a 2119 goto disable;
0e53d180 2120 }
e32efbfc
JA
2121
2122 /*
a5229050
KB
2123 * Some devices and/or platforms don't advertise or work with INTx
2124 * interrupts. Pre-enable a single MSIX or MSI vec for setup. We'll
2125 * adjust this later.
e32efbfc 2126 */
dca51e78
CH
2127 result = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_ALL_TYPES);
2128 if (result < 0)
2129 return result;
e32efbfc 2130
20d0dfe6 2131 dev->ctrl.cap = lo_hi_readq(dev->bar + NVME_REG_CAP);
7a67cbea 2132
20d0dfe6 2133 dev->q_depth = min_t(int, NVME_CAP_MQES(dev->ctrl.cap) + 1,
b27c1e68 2134 io_queue_depth);
20d0dfe6 2135 dev->db_stride = 1 << NVME_CAP_STRIDE(dev->ctrl.cap);
7a67cbea 2136 dev->dbs = dev->bar + 4096;
1f390c1f
SG
2137
2138 /*
2139 * Temporary fix for the Apple controller found in the MacBook8,1 and
2140 * some MacBook7,1 to avoid controller resets and data loss.
2141 */
2142 if (pdev->vendor == PCI_VENDOR_ID_APPLE && pdev->device == 0x2001) {
2143 dev->q_depth = 2;
9bdcfb10
CH
2144 dev_warn(dev->ctrl.device, "detected Apple NVMe controller, "
2145 "set queue depth=%u to work around controller resets\n",
1f390c1f 2146 dev->q_depth);
d554b5e1
MP
2147 } else if (pdev->vendor == PCI_VENDOR_ID_SAMSUNG &&
2148 (pdev->device == 0xa821 || pdev->device == 0xa822) &&
20d0dfe6 2149 NVME_CAP_MQES(dev->ctrl.cap) == 0) {
d554b5e1
MP
2150 dev->q_depth = 64;
2151 dev_err(dev->ctrl.device, "detected PM1725 NVMe controller, "
2152 "set queue depth=%u\n", dev->q_depth);
1f390c1f
SG
2153 }
2154
202021c1
SB
2155 /*
2156 * CMBs can currently only exist on >=1.2 PCIe devices. We only
1c78f773
MG
2157 * populate sysfs if a CMB is implemented. Since nvme_dev_attrs_group
2158 * has no name we can pass NULL as final argument to
2159 * sysfs_add_file_to_group.
202021c1
SB
2160 */
2161
8ef2074d 2162 if (readl(dev->bar + NVME_REG_VS) >= NVME_VS(1, 2, 0)) {
8ffaadf7 2163 dev->cmb = nvme_map_cmb(dev);
1c78f773 2164 if (dev->cmb) {
202021c1
SB
2165 if (sysfs_add_file_to_group(&dev->ctrl.device->kobj,
2166 &dev_attr_cmb.attr, NULL))
9bdcfb10 2167 dev_warn(dev->ctrl.device,
202021c1
SB
2168 "failed to add sysfs attribute for CMB\n");
2169 }
2170 }
2171
a0a3408e
KB
2172 pci_enable_pcie_error_reporting(pdev);
2173 pci_save_state(pdev);
0877cb0d
KB
2174 return 0;
2175
2176 disable:
0877cb0d
KB
2177 pci_disable_device(pdev);
2178 return result;
2179}
2180
2181static void nvme_dev_unmap(struct nvme_dev *dev)
b00a726a
KB
2182{
2183 if (dev->bar)
2184 iounmap(dev->bar);
a1f447b3 2185 pci_release_mem_regions(to_pci_dev(dev->dev));
b00a726a
KB
2186}
2187
2188static void nvme_pci_disable(struct nvme_dev *dev)
0877cb0d 2189{
e75ec752
CH
2190 struct pci_dev *pdev = to_pci_dev(dev->dev);
2191
f63572df 2192 nvme_release_cmb(dev);
dca51e78 2193 pci_free_irq_vectors(pdev);
0877cb0d 2194
a0a3408e
KB
2195 if (pci_is_enabled(pdev)) {
2196 pci_disable_pcie_error_reporting(pdev);
e75ec752 2197 pci_disable_device(pdev);
4d115420 2198 }
4d115420
KB
2199}
2200
a5cdb68c 2201static void nvme_dev_disable(struct nvme_dev *dev, bool shutdown)
b60503ba 2202{
70659060 2203 int i, queues;
302ad8cc
KB
2204 bool dead = true;
2205 struct pci_dev *pdev = to_pci_dev(dev->dev);
22404274 2206
77bf25ea 2207 mutex_lock(&dev->shutdown_lock);
302ad8cc
KB
2208 if (pci_is_enabled(pdev)) {
2209 u32 csts = readl(dev->bar + NVME_REG_CSTS);
2210
ebef7368
KB
2211 if (dev->ctrl.state == NVME_CTRL_LIVE ||
2212 dev->ctrl.state == NVME_CTRL_RESETTING)
302ad8cc
KB
2213 nvme_start_freeze(&dev->ctrl);
2214 dead = !!((csts & NVME_CSTS_CFS) || !(csts & NVME_CSTS_RDY) ||
2215 pdev->error_state != pci_channel_io_normal);
c9d3bf88 2216 }
c21377f8 2217
302ad8cc
KB
2218 /*
2219 * Give the controller a chance to complete all entered requests if
2220 * doing a safe shutdown.
2221 */
87ad72a5
CH
2222 if (!dead) {
2223 if (shutdown)
2224 nvme_wait_freeze_timeout(&dev->ctrl, NVME_IO_TIMEOUT);
2225
2226 /*
2227 * If the controller is still alive tell it to stop using the
2228 * host memory buffer. In theory the shutdown / reset should
2229 * make sure that it doesn't access the host memoery anymore,
2230 * but I'd rather be safe than sorry..
2231 */
2232 if (dev->host_mem_descs)
2233 nvme_set_host_mem(dev, 0);
2234
2235 }
302ad8cc
KB
2236 nvme_stop_queues(&dev->ctrl);
2237
70659060 2238 queues = dev->online_queues - 1;
d858e5f0 2239 for (i = dev->ctrl.queue_count - 1; i > 0; i--)
c21377f8
GKB
2240 nvme_suspend_queue(dev->queues[i]);
2241
302ad8cc 2242 if (dead) {
82469c59
GKB
2243 /* A device might become IO incapable very soon during
2244 * probe, before the admin queue is configured. Thus,
2245 * queue_count can be 0 here.
2246 */
d858e5f0 2247 if (dev->ctrl.queue_count)
82469c59 2248 nvme_suspend_queue(dev->queues[0]);
4d115420 2249 } else {
70659060 2250 nvme_disable_io_queues(dev, queues);
a5cdb68c 2251 nvme_disable_admin_queue(dev, shutdown);
4d115420 2252 }
b00a726a 2253 nvme_pci_disable(dev);
07836e65 2254
e1958e65
ML
2255 blk_mq_tagset_busy_iter(&dev->tagset, nvme_cancel_request, &dev->ctrl);
2256 blk_mq_tagset_busy_iter(&dev->admin_tagset, nvme_cancel_request, &dev->ctrl);
302ad8cc
KB
2257
2258 /*
2259 * The driver will not be starting up queues again if shutting down so
2260 * must flush all entered requests to their failed completion to avoid
2261 * deadlocking blk-mq hot-cpu notifier.
2262 */
2263 if (shutdown)
2264 nvme_start_queues(&dev->ctrl);
77bf25ea 2265 mutex_unlock(&dev->shutdown_lock);
b60503ba
MW
2266}
2267
091b6092
MW
2268static int nvme_setup_prp_pools(struct nvme_dev *dev)
2269{
e75ec752 2270 dev->prp_page_pool = dma_pool_create("prp list page", dev->dev,
091b6092
MW
2271 PAGE_SIZE, PAGE_SIZE, 0);
2272 if (!dev->prp_page_pool)
2273 return -ENOMEM;
2274
99802a7a 2275 /* Optimisation for I/Os between 4k and 128k */
e75ec752 2276 dev->prp_small_pool = dma_pool_create("prp list 256", dev->dev,
99802a7a
MW
2277 256, 256, 0);
2278 if (!dev->prp_small_pool) {
2279 dma_pool_destroy(dev->prp_page_pool);
2280 return -ENOMEM;
2281 }
091b6092
MW
2282 return 0;
2283}
2284
2285static void nvme_release_prp_pools(struct nvme_dev *dev)
2286{
2287 dma_pool_destroy(dev->prp_page_pool);
99802a7a 2288 dma_pool_destroy(dev->prp_small_pool);
091b6092
MW
2289}
2290
1673f1f0 2291static void nvme_pci_free_ctrl(struct nvme_ctrl *ctrl)
5e82e952 2292{
1673f1f0 2293 struct nvme_dev *dev = to_nvme_dev(ctrl);
9ac27090 2294
f9f38e33 2295 nvme_dbbuf_dma_free(dev);
e75ec752 2296 put_device(dev->dev);
4af0e21c
KB
2297 if (dev->tagset.tags)
2298 blk_mq_free_tag_set(&dev->tagset);
1c63dc66
CH
2299 if (dev->ctrl.admin_q)
2300 blk_put_queue(dev->ctrl.admin_q);
5e82e952 2301 kfree(dev->queues);
e286bcfc 2302 free_opal_dev(dev->ctrl.opal_dev);
5e82e952
KB
2303 kfree(dev);
2304}
2305
f58944e2
KB
2306static void nvme_remove_dead_ctrl(struct nvme_dev *dev, int status)
2307{
237045fc 2308 dev_warn(dev->ctrl.device, "Removing after probe failure status: %d\n", status);
f58944e2 2309
d22524a4 2310 nvme_get_ctrl(&dev->ctrl);
69d9a99c 2311 nvme_dev_disable(dev, false);
03e0f3a6 2312 if (!queue_work(nvme_wq, &dev->remove_work))
f58944e2
KB
2313 nvme_put_ctrl(&dev->ctrl);
2314}
2315
fd634f41 2316static void nvme_reset_work(struct work_struct *work)
5e82e952 2317{
d86c4d8e
CH
2318 struct nvme_dev *dev =
2319 container_of(work, struct nvme_dev, ctrl.reset_work);
a98e58e5 2320 bool was_suspend = !!(dev->ctrl.ctrl_config & NVME_CC_SHN_NORMAL);
f58944e2 2321 int result = -ENODEV;
5e82e952 2322
82b057ca 2323 if (WARN_ON(dev->ctrl.state != NVME_CTRL_RESETTING))
fd634f41 2324 goto out;
5e82e952 2325
fd634f41
CH
2326 /*
2327 * If we're called to reset a live controller first shut it down before
2328 * moving on.
2329 */
b00a726a 2330 if (dev->ctrl.ctrl_config & NVME_CC_ENABLE)
a5cdb68c 2331 nvme_dev_disable(dev, false);
80bc535d 2332 nvme_sync_queues(&dev->ctrl);
5e82e952 2333
b00a726a 2334 result = nvme_pci_enable(dev);
f0b50732 2335 if (result)
3cf519b5 2336 goto out;
f0b50732 2337
01ad0990 2338 result = nvme_pci_configure_admin_queue(dev);
f0b50732 2339 if (result)
f58944e2 2340 goto out;
f0b50732 2341
0fb59cbc
KB
2342 result = nvme_alloc_admin_tags(dev);
2343 if (result)
f58944e2 2344 goto out;
b9afca3e 2345
ce4541f4
CH
2346 result = nvme_init_identify(&dev->ctrl);
2347 if (result)
f58944e2 2348 goto out;
ce4541f4 2349
e286bcfc
SB
2350 if (dev->ctrl.oacs & NVME_CTRL_OACS_SEC_SUPP) {
2351 if (!dev->ctrl.opal_dev)
2352 dev->ctrl.opal_dev =
2353 init_opal_dev(&dev->ctrl, &nvme_sec_submit);
2354 else if (was_suspend)
2355 opal_unlock_from_suspend(dev->ctrl.opal_dev);
2356 } else {
2357 free_opal_dev(dev->ctrl.opal_dev);
2358 dev->ctrl.opal_dev = NULL;
4f1244c8 2359 }
a98e58e5 2360
f9f38e33
HK
2361 if (dev->ctrl.oacs & NVME_CTRL_OACS_DBBUF_SUPP) {
2362 result = nvme_dbbuf_dma_alloc(dev);
2363 if (result)
2364 dev_warn(dev->dev,
2365 "unable to allocate dma for dbbuf\n");
2366 }
2367
9620cfba
CH
2368 if (dev->ctrl.hmpre) {
2369 result = nvme_setup_host_mem(dev);
2370 if (result < 0)
2371 goto out;
2372 }
87ad72a5 2373
f0b50732 2374 result = nvme_setup_io_queues(dev);
badc34d4 2375 if (result)
f58944e2 2376 goto out;
f0b50732 2377
2659e57b
CH
2378 /*
2379 * Keep the controller around but remove all namespaces if we don't have
2380 * any working I/O queue.
2381 */
3cf519b5 2382 if (dev->online_queues < 2) {
1b3c47c1 2383 dev_warn(dev->ctrl.device, "IO queues not created\n");
3b24774e 2384 nvme_kill_queues(&dev->ctrl);
5bae7f73 2385 nvme_remove_namespaces(&dev->ctrl);
3cf519b5 2386 } else {
25646264 2387 nvme_start_queues(&dev->ctrl);
302ad8cc 2388 nvme_wait_freeze(&dev->ctrl);
3cf519b5 2389 nvme_dev_add(dev);
302ad8cc 2390 nvme_unfreeze(&dev->ctrl);
3cf519b5
CH
2391 }
2392
bb8d261e
CH
2393 if (!nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_LIVE)) {
2394 dev_warn(dev->ctrl.device, "failed to mark controller live\n");
2395 goto out;
2396 }
92911a55 2397
d09f2b45 2398 nvme_start_ctrl(&dev->ctrl);
3cf519b5 2399 return;
f0b50732 2400
3cf519b5 2401 out:
f58944e2 2402 nvme_remove_dead_ctrl(dev, result);
f0b50732
KB
2403}
2404
5c8809e6 2405static void nvme_remove_dead_ctrl_work(struct work_struct *work)
9a6b9458 2406{
5c8809e6 2407 struct nvme_dev *dev = container_of(work, struct nvme_dev, remove_work);
e75ec752 2408 struct pci_dev *pdev = to_pci_dev(dev->dev);
9a6b9458 2409
69d9a99c 2410 nvme_kill_queues(&dev->ctrl);
9a6b9458 2411 if (pci_get_drvdata(pdev))
921920ab 2412 device_release_driver(&pdev->dev);
1673f1f0 2413 nvme_put_ctrl(&dev->ctrl);
9a6b9458
KB
2414}
2415
1c63dc66 2416static int nvme_pci_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val)
9ca97374 2417{
1c63dc66 2418 *val = readl(to_nvme_dev(ctrl)->bar + off);
90667892 2419 return 0;
9ca97374
TH
2420}
2421
5fd4ce1b 2422static int nvme_pci_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val)
4cc06521 2423{
5fd4ce1b
CH
2424 writel(val, to_nvme_dev(ctrl)->bar + off);
2425 return 0;
2426}
4cc06521 2427
7fd8930f
CH
2428static int nvme_pci_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val)
2429{
2430 *val = readq(to_nvme_dev(ctrl)->bar + off);
2431 return 0;
4cc06521
KB
2432}
2433
1c63dc66 2434static const struct nvme_ctrl_ops nvme_pci_ctrl_ops = {
1a353d85 2435 .name = "pcie",
e439bb12 2436 .module = THIS_MODULE,
c81bfba9 2437 .flags = NVME_F_METADATA_SUPPORTED,
1c63dc66 2438 .reg_read32 = nvme_pci_reg_read32,
5fd4ce1b 2439 .reg_write32 = nvme_pci_reg_write32,
7fd8930f 2440 .reg_read64 = nvme_pci_reg_read64,
1673f1f0 2441 .free_ctrl = nvme_pci_free_ctrl,
f866fc42 2442 .submit_async_event = nvme_pci_submit_async_event,
1c63dc66 2443};
4cc06521 2444
b00a726a
KB
2445static int nvme_dev_map(struct nvme_dev *dev)
2446{
b00a726a
KB
2447 struct pci_dev *pdev = to_pci_dev(dev->dev);
2448
a1f447b3 2449 if (pci_request_mem_regions(pdev, "nvme"))
b00a726a
KB
2450 return -ENODEV;
2451
97f6ef64 2452 if (nvme_remap_bar(dev, NVME_REG_DBS + 4096))
b00a726a
KB
2453 goto release;
2454
9fa196e7 2455 return 0;
b00a726a 2456 release:
9fa196e7
MG
2457 pci_release_mem_regions(pdev);
2458 return -ENODEV;
b00a726a
KB
2459}
2460
8427bbc2 2461static unsigned long check_vendor_combination_bug(struct pci_dev *pdev)
ff5350a8
AL
2462{
2463 if (pdev->vendor == 0x144d && pdev->device == 0xa802) {
2464 /*
2465 * Several Samsung devices seem to drop off the PCIe bus
2466 * randomly when APST is on and uses the deepest sleep state.
2467 * This has been observed on a Samsung "SM951 NVMe SAMSUNG
2468 * 256GB", a "PM951 NVMe SAMSUNG 512GB", and a "Samsung SSD
2469 * 950 PRO 256GB", but it seems to be restricted to two Dell
2470 * laptops.
2471 */
2472 if (dmi_match(DMI_SYS_VENDOR, "Dell Inc.") &&
2473 (dmi_match(DMI_PRODUCT_NAME, "XPS 15 9550") ||
2474 dmi_match(DMI_PRODUCT_NAME, "Precision 5510")))
2475 return NVME_QUIRK_NO_DEEPEST_PS;
8427bbc2
KHF
2476 } else if (pdev->vendor == 0x144d && pdev->device == 0xa804) {
2477 /*
2478 * Samsung SSD 960 EVO drops off the PCIe bus after system
8ec9bf9c
JJ
2479 * suspend on a Ryzen board, ASUS PRIME B350M-A, as well as
2480 * within few minutes after bootup on a Coffee Lake board -
2481 * ASUS PRIME Z370-A
8427bbc2
KHF
2482 */
2483 if (dmi_match(DMI_BOARD_VENDOR, "ASUSTeK COMPUTER INC.") &&
8ec9bf9c
JJ
2484 (dmi_match(DMI_BOARD_NAME, "PRIME B350M-A") ||
2485 dmi_match(DMI_BOARD_NAME, "PRIME Z370-A")))
8427bbc2 2486 return NVME_QUIRK_NO_APST;
ff5350a8
AL
2487 }
2488
2489 return 0;
2490}
2491
8d85fce7 2492static int nvme_probe(struct pci_dev *pdev, const struct pci_device_id *id)
b60503ba 2493{
a4aea562 2494 int node, result = -ENOMEM;
b60503ba 2495 struct nvme_dev *dev;
ff5350a8 2496 unsigned long quirks = id->driver_data;
b60503ba 2497
a4aea562
MB
2498 node = dev_to_node(&pdev->dev);
2499 if (node == NUMA_NO_NODE)
2fa84351 2500 set_dev_node(&pdev->dev, first_memory_node);
a4aea562
MB
2501
2502 dev = kzalloc_node(sizeof(*dev), GFP_KERNEL, node);
b60503ba
MW
2503 if (!dev)
2504 return -ENOMEM;
a4aea562
MB
2505 dev->queues = kzalloc_node((num_possible_cpus() + 1) * sizeof(void *),
2506 GFP_KERNEL, node);
b60503ba
MW
2507 if (!dev->queues)
2508 goto free;
2509
e75ec752 2510 dev->dev = get_device(&pdev->dev);
9a6b9458 2511 pci_set_drvdata(pdev, dev);
1c63dc66 2512
b00a726a
KB
2513 result = nvme_dev_map(dev);
2514 if (result)
b00c9b7a 2515 goto put_pci;
b00a726a 2516
d86c4d8e 2517 INIT_WORK(&dev->ctrl.reset_work, nvme_reset_work);
5c8809e6 2518 INIT_WORK(&dev->remove_work, nvme_remove_dead_ctrl_work);
77bf25ea 2519 mutex_init(&dev->shutdown_lock);
db3cbfff 2520 init_completion(&dev->ioq_wait);
b60503ba 2521
091b6092
MW
2522 result = nvme_setup_prp_pools(dev);
2523 if (result)
b00c9b7a 2524 goto unmap;
4cc06521 2525
8427bbc2 2526 quirks |= check_vendor_combination_bug(pdev);
ff5350a8 2527
f3ca80fc 2528 result = nvme_init_ctrl(&dev->ctrl, &pdev->dev, &nvme_pci_ctrl_ops,
ff5350a8 2529 quirks);
4cc06521 2530 if (result)
2e1d8448 2531 goto release_pools;
740216fc 2532
82b057ca 2533 nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_RESETTING);
1b3c47c1
SG
2534 dev_info(dev->ctrl.device, "pci function %s\n", dev_name(&pdev->dev));
2535
d86c4d8e 2536 queue_work(nvme_wq, &dev->ctrl.reset_work);
b60503ba
MW
2537 return 0;
2538
0877cb0d 2539 release_pools:
091b6092 2540 nvme_release_prp_pools(dev);
b00c9b7a
CJ
2541 unmap:
2542 nvme_dev_unmap(dev);
a96d4f5c 2543 put_pci:
e75ec752 2544 put_device(dev->dev);
b60503ba
MW
2545 free:
2546 kfree(dev->queues);
b60503ba
MW
2547 kfree(dev);
2548 return result;
2549}
2550
775755ed 2551static void nvme_reset_prepare(struct pci_dev *pdev)
f0d54a54 2552{
a6739479 2553 struct nvme_dev *dev = pci_get_drvdata(pdev);
f263fbb8 2554 nvme_dev_disable(dev, false);
775755ed 2555}
f0d54a54 2556
775755ed
CH
2557static void nvme_reset_done(struct pci_dev *pdev)
2558{
f263fbb8
LT
2559 struct nvme_dev *dev = pci_get_drvdata(pdev);
2560 nvme_reset_ctrl(&dev->ctrl);
f0d54a54
KB
2561}
2562
09ece142
KB
2563static void nvme_shutdown(struct pci_dev *pdev)
2564{
2565 struct nvme_dev *dev = pci_get_drvdata(pdev);
a5cdb68c 2566 nvme_dev_disable(dev, true);
09ece142
KB
2567}
2568
f58944e2
KB
2569/*
2570 * The driver's remove may be called on a device in a partially initialized
2571 * state. This function must not have any dependencies on the device state in
2572 * order to proceed.
2573 */
8d85fce7 2574static void nvme_remove(struct pci_dev *pdev)
b60503ba
MW
2575{
2576 struct nvme_dev *dev = pci_get_drvdata(pdev);
9a6b9458 2577
bb8d261e
CH
2578 nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DELETING);
2579
d86c4d8e 2580 cancel_work_sync(&dev->ctrl.reset_work);
9a6b9458 2581 pci_set_drvdata(pdev, NULL);
0ff9d4e1 2582
6db28eda 2583 if (!pci_device_is_present(pdev)) {
0ff9d4e1 2584 nvme_change_ctrl_state(&dev->ctrl, NVME_CTRL_DEAD);
6db28eda
KB
2585 nvme_dev_disable(dev, false);
2586 }
0ff9d4e1 2587
d86c4d8e 2588 flush_work(&dev->ctrl.reset_work);
d09f2b45
SG
2589 nvme_stop_ctrl(&dev->ctrl);
2590 nvme_remove_namespaces(&dev->ctrl);
a5cdb68c 2591 nvme_dev_disable(dev, true);
87ad72a5 2592 nvme_free_host_mem(dev);
a4aea562 2593 nvme_dev_remove_admin(dev);
a1a5ef99 2594 nvme_free_queues(dev, 0);
d09f2b45 2595 nvme_uninit_ctrl(&dev->ctrl);
9a6b9458 2596 nvme_release_prp_pools(dev);
b00a726a 2597 nvme_dev_unmap(dev);
1673f1f0 2598 nvme_put_ctrl(&dev->ctrl);
b60503ba
MW
2599}
2600
13880f5b
KB
2601static int nvme_pci_sriov_configure(struct pci_dev *pdev, int numvfs)
2602{
2603 int ret = 0;
2604
2605 if (numvfs == 0) {
2606 if (pci_vfs_assigned(pdev)) {
2607 dev_warn(&pdev->dev,
2608 "Cannot disable SR-IOV VFs while assigned\n");
2609 return -EPERM;
2610 }
2611 pci_disable_sriov(pdev);
2612 return 0;
2613 }
2614
2615 ret = pci_enable_sriov(pdev, numvfs);
2616 return ret ? ret : numvfs;
2617}
2618
671a6018 2619#ifdef CONFIG_PM_SLEEP
0b5db994
KB
2620static int nvme_get_power_state(struct nvme_ctrl *ctrl, u32 *ps)
2621{
2622 return nvme_get_features(ctrl, NVME_FEAT_POWER_MGMT, 0, NULL, 0, ps);
2623}
2624
2625static int nvme_set_power_state(struct nvme_ctrl *ctrl, u32 ps)
2626{
2627 return nvme_set_features(ctrl, NVME_FEAT_POWER_MGMT, ps, NULL, 0, NULL);
2628}
2629
2630static int nvme_resume(struct device *dev)
2631{
2632 struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
2633 struct nvme_ctrl *ctrl = &ndev->ctrl;
2634
2635 if (pm_resume_via_firmware() || !ctrl->npss ||
2636 nvme_set_power_state(ctrl, ndev->last_ps) != 0)
2637 nvme_reset_ctrl(ctrl);
2638 return 0;
2639}
2640
cd638946
KB
2641static int nvme_suspend(struct device *dev)
2642{
2643 struct pci_dev *pdev = to_pci_dev(dev);
2644 struct nvme_dev *ndev = pci_get_drvdata(pdev);
0b5db994
KB
2645 struct nvme_ctrl *ctrl = &ndev->ctrl;
2646 int ret = -EBUSY;
2647
2648 /*
2649 * The platform does not remove power for a kernel managed suspend so
2650 * use host managed nvme power settings for lowest idle power if
2651 * possible. This should have quicker resume latency than a full device
2652 * shutdown. But if the firmware is involved after the suspend or the
2653 * device does not support any non-default power states, shut down the
2654 * device fully.
2655 */
2656 if (pm_suspend_via_firmware() || !ctrl->npss) {
2657 nvme_dev_disable(ndev, true);
2658 return 0;
2659 }
2660
2661 nvme_start_freeze(ctrl);
2662 nvme_wait_freeze(ctrl);
2663 nvme_sync_queues(ctrl);
2664
2665 if (ctrl->state != NVME_CTRL_LIVE)
2666 goto unfreeze;
2667
2668 ndev->last_ps = 0;
2669 ret = nvme_get_power_state(ctrl, &ndev->last_ps);
2670 if (ret < 0)
2671 goto unfreeze;
2672
2673 ret = nvme_set_power_state(ctrl, ctrl->npss);
2674 if (ret < 0)
2675 goto unfreeze;
2676
2677 if (ret) {
2678 /*
2679 * Clearing npss forces a controller reset on resume. The
2680 * correct value will be resdicovered then.
2681 */
2682 nvme_dev_disable(ndev, true);
2683 ctrl->npss = 0;
2684 ret = 0;
2685 goto unfreeze;
2686 }
2687 /*
2688 * A saved state prevents pci pm from generically controlling the
2689 * device's power. If we're using protocol specific settings, we don't
2690 * want pci interfering.
2691 */
2692 pci_save_state(pdev);
2693unfreeze:
2694 nvme_unfreeze(ctrl);
2695 return ret;
2696}
2697
2698static int nvme_simple_suspend(struct device *dev)
2699{
2700 struct nvme_dev *ndev = pci_get_drvdata(to_pci_dev(dev));
cd638946 2701
a1894ef1 2702 nvme_dev_disable(ndev, true);
cd638946
KB
2703 return 0;
2704}
2705
0b5db994 2706static int nvme_simple_resume(struct device *dev)
cd638946
KB
2707{
2708 struct pci_dev *pdev = to_pci_dev(dev);
2709 struct nvme_dev *ndev = pci_get_drvdata(pdev);
cd638946 2710
d86c4d8e 2711 nvme_reset_ctrl(&ndev->ctrl);
9a6b9458 2712 return 0;
cd638946
KB
2713}
2714
0b5db994
KB
2715const struct dev_pm_ops nvme_dev_pm_ops = {
2716 .suspend = nvme_suspend,
2717 .resume = nvme_resume,
2718 .freeze = nvme_simple_suspend,
2719 .thaw = nvme_simple_resume,
2720 .poweroff = nvme_simple_suspend,
2721 .restore = nvme_simple_resume,
2722};
2723
2724#else
2725#define nvme_dev_pm_ops NULL
2726#endif
b60503ba 2727
a0a3408e
KB
2728static pci_ers_result_t nvme_error_detected(struct pci_dev *pdev,
2729 pci_channel_state_t state)
2730{
2731 struct nvme_dev *dev = pci_get_drvdata(pdev);
2732
2733 /*
2734 * A frozen channel requires a reset. When detected, this method will
2735 * shutdown the controller to quiesce. The controller will be restarted
2736 * after the slot reset through driver's slot_reset callback.
2737 */
a0a3408e
KB
2738 switch (state) {
2739 case pci_channel_io_normal:
2740 return PCI_ERS_RESULT_CAN_RECOVER;
2741 case pci_channel_io_frozen:
d011fb31
KB
2742 dev_warn(dev->ctrl.device,
2743 "frozen state error detected, reset controller\n");
a5cdb68c 2744 nvme_dev_disable(dev, false);
a0a3408e
KB
2745 return PCI_ERS_RESULT_NEED_RESET;
2746 case pci_channel_io_perm_failure:
d011fb31
KB
2747 dev_warn(dev->ctrl.device,
2748 "failure state error detected, request disconnect\n");
a0a3408e
KB
2749 return PCI_ERS_RESULT_DISCONNECT;
2750 }
2751 return PCI_ERS_RESULT_NEED_RESET;
2752}
2753
2754static pci_ers_result_t nvme_slot_reset(struct pci_dev *pdev)
2755{
2756 struct nvme_dev *dev = pci_get_drvdata(pdev);
2757
1b3c47c1 2758 dev_info(dev->ctrl.device, "restart after slot reset\n");
a0a3408e 2759 pci_restore_state(pdev);
d86c4d8e 2760 nvme_reset_ctrl(&dev->ctrl);
a0a3408e
KB
2761 return PCI_ERS_RESULT_RECOVERED;
2762}
2763
2764static void nvme_error_resume(struct pci_dev *pdev)
2765{
baf41196
KB
2766 struct nvme_dev *dev = pci_get_drvdata(pdev);
2767
2768 flush_work(&dev->ctrl.reset_work);
a0a3408e
KB
2769 pci_cleanup_aer_uncorrect_error_status(pdev);
2770}
2771
1d352035 2772static const struct pci_error_handlers nvme_err_handler = {
b60503ba 2773 .error_detected = nvme_error_detected,
b60503ba
MW
2774 .slot_reset = nvme_slot_reset,
2775 .resume = nvme_error_resume,
775755ed
CH
2776 .reset_prepare = nvme_reset_prepare,
2777 .reset_done = nvme_reset_done,
b60503ba
MW
2778};
2779
6eb0d698 2780static const struct pci_device_id nvme_id_table[] = {
106198ed 2781 { PCI_VDEVICE(INTEL, 0x0953),
08095e70 2782 .driver_data = NVME_QUIRK_STRIPE_SIZE |
e850fd16 2783 NVME_QUIRK_DEALLOCATE_ZEROES, },
99466e70
KB
2784 { PCI_VDEVICE(INTEL, 0x0a53),
2785 .driver_data = NVME_QUIRK_STRIPE_SIZE |
e850fd16 2786 NVME_QUIRK_DEALLOCATE_ZEROES, },
99466e70
KB
2787 { PCI_VDEVICE(INTEL, 0x0a54),
2788 .driver_data = NVME_QUIRK_STRIPE_SIZE |
e850fd16 2789 NVME_QUIRK_DEALLOCATE_ZEROES, },
f99cb7af
DWF
2790 { PCI_VDEVICE(INTEL, 0x0a55),
2791 .driver_data = NVME_QUIRK_STRIPE_SIZE |
2792 NVME_QUIRK_DEALLOCATE_ZEROES, },
50af47d0 2793 { PCI_VDEVICE(INTEL, 0xf1a5), /* Intel 600P/P3100 */
5750cb1c
JA
2794 .driver_data = NVME_QUIRK_NO_DEEPEST_PS |
2795 NVME_QUIRK_MEDIUM_PRIO_SQ },
a676e05d 2796 { PCI_VDEVICE(INTEL, 0xf1a6), /* Intel 760p/Pro 7600p */
af9e76ef 2797 .driver_data = NVME_QUIRK_IGNORE_DEV_SUBNQN, },
540c801c
KB
2798 { PCI_VDEVICE(INTEL, 0x5845), /* Qemu emulated controller */
2799 .driver_data = NVME_QUIRK_IDENTIFY_CNS, },
54adc010
GP
2800 { PCI_DEVICE(0x1c58, 0x0003), /* HGST adapter */
2801 .driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
8c97eecc
JL
2802 { PCI_DEVICE(0x1c58, 0x0023), /* WDC SN200 adapter */
2803 .driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
015282c9
WW
2804 { PCI_DEVICE(0x1c5f, 0x0540), /* Memblaze Pblaze4 adapter */
2805 .driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
d554b5e1
MP
2806 { PCI_DEVICE(0x144d, 0xa821), /* Samsung PM1725 */
2807 .driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
2808 { PCI_DEVICE(0x144d, 0xa822), /* Samsung PM1725a */
2809 .driver_data = NVME_QUIRK_DELAY_BEFORE_CHK_RDY, },
608cc4b1
CH
2810 { PCI_DEVICE(0x1d1d, 0x1f1f), /* LighNVM qemu device */
2811 .driver_data = NVME_QUIRK_LIGHTNVM, },
2812 { PCI_DEVICE(0x1d1d, 0x2807), /* CNEX WL */
2813 .driver_data = NVME_QUIRK_LIGHTNVM, },
705e8934
WX
2814 { PCI_DEVICE(0x1d1d, 0x2601), /* CNEX Granby */
2815 .driver_data = NVME_QUIRK_LIGHTNVM, },
b60503ba 2816 { PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
c74dc780 2817 { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2001) },
124298bd 2818 { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2003) },
b60503ba
MW
2819 { 0, }
2820};
2821MODULE_DEVICE_TABLE(pci, nvme_id_table);
2822
2823static struct pci_driver nvme_driver = {
2824 .name = "nvme",
2825 .id_table = nvme_id_table,
2826 .probe = nvme_probe,
8d85fce7 2827 .remove = nvme_remove,
09ece142 2828 .shutdown = nvme_shutdown,
cd638946
KB
2829 .driver = {
2830 .pm = &nvme_dev_pm_ops,
2831 },
13880f5b 2832 .sriov_configure = nvme_pci_sriov_configure,
b60503ba
MW
2833 .err_handler = &nvme_err_handler,
2834};
2835
2836static int __init nvme_init(void)
2837{
9a6327d2 2838 return pci_register_driver(&nvme_driver);
b60503ba
MW
2839}
2840
2841static void __exit nvme_exit(void)
2842{
2843 pci_unregister_driver(&nvme_driver);
03e0f3a6 2844 flush_workqueue(nvme_wq);
21bd78bc 2845 _nvme_check_size();
b60503ba
MW
2846}
2847
2848MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
2849MODULE_LICENSE("GPL");
c78b4713 2850MODULE_VERSION("1.0");
b60503ba
MW
2851module_init(nvme_init);
2852module_exit(nvme_exit);