[linux-block.git] / drivers / thunderbolt / quirks.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Thunderbolt driver - quirks
 *
 * Copyright (c) 2020 Mario Limonciello <mario.limonciello@dell.com>
 */

#include "tb.h"

static void quirk_force_power_link(struct tb_switch *sw)
{
	sw->quirks |= QUIRK_FORCE_POWER_LINK_CONTROLLER;
	tb_sw_dbg(sw, "forcing power to link controller\n");
}

static void quirk_dp_credit_allocation(struct tb_switch *sw)
{
	if (sw->credit_allocation && sw->min_dp_main_credits == 56) {
		sw->min_dp_main_credits = 18;
		tb_sw_dbg(sw, "quirked DP main: %u\n", sw->min_dp_main_credits);
	}
}

static void quirk_clx_disable(struct tb_switch *sw)
{
	sw->quirks |= QUIRK_NO_CLX;
	tb_sw_dbg(sw, "disabling CL states\n");
}

static void quirk_usb3_maximum_bandwidth(struct tb_switch *sw)
{
	struct tb_port *port;

	if (tb_switch_is_icm(sw))
		return;

	tb_switch_for_each_port(sw, port) {
		if (!tb_port_is_usb3_down(port))
			continue;
		port->max_bw = 16376;
		tb_port_dbg(port, "USB3 maximum bandwidth limited to %u Mb/s\n",
			    port->max_bw);
	}
}

static void quirk_block_rpm_in_redrive(struct tb_switch *sw)
{
	sw->quirks |= QUIRK_KEEP_POWER_IN_DP_REDRIVE;
	tb_sw_dbg(sw, "preventing runtime PM in DP redrive mode\n");
}

struct tb_quirk {
	u16 hw_vendor_id;
	u16 hw_device_id;
	u16 vendor;
	u16 device;
	void (*hook)(struct tb_switch *sw);
};

static const struct tb_quirk tb_quirks[] = {
	/* Dell WD19TB supports self-authentication on unplug */
	{ 0x0000, 0x0000, 0x00d4, 0xb070, quirk_force_power_link },
	{ 0x0000, 0x0000, 0x00d4, 0xb071, quirk_force_power_link },
	/*
	 * Intel Goshen Ridge NVM 27 and before report wrong number of
	 * DP buffers.
	 */
	{ 0x8087, 0x0b26, 0x0000, 0x0000, quirk_dp_credit_allocation },
	/*
	 * Limit the maximum USB3 bandwidth for the following Intel USB4
	 * host routers due to a hardware issue.
	 */
	{ 0x8087, PCI_DEVICE_ID_INTEL_ADL_NHI0, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_ADL_NHI1, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_RPL_NHI0, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_RPL_NHI1, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_M_NHI0, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_P_NHI0, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_P_NHI1, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_80G_NHI, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_40G_NHI, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HUB_80G_BRIDGE, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HUB_40G_BRIDGE, 0x0000, 0x0000,
		  quirk_usb3_maximum_bandwidth },
	/*
	 * Block Runtime PM in DP redrive mode for Intel Barlow Ridge host
	 * controllers.
	 */
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_80G_NHI, 0x0000, 0x0000,
		  quirk_block_rpm_in_redrive },
	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_40G_NHI, 0x0000, 0x0000,
		  quirk_block_rpm_in_redrive },
	/*
	 * CLx is not supported on AMD USB4 Yellow Carp and Pink Sardine platforms.
	 */
	{ 0x0438, 0x0208, 0x0000, 0x0000, quirk_clx_disable },
	{ 0x0438, 0x0209, 0x0000, 0x0000, quirk_clx_disable },
	{ 0x0438, 0x020a, 0x0000, 0x0000, quirk_clx_disable },
	{ 0x0438, 0x020b, 0x0000, 0x0000, quirk_clx_disable },
};

/**
 * tb_check_quirks() - Check for quirks to apply
 * @sw: Thunderbolt switch
 *
 * Apply any quirks for the Thunderbolt controller.
 */
