| Message ID | 20250307094823.478152-1-adrian@mainlining.org |
|---|---|
| Headers | show |
| Series | Add Goodix Berlin-A series support | expand |
On 07/03/2025 10:48, Jens Reidel wrote: > The current implementation of the goodix_berlin driver lacks support for > revisions A and B of the Berlin IC. This change adds support for the > gt9897 IC, which is a Berlin-A revision part. > > The differences between revision D and A are rather minor, a handful of > address changes and a slightly larger read buffer. They were taken from > the driver published by Goodix, which does a few more things that don't > appear to be necessary for the touchscreen to work properly. > > Tested-by: Luca Weiss <luca.weiss@fairphone.com> > Signed-off-by: Jens Reidel <adrian@mainlining.org> > --- > drivers/input/touchscreen/goodix_berlin.h | 16 ++++++- > .../input/touchscreen/goodix_berlin_core.c | 21 ++++---- > drivers/input/touchscreen/goodix_berlin_i2c.c | 14 ++++-- > drivers/input/touchscreen/goodix_berlin_spi.c | 48 ++++++++++++++----- > 4 files changed, 73 insertions(+), 26 deletions(-) > > diff --git a/drivers/input/touchscreen/goodix_berlin.h b/drivers/input/touchscreen/goodix_berlin.h > index 38b6f9ddbdef..d8bbd4853206 100644 > --- a/drivers/input/touchscreen/goodix_berlin.h > +++ b/drivers/input/touchscreen/goodix_berlin.h > @@ -12,12 +12,26 @@ > > #include <linux/pm.h> > > +#define GOODIX_BERLIN_FW_VERSION_INFO_ADDR_A 0x1000C > +#define GOODIX_BERLIN_FW_VERSION_INFO_ADDR_D 0x10014 > + > +#define GOODIX_BERLIN_IC_INFO_ADDR_A 0x10068 > +#define GOODIX_BERLIN_IC_INFO_ADDR_D 0x10070 > + > +struct goodix_berlin_ic_data { > + int fw_version_info_addr; > + int ic_info_addr; > + ssize_t read_dummy_len; > + ssize_t read_prefix_len; > +}; > + > struct device; > struct input_id; > struct regmap; > > int goodix_berlin_probe(struct device *dev, int irq, const struct input_id *id, > - struct regmap *regmap); > + struct regmap *regmap, > + const struct goodix_berlin_ic_data *ic_data); > > extern const struct dev_pm_ops goodix_berlin_pm_ops; > extern const struct attribute_group *goodix_berlin_groups[]; > diff --git a/drivers/input/touchscreen/goodix_berlin_core.c b/drivers/input/touchscreen/goodix_berlin_core.c > index f7ea443b152e..02a1d9a465f2 100644 > --- a/drivers/input/touchscreen/goodix_berlin_core.c > +++ b/drivers/input/touchscreen/goodix_berlin_core.c > @@ -12,7 +12,7 @@ > * to the previous generations. > * > * Currently the driver only handles Multitouch events with already > - * programmed firmware and "config" for "Revision D" Berlin IC. > + * programmed firmware and "config" for "Revision A/D" Berlin IC. > * > * Support is missing for: > * - ESD Management > @@ -20,7 +20,7 @@ > * - "Config" update/flashing > * - Stylus Events > * - Gesture Events > - * - Support for older revisions (A & B) > + * - Support for revision B > */ > > #include <linux/bitfield.h> > @@ -28,6 +28,7 @@ > #include <linux/input.h> > #include <linux/input/mt.h> > #include <linux/input/touchscreen.h> > +#include <linux/property.h> > #include <linux/regmap.h> > #include <linux/regulator/consumer.h> > #include <linux/sizes.h> > @@ -53,10 +54,8 @@ > > #define GOODIX_BERLIN_DEV_CONFIRM_VAL 0xAA > #define GOODIX_BERLIN_BOOTOPTION_ADDR 0x10000 > -#define GOODIX_BERLIN_FW_VERSION_INFO_ADDR 0x10014 > > #define GOODIX_BERLIN_IC_INFO_MAX_LEN SZ_1K > -#define GOODIX_BERLIN_IC_INFO_ADDR 0x10070 > > #define GOODIX_BERLIN_CHECKSUM_SIZE sizeof(u16) > > @@ -175,6 +174,8 @@ struct goodix_berlin_core { > /* Runtime parameters extracted from IC_INFO buffer */ > u32 touch_data_addr; > > + const struct goodix_berlin_ic_data *ic_data; > + > struct goodix_berlin_event event; > }; > > @@ -299,7 +300,7 @@ static int goodix_berlin_read_version(struct goodix_berlin_core *cd) > { > int error; > > - error = regmap_raw_read(cd->regmap, GOODIX_BERLIN_FW_VERSION_INFO_ADDR, > + error = regmap_raw_read(cd->regmap, cd->ic_data->fw_version_info_addr, > &cd->fw_version, sizeof(cd->fw_version)); > if (error) { > dev_err(cd->dev, "error reading fw version, %d\n", error); > @@ -367,7 +368,7 @@ static int goodix_berlin_get_ic_info(struct goodix_berlin_core *cd) > if (!afe_data) > return -ENOMEM; > > - error = regmap_raw_read(cd->regmap, GOODIX_BERLIN_IC_INFO_ADDR, > + error = regmap_raw_read(cd->regmap, cd->ic_data->ic_info_addr, > &length_raw, sizeof(length_raw)); > if (error) { > dev_err(cd->dev, "failed get ic info length, %d\n", error); > @@ -380,8 +381,8 @@ static int goodix_berlin_get_ic_info(struct goodix_berlin_core *cd) > return -EINVAL; > } > > - error = regmap_raw_read(cd->regmap, GOODIX_BERLIN_IC_INFO_ADDR, > - afe_data, length); > + error = regmap_raw_read(cd->regmap, cd->ic_data->ic_info_addr, afe_data, > + length); > if (error) { > dev_err(cd->dev, "failed get ic info data, %d\n", error); > return error; > @@ -716,7 +717,8 @@ const struct attribute_group *goodix_berlin_groups[] = { > EXPORT_SYMBOL_GPL(goodix_berlin_groups); > > int goodix_berlin_probe(struct device *dev, int irq, const struct input_id *id, > - struct regmap *regmap) > + struct regmap *regmap, > + const struct goodix_berlin_ic_data *ic_data) > { > struct goodix_berlin_core *cd; > int error; > @@ -733,6 +735,7 @@ int goodix_berlin_probe(struct device *dev, int irq, const struct input_id *id, > cd->dev = dev; > cd->regmap = regmap; > cd->irq = irq; > + cd->ic_data = ic_data; > > cd->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH); > if (IS_ERR(cd->reset_gpio)) > diff --git a/drivers/input/touchscreen/goodix_berlin_i2c.c b/drivers/input/touchscreen/goodix_berlin_i2c.c > index ad7a60d94338..059a25537aad 100644 > --- a/drivers/input/touchscreen/goodix_berlin_i2c.c > +++ b/drivers/input/touchscreen/goodix_berlin_i2c.c > @@ -31,6 +31,8 @@ static const struct input_id goodix_berlin_i2c_input_id = { > > static int goodix_berlin_i2c_probe(struct i2c_client *client) > { > + const struct goodix_berlin_ic_data *ic_data = > + i2c_get_match_data(cd->dev); > struct regmap *regmap; > int error; > > @@ -39,22 +41,28 @@ static int goodix_berlin_i2c_probe(struct i2c_client *client) > return PTR_ERR(regmap); > > error = goodix_berlin_probe(&client->dev, client->irq, > - &goodix_berlin_i2c_input_id, regmap); > + &goodix_berlin_i2c_input_id, regmap, > + ic_data); > if (error) > return error; > > return 0; > } > > +static const struct goodix_berlin_ic_data gt9916_data = { > + .fw_version_info_addr = GOODIX_BERLIN_FW_VERSION_INFO_ADDR_D, > + .ic_info_addr = GOODIX_BERLIN_IC_INFO_ADDR_D, > +}; > + > static const struct i2c_device_id goodix_berlin_i2c_id[] = { > - { "gt9916" }, > + { .name = "gt9916", .driver_data = (long)>9916_data }, > { } > }; > > MODULE_DEVICE_TABLE(i2c, goodix_berlin_i2c_id); > > static const struct of_device_id goodix_berlin_i2c_of_match[] = { > - { .compatible = "goodix,gt9916", }, > + { .compatible = "goodix,gt9916", .data = >9916_data }, > { } > }; > MODULE_DEVICE_TABLE(of, goodix_berlin_i2c_of_match); > diff --git a/drivers/input/touchscreen/goodix_berlin_spi.c b/drivers/input/touchscreen/goodix_berlin_spi.c > index 0662e87b8692..01f850f484c2 100644 > --- a/drivers/input/touchscreen/goodix_berlin_spi.c > +++ b/drivers/input/touchscreen/goodix_berlin_spi.c > @@ -18,10 +18,14 @@ > > #define GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN 1 > #define GOODIX_BERLIN_REGISTER_WIDTH 4 > -#define GOODIX_BERLIN_SPI_READ_DUMMY_LEN 3 > -#define GOODIX_BERLIN_SPI_READ_PREFIX_LEN (GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN + \ > +#define GOODIX_BERLIN_SPI_READ_DUMMY_LEN_A 4 > +#define GOODIX_BERLIN_SPI_READ_DUMMY_LEN_D 3 > +#define GOODIX_BERLIN_SPI_READ_PREFIX_LEN_A (GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN + \ > GOODIX_BERLIN_REGISTER_WIDTH + \ > - GOODIX_BERLIN_SPI_READ_DUMMY_LEN) > + GOODIX_BERLIN_SPI_READ_DUMMY_LEN_A) > +#define GOODIX_BERLIN_SPI_READ_PREFIX_LEN_D (GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN + \ > + GOODIX_BERLIN_REGISTER_WIDTH + \ > + GOODIX_BERLIN_SPI_READ_DUMMY_LEN_D) > #define GOODIX_BERLIN_SPI_WRITE_PREFIX_LEN (GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN + \ > GOODIX_BERLIN_REGISTER_WIDTH) > > @@ -33,6 +37,7 @@ static int goodix_berlin_spi_read(void *context, const void *reg_buf, > size_t val_size) > { > struct spi_device *spi = context; > + const struct goodix_berlin_ic_data *ic_data = spi_get_device_match_data(spi); > struct spi_transfer xfers; > struct spi_message spi_msg; > const u32 *reg = reg_buf; /* reg is stored as native u32 at start of buffer */ > @@ -42,23 +47,22 @@ static int goodix_berlin_spi_read(void *context, const void *reg_buf, > return -EINVAL; > > u8 *buf __free(kfree) = > - kzalloc(GOODIX_BERLIN_SPI_READ_PREFIX_LEN + val_size, > - GFP_KERNEL); > + kzalloc(ic_data->read_prefix_len + val_size, GFP_KERNEL); > if (!buf) > return -ENOMEM; > > spi_message_init(&spi_msg); > memset(&xfers, 0, sizeof(xfers)); > > - /* buffer format: 0xF1 + addr(4bytes) + dummy(3bytes) + data */ > + /* buffer format: 0xF1 + addr(4bytes) + dummy(3/4bytes) + data */ > buf[0] = GOODIX_BERLIN_SPI_READ_FLAG; > put_unaligned_be32(*reg, buf + GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN); > memset(buf + GOODIX_BERLIN_SPI_TRANS_PREFIX_LEN + GOODIX_BERLIN_REGISTER_WIDTH, > - 0xff, GOODIX_BERLIN_SPI_READ_DUMMY_LEN); > + 0xff, ic_data->read_dummy_len); > > xfers.tx_buf = buf; > xfers.rx_buf = buf; > - xfers.len = GOODIX_BERLIN_SPI_READ_PREFIX_LEN + val_size; > + xfers.len = ic_data->read_prefix_len + val_size; > xfers.cs_change = 0; > spi_message_add_tail(&xfers, &spi_msg); > > @@ -68,7 +72,7 @@ static int goodix_berlin_spi_read(void *context, const void *reg_buf, > return error; > } > > - memcpy(val_buf, buf + GOODIX_BERLIN_SPI_READ_PREFIX_LEN, val_size); > + memcpy(val_buf, buf + ic_data->read_prefix_len, val_size); > return error; > } > > @@ -123,6 +127,7 @@ static const struct input_id goodix_berlin_spi_input_id = { > > static int goodix_berlin_spi_probe(struct spi_device *spi) > { > + const struct goodix_berlin_ic_data *ic_data = spi_get_device_match_data(spi); > struct regmap_config regmap_config; > struct regmap *regmap; > size_t max_size; > @@ -137,7 +142,7 @@ static int goodix_berlin_spi_probe(struct spi_device *spi) > max_size = spi_max_transfer_size(spi); > > regmap_config = goodix_berlin_spi_regmap_conf; > - regmap_config.max_raw_read = max_size - GOODIX_BERLIN_SPI_READ_PREFIX_LEN; > + regmap_config.max_raw_read = max_size - ic_data->read_prefix_len; > regmap_config.max_raw_write = max_size - GOODIX_BERLIN_SPI_WRITE_PREFIX_LEN; > > regmap = devm_regmap_init(&spi->dev, NULL, spi, ®map_config); > @@ -145,21 +150,38 @@ static int goodix_berlin_spi_probe(struct spi_device *spi) > return PTR_ERR(regmap); > > error = goodix_berlin_probe(&spi->dev, spi->irq, > - &goodix_berlin_spi_input_id, regmap); > + &goodix_berlin_spi_input_id, regmap, > + ic_data); > if (error) > return error; > > return 0; > } > > +static const struct goodix_berlin_ic_data gt9897_data = { > + .fw_version_info_addr = GOODIX_BERLIN_FW_VERSION_INFO_ADDR_A, > + .ic_info_addr = GOODIX_BERLIN_IC_INFO_ADDR_A, > + .read_dummy_len = GOODIX_BERLIN_SPI_READ_DUMMY_LEN_A, > + .read_prefix_len = GOODIX_BERLIN_SPI_READ_PREFIX_LEN_A, > +}; > + > +static const struct goodix_berlin_ic_data gt9916_data = { > + .fw_version_info_addr = GOODIX_BERLIN_FW_VERSION_INFO_ADDR_D, > + .ic_info_addr = GOODIX_BERLIN_IC_INFO_ADDR_D, > + .read_dummy_len = GOODIX_BERLIN_SPI_READ_DUMMY_LEN_D, > + .read_prefix_len = GOODIX_BERLIN_SPI_READ_PREFIX_LEN_D, > +}; > + > static const struct spi_device_id goodix_berlin_spi_ids[] = { > - { "gt9916" }, > + { .name = "gt9897", .driver_data = (long)>9897_data }, > + { .name = "gt9916", .driver_data = (long)>9916_data }, > { }, > }; > MODULE_DEVICE_TABLE(spi, goodix_berlin_spi_ids); > > static const struct of_device_id goodix_berlin_spi_of_match[] = { > - { .compatible = "goodix,gt9916", }, > + { .compatible = "goodix,gt9897", .data = >9897_data }, > + { .compatible = "goodix,gt9916", .data = >9916_data }, > { } > }; > MODULE_DEVICE_TABLE(of, goodix_berlin_spi_of_match); Thanks ! Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>
This series adds support for the Goodix Berlin-A series touch ICs (gt9897). This was tested on a Xiaomi 11 Lite 5G NE (xiaomi-lisa), which uses the gt9897 IC connected over SPI. I am not aware of any device that has gt9897 connected over I2C and therefore could not test it, so I didn't add a compatible in the I2C driver. Changes in v3: - Store the ic data in the goodix_berlin_core struct and pass it to goodix_berlin_probe from the i2c/spi probes (requested by Neil) - Resent from my now preferred e-mail for kernel work Changes in v2: - Added Rob's A-b tag (patch no. 1) - Added Luca's T-b tag (patch no. 2) - Updated the i2c and spi device id tables with the driver data and switched to spi_get_device_match_data where possible (requested by Neil) - Switched to device_get_match_data in goodix_berlin_core.c - Move all revision specific addresses and other properties into the goodix_berlin_ic_data struct (requested by Dmitry) - Link to v1: https://lore.kernel.org/all/20250203174309.21574-1-adrian@travitia.xyz/ To: Dmitry Torokhov <dmitry.torokhov@gmail.com> To: Rob Herring <robh@kernel.org> To: Krzysztof Kozlowski <krzk+dt@kernel.org> To: Conor Dooley <conor+dt@kernel.org> To: Bastien Nocera <hadess@hadess.net> To: Hans de Goede <hdegoede@redhat.com> To: Neil Armstrong <neil.armstrong@linaro.org> Cc: Luca Weiss <luca.weiss@fairphone.com> Cc: linux-input@vger.kernel.org Cc: devicetree@vger.kernel.org Cc: linux-kernel@vger.kernel.org Cc: phone-devel@vger.kernel.org Cc: linux@mainlining.org Cc: ~postmarketos/upstreaming@lists.sr.ht Signed-off-by: Jens Reidel <adrian@mainlining.org> Jens Reidel (2): dt-bindings: input: goodix,gt9916: Document gt9897 compatible Input: goodix_berlin - Add support for Berlin-A series .../input/touchscreen/goodix,gt9916.yaml | 1 + drivers/input/touchscreen/goodix_berlin.h | 16 ++++++- .../input/touchscreen/goodix_berlin_core.c | 21 ++++---- drivers/input/touchscreen/goodix_berlin_i2c.c | 14 ++++-- drivers/input/touchscreen/goodix_berlin_spi.c | 48 ++++++++++++++----- 5 files changed, 74 insertions(+), 26 deletions(-)