diff mbox series

[v2,1/3] PCI: Add check for CXL Secondary Bus Reset

Message ID 20240325235914.1897647-2-dave.jiang@intel.com (mailing list archive)
State Superseded
Headers show
Series PCI: Add Secondary Bus Reset (SBR) support for CXL | expand

Commit Message

Dave Jiang March 25, 2024, 11:58 p.m. UTC
Per CXL spec r3.1 8.1.5.2, secondary bus reset is masked unless the
"Unmask SBR" bit is set. Add a check to the PCI secondary bus reset
path to fail the CXL SBR request if the "Unmask SBR" bit is clear in
the CXL Port Control Extensions register by returning -ENOTTY.

With the current behavior, the bus_reset would appear to have executed
successfully, however the operation is actually masked if the "Unmask
SBR" bit is set with the default value. The intention is to inform the
user that SBR for the CXL device is masked and will not go through.

The expectation is that if a user overrides the "Unmask SBR" via a
user tool such as setpci then they can trigger a bus reset successfully.

Link: https://lore.kernel.org/linux-cxl/20240220203956.GA1502351@bhelgaas/
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
v2:
- Rename is_cxl_device() to pci_is_cxl(). (Lukas)
- Inverse xmas tree var declaration for is_cxl_port_sbr_masked(). (Lukas)
- Return -ENOTTY on error of reset method. (Lukas)
- Use pci_upstream_bridge() instead of dev->bus->self. (Lukas)
- Additional explanation in commit log on behavior. (Lukas)
---
 drivers/cxl/cxlpci.h          |  2 --
 drivers/pci/pci.c             | 45 +++++++++++++++++++++++++++++++++++
 include/uapi/linux/pci_regs.h |  7 ++++++
 3 files changed, 52 insertions(+), 2 deletions(-)

Comments

Bjorn Helgaas March 27, 2024, 9:26 p.m. UTC | #1
On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:
> Per CXL spec r3.1 8.1.5.2, secondary bus reset is masked unless the
> "Unmask SBR" bit is set. Add a check to the PCI secondary bus reset
> path to fail the CXL SBR request if the "Unmask SBR" bit is clear in
> the CXL Port Control Extensions register by returning -ENOTTY.

s/secondary bus reset/Secondary Bus Reset (SBR)/
to show that this is defined by PCIe spec and introduce the
initialism.

> With the current behavior, the bus_reset would appear to have executed
> successfully, however the operation is actually masked if the "Unmask
> SBR" bit is set with the default value. The intention is to inform the
> user that SBR for the CXL device is masked and will not go through.

The default value of Unmask SBR isn't really relevant here.

> The expectation is that if a user overrides the "Unmask SBR" via a
> user tool such as setpci then they can trigger a bus reset successfully.

... if a user *sets* Unmask SBR ...
to be more specific about what value is required.

> Link: https://lore.kernel.org/linux-cxl/20240220203956.GA1502351@bhelgaas/
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
> v2:
> - Rename is_cxl_device() to pci_is_cxl(). (Lukas)
> - Inverse xmas tree var declaration for is_cxl_port_sbr_masked(). (Lukas)
> - Return -ENOTTY on error of reset method. (Lukas)
> - Use pci_upstream_bridge() instead of dev->bus->self. (Lukas)
> - Additional explanation in commit log on behavior. (Lukas)
> ---
>  drivers/cxl/cxlpci.h          |  2 --
>  drivers/pci/pci.c             | 45 +++++++++++++++++++++++++++++++++++
>  include/uapi/linux/pci_regs.h |  7 ++++++
>  3 files changed, 52 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/cxl/cxlpci.h b/drivers/cxl/cxlpci.h
> index 93992a1c8eec..55be4dccbed0 100644
> --- a/drivers/cxl/cxlpci.h
> +++ b/drivers/cxl/cxlpci.h
> @@ -13,10 +13,8 @@
>   * "DVSEC" redundancies removed. When obvious, abbreviations may be used.
>   */
>  #define PCI_DVSEC_HEADER1_LENGTH_MASK	GENMASK(31, 20)
> -#define PCI_DVSEC_VENDOR_ID_CXL		0x1E98
>  
>  /* CXL 2.0 8.1.3: PCIe DVSEC for CXL Device */
> -#define CXL_DVSEC_PCIE_DEVICE					0
>  #define   CXL_DVSEC_CAP_OFFSET		0xA
>  #define     CXL_DVSEC_MEM_CAPABLE	BIT(2)
>  #define     CXL_DVSEC_HDM_COUNT_MASK	GENMASK(5, 4)
> diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c
> index e5f243dd4288..259e5d6538bb 100644
> --- a/drivers/pci/pci.c
> +++ b/drivers/pci/pci.c
> @@ -4927,10 +4927,55 @@ static int pci_dev_reset_slot_function(struct pci_dev *dev, bool probe)
>  	return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
>  }
>  
> +static bool pci_is_cxl(struct pci_dev *dev)
> +{
> +	return pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
> +					 CXL_DVSEC_PCIE_DEVICE);
> +}
> +
> +static bool is_cxl_port_sbr_masked(struct pci_dev *dev)

s/is_cxl_port_sbr_masked/cxl_sbr_masked/ or similar