void tb_check_quirks(struct tb_switch *sw)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(tb_quirks); i++) {
		const struct tb_quirk *q = &tb_quirks[i];

		if (q->hw_vendor_id && q->hw_vendor_id != sw->config.vendor_id)
			continue;
		if (q->hw_device_id && q->hw_device_id != sw->config.device_id)
			continue;
		if (q->vendor && q->vendor != sw->vendor)
			continue;
		if (q->device && q->device != sw->device)
			continue;

		tb_sw_dbg(sw, "running %ps\n", q->hook);
		q->hook(sw);
	}
}
Commit	Line	Data
1cb36293 ML	1	// SPDX-License-Identifier: GPL-2.0
	2	/*
	3	* Thunderbolt driver - quirks
	4	*
	5	* Copyright (c) 2020 Mario Limonciello <mario.limonciello@dell.com>
	6	*/
	7
	8	#include "tb.h"
	9
	10	static void quirk_force_power_link(struct tb_switch *sw)
	11	{
	12	sw->quirks \|= QUIRK_FORCE_POWER_LINK_CONTROLLER;
ccdb0900	13	tb_sw_dbg(sw, "forcing power to link controller\n");
1cb36293 ML	14	}
1cb36293 ML	15
7c37bb30 MW	16	static void quirk_dp_credit_allocation(struct tb_switch *sw)
	17	{
	18	if (sw->credit_allocation && sw->min_dp_main_credits == 56) {
	19	sw->min_dp_main_credits = 18;
	20	tb_sw_dbg(sw, "quirked DP main: %u\n", sw->min_dp_main_credits);
	21	}
	22	}
	23
7af9da8c SM	24	static void quirk_clx_disable(struct tb_switch *sw)
	25	{
	26	sw->quirks \|= QUIRK_NO_CLX;
	27	tb_sw_dbg(sw, "disabling CL states\n");
	28	}
	29
f0a57dd3 GF	30	static void quirk_usb3_maximum_bandwidth(struct tb_switch *sw)
	31	{
	32	struct tb_port *port;
	33
0c35ac18 MW	34	if (tb_switch_is_icm(sw))
	35	return;
	36
f0a57dd3 GF	37	tb_switch_for_each_port(sw, port) {
	38	if (!tb_port_is_usb3_down(port))
	39	continue;
	40	port->max_bw = 16376;
	41	tb_port_dbg(port, "USB3 maximum bandwidth limited to %u Mb/s\n",
	42	port->max_bw);
	43	}
	44	}
	45
a75e0684 MW	46	static void quirk_block_rpm_in_redrive(struct tb_switch *sw)
	47	{
	48	sw->quirks \|= QUIRK_KEEP_POWER_IN_DP_REDRIVE;
	49	tb_sw_dbg(sw, "preventing runtime PM in DP redrive mode\n");
	50	}
	51
1cb36293	52	struct tb_quirk {
7c37bb30 MW	53	u16 hw_vendor_id;
7c37bb30 MW	54	u16 hw_device_id;
1cb36293 ML	55	u16 vendor;
	56	u16 device;
	57	void (hook)(struct tb_switch sw);
	58	};
	59
