1*2513563eSHans de Goede // SPDX-License-Identifier: GPL-2.0-or-later
2*2513563eSHans de Goede /*
3*2513563eSHans de Goede * Driver to power on the Analogix ANX7428 USB Type-C crosspoint switch
4*2513563eSHans de Goede * on MeeGoPad top-set boxes.
5*2513563eSHans de Goede *
6*2513563eSHans de Goede * The MeeGoPad T8 and T9 are Cherry Trail top-set boxes which
7*2513563eSHans de Goede * use an ANX7428 to provide a Type-C port with USB3.1 Gen 1 and
8*2513563eSHans de Goede * DisplayPort over Type-C alternate mode support.
9*2513563eSHans de Goede *
10*2513563eSHans de Goede * The ANX7428 has a microcontroller which takes care of the PD
11*2513563eSHans de Goede * negotiation and automatically sets the builtin Crosspoint Switch
12*2513563eSHans de Goede * to send the right signal to the 4 highspeed pairs of the Type-C
13*2513563eSHans de Goede * connector. It also takes care of HPD and AUX channel routing for
14*2513563eSHans de Goede * DP alternate mode.
15*2513563eSHans de Goede *
16*2513563eSHans de Goede * IOW the ANX7428 operates fully autonomous and to the x5-Z8350 SoC
17*2513563eSHans de Goede * things look like there simply is a USB-3 Type-A connector and a
18*2513563eSHans de Goede * separate DisplayPort connector. Except that the BIOS does not
19*2513563eSHans de Goede * power on the ANX7428 at boot. This driver takes care of powering
20*2513563eSHans de Goede * on the ANX7428.
21*2513563eSHans de Goede *
22*2513563eSHans de Goede * It should be possible to tell the micro-controller which data- and/or
23*2513563eSHans de Goede * power-role to negotiate and to swap the role(s) after negotiation
24*2513563eSHans de Goede * but the MeeGoPad top-set boxes always draw their power from a separate
25*2513563eSHans de Goede * power-connector and they only support USB host-mode. So this functionality
26*2513563eSHans de Goede * is unnecessary and due to lack of documentation this is tricky to support.
27*2513563eSHans de Goede *
28*2513563eSHans de Goede * For a more complete ANX7428 driver see drivers/usb/misc/anx7418/ of
29*2513563eSHans de Goede * the LineageOS kernel for the LG G5 (International) aka the LG H850:
30*2513563eSHans de Goede * https://github.com/LineageOS/android_kernel_lge_msm8996/
31*2513563eSHans de Goede *
32*2513563eSHans de Goede * (C) Copyright 2024 Hans de Goede <hansg@kernel.org>
33*2513563eSHans de Goede */
34*2513563eSHans de Goede
35*2513563eSHans de Goede #include <linux/acpi.h>
36*2513563eSHans de Goede #include <linux/bits.h>
37*2513563eSHans de Goede #include <linux/delay.h>
38*2513563eSHans de Goede #include <linux/dev_printk.h>
39*2513563eSHans de Goede #include <linux/dmi.h>
40*2513563eSHans de Goede #include <linux/err.h>
41*2513563eSHans de Goede #include <linux/gpio/consumer.h>
42*2513563eSHans de Goede #include <linux/i2c.h>
43*2513563eSHans de Goede #include <linux/iopoll.h>
44*2513563eSHans de Goede #include <linux/module.h>
45*2513563eSHans de Goede #include <linux/types.h>
46*2513563eSHans de Goede
47*2513563eSHans de Goede /* Register addresses and fields */
48*2513563eSHans de Goede #define VENDOR_ID 0x00
49*2513563eSHans de Goede #define DEVICE_ID 0x02
50*2513563eSHans de Goede
51*2513563eSHans de Goede #define TX_STATUS 0x16
52*2513563eSHans de Goede #define STATUS_SUCCESS BIT(0)
53*2513563eSHans de Goede #define STATUS_ERROR BIT(1)
54*2513563eSHans de Goede #define OCM_STARTUP BIT(7)
55*2513563eSHans de Goede
56*2513563eSHans de Goede static bool force;
57*2513563eSHans de Goede module_param(force, bool, 0444);
58*2513563eSHans de Goede MODULE_PARM_DESC(force, "Force the driver to probe on unknown boards");
59*2513563eSHans de Goede
60*2513563eSHans de Goede static const struct acpi_gpio_params enable_gpio = { 0, 0, false };
61*2513563eSHans de Goede static const struct acpi_gpio_params reset_gpio = { 1, 0, true };
62*2513563eSHans de Goede
63*2513563eSHans de Goede static const struct acpi_gpio_mapping meegopad_anx7428_gpios[] = {
64*2513563eSHans de Goede { "enable-gpios", &enable_gpio, 1 },
65*2513563eSHans de Goede { "reset-gpios", &reset_gpio, 1 },
66*2513563eSHans de Goede { }
67*2513563eSHans de Goede };
68*2513563eSHans de Goede
69*2513563eSHans de Goede static const struct dmi_system_id meegopad_anx7428_ids[] = {
70*2513563eSHans de Goede {
71*2513563eSHans de Goede /* Meegopad T08 */
72*2513563eSHans de Goede .matches = {
73*2513563eSHans de Goede DMI_MATCH(DMI_SYS_VENDOR, "Default string"),
74*2513563eSHans de Goede DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
75*2513563eSHans de Goede DMI_MATCH(DMI_BOARD_NAME, "T3 MRD"),
76*2513563eSHans de Goede DMI_MATCH(DMI_BOARD_VERSION, "V1.1"),
77*2513563eSHans de Goede },
78*2513563eSHans de Goede },
79*2513563eSHans de Goede { }
80*2513563eSHans de Goede };
81*2513563eSHans de Goede
anx7428_probe(struct i2c_client * client)82*2513563eSHans de Goede static int anx7428_probe(struct i2c_client *client)
83*2513563eSHans de Goede {
84*2513563eSHans de Goede struct device *dev = &client->dev;
85*2513563eSHans de Goede struct gpio_desc *gpio;
86*2513563eSHans de Goede int ret, val;
87*2513563eSHans de Goede
88*2513563eSHans de Goede if (!dmi_check_system(meegopad_anx7428_ids) && !force) {
89*2513563eSHans de Goede dev_warn(dev, "Not probing unknown board, pass meegopad_anx7428.force=1 to probe");
90*2513563eSHans de Goede return -ENODEV;
91*2513563eSHans de Goede }
92*2513563eSHans de Goede
93*2513563eSHans de Goede ret = devm_acpi_dev_add_driver_gpios(dev, meegopad_anx7428_gpios);
94*2513563eSHans de Goede if (ret)
95*2513563eSHans de Goede return ret;
96*2513563eSHans de Goede
97*2513563eSHans de Goede /*
98*2513563eSHans de Goede * Set GPIOs to desired values while getting them, they are not needed
99*2513563eSHans de Goede * afterwards. Ordering and delays come from android_kernel_lge_msm8996.
100*2513563eSHans de Goede */
101*2513563eSHans de Goede gpio = devm_gpiod_get(dev, "enable", GPIOD_OUT_HIGH);
102*2513563eSHans de Goede if (IS_ERR(gpio))
103*2513563eSHans de Goede return dev_err_probe(dev, PTR_ERR(gpio), "getting enable GPIO\n");
104*2513563eSHans de Goede
105*2513563eSHans de Goede fsleep(10000);
106*2513563eSHans de Goede
107*2513563eSHans de Goede gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_LOW);
108*2513563eSHans de Goede if (IS_ERR(gpio))
109*2513563eSHans de Goede return dev_err_probe(dev, PTR_ERR(gpio), "getting reset GPIO\n");
110*2513563eSHans de Goede
111*2513563eSHans de Goede /* Wait for the OCM (On Chip Microcontroller) to start */
112*2513563eSHans de Goede ret = read_poll_timeout(i2c_smbus_read_byte_data, val,
113*2513563eSHans de Goede val >= 0 && (val & OCM_STARTUP),
114*2513563eSHans de Goede 5000, 50000, true, client, TX_STATUS);
115*2513563eSHans de Goede if (ret)
116*2513563eSHans de Goede return dev_err_probe(dev, ret,
117*2513563eSHans de Goede "On Chip Microcontroller did not start, status: 0x%02x\n",
118*2513563eSHans de Goede val);
119*2513563eSHans de Goede
120*2513563eSHans de Goede ret = i2c_smbus_read_word_data(client, VENDOR_ID);
121*2513563eSHans de Goede if (ret < 0)
122*2513563eSHans de Goede return dev_err_probe(dev, ret, "reading vendor-id register\n");
123*2513563eSHans de Goede val = ret;
124*2513563eSHans de Goede
125*2513563eSHans de Goede ret = i2c_smbus_read_word_data(client, DEVICE_ID);
126*2513563eSHans de Goede if (ret < 0)
127*2513563eSHans de Goede return dev_err_probe(dev, ret, "reading device-id register\n");
128*2513563eSHans de Goede
129*2513563eSHans de Goede dev_dbg(dev, "Powered on ANX7428 id %04x:%04x\n", val, ret);
130*2513563eSHans de Goede return 0;
131*2513563eSHans de Goede }
132*2513563eSHans de Goede
133*2513563eSHans de Goede static const struct acpi_device_id anx7428_acpi_match[] = {
134*2513563eSHans de Goede { "ANXO7418" }, /* ACPI says 7418 (max 2 DP lanes version) but HW is 7428 */
135*2513563eSHans de Goede { }
136*2513563eSHans de Goede };
137*2513563eSHans de Goede MODULE_DEVICE_TABLE(acpi, anx7428_acpi_match);
138*2513563eSHans de Goede
139*2513563eSHans de Goede static struct i2c_driver anx7428_driver = {
140*2513563eSHans de Goede .driver = {
141*2513563eSHans de Goede .name = "meegopad_anx7428",
142*2513563eSHans de Goede .acpi_match_table = anx7428_acpi_match,
143*2513563eSHans de Goede },
144*2513563eSHans de Goede .probe = anx7428_probe,
145*2513563eSHans de Goede };
146*2513563eSHans de Goede module_i2c_driver(anx7428_driver);
147*2513563eSHans de Goede
148*2513563eSHans de Goede MODULE_AUTHOR("Hans de Goede <hansg@kernel.org>");
149*2513563eSHans de Goede MODULE_DESCRIPTION("MeeGoPad ANX7428 driver");
150*2513563eSHans de Goede MODULE_LICENSE("GPL");
151