> +{
> +	int dvsec;

u16

> +	u16 reg;
> +	int rc;
> +
> +	/*
> +	 * No DVSEC found, must not be CXL port.
> +	 */
> +	dvsec = pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
> +					  CXL_DVSEC_PCIE_PORT);
> +	if (!dvsec)
> +		return false;
> +
> +	rc = pci_read_config_word(dev, dvsec + CXL_DVSEC_PORT_CONTROL, &reg);
> +	if (rc)
> +		return true;
> +
> +	/*
> +	 * CXL spec r3.1 8.1.5.2
> +	 * When 0, SBR bit in Bridge Control register of this Port has no effect.
> +	 * When 1, the Port shall generate hot reset when SBR bit in Bridge
> +	 * Control gets set to 1.
> +	 */
> +	if (reg & CXL_DVSEC_PORT_CONTROL_UNMASK_SBR)
> +		return false;
> +
> +	return true;
> +}
> +
>  static int pci_reset_bus_function(struct pci_dev *dev, bool probe)
>  {
> +	struct pci_dev *bridge = pci_upstream_bridge(dev);
>  	int rc;
>  
> +	/* If it's a CXL port and the SBR control is masked, fail the SBR */
> +	if (pci_is_cxl(dev) && bridge && is_cxl_port_sbr_masked(bridge)) {

This sounds like solely a property of the bridge, so why do we care
what "dev" is?  I assume SBR is asserted in the standard PCIe way, and
the only question is whether the bridge itself masks it.  Would this
be enough?

  if (bridge && is_cxl_port_sbr_masked(bridge))

> +		if (probe)
> +			return 0;
> +
> +		return -ENOTTY;
> +	}
> +
>  	rc = pci_dev_reset_slot_function(dev, probe);
>  	if (rc != -ENOTTY)
>  		return rc;
> diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
> index a39193213ff2..5f2c66987299 100644
> --- a/include/uapi/linux/pci_regs.h
> +++ b/include/uapi/linux/pci_regs.h
> @@ -1148,4 +1148,11 @@
>  #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_PROTOCOL		0x00ff0000
>  #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_NEXT_INDEX	0xff000000
>  
> +/* Compute Express Link (CXL) */
> +#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98

I see that you're just moving this #define from drivers/cxl/cxlpci.h,
but I'm scratching my head a bit.  As used here, this is to match the
DVSEC Vendor ID (PCIe r6.0, sec 7.9.6.2).

IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
"PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
name, and would normally be defined in include/linux/pci_ids.h.

But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
value "1e98" in the PCI SIG list at
https://pcisig.com/membership/member-companies.

> +#define CXL_DVSEC_PCIE_DEVICE				0

I think this is the "DVSEC ID" (PCIe r6.0, sec 7.9.6.3), right?  And
the "0" value comes from CXL r3.1, sec 8.1.3?

Sec 8.1.3 says "Software may use the presence of this DVSEC to
differentiate between a CXL device and a PCIe device. As such, a
standard PCIe device must not expose this DVSEC."

I think the "PCIE" in the name here may end up being confusing since
the presence of this DVSEC means the device is a CXL device, *not* a
standard PCIe device.

> +#define CXL_DVSEC_PCIE_PORT				3

And "3" comes from CXL r3.1, sec 8.1.5?

Same here; I'm not sure "PCIE" should be in the name, or maybe it
should be at a different place, e.g., "PCI_DVSEC_CXL_PORT" or
something, since this DVSEC controls CXL-specific things.

I kind of think a "PCI_DVSEC_" prefix might be appropriate since
PCI is where the DVSEC concept is defined, and then the more specific
details can follow

> +#define CXL_DVSEC_PORT_CONTROL				0x0c
> +#define  CXL_DVSEC_PORT_CONTROL_UNMASK_SBR		0x00000001

s/CONTROL/CTL/ (or CTRL, though CTL is more common in this file)

Bjorn
Dave Jiang March 27, 2024, 11:57 p.m. UTC | #2
On 3/27/24 2:26 PM, Bjorn Helgaas wrote:
> On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:
>> Per CXL spec r3.1 8.1.5.2, secondary bus reset is masked unless the
>> "Unmask SBR" bit is set. Add a check to the PCI secondary bus reset
>> path to fail the CXL SBR request if the "Unmask SBR" bit is clear in
>> the CXL Port Control Extensions register by returning -ENOTTY.
> 
> s/secondary bus reset/Secondary Bus Reset (SBR)/
> to show that this is defined by PCIe spec and introduce the
> initialism.

ok will fix
> 
>> With the current behavior, the bus_reset would appear to have executed
>> successfully, however the operation is actually masked if the "Unmask
>> SBR" bit is set with the default value. The intention is to inform the
>> user that SBR for the CXL device is masked and will not go through.
> 
> The default value of Unmask SBR isn't really relevant here.

Changing to:
    When the "Unmask SBR" bit is set to 0 (default), the bus_reset would
    appear to have executed successfully. However the operation is actually
    masked. The intention is to inform the user that SBR for the CXL device
    is masked and will not go through.

> 
>> The expectation is that if a user overrides the "Unmask SBR" via a
>> user tool such as setpci then they can trigger a bus reset successfully.
> 
> ... if a user *sets* Unmask SBR ...
> to be more specific about what value is required.
> 

    If a user overrides the "Unmask SBR" via a user tool such as setpci and
    sets the value to 1, then the bus reset will execute successfully.


>> Link: https://lore.kernel.org/linux-cxl/20240220203956.GA1502351@bhelgaas/
>> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
>> ---
>> v2:
>> - Rename is_cxl_device() to pci_is_cxl(). (Lukas)
>> - Inverse xmas tree var declaration for is_cxl_port_sbr_masked(). (Lukas)
>> - Return -ENOTTY on error of reset method. (Lukas)
>> - Use pci_upstream_bridge() instead of dev->bus->self. (Lukas)
>> - Additional explanation in commit log on behavior. (Lukas)
>> ---
>>  drivers/cxl/cxlpci.h          |  2 --
>>  drivers/pci/pci.c             | 45 +++++++++++++++++++++++++++++++++++
>>  include/uapi/linux/pci_regs.h |  7 ++++++
>>  3 files changed, 52 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/cxl/cxlpci.h b/drivers/cxl/cxlpci.h
>> index 93992a1c8eec..55be4dccbed0 100644
>> --- a/drivers/cxl/cxlpci.h
>> +++ b/drivers/cxl/cxlpci.h
>> @@ -13,10 +13,8 @@
>>   * "DVSEC" redundancies removed. When obvious, abbreviations may be used.
>>   */
>>  #define PCI_DVSEC_HEADER1_LENGTH_MASK	GENMASK(31, 20)
>> -#define PCI_DVSEC_VENDOR_ID_CXL		0x1E98
>>  
>>  /* CXL 2.0 8.1.3: PCIe DVSEC for CXL Device */
>> -#define CXL_DVSEC_PCIE_DEVICE					0
>>  #define   CXL_DVSEC_CAP_OFFSET		0xA
>>  #define     CXL_DVSEC_MEM_CAPABLE	BIT(2)
>>  #define     CXL_DVSEC_HDM_COUNT_MASK	GENMASK(5, 4)
>> diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c
>> index e5f243dd4288..259e5d6538bb 100644
>> --- a/drivers/pci/pci.c
>> +++ b/drivers/pci/pci.c
>> @@ -4927,10 +4927,55 @@ static int pci_dev_reset_slot_function(struct pci_dev *dev, bool probe)
>>  	return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
>>  }
>>  
>> +static bool pci_is_cxl(struct pci_dev *dev)
>> +{
>> +	return pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
>> +					 CXL_DVSEC_PCIE_DEVICE);
>> +}
>> +
>> +static bool is_cxl_port_sbr_masked(struct pci_dev *dev)
> 
> s/is_cxl_port_sbr_masked/cxl_sbr_masked/ or similar

