-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy path0052-PCI-endpoint-Add-NVMe-endpoint-function-driver.patch
2655 lines (2646 loc) · 68.4 KB
/
0052-PCI-endpoint-Add-NVMe-endpoint-function-driver.patch
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
From a50f75e38ffc4a15a679c070238a07539feb8b42 Mon Sep 17 00:00:00 2001
From: Damien Le Moal <damien.lemoal@opensource.wdc.com>
Date: Wed, 11 Jan 2023 18:09:22 +0900
Subject: [PATCH 52/52] PCI: endpoint: Add NVMe endpoint function driver
Add a Linux PCI Endpoint function driver to implement a PCIe NVMe
device. The nvme endpoint function driver implements a PCIe controller
which executes NVMe commands sent by the host using an NVMe target which
can be either a file or a block device. Some NVMe admin commands are an
exception to this basic implementation: the create submission queue and
create completion queue commands for the admin and IO queues are parsed
and executed by the driver directly to allow for mapping on the endpoint
memory the host defined queues in the host PCIe space.
When initialized, the nvme endpoint driver brings up an nvme controller
in the disabled state (CC.EN and CSTS.RDY are not set). When the host
enables the controller by setting CC.EN, the nvme endpoint driver
connects the nvme target with a local file or block device as backend
storage. This backend storage is exposed as the single namespace.
Workqueues are used to poll the controller registers and detect
controller enable/disable events, and to poll submission queues
doorbells to detect command submissions by the host.
Upon reception of a new command, the endpoint nvme driver parses the
command PRPs (or PRP list) to map and access host data buffers. The
execution of the commands on the nvme target side are done using a local
buffer which is transfered to or from the host based on the PRP mapping.
This driver code is based on an RFC submission by Alan Mikhak
<alan.mikhak@sifive.com> (https://lwn.net/Articles/804369/).
Signed-off-by: Damien Le Moal <damien.lemoal@opensource.wdc.com>
---
drivers/pci/endpoint/functions/Kconfig | 9 +
drivers/pci/endpoint/functions/Makefile | 1 +
drivers/pci/endpoint/functions/pci-epf-nvme.c | 2580 +++++++++++++++++
3 files changed, 2590 insertions(+)
create mode 100644 drivers/pci/endpoint/functions/pci-epf-nvme.c
diff --git a/drivers/pci/endpoint/functions/Kconfig b/drivers/pci/endpoint/functions/Kconfig
index 9fd560886871..5bf5ff06a759 100644
--- a/drivers/pci/endpoint/functions/Kconfig
+++ b/drivers/pci/endpoint/functions/Kconfig
@@ -37,3 +37,12 @@ config PCI_EPF_VNTB
between PCI Root Port and PCIe Endpoint.
If in doubt, say "N" to disable Endpoint NTB driver.
+
+config PCI_EPF_NVME
+ tristate "PCI Endpoint NVMe function driver"
+ depends on PCI_ENDPOINT && NVME_TARGET
+ help
+ Enable this configuration option to enable the NVMe function
+ driver for PCI Endpoint.
+
+ If in doubt, say "N" to disable Endpoint NVMe function driver.
diff --git a/drivers/pci/endpoint/functions/Makefile b/drivers/pci/endpoint/functions/Makefile
index 5c13001deaba..382f66beea01 100644
--- a/drivers/pci/endpoint/functions/Makefile
+++ b/drivers/pci/endpoint/functions/Makefile
@@ -6,3 +6,4 @@
obj-$(CONFIG_PCI_EPF_TEST) += pci-epf-test.o
obj-$(CONFIG_PCI_EPF_NTB) += pci-epf-ntb.o
obj-$(CONFIG_PCI_EPF_VNTB) += pci-epf-vntb.o
+obj-$(CONFIG_PCI_EPF_NVME) += pci-epf-nvme.o
diff --git a/drivers/pci/endpoint/functions/pci-epf-nvme.c b/drivers/pci/endpoint/functions/pci-epf-nvme.c
new file mode 100644
index 000000000000..84d5d2583f0f
--- /dev/null
+++ b/drivers/pci/endpoint/functions/pci-epf-nvme.c
@@ -0,0 +1,2580 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * NVMe function driver for PCI Endpoint Framework
+ *
+ * Copyright (C) 2019 SiFive
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/delay.h>
+#include <linux/dmaengine.h>
+#include <linux/io.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/pci_ids.h>
+#include <linux/pci-epf.h>
+#include <linux/pci_regs.h>
+#include <linux/io-64-nonatomic-lo-hi.h>
+#include <linux/nvme.h>
+#include <generated/utsrelease.h>
+
+#include "../../../nvme/host/nvme.h"
+#include "../../../nvme/target/nvmet.h"
+
+#define PCI_EPF_NVME_HOSTNQN "pciepfhostnqn"
+#define PCI_EPF_NVME_SUBSYSNQN "pciepfnqn"
+
+/* Command sets supported: NVMe command set */
+#define PCI_EPF_NVME_CSS 1ULL
+
+/* CC.EN timeout in 500msec units */
+#define PCI_EPF_NVME_TO 15ULL
+
+/* Maximum queue size */
+#define PCI_EPF_NVME_QUEUE_DEPTH 64
+#define PCI_EPF_NVME_MQES (PCI_EPF_NVME_QUEUE_DEPTH - 1)
+
+/* Maximum queue id */
+#define PCI_EPF_NVME_MAX_QID 4
+#define PCI_EPF_NVME_MAX_NR_QUEUES (PCI_EPF_NVME_MAX_QID + 1)
+
+/* Keep alive interval: 60s (default: NVME_DEFAULT_KATO = 5s) */
+#define PCI_EPF_NVME_KATO 60
+#define PCI_EPF_NVME_KEEP_ALIVE_JIFFIES (HZ * (PCI_EPF_NVME_KATO - 2))
+
+/* Model number string max length */
+#define PCI_EPF_NVME_MN_LEN 40
+
+/*
+ * Maximum data transfer size: limit to 512 KiB to limit the number of PRPs we
+ * will get and to not exceed the PCI memory regions size of the EP controller.
+ */
+#define PCI_EPF_NVME_MDTS (512 * 1024)
+#define PCI_EPF_NVME_MAX_PRPS \
+ ((PCI_EPF_NVME_MDTS >> NVME_CTRL_PAGE_SHIFT) + 1)
+
+/* PRP manipulation macros */
+#define pci_epf_nvme_prp_addr(prp) ((prp) & ~(NVME_CTRL_PAGE_SIZE - 1))
+#define pci_epf_nvme_prp_ofst(prp) ((prp) & (NVME_CTRL_PAGE_SIZE - 1))
+#define pci_epf_nvme_prp_size(prp) \
+ ((size_t)(NVME_CTRL_PAGE_SIZE - pci_epf_nvme_prp_ofst(prp)))
+
+static struct workqueue_struct *epf_nvme_reg_wq;
+static struct workqueue_struct *epf_nvme_sq_wq;
+static struct kmem_cache *epf_nvme_cmd_cache;
+
+/*
+ * Host PCI memory segment for admin and IO commands.
+ */
+struct pci_epf_nvme_seg {
+ phys_addr_t pci_addr;
+ size_t size;
+};
+
+/*
+ * Controller queue definition and mapping.
+ */
+struct pci_epf_nvme_queue {
+
+ int ref;
+
+ u16 qid;
+ u16 cqid;
+ u16 size;
+ u16 depth;
+ u16 flags;
+ u16 vector;
+ u16 head;
+ u16 tail;
+ u16 phase;
+ u32 db;
+
+ size_t qes;
+
+ struct pci_epc_map map;
+};
+
+/*
+ * Our local emulated controller.
+ */
+struct pci_epf_nvme_ctrl {
+ void __iomem *reg;
+
+ u64 cap;
+ u32 vs;
+ u32 cc;
+ u32 csts;
+ u32 aqa;
+ u64 asq;
+ u64 acq;
+
+ size_t adm_sqes;
+ size_t adm_cqes;
+ size_t io_sqes;
+ size_t io_cqes;
+
+ size_t mps_shift;
+ size_t mps;
+
+ struct pci_epf_nvme_queue sq[PCI_EPF_NVME_MAX_NR_QUEUES];
+ struct pci_epf_nvme_queue cq[PCI_EPF_NVME_MAX_NR_QUEUES];
+};
+
+struct pci_epf_nvme;
+
+/*
+ * Command flags.
+ */
+#define PCI_EPF_NVME_CMD_ASYNC (1LU << 0)
+
+/*
+ * Descriptor for commands sent by the host. This is also used internally for
+ * fabrics commands to control our fabrics target.
+ */
+struct pci_epf_nvme_cmd {
+ struct pci_epf_nvme *nvme;
+ unsigned long flags;
+
+ int qid;
+ int cqid;
+ struct nvmet_req req;
+ struct nvme_command cmd;
+ struct nvme_completion cqe;
+ unsigned int status;
+ struct completion done;
+
+ /* Internal buffer for the target command data and its SGL */
+ size_t buffer_size;
+ void *buffer;
+ struct scatterlist buffer_sgl;
+
+ /*
+ * Host PCI adress segments: if nr_segs is 1, we use only "seg",
+ * otherwise, the segs array is allocated and used to store
+ * multiple segments.
+ */
+ unsigned int nr_segs;
+ struct pci_epf_nvme_seg seg;
+ struct pci_epf_nvme_seg *segs;
+};
+
+/*
+ * The fabrics target we will use behind our emulated controller.
+ */
+struct pci_epf_nvme_target {
+ struct device *dev;
+
+ /* Target definition */
+ struct nvmet_sq sq[PCI_EPF_NVME_MAX_NR_QUEUES];
+ struct nvmet_cq cq[PCI_EPF_NVME_MAX_NR_QUEUES];
+
+ struct nvmet_host host;
+ struct nvmet_host_link host_link;
+
+ struct nvmet_port port;
+ enum nvme_ana_state port_ana_state[NVMET_MAX_ANAGRPS + 1];
+
+ struct nvmet_subsys_link subsys_link;
+ struct nvmet_subsys *subsys;
+
+ struct nvmet_ns *ns;
+
+ struct nvmet_ctrl *nvmet_ctrl;
+
+ /* Target fabrics command */
+ unsigned long keep_alive;
+ struct pci_epf_nvme_cmd fabrics_epcmd;
+ struct pci_epf_nvme_cmd keep_alive_epcmd;
+};
+
+/*
+ * EPF function private data representing our NVMe subsystem.
+ */
+struct pci_epf_nvme {
+ struct pci_epf *epf;
+ const struct pci_epc_features *epc_features;
+
+ void *reg[PCI_STD_NUM_BARS];
+ enum pci_barno reg_bar;
+ size_t msix_table_offset;
+
+ unsigned int irq_type;
+ unsigned int nr_vectors;
+
+ __le64 *prp_list_buf;
+
+ bool dma_supported;
+ bool dma_private;
+ struct dma_chan *dma_chan_tx;
+ struct dma_chan *dma_chan_rx;
+ struct dma_chan *dma_chan;
+ struct device *dma_dev;
+ dma_cookie_t dma_cookie;
+ enum dma_status dma_status;
+ struct completion dma_complete;
+
+ struct delayed_work reg_poll;
+ struct delayed_work sq_poll;
+
+ struct pci_epf_nvme_ctrl ctrl;
+
+ struct pci_epf_nvme_target target;
+
+ spinlock_t qlock;
+
+ /* Function configfs attributes */
+ struct config_group group;
+ char ns_device_path[PATH_MAX + 1];
+ char model_number[PCI_EPF_NVME_MN_LEN];
+ guid_t ns_nguid;
+ int dma_enable;
+ int buffered_io;
+};
+
+static inline u32 pci_epf_nvme_reg_read32(struct pci_epf_nvme_ctrl *ctrl,
+ u32 reg)
+{
+ return readl(ctrl->reg + reg);
+}
+
+static inline void pci_epf_nvme_reg_write32(struct pci_epf_nvme_ctrl *ctrl,
+ u32 reg, u32 val)
+{
+ writel(val, ctrl->reg + reg);
+}
+
+static inline u64 pci_epf_nvme_reg_read64(struct pci_epf_nvme_ctrl *ctrl,
+ u32 reg)
+{
+ return lo_hi_readq(ctrl->reg + reg);
+}
+
+static inline void pci_epf_nvme_reg_write64(struct pci_epf_nvme_ctrl *ctrl,
+ u32 reg, u64 val)
+{
+ lo_hi_writeq(val, ctrl->reg + reg);
+}
+
+struct pci_epf_nvme_dma_filter {
+ struct device *dev;
+ u32 dma_mask;
+};
+
+static bool pci_epf_nvme_dma_filter(struct dma_chan *chan, void *arg)
+{
+ struct pci_epf_nvme_dma_filter *filter = arg;
+ struct dma_slave_caps caps;
+
+ memset(&caps, 0, sizeof(caps));
+ dma_get_slave_caps(chan, &caps);
+
+ return chan->device->dev == filter->dev &&
+ (filter->dma_mask & caps.directions);
+}
+
+static bool pci_epf_nvme_init_dma(struct pci_epf_nvme *nvme)
+{
+ struct pci_epf *epf = nvme->epf;
+ struct device *dev = &epf->dev;
+ struct pci_epf_nvme_dma_filter filter;
+ struct dma_chan *chan;
+ dma_cap_mask_t mask;
+ int ret;
+
+ nvme->dma_dev = nvme->epf->epc->dev.parent;
+ init_completion(&nvme->dma_complete);
+
+ dma_cap_zero(mask);
+ dma_cap_set(DMA_SLAVE, mask);
+
+ filter.dev = nvme->dma_dev;
+ filter.dma_mask = BIT(DMA_DEV_TO_MEM);
+ chan = dma_request_channel(mask, pci_epf_nvme_dma_filter, &filter);
+ if (!chan)
+ goto generic;
+ nvme->dma_chan_rx = chan;
+
+ filter.dma_mask = BIT(DMA_MEM_TO_DEV);
+ chan = dma_request_channel(mask, pci_epf_nvme_dma_filter, &filter);
+ if (!chan)
+ goto release_rx;
+ nvme->dma_chan_tx = chan;
+
+ dev_info(dev, "DMA RX channel %s: maximum segment size %d B\n",
+ dma_chan_name(nvme->dma_chan_rx),
+ dma_get_max_seg_size(nvme->dma_chan_rx->device->dev));
+ dev_info(dev, "DMA TX channel %s: maximum segment size %d B\n",
+ dma_chan_name(nvme->dma_chan_tx),
+ dma_get_max_seg_size(nvme->dma_chan_tx->device->dev));
+
+ nvme->dma_private = true;
+
+ return true;
+
+release_rx:
+ dma_release_channel(nvme->dma_chan_rx);
+ nvme->dma_chan_rx = NULL;
+
+generic:
+ /* Fallback to a generic memcpy channel if we have one */
+ dma_cap_zero(mask);
+ dma_cap_set(DMA_MEMCPY, mask);
+ chan = dma_request_chan_by_mask(&mask);
+ if (IS_ERR(chan)) {
+ ret = PTR_ERR(chan);
+ if (ret != -EPROBE_DEFER)
+ dev_err(dev, "Failed to get generic DMA channel\n");
+ return false;
+ }
+
+ dev_info(dev, "Generic DMA channel %s: maximum segment size %d B\n",
+ dma_chan_name(chan),
+ dma_get_max_seg_size(chan->device->dev));
+
+ nvme->dma_chan_tx = chan;
+ nvme->dma_chan_rx = chan;
+
+ return true;
+}
+
+static void pci_epf_nvme_clean_dma(struct pci_epf_nvme *nvme)
+{
+ if (!nvme->dma_supported)
+ return;
+
+ dma_release_channel(nvme->dma_chan_tx);
+ if (nvme->dma_chan_rx != nvme->dma_chan_tx)
+ dma_release_channel(nvme->dma_chan_rx);
+
+ nvme->dma_chan_tx = NULL;
+ nvme->dma_chan_rx = NULL;
+ nvme->dma_chan = NULL;
+ nvme->dma_supported = false;
+}
+
+static void pci_epf_nvme_dma_callback(void *param)
+{
+ struct pci_epf_nvme *nvme = param;
+ struct dma_tx_state state;
+ enum dma_status status;
+
+ status = dmaengine_tx_status(nvme->dma_chan, nvme->dma_cookie, &state);
+ if (status == DMA_COMPLETE || status == DMA_ERROR) {
+ nvme->dma_status = status;
+ complete(&nvme->dma_complete);
+ }
+}
+
+static int pci_epf_nvme_dma(struct pci_epf_nvme *nvme,
+ dma_addr_t dma_dst, dma_addr_t dma_src,
+ size_t len, dma_addr_t dma_remote,
+ enum dma_transfer_direction dir)
+{
+ struct dma_async_tx_descriptor *tx;
+ struct dma_slave_config sconf = {};
+ unsigned long time_left;
+ struct dma_chan *chan;
+ dma_addr_t dma_local;
+ int ret;
+
+ if (dir == DMA_DEV_TO_MEM) {
+ chan = nvme->dma_chan_tx;
+ dma_local = dma_dst;
+ } else {
+ dma_local = dma_src;
+ chan = nvme->dma_chan_rx;
+ }
+ if (IS_ERR_OR_NULL(chan)) {
+ dev_err(&nvme->epf->dev, "Invalid DMA channel\n");
+ return -EINVAL;
+ }
+
+ if (nvme->dma_private) {
+ sconf.direction = dir;
+ if (dir == DMA_MEM_TO_DEV)
+ sconf.dst_addr = dma_remote;
+ else
+ sconf.src_addr = dma_remote;
+
+ if (dmaengine_slave_config(chan, &sconf)) {
+ dev_err(&nvme->epf->dev, "DMA slave config failed\n");
+ return -EIO;
+ }
+
+ tx = dmaengine_prep_slave_single(chan, dma_local, len, dir,
+ DMA_CTRL_ACK | DMA_PREP_INTERRUPT);
+ } else {
+ tx = dmaengine_prep_dma_memcpy(chan, dma_dst, dma_src, len,
+ DMA_CTRL_ACK | DMA_PREP_INTERRUPT);
+ }
+ if (!tx) {
+ dev_err(&nvme->epf->dev, "Prepare DMA memcpy failed\n");
+ return -EIO;
+ }
+
+ reinit_completion(&nvme->dma_complete);
+ nvme->dma_chan = chan;
+ tx->callback = pci_epf_nvme_dma_callback;
+ tx->callback_param = nvme;
+ nvme->dma_cookie = dmaengine_submit(tx);
+
+ ret = dma_submit_error(nvme->dma_cookie);
+ if (ret) {
+ dev_err(&nvme->epf->dev, "DMA tx_submit failed %d\n", ret);
+ goto terminate;
+ }
+
+ dma_async_issue_pending(chan);
+
+ time_left = wait_for_completion_timeout(&nvme->dma_complete, HZ * 10);
+ if (!time_left) {
+ dev_err(&nvme->epf->dev, "DMA transfer timeout\n");
+ ret = -ETIMEDOUT;
+ goto terminate;
+ }
+
+ if (nvme->dma_status != DMA_COMPLETE) {
+ dev_err(&nvme->epf->dev, "DMA transfer failed\n");
+ ret = -EIO;
+ }
+
+terminate:
+ if (ret)
+ dmaengine_terminate_sync(chan);
+
+ return ret;
+}
+
+static int pci_epf_nvme_dma_transfer(struct pci_epf_nvme *nvme,
+ struct pci_epc_map *map,
+ enum dma_data_direction dir,
+ void *buf, size_t size)
+{
+ phys_addr_t dma_phys_addr;
+ int ret;
+
+ dma_phys_addr = dma_map_single(nvme->dma_dev, buf, size, dir);
+ if (dma_mapping_error(nvme->dma_dev, dma_phys_addr)) {
+ dev_err(&nvme->epf->dev,
+ "Failed to map source buffer addr\n");
+ return -ENOMEM;
+ }
+
+ switch (dir) {
+ case DMA_FROM_DEVICE:
+ ret = pci_epf_nvme_dma(nvme, dma_phys_addr, map->phys_addr,
+ size, map->pci_addr, DMA_DEV_TO_MEM);
+ break;
+ case DMA_TO_DEVICE:
+ ret = pci_epf_nvme_dma(nvme, map->phys_addr, dma_phys_addr,
+ size, map->pci_addr, DMA_MEM_TO_DEV);
+ break;
+ default:
+ ret = -EINVAL;
+ }
+
+ dma_unmap_single(nvme->dma_dev, dma_phys_addr, size, dir);
+
+ return ret;
+}
+
+static int pci_epf_nvme_mmio_transfer(struct pci_epf_nvme *nvme,
+ struct pci_epc_map *map,
+ enum dma_data_direction dir,
+ void *buf, size_t size)
+{
+ switch (dir) {
+ case DMA_FROM_DEVICE:
+ memcpy_fromio(buf, map->virt_addr, size);
+ return 0;
+ case DMA_TO_DEVICE:
+ memcpy_toio(map->virt_addr, buf, size);
+ return 0;
+ default:
+ return -EINVAL;
+ }
+}
+
+static int pci_epf_nvme_transfer(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_seg *seg,
+ enum dma_data_direction dir, void *buf)
+{
+ struct pci_epf *epf = nvme->epf;
+ struct pci_epc_map map;
+ int ret;
+
+ /* Map segment */
+ ret = pci_epf_mem_map(epf, seg->pci_addr, seg->size, &map);
+ if (ret)
+ return ret;
+
+ /* Do not bother with DMA for small transfers */
+ if (nvme->dma_enable && seg->size > NVME_CTRL_PAGE_SIZE)
+ ret = pci_epf_nvme_dma_transfer(nvme, &map, dir, buf,
+ seg->size);
+ else
+ ret = pci_epf_nvme_mmio_transfer(nvme, &map, dir, buf,
+ seg->size);
+
+ pci_epf_mem_unmap(epf, &map);
+
+ return ret;
+}
+
+static struct nvme_command *pci_epf_nvme_init_cmd(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_cmd *epcmd,
+ int qid, int cqid)
+{
+ memset(epcmd, 0, sizeof(*epcmd));
+ epcmd->nvme = nvme;
+ epcmd->qid = qid;
+ epcmd->cqid = cqid;
+ epcmd->req.cmd = &epcmd->cmd;
+ epcmd->req.cqe = &epcmd->cqe;
+ epcmd->req.port = &nvme->target.port;
+ if (epcmd->qid)
+ epcmd->req.ns = nvme->target.ns;
+ epcmd->status = NVME_SC_SUCCESS;
+ init_completion(&epcmd->done);
+
+ return &epcmd->cmd;
+}
+
+static struct pci_epf_nvme_cmd *
+pci_epf_nvme_alloc_cmd(struct pci_epf_nvme *nvme)
+{
+ return kmem_cache_alloc(epf_nvme_cmd_cache, GFP_KERNEL);
+}
+
+static int pci_epf_nvme_alloc_cmd_buffer(struct pci_epf_nvme_cmd *epcmd,
+ size_t size)
+{
+ void *buffer;
+
+ buffer = kzalloc(size, GFP_KERNEL);
+ if (!buffer)
+ return -ENOMEM;
+
+ epcmd->buffer = buffer;
+ epcmd->buffer_size = size;
+
+ return 0;
+}
+
+static int pci_epf_nvme_alloc_cmd_segs(struct pci_epf_nvme_cmd *epcmd,
+ int nr_segs)
+{
+ struct pci_epf_nvme_seg *segs;
+
+ /* Single map case: use the command map structure */
+ if (nr_segs == 1) {
+ epcmd->segs = &epcmd->seg;
+ epcmd->nr_segs = 1;
+ return 0;
+ }
+
+ /* More than one map needed: allocate an array */
+ segs = kcalloc(nr_segs, sizeof(struct pci_epf_nvme_seg), GFP_KERNEL);
+ if (!segs)
+ return -ENOMEM;
+
+ epcmd->nr_segs = nr_segs;
+ epcmd->segs = segs;
+
+ return 0;
+}
+
+static void pci_epf_nvme_free_cmd(struct pci_epf_nvme_cmd *epcmd)
+{
+ if (WARN_ON_ONCE(epcmd == &epcmd->nvme->target.fabrics_epcmd))
+ return;
+
+ if (epcmd->buffer)
+ kfree(epcmd->buffer);
+
+ if (epcmd->segs && epcmd->segs != &epcmd->seg)
+ kfree(epcmd->segs);
+
+ kmem_cache_free(epf_nvme_cmd_cache, epcmd);
+}
+
+static const char *pci_epf_nvme_cmd_name(struct pci_epf_nvme_cmd *epcmd)
+{
+ u8 opcode = epcmd->cmd.common.opcode;
+
+ if (epcmd->qid)
+ return nvme_get_opcode_str(opcode);
+ return nvme_get_admin_opcode_str(opcode);
+}
+
+static int pci_epf_nvme_cmd_transfer(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_cmd *epcmd,
+ enum dma_data_direction dir)
+{
+ struct pci_epf_nvme_seg *seg;
+ void *buf = epcmd->buffer;
+ size_t size = 0;
+ int i, ret;
+
+ /* Do nothing for commands already marked as failed */
+ if (epcmd->status != NVME_SC_SUCCESS)
+ return -EIO;
+
+ /* Go through the command segments and transfer each one */
+ for (i = 0; i < epcmd->nr_segs; i++) {
+ seg = &epcmd->segs[i];
+
+ if (size >= epcmd->buffer_size) {
+ dev_err(&nvme->epf->dev, "Invalid transfer size\n");
+ goto xfer_err;
+ }
+
+ ret = pci_epf_nvme_transfer(nvme, seg, dir, buf);
+ if (ret)
+ goto xfer_err;
+
+ buf += seg->size;
+ size += seg->size;
+ }
+
+ return 0;
+
+xfer_err:
+ epcmd->status = NVME_SC_DATA_XFER_ERROR | NVME_SC_DNR;
+ return -EIO;
+}
+
+static void pci_epf_nvme_raise_irq(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_queue *cq)
+{
+ struct pci_epf *epf = nvme->epf;
+ int ret;
+
+ if (!(cq->flags & NVME_CQ_IRQ_ENABLED))
+ return;
+
+ switch (nvme->irq_type) {
+ case PCI_IRQ_MSIX:
+ case PCI_IRQ_MSI:
+ ret = pci_epf_raise_irq(epf, nvme->irq_type, cq->vector + 1);
+ if (!ret)
+ return;
+ /*
+ * If we got an error, it is likely because the host is using
+ * legacy IRQs (e.g. BIOS, grub), so fallthrough.
+ */
+ fallthrough;
+ case PCI_IRQ_LEGACY:
+ ret = pci_epf_raise_irq(epf, PCI_IRQ_LEGACY, 0);
+ if (!ret)
+ return;
+ break;
+ default:
+ WARN_ON_ONCE(1);
+ ret = -EINVAL;
+ break;
+ }
+
+ if (ret)
+ dev_err(&epf->dev, "Raise IRQ failed %d\n", ret);
+}
+
+static bool pci_epf_nvme_ctrl_ready(struct pci_epf_nvme *nvme)
+{
+ struct pci_epf_nvme_ctrl *ctrl = &nvme->ctrl;
+
+ return (ctrl->cc & NVME_CC_ENABLE) && (ctrl->csts & NVME_CSTS_RDY);
+}
+
+static void pci_epf_nvme_cmd_complete(struct pci_epf_nvme_cmd *epcmd)
+{
+ struct pci_epf_nvme *nvme = epcmd->nvme;
+ struct pci_epf *epf = nvme->epf;
+ struct pci_epf_nvme_ctrl *ctrl = &nvme->ctrl;
+ struct pci_epf_nvme_queue *sq = &ctrl->sq[epcmd->qid];
+ struct pci_epf_nvme_queue *cq = &ctrl->cq[epcmd->cqid];
+ struct nvme_completion *cqe = &epcmd->cqe;
+ unsigned long flags;
+
+ /*
+ * Do not try to complete commands if the controller is not ready
+ * anymore, e.g. after the host cleared CC.EN.
+ */
+ if (!pci_epf_nvme_ctrl_ready(nvme))
+ goto free;
+
+ spin_lock_irqsave(&nvme->qlock, flags);
+
+ /* XXX Check completion queue full state XXX */
+ cq->head = pci_epf_nvme_reg_read32(ctrl, cq->db);
+
+ /* Setup the completion entry */
+ cqe->sq_id = cpu_to_le16(epcmd->qid);
+ cqe->sq_head = cpu_to_le16(sq->head);
+ cqe->command_id = epcmd->cmd.common.command_id;
+ cqe->status = cpu_to_le16((epcmd->status << 1) | cq->phase);
+
+ /* Post the completion entry */
+ dev_dbg(&epf->dev, "cq[%d]: status 0x%x, phase %d, tail %d -> %d/%d\n",
+ epcmd->cqid, epcmd->status, cq->phase, cq->tail,
+ (int)cq->tail, (int)cq->depth);
+
+ memcpy_toio(cq->map.virt_addr + cq->tail * cq->qes, cqe,
+ sizeof(struct nvme_completion));
+
+ /* Advance cq tail */
+ cq->tail++;
+ if (cq->tail >= cq->depth) {
+ cq->tail = 0;
+ cq->phase ^= 1;
+ }
+
+ spin_unlock_irqrestore(&nvme->qlock, flags);
+
+ pci_epf_nvme_raise_irq(nvme, cq);
+
+free:
+ pci_epf_nvme_free_cmd(epcmd);
+}
+
+static struct pci_epf_nvme_cmd *
+pci_epf_nvme_fetch_cmd(struct pci_epf_nvme *nvme, int qid)
+{
+ struct pci_epf_nvme_ctrl *ctrl = &nvme->ctrl;
+ struct pci_epf_nvme_queue *sq = &ctrl->sq[qid];
+ struct pci_epf_nvme_cmd *epcmd;
+ struct nvme_command *cmd;
+ unsigned long flags;
+
+ if (!sq->size)
+ return NULL;
+
+ sq->tail = pci_epf_nvme_reg_read32(ctrl, sq->db);
+ if (sq->tail == sq->head) {
+ /* Queue empty */
+ return NULL;
+ }
+
+ epcmd = pci_epf_nvme_alloc_cmd(nvme);
+ if (!epcmd)
+ return NULL;
+
+ /* Get the NVMe command submitted by the host */
+ cmd = pci_epf_nvme_init_cmd(nvme, epcmd, sq->qid, sq->cqid);
+ memcpy_fromio(cmd, sq->map.virt_addr + sq->head * sq->qes,
+ sizeof(struct nvme_command));
+
+ dev_dbg(&nvme->epf->dev,
+ "sq[%d]: head %d/%d, tail %d, command %s\n",
+ qid, (int)sq->head, (int)sq->depth, (int)sq->tail,
+ pci_epf_nvme_cmd_name(epcmd));
+
+ spin_lock_irqsave(&nvme->qlock, flags);
+ sq->head++;
+ if (sq->head == sq->depth)
+ sq->head = 0;
+ spin_unlock_irqrestore(&nvme->qlock, flags);
+
+ return epcmd;
+}
+
+static int pci_epf_nvme_get_prp_list(struct pci_epf_nvme *nvme, u64 prp,
+ size_t mapping_size)
+{
+ struct pci_epf *epf = nvme->epf;
+ struct pci_epc_map map;
+ size_t prp_size;
+ int ret;
+
+ prp_size = min(pci_epf_nvme_prp_size(prp),
+ (mapping_size >> NVME_CTRL_PAGE_SHIFT) << 3);
+ ret = pci_epf_mem_map(epf, prp, prp_size, &map);
+ if (ret)
+ return ret;
+
+ memcpy_fromio(nvme->prp_list_buf, map.virt_addr, prp_size);
+
+ pci_epf_mem_unmap(epf, &map);
+
+ return prp_size >> 3;
+}
+
+static int pci_epf_nvme_cmd_parse_prp_list(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_cmd *epcmd,
+ size_t transfer_len)
+{
+ struct nvme_command *cmd = &epcmd->cmd;
+ __le64 *prps = nvme->prp_list_buf;
+ struct pci_epf_nvme_seg *seg;
+ size_t size = 0, ofst, prp_size;
+ int nr_segs, nr_prps = 0;
+ phys_addr_t pci_addr;
+ int i = 0, ret;
+ u64 prp;
+
+ /*
+ * Allocate segments for the command: this considers the worst case
+ * scenario where all prps are discontiguous, so get as many segments
+ * as we can have prps. In practice, most of the time, we will have
+ * far less segments than prps.
+ */
+ prp = le64_to_cpu(cmd->common.dptr.prp1);
+ if (!prp)
+ goto invalid_field;
+
+ nr_segs = (transfer_len + NVME_CTRL_PAGE_SIZE - 1)
+ >> NVME_CTRL_PAGE_SHIFT;
+
+ ret = pci_epf_nvme_alloc_cmd_segs(epcmd, nr_segs);
+ if (ret)
+ goto internal;
+
+ /* Set the first segment using prp1 */
+ seg = &epcmd->segs[0];
+ seg->pci_addr = prp;
+ seg->size = pci_epf_nvme_prp_size(prp);
+ ofst = pci_epf_nvme_prp_ofst(prp);
+
+ size = seg->size;
+ pci_addr = prp + size;
+ nr_segs = 1;
+
+ /*
+ * Now build the pci address segments using the prp lists, starting
+ * from prp2.
+ */
+ prp = le64_to_cpu(cmd->common.dptr.prp2);
+ if (!prp)
+ goto invalid_field;
+
+ while (size < transfer_len) {
+
+ if (!nr_prps) {
+ /* Map the prp list */
+ nr_prps = pci_epf_nvme_get_prp_list(nvme, prp,
+ transfer_len + ofst - size);
+ if (nr_prps < 0)
+ goto internal;
+
+ i = 0;
+ ofst = 0;
+ }
+
+ /* Current entry */
+ prp = le64_to_cpu(prps[i]);
+ if (!prp)
+ goto invalid_field;
+
+ /* Did we reach the last prp entry of the list ? */
+ if (transfer_len - size > NVME_CTRL_PAGE_SIZE &&
+ i == nr_prps - 1) {
+ /* We need more PRPs: prp is a list pointer */
+ nr_prps = 0;
+ continue;
+ }
+
+ /* Only the first prp is allowed to have an offset */
+ if (pci_epf_nvme_prp_ofst(prp))
+ goto invalid_offset;
+
+ if (prp != pci_addr) {
+ /* Discontiguous prp: new segment */
+ nr_segs++;
+ if (WARN_ON_ONCE(nr_segs > epcmd->nr_segs))
+ goto internal;
+
+ seg++;
+ seg->pci_addr = prp;
+ seg->size = 0;
+ pci_addr = prp;
+ }
+
+ prp_size = min_t(size_t, NVME_CTRL_PAGE_SIZE,
+ transfer_len - size);
+ seg->size += prp_size;
+ pci_addr += prp_size;
+ size += prp_size;
+
+ i++;
+ }
+
+ epcmd->nr_segs = nr_segs;
+ ret = 0;
+
+ if (size != transfer_len) {
+ dev_err(&nvme->epf->dev,
+ "PRPs transfer length mismatch %zu / %zu\n",
+ size, transfer_len);
+ goto internal;
+ }
+
+ return 0;
+
+internal:
+ epcmd->status = NVME_SC_INTERNAL | NVME_SC_DNR;
+ return -EINVAL;
+
+invalid_offset:
+ epcmd->status = NVME_SC_PRP_INVALID_OFFSET | NVME_SC_DNR;
+ return -EINVAL;
+
+invalid_field:
+ epcmd->status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
+ return -EINVAL;
+}
+
+static int pci_epf_nvme_cmd_parse_prp_simple(struct pci_epf_nvme *nvme,
+ struct pci_epf_nvme_cmd *epcmd,