| Message ID | 20241101-x1e80100-ps8830-v4-2-f0f7518b263e@linaro.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | usb: typec: Add new driver for Parade PS8830 Type-C Retimer | expand |
Le 01/11/2024 à 17:29, Abel Vesa a écrit : > The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, > controlled over I2C. It usually sits between a USB/DisplayPort PHY > and the Type-C connector, and provides orientation and altmode handling. > > The boards that use this retimer are the ones featuring the Qualcomm > Snapdragon X Elite SoCs. > > Add a driver with support for the following modes: > - DisplayPort 4-lanes > - DisplayPort 2-lanes + USB3 > - USB3 > > There is another variant of this retimer which is called PS8833. It seems > to be really similar to the PS8830, so future-proof this driver by > naming it ps883x. > > Signed-off-by: Abel Vesa <abel.vesa-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org> > --- Hi, ... > +static void ps883x_disable_vregs(struct ps883x_retimer *retimer) > +{ > + regulator_disable(retimer->vddio_supply); > + regulator_disable(retimer->vddat_supply); > + regulator_disable(retimer->vddar_supply); > + regulator_disable(retimer->vdd_supply); > + regulator_disable(retimer->vdd33_cap_supply); > + regulator_disable(retimer->vdd33_supply); > +} > + > +static int ps883x_get_vregs(struct ps883x_retimer *retimer) This could maybe be replaced by a devm_regulator_bulk_get() call? (and use the bulk API in other places) > +{ > + struct device *dev = &retimer->client->dev; > + > + retimer->vdd_supply = devm_regulator_get(dev, "vdd"); > + if (IS_ERR(retimer->vdd_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vdd_supply), > + "failed to get VDD\n"); > + > + retimer->vdd33_supply = devm_regulator_get(dev, "vdd33"); > + if (IS_ERR(retimer->vdd33_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_supply), > + "failed to get VDD 3.3V\n"); > + > + retimer->vdd33_cap_supply = devm_regulator_get(dev, "vdd33-cap"); > + if (IS_ERR(retimer->vdd33_cap_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_cap_supply), > + "failed to get VDD CAP 3.3V\n"); > + > + retimer->vddat_supply = devm_regulator_get(dev, "vddat"); > + if (IS_ERR(retimer->vddat_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vddat_supply), > + "failed to get VDD AT\n"); > + > + retimer->vddar_supply = devm_regulator_get(dev, "vddar"); > + if (IS_ERR(retimer->vddar_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vddar_supply), > + "failed to get VDD AR\n"); > + > + retimer->vddio_supply = devm_regulator_get(dev, "vddio"); > + if (IS_ERR(retimer->vddio_supply)) > + return dev_err_probe(dev, PTR_ERR(retimer->vddio_supply), > + "failed to get VDD IO\n"); > + > + return 0; > +} ... > +static int ps883x_retimer_probe(struct i2c_client *client) > +{ > + struct device *dev = &client->dev; > + struct typec_switch_desc sw_desc = { }; > + struct typec_retimer_desc rtmr_desc = { }; > + struct ps883x_retimer *retimer; > + int ret; > + > + retimer = devm_kzalloc(dev, sizeof(*retimer), GFP_KERNEL); > + if (!retimer) > + return -ENOMEM; > + > + retimer->client = client; > + > + mutex_init(&retimer->lock); > + > + retimer->regmap = devm_regmap_init_i2c(client, &ps883x_retimer_regmap); > + if (IS_ERR(retimer->regmap)) { > + ret = PTR_ERR(retimer->regmap); > + dev_err(dev, "failed to allocate register map: %d\n", ret); Maybe dev_err_probe() as below? > + return ret; > + } > + > + ret = ps883x_get_vregs(retimer); > + if (ret) > + return ret; > + > + retimer->xo_clk = devm_clk_get(dev, NULL); > + if (IS_ERR(retimer->xo_clk)) > + return dev_err_probe(dev, PTR_ERR(retimer->xo_clk), > + "failed to get xo clock\n"); > + > + retimer->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_ASIS); > + if (IS_ERR(retimer->reset_gpio)) > + return dev_err_probe(dev, PTR_ERR(retimer->reset_gpio), > + "failed to get reset gpio\n"); > + > + retimer->typec_switch = typec_switch_get(dev); > + if (IS_ERR(retimer->typec_switch)) > + return dev_err_probe(dev, PTR_ERR(retimer->typec_switch), > + "failed to acquire orientation-switch\n"); > + > + retimer->typec_mux = typec_mux_get(dev); > + if (IS_ERR(retimer->typec_mux)) { > + ret = dev_err_probe(dev, PTR_ERR(retimer->typec_mux), > + "failed to acquire mode-mux\n"); > + goto err_switch_put; > + } > + > + ret = drm_aux_bridge_register(dev); > + if (ret) > + goto err_mux_put; > + > + ret = clk_prepare_enable(retimer->xo_clk); > + if (ret) { > + dev_err(dev, "failed to enable XO: %d\n", ret); > + goto err_mux_put; > + } > + > + ret = ps883x_enable_vregs(retimer); > + if (ret) > + goto err_clk_disable; > + > + sw_desc.drvdata = retimer; > + sw_desc.fwnode = dev_fwnode(dev); > + sw_desc.set = ps883x_sw_set; > + > + retimer->sw = typec_switch_register(dev, &sw_desc); > + if (IS_ERR(retimer->sw)) { > + ret = PTR_ERR(retimer->sw); > + dev_err(dev, "failed to register typec switch: %d\n", ret); Maybe dev_err_probe() as above? > + goto err_vregs_disable; > + } > + > + rtmr_desc.drvdata = retimer; > + rtmr_desc.fwnode = dev_fwnode(dev); > + rtmr_desc.set = ps883x_retimer_set; > + > + retimer->retimer = typec_retimer_register(dev, &rtmr_desc); > + if (IS_ERR(retimer->retimer)) { > + ret = PTR_ERR(retimer->retimer); > + dev_err(dev, "failed to register typec retimer: %d\n", ret); Maybe dev_err_probe() as above? > + goto err_switch_unregister; > + } > + > + /* skip resetting if already configured */ > + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) > + return 0; > + > + gpiod_direction_output(retimer->reset_gpio, 1); > + > + /* VDD IO supply enable to reset release delay */ > + usleep_range(4000, 14000); > + > + gpiod_set_value(retimer->reset_gpio, 0); > + > + /* firmware initialization delay */ > + msleep(60); > + > + return 0; > + > +err_switch_unregister: > + typec_switch_unregister(retimer->sw); > +err_vregs_disable: > + ps883x_disable_vregs(retimer); > +err_clk_disable: > + clk_disable_unprepare(retimer->xo_clk); > +err_mux_put: > + typec_mux_put(retimer->typec_mux); > +err_switch_put: > + typec_switch_put(retimer->typec_switch); > + > + return ret; > +} > + > +static void ps883x_retimer_remove(struct i2c_client *client) > +{ > + struct ps883x_retimer *retimer = i2c_get_clientdata(client); > + > + typec_retimer_unregister(retimer->retimer); > + typec_switch_unregister(retimer->sw); > + > + gpiod_set_value(retimer->reset_gpio, 1); > + > + regulator_disable(retimer->vddio_supply); > + regulator_disable(retimer->vddat_supply); > + regulator_disable(retimer->vddar_supply); > + regulator_disable(retimer->vdd_supply); > + regulator_disable(retimer->vdd33_cap_supply); > + regulator_disable(retimer->vdd33_supply); ps883x_disable_vregs()? > + > + clk_disable_unprepare(retimer->xo_clk); > + > + typec_mux_put(retimer->typec_mux); > + typec_switch_put(retimer->typec_switch); > +} ... CJ
On 1.11.2024 5:29 PM, Abel Vesa wrote: > The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, > controlled over I2C. It usually sits between a USB/DisplayPort PHY > and the Type-C connector, and provides orientation and altmode handling. > > The boards that use this retimer are the ones featuring the Qualcomm > Snapdragon X Elite SoCs. > > Add a driver with support for the following modes: > - DisplayPort 4-lanes > - DisplayPort 2-lanes + USB3 > - USB3 > > There is another variant of this retimer which is called PS8833. It seems > to be really similar to the PS8830, so future-proof this driver by > naming it ps883x. > > Signed-off-by: Abel Vesa <abel.vesa@linaro.org> > --- [...] > +static void ps883x_configure(struct ps883x_retimer *retimer, int cfg0, int cfg1, int cfg2) > +{ > + regmap_write(retimer->regmap, 0x0, cfg0); > + regmap_write(retimer->regmap, 0x1, cfg1); > + regmap_write(retimer->regmap, 0x2, cfg2); > +} Somewhere between introducing regcache and dropping it, you removed muxing to a safe mode during _configure() [...] > + /* skip resetting if already configured */ > + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) > + return 0; What is that register and what does BIT(0) mean? Konrad
On 24-11-02 10:17:56, Konrad Dybcio wrote: > On 1.11.2024 5:29 PM, Abel Vesa wrote: > > The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, > > controlled over I2C. It usually sits between a USB/DisplayPort PHY > > and the Type-C connector, and provides orientation and altmode handling. > > > > The boards that use this retimer are the ones featuring the Qualcomm > > Snapdragon X Elite SoCs. > > > > Add a driver with support for the following modes: > > - DisplayPort 4-lanes > > - DisplayPort 2-lanes + USB3 > > - USB3 > > > > There is another variant of this retimer which is called PS8833. It seems > > to be really similar to the PS8830, so future-proof this driver by > > naming it ps883x. > > > > Signed-off-by: Abel Vesa <abel.vesa@linaro.org> > > --- > > [...] > > > +static void ps883x_configure(struct ps883x_retimer *retimer, int cfg0, int cfg1, int cfg2) > > +{ > > + regmap_write(retimer->regmap, 0x0, cfg0); > > + regmap_write(retimer->regmap, 0x1, cfg1); > > + regmap_write(retimer->regmap, 0x2, cfg2); > > +} > > Somewhere between introducing regcache and dropping it, you removed > muxing to a safe mode during _configure() Oh, yeah, I forgot to mention that in the change log, it seems. Configuring to safe mode is not needed since we always do that on unplug anyway. > > [...] > > > + /* skip resetting if already configured */ > > + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) > > + return 0; > > What is that register and what does BIT(0) mean? Looking at the documentation, the first register is REG_USB_PORT_CONN_STATUS and spans over the first 4 bytes. But it doesn't really help here. BIT(0) doesn't really have a name, it just says "Connection present". > > Konrad
On 4.11.2024 11:16 AM, Abel Vesa wrote: > On 24-11-02 10:17:56, Konrad Dybcio wrote: >> On 1.11.2024 5:29 PM, Abel Vesa wrote: >>> The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, >>> controlled over I2C. It usually sits between a USB/DisplayPort PHY >>> and the Type-C connector, and provides orientation and altmode handling. >>> >>> The boards that use this retimer are the ones featuring the Qualcomm >>> Snapdragon X Elite SoCs. >>> >>> Add a driver with support for the following modes: >>> - DisplayPort 4-lanes >>> - DisplayPort 2-lanes + USB3 >>> - USB3 >>> >>> There is another variant of this retimer which is called PS8833. It seems >>> to be really similar to the PS8830, so future-proof this driver by >>> naming it ps883x. >>> >>> Signed-off-by: Abel Vesa <abel.vesa@linaro.org> >>> --- >> >> [...] >> >>> +static void ps883x_configure(struct ps883x_retimer *retimer, int cfg0, int cfg1, int cfg2) >>> +{ >>> + regmap_write(retimer->regmap, 0x0, cfg0); >>> + regmap_write(retimer->regmap, 0x1, cfg1); >>> + regmap_write(retimer->regmap, 0x2, cfg2); >>> +} >> >> Somewhere between introducing regcache and dropping it, you removed >> muxing to a safe mode during _configure() > > Oh, yeah, I forgot to mention that in the change log, it seems. > > Configuring to safe mode is not needed since we always do that on > unplug anyway. > >> >> [...] >> >>> + /* skip resetting if already configured */ >>> + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) >>> + return 0; >> >> What is that register and what does BIT(0) mean? > > Looking at the documentation, the first register is > REG_USB_PORT_CONN_STATUS and spans over the first 4 bytes. > > But it doesn't really help here. > > BIT(0) doesn't really have a name, it just says "Connection present". Please define both then. STATUS_CONNECTION_PRESENT sounds good for the bit. Konrad
On 24-11-01 17:56:04, Christophe JAILLET wrote: > Le 01/11/2024 à 17:29, Abel Vesa a écrit : > > The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, > > controlled over I2C. It usually sits between a USB/DisplayPort PHY > > and the Type-C connector, and provides orientation and altmode handling. > > > > The boards that use this retimer are the ones featuring the Qualcomm > > Snapdragon X Elite SoCs. > > > > Add a driver with support for the following modes: > > - DisplayPort 4-lanes > > - DisplayPort 2-lanes + USB3 > > - USB3 > > > > There is another variant of this retimer which is called PS8833. It seems > > to be really similar to the PS8830, so future-proof this driver by > > naming it ps883x. > > > > Signed-off-by: Abel Vesa <abel.vesa-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org> > > --- > > Hi, > > ... > > > +static void ps883x_disable_vregs(struct ps883x_retimer *retimer) > > +{ > > + regulator_disable(retimer->vddio_supply); > > + regulator_disable(retimer->vddat_supply); > > + regulator_disable(retimer->vddar_supply); > > + regulator_disable(retimer->vdd_supply); > > + regulator_disable(retimer->vdd33_cap_supply); > > + regulator_disable(retimer->vdd33_supply); > > +} > > + > > +static int ps883x_get_vregs(struct ps883x_retimer *retimer) > > This could maybe be replaced by a > devm_regulator_bulk_get() call? > (and use the bulk API in other places) Nope, look in the ps883x_enable_vregs. There are some delays needed between enabling them, according to spec. > > > +{ > > + struct device *dev = &retimer->client->dev; > > + > > + retimer->vdd_supply = devm_regulator_get(dev, "vdd"); > > + if (IS_ERR(retimer->vdd_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vdd_supply), > > + "failed to get VDD\n"); > > + > > + retimer->vdd33_supply = devm_regulator_get(dev, "vdd33"); > > + if (IS_ERR(retimer->vdd33_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_supply), > > + "failed to get VDD 3.3V\n"); > > + > > + retimer->vdd33_cap_supply = devm_regulator_get(dev, "vdd33-cap"); > > + if (IS_ERR(retimer->vdd33_cap_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_cap_supply), > > + "failed to get VDD CAP 3.3V\n"); > > + > > + retimer->vddat_supply = devm_regulator_get(dev, "vddat"); > > + if (IS_ERR(retimer->vddat_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vddat_supply), > > + "failed to get VDD AT\n"); > > + > > + retimer->vddar_supply = devm_regulator_get(dev, "vddar"); > > + if (IS_ERR(retimer->vddar_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vddar_supply), > > + "failed to get VDD AR\n"); > > + > > + retimer->vddio_supply = devm_regulator_get(dev, "vddio"); > > + if (IS_ERR(retimer->vddio_supply)) > > + return dev_err_probe(dev, PTR_ERR(retimer->vddio_supply), > > + "failed to get VDD IO\n"); > > + > > + return 0; > > +} > > ... > > > +static int ps883x_retimer_probe(struct i2c_client *client) > > +{ > > + struct device *dev = &client->dev; > > + struct typec_switch_desc sw_desc = { }; > > + struct typec_retimer_desc rtmr_desc = { }; > > + struct ps883x_retimer *retimer; > > + int ret; > > + > > + retimer = devm_kzalloc(dev, sizeof(*retimer), GFP_KERNEL); > > + if (!retimer) > > + return -ENOMEM; > > + > > + retimer->client = client; > > + > > + mutex_init(&retimer->lock); > > + > > + retimer->regmap = devm_regmap_init_i2c(client, &ps883x_retimer_regmap); > > + if (IS_ERR(retimer->regmap)) { > > + ret = PTR_ERR(retimer->regmap); > > + dev_err(dev, "failed to allocate register map: %d\n", ret); > > Maybe dev_err_probe() as below? Sure, even though this one here doesn't return EPROBE_DEFER. But will help with stringifying the error code nonetheless. So will do that in the next version. > > > + return ret; > > + } > > + > > + ret = ps883x_get_vregs(retimer); > > + if (ret) > > + return ret; > > + > > + retimer->xo_clk = devm_clk_get(dev, NULL); > > + if (IS_ERR(retimer->xo_clk)) > > + return dev_err_probe(dev, PTR_ERR(retimer->xo_clk), > > + "failed to get xo clock\n"); > > + > > + retimer->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_ASIS); > > + if (IS_ERR(retimer->reset_gpio)) > > + return dev_err_probe(dev, PTR_ERR(retimer->reset_gpio), > > + "failed to get reset gpio\n"); > > + > > + retimer->typec_switch = typec_switch_get(dev); > > + if (IS_ERR(retimer->typec_switch)) > > + return dev_err_probe(dev, PTR_ERR(retimer->typec_switch), > > + "failed to acquire orientation-switch\n"); > > + > > + retimer->typec_mux = typec_mux_get(dev); > > + if (IS_ERR(retimer->typec_mux)) { > > + ret = dev_err_probe(dev, PTR_ERR(retimer->typec_mux), > > + "failed to acquire mode-mux\n"); > > + goto err_switch_put; > > + } > > + > > + ret = drm_aux_bridge_register(dev); > > + if (ret) > > + goto err_mux_put; > > + > > + ret = clk_prepare_enable(retimer->xo_clk); > > + if (ret) { > > + dev_err(dev, "failed to enable XO: %d\n", ret); > > + goto err_mux_put; > > + } > > + > > + ret = ps883x_enable_vregs(retimer); > > + if (ret) > > + goto err_clk_disable; > > + > > + sw_desc.drvdata = retimer; > > + sw_desc.fwnode = dev_fwnode(dev); > > + sw_desc.set = ps883x_sw_set; > > + > > + retimer->sw = typec_switch_register(dev, &sw_desc); > > + if (IS_ERR(retimer->sw)) { > > + ret = PTR_ERR(retimer->sw); > > + dev_err(dev, "failed to register typec switch: %d\n", ret); > > Maybe dev_err_probe() as above? Yep. > > > + goto err_vregs_disable; > > + } > > + > > + rtmr_desc.drvdata = retimer; > > + rtmr_desc.fwnode = dev_fwnode(dev); > > + rtmr_desc.set = ps883x_retimer_set; > > + > > + retimer->retimer = typec_retimer_register(dev, &rtmr_desc); > > + if (IS_ERR(retimer->retimer)) { > > + ret = PTR_ERR(retimer->retimer); > > + dev_err(dev, "failed to register typec retimer: %d\n", ret); > > Maybe dev_err_probe() as above? Yep. > > > + goto err_switch_unregister; > > + } > > + > > + /* skip resetting if already configured */ > > + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) > > + return 0; > > + > > + gpiod_direction_output(retimer->reset_gpio, 1); > > + > > + /* VDD IO supply enable to reset release delay */ > > + usleep_range(4000, 14000); > > + > > + gpiod_set_value(retimer->reset_gpio, 0); > > + > > + /* firmware initialization delay */ > > + msleep(60); > > + > > + return 0; > > + > > +err_switch_unregister: > > + typec_switch_unregister(retimer->sw); > > +err_vregs_disable: > > + ps883x_disable_vregs(retimer); > > +err_clk_disable: > > + clk_disable_unprepare(retimer->xo_clk); > > +err_mux_put: > > + typec_mux_put(retimer->typec_mux); > > +err_switch_put: > > + typec_switch_put(retimer->typec_switch); > > + > > + return ret; > > +} > > + > > +static void ps883x_retimer_remove(struct i2c_client *client) > > +{ > > + struct ps883x_retimer *retimer = i2c_get_clientdata(client); > > + > > + typec_retimer_unregister(retimer->retimer); > > + typec_switch_unregister(retimer->sw); > > + > > + gpiod_set_value(retimer->reset_gpio, 1); > > + > > + regulator_disable(retimer->vddio_supply); > > + regulator_disable(retimer->vddat_supply); > > + regulator_disable(retimer->vddar_supply); > > + regulator_disable(retimer->vdd_supply); > > + regulator_disable(retimer->vdd33_cap_supply); > > + regulator_disable(retimer->vdd33_supply); > > ps883x_disable_vregs()? Makes sense. Will do > > > + > > + clk_disable_unprepare(retimer->xo_clk); > > + > > + typec_mux_put(retimer->typec_mux); > > + typec_switch_put(retimer->typec_switch); > > +} > > ... > > CJ Thanks for reviewing. Abel
On 24-11-04 11:25:40, Konrad Dybcio wrote: > On 4.11.2024 11:16 AM, Abel Vesa wrote: > > On 24-11-02 10:17:56, Konrad Dybcio wrote: > >> On 1.11.2024 5:29 PM, Abel Vesa wrote: > >>> The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, > >>> controlled over I2C. It usually sits between a USB/DisplayPort PHY > >>> and the Type-C connector, and provides orientation and altmode handling. > >>> > >>> The boards that use this retimer are the ones featuring the Qualcomm > >>> Snapdragon X Elite SoCs. > >>> > >>> Add a driver with support for the following modes: > >>> - DisplayPort 4-lanes > >>> - DisplayPort 2-lanes + USB3 > >>> - USB3 > >>> > >>> There is another variant of this retimer which is called PS8833. It seems > >>> to be really similar to the PS8830, so future-proof this driver by > >>> naming it ps883x. > >>> > >>> Signed-off-by: Abel Vesa <abel.vesa@linaro.org> > >>> --- > >> > >> [...] > >> > >>> +static void ps883x_configure(struct ps883x_retimer *retimer, int cfg0, int cfg1, int cfg2) > >>> +{ > >>> + regmap_write(retimer->regmap, 0x0, cfg0); > >>> + regmap_write(retimer->regmap, 0x1, cfg1); > >>> + regmap_write(retimer->regmap, 0x2, cfg2); > >>> +} > >> > >> Somewhere between introducing regcache and dropping it, you removed > >> muxing to a safe mode during _configure() > > > > Oh, yeah, I forgot to mention that in the change log, it seems. > > > > Configuring to safe mode is not needed since we always do that on > > unplug anyway. > > > >> > >> [...] > >> > >>> + /* skip resetting if already configured */ > >>> + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) > >>> + return 0; > >> > >> What is that register and what does BIT(0) mean? > > > > Looking at the documentation, the first register is > > REG_USB_PORT_CONN_STATUS and spans over the first 4 bytes. > > > > But it doesn't really help here. > > > > BIT(0) doesn't really have a name, it just says "Connection present". > > Please define both then. STATUS_CONNECTION_PRESENT sounds good for the bit. Sure, will do. For the register name I'll just define as: REG_USB_PORT_CONN_STATUS_1 REG_USB_PORT_CONN_STATUS_2 REG_USB_PORT_CONN_STATUS_3 And that's it. > > Konrad
diff --git a/drivers/usb/typec/mux/Kconfig b/drivers/usb/typec/mux/Kconfig index ce7db6ad30572a0a74890f5f11944fb3ff07f635..10c3464324dd7226e0c7304a99d6a558d3743553 100644 --- a/drivers/usb/typec/mux/Kconfig +++ b/drivers/usb/typec/mux/Kconfig @@ -56,6 +56,16 @@ config TYPEC_MUX_NB7VPQ904M Say Y or M if your system has a On Semiconductor NB7VPQ904M Type-C redriver chip found on some devices with a Type-C port. +config TYPEC_MUX_PS883X + tristate "Parade PS883x Type-C retimer driver" + depends on I2C + depends on DRM || DRM=n + select DRM_AUX_BRIDGE if DRM_BRIDGE && OF + select REGMAP_I2C + help + Say Y or M if your system has a Parade PS883x Type-C retimer chip + found on some devices with a Type-C port. + config TYPEC_MUX_PTN36502 tristate "NXP PTN36502 Type-C redriver driver" depends on I2C diff --git a/drivers/usb/typec/mux/Makefile b/drivers/usb/typec/mux/Makefile index bb96f30267af05b33b9277dcf1cc0e1527d2dcdd..732aded5f0590b21d45deb07bb9751d807c115f7 100644 --- a/drivers/usb/typec/mux/Makefile +++ b/drivers/usb/typec/mux/Makefile @@ -6,5 +6,6 @@ obj-$(CONFIG_TYPEC_MUX_PI3USB30532) += pi3usb30532.o obj-$(CONFIG_TYPEC_MUX_INTEL_PMC) += intel_pmc_mux.o obj-$(CONFIG_TYPEC_MUX_IT5205) += it5205.o obj-$(CONFIG_TYPEC_MUX_NB7VPQ904M) += nb7vpq904m.o +obj-$(CONFIG_TYPEC_MUX_PS883X) += ps883x.o obj-$(CONFIG_TYPEC_MUX_PTN36502) += ptn36502.o obj-$(CONFIG_TYPEC_MUX_WCD939X_USBSS) += wcd939x-usbss.o diff --git a/drivers/usb/typec/mux/ps883x.c b/drivers/usb/typec/mux/ps883x.c new file mode 100644 index 0000000000000000000000000000000000000000..101e3dc3a867601f13385f55935af5a9701e7ec3 --- /dev/null +++ b/drivers/usb/typec/mux/ps883x.c @@ -0,0 +1,422 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Parade ps883x usb retimer driver + * + * Copyright (C) 2024 Linaro Ltd. + */ + +#include <drm/bridge/aux-bridge.h> +#include <linux/clk.h> +#include <linux/gpio/consumer.h> +#include <linux/i2c.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/regmap.h> +#include <linux/regulator/consumer.h> +#include <linux/usb/typec_altmode.h> +#include <linux/usb/typec_dp.h> +#include <linux/usb/typec_mux.h> +#include <linux/usb/typec_retimer.h> + +struct ps883x_retimer { + struct i2c_client *client; + struct gpio_desc *reset_gpio; + struct regmap *regmap; + struct typec_switch_dev *sw; + struct typec_retimer *retimer; + struct clk *xo_clk; + struct regulator *vdd_supply; + struct regulator *vdd33_supply; + struct regulator *vdd33_cap_supply; + struct regulator *vddat_supply; + struct regulator *vddar_supply; + struct regulator *vddio_supply; + + struct typec_switch *typec_switch; + struct typec_mux *typec_mux; + + struct mutex lock; /* protect non-concurrent retimer & switch */ + + enum typec_orientation orientation; + unsigned long mode; + unsigned int svid; +}; + +static void ps883x_configure(struct ps883x_retimer *retimer, int cfg0, int cfg1, int cfg2) +{ + regmap_write(retimer->regmap, 0x0, cfg0); + regmap_write(retimer->regmap, 0x1, cfg1); + regmap_write(retimer->regmap, 0x2, cfg2); +} + +static int ps883x_set(struct ps883x_retimer *retimer) +{ + int cfg0 = 0x00; + int cfg1 = 0x00; + int cfg2 = 0x00; + + if (retimer->orientation == TYPEC_ORIENTATION_NONE || + retimer->mode == TYPEC_STATE_SAFE) { + ps883x_configure(retimer, 0x1, 0x0, 0x0); + return 0; + } + + if (retimer->mode != TYPEC_STATE_USB && retimer->svid != USB_TYPEC_DP_SID) + return -EINVAL; + + if (retimer->orientation == TYPEC_ORIENTATION_NORMAL) + cfg0 = 0x01; + else + cfg0 = 0x03; + + switch (retimer->mode) { + case TYPEC_STATE_USB: + cfg0 |= 0x20; + break; + + case TYPEC_DP_STATE_C: + cfg1 = 0x85; + break; + + case TYPEC_DP_STATE_D: + cfg0 |= 0x20; + cfg1 = 0x85; + break; + + case TYPEC_DP_STATE_E: + cfg1 = 0x81; + break; + + default: + return -EOPNOTSUPP; + } + + ps883x_configure(retimer, cfg0, cfg1, cfg2); + + return 0; +} + +static int ps883x_sw_set(struct typec_switch_dev *sw, + enum typec_orientation orientation) +{ + struct ps883x_retimer *retimer = typec_switch_get_drvdata(sw); + int ret = 0; + + ret = typec_switch_set(retimer->typec_switch, orientation); + if (ret) + return ret; + + mutex_lock(&retimer->lock); + + if (retimer->orientation != orientation) { + retimer->orientation = orientation; + + ret = ps883x_set(retimer); + } + + mutex_unlock(&retimer->lock); + + return ret; +} + +static int ps883x_retimer_set(struct typec_retimer *rtmr, + struct typec_retimer_state *state) +{ + struct ps883x_retimer *retimer = typec_retimer_get_drvdata(rtmr); + struct typec_mux_state mux_state; + int ret = 0; + + mutex_lock(&retimer->lock); + + if (state->mode != retimer->mode) { + retimer->mode = state->mode; + + if (state->alt) + retimer->svid = state->alt->svid; + else + retimer->svid = 0; // No SVID + + ret = ps883x_set(retimer); + } + + mutex_unlock(&retimer->lock); + + if (ret) + return ret; + + mux_state.alt = state->alt; + mux_state.data = state->data; + mux_state.mode = state->mode; + + return typec_mux_set(retimer->typec_mux, &mux_state); +} + +static int ps883x_enable_vregs(struct ps883x_retimer *retimer) +{ + struct device *dev = &retimer->client->dev; + int ret; + + ret = regulator_enable(retimer->vdd33_supply); + if (ret) { + dev_err(dev, "cannot enable VDD 3.3V regulator: %d\n", ret); + return ret; + } + + ret = regulator_enable(retimer->vdd33_cap_supply); + if (ret) { + dev_err(dev, "cannot enable VDD 3.3V CAP regulator: %d\n", ret); + goto err_vdd33_disable; + } + + usleep_range(4000, 10000); + + ret = regulator_enable(retimer->vdd_supply); + if (ret) { + dev_err(dev, "cannot enable VDD regulator: %d\n", ret); + goto err_vdd33_cap_disable; + } + + ret = regulator_enable(retimer->vddar_supply); + if (ret) { + dev_err(dev, "cannot enable VDD AR regulator: %d\n", ret); + goto err_vdd_disable; + } + + ret = regulator_enable(retimer->vddat_supply); + if (ret) { + dev_err(dev, "cannot enable VDD AT regulator: %d\n", ret); + goto err_vddar_disable; + } + + ret = regulator_enable(retimer->vddio_supply); + if (ret) { + dev_err(dev, "cannot enable VDD IO regulator: %d\n", ret); + goto err_vddat_disable; + } + + return 0; + +err_vddat_disable: + regulator_disable(retimer->vddat_supply); +err_vddar_disable: + regulator_disable(retimer->vddar_supply); +err_vdd_disable: + regulator_disable(retimer->vdd_supply); +err_vdd33_cap_disable: + regulator_disable(retimer->vdd33_cap_supply); +err_vdd33_disable: + regulator_disable(retimer->vdd33_supply); + + return ret; +} + +static void ps883x_disable_vregs(struct ps883x_retimer *retimer) +{ + regulator_disable(retimer->vddio_supply); + regulator_disable(retimer->vddat_supply); + regulator_disable(retimer->vddar_supply); + regulator_disable(retimer->vdd_supply); + regulator_disable(retimer->vdd33_cap_supply); + regulator_disable(retimer->vdd33_supply); +} + +static int ps883x_get_vregs(struct ps883x_retimer *retimer) +{ + struct device *dev = &retimer->client->dev; + + retimer->vdd_supply = devm_regulator_get(dev, "vdd"); + if (IS_ERR(retimer->vdd_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vdd_supply), + "failed to get VDD\n"); + + retimer->vdd33_supply = devm_regulator_get(dev, "vdd33"); + if (IS_ERR(retimer->vdd33_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_supply), + "failed to get VDD 3.3V\n"); + + retimer->vdd33_cap_supply = devm_regulator_get(dev, "vdd33-cap"); + if (IS_ERR(retimer->vdd33_cap_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vdd33_cap_supply), + "failed to get VDD CAP 3.3V\n"); + + retimer->vddat_supply = devm_regulator_get(dev, "vddat"); + if (IS_ERR(retimer->vddat_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vddat_supply), + "failed to get VDD AT\n"); + + retimer->vddar_supply = devm_regulator_get(dev, "vddar"); + if (IS_ERR(retimer->vddar_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vddar_supply), + "failed to get VDD AR\n"); + + retimer->vddio_supply = devm_regulator_get(dev, "vddio"); + if (IS_ERR(retimer->vddio_supply)) + return dev_err_probe(dev, PTR_ERR(retimer->vddio_supply), + "failed to get VDD IO\n"); + + return 0; +} + +static const struct regmap_config ps883x_retimer_regmap = { + .max_register = 0x1f, + .reg_bits = 8, + .val_bits = 8, +}; + +static int ps883x_retimer_probe(struct i2c_client *client) +{ + struct device *dev = &client->dev; + struct typec_switch_desc sw_desc = { }; + struct typec_retimer_desc rtmr_desc = { }; + struct ps883x_retimer *retimer; + int ret; + + retimer = devm_kzalloc(dev, sizeof(*retimer), GFP_KERNEL); + if (!retimer) + return -ENOMEM; + + retimer->client = client; + + mutex_init(&retimer->lock); + + retimer->regmap = devm_regmap_init_i2c(client, &ps883x_retimer_regmap); + if (IS_ERR(retimer->regmap)) { + ret = PTR_ERR(retimer->regmap); + dev_err(dev, "failed to allocate register map: %d\n", ret); + return ret; + } + + ret = ps883x_get_vregs(retimer); + if (ret) + return ret; + + retimer->xo_clk = devm_clk_get(dev, NULL); + if (IS_ERR(retimer->xo_clk)) + return dev_err_probe(dev, PTR_ERR(retimer->xo_clk), + "failed to get xo clock\n"); + + retimer->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_ASIS); + if (IS_ERR(retimer->reset_gpio)) + return dev_err_probe(dev, PTR_ERR(retimer->reset_gpio), + "failed to get reset gpio\n"); + + retimer->typec_switch = typec_switch_get(dev); + if (IS_ERR(retimer->typec_switch)) + return dev_err_probe(dev, PTR_ERR(retimer->typec_switch), + "failed to acquire orientation-switch\n"); + + retimer->typec_mux = typec_mux_get(dev); + if (IS_ERR(retimer->typec_mux)) { + ret = dev_err_probe(dev, PTR_ERR(retimer->typec_mux), + "failed to acquire mode-mux\n"); + goto err_switch_put; + } + + ret = drm_aux_bridge_register(dev); + if (ret) + goto err_mux_put; + + ret = clk_prepare_enable(retimer->xo_clk); + if (ret) { + dev_err(dev, "failed to enable XO: %d\n", ret); + goto err_mux_put; + } + + ret = ps883x_enable_vregs(retimer); + if (ret) + goto err_clk_disable; + + sw_desc.drvdata = retimer; + sw_desc.fwnode = dev_fwnode(dev); + sw_desc.set = ps883x_sw_set; + + retimer->sw = typec_switch_register(dev, &sw_desc); + if (IS_ERR(retimer->sw)) { + ret = PTR_ERR(retimer->sw); + dev_err(dev, "failed to register typec switch: %d\n", ret); + goto err_vregs_disable; + } + + rtmr_desc.drvdata = retimer; + rtmr_desc.fwnode = dev_fwnode(dev); + rtmr_desc.set = ps883x_retimer_set; + + retimer->retimer = typec_retimer_register(dev, &rtmr_desc); + if (IS_ERR(retimer->retimer)) { + ret = PTR_ERR(retimer->retimer); + dev_err(dev, "failed to register typec retimer: %d\n", ret); + goto err_switch_unregister; + } + + /* skip resetting if already configured */ + if (regmap_test_bits(retimer->regmap, 0x00, BIT(0))) + return 0; + + gpiod_direction_output(retimer->reset_gpio, 1); + + /* VDD IO supply enable to reset release delay */ + usleep_range(4000, 14000); + + gpiod_set_value(retimer->reset_gpio, 0); + + /* firmware initialization delay */ + msleep(60); + + return 0; + +err_switch_unregister: + typec_switch_unregister(retimer->sw); +err_vregs_disable: + ps883x_disable_vregs(retimer); +err_clk_disable: + clk_disable_unprepare(retimer->xo_clk); +err_mux_put: + typec_mux_put(retimer->typec_mux); +err_switch_put: + typec_switch_put(retimer->typec_switch); + + return ret; +} + +static void ps883x_retimer_remove(struct i2c_client *client) +{ + struct ps883x_retimer *retimer = i2c_get_clientdata(client); + + typec_retimer_unregister(retimer->retimer); + typec_switch_unregister(retimer->sw); + + gpiod_set_value(retimer->reset_gpio, 1); + + regulator_disable(retimer->vddio_supply); + regulator_disable(retimer->vddat_supply); + regulator_disable(retimer->vddar_supply); + regulator_disable(retimer->vdd_supply); + regulator_disable(retimer->vdd33_cap_supply); + regulator_disable(retimer->vdd33_supply); + + clk_disable_unprepare(retimer->xo_clk); + + typec_mux_put(retimer->typec_mux); + typec_switch_put(retimer->typec_switch); +} + +static const struct of_device_id ps883x_retimer_of_table[] = { + { .compatible = "parade,ps8830" }, + { } +}; +MODULE_DEVICE_TABLE(of, ps883x_retimer_of_table); + +static struct i2c_driver ps883x_retimer_driver = { + .driver = { + .name = "ps883x_retimer", + .of_match_table = ps883x_retimer_of_table, + }, + .probe = ps883x_retimer_probe, + .remove = ps883x_retimer_remove, +}; + +module_i2c_driver(ps883x_retimer_driver); + +MODULE_DESCRIPTION("Parade ps883x Type-C Retimer driver"); +MODULE_LICENSE("GPL");
The Parade PS8830 is a USB4, DisplayPort and Thunderbolt 4 retimer, controlled over I2C. It usually sits between a USB/DisplayPort PHY and the Type-C connector, and provides orientation and altmode handling. The boards that use this retimer are the ones featuring the Qualcomm Snapdragon X Elite SoCs. Add a driver with support for the following modes: - DisplayPort 4-lanes - DisplayPort 2-lanes + USB3 - USB3 There is another variant of this retimer which is called PS8833. It seems to be really similar to the PS8830, so future-proof this driver by naming it ps883x. Signed-off-by: Abel Vesa <abel.vesa@linaro.org> --- drivers/usb/typec/mux/Kconfig | 10 + drivers/usb/typec/mux/Makefile | 1 + drivers/usb/typec/mux/ps883x.c | 422 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 433 insertions(+)