will update

> 
>> +{
>> +	int dvsec;
> 
> u16
> 

ok

>> +	u16 reg;
>> +	int rc;
>> +
>> +	/*
>> +	 * No DVSEC found, must not be CXL port.
>> +	 */
>> +	dvsec = pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
>> +					  CXL_DVSEC_PCIE_PORT);
>> +	if (!dvsec)
>> +		return false;
>> +
>> +	rc = pci_read_config_word(dev, dvsec + CXL_DVSEC_PORT_CONTROL, &reg);
>> +	if (rc)
>> +		return true;
>> +
>> +	/*
>> +	 * CXL spec r3.1 8.1.5.2
>> +	 * When 0, SBR bit in Bridge Control register of this Port has no effect.
>> +	 * When 1, the Port shall generate hot reset when SBR bit in Bridge
>> +	 * Control gets set to 1.
>> +	 */
>> +	if (reg & CXL_DVSEC_PORT_CONTROL_UNMASK_SBR)
>> +		return false;
>> +
>> +	return true;
>> +}
>> +
>>  static int pci_reset_bus_function(struct pci_dev *dev, bool probe)
>>  {
>> +	struct pci_dev *bridge = pci_upstream_bridge(dev);
>>  	int rc;
>>  
>> +	/* If it's a CXL port and the SBR control is masked, fail the SBR */
>> +	if (pci_is_cxl(dev) && bridge && is_cxl_port_sbr_masked(bridge)) {
> 
> This sounds like solely a property of the bridge, so why do we care
> what "dev" is?  I assume SBR is asserted in the standard PCIe way, and
> the only question is whether the bridge itself masks it.  Would this
> be enough?
> 
>   if (bridge && is_cxl_port_sbr_masked(bridge))

Yes that should work. I'll drop pci_is_cxl() and related bits

> 
>> +		if (probe)
>> +			return 0;
>> +
>> +		return -ENOTTY;
>> +	}
>> +
>>  	rc = pci_dev_reset_slot_function(dev, probe);
>>  	if (rc != -ENOTTY)
>>  		return rc;
>> diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
>> index a39193213ff2..5f2c66987299 100644
>> --- a/include/uapi/linux/pci_regs.h
>> +++ b/include/uapi/linux/pci_regs.h
>> @@ -1148,4 +1148,11 @@
>>  #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_PROTOCOL		0x00ff0000
>>  #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_NEXT_INDEX	0xff000000
>>  
>> +/* Compute Express Link (CXL) */
>> +#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98
> 
> I see that you're just moving this #define from drivers/cxl/cxlpci.h,
> but I'm scratching my head a bit.  As used here, this is to match the
> DVSEC Vendor ID (PCIe r6.0, sec 7.9.6.2).
> 
> IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
> "PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
> name, and would normally be defined in include/linux/pci_ids.h.
> 
> But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
> value "1e98" in the PCI SIG list at
> https://pcisig.com/membership/member-companies.
> 
I'll create a new patch and move to include/linux/pci_ids.h first for this define and change to PCI_VENDOR_ID_CXL. The value is defined in CXL spec r3.1 sec 8.1.1.

diff --git a/include/linux/pci_ids.h b/include/linux/pci_ids.h
index a0c75e467df3..7dfbf6d96b3d 100644
--- a/include/linux/pci_ids.h
+++ b/include/linux/pci_ids.h
@@ -2607,6 +2607,8 @@
 
 #define PCI_VENDOR_ID_ALIBABA          0x1ded
 
+#define PCI_VENDOR_ID_CXL              0x1e98
+
 #define PCI_VENDOR_ID_TEHUTI           0x1fc9
 #define PCI_DEVICE_ID_TEHUTI_3009      0x3009
 #define PCI_DEVICE_ID_TEHUTI_3010      0x3010


>> +#define CXL_DVSEC_PCIE_DEVICE				0
> 
> I think this is the "DVSEC ID" (PCIe r6.0, sec 7.9.6.3), right?  And
> the "0" value comes from CXL r3.1, sec 8.1.3?

I'll leave this define alone for now since it's not needed anymore with dropping the CXL device check.
> 
> Sec 8.1.3 says "Software may use the presence of this DVSEC to
> differentiate between a CXL device and a PCIe device. As such, a
> standard PCIe device must not expose this DVSEC."
> 
> I think the "PCIE" in the name here may end up being confusing since
> the presence of this DVSEC means the device is a CXL device, *not* a
> standard PCIe device.
> 
>> +#define CXL_DVSEC_PCIE_PORT				3
> 
> And "3" comes from CXL r3.1, sec 8.1.5?
> 
> Same here; I'm not sure "PCIE" should be in the name, or maybe it
> should be at a different place, e.g., "PCI_DVSEC_CXL_PORT" or
> something, since this DVSEC controls CXL-specific things.
> 
> I kind of think a "PCI_DVSEC_" prefix might be appropriate since
> PCI is where the DVSEC concept is defined, and then the more specific
> details can follow

Will rename to PCI_DVSEC_CXL_PORT*

> 
>> +#define CXL_DVSEC_PORT_CONTROL				0x0c
>> +#define  CXL_DVSEC_PORT_CONTROL_UNMASK_SBR		0x00000001
> 
> s/CONTROL/CTL/ (or CTRL, though CTL is more common in this file)

ok

> 
> Bjorn
>
Dan Williams March 28, 2024, 1:43 a.m. UTC | #3
Dave Jiang wrote:
> Per CXL spec r3.1 8.1.5.2, secondary bus reset is masked unless the
> "Unmask SBR" bit is set. Add a check to the PCI secondary bus reset
> path to fail the CXL SBR request if the "Unmask SBR" bit is clear in
> the CXL Port Control Extensions register by returning -ENOTTY.
> 
> With the current behavior, the bus_reset would appear to have executed
> successfully, however the operation is actually masked if the "Unmask
> SBR" bit is set with the default value. The intention is to inform the
> user that SBR for the CXL device is masked and will not go through.
> 
> The expectation is that if a user overrides the "Unmask SBR" via a
> user tool such as setpci then they can trigger a bus reset successfully.
> 
> Link: https://lore.kernel.org/linux-cxl/20240220203956.GA1502351@bhelgaas/
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
[..]
> diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c
> index e5f243dd4288..259e5d6538bb 100644
> --- a/drivers/pci/pci.c
> +++ b/drivers/pci/pci.c
> @@ -4927,10 +4927,55 @@ static int pci_dev_reset_slot_function(struct pci_dev *dev, bool probe)
>  	return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
>  }
>  
> +static bool pci_is_cxl(struct pci_dev *dev)
> +{
> +	return pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
> +					 CXL_DVSEC_PCIE_DEVICE);
> +}
> +
> +static bool is_cxl_port_sbr_masked(struct pci_dev *dev)
> +{
> +	int dvsec;
> +	u16 reg;
> +	int rc;
> +
> +	/*
> +	 * No DVSEC found, must not be CXL port.
> +	 */

This comment is unfortunately not correct. Per CXL 9.12.3 "Enumerating
CXL RPs and DSPs", the CXL_DVSEC_PCIE_PORT disappears when no endpoint
is connected. So the comment should be:

/*
 * No DVSEC found, either is not a CXL port, or not connected in which
 * case mask state is a nop (CXL 3.1 9.12.3 "Enumerating CXL RPs and DSPs") 
 */

> +	dvsec = pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
> +					  CXL_DVSEC_PCIE_PORT);
> +	if (!dvsec)
> +		return false;
> +
> +	rc = pci_read_config_word(dev, dvsec + CXL_DVSEC_PORT_CONTROL, &reg);
> +	if (rc)
> +		return true;

