Re: [PATCH v3 2/3] platform: arm64: dell-xps-ec: new driver
Aleksandrs Vinarskis <[email protected]>
| Newsgroups | org.kernel.vger.platform-driver-x86,org.kernel.vger.linux-arm-msm,org.kernel.vger.linux-devicetree,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <6BXqGe3dUjlSSoYUgSDvrO0rn9-g1fATSBg3KqwoG4kXZNXsPYKBQd4ZtFx7iYwxhm8zIC8QW9zZSHxb716u_8XhOiHeHkhs2Ah4kwuwSIg=@vinarskis.com> |
On Saturday, August 1st, 2026 at 23:15, Bryan O'Donoghue <[email protected]> wrote: Hi Bryan, Thanks for review; > On 01/08/2026 19:22, Aleksandrs Vinarskis wrote: > > Introduce EC driver for Dell XPS 13 9345 (codename 'tributo') which may > > partially of fully compatible with Snapdragon-based Dell Latitude, > > Inspiron ('thena'). Primary function of this driver is unblock EC's > > thermal management, specifically to provide it with necessary > > information to control device fans, peripherals power. > > > > The driver was developed primarily by analyzing ACPI DSDT's _DSM and > > i2c dumps of communication between SoC and EC. Changes to Windows > > driver's behavior include increasing temperature feed loop from ~50ms > > to 100ms here. > > > > While Xps's EC is rather complex and controls practically all device > > peripherals including touch row's brightness and special keys such as > > mic mute, these do not go over this particular i2c interface. > > > > Not yet implemented features: > > - On lid-close IRQ event is registered. Windows performs what to > > appears to be thermistor constants readout, though its not obvious > > what it used for. > > - According to ACPI's _DSM there is a method to readout fans' RPM. > > - Initial thermistor constants were sniffed from Windows, these can be > > likely fine tuned for better cooling performance. > > - There is additional temperature reading that Windows sents to EC but > > more rare than others, likely SoC T_j / TZ98 or TZ4. This is the only > > thermal zone who's reading can exceed 115C without triggering thermal > > shutdown. > > - Given similarities between 'tributo' and 'thena' platforms, including > > EC i2c address, driver can be potentially extended to support both. > > > > Signed-off-by: Aleksandrs Vinarskis <[email protected]> > > --- > > MAINTAINERS | 1 + > > drivers/platform/arm64/Kconfig | 12 ++ > > drivers/platform/arm64/Makefile | 1 + > > drivers/platform/arm64/dell-xps-ec.c | 268 +++++++++++++++++++++++++++++++++++ > > 4 files changed, 282 insertions(+) > > > > diff --git a/MAINTAINERS b/MAINTAINERS > > index 9b5efed4c430..64e143bc5129 100644 > > --- a/MAINTAINERS > > +++ b/MAINTAINERS > > @@ -7347,6 +7347,7 @@ DELL XPS EMBEDDED CONTROLLER DRIVER > > M: Aleksandrs Vinarskis <[email protected]> > > S: Maintained > > F: Documentation/devicetree/bindings/embedded-controller/dell,xps13-9345-ec.yaml > > +F: drivers/platform/arm64/dell-xps-ec.c > > > > DELTA AHE-50DC FAN CONTROL MODULE DRIVER > > M: Zev Weiss <[email protected]> > > diff --git a/drivers/platform/arm64/Kconfig b/drivers/platform/arm64/Kconfig > > index e32e01b2a9bd..29416f8d7232 100644 > > --- a/drivers/platform/arm64/Kconfig > > +++ b/drivers/platform/arm64/Kconfig > > @@ -33,6 +33,18 @@ config EC_ACER_ASPIRE1 > > laptop where this information is not properly exposed via the > > standard ACPI devices. > > > > +config EC_DELL_XPS > > + tristate "Dell XPS 9345 Embedded Controller driver" > > + depends on ARCH_QCOM || COMPILE_TEST > > + depends on I2C > > + depends on IIO > > + help > > + Driver for the Embedded Controller in the Qualcomm Snapdragon-based > > + Dell XPS 13 9345, which handles thermal management and fan speed > > + control. > > + > > + Say M or Y here to include this support. > > + > > config EC_HUAWEI_GAOKUN > > tristate "Huawei Matebook E Go Embedded Controller driver" > > depends on ARCH_QCOM || COMPILE_TEST > > diff --git a/drivers/platform/arm64/Makefile b/drivers/platform/arm64/Makefile > > index 7681be4a46e9..669dc9e79afb 100644 > > --- a/drivers/platform/arm64/Makefile > > +++ b/drivers/platform/arm64/Makefile > > @@ -6,6 +6,7 @@ > > # > > > > obj-$(CONFIG_EC_ACER_ASPIRE1) += acer-aspire1-ec.o > > +obj-$(CONFIG_EC_DELL_XPS) += dell-xps-ec.o > > obj-$(CONFIG_EC_HUAWEI_GAOKUN) += huawei-gaokun-ec.o > > obj-$(CONFIG_EC_LENOVO_YOGA_C630) += lenovo-yoga-c630.o > > obj-$(CONFIG_EC_LENOVO_THINKPAD_T14S) += lenovo-thinkpad-t14s.o > > diff --git a/drivers/platform/arm64/dell-xps-ec.c b/drivers/platform/arm64/dell-xps-ec.c > > new file mode 100644 > > index 000000000000..7758f5dd9342 > > --- /dev/null > > +++ b/drivers/platform/arm64/dell-xps-ec.c > > @@ -0,0 +1,268 @@ > > +// SPDX-License-Identifier: GPL-2.0-only > > +/* > > + * Copyright (c) 2026, Aleksandrs Vinarskis <[email protected]> > > + */ > > + > > +#include <linux/array_size.h> > > +#include <linux/dev_printk.h> > > +#include <linux/device.h> > > +#include <linux/devm-helpers.h> > > +#include <linux/err.h> > > +#include <linux/i2c.h> > > +#include <linux/iio/consumer.h> > > +#include <linux/interrupt.h> > > +#include <linux/jiffies.h> > > +#include <linux/module.h> > > +#include <linux/pm.h> > > +#include <linux/unaligned.h> > > +#include <linux/workqueue.h> > > + > > +#define DELL_XPS_EC_SUSPEND_CMD 0xb9 > > +#define DELL_XPS_EC_SUSPEND_MSG_LEN 64 > > + > > +#define DELL_XPS_EC_TEMP_CMD0 0xfb > > +#define DELL_XPS_EC_TEMP_CMD1 0x20 > > +#define DELL_XPS_EC_TEMP_CMD3 0x02 > > +#define DELL_XPS_EC_TEMP_MSG_LEN 6 > > +#define DELL_XPS_EC_TEMP_POLL_JIFFIES msecs_to_jiffies(100) > > + > > +/* > > + * Format: > > + * - header/unknown (2 bytes) > > + * - per-thermistor entries (3 bytes): thermistor_id, param1, param2 > > + */ > > +static const u8 dell_xps_ec_thermistor_profile[] = { > > + 0xff, 0x54, > > + 0x01, 0x00, 0x2b, /* sys_therm0 */ > > + 0x02, 0x44, 0x2a, /* sys_therm1 */ > > + 0x03, 0x44, 0x2b, /* sys_therm2 */ > > + 0x04, 0x44, 0x28, /* sys_therm3 */ > > + 0x05, 0x55, 0x2a, /* sys_therm4 */ > > + 0x06, 0x44, 0x26, /* sys_therm5 */ > > + 0x07, 0x44, 0x2b, /* sys_therm6 */ > > +}; > > You ready have intuited this as a data-structure so if you define it as > such with __attribute(packed); it will look neater. > I looked into it again, and I think its safer to assume that the init sequence is a 'magic byte sequence' instead. The order and total amount of thermistors does not match the data structure that is being sent on regular intervals (off by one, short by one). I am also not sure it would be the same across different platforms. > > + > > +/* > > + * Mapping from IIO channel name to EC command byte > > + */ > > +static const struct { > > + const char *name; > > + u8 cmd; > > +} dell_xps_ec_therms[] = { > > + /* TODO: 0x01 is sent only occasionally, likely TZ98 or TZ4 */ > > + { "sys_therm0", 0x02 }, > > + { "sys_therm1", 0x03 }, > > + { "sys_therm2", 0x04 }, > > + { "sys_therm3", 0x05 }, > > + { "sys_therm4", 0x06 }, > > + { "sys_therm5", 0x07 }, > > + { "sys_therm6", 0x08 }, > > +}; > > + > > +struct dell_xps_ec { > > + struct device *dev; > > + struct i2c_client *client; > > + struct iio_channel *therm_channels[ARRAY_SIZE(dell_xps_ec_therms)]; > > This should come from data supplied via the probe .data and compat string. Good idea, will rework. > > > + struct delayed_work temp_work; > > +}; > > + > > +static int dell_xps_ec_suspend_cmd(struct dell_xps_ec *ec, bool suspend) > > +{ > > + u8 buf[DELL_XPS_EC_SUSPEND_MSG_LEN] = {}; > > + int ret; > > + > > + buf[0] = DELL_XPS_EC_SUSPEND_CMD; > > + buf[1] = suspend ? 0x01 : 0x00; > > + /* bytes 2..63 remain zero */ > > + > > + ret = i2c_master_send(ec->client, buf, sizeof(buf)); > > + if (ret < 0) > > + return ret; > > + > > + return 0; > > +} > > + > > +static int dell_xps_ec_send_temp(struct dell_xps_ec *ec, u8 cmd_byte, > > + int milli_celsius) > > +{ > > + u8 buf[DELL_XPS_EC_TEMP_MSG_LEN]; > > + u16 deci_celsius; > > + int ret; > > + > > + /* Convert milli-Celsius to deci-Celsius (Celsius * 10) */ > > milli-Celsius is very strange hyphenation just use the lower-case kernel > terminology for it millicelsius. > > https://www.kernel.org/doc/Documentation/devicetree/bindings/thermal/thermal.txt Will fix. > > > + deci_celsius = milli_celsius / 100; > > + > > + buf[0] = DELL_XPS_EC_TEMP_CMD0; > > + buf[1] = DELL_XPS_EC_TEMP_CMD1; > > + buf[2] = cmd_byte; > > + buf[3] = DELL_XPS_EC_TEMP_CMD3; > > + put_unaligned_le16(deci_celsius, &buf[4]); > > + > > + ret = i2c_master_send(ec->client, buf, sizeof(buf)); > > + if (ret < 0) > > + return ret; > > + > > + return 0; > > +} > > + > > +static void dell_xps_ec_temp_work_fn(struct work_struct *work) > > +{ > > + struct dell_xps_ec *ec = container_of(work, struct dell_xps_ec, > > + temp_work.work); > > + int val, ret, i; > > + > > + for (i = 0; i < ARRAY_SIZE(dell_xps_ec_therms); i++) { > > + if (!ec->therm_channels[i]) > > + continue; > > + > > + ret = iio_read_channel_processed(ec->therm_channels[i], &val); > > + if (ret < 0) { > > + dev_err_ratelimited(ec->dev, > > + "Failed to read thermistor %s: %d\n", > > + dell_xps_ec_therms[i].name, ret); > > + continue; > > Is it really legitimate to continue on in this case ? I'll leave it up > to you to think about that for yourself, perhaps yes is the answer but > if term_channels[i] is true and a read of a channel fails - surely > that's indicative of a bail-out situation not read the next channel > situation I think, its still good to continue, since its probably better to have some channels working than none. It is not failing silently, developer will be able to see it. > > > + } > > + > > + ret = dell_xps_ec_send_temp(ec, dell_xps_ec_therms[i].cmd, val); > > + if (ret < 0) { > > + dev_err_ratelimited(ec->dev, > > + "Failed to send temp for %s: %d\n", > > + dell_xps_ec_therms[i].name, ret); > > + } > > + } > > + > > + schedule_delayed_work(&ec->temp_work, DELL_XPS_EC_TEMP_POLL_JIFFIES); > > +} > > + > > +static irqreturn_t dell_xps_ec_irq_handler(int irq, void *data) > > +{ > > + struct dell_xps_ec *ec = data; > > + > > + /* > > + * TODO: IRQ is fired on lid-close. Follow Windows example to read out > > + * the thermistor thresholds and potentially fan speeds. > > + */ > > + dev_info_ratelimited(ec->dev, "IRQ triggered! (irq=%d)\n", irq); > > + > > + return IRQ_HANDLED; > > +} > > + > > +static int dell_xps_ec_probe(struct i2c_client *client) > > +{ > > + struct device *dev = &client->dev; > > + struct dell_xps_ec *ec; > > + int ret, i; > > + > > + ec = devm_kzalloc(dev, sizeof(*ec), GFP_KERNEL); > > + if (!ec) > > + return -ENOMEM; > > + > > + ec->dev = dev; > > + ec->client = client; > > + i2c_set_clientdata(client, ec); > > + > > + /* Set default thermistor profile */ > > + ret = i2c_master_send(client, dell_xps_ec_thermistor_profile, > > + sizeof(dell_xps_ec_thermistor_profile)); > > + if (ret < 0) > > + return dev_err_probe(dev, ret, "Failed to set thermistor profile\n"); > > + > > + /* Get IIO channels for thermistors */ > > + for (i = 0; i < ARRAY_SIZE(dell_xps_ec_therms); i++) { > > This should be num_channels passed from your compat .data Will fix. > > > + ec->therm_channels[i] = > > + devm_iio_channel_get(dev, dell_xps_ec_therms[i].name); > > + if (IS_ERR(ec->therm_channels[i])) { > > + ret = PTR_ERR(ec->therm_channels[i]); > > + ec->therm_channels[i] = NULL; > > + if (ret == -EPROBE_DEFER) > > + return ret; > > + dev_warn(dev, "Thermistor %s not available: %d\n", > > + dell_xps_ec_therms[i].name, ret); > > + } > > + } > > + > > + /* Start periodic temperature reporting */ > > + ret = devm_delayed_work_autocancel(dev, &ec->temp_work, > > + dell_xps_ec_temp_work_fn); > > + if (ret) > > + return ret; > \n > > > + schedule_delayed_work(&ec->temp_work, DELL_XPS_EC_TEMP_POLL_JIFFIES); > > + dev_dbg(dev, "Started periodic temperature reporting to EC every %d ms\n", > > + jiffies_to_msecs(DELL_XPS_EC_TEMP_POLL_JIFFIES)); > > + > > + /* Request IRQ for EC events */ > > + ret = devm_request_threaded_irq(dev, client->irq, NULL, > > + dell_xps_ec_irq_handler, > > + IRQF_ONESHOT, dev_name(dev), ec); > > + if (ret < 0) > > + return dev_err_probe(dev, ret, "Failed to request IRQ\n"); > > + > > + return 0; > > You aren't returning the ret. Good catch, switched to `if (ret)` with `return 0;` in the end instead to match existing implementations. > > > +} > > + > > +/* > > + * Notify EC of suspend > > + * > > + * This will: > > + * - Cut power to display/trackpad/keyboard/touchrow, wake-up source still works > > + */ > > +static int dell_xps_ec_suspend(struct device *dev) > > +{ > > + struct dell_xps_ec *ec = dev_get_drvdata(dev); > > + > > + cancel_delayed_work_sync(&ec->temp_work); > > + > > + return dell_xps_ec_suspend_cmd(ec, true); > > +} > > + > > +/* > > + * Notify EC of resume > > + * > > + * This will undo the suspend actions > > + * Without the resume signal, device would wake up but be forced back into > > + * suspend by EC within seconds > > + */ > > +static int dell_xps_ec_resume(struct device *dev) > > +{ > > + struct dell_xps_ec *ec = dev_get_drvdata(dev); > > + int ret; > > + > > + ret = dell_xps_ec_suspend_cmd(ec, false); > > + if (ret) > > + return ret; > > + > > + schedule_delayed_work(&ec->temp_work, DELL_XPS_EC_TEMP_POLL_JIFFIES); > \n> + return 0; > > +} > > + > > +static const struct of_device_id dell_xps_ec_of_match[] = { > > + { .compatible = "dell,xps13-9345-ec" }, > > + {} > > +}; > > +MODULE_DEVICE_TABLE(of, dell_xps_ec_of_match); > > + > > +static const struct i2c_device_id dell_xps_ec_i2c_id[] = { > > + { "dell-xps-ec" }, > > A nice .data will allow extension of this to other systems with > more/less channels. > > Which is why you shouldn't use the ARRAY_SIZE() extents from statics > declared up top directly. Indeed, will fix. Thanks, Alex > > > + {} > > +}; > > +MODULE_DEVICE_TABLE(i2c, dell_xps_ec_i2c_id); > > + > > +static const struct dev_pm_ops dell_xps_ec_pm_ops = { > > + SYSTEM_SLEEP_PM_OPS(dell_xps_ec_suspend, dell_xps_ec_resume) > > +}; > > + > > +static struct i2c_driver dell_xps_ec_driver = { > > + .driver = { > > + .name = "dell-xps-ec", > > + .of_match_table = dell_xps_ec_of_match, > > + .pm = &dell_xps_ec_pm_ops, > > + }, > > + .probe = dell_xps_ec_probe, > > + .id_table = dell_xps_ec_i2c_id, > > +}; > > +module_i2c_driver(dell_xps_ec_driver); > > + > > +MODULE_AUTHOR("Aleksandrs Vinarskis <[email protected]>"); > > +MODULE_DESCRIPTION("Dell XPS 13 9345 Embedded Controller"); > > +MODULE_LICENSE("GPL"); > > +MODULE_IMPORT_NS("IIO_CONSUMER"); > > > >