ef7e1207	60	static const struct tb_quirk tb_quirks[] = {
1cb36293	61	/* Dell WD19TB supports self-authentication on unplug */
7c37bb30 MW	62	{ 0x0000, 0x0000, 0x00d4, 0xb070, quirk_force_power_link },
	63	{ 0x0000, 0x0000, 0x00d4, 0xb071, quirk_force_power_link },
	64	/*
	65	* Intel Goshen Ridge NVM 27 and before report wrong number of
	66	* DP buffers.
	67	*/
	68	{ 0x8087, 0x0b26, 0x0000, 0x0000, quirk_dp_credit_allocation },
f0a57dd3 GF	69	/*
	70	* Limit the maximum USB3 bandwidth for the following Intel USB4
	71	* host routers due to a hardware issue.
	72	*/
	73	{ 0x8087, PCI_DEVICE_ID_INTEL_ADL_NHI0, 0x0000, 0x0000,
	74	quirk_usb3_maximum_bandwidth },
	75	{ 0x8087, PCI_DEVICE_ID_INTEL_ADL_NHI1, 0x0000, 0x0000,
	76	quirk_usb3_maximum_bandwidth },
	77	{ 0x8087, PCI_DEVICE_ID_INTEL_RPL_NHI0, 0x0000, 0x0000,
	78	quirk_usb3_maximum_bandwidth },
	79	{ 0x8087, PCI_DEVICE_ID_INTEL_RPL_NHI1, 0x0000, 0x0000,
	80	quirk_usb3_maximum_bandwidth },
	81	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_M_NHI0, 0x0000, 0x0000,
	82	quirk_usb3_maximum_bandwidth },
	83	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_P_NHI0, 0x0000, 0x0000,
	84	quirk_usb3_maximum_bandwidth },
	85	{ 0x8087, PCI_DEVICE_ID_INTEL_MTL_P_NHI1, 0x0000, 0x0000,
	86	quirk_usb3_maximum_bandwidth },
f2bfa944 MW	87	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_80G_NHI, 0x0000, 0x0000,
	88	quirk_usb3_maximum_bandwidth },
	89	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_40G_NHI, 0x0000, 0x0000,
	90	quirk_usb3_maximum_bandwidth },
	91	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HUB_80G_BRIDGE, 0x0000, 0x0000,
	92	quirk_usb3_maximum_bandwidth },
	93	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HUB_40G_BRIDGE, 0x0000, 0x0000,
	94	quirk_usb3_maximum_bandwidth },
a75e0684 MW	95	/*
	96	* Block Runtime PM in DP redrive mode for Intel Barlow Ridge host
	97	* controllers.
	98	*/
	99	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_80G_NHI, 0x0000, 0x0000,
	100	quirk_block_rpm_in_redrive },
	101	{ 0x8087, PCI_DEVICE_ID_INTEL_BARLOW_RIDGE_HOST_40G_NHI, 0x0000, 0x0000,
	102	quirk_block_rpm_in_redrive },
7af9da8c SM	103	/*
	104	* CLx is not supported on AMD USB4 Yellow Carp and Pink Sardine platforms.
	105	*/
	106	{ 0x0438, 0x0208, 0x0000, 0x0000, quirk_clx_disable },
	107	{ 0x0438, 0x0209, 0x0000, 0x0000, quirk_clx_disable },
	108	{ 0x0438, 0x020a, 0x0000, 0x0000, quirk_clx_disable },
	109	{ 0x0438, 0x020b, 0x0000, 0x0000, quirk_clx_disable },
1cb36293 ML	110	};
	111
	112	/**
	113	* tb_check_quirks() - Check for quirks to apply
	114	* @sw: Thunderbolt switch
	115	*
9c8cac6a	116	* Apply any quirks for the Thunderbolt controller.
1cb36293 ML	117	*/
	118	void tb_check_quirks(struct tb_switch *sw)
	119	{
	120	int i;
	121
	122	for (i = 0; i < ARRAY_SIZE(tb_quirks); i++) {
	123	const struct tb_quirk *q = &tb_quirks[i];
	124
7c37bb30 MW	125	if (q->hw_vendor_id && q->hw_vendor_id != sw->config.vendor_id)
	126	continue;
	127	if (q->hw_device_id && q->hw_device_id != sw->config.device_id)
	128	continue;
	129	if (q->vendor && q->vendor != sw->vendor)
	130	continue;
	131	if (q->device && q->device != sw->device)
	132	continue;
	133
f14d177e	134	tb_sw_dbg(sw, "running %ps\n", q->hook);
7c37bb30	135	q->hook(sw);
1cb36293 ML	136	}
1cb36293 ML	137	}