If the link gets disconnected after the above check but before reading
the register the value returned *should* be 0xffff which should
naturally indicate that reset is not masked.
Bjorn Helgaas March 28, 2024, 5:38 p.m. UTC | #4
On Wed, Mar 27, 2024 at 04:57:40PM -0700, Dave Jiang wrote:
> On 3/27/24 2:26 PM, Bjorn Helgaas wrote:
> > On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:

> >> With the current behavior, the bus_reset would appear to have executed
> >> successfully, however the operation is actually masked if the "Unmask
> >> SBR" bit is set with the default value. The intention is to inform the
> >> user that SBR for the CXL device is masked and will not go through.
> > 
> > The default value of Unmask SBR isn't really relevant here.
> 
> Changing to:
>     When the "Unmask SBR" bit is set to 0 (default), the bus_reset would
>     appear to have executed successfully. However the operation is actually
>     masked. The intention is to inform the user that SBR for the CXL device
>     is masked and will not go through.
> 
> > 
> >> The expectation is that if a user overrides the "Unmask SBR" via a
> >> user tool such as setpci then they can trigger a bus reset successfully.
> > 
> > ... if a user *sets* Unmask SBR ...
> > to be more specific about what value is required.
> > 
> 
>     If a user overrides the "Unmask SBR" via a user tool such as setpci and
>     sets the value to 1, then the bus reset will execute successfully.

I'm not super enamored with the "if a user overrides" language because
a driver may change that bit in the future, and then the suggestion of
a "user" will be misleading.

It doesn't matter *how* it gets set to 1; it only matters that SBR
doesn't work when "Unmask SBR" is 0 and it does work when "Unmask SBR"
is 1.

> >> +/* Compute Express Link (CXL) */
> >> +#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98
> > 
> > I see that you're just moving this #define from drivers/cxl/cxlpci.h,
> > but I'm scratching my head a bit.  As used here, this is to match the
> > DVSEC Vendor ID (PCIe r6.0, sec 7.9.6.2).
> > 
> > IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
> > "PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
> > name, and would normally be defined in include/linux/pci_ids.h.
> > 
> > But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
> > value "1e98" in the PCI SIG list at
> > https://pcisig.com/membership/member-companies.
> > 
> I'll create a new patch and move to include/linux/pci_ids.h first
> for this define and change to PCI_VENDOR_ID_CXL. The value is
> defined in CXL spec r3.1 sec 8.1.1.

