PCI: Add save and restore capability for TPH config space
PATCH v6 1/1 PCI: Add save and restore capability for TPH config space
From: paul luse <[email protected]>
The PCI subsystem does not currently save and restore the configuration space for the Transaction Layer Processing Hints (TPH) capability, leading to the possibility of configuration loss in some scenarios. For more information please refer to PCIe r6.0 sec 6.17.
This was discovered working on the Storage Performance Development Kit (SPDK) project (see https://spdk.io/) where we typically unbind devices from their native kernel driver and bind to VFIO for use with our own user space drivers. The process of binding to VFIO results in the loss of TPH settings due to the resulting PCI reset.
---
Log: v1-v3: Misc review feedback before I knew to add a log
V4: changed tph declaration from int to u16
V5: removed TPH as a kernel option
V6: Updated commit message per feedback, added log
drivers/pci/pci.c | 2 + drivers/pci/pci.h | 4 ++ drivers/pci/pcie/Makefile | 1 + drivers/pci/pcie/tph.c | 93 +++++++++++++++++++++++++++++++++++ drivers/pci/probe.c | 1 + include/uapi/linux/pci_regs.h | 2 + 6 files changed, 103 insertions(+) create mode 100644 drivers/pci/pcie/tph.c
drivers/pci/pci.c +2 -0
@@ -1670,6 +1670,7 @@ int pci_save_state(struct pci_dev *dev)pci_save_dpc_state (dev);pci_save_aer_state (dev);pci_save_ptm_state (dev); +pci_save_tph_state (dev);return pci_save_vc_state (dev); }EXPORT_SYMBOL (pci_save_state);
@@ -1782,6 +1783,7 @@ void pci_restore_state(struct pci_dev *dev)pci_restore_rebar_state (dev);pci_restore_dpc_state (dev);pci_restore_ptm_state (dev); +pci_restore_tph_state (dev);pci_aer_clear_status (dev);pci_restore_aer_state (dev);
drivers/pci/pci.h +4 -0
@@ -514,6 +514,10 @@ static inline void pci_restore_ptm_state(struct pci_dev *dev) { }static inline void pci_disable_ptm (struct pci_dev *dev) { }#endif +void pci_save_tph_state (struct pci_dev *dev); +void pci_restore_tph_state (struct pci_dev *dev); +void pci_tph_init (struct pci_dev *dev); +unsigned long pci_cardbus_resource_alignment (struct resource *); static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
drivers/pci/pcie/Makefile +1 -0
@@ -3,6 +3,7 @@ # Makefile for PCI Express features and port driver pcieportdrv-y := portdrv_core.o portdrv_pci.o rcec.o +obj-y += tph.o obj-$(CONFIG_PCIEPORTBUS) += pcieportdrv.o
drivers/pci/pcie/tph.c new file +93 -0
93 lines not on this page · raw message
drivers/pci/probe.c +1 -0
@@ -2464,6 +2464,7 @@ static void pci_init_capabilities(struct pci_dev *dev)pci_aer_init (dev);/* Advanced Error Reporting */ pci_dpc_init (dev);/* Downstream Port Containment */ pci_rcec_init (dev);/* Root Complex Event Collector */ +pci_tph_init (dev);/* Transaction Layer Packet Processing Hints */ pcie_report_downtraining (dev);pci_init_reset_methods (dev);
include/uapi/linux/pci_regs.h +2 -0
@@ -1020,6 +1020,8 @@#define PCI_TPH_LOC_MSIX 0x400/* in MSI-X */ #define PCI_TPH_CAP_ST_MASK 0x07FF0000/* ST table mask */ #define PCI_TPH_CAP_ST_SHIFT 16/* ST table shift */ +#define PCI_TPH_CTL 8/* control offset */ +#define PCI_TPH_ST_TBL 0xc/* ST table offset */ #define PCI_TPH_BASE_SIZEOF 0xc/* size with no ST table */ /* Downstream Port Containment */
Signature · 1 line
2.34.3
Quoted 16 lines · Paul Luse
drivers/pci/pcie/tph.c new file +16
-0+void pci_save_tph_state (struct pci_dev *dev) +{ +struct pci_cap_saved_state *save_state; +int num_entries, i, offset; +u16 *st_entry, tph; +u32 *cap; + + tph =pci_find_ext_capability (dev,PCI_EXT_CAP_ID_TPH ); +if (!tph) +return ; + + save_state =pci_find_saved_ext_cap (dev,PCI_EXT_CAP_ID_TPH ); +if (!save_state) +return ; + +/* Save control register as well as all ST entries */
drivers/pci/pcie/tph.c line 48
Quoted 10 lines
drivers/pci/pcie/tph.c new file +10
-0+ cap = &save_state->cap.data[0 ]; +pci_read_config_dword (dev, tph +PCI_TPH_CTL , cap++); + st_entry = (u16 *)cap; + offset =PCI_TPH_ST_TBL ; + num_entries =pci_get_tph_st_num_entries (dev, tph); +for (i =0 ; i < num_entries; i++) { +pci_read_config_word (dev, tph + offset, st_entry++); + offset +=sizeof (u16); + } +}
It has just occurred to me that a small optimization would be possible here:
num_entries = save_state->cap.size - sizeof(u32);
Though your approach is probably more readable.
Quoted 7 lines
drivers/pci/pcie/tph.c new file +7
-0+void pci_tph_init (struct pci_dev *dev) +{ +int num_entries; +u32 save_size; +u16 tph; + +if (!pci_is_pcie (dev))
drivers/pci/pcie/tph.c line 93
Quoted 10 lines
drivers/pci/pcie/tph.c new file +10
-0+return ; + + tph =pci_find_ext_capability (dev,PCI_EXT_CAP_ID_TPH ); +if (!tph) +return ; + + num_entries =pci_get_tph_st_num_entries (dev, tph); + save_size =sizeof (int ) + num_entries *sizeof (u16); +pci_add_ext_cap_save_buffer (dev,PCI_EXT_CAP_ID_TPH , save_size); +}
sizeof(u32) instead of sizeof(int) is probably more appropriate to account for the Control register. I can never remember if sizeof(int) is 4 or 8 on a 64-bit architecture, but I guess it's 4.
Either way, this is
Thanks,
Lukas