nvme-pci: Support for Apple 201+ (T2 chip)
v4 cover nvme-pci: Support for Apple 201+ (T2 chip)
This series combines the original series and an updated version of the shared tags patch, and is rebased on nvme-5.4.
This adds support for the controller found in recent Apple machines which is basically a SW emulated NVME controller in the T2 chip.
The original reverse engineering work was done by
Paul Pawlowski <paul at mrarm.io>.
PATCH v4 1/4 nvme-pci: Pass the queue to SQ_SIZE/CQ_SIZE macros
This will make it easier to handle variable queue entry sizes later. No functional change.
--- drivers/nvme/host/pci.c | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-)
drivers/nvme/host/pci.c +15 -15
@@ -28,8 +28,8 @@#include "trace.h" #include "nvme.h" -#define SQ_SIZE (depth) (depth * sizeof(struct nvme_command)) -#define CQ_SIZE (depth) (depth * sizeof(struct nvme_completion)) +#define SQ_SIZE (q) ((q)->q_depth * sizeof(struct nvme_command)) +#define CQ_SIZE (q) ((q)->q_depth * sizeof(struct nvme_completion))#define SGES_PER_PAGE (PAGE_SIZE / sizeof(struct nvme_sgl_desc))
@@ -1344,16 +1344,16 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req, bool reserved)static void nvme_free_queue (struct nvme_queue *nvmeq) { -dma_free_coherent (nvmeq->dev->dev,CQ_SIZE (nvmeq->q_depth), +dma_free_coherent (nvmeq->dev->dev,CQ_SIZE (nvmeq), (void *)nvmeq->cqes, nvmeq->cq_dma_addr);if (!nvmeq->sq_cmds)return ;if (test_and_clear_bit (NVMEQ_SQ_CMB , &nvmeq->flags)) {pci_free_p2pmem (to_pci_dev (nvmeq->dev->dev), - nvmeq->sq_cmds,SQ_SIZE (nvmeq->q_depth)); + nvmeq->sq_cmds,SQ_SIZE (nvmeq)); }else { -dma_free_coherent (nvmeq->dev->dev,SQ_SIZE (nvmeq->q_depth), +dma_free_coherent (nvmeq->dev->dev,SQ_SIZE (nvmeq), nvmeq->sq_cmds, nvmeq->sq_dma_addr); } }
@@ -1433,12 +1433,12 @@ static int nvme_cmb_qdepth(struct nvme_dev *dev, int nr_io_queues, }static int nvme_alloc_sq_cmds (struct nvme_dev *dev,struct nvme_queue *nvmeq, -int qid,int depth) +int qid) {struct pci_dev *pdev =to_pci_dev (dev->dev);if (qid && dev->cmb_use_sqes && (dev->cmbsz &NVME_CMBSZ_SQS )) { - nvmeq->sq_cmds =pci_alloc_p2pmem (pdev,SQ_SIZE (depth)); + nvmeq->sq_cmds =pci_alloc_p2pmem (pdev,SQ_SIZE (nvmeq));if (nvmeq->sq_cmds) { nvmeq->sq_dma_addr =pci_p2pmem_virt_to_bus (pdev, nvmeq->sq_cmds);
@@ -1447,11 +1447,11 @@ static int nvme_alloc_sq_cmds(struct nvme_dev *dev, struct nvme_queue *nvmeq,return 0 ; } -pci_free_p2pmem (pdev, nvmeq->sq_cmds,SQ_SIZE (depth)); +pci_free_p2pmem (pdev, nvmeq->sq_cmds,SQ_SIZE (nvmeq)); } } - nvmeq->sq_cmds =dma_alloc_coherent (dev->dev,SQ_SIZE (depth), + nvmeq->sq_cmds =dma_alloc_coherent (dev->dev,SQ_SIZE (nvmeq), &nvmeq->sq_dma_addr,GFP_KERNEL );if (!nvmeq->sq_cmds)return -ENOMEM ;
@@ -1465,12 +1465,13 @@ static int nvme_alloc_queue(struct nvme_dev *dev, int qid, int depth)if (dev->ctrl.queue_count > qid)return 0 ; - nvmeq->cqes =dma_alloc_coherent (dev->dev,CQ_SIZE (depth), + nvmeq->q_depth = depth; + nvmeq->cqes =dma_alloc_coherent (dev->dev,CQ_SIZE (nvmeq), &nvmeq->cq_dma_addr,GFP_KERNEL );if (!nvmeq->cqes) goto free_nvmeq; -if (nvme_alloc_sq_cmds (dev, nvmeq, qid, depth)) +if (nvme_alloc_sq_cmds (dev, nvmeq, qid)) goto free_cqdma; nvmeq->dev = dev;
@@ -1479,15 +1480,14 @@ static int nvme_alloc_queue(struct nvme_dev *dev, int qid, int depth) nvmeq->cq_head =0 ; nvmeq->cq_phase =1 ; nvmeq->q_db = &dev->dbs[qid *2 * dev->db_stride]; - nvmeq->q_depth = depth; nvmeq->qid = qid; dev->ctrl.queue_count++;return 0 ; free_cqdma: -dma_free_coherent (dev->dev,CQ_SIZE (depth), (void *)nvmeq->cqes, - nvmeq->cq_dma_addr); +dma_free_coherent (dev->dev,CQ_SIZE (nvmeq), (void *)nvmeq->cqes, + nvmeq->cq_dma_addr); free_nvmeq:return -ENOMEM ; }
@@ -1515,7 +1515,7 @@ static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid) nvmeq->cq_head =0 ; nvmeq->cq_phase =1 ; nvmeq->q_db = &dev->dbs[qid *2 * dev->db_stride]; -memset ((void *)nvmeq->cqes,0 ,CQ_SIZE (nvmeq->q_depth)); +memset ((void *)nvmeq->cqes,0 ,CQ_SIZE (nvmeq));nvme_dbbuf_init (dev, nvmeq, qid); dev->online_queues++;wmb ();/* ensure the first interrupt sees the initialization */
Signature · 1 line
2.17.1
PATCH v4 2/4 nvme-pci: Add support for variable IO SQ element size
In reply to Benjamin HerrenschmidtThe size of a submission queue element should always be 6 (64 bytes) by spec.
However some controllers such as Apple's are not properly implementing the standard and require a different size.
This provides the ground work for the subsequent quirks for these controllers.
--- drivers/nvme/host/pci.c | 11 ++++++++--- include/linux/nvme.h | 1 + 2 files changed, 9 insertions(+), 3 deletions(-)
drivers/nvme/host/pci.c +8 -3
@@ -28,7 +28,7 @@#include "trace.h" #include "nvme.h" -#define SQ_SIZE (q) ((q)->q_depth * sizeof(struct nvme_command)) +#define SQ_SIZE (q) ((q)->q_depth << (q)->sqes)#define CQ_SIZE (q) ((q)->q_depth * sizeof(struct nvme_completion))#define SGES_PER_PAGE (PAGE_SIZE / sizeof(struct nvme_sgl_desc))
@@ -100,6 +100,7 @@ struct nvme_dev {unsigned io_queues[HCTX_MAX_TYPES ];unsigned int num_vecs;int q_depth; +int io_sqes;u32 db_stride;void __iomem *bar;unsigned long bar_mapped_size;
@@ -162,7 +163,7 @@ static inline struct nvme_dev *to_nvme_dev(struct nvme_ctrl *ctrl)struct nvme_queue {struct nvme_dev *dev;spinlock_t sq_lock; -struct nvme_command *sq_cmds; +void *sq_cmds;/* only used for poll queues: */ spinlock_t cq_poll_lock____cacheline_aligned_in_smp ;volatile struct nvme_completion *cqes;
@@ -178,6 +179,7 @@ struct nvme_queue {u16 last_cq_head;u16 qid;u8 cq_phase; +u8 sqes;unsigned long flags;#define NVMEQ_ENABLED 0#define NVMEQ_SQ_CMB 1
@@ -488,7 +490,8 @@ static void nvme_submit_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd, bool write_sq) {spin_lock (&nvmeq->sq_lock); -memcpy (&nvmeq->sq_cmds[nvmeq->sq_tail], cmd,sizeof (*cmd)); +memcpy (nvmeq->sq_cmds + (nvmeq->sq_tail << nvmeq->sqes), + cmd,sizeof (*cmd));if (++nvmeq->sq_tail == nvmeq->q_depth) nvmeq->sq_tail =0 ;nvme_write_sq_db (nvmeq, write_sq);
@@ -1465,6 +1468,7 @@ static int nvme_alloc_queue(struct nvme_dev *dev, int qid, int depth)if (dev->ctrl.queue_count > qid)return 0 ; + nvmeq->sqes = qid ? dev->io_sqes :NVME_NVM_ADMSQES ; nvmeq->q_depth = depth; nvmeq->cqes =dma_alloc_coherent (dev->dev,CQ_SIZE (nvmeq), &nvmeq->cq_dma_addr,GFP_KERNEL );
@@ -2317,6 +2321,7 @@ static int nvme_pci_enable(struct nvme_dev *dev) dev->ctrl.sqsize = dev->q_depth -1 ;/* 0's based queue depth */ dev->db_stride =1 <<NVME_CAP_STRIDE (dev->ctrl.cap); dev->dbs = dev->bar +4096 ; + dev->io_sqes =NVME_NVM_IOSQES ;/* * Temporary fix for the Apple controller found in the MacBook8,1 and
include/linux/nvme.h +1 -0
@@ -140,6 +140,7 @@ enum {* Submission and Completion Queue Entry Sizes for the NVM command set. * (In bytes and specified as a power of two (2^n)). */ +#define NVME_NVM_ADMSQES 6#define NVME_NVM_IOSQES 6#define NVME_NVM_IOCQES 4
Signature · 1 line
2.17.1
Re: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 3 lines · Benjamin Herrenschmidt
+#define
NVME_NVM_ADMSQES6
#defineNVME_NVM_IOSQES6
#defineNVME_NVM_IOCQES4
The NVM in the two defines here stands for the NVM command set, so this should just be named NVME_ADM_SQES or so. But except for this the patch looks good:
So maybe Sagi can just fix this up in the tree.
Re: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 6 lines · Christoph Hellwig
Quoted 3 lines · Benjamin Herrenschmidt
+#define
NVME_NVM_ADMSQES6
#defineNVME_NVM_IOSQES6
#defineNVME_NVM_IOCQES4
Quoted 8 lines
The NVM in the two defines here stands for the NVM command set, so this should just be named
NVME_ADM_SQESor so. But except for this
the patch looks good:Reviewed-by Christoph Hellwig <[email protected]>So maybe Sagi can just fix this up in the tree.
Ah ok I missed the meaning. Thanks. Sagi, can you fix that up or do you need me to resubmit ?
Cheers,
Ben.
Sagi Grimberg
maintainerRe: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 11 lines
Quoted 11 lines
Quoted 3 lines · wrote:
+#define
NVME_NVM_ADMSQES6
#defineNVME_NVM_IOSQES6
#defineNVME_NVM_IOCQES4The NVM in the two defines here stands for the NVM command set, so this should just be named
NVME_ADM_SQESor so. But except for this
the patch looks good:
Quoted 6 lines
Quoted 3 lines
Reviewed-by Christoph Hellwig <[email protected]>So maybe Sagi can just fix this up in the tree.
Ah ok I missed the meaning. Thanks. Sagi, can you fix that up or do you need me to resubmit ?
I'll fix it. Note that I'm going to take it out of the tree soon because it will have conflicts with Jens for-5.4/block, so we will send it to Jens after the initial merge window, after he rebases off of Linus.
Re: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 5 lines · Sagi Grimberg
Quoted 1 line
Quoted 1 line
I'll fix it. Note that I'm going to take it out of the tree soon because it will have conflicts with Jens for-5.4/block, so we will send it to Jens after the initial merge window, after he rebases off of Linus.
Conflicts too hard to fixup at merge time ? Otherwise I could just rebase on top of Jens and put in a topic branch...
Whatever works for you.
Cheers,
Ben.
Sagi Grimberg
maintainerRe: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 8 lines
Quoted 5 lines
I'll fix it. Note that I'm going to take it out of the tree soon because it will have conflicts with Jens for-5.4/block, so we will send it to Jens after the initial merge window, after he rebases off of Linus.
Conflicts too hard to fixup at merge time ? Otherwise I could just rebase on top of Jens and put in a topic branch...
The quirk enumeration conflicts with 5.3-rc. Not a big deal, just thought it'd be easier to handle that way.
Rebasing on top of Jens won't help because his for-5.4/block which does not have the rc code yet.
Re: [PATCH v4 2/4] nvme-pci: Add support for variable IO SQ element size
Quoted 5 lines · Sagi Grimberg
Quoted 5 lines
Quoted 4 lines
I'll fix it. Note that I'm going to take it out of the tree soon because it will have conflicts with Jens for-5.4/block, so we will send it to Jens after the initial merge window, after he rebases off of Linus.
Quoted 8 lines
Quoted 2 lines
Conflicts too hard to fixup at merge time ? Otherwise I could just rebase on top of Jens and put in a topic branch...
The quirk enumeration conflicts with 5.3-rc. Not a big deal, just thought it'd be easier to handle that way.
Rebasing on top of Jens won't help because his for-5.4/block which does not have the rc code yet.
Ok sure, do as you prefer. Let me know if you want me to do anything.
Cheers,
Ben.
PATCH v4 3/4 nvme-pci: Add support for Apple 2018+ models
In reply to Benjamin HerrenschmidtBased on reverse engineering and original patch by
Paul Pawlowski <paul at mrarm.io>
This adds support for Apple weird implementation of NVME in their 2018 or later machines. It accounts for the twice-as-big SQ entries for the IO queues, and the fact that only interrupt vector 0 appears to function properly.
--- drivers/nvme/host/nvme.h | 10 ++++++++++ drivers/nvme/host/pci.c | 21 ++++++++++++++++++++- 2 files changed, 30 insertions(+), 1 deletion(-)
drivers/nvme/host/nvme.h +10 -0
@@ -92,6 +92,16 @@ enum nvme_quirks {* Broken Write Zeroes. */ NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 <<9 ), + +/* +* Use only one interrupt vector for all queues +*/ +NVME_QUIRK_SINGLE_VECTOR = (1 <<10 ), + +/* +* Use non-standard 128 bytes SQEs. +*/ + NVME_QUIRK_128_BYTES_SQES = (1 << 11), };/*
drivers/nvme/host/pci.c +20 -1
@@ -2081,6 +2081,13 @@ static int nvme_setup_irqs(struct nvme_dev *dev, unsigned int nr_io_queues) dev->io_queues[HCTX_TYPE_DEFAULT ] =1 ; dev->io_queues[HCTX_TYPE_READ ] =0 ; +/* +* Some Apple controllers require all queues to use the +* first vector. +*/ +if (dev->ctrl.quirks &NVME_QUIRK_SINGLE_VECTOR ) + irq_queues =1 ; +return pci_alloc_irq_vectors_affinity (pdev,1 , irq_queues,PCI_IRQ_ALL_TYPES |PCI_IRQ_AFFINITY , &affd); }
@@ -2321,7 +2328,16 @@ static int nvme_pci_enable(struct nvme_dev *dev) dev->ctrl.sqsize = dev->q_depth -1 ;/* 0's based queue depth */ dev->db_stride =1 <<NVME_CAP_STRIDE (dev->ctrl.cap); dev->dbs = dev->bar +4096 ; - dev->io_sqes =NVME_NVM_IOSQES ; + +/* +* Some Apple controllers require a non-standard SQE size. +* Interestingly they also seem to ignore the CC:IOSQES register +* so we don't bother updating it here. +*/ +if (dev->ctrl.quirks &NVME_QUIRK_128_BYTES_SQES ) + dev->io_sqes =7 ; +else + dev->io_sqes =NVME_NVM_IOSQES ;/* * Temporary fix for the Apple controller found in the MacBook8,1 and
@@ -3039,6 +3055,9 @@ static const struct pci_device_id nvme_id_table[] = { { PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) }, { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2001) }, { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2003) }, + { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2005), + .driver_data = NVME_QUIRK_SINGLE_VECTOR | + NVME_QUIRK_128_BYTES_SQES }, { 0, } };MODULE_DEVICE_TABLE (pci, nvme_id_table);
Signature · 1 line
2.17.1
Re: [PATCH v4 3/4] nvme-pci: Add support for Apple 2018+ models
Quoted 11 lines · Benjamin Herrenschmidt
Based on reverse engineering and original patch by
Paul Pawlowski <[email protected]>
This adds support for Apple weird implementation of NVME in their 2018 or later machines. It accounts for the twice-as-big SQ entries for the IO queues, and the fact that only interrupt vector 0 appears to function properly.
Signed-off-by Benjamin Herrenschmidt <[email protected]>Reviewed-by Minwoo Im <[email protected]>
Looks good:
PATCH v4 4/4 nvme-pci: Support shared tags across queues for Apple 2018 controllers
In reply to Benjamin HerrenschmidtAnother issue with the Apple T2 based 2018 controllers seem to be that they blow up (and shut the machine down) if there's a tag collision between the IO queue and the Admin queue.
My suspicion is that they use our tags for their internal tracking and don't mix them with the queue id. They also seem to not like when tags go beyond the IO queue depth, ie 128 tags.
This adds a quirk that marks tags 0..31 of the IO queue reserved
--- drivers/nvme/host/nvme.h | 5 +++++ drivers/nvme/host/pci.c | 31 ++++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-)
drivers/nvme/host/nvme.h +5 -0
@@ -102,6 +102,11 @@ enum nvme_quirks {* Use non-standard 128 bytes SQEs. */ NVME_QUIRK_128_BYTES_SQES = (1 <<11 ), + +/* +* Prevent tag overlap between queues +*/ + NVME_QUIRK_SHARED_TAGS = (1 << 12), };/*
drivers/nvme/host/pci.c +30 -1
@@ -2106,6 +2106,14 @@ static int nvme_setup_io_queues(struct nvme_dev *dev)unsigned long size; nr_io_queues =max_io_queues (); + +/* +* If tags are shared with admin queue (Apple bug), then +* make sure we only use one IO queue. +*/ +if (dev->ctrl.quirks &NVME_QUIRK_SHARED_TAGS ) + nr_io_queues =1 ; + result =nvme_set_queue_count (&dev->ctrl, &nr_io_queues);if (result <0 )return result;
@@ -2276,6 +2284,14 @@ static int nvme_dev_add(struct nvme_dev *dev) dev->tagset.flags =BLK_MQ_F_SHOULD_MERGE ; dev->tagset.driver_data = dev; +/* +* Some Apple controllers requires tags to be unique +* across admin and IO queue, so reserve the first 32 +* tags of the IO queue. +*/ +if (dev->ctrl.quirks &NVME_QUIRK_SHARED_TAGS ) + dev->tagset.reserved_tags =NVME_AQ_DEPTH ; + ret =blk_mq_alloc_tag_set (&dev->tagset);if (ret) { dev_warn(dev->ctrl.device,
@@ -2356,6 +2372,18 @@ static int nvme_pci_enable(struct nvme_dev *dev) "set queue depth=%u\n", dev->q_depth); } +/* +* Controllers with the shared tags quirk need the IO queue to be +* big enough so that we get 32 tags for the admin queue +*/ +if ((dev->ctrl.quirks &NVME_QUIRK_SHARED_TAGS ) && + (dev->q_depth < (NVME_AQ_DEPTH +2 ))) { + dev->q_depth =NVME_AQ_DEPTH +2 ; +dev_warn (dev->ctrl.device,"IO queue depth clamped to %d\n" , + dev->q_depth); + } + +nvme_map_cmb (dev);pci_enable_pcie_error_reporting (pdev);
@@ -3057,7 +3085,8 @@ static const struct pci_device_id nvme_id_table[] = { { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2003) }, { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2005), .driver_data =NVME_QUIRK_SINGLE_VECTOR | - NVME_QUIRK_128_BYTES_SQES }, +NVME_QUIRK_128_BYTES_SQES | + NVME_QUIRK_SHARED_TAGS }, { 0, } };MODULE_DEVICE_TABLE (pci, nvme_id_table);
Signature · 1 line
2.17.1
Re: [PATCH v4 4/4] nvme-pci: Support shared tags across queues for Apple 2018 controllers
Quoted 9 lines · Benjamin Herrenschmidt
Another issue with the Apple T2 based 2018 controllers seem to be that they blow up (and shut the machine down) if there's a tag collision between the IO queue and the Admin queue.
My suspicion is that they use our tags for their internal tracking and don't mix them with the queue id. They also seem to not like when tags go beyond the IO queue depth, ie 128 tags.
This adds a quirk that marks tags 0..31 of the IO queue reserved
What a mess. But given how widely available the macbooks are supporting them makes sense:
Sagi Grimberg
maintainerQuoted 9 lines
This series combines the original series and an updated version of the shared tags patch, and is rebased on nvme-5.4.
This adds support for the controller found in recent Apple machines which is basically a SW emulated NVME controller in the T2 chip.
The original reverse engineering work was done by
Paul Pawlowski <paul at mrarm.io>.
Thanks, pulled to nvme-5.4
v4 cover nvme-pci: Support for Apple 201+ (T2 chip)
Quoted 11 lines · Sagi Grimberg
Quoted 9 lines
This series combines the original series and an updated version of the
shared tags patch, and is rebased on nvme-5.4.This adds support for the controller found in recent Apple machines which is basically a SW emulated NVME controller in the T2 chip.
The original reverse engineering work was done by
Paul Pawlowski <paul at mrarm.io>.Thanks, pulled to nvme-5.4
Thanks !
Cheers,
Ben.