I saw the CXL mentions of 0x1e98, but IMO that's not an authoritative
source; no vendor is allowed to just squat on a Vendor ID value simply
by mentioning it in their own internal specs.  That would obviously
lead to madness.

The footnote in CXL r3.1, sec 3.1.2, about how the 1E98h value is only
for use in DVSEC etc., is really weird.

IIUC, the PCI SIG controls the Vendor ID namespace, so I'm still
really confused about why it is not reserved there.  I emailed the PCI
SIG, but the footnote suggests to me that there some kind of history
here that I don't know.

Anyway, I think all we can do here is to put the definition in
include/linux/pci_ids.h as you did and hope 0x1e98 is never allocated
to another vendor.

> diff --git a/include/linux/pci_ids.h b/include/linux/pci_ids.h
> index a0c75e467df3..7dfbf6d96b3d 100644
> --- a/include/linux/pci_ids.h
> +++ b/include/linux/pci_ids.h
> @@ -2607,6 +2607,8 @@
>  
>  #define PCI_VENDOR_ID_ALIBABA          0x1ded
>  
> +#define PCI_VENDOR_ID_CXL              0x1e98
> +
>  #define PCI_VENDOR_ID_TEHUTI           0x1fc9
>  #define PCI_DEVICE_ID_TEHUTI_3009      0x3009
>  #define PCI_DEVICE_ID_TEHUTI_3010      0x3010
Dan Williams March 28, 2024, 7:03 p.m. UTC | #5
Bjorn Helgaas wrote:
> On Wed, Mar 27, 2024 at 04:57:40PM -0700, Dave Jiang wrote:
> > On 3/27/24 2:26 PM, Bjorn Helgaas wrote:
> > > On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:
> 
> > >> With the current behavior, the bus_reset would appear to have executed
> > >> successfully, however the operation is actually masked if the "Unmask
> > >> SBR" bit is set with the default value. The intention is to inform the
> > >> user that SBR for the CXL device is masked and will not go through.
> > > 
> > > The default value of Unmask SBR isn't really relevant here.
> > 
> > Changing to:
> >     When the "Unmask SBR" bit is set to 0 (default), the bus_reset would
> >     appear to have executed successfully. However the operation is actually
> >     masked. The intention is to inform the user that SBR for the CXL device
> >     is masked and will not go through.
> > 
> > > 
> > >> The expectation is that if a user overrides the "Unmask SBR" via a
> > >> user tool such as setpci then they can trigger a bus reset successfully.
> > > 
> > > ... if a user *sets* Unmask SBR ...
> > > to be more specific about what value is required.
> > > 
> > 
> >     If a user overrides the "Unmask SBR" via a user tool such as setpci and
> >     sets the value to 1, then the bus reset will execute successfully.
> 
> I'm not super enamored with the "if a user overrides" language because
> a driver may change that bit in the future, and then the suggestion of
> a "user" will be misleading.
> 
> It doesn't matter *how* it gets set to 1; it only matters that SBR
> doesn't work when "Unmask SBR" is 0 and it does work when "Unmask SBR"
> is 1.
> 
> > >> +/* Compute Express Link (CXL) */
> > >> +#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98
> > > 
> > > I see that you're just moving this #define from drivers/cxl/cxlpci.h,
> > > but I'm scratching my head a bit.  As used here, this is to match the
> > > DVSEC Vendor ID (PCIe r6.0, sec 7.9.6.2).
> > > 
> > > IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
> > > "PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
> > > name, and would normally be defined in include/linux/pci_ids.h.
> > > 
> > > But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
> > > value "1e98" in the PCI SIG list at
> > > https://pcisig.com/membership/member-companies.
> > > 
> > I'll create a new patch and move to include/linux/pci_ids.h first
> > for this define and change to PCI_VENDOR_ID_CXL. The value is
> > defined in CXL spec r3.1 sec 8.1.1.
> 
> I saw the CXL mentions of 0x1e98, but IMO that's not an authoritative
> source; no vendor is allowed to just squat on a Vendor ID value simply
> by mentioning it in their own internal specs.  That would obviously
> lead to madness.
> 
> The footnote in CXL r3.1, sec 3.1.2, about how the 1E98h value is only
> for use in DVSEC etc., is really weird.
> 
> IIUC, the PCI SIG controls the Vendor ID namespace, so I'm still
> really confused about why it is not reserved there.  I emailed the PCI
> SIG, but the footnote suggests to me that there some kind of history
> here that I don't know.
> 
> Anyway, I think all we can do here is to put the definition in
> include/linux/pci_ids.h as you did and hope 0x1e98 is never allocated
> to another vendor.

Oh, true, I think this should be PCI_DVSEC_VENDOR_ID_CXL, because afaics
it is still possible that 0x1e98 be used as a non-DVSEC vendor-id in
some future device.

In other words I think the CXL specification usage of 0x1e98 is scoped
as "DVSEC Vendor ID", not "Vendor ID".

However that would mean that a future 0x1e98 device could not publish
DVSECs without colliding with CXL DVSECs.

I note this footnote in section 3.1.2 about the 0x1e98 value (all caps
emphasis is from the spec, not me):

---
NOTICE TO USERS: THE UNIQUE VALUE THAT IS PROVIDED IN THIS CXL SPECIFICATION IS
FOR USE IN VENDOR DEFINED MESSAGE FIELDS, DESIGNATED VENDOR SPECIFIC EXTENDED
CAPABILITIES, AND ALTERNATE PROTOCOL NEGOTIATION ONLY...
Bjorn Helgaas March 28, 2024, 7:14 p.m. UTC | #6
On Thu, Mar 28, 2024 at 12:03:17PM -0700, Dan Williams wrote:
> Bjorn Helgaas wrote:
> > On Wed, Mar 27, 2024 at 04:57:40PM -0700, Dave Jiang wrote:
> > > On 3/27/24 2:26 PM, Bjorn Helgaas wrote:
> > > > On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:

