Input: cap11xx - Add support for CAP1114
Subsystems (3)
v2 cover Input: cap11xx - Add support for CAP1114
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
Patches 1-4 perform driver cleanup and DT binding tweaks. Patches 5-6 add reset-gpios support for CAP11xx. Patches 7-9 add support for CAP1114.
Changes in v2:
- Drop LED property tweaks, keep only reg changes and node regex update in DT bindings.
- Split microchip,cap1126 LED reg constraints into a separate patch.
- Replace usleep_range() with msleep() for 500 ms delay during reset pin handling.
- Add missing <linux/delay.h> for usleep_range() and msleep().
- Add CAP1114 to unsupported enum for microchip,signal-guard and microchip,calib-sensitivity
- Add constraint for linux,keycodes to support CAP1114.
- When reading CAP1114 button status, mask STATUS1 to bits 0-5 and OR with STATUS2.
- Adjust code style.
- Link to v1:
https://lore.kernel.org/all/[email protected]
Jun Yan (9):
Input: cap11xx - clean up duplicate log and add probe error logs
Input: cap11xx - remove unused register macros
dt-bindings: input: microchip,cap11xx: Update datasheet URL and LED
reg range
dt-bindings: input: microchip,cap11xx: Add microchip,cap1126 LED reg
constraints
dt-bindings: input: microchip,cap11xx: Add reset-gpios property
Input: cap11xx - add reset gpio support
Input: cap11xx - refactor code for better CAP1114 support.
dt-bindings: input: microchip,cap11xx: Add CAP1114 support
Input: cap11xx - add support for CAP1114
.../bindings/input/microchip,cap11xx.yaml | 85 ++++++- drivers/input/keyboard/cap11xx.c | 230 +++++++++++------- 2 files changed, 224 insertions(+), 91 deletions(-)
Signature · 1 line
2.54.0
PATCH v2 1/9 Input: cap11xx - clean up duplicate log and add probe error logs
Duplicated device detection log exists at line 537 and line 542, which brings redundant kernel print messages. Drop one redundant log entry to clean up dmesg output.
Meanwhile add missing error logs when I2C communication fails during driver probe(), helping debug.
--- drivers/input/keyboard/cap11xx.c | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-)
drivers/input/keyboard/cap11xx.c +4 -7
@@ -512,7 +512,7 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) error =regmap_read (priv->regmap,CAP11XX_REG_PRODUCT_ID , &val);if (error) -return error; +return dev_err_probe (dev, error,"Failed to read product ID\n" );if (val != cap->product_id) { dev_err(dev, "Product ID: Got 0x%02x, expected 0x%02x\n",
@@ -522,7 +522,7 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) error =regmap_read (priv->regmap,CAP11XX_REG_MANUFACTURER_ID , &val);if (error) -return error; +return dev_err_probe (dev, error,"Failed to read manufacturer ID\n" );if (val !=CAP11XX_MANUFACTURER_ID ) { dev_err(dev, "Manufacturer ID: Got 0x%02x, expected 0x%02x\n",
@@ -531,11 +531,8 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) } error =regmap_read (priv->regmap,CAP11XX_REG_REVISION , &rev); -if (error <0 ) -return error; - -dev_info (dev,"CAP11XX detected, model %s, revision 0x%02x\n" , - id->name, rev); +if (error) +return dev_err_probe (dev, error,"Failed to read revision\n" ); priv->model = cap;
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 1/9] Input: cap11xx - clean up duplicate log and add probe error logs
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Pre-existing issues:
- [High] Threaded interrupt handler returns IRQ_HANDLED on I2C failure, potentially causing an interrupt storm. --
commit f746dddeb8894305a4dab485d320b84f53191dc0
Author: Jun Yan <[email protected]>
Input: cap11xx - clean up duplicate log and add probe error logs
This commit removes a duplicated device detection log entry to clean up dmesg output. It also adds missing error logs using dev_err_probe() when I2C communication fails during the driver's probe sequence.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_client) · line 537
Quoted 13 lines
drivers/input/keyboard/cap11xx.c +2
-5@@ -531,11 +531,8 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) } error =regmap_read (priv->regmap,CAP11XX_REG_REVISION , &rev); -if (error <0 ) -return error; - -dev_info (dev,"CAP11XX detected, model %s, revision 0x%02x\n" , - id->name, rev); +if (error) +return dev_err_probe (dev, error,"Failed to read revision\n" ); priv->model = cap;
[Severity: High]
This isn't a bug introduced by this patch, but while looking at I2C failure handling in this driver, I noticed an issue in cap11xx_thread_func().
If I2C communication fails during the interrupt handler, the code jumps to the out label:
drivers/input/keyboard/cap11xx.c:cap11xx_thread_func() {
...
ret = regmap_update_bits(priv->regmap, CAP11XX_REG_MAIN_CONTROL, 1, 0);
if (ret < 0)
goto out;
...
out:
return IRQ_HANDLED;
}Because it unconditionally returns IRQ_HANDLED without deasserting the hardware interrupt, the level-triggered interrupt line remains active. This causes the interrupt controller to unmask the IRQ and immediately trigger it again, creating an infinite loop (interrupt storm) that can lock up the CPU.
Should the handler return IRQ_NONE upon I2C failure so the kernel's spurious interrupt detector can eventually disable the broken IRQ?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
PATCH v2 2/9 Input: cap11xx - remove unused register macros
In reply to Jun YanRemove unused register address macros and unused definitions in the cap11xx_reg_defaults array and cap11xx_volatile_reg.
This cleanup reduces code clutter and makes the driver easier to maintain without affecting functionality.
--- drivers/input/keyboard/cap11xx.c | 58 -------------------------------- 1 file changed, 58 deletions(-)
drivers/input/keyboard/cap11xx.c +0 -58
@@ -20,53 +20,23 @@#define CAP11XX_REG_MAIN_CONTROL_GAIN_SHIFT (6)#define CAP11XX_REG_MAIN_CONTROL_GAIN_MASK (0xc0)#define CAP11XX_REG_MAIN_CONTROL_DLSEEP BIT(4) -#define CAP11XX_REG_GENERAL_STATUS 0x02#define CAP11XX_REG_SENSOR_INPUT 0x03 -#define CAP11XX_REG_NOISE_FLAG_STATUS 0x0a -#define CAP11XX_REG_SENOR_DELTA (X ) (0x10 + (X))#define CAP11XX_REG_SENSITIVITY_CONTROL 0x1f#define CAP11XX_REG_SENSITIVITY_CONTROL_DELTA_SENSE_MASK 0x70 -#define CAP11XX_REG_CONFIG 0x20 -#define CAP11XX_REG_SENSOR_ENABLE 0x21 -#define CAP11XX_REG_SENSOR_CONFIG 0x22 -#define CAP11XX_REG_SENSOR_CONFIG2 0x23 -#define CAP11XX_REG_SAMPLING_CONFIG 0x24 -#define CAP11XX_REG_CALIBRATION 0x26 -#define CAP11XX_REG_INT_ENABLE 0x27#define CAP11XX_REG_REPEAT_RATE 0x28#define CAP11XX_REG_SIGNAL_GUARD_ENABLE 0x29 -#define CAP11XX_REG_MT_CONFIG 0x2a -#define CAP11XX_REG_MT_PATTERN_CONFIG 0x2b -#define CAP11XX_REG_MT_PATTERN 0x2d -#define CAP11XX_REG_RECALIB_CONFIG 0x2f#define CAP11XX_REG_SENSOR_THRESH (X ) (0x30 + (X)) -#define CAP11XX_REG_SENSOR_NOISE_THRESH 0x38 -#define CAP11XX_REG_STANDBY_CHANNEL 0x40 -#define CAP11XX_REG_STANDBY_CONFIG 0x41 -#define CAP11XX_REG_STANDBY_SENSITIVITY 0x42 -#define CAP11XX_REG_STANDBY_THRESH 0x43#define CAP11XX_REG_CONFIG2 0x44#define CAP11XX_REG_CONFIG2_ALT_POL BIT(6) -#define CAP11XX_REG_SENSOR_BASE_CNT (X ) (0x50 + (X)) -#define CAP11XX_REG_LED_POLARITY 0x73#define CAP11XX_REG_LED_OUTPUT_CONTROL 0x74#define CAP11XX_REG_CALIB_SENSITIVITY_CONFIG 0x80#define CAP11XX_REG_CALIB_SENSITIVITY_CONFIG2 0x81 - -#define CAP11XX_REG_LED_DUTY_CYCLE_1 0x90 -#define CAP11XX_REG_LED_DUTY_CYCLE_2 0x91 -#define CAP11XX_REG_LED_DUTY_CYCLE_3 0x92#define CAP11XX_REG_LED_DUTY_CYCLE_4 0x93 -#define CAP11XX_REG_LED_DUTY_MIN_MASK (0x0f) -#define CAP11XX_REG_LED_DUTY_MIN_MASK_SHIFT (0)#define CAP11XX_REG_LED_DUTY_MAX_MASK (0xf0)#define CAP11XX_REG_LED_DUTY_MAX_MASK_SHIFT (4)#define CAP11XX_REG_LED_DUTY_MAX_VALUE (15) -#define CAP11XX_REG_SENSOR_CALIB (0xb1 + (X)) -#define CAP11XX_REG_SENSOR_CALIB_LSB1 0xb9 -#define CAP11XX_REG_SENSOR_CALIB_LSB2 0xba#define CAP11XX_REG_PRODUCT_ID 0xfd#define CAP11XX_REG_MANUFACTURER_ID 0xfe#define CAP11XX_REG_REVISION 0xff
@@ -111,37 +81,15 @@ struct cap11xx_hw_model {static const struct reg_default cap11xx_reg_defaults[] = { {CAP11XX_REG_MAIN_CONTROL ,0x00 }, - {CAP11XX_REG_GENERAL_STATUS ,0x00 }, - {CAP11XX_REG_SENSOR_INPUT ,0x00 }, - {CAP11XX_REG_NOISE_FLAG_STATUS ,0x00 }, {CAP11XX_REG_SENSITIVITY_CONTROL ,0x2f }, - {CAP11XX_REG_CONFIG ,0x20 }, - {CAP11XX_REG_SENSOR_ENABLE ,0x3f }, - {CAP11XX_REG_SENSOR_CONFIG ,0xa4 }, - {CAP11XX_REG_SENSOR_CONFIG2 ,0x07 }, - {CAP11XX_REG_SAMPLING_CONFIG ,0x39 }, - {CAP11XX_REG_CALIBRATION ,0x00 }, - {CAP11XX_REG_INT_ENABLE ,0x3f }, {CAP11XX_REG_REPEAT_RATE ,0x3f }, - {CAP11XX_REG_MT_CONFIG ,0x80 }, - {CAP11XX_REG_MT_PATTERN_CONFIG ,0x00 }, - {CAP11XX_REG_MT_PATTERN ,0x3f }, - {CAP11XX_REG_RECALIB_CONFIG ,0x8a }, {CAP11XX_REG_SENSOR_THRESH (0 ),0x40 }, {CAP11XX_REG_SENSOR_THRESH (1 ),0x40 }, {CAP11XX_REG_SENSOR_THRESH (2 ),0x40 }, {CAP11XX_REG_SENSOR_THRESH (3 ),0x40 }, {CAP11XX_REG_SENSOR_THRESH (4 ),0x40 }, {CAP11XX_REG_SENSOR_THRESH (5 ),0x40 }, - {CAP11XX_REG_SENSOR_NOISE_THRESH ,0x01 }, - {CAP11XX_REG_STANDBY_CHANNEL ,0x00 }, - {CAP11XX_REG_STANDBY_CONFIG ,0x39 }, - {CAP11XX_REG_STANDBY_SENSITIVITY ,0x02 }, - {CAP11XX_REG_STANDBY_THRESH ,0x40 }, {CAP11XX_REG_CONFIG2 ,0x40 }, - {CAP11XX_REG_LED_POLARITY ,0x00 }, - {CAP11XX_REG_SENSOR_CALIB_LSB1 ,0x00 }, - {CAP11XX_REG_SENSOR_CALIB_LSB2 ,0x00 }, };static bool cap11xx_volatile_reg (struct device *dev,unsigned int reg)
@@ -149,12 +97,6 @@ static bool cap11xx_volatile_reg(struct device *dev, unsigned int reg)switch (reg) {case CAP11XX_REG_MAIN_CONTROL :case CAP11XX_REG_SENSOR_INPUT : -case CAP11XX_REG_SENOR_DELTA (0 ): -case CAP11XX_REG_SENOR_DELTA (1 ): -case CAP11XX_REG_SENOR_DELTA (2 ): -case CAP11XX_REG_SENOR_DELTA (3 ): -case CAP11XX_REG_SENOR_DELTA (4 ): -case CAP11XX_REG_SENOR_DELTA (5 ):return true; }
Signature · 1 line
2.54.0
PATCH v2 3/9 dt-bindings: input: microchip,cap11xx: Update datasheet URL and LED reg range
In reply to Jun Yan- Add datasheet links for all supported CAP11xx variants.
- Update LED node regex and replace enum constraints with minimum/maximum for LED reg ranges in preparation for CAP1114 support.
CAP1114 has 11 LED channels. minimum/maximum constraints are easier to maintain than long enum lists when expanding channel count later.
--- .../bindings/input/microchip,cap11xx.yaml | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +14 -3
@@ -10,6 +10,15 @@ description: | The Microchip CAP1xxx Family of RightTouchTM multiple-channel capacitive touch controllers and LED drivers. The device communication via I2C only. + For more product information please see the links below: + CAP1106: https://ww1.microchip.com/downloads/en/DeviceDoc/00001624B.pdf + CAP1126: https://ww1.microchip.com/downloads/en/DeviceDoc/00001623B.pdf + CAP1188: https://ww1.microchip.com/downloads/en/DeviceDoc/00001620C.pdf + CAP1203: https://ww1.microchip.com/downloads/en/DeviceDoc/00001572B.pdf + CAP1206: https://ww1.microchip.com/downloads/en/DeviceDoc/00001567B.pdf + CAP1293: https://ww1.microchip.com/downloads/en/DeviceDoc/00001566B.pdf + CAP1298: https://ww1.microchip.com/downloads/en/DeviceDoc/00001571B.pdf + maintainers: - Rob Herring <[email protected]>
@@ -124,14 +133,16 @@ properties: The number of entries must correspond to the number of channels. patternProperties: - "^led@[0-7]$": + "^led@[0-9a-f]$": type: object description: CAP11xx LEDs $ref: /schemas/leds/common.yaml# properties: reg: - enum: [0, 1, 2, 3, 4, 5, 6, 7] + description: LED channel number + minimum: 0 + maximum: 7 label: true
@@ -158,7 +169,7 @@ allOf: - microchip,cap1298 then: patternProperties: - "^led@[0-7]$": false + "^led@": false - if: properties:
Signature · 1 line
2.54.0
PATCH v2 4/9 dt-bindings: input: microchip,cap11xx: Add microchip,cap1126 LED reg constraints
In reply to Jun YanApply per-chip LED channel limits:
- CAP1126: max 2 channels (0-1)
- CAP1188: max 8 channels (0-7)
- CAP1106, CAP12xx: no LED support
--- .../bindings/input/microchip,cap11xx.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +13 -0
@@ -171,6 +171,19 @@ allOf: patternProperties: "^led@": false + - if: + properties: + compatible: + contains: + enum: + - microchip,cap1126 + then: + patternProperties: + "^led@": + properties: + reg: + maximum: 1 + - if: properties: compatible:
Signature · 1 line
2.54.0
PATCH v2 5/9 dt-bindings: input: microchip,cap11xx: Add reset-gpios property
In reply to Jun YanAdd support for the optional reset-gpios property to describe the active-high reset pin for CAP1126/CAP1188 devices. Driving the GPIO high asserts reset and deep sleep, while driving it low releases reset for normal operation.
Restrict this property to be available only on CAP1126 and CAP1188 chips, as other CAP11xx variants do not have a hardware reset pin.
--- .../bindings/input/microchip,cap11xx.yaml | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +25 -0
@@ -49,6 +49,13 @@ properties: device's ALERT#/CM_IRQ# pin is connected to. The device only has one interrupt source. + reset-gpios: + description: | + GPIO connected to the active-high RESET pin of the chip; + driving it high asserts reset and deep sleep, while driving + it low releases reset for normal operation. + maxItems: 1 + autorepeat: description: | Enables the Linux input system's autorepeat feature on the input device.
@@ -157,6 +164,20 @@ patternProperties: allOf: - $ref: input.yaml + - if: + properties: + compatible: + contains: + enum: + - microchip,cap1106 + - microchip,cap1203 + - microchip,cap1206 + - microchip,cap1293 + - microchip,cap1298 + then: + properties: + reset-gpios: false + - if: properties: compatible:
@@ -207,6 +228,8 @@ additionalProperties: false examples: - | + #include <dt-bindings/gpio/gpio.h> + i2c { #address-cells = <1>; #size-cells = <0>;
@@ -228,6 +251,8 @@ examples: <109>, /* KEY_PAGEDOWN */ <104>; /* KEY_PAGEUP */ + reset-gpios = <&gpio 17 GPIO_ACTIVE_HIGH>; + #address-cells = <1>; #size-cells = <0>;
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 5/9] dt-bindings: input: microchip,cap11xx: Add reset-gpios property
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Pre-existing issues:
- [High] The threaded interrupt handler returns IRQ_HANDLED even when it fails to clear the hardware interrupt due to I2C errors. --
commit ace8e5621e0baa976a27041614c9c01f25526d5e
Author: Jun Yan <[email protected]>
dt-bindings: input: microchip,cap11xx: Add reset-gpios property
This commit adds support for the optional reset-gpios property to describe the active-high reset pin for CAP1126 and CAP1188 devices. It restricts this property to only these variants, as other variants lack a hardware reset pin.
Quoted 13 lines
drivers/input/keyboard/cap11xx.c:cap11xx_thread_func() {
...ret = regmap_update_bits(priv->regmap, CAP11XX_REG_MAIN_CONTROL, 1, 0); if (ret < 0) goto out; ret = regmap_read(priv->regmap, priv->model->sensor_input_reg_base, &status); if (ret < 0) goto out; ... out: return IRQ_HANDLED; }
[Severity: High]
This is a pre-existing issue, but does this error path cause an interrupt storm?
If the I2C operations regmap_update_bits() or regmap_read() fail, the function jumps to the out label and returns IRQ_HANDLED instead of returning IRQ_NONE or disabling the IRQ.
Since the IRQ is registered with IRQF_ONESHOT, returning IRQ_HANDLED tells the IRQ subsystem to unmask the interrupt line. If the interrupt condition on the hardware was not successfully cleared due to the I2C failure, will the interrupt immediately fire again?
This could create an infinite loop of threaded IRQ scheduling that bypasses the kernel's spurious interrupt detector (which requires IRQ_NONE to trigger), potentially consuming 100% of a CPU core and causing a soft lockup.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=5
PATCH v2 6/9 Input: cap11xx - add reset gpio support
In reply to Jun YanSome CAP11xx devices (CAP1126/CAP1188) have a dedicated RESET pin. Add hardware reset operation to improve device reliability and ensure proper initialization on probe.
--- drivers/input/keyboard/cap11xx.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
drivers/input/keyboard/cap11xx.c +16 -0
@@ -5,6 +5,7 @@* (c) 2014 Daniel Mack <[email protected]> */ +#include <linux/delay.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/interrupt.h>
@@ -43,6 +44,9 @@#define CAP11XX_MANUFACTURER_ID 0x5d +#define CAP11XX_T_RST_FILT_MIN_US 10000 +#define CAP11XX_T_RST_ON_MIN_MS 400 + #ifdef CONFIG_LEDS_CLASS struct cap11xx_led { struct cap11xx_priv *priv;
@@ -55,6 +59,7 @@ struct cap11xx_priv {struct regmap *regmap;struct device *dev;struct input_dev *idev; +struct gpio_desc *reset_gpio;const struct cap11xx_hw_model *model;struct cap11xx_led *leds;
@@ -452,6 +457,17 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client)if (IS_ERR (priv->regmap))return PTR_ERR (priv->regmap); + priv->reset_gpio =devm_gpiod_get_optional (dev,"reset" ,GPIOD_OUT_LOW ); +if (IS_ERR (priv->reset_gpio)) +return dev_err_probe (dev,PTR_ERR (priv->reset_gpio), +"Failed to get 'reset' GPIO\n" ); +if (priv->reset_gpio) { +gpiod_set_value_cansleep (priv->reset_gpio,1 ); +usleep_range (CAP11XX_T_RST_FILT_MIN_US ,CAP11XX_T_RST_FILT_MIN_US *2 ); +gpiod_set_value_cansleep (priv->reset_gpio,0 ); +msleep (CAP11XX_T_RST_ON_MIN_MS ); + } + error =regmap_read (priv->regmap,CAP11XX_REG_PRODUCT_ID , &val);if (error)return dev_err_probe (dev, error,"Failed to read product ID\n" );
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 6/9] Input: cap11xx - add reset gpio support
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
New issues:
- [Medium] Unintended glitch on the reset line during probe due to GPIOD_OUT_LOW initialization.
Pre-existing issues:
- [High] Unvalidated keycodes from Device Tree cause an out-of-bounds heap write. --
commit 5befbfbb7019f474fe2d2d2e0e3da23976b75ada
Author: Jun Yan <[email protected]>
Input: cap11xx - add reset gpio support
Some CAP11xx devices (CAP1126/CAP1188) have a dedicated RESET pin. Add hardware reset operation to improve device reliability and ensure proper initialization on probe.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_client) · line 465
Quoted 10 lines
drivers/input/keyboard/cap11xx.c +6
-0@@ -452,6 +457,17 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client)if (IS_ERR (priv->regmap))return PTR_ERR (priv->regmap); + priv->reset_gpio =devm_gpiod_get_optional (dev,"reset" ,GPIOD_OUT_LOW ); +if (IS_ERR (priv->reset_gpio)) +return dev_err_probe (dev,PTR_ERR (priv->reset_gpio), +"Failed to get 'reset' GPIO\n" ); +if (priv->reset_gpio) { +gpiod_set_value_cansleep (priv->reset_gpio,1 );
[Severity: Medium]
Does initializing the reset GPIO with GPIOD_OUT_LOW cause an unintended glitch on the reset line?
When devm_gpiod_get_optional() is called with GPIOD_OUT_LOW, the GPIO line is immediately driven to its logical low (inactive) state. If the hardware or bootloader previously left the device in a reset state, this prematurely pulls it out of reset.
The driver then immediately calls gpiod_set_value_cansleep() to assert the reset. This sequence creates an extremely short, unintended de-assert/assert glitch on the reset pin, which could violate hardware timing requirements.
Would it be safer to request the reset GPIO with GPIOD_OUT_HIGH (or GPIOD_ASIS) to guarantee it starts in the logically asserted state before we hold it for the required minimum duration?
[Severity: High]
This is a pre-existing issue, but does this code overflow the keybit array if a device tree provides unvalidated keycodes?
Later in cap11xx_i2c_probe(), the driver loops over the keycodes read from the device tree:
for (i = 0; i < cap->num_channels; i++)
__set_bit(priv->keycodes[i], priv->idev->keybit);
Since __set_bit() does not perform bounds checking, if a device tree specifies a keycode value greater than or equal to KEY_MAX, this will write outside the bounds of the keybit array in the input_dev structure, clobbering adjacent memory in the kernel heap.
Should we add a check against KEY_MAX before setting the bit?
Quoted 6 lines
drivers/input/keyboard/cap11xx.c +5
-0+usleep_range (CAP11XX_T_RST_FILT_MIN_US ,CAP11XX_T_RST_FILT_MIN_US *2 ); +gpiod_set_value_cansleep (priv->reset_gpio,0 ); +msleep (CAP11XX_T_RST_ON_MIN_MS ); + } + error =regmap_read (priv->regmap,CAP11XX_REG_PRODUCT_ID , &val);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=6
Re: [PATCH v2 6/9] Input: cap11xx - add reset gpio support
Quoted 51 lines
Thank you for your contribution! Sashiko AI review found 2 potential issue(=
s) to consider:New issues:
- [Medium] Unintended glitch on the reset line during probe due to GPIOD_OU=T_LOWinitialization.Pre-existing issues:
- [High] Unvalidated keycodes from Device Tree cause an out-of-bounds heap = write.
--commit
5befbfbb7019f474fe2d2d2e0e3da23976b75ada
Author: Jun Yan <[email protected]>Input: cap11xx - add reset gpio support
Some CAP11xx devices (CAP1126/CAP1188) have a dedicated RESET pin. Add hardware reset operation to improve device reliability and ensure proper initialization on probe.
drivers/input/keyboard/ca=
Quoted 1 line
drivers/input/keyboard/ca= renamed from drivers/input/keyboard/cap11xx.c +0
-0
p11xx.cQuoted 3 lines
index
686174722204c..75746a8a22332100644drivers/input/keyboard/cap11xx.c +0
-0[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_=
Quoted 1 line
drivers/input/keyboard/cap11xx.c +0
-0@@ -452,6 +457,17 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_=client)
drivers/input/keyboard/cap11xx.c
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0if (IS_ERR (priv->regmap))return PTR_ERR (priv->regmap);=20
drivers/input/keyboard/cap11xx.c +1
-0+ priv->reset_gpio =3D devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LO=W);
drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_client) · line 465
Quoted 5 lines
drivers/input/keyboard/cap11xx.c +5
-0+if (IS_ERR (priv->reset_gpio)) +return dev_err_probe (dev,PTR_ERR (priv->reset_gpio), +"Failed to get 'reset' GPIO\n" ); +if (priv->reset_gpio) { +gpiod_set_value_cansleep (priv->reset_gpio,1 );[Severity: Medium]
Does initializing the reset GPIO withGPIOD_OUT_LOWcause an unintended glitch on the reset line?When
devm_gpiod_get_optional()is called withGPIOD_OUT_LOW, the GPIO line is immediately driven to its logical low (inactive) state. If the hardware or bootloader previously left the device in a reset state, this prematurely pulls it out of reset.
Quoted 8 lines
The driver then immediately calls
gpiod_set_value_cansleep()to assert the reset. This sequence creates an extremely short, unintended de-assert/assert glitch on the reset pin, which could violate hardware timing requirements.Would it be safer to request the reset GPIO with
GPIOD_OUT_HIGH(orGPIOD_ASIS) to guarantee it starts in the logically asserted state before we hold it for the required minimum duration?
Agreed, this also makes the code cleaner.
Quoted 29 lines
[Severity: High]
This is a pre-existing issue, but does this code overflow the keybit array if a device tree provides unvalidated keycodes?Later in
cap11xx_i2c_probe(), the driver loops over the keycodes read from the device tree:for (i =3D 0; i <
cap->num_channels; i++)__set_bit(priv->keycodes[i], priv->idev->keybit);Since
__set_bit()does not perform bounds checking, if a device tree specifies a keycode value greater than or equal toKEY_MAX, this will write outside the bounds of the keybit array in theinput_devstructure, clobbering adjacent memory in the kernel heap.Should we add a check against
KEY_MAXbefore setting the bit?drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_client)
Quoted 6 lines
drivers/input/keyboard/cap11xx.c +5
-0+usleep_range (CAP11XX_T_RST_FILT_MIN_US ,CAP11XX_T_RST_FILT_MIN_US *2 ); +gpiod_set_value_cansleep (priv->reset_gpio,0 ); +msleep (CAP11XX_T_RST_ON_MIN_MS ); + } + error =3D regmap_read(priv->regmap, CAP11XX_REG_PRODUCT_ID, &val);--=20
Sashiko AI review =C2=B7 https://sashiko.dev/#/patchset/20260612072237.1177=
[email protected]?part=3D6
PATCH v2 7/9 Input: cap11xx - refactor code for better CAP1114 support.
In reply to Jun YanExtend cap11xx_hw_model structure to support CAP1114 with different register offsets and hardware characteristics:
- led_output_control_reg_base: different address on CAP1114
- sensor_input_reg_base: different address on CAP1114
- num_sensor_thresholds: separate value from num_channels for CAP1114
- has_repeat_en: repeat enable support, disabled by default on CAP1114
Include linux/bits.h, update the register operations related to LEDs.
--- drivers/input/keyboard/cap11xx.c | 73 +++++++++++++++++++++++--------- 1 file changed, 53 insertions(+), 20 deletions(-)
drivers/input/keyboard/cap11xx.c +53 -20
@@ -5,6 +5,7 @@* (c) 2014 Daniel Mack <[email protected]> */ +#include <linux/bits.h> #include <linux/delay.h> #include <linux/kernel.h> #include <linux/module.h>
@@ -35,7 +36,6 @@#define CAP11XX_REG_LED_DUTY_CYCLE_4 0x93#define CAP11XX_REG_LED_DUTY_MAX_MASK (0xf0) -#define CAP11XX_REG_LED_DUTY_MAX_MASK_SHIFT (4)#define CAP11XX_REG_LED_DUTY_MAX_VALUE (15)#define CAP11XX_REG_PRODUCT_ID 0xfd
@@ -76,10 +76,14 @@ struct cap11xx_priv {struct cap11xx_hw_model {u8 product_id; +u8 led_output_control_reg_base; +u8 sensor_input_reg_base;unsigned int num_channels;unsigned int num_leds; +unsigned int num_sensor_thresholds;bool has_gain;bool has_irq_config; +bool has_repeat_en;bool has_sensitivity_control;bool has_signal_guard; };
@@ -204,8 +208,8 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv) }if (!of_property_read_u32_array (node,"microchip,input-threshold" , - priv->thresholds, priv->model->num_channels)) { -for (i =0 ; i < priv->model->num_channels; i++) { + priv->thresholds, priv->model->num_sensor_thresholds)) { +for (i =0 ; i < priv->model->num_sensor_thresholds; i++) {if (priv->thresholds[i] >127 ) {dev_err (dev,"Invalid input-threshold value %u\n" , priv->thresholds[i]);
@@ -279,10 +283,12 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv)of_property_read_u32_array (node,"linux,keycodes" , priv->keycodes, priv->model->num_channels); -/* Disable autorepeat. The Linux input system has its own handling. */ - error =regmap_write (priv->regmap,CAP11XX_REG_REPEAT_RATE ,0 ); -if (error) -return error; +if (priv->model->has_repeat_en) { +/* Disable autorepeat. The Linux input system has its own handling. */ + error =regmap_write (priv->regmap,CAP11XX_REG_REPEAT_RATE ,0 ); +if (error) +return error; + }return 0 ; }
@@ -301,7 +307,7 @@ static irqreturn_t cap11xx_thread_func(int irq_num, void *data)if (ret <0 ) goto out; - ret =regmap_read (priv->regmap,CAP11XX_REG_SENSOR_INPUT , &status); + ret =regmap_read (priv->regmap, priv->model->sensor_input_reg_base, &status);if (ret <0 ) goto out;
@@ -355,7 +361,7 @@ static int cap11xx_led_set(struct led_classdev *cdev,* 0 (OFF) and 1 (ON). */ return regmap_update_bits (priv->regmap, -CAP11XX_REG_LED_OUTPUT_CONTROL , + priv->model->led_output_control_reg_base,BIT (led->reg), value ?BIT (led->reg) :0 ); }
@@ -367,6 +373,7 @@ static int cap11xx_init_leds(struct device *dev,struct cap11xx_led *led;int cnt =of_get_child_count (node);int error; +u32 duty_val;if (!num_leds || !cnt)return 0 ;
@@ -380,15 +387,18 @@ static int cap11xx_init_leds(struct device *dev, priv->leds = led; +/* Set all LEDs to off */ error =regmap_update_bits (priv->regmap, -CAP11XX_REG_LED_OUTPUT_CONTROL ,0xff ,0 ); + priv->model->led_output_control_reg_base, +GENMASK (num_leds -1 ,0 ),0 );if (error)return error; + duty_val =FIELD_PREP (CAP11XX_REG_LED_DUTY_MAX_MASK , +CAP11XX_REG_LED_DUTY_MAX_VALUE ); + error =regmap_update_bits (priv->regmap,CAP11XX_REG_LED_DUTY_CYCLE_4 , -CAP11XX_REG_LED_DUTY_MAX_MASK , -CAP11XX_REG_LED_DUTY_MAX_VALUE << -CAP11XX_REG_LED_DUTY_MAX_MASK_SHIFT ); +CAP11XX_REG_LED_DUTY_MAX_MASK , duty_val);if (error)return error;
@@ -554,41 +564,64 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) }static const struct cap11xx_hw_model cap1106_model = { - .product_id =0x55 , .num_channels =6 , .num_leds =0 , + .product_id =0x55 , + .num_channels =6 , .num_leds =0 , .num_sensor_thresholds =6 , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , .has_gain = true, .has_irq_config = true, + .has_repeat_en = true, };static const struct cap11xx_hw_model cap1126_model = { - .product_id =0x53 , .num_channels =6 , .num_leds =2 , + .product_id =0x53 , + .num_channels =6 , .num_leds =2 , .num_sensor_thresholds =6 , + .led_output_control_reg_base =CAP11XX_REG_LED_OUTPUT_CONTROL , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , .has_gain = true, .has_irq_config = true, + .has_repeat_en = true, };static const struct cap11xx_hw_model cap1188_model = { - .product_id =0x50 , .num_channels =8 , .num_leds =8 , + .product_id =0x50 , + .num_channels =8 , .num_leds =8 , .num_sensor_thresholds =8 , + .led_output_control_reg_base =CAP11XX_REG_LED_OUTPUT_CONTROL , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , .has_gain = true, .has_irq_config = true, + .has_repeat_en = true, };static const struct cap11xx_hw_model cap1203_model = { - .product_id =0x6d , .num_channels =3 , .num_leds =0 , + .product_id =0x6d , + .num_channels =3 , .num_leds =0 , .num_sensor_thresholds =3 , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , + .has_repeat_en = true, };static const struct cap11xx_hw_model cap1206_model = { - .product_id =0x67 , .num_channels =6 , .num_leds =0 , + .product_id =0x67 , + .num_channels =6 , .num_leds =0 , .num_sensor_thresholds =6 , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , + .has_repeat_en = true, };static const struct cap11xx_hw_model cap1293_model = { - .product_id =0x6f , .num_channels =3 , .num_leds =0 , + .product_id =0x6f , + .num_channels =3 , .num_leds =0 , .num_sensor_thresholds =3 , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , .has_gain = true, + .has_repeat_en = true, .has_sensitivity_control = true, .has_signal_guard = true, };static const struct cap11xx_hw_model cap1298_model = { - .product_id =0x71 , .num_channels =8 , .num_leds =0 , + .product_id =0x71 , + .num_channels =8 , .num_leds =0 , .num_sensor_thresholds =8 , + .sensor_input_reg_base =CAP11XX_REG_SENSOR_INPUT , .has_gain = true, + .has_repeat_en = true, .has_sensitivity_control = true, .has_signal_guard = true, };
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 7/9] Input: cap11xx - refactor code for better CAP1114 support.
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Pre-existing issues:
- [High] The input device is registered and exposed to userspace before its threaded IRQ handler is requested, creating a race window where events could be lost or unhandled. --
commit d2a53f68ed5e5f2311cb5dfaea4bd95be2449ab4
Author: Jun Yan <[email protected]>
Input: cap11xx - refactor code for better CAP1114 support.
Extend cap11xx_hw_model structure to support CAP1114 with different register offsets and hardware characteristics.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_i2c_probe(struct i2c_client *i2c_client) · line 564
Quoted 2 lines
drivers/input/keyboard/cap11xx.c +0
-0@@ -554,41 +564,64 @@ static int cap11xx_i2c_probe(struct i2c_client *i2c_client) }
[Severity: High]
This isn't a bug introduced by this patch, but looking at cap11xx_i2c_probe(), the input device is registered and exposed to userspace before its threaded IRQ handler is requested:
error = input_register_device(priv->idev); if (error) return error; error = devm_request_threaded_irq(dev, i2c_client->irq, NULL, cap11xx_thread_func, IRQF_ONESHOT, dev_name(dev), priv);
Since input_register_device() makes the device visible to userspace, processes like udev can immediately open the device. This invokes cap11xx_input_open() and wakes the hardware from deep sleep.
If a hardware interrupt occurs before devm_request_threaded_irq() registers the handler, could this unhandled interrupt cause an interrupt storm? The kernel might then disable the IRQ line ('nobody cared'), rendering the touch controller permanently inoperable until the module is reloaded or the system reboots.
Should the IRQ handler be requested before the device is registered?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=7
PATCH v2 8/9 dt-bindings: input: microchip,cap11xx: Add CAP1114 support
In reply to Jun YanCAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
Add the compatible string for CAP1114, add its datasheet URL, update the maximum of LED channel reg, and add constraint for linux,keycodes.
Previously, the LED reg property had a default maximum of 7 for CAP1188. With the addition of CAP1114, the default maximum is now 11. An if-then constraint is added to limit the LED count for CAP1188.
Update description for microchip,input-threshold: CAP1114 only provides eight threshold entries, which does not match its total channel count.
CAP1114 does not support microchip,signal-guard and microchip,calib-sensitivity.
Add CAP1114 to the unsupported enum list.
--- .../bindings/input/microchip,cap11xx.yaml | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +31 -1
@@ -12,6 +12,7 @@ description: | For more product information please see the links below: CAP1106: https://ww1.microchip.com/downloads/en/DeviceDoc/00001624B.pdf + CAP1114: https://ww1.microchip.com/downloads/en/DeviceDoc/00002444A.pdf CAP1126: https://ww1.microchip.com/downloads/en/DeviceDoc/00001623B.pdf CAP1188: https://ww1.microchip.com/downloads/en/DeviceDoc/00001620C.pdf CAP1203: https://ww1.microchip.com/downloads/en/DeviceDoc/00001572B.pdf
@@ -26,6 +27,7 @@ properties: compatible: enum: - microchip,cap1106 + - microchip,cap1114 - microchip,cap1126 - microchip,cap1188 - microchip,cap1203
@@ -122,6 +124,8 @@ properties: is required for a touch to be registered, making the touch sensor less sensitive. The number of entries must correspond to the number of channels. + CAP1114 is an exception where channels 8~14 reuse the eighth entry's + threshold, so counts differ. microchip,calib-sensitivity: $ref: /schemas/types.yaml#/definitions/uint32-array
@@ -149,7 +153,7 @@ patternProperties: reg: description: LED channel number minimum: 0 - maximum: 7 + maximum: 10 label: true
@@ -178,6 +182,18 @@ allOf: properties: reset-gpios: false + - if: + properties: + compatible: + contains: + enum: + - microchip,cap1114 + then: + properties: + linux,keycodes: + minItems: 14 + maxItems: 14 + - if: properties: compatible:
@@ -205,12 +221,26 @@ allOf: reg: maximum: 1 + - if: + properties: + compatible: + contains: + enum: + - microchip,cap1188 + then: + patternProperties: + "^led@": + properties: + reg: + maximum: 7 + - if: properties: compatible: contains: enum: - microchip,cap1106 + - microchip,cap1114 - microchip,cap1126 - microchip,cap1188 - microchip,cap1203
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 8/9] dt-bindings: input: microchip,cap11xx: Add CAP1114 support
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [High] Schema constraint conflict for `linux,keycodes` makes CAP1114 validation impossible. - [High]…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] Schema constraint conflict for linux,keycodes makes CAP1114 validation impossible.
- [High] Buffer overflow when parsing microchip,calib-sensitivity property for models with >8 channels. --
commit f0d8405d987f3f3e2623cf6af9274da6bb531e55
Author: Jun Yan <[email protected]>
dt-bindings: input: microchip,cap11xx: Add CAP1114 support
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support. Add the compatible string for CAP1114, update maximum LED channels, and add constraints for linux,keycodes.
Quoted 4 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +0
-0
[ ... ]
Quoted 6 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +2
-0@@ -178,6 +182,18 @@ allOf: properties: reset-gpios: false + - if: + properties:
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml allOf: · line 196
Quoted 10 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +10
-0+ compatible: + contains: + enum: + - microchip,cap1114 + then: + properties: + linux,keycodes: + minItems: 14 + maxItems: 14 +
[Severity: High]
This conditional block enforces 14 items for linux,keycodes, but earlier in the file there is a global constraint that limits it to 8:
linux,keycodes:
minItems: 3
maxItems: 8
Because JSON Schema evaluates global and conditional constraints cumulatively, any valid CAP1114 node with 14 keycodes will fail dt_binding_check against the global 8-item limit. Should the global maxItems be increased to 14, while keeping other models constrained in their respective blocks?
[ ... ]
One additional question regarding the CAP1114 integration with the driver:
[Severity: High]
When CAP1114 support is added to the driver (since num_channels will be 14), can this lead to an out-of-bounds write?
In drivers/input/keyboard/cap11xx.c, calib_sensitivities is a fixed-size 8-element array:
struct cap11xx_priv {
...
u32 calib_sensitivities[8];
u32 keycodes[];
};However, during initialization, the driver reads num_channels items into it:
if (!of_property_read_u32_array(node, "microchip,calib-sensitivity",
priv->calib_sensitivities,
priv->model->num_channels)) {Even though the CAP1114 binding forbids microchip,calib-sensitivity, an incorrectly configured or malicious device tree providing 14 items could cause this to overflow the 8-element array by 24 bytes. Does the driver need to be updated to prevent this when num_channels is greater than 8?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=8
Re: [PATCH v2 8/9] dt-bindings: input: microchip,cap11xx: Add CAP1114 support
In reply to Jun YanQuoted 67 lines · Jun Yan
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
Add the compatible string for CAP1114, add its datasheet URL, update the maximum of LED channel reg, and add constraint for linux,keycodes.
Previously, the LED reg property had a default maximum of 7 for CAP1188. With the addition of CAP1114, the default maximum is now 11. An if-then constraint is added to limit the LED count for CAP1188.
Update description for microchip,input-threshold: CAP1114 only provides eight threshold entries, which does not match its total channel count.
CAP1114 does not support microchip,signal-guard and microchip,calib-sensitivity.
Add CAP1114 to the unsupported enum list.
Signed-off-by Jun Yan <[email protected]>--- .../bindings/input/microchip,cap11xx.yaml | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-)Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +6
-1@@ -12,6 +12,7 @@ description: | For more product information please see the links below: CAP1106: https://ww1.microchip.com/downloads/en/DeviceDoc/00001624B.pdf + CAP1114: https://ww1.microchip.com/downloads/en/DeviceDoc/00002444A.pdf CAP1126: https://ww1.microchip.com/downloads/en/DeviceDoc/00001623B.pdf CAP1188: https://ww1.microchip.com/downloads/en/DeviceDoc/00001620C.pdf CAP1203: https://ww1.microchip.com/downloads/en/DeviceDoc/00001572B.pdf@@ -26,6 +27,7 @@ properties: compatible: enum: - microchip,cap1106 + - microchip,cap1114 - microchip,cap1126 - microchip,cap1188 - microchip,cap1203@@ -122,6 +124,8 @@ properties: is required for a touch to be registered, making the touch sensor less sensitive. The number of entries must correspond to the number of channels. + CAP1114 is an exception where channels 8~14 reuse the eighth entry's + threshold, so counts differ. microchip,calib-sensitivity: $ref: /schemas/types.yaml#/definitions/uint32-array@@ -149,7 +153,7 @@ patternProperties: reg: description: LED channel number minimum: 0 - maximum: 7 + maximum: 10 label: true@@ -178,6 +182,18 @@ allOf: properties: reset-gpios: false + - if:
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml allOf: · line 195
Quoted 10 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +10
-0+ properties: + compatible: + contains: + enum: + - microchip,cap1114 + then: + properties: + linux,keycodes: + minItems: 14 + maxItems: 14
Sashiko complaint here is valid.
You need to increase the outer constraint to max 14, and only set the min here.
Then you need to add an else that sets maxitems to 8.
pw-bot: changes-requested
Cheers,
Conor.
Re: [PATCH v2 8/9] dt-bindings: input: microchip,cap11xx: Add CAP1114 support
Quoted 83 lines · Jun Yan
Quoted 19 lines
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
=20
Add the compatible string for CAP1114, add its datasheet URL, update the maximum of LED channel reg, and add constraint for linux,keycodes.
=20
Previously, the LED reg property had a default maximum of 7 for CAP1188. With the addition of CAP1114, the default maximum is now 11. An if-then constraint is added to limit the LED count for CAP1188. =20
Update description for microchip,input-threshold: CAP1114 only provides eight threshold entries, which does not match its total channel count. =20
CAP1114 does not support microchip,signal-guard and microchip,calib-sensitivity.
=20
Add CAP1114 to the unsupported enum list.
=20Review
Quoted 6 lines
Signed-off-by Jun Yan <[email protected]>--- .../bindings/input/microchip,cap11xx.yaml | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-)=20
(quoted diff) +0
-0ml
b/Documentation/devicetree/bindings/input/microchip,cap11xx.yamlQuoted 7 lines
index
778ec6d659a8..0e9a1a8a3f3e100644Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +0
-0@@ -12,6 +12,7 @@ description: |=20
For more product information please see the links below:CAP1106: https://ww1.microchip.com/downloads/en/DeviceDoc/00001624B.=Quoted 1 line
+ CAP1114: https://ww1.microchip.com/downloads/en/DeviceDoc/00002444A.=
Quoted 1 line
CAP1126: https://ww1.microchip.com/downloads/en/DeviceDoc/00001623B.=Quoted 1 line
CAP1188: https://ww1.microchip.com/downloads/en/DeviceDoc/00001620C.=Quoted 1 line
CAP1203: https://ww1.microchip.com/downloads/en/DeviceDoc/00001572B.=Documentation/devicetree/bindings/input/microchip,cap11xx.yaml properties: · line 124
Quoted 10 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-0@@ -26,6 +27,7 @@ properties: compatible: enum: - microchip,cap1106 + - microchip,cap1114 - microchip,cap1126 - microchip,cap1188 - microchip,cap1203@@ -122,6 +124,8 @@ properties: is required for a touch to be registered, making the touch sensor =less
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml properties:
Quoted 3 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-0sensitive. The number of entries must correspond to the number of channels. + CAP1114 is an exception where channels 8~14 reuse the eighth entry='s
Quoted 25 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-0+ threshold, so counts differ.=20
microchip,calib-sensitivity:
$ref: /schemas/types.yaml#/definitions/uint32-arrayDocumentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-1@@ -149,7 +153,7 @@ patternProperties: reg: description: LED channel number minimum: 0 - maximum: 7 + maximum: 10=20
label: true
=20Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +0
-0@@ -178,6 +182,18 @@ allOf: properties: reset-gpios: false=20
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +8
-0+ - if: + properties: + compatible: + contains: + enum: + - microchip,cap1114 + then: + properties:
Quoted 8 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml allOf: · line 195
Quoted 3 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +3
-0+ linux,keycodes: + minItems: 14 + maxItems: 14Sashiko complaint here is valid.
You need to increase the outer constraint to max 14, and only set the min here.
Then you need to add an else that sets maxitems to 8.
Thanks for the review. I'll fix this in v3.
Quoted 4 lines
pw-bot: changes-requested
Cheers,
Conor.
PATCH v2 9/9 Input: cap11xx - add support for CAP1114
In reply to Jun YanCAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
The CAP1114 uses two control registers for LED output management and requires two button status registers for touch input state reporting.
By default, channels CS8~CS14 operate as a single grouped block. Set the corresponding register enable bit to enable these channels as independent touch inputs. Note these channels share the input threshold of the eighth entry, causing num_sensor_thresholds to differ from num_channels.
--- drivers/input/keyboard/cap11xx.c | 74 ++++++++++++++++++++++++++++++-- 1 file changed, 70 insertions(+), 4 deletions(-)
drivers/input/keyboard/cap11xx.c +70 -4
@@ -18,6 +18,12 @@#include <linux/gpio/consumer.h> #include <linux/bitfield.h> +#define CAP1114_REG_BUTTON_STATUS1 0x03 +#define CAP1114_REG_BUTTON_STATUS2 0x04 +#define CAP1114_REG_CONFIG2 0x40 +#define CAP1114_REG_CONFIG2_VOL_UP_DOWN BIT(1) +#define CAP1114_REG_LED_OUTPUT_CONTROL1 0x73 +#define CAP11XX_REG_MAIN_CONTROL 0x00#define CAP11XX_REG_MAIN_CONTROL_GAIN_SHIFT (6)#define CAP11XX_REG_MAIN_CONTROL_GAIN_MASK (0xc0)
@@ -82,6 +88,7 @@ struct cap11xx_hw_model {unsigned int num_leds;unsigned int num_sensor_thresholds;bool has_gain; +bool has_grouped_sensors;bool has_irq_config;bool has_repeat_en;bool has_sensitivity_control;
@@ -98,6 +105,9 @@ static const struct reg_default cap11xx_reg_defaults[] = { { CAP11XX_REG_SENSOR_THRESH(3), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(4), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(5), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(6), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(7), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(8), 0x40 }, { CAP11XX_REG_CONFIG2, 0x40 }, };
@@ -106,6 +116,12 @@ static bool cap11xx_volatile_reg(struct device *dev, unsigned int reg)switch (reg) {case CAP11XX_REG_MAIN_CONTROL :case CAP11XX_REG_SENSOR_INPUT : +/* +* CAP1114_REG_BUTTON_STATUS1 (CAP11XX_REG_SENSOR_INPUT) and +* CAP1114_REG_BUTTON_STATUS2 is volatile for the CAP1114, +* which supports more than 8 touch channels. +*/ +case CAP1114_REG_BUTTON_STATUS2 :return true; }
@@ -283,6 +299,17 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv)of_property_read_u32_array (node,"linux,keycodes" , priv->keycodes, priv->model->num_channels); +/* +* CAP1114 needs dedicated configuration to split +* grouped sensors into independent inputs. +*/ +if (priv->model->has_grouped_sensors) { + error =regmap_set_bits (priv->regmap,CAP1114_REG_CONFIG2 , +CAP1114_REG_CONFIG2_VOL_UP_DOWN ); +if (error) +return error; + } +if (priv->model->has_repeat_en) {/* Disable autorepeat. The Linux input system has its own handling. */ error =regmap_write (priv->regmap,CAP11XX_REG_REPEAT_RATE ,0 );
@@ -311,6 +338,21 @@ static irqreturn_t cap11xx_thread_func(int irq_num, void *data)if (ret <0 ) goto out; +if (priv->model->num_channels >8 ) { +unsigned int status2; + + ret =regmap_read (priv->regmap, priv->model->sensor_input_reg_base +1 , &status2); +if (ret <0 ) + goto out; + +/* +* CAP1114 STATUS1 register only contains data for the first 6 channels. +* the remaining channels is stored in STATUS2. +*/ + status &=GENMASK (5 ,0 ); + status |=FIELD_PREP (GENMASK (13 ,6 ), status2); + } +for (i =0 ; i < priv->idev->keycodemax; i++)input_report_key (priv->idev, priv->keycodes[i], status & (1 << i));
@@ -360,10 +402,16 @@ static int cap11xx_led_set(struct led_classdev *cdev,* limitation. Brightness levels per LED are either * 0 (OFF) and 1 (ON). */ -return regmap_update_bits (priv->regmap, - priv->model->led_output_control_reg_base, -BIT (led->reg), - value ?BIT (led->reg) :0 ); +if (led->reg >=8 ) +return regmap_update_bits (priv->regmap, + priv->model->led_output_control_reg_base +1 , +BIT (led->reg -8 ), + value ?BIT (led->reg -8 ) :0 ); +else +return regmap_update_bits (priv->regmap, + priv->model->led_output_control_reg_base, +BIT (led->reg), + value ?BIT (led->reg) :0 ); } static int cap11xx_init_leds(struct device *dev,
@@ -394,6 +442,14 @@ static int cap11xx_init_leds(struct device *dev,if (error)return error; +if (num_leds >8 ) { + error =regmap_update_bits (priv->regmap, + priv->model->led_output_control_reg_base +1 , +GENMASK (num_leds -8 -1 ,0 ),0 ); +if (error) +return error; + } + duty_val =FIELD_PREP (CAP11XX_REG_LED_DUTY_MAX_MASK ,CAP11XX_REG_LED_DUTY_MAX_VALUE );
@@ -572,6 +628,14 @@ static const struct cap11xx_hw_model cap1106_model = { .has_repeat_en = true, }; +static const struct cap11xx_hw_model cap1114_model = { + .product_id =0x3a , + .num_channels =14 , .num_leds =11 , .num_sensor_thresholds =8 , + .led_output_control_reg_base =CAP1114_REG_LED_OUTPUT_CONTROL1 , + .sensor_input_reg_base =CAP1114_REG_BUTTON_STATUS1 , + .has_grouped_sensors = true, +}; +static const struct cap11xx_hw_model cap1126_model = { .product_id =0x53 , .num_channels =6 , .num_leds =2 , .num_sensor_thresholds =6 ,
@@ -628,6 +692,7 @@ static const struct cap11xx_hw_model cap1298_model = {static const struct of_device_id cap11xx_dt_ids[] = { { .compatible ="microchip,cap1106" , .data = &cap1106_model }, + { .compatible ="microchip,cap1114" , .data = &cap1114_model }, { .compatible ="microchip,cap1126" , .data = &cap1126_model }, { .compatible ="microchip,cap1188" , .data = &cap1188_model }, { .compatible ="microchip,cap1203" , .data = &cap1203_model },
@@ -640,6 +705,7 @@ MODULE_DEVICE_TABLE(of, cap11xx_dt_ids);static const struct i2c_device_id cap11xx_i2c_ids[] = { { .name ="cap1106" , .driver_data = (kernel_ulong_t)&cap1106_model }, + { .name ="cap1114" , .driver_data = (kernel_ulong_t)&cap1114_model }, { .name ="cap1126" , .driver_data = (kernel_ulong_t)&cap1126_model }, { .name ="cap1188" , .driver_data = (kernel_ulong_t)&cap1188_model }, { .name ="cap1203" , .driver_data = (kernel_ulong_t)&cap1203_model },
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v2 9/9] Input: cap11xx - add support for CAP1114
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider: - [High] Buffer overflow when parsing the 'microchip,calib-sensitivity' device tree property for devices…
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [High] Buffer overflow when parsing the 'microchip,calib-sensitivity' device tree property for devices with more than 8 channels.
- [Medium] Integer truncation silently drops signal guard configurations for channels 8-13.
- [Low] Out-of-bounds GENMASK generates an 11-bit mask for an 8-bit LED control register.
- [Low] Unnecessary 9th threshold register added to regmap defaults.
--
commit a843fc20f78c2766e479b33ffb3dcd6238d1f3f0
Author: Jun Yan <[email protected]>
Input: cap11xx - add support for CAP1114
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support. The CAP1114 uses two control registers for LED output management and requires two button status registers for touch input state reporting.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0
[ ... ]
drivers/input/keyboard/cap11xx.c static const struct reg_default cap11xx_reg_defaults[] = { · line 110
Quoted 7 lines
drivers/input/keyboard/cap11xx.c +3
-0@@ -98,6 +105,9 @@ static const struct reg_default cap11xx_reg_defaults[] = { { CAP11XX_REG_SENSOR_THRESH(3), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(4), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(5), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(6), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(7), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(8), 0x40 },
[Severity: Low]
Does this code inadvertently add a 9th threshold register?
Since the indexing is 0-based, an 8-threshold device should only need indices 0 through 7.
Register index 8 appears to map to an unused register.
Quoted 2 lines
drivers/input/keyboard/cap11xx.c +0
-0{ CAP11XX_REG_CONFIG2, 0x40 }, };
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_init_leds(struct device *dev, · line 448
Quoted 8 lines
drivers/input/keyboard/cap11xx.c +4
-0@@ -394,6 +442,14 @@ static int cap11xx_init_leds(struct device *dev,if (error)return error; +if (num_leds >8 ) { + error =regmap_update_bits (priv->regmap, + priv->model->led_output_control_reg_base +1 , +GENMASK (num_leds -8 -1 ,0 ),0 );
[Severity: Low]
Can this result in an out-of-bounds mask generation when num_leds > 8?
In cap11xx_init_leds() just prior to this addition, the code calls:
error = regmap_update_bits(priv->regmap,
priv->model->led_output_control_reg_base,
GENMASK(num_leds - 1, 0), 0);When num_leds is 11 for the CAP1114 model, this generates an 11-bit mask to update an 8-bit register.
While the regmap core safely masks this, should the mask be clamped to min(num_leds, 8) to accurately reflect the hardware register's capacity?
Quoted 3 lines
drivers/input/keyboard/cap11xx.c +3
-0+if (error) +return error; + }
[ ... ]
drivers/input/keyboard/cap11xx.c static const struct cap11xx_hw_model cap1106_model = { · line 633
Quoted 7 lines
drivers/input/keyboard/cap11xx.c +3
-0@@ -572,6 +628,14 @@ static const struct cap11xx_hw_model cap1106_model = { .has_repeat_en = true, }; +static const struct cap11xx_hw_model cap1114_model = { + .product_id =0x3a , + .num_channels =14 , .num_leds =11 , .num_sensor_thresholds =8 ,
[Severity: High]
Does this code overflow the calib_sensitivities array during initialization?
In struct cap11xx_priv, the array is rigidly sized to 8 elements:
u32 calib_sensitivities[8];
u32 keycodes[];During cap11xx_init_keys(), when parsing "microchip,calib-sensitivity", the driver reads priv->model->num_channels elements:
of_property_read_u32_array(node, "microchip,calib-sensitivity",
priv->calib_sensitivities,
priv->model->num_channels)With num_channels set to 14, won't this write 14 elements into an 8-element array, clobbering the adjacent keycodes flexible array member and potentially causing memory corruption or a kernel panic?
[Severity: Medium]
Will this configuration lead to integer truncation when parsing the "microchip,signal-guard" property?
In struct cap11xx_priv, the mask is defined as an 8-bit value:
u8 signal_guard_inputs_mask;
During cap11xx_init_keys(), a loop iterates up to num_channels (14) and shifts the bits:
priv->signal_guard_inputs_mask |= 0x01 << i;
For channels 8 to 13, won't this bitwise shift exceed the 8-bit variable width and silently truncate to 0?
Even if the CAP1114 doesn't support signal guards, this drops the bitmask for the upper channels, bypassing the capability check and failing to emit the intended 'unsupported' warning.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +4
-0+ .led_output_control_reg_base = CAP1114_REG_LED_OUTPUT_CONTROL1, + .sensor_input_reg_base = CAP1114_REG_BUTTON_STATUS1, + .has_grouped_sensors = true, +};
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=9
Re: [PATCH v2 9/9] Input: cap11xx - add support for CAP1114
Quoted 39 lines
Thank you for your contribution! Sashiko AI review found 4 potential issue(=
s) to consider:
- [High] Buffer overflow when parsing the 'microchip,calib-sensitivity' dev= ice tree property for devices with more than 8 channels.
- [Medium] Integer truncation silently drops signal guard configurations fo= r channels 8-13.
- [Low] Out-of-boundsGENMASKgenerates an 11-bit mask for an 8-bit LED c= ontrol register.
- [Low] Unnecessary 9th threshold register added to regmap defaults. --commit
a843fc20f78c2766e479b33ffb3dcd6238d1f3f0
Author: Jun Yan <[email protected]>Input: cap11xx - add support for CAP1114
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support. The CAP1114 uses two control registers for LED output management and requires two button status registers for touch input state reporting.
drivers/input/keyboard/ca=
Quoted 1 line
drivers/input/keyboard/ca= renamed from drivers/input/keyboard/cap11xx.c +0
-0
p11xx.cQuoted 3 lines
index
d45bb231d7a1f..e4da0e26c34a8100644drivers/input/keyboard/cap11xx.c +0
-0[ ... ]
drivers/input/keyboard/cap11xx.c static const struct reg_default cap11xx_reg_defaults[]=
Quoted 1 line
drivers/input/keyboard/cap11xx.c +0
-0@@ -98,6 +105,9 @@ static const struct reg_default cap11xx_reg_defaults[]==3D {
drivers/input/keyboard/cap11xx.c static const struct reg_default cap11xx_reg_defaults[] = { · line 110
Quoted 6 lines
drivers/input/keyboard/cap11xx.c +3
-0{ CAP11XX_REG_SENSOR_THRESH(3), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(4), 0x40 }, { CAP11XX_REG_SENSOR_THRESH(5), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(6), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(7), 0x40 }, + { CAP11XX_REG_SENSOR_THRESH(8), 0x40 },[Severity: Low]
Does this code inadvertently add a 9th threshold register?
Quoted 5 lines
Since the indexing is 0-based, an 8-threshold device should only need indic= es
0 through 7.Register index 8 appears to map to an unused register.
Good catch, CAP11XX_REG_SENSOR_THRESH(8) should be dropped.
Quoted 22 lines
Quoted 3 lines
drivers/input/keyboard/cap11xx.c +0
-0{ CAP11XX_REG_CONFIG2, 0x40 }, };[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_init_leds(struct device *dev, · line 448
Quoted 8 lines
drivers/input/keyboard/cap11xx.c +0
-0@@ -394,6 +442,14 @@ static int cap11xx_init_leds(struct device *dev,if (error)return error;=20
drivers/input/keyboard/cap11xx.c +4
-0+if (num_leds >8 ) { + error =3D regmap_update_bits(priv->regmap, + priv->model->led_output_control_reg_base +1 , +GENMASK (num_leds -8 -1 ,0 ),0 );[Severity: Low]
Can this result in an out-of-bounds mask generation whennum_leds> 8?In
cap11xx_init_leds()just prior to this addition, the code calls:error =3D regmap_update_bits(priv->regmap, priv->model->led_output_control_reg_base, GENMASK(num_leds - 1, 0), 0);
Quoted 5 lines
When
num_ledsis 11 for the CAP1114 model, this generates an 11-bit mask to update an 8-bit register.While the regmap core safely masks this, should the mask be clamped to
min(num_leds, 8)to accurately reflect the hardware register's capacity?
Agreed, thanks for the correction.
Quoted 25 lines
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +3
-0+if (error) +return error; + }[ ... ]
drivers/input/keyboard/cap11xx.c static const struct cap11xx_hw_model cap1106_model =
Quoted 1 line
drivers/input/keyboard/cap11xx.c +0
-0@@ -572,6 +628,14 @@ static const struct cap11xx_hw_model cap1106_model ==3D {
drivers/input/keyboard/cap11xx.c
Quoted 6 lines
drivers/input/keyboard/cap11xx.c +0
-0.has_repeat_en =3D true, };=20
drivers/input/keyboard/cap11xx.c +3
-0+static const struct cap11xx_hw_model cap1114_model =3D { + .product_id =3D 0x3a, + .num_channels =3D 14, .num_leds =3D 11, .num_sensor_thresholds =3D 8,[Severity: High]
Does this code overflow thecalib_sensitivitiesarray during initialization?In struct
cap11xx_priv, the array is rigidly sized to 8 elements:u32 calib_sensitivities[8]; u32 keycodes[];During
cap11xx_init_keys(), when parsing "microchip,calib-sensitivity", the driver readspriv->model->num_channelselements:
Quoted 8 lines
of_property_read_u32_array(node, "microchip,calib-sensitivity", priv->calib_sensitivities, priv->model->num_channels)With
num_channelsset to 14, won't this write 14 elements into an 8-element array, clobbering the adjacent keycodes flexible array member and potential= ly
causing memory corruption or a kernel panic?
Good point, I'll fix that in v3.
Quoted 14 lines
[Severity: Medium]
Will this configuration lead to integer truncation when parsing the "microchip,signal-guard" property?In struct
cap11xx_priv, the mask is defined as an 8-bit value:u8 signal_guard_inputs_mask;During
cap11xx_init_keys(), a loop iterates up tonum_channels(14) and shi= fts
the bits:
Quoted 5 lines
priv->signal_guard_inputs_mask |=3D 0x01 << i;For channels 8 to 13, won't this bitwise shift exceed the 8-bit variable wi= dth
and silently truncate to 0?
Good point, I'll fix that in v3.
Quoted 15 lines
Even if the CAP1114 doesn't support signal guards, this drops the bitmask f= or
the upper channels, bypassing the capability check and failing to emit the intended 'unsupported' warning.drivers/input/keyboard/cap11xx.c
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +4
-0+ .led_output_control_reg_base =3D CAP1114_REG_LED_OUTPUT_CONTROL1, + .sensor_input_reg_base =3D CAP1114_REG_BUTTON_STATUS1, + .has_grouped_sensors =3D true, +};--=20
Sashiko AI review =C2=B7 https://sashiko.dev/#/patchset/20260612072237.1177=
[email protected]?part=3D9