> > > >> +/* Compute Express Link (CXL) */
> > > >> +#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98
> > > > 
> > > > I see that you're just moving this #define from drivers/cxl/cxlpci.h,
> > > > but I'm scratching my head a bit.  As used here, this is to match the
> > > > DVSEC Vendor ID (PCIe r6.0, sec 7.9.6.2).
> > > > 
> > > > IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
> > > > "PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
> > > > name, and would normally be defined in include/linux/pci_ids.h.
> > > > 
> > > > But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
> > > > value "1e98" in the PCI SIG list at
> > > > https://pcisig.com/membership/member-companies.
> > > > 
> > > I'll create a new patch and move to include/linux/pci_ids.h first
> > > for this define and change to PCI_VENDOR_ID_CXL. The value is
> > > defined in CXL spec r3.1 sec 8.1.1.
> > 
> > I saw the CXL mentions of 0x1e98, but IMO that's not an authoritative
> > source; no vendor is allowed to just squat on a Vendor ID value simply
> > by mentioning it in their own internal specs.  That would obviously
> > lead to madness.
> > 
> > The footnote in CXL r3.1, sec 3.1.2, about how the 1E98h value is only
> > for use in DVSEC etc., is really weird.
> > 
> > IIUC, the PCI SIG controls the Vendor ID namespace, so I'm still
> > really confused about why it is not reserved there.  I emailed the PCI
> > SIG, but the footnote suggests to me that there some kind of history
> > here that I don't know.
> > 
> > Anyway, I think all we can do here is to put the definition in
> > include/linux/pci_ids.h as you did and hope 0x1e98 is never allocated
> > to another vendor.
> 
> Oh, true, I think this should be PCI_DVSEC_VENDOR_ID_CXL, because afaics
> it is still possible that 0x1e98 be used as a non-DVSEC vendor-id in
> some future device.

What a disaster that would be.

> In other words I think the CXL specification usage of 0x1e98 is scoped
> as "DVSEC Vendor ID", not "Vendor ID".
> 
> However that would mean that a future 0x1e98 device could not publish
> DVSECs without colliding with CXL DVSECs.
> 
> I note this footnote in section 3.1.2 about the 0x1e98 value (all caps
> emphasis is from the spec, not me):
> 
> ---
> NOTICE TO USERS: THE UNIQUE VALUE THAT IS PROVIDED IN THIS CXL SPECIFICATION IS
> FOR USE IN VENDOR DEFINED MESSAGE FIELDS, DESIGNATED VENDOR SPECIFIC EXTENDED
> CAPABILITIES, AND ALTERNATE PROTOCOL NEGOTIATION ONLY...

Right, that's the one I thought was really weird.  No sane person
would put crap like that in a spec, which is why I thought there must
be some "interesting" history behind it.

Sigh.
Bjorn Helgaas April 2, 2024, 5:23 p.m. UTC | #7
On Thu, Mar 28, 2024 at 12:03:17PM -0700, Dan Williams wrote:
> Bjorn Helgaas wrote:
> > On Wed, Mar 27, 2024 at 04:57:40PM -0700, Dave Jiang wrote:
> > > On 3/27/24 2:26 PM, Bjorn Helgaas wrote:
> > > > On Mon, Mar 25, 2024 at 04:58:01PM -0700, Dave Jiang wrote:
> ...

> > > > IIUC, this should be just a PCI SIG-defined "Vendor ID", e.g.,
> > > > "PCI_VENDOR_ID_CXL", that doesn't need the "DVSEC" qualifier in the
> > > > name, and would normally be defined in include/linux/pci_ids.h.
> > > > 
> > > > But I don't see CXL in pci_ids.h, and I don't see either "CXL" or the
> > > > value "1e98" in the PCI SIG list at
> > > > https://pcisig.com/membership/member-companies.
> > > > 
> > > I'll create a new patch and move to include/linux/pci_ids.h first
> > > for this define and change to PCI_VENDOR_ID_CXL. The value is
> > > defined in CXL spec r3.1 sec 8.1.1.
> > 
> > I saw the CXL mentions of 0x1e98, but IMO that's not an authoritative
> > source; no vendor is allowed to just squat on a Vendor ID value simply
> > by mentioning it in their own internal specs.  That would obviously
> > lead to madness.
> > 
> > The footnote in CXL r3.1, sec 3.1.2, about how the 1E98h value is only
> > for use in DVSEC etc., is really weird.
> > 
> > IIUC, the PCI SIG controls the Vendor ID namespace, so I'm still
> > really confused about why it is not reserved there.  I emailed the PCI
> > SIG, but the footnote suggests to me that there some kind of history
> > here that I don't know.
> > 
> > Anyway, I think all we can do here is to put the definition in
> > include/linux/pci_ids.h as you did and hope 0x1e98 is never allocated
> > to another vendor.
> 
> Oh, true, I think this should be PCI_DVSEC_VENDOR_ID_CXL, because afaics
> it is still possible that 0x1e98 be used as a non-DVSEC vendor-id in
> some future device.
> 
> In other words I think the CXL specification usage of 0x1e98 is scoped
> as "DVSEC Vendor ID", not "Vendor ID".
> 
> However that would mean that a future 0x1e98 device could not publish
> DVSECs without colliding with CXL DVSECs.

FWIW, I pinged administration@pcisig.com and got the response that
"1E98h is not a VID in our system, but 1E98 has already been reserved
by CXL."

I wish there were a clearer public statement of this reservation, but
I interpret the response to mean that CXL is not a "Vendor", maybe due
to some strict definition of "Vendor," but that PCI-SIG will not
assign 0x1e98 to any other vendor.

So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
ever *do* see such an assignment, we'll be more likely to flag it as
an issue.

Bjorn
Dan Williams April 2, 2024, 5:46 p.m. UTC | #8
Bjorn Helgaas wrote:
[..]
> FWIW, I pinged administration@pcisig.com and got the response that
> "1E98h is not a VID in our system, but 1E98 has already been reserved
> by CXL."
> 
> I wish there were a clearer public statement of this reservation, but
> I interpret the response to mean that CXL is not a "Vendor", maybe due
> to some strict definition of "Vendor," but that PCI-SIG will not
> assign 0x1e98 to any other vendor.
> 
> So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
> ever *do* see such an assignment, we'll be more likely to flag it as
> an issue.

Agree.
Jonathan Cameron April 3, 2024, 2:44 p.m. UTC | #9
On Tue, 2 Apr 2024 10:46:08 -0700
Dan Williams <dan.j.williams@intel.com> wrote:

> Bjorn Helgaas wrote:
> [..]
> > FWIW, I pinged administration@pcisig.com and got the response that
> > "1E98h is not a VID in our system, but 1E98 has already been reserved
> > by CXL."
> > 
> > I wish there were a clearer public statement of this reservation, but
> > I interpret the response to mean that CXL is not a "Vendor", maybe due
> > to some strict definition of "Vendor," but that PCI-SIG will not
> > assign 0x1e98 to any other vendor.
> > 
> > So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
> > ever *do* see such an assignment, we'll be more likely to flag it as
> > an issue.  
> 
> Agree.

Sorry for late entry on this discussion and I'll be careful what I say
on the history.

As you've guessed it was "entertaining" and for FWIW that text occurs
in other consortium specs (some predate CXL).

It's reserved with agreement from the PCI SIG for a strictly defined set
of purposes that does not correspond to those allowed for a normal ID
granted to a vendor member. As you say CXL isn't a vendor (don't ask
how DMTF got a vendor ID - 0x1AB4).

Hence the naming gymnastics and vague answers to avoid any chance of
lawyers getting involved :(

Jonathan
Dan Williams April 3, 2024, 8:36 p.m. UTC | #10
Jonathan Cameron wrote:
> On Tue, 2 Apr 2024 10:46:08 -0700
> Dan Williams <dan.j.williams@intel.com> wrote:
> 
> > Bjorn Helgaas wrote:
> > [..]
> > > FWIW, I pinged administration@pcisig.com and got the response that
> > > "1E98h is not a VID in our system, but 1E98 has already been reserved
> > > by CXL."
> > > 
> > > I wish there were a clearer public statement of this reservation, but
> > > I interpret the response to mean that CXL is not a "Vendor", maybe due
> > > to some strict definition of "Vendor," but that PCI-SIG will not
> > > assign 0x1e98 to any other vendor.
> > > 
> > > So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
> > > ever *do* see such an assignment, we'll be more likely to flag it as
> > > an issue.  
> > 
> > Agree.
> 
> Sorry for late entry on this discussion and I'll be careful what I say
> on the history.
> 
> As you've guessed it was "entertaining" and for FWIW that text occurs
> in other consortium specs (some predate CXL).
> 
> It's reserved with agreement from the PCI SIG for a strictly defined set
> of purposes that does not correspond to those allowed for a normal ID
> granted to a vendor member. As you say CXL isn't a vendor (don't ask
> how DMTF got a vendor ID - 0x1AB4).
> 
> Hence the naming gymnastics and vague answers to avoid any chance of
> lawyers getting involved :(

Linux has practical reasons for renaming PCI_DVSEC_VENDOR_ID_CXL to
PCI_VENDOR_ID_CXL. By this change Linux is asserting that not only does
it expect to find 0x1e98 exclusively used for CXL DVSECs, but it expects
to never read "0x1e98" from offset 0 in config space. If someone has
reason to believe that assertion is invalid they can speak up here, but
otherwise the naming solely reflects Linux's expectation of where it
will be used.
Lukas Wunner April 4, 2024, 9:02 a.m. UTC | #11
On Wed, Apr 03, 2024 at 03:44:41PM +0100, Jonathan Cameron wrote:
> > Bjorn Helgaas wrote:
> > > FWIW, I pinged administration@pcisig.com and got the response that
> > > "1E98h is not a VID in our system, but 1E98 has already been reserved
> > > by CXL."
> > > 
> > > I wish there were a clearer public statement of this reservation, but
> > > I interpret the response to mean that CXL is not a "Vendor", maybe due
> > > to some strict definition of "Vendor," but that PCI-SIG will not
> > > assign 0x1e98 to any other vendor.
> > > 
> > > So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
> > > ever *do* see such an assignment, we'll be more likely to flag it as
> > > an issue.  
> 
> Sorry for late entry on this discussion and I'll be careful what I say
> on the history.
> 
> As you've guessed it was "entertaining" and for FWIW that text occurs
> in other consortium specs (some predate CXL).
> 
> It's reserved with agreement from the PCI SIG for a strictly defined set
> of purposes that does not correspond to those allowed for a normal ID
> granted to a vendor member. As you say CXL isn't a vendor (don't ask
> how DMTF got a vendor ID - 0x1AB4).
> 
> Hence the naming gymnastics and vague answers to avoid any chance of
> lawyers getting involved :(

Hm, I'm wondering if avoiding the term "vendor" with something like

#define PCI_CONSORTIUM_ID_CXL 0x1e98

would assuage the angst of a legal misstep? ;)
Jonathan Cameron April 4, 2024, 1:52 p.m. UTC | #12
On Thu, 4 Apr 2024 11:02:10 +0200
Lukas Wunner <lukas@wunner.de> wrote:

> On Wed, Apr 03, 2024 at 03:44:41PM +0100, Jonathan Cameron wrote:
> > > Bjorn Helgaas wrote:  
> > > > FWIW, I pinged administration@pcisig.com and got the response that
> > > > "1E98h is not a VID in our system, but 1E98 has already been reserved
> > > > by CXL."
> > > > 
> > > > I wish there were a clearer public statement of this reservation, but
> > > > I interpret the response to mean that CXL is not a "Vendor", maybe due
> > > > to some strict definition of "Vendor," but that PCI-SIG will not
> > > > assign 0x1e98 to any other vendor.
> > > > 
> > > > So IMO we should add "#define PCI_VENDOR_ID_CXL 0x1e98" so that if we
> > > > ever *do* see such an assignment, we'll be more likely to flag it as
> > > > an issue.    
> > 
> > Sorry for late entry on this discussion and I'll be careful what I say
> > on the history.
> > 
> > As you've guessed it was "entertaining" and for FWIW that text occurs
> > in other consortium specs (some predate CXL).
> > 
> > It's reserved with agreement from the PCI SIG for a strictly defined set
> > of purposes that does not correspond to those allowed for a normal ID
> > granted to a vendor member. As you say CXL isn't a vendor (don't ask
> > how DMTF got a vendor ID - 0x1AB4).
> > 
> > Hence the naming gymnastics and vague answers to avoid any chance of
> > lawyers getting involved :(  
> 
> Hm, I'm wondering if avoiding the term "vendor" with something like
> 
> #define PCI_CONSORTIUM_ID_CXL 0x1e98
> 
> would assuage the angst of a legal misstep? ;)
Works for me, but I really hope we don't have to care :(

Jonathan
diff mbox series

Patch

diff --git a/drivers/cxl/cxlpci.h b/drivers/cxl/cxlpci.h
index 93992a1c8eec..55be4dccbed0 100644
--- a/drivers/cxl/cxlpci.h
+++ b/drivers/cxl/cxlpci.h
@@ -13,10 +13,8 @@ 
  * "DVSEC" redundancies removed. When obvious, abbreviations may be used.
  */
 #define PCI_DVSEC_HEADER1_LENGTH_MASK	GENMASK(31, 20)
-#define PCI_DVSEC_VENDOR_ID_CXL		0x1E98
 
 /* CXL 2.0 8.1.3: PCIe DVSEC for CXL Device */
-#define CXL_DVSEC_PCIE_DEVICE					0
 #define   CXL_DVSEC_CAP_OFFSET		0xA
 #define     CXL_DVSEC_MEM_CAPABLE	BIT(2)
 #define     CXL_DVSEC_HDM_COUNT_MASK	GENMASK(5, 4)
diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c
index e5f243dd4288..259e5d6538bb 100644
--- a/drivers/pci/pci.c
+++ b/drivers/pci/pci.c
@@ -4927,10 +4927,55 @@  static int pci_dev_reset_slot_function(struct pci_dev *dev, bool probe)
 	return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
 }
 
+static bool pci_is_cxl(struct pci_dev *dev)
+{
+	return pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
+					 CXL_DVSEC_PCIE_DEVICE);
+}
+
+static bool is_cxl_port_sbr_masked(struct pci_dev *dev)
+{
+	int dvsec;
+	u16 reg;
+	int rc;
+
+	/*
+	 * No DVSEC found, must not be CXL port.
+	 */
+	dvsec = pci_find_dvsec_capability(dev, PCI_DVSEC_VENDOR_ID_CXL,
+					  CXL_DVSEC_PCIE_PORT);
+	if (!dvsec)
+		return false;
+
+	rc = pci_read_config_word(dev, dvsec + CXL_DVSEC_PORT_CONTROL, &reg);
+	if (rc)
+		return true;
+
+	/*
+	 * CXL spec r3.1 8.1.5.2
+	 * When 0, SBR bit in Bridge Control register of this Port has no effect.
+	 * When 1, the Port shall generate hot reset when SBR bit in Bridge
+	 * Control gets set to 1.
+	 */
+	if (reg & CXL_DVSEC_PORT_CONTROL_UNMASK_SBR)
+		return false;
+
+	return true;
+}
+
 static int pci_reset_bus_function(struct pci_dev *dev, bool probe)
 {
+	struct pci_dev *bridge = pci_upstream_bridge(dev);
 	int rc;
 
+	/* If it's a CXL port and the SBR control is masked, fail the SBR */
+	if (pci_is_cxl(dev) && bridge && is_cxl_port_sbr_masked(bridge)) {
+		if (probe)
+			return 0;
+
+		return -ENOTTY;
+	}
+
 	rc = pci_dev_reset_slot_function(dev, probe);
 	if (rc != -ENOTTY)
 		return rc;
diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
index a39193213ff2..5f2c66987299 100644
--- a/include/uapi/linux/pci_regs.h
+++ b/include/uapi/linux/pci_regs.h
@@ -1148,4 +1148,11 @@ 
 #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_PROTOCOL		0x00ff0000
 #define PCI_DOE_DATA_OBJECT_DISC_RSP_3_NEXT_INDEX	0xff000000
 
+/* Compute Express Link (CXL) */
+#define PCI_DVSEC_VENDOR_ID_CXL				0x1e98
+#define CXL_DVSEC_PCIE_DEVICE				0
+#define CXL_DVSEC_PCIE_PORT				3
+#define CXL_DVSEC_PORT_CONTROL				0x0c
+#define  CXL_DVSEC_PORT_CONTROL_UNMASK_SBR		0x00000001
+
 #endif /* LINUX_PCI_REGS_H */