Input: cap11xx - Add support for CAP1114
Subsystems (3)
v4 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-10 add support for CAP1114.
Changes in v4:
- Revert cleanup operation for CAP11XX_REG_SENSOR_DELTA.
- Move the LED unit-address update operation to the CAP1114 support patch.
- Limit the CAP1114 LED unit-address range from 0x0 to 0xa.
- Link to v3:
https://lore.kernel.org/all/[email protected]/
Changes in v3:
- Simplified the logic of the reset pin operation.
- Adjust linux,keycodes configuration for CAP11xx.
- Drop unnecessary CAP11XX_REG_SENSOR_THRESH(8).
- Checks for the presence of microchip,calib-sensitivity and microchip,signal-guard properties before processing them.
- Link to v2:
https://lore.kernel.org/all/[email protected]/
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 (10):
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.
Input: cap11xx - guard unsupported DT properties before parsing
dt-bindings: input: microchip,cap11xx: Add CAP1114 support
Input: cap11xx - add support for CAP1114
.../bindings/input/microchip,cap11xx.yaml | 90 +++++- drivers/input/keyboard/cap11xx.c | 274 +++++++++++------- 2 files changed, 254 insertions(+), 110 deletions(-)
--
2.54.0
PATCH v4 1/10 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
PATCH v4 2/10 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 | 51 -------------------------------- 1 file changed, 51 deletions(-)
drivers/input/keyboard/cap11xx.c +0 -51
@@ -20,53 +20,24 @@#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 +82,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)
Signature · 1 line
2.54.0
[email protected]
AI reviewRe: [PATCH v4 02/10] Input: cap11xx - remove unused register macros
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] The patch fails to remove unused definitions in cap11xx_volatile_reg despite the commit message claiming otherwise.
Pre-existing issues:
- [High] The threaded interrupt handler unconditionally returns IRQ_HANDLED even when I2C operations fail to clear the hardware interrupt source, risking an IRQ storm. --
commit 8aa29f5d8b4eefa859454cdb0496fecf07ff5aa8
Author: Jun Yan <[email protected]>
Remove 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.
Quoted 2 lines
Remove unused register address macros and unused definitions in the
cap11xx_reg_defaultsarray andcap11xx_volatile_reg.
[Severity: Medium]
Will this patch actually remove the unused definitions in cap11xx_volatile_reg?
The commit message states they are removed, but the patch doesn't modify that function.
drivers/input/keyboard/cap11xx.c line 24
Quoted 12 lines
drivers/input/keyboard/cap11xx.c +0
-2@@ -20,53 +20,24 @@#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))
[Severity: Medium]
Should this macro also have been removed?
Because cap11xx_volatile_reg() was not updated, this macro and its corresponding case entries:
case CAP11XX_REG_SENOR_DELTA(0): case CAP11XX_REG_SENOR_DELTA(1):
were left in the file.
[ ... ]
drivers/input/keyboard/cap11xx.c struct cap11xx_hw_model { · line 96
Quoted 1 line
drivers/input/keyboard/cap11xx.c +0
-0static bool cap11xx_volatile_reg (struct device *dev,unsigned int reg)
[Severity: High]
This isn't a bug introduced by this patch, but could the error handling in cap11xx_thread_func() risk an IRQ storm?
If an I2C communication error occurs during the interrupt handler:
cap11xx_thread_func() {
...
if (ret < 0)
goto out;
...
out:
return IRQ_HANDLED;
}Because this uses IRQF_ONESHOT, returning IRQ_HANDLED instructs the IRQ subsystem to unmask the interrupt. Since the device's interrupt status was never cleared due to the I2C failure, the interrupt line will remain asserted.
Will this cause the interrupt to immediately fire again when unmasked, creating an infinite loop?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
PATCH v4 3/10 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.
Drop unnecessary led unit-address pattern.
--- .../bindings/input/microchip,cap11xx.yaml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +13 -2
@@ -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]>
@@ -131,7 +140,9 @@ patternProperties: 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
[email protected]
AI reviewRe: [PATCH v4 03/10] dt-bindings: input: microchip,cap11xx: Update datasheet URL and LED reg range
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] Incomplete Refactoring / Code and Commit Message Mismatch --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] Incomplete Refactoring / Code and Commit Message Mismatch
--
commit e8499e0ca62db6a2ee6dc0986e7c04ea1337f6c7
Author: Jun Yan <[email protected]>
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. Drop unnecessary led unit-address pattern.
Quoted 4 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +0
-0
[ ... ]
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml patternProperties: · line 145
Quoted 8 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +3
-1@@ -131,7 +140,9 @@ patternProperties: properties: reg: - enum: [0, 1, 2, 3, 4, 5, 6, 7] + description: LED channel number + minimum: 0 + maximum: 7
[Severity: Medium]
Does this fully prepare the schema for CAP1114 support as mentioned in the commit message?
While the constraints on the reg property were updated here, the main patternProperties definition for the LED node just above this still uses "^led@[0-7]$".
Since CAP1114 has 11 LED channels, wouldn't the schema fail validation for nodes like led@8 and led@9 because the top-level pattern wasn't also updated?
[ ... ]
Quoted 6 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-1@@ -158,7 +169,7 @@ allOf: - microchip,cap1298 then: patternProperties: - "^led@[0-7]$": false + "^led@": false
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3
PATCH v4 4/10 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 v4 5/10 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
PATCH v4 6/10 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>
@@ -44,6 +45,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;
@@ -56,6 +60,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;
@@ -459,6 +464,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_HIGH ); +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) { +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
PATCH v4 7/10 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>
@@ -36,7 +37,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
@@ -77,10 +77,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; };
@@ -211,8 +215,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]);
@@ -286,10 +290,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 ; }
@@ -308,7 +314,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;
@@ -362,7 +368,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 ); }
@@ -374,6 +380,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 ;
@@ -387,15 +394,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 (min (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 ); + 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;
@@ -561,41 +571,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 v4 07/10] Input: cap11xx - refactor code for better CAP1114 support.
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
New issues:
- [High] Bitmask truncation in cap11xx_led_set causing silent failure for LEDs >= 8.
- [High] Regmap cache staleness due to missing volatile register definition for the dynamic sensor_input_reg_base.
Pre-existing issues:
- [High] Buffer overflow and Fortify Source panic when reading calib_sensitivities for devices with more than 8 channels. --
commit 837f207153012dfc0860b6d46ad5d3ae4f7b3004
Author: Jun Yan <[email protected]>
Extend cap11xx_hw_model structure to support CAP1114
This patch extends the 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_init_keys(struct cap11xx_priv *priv) · line 222
Quoted 11 lines
drivers/input/keyboard/cap11xx.c +2
-2@@ -211,8 +215,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)) { + priv->thresholds, priv->model->num_sensor_thresholds)) { -for (i =0 ; i < priv->model->num_channels; i++) { +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]);
[Severity: High]
This is a pre-existing issue, but looking at cap11xx_init_keys(), could reading "microchip,calib-sensitivity" overflow the calib_sensitivities array for devices with more than 8 channels?
In cap11xx_init_keys():
} else if (!of_property_read_u32_array(node, "microchip,calib-sensitivity",
priv->calib_sensitivities,
priv->model->num_channels)) {The calib_sensitivities array is statically allocated to 8 elements in struct cap11xx_priv. For models with more than 8 channels (like the CAP1114 which has 14), could this cause a buffer overflow into the keycodes array and trigger a kernel panic if FORTIFY_SOURCE is enabled?
[ ... ]
drivers/input/keyboard/cap11xx.c static irqreturn_t cap11xx_thread_func(int irq_num, void *data) · line 319
Quoted 8 lines
drivers/input/keyboard/cap11xx.c +1
-1@@ -308,7 +314,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;
[Severity: High]
Will this result in reading stale cached values instead of the actual hardware state?
The interrupt handler now dynamically reads from sensor_input_reg_base. However, cap11xx_volatile_reg() still hardcodes CAP11XX_REG_SENSOR_INPUT as a volatile register.
Since the new dynamic base register (and the subsequent register for devices with more than 8 channels) is no longer marked volatile, will the regmap cache return stale data and break input events for these models?
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_led_set(struct led_classdev *cdev, · line 374
Quoted 9 lines
drivers/input/keyboard/cap11xx.c +1
-1@@ -362,7 +368,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 ); }
[Severity: High]
Will this bitmask be truncated for LEDs with an index of 8 or higher?
The bitmask passed to regmap_update_bits() is BIT(led->reg). Since models like CAP1114 support more than 8 LEDs, and the register operations are 8-bit, BIT(led->reg) will exceed 8 bits for higher-index LEDs.
The initialization code in cap11xx_init_leds() caps the LED clearance mask to 8 bits:
GENMASK(min(num_leds, 8) - 1, 0)
Does cap11xx_led_set() also need an update to handle devices with more than 8 LEDs to avoid silently failing?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=7
PATCH v4 8/10 Input: cap11xx - guard unsupported DT properties before parsing
In reply to Jun YanCheck of_property_present() before parsing microchip,calib-sensitivity and microchip,signal-guard, so that models which do not support these properties (e.g. CAP1114) skip the parsing entirely.
This prevents a potential buffer overflow in calib_sensitivities[8] and signal_guard_inputs_mask when a model with more than 8 channels (CAP1114 has 14) would otherwise call of_property_read_u32_array() with num_channels as the element count.
--- drivers/input/keyboard/cap11xx.c | 52 +++++++++++++++++--------------- 1 file changed, 27 insertions(+), 25 deletions(-)
drivers/input/keyboard/cap11xx.c +27 -25
@@ -231,10 +231,13 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv) } } -if (!of_property_read_u32_array (node,"microchip,calib-sensitivity" , - priv->calib_sensitivities, - priv->model->num_channels)) { -if (priv->model->has_sensitivity_control) { +if (of_property_present (node,"microchip,calib-sensitivity" )) { +if (!priv->model->has_sensitivity_control) { +dev_warn (dev, +"This model doesn't support 'calib-sensitivity'\n" ); + }else if (!of_property_read_u32_array (node,"microchip,calib-sensitivity" , + priv->calib_sensitivities, + priv->model->num_channels)) {for (i =0 ; i < priv->model->num_channels; i++) {if (!is_power_of_2 (priv->calib_sensitivities[i]) || priv->calib_sensitivities[i] >4 ) {
@@ -254,32 +257,31 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv)if (error)return error; } - }else { -dev_warn (dev, -"This model doesn't support 'calib-sensitivity'\n" ); } } -for (i =0 ; i < priv->model->num_channels; i++) { -if (!of_property_read_u32_index (node,"microchip,signal-guard" , - i, &u32_val)) { -if (u32_val >1 ) -return -EINVAL ; -if (u32_val) - priv->signal_guard_inputs_mask |=0x01 << i; - } - } - -if (priv->signal_guard_inputs_mask) { -if (priv->model->has_signal_guard) { - error =regmap_write (priv->regmap, -CAP11XX_REG_SIGNAL_GUARD_ENABLE , - priv->signal_guard_inputs_mask); -if (error) -return error; - }else { +if (of_property_present (node,"microchip,signal-guard" )) { +if (!priv->model->has_signal_guard) {dev_warn (dev,"This model doesn't support 'signal-guard'\n" ); + }else { +for (i =0 ; i < priv->model->num_channels; i++) { +if (!of_property_read_u32_index (node,"microchip,signal-guard" , + i, &u32_val)) { +if (u32_val >1 ) +return -EINVAL ; +if (u32_val) + priv->signal_guard_inputs_mask |=0x01 << i; + } + } + +if (priv->signal_guard_inputs_mask) { + error =regmap_write (priv->regmap, +CAP11XX_REG_SIGNAL_GUARD_ENABLE , + priv->signal_guard_inputs_mask); +if (error) +return error; + } } }
Signature · 1 line
2.54.0
PATCH v4 9/10 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 | 39 +++++++++++++++++-- 1 file changed, 36 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +36 -3
@@ -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
@@ -62,7 +64,7 @@ properties: linux,keycodes: minItems: 3 - maxItems: 8 + maxItems: 14 description: | Specifies an array of numeric keycode values to be used for the channels. If this property is
@@ -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
@@ -140,7 +144,7 @@ properties: The number of entries must correspond to the number of channels. patternProperties: - "^led@[0-7]$": + "^led@[0-9a]$": type: object description: CAP11xx LEDs $ref: /schemas/leds/common.yaml#
@@ -149,7 +153,7 @@ patternProperties: reg: description: LED channel number minimum: 0 - maximum: 7 + maximum: 10 label: true
@@ -178,6 +182,21 @@ allOf: properties: reset-gpios: false + - if: + properties: + compatible: + contains: + enum: + - microchip,cap1114 + then: + properties: + linux,keycodes: + minItems: 14 + else: + properties: + linux,keycodes: + maxItems: 8 + - if: properties: compatible:
@@ -205,12 +224,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 v4 09/10] dt-bindings: input: microchip,cap11xx: Add CAP1114 support
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] Schema Validation Regression (Incomplete Constraints Update) --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] Schema Validation Regression (Incomplete Constraints Update)
--
commit 74e08f50d786114a66be01956a59aeb6b7083fbc
Author: Jun Yan <[email protected]>
dt-bindings: input: 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, add its datasheet URL, update the maximum of LED channel reg, and add constraint for linux,keycodes.
Quoted 4 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +0
-0
[ ... ]
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml properties: · line 147
Quoted 6 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-1@@ -140,7 +144,7 @@ properties: The number of entries must correspond to the number of channels. patternProperties: - "^led@[0-7]$": + "^led@[0-9a]$":
[Severity: Medium]
Does this global regex update also require an update to the disablement block for hardware variants without LEDs?
The allOf block that disables LEDs for specific variants (like CAP1106, CAP1203, etc.) still uses "^led@[0-7]$": false.
Because of this new global regex, wouldn't nodes like led@8, led@9, and led@a now bypass the false constraint and be silently permitted on devices that are supposed to have zero LEDs?
Quoted 11 lines
Documentation/devicetree/bindings/input/microchip,cap11xx.yaml +1
-1type: object description: CAP11xx LEDs $ref: /schemas/leds/common.yaml#@@ -149,7 +153,7 @@ patternProperties: reg: description: LED channel number minimum: 0 - maximum: 7 + maximum: 10 label: true
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=9
PATCH v4 10/10 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 | 73 ++++++++++++++++++++++++++++++-- 1 file changed, 69 insertions(+), 4 deletions(-)
drivers/input/keyboard/cap11xx.c +69 -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)
@@ -83,6 +89,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;
@@ -99,6 +106,8 @@ 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_CONFIG2, 0x40 }, };
@@ -107,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 :case CAP11XX_REG_SENOR_DELTA (0 ):case CAP11XX_REG_SENOR_DELTA (1 ):case CAP11XX_REG_SENOR_DELTA (2 ):
@@ -292,6 +307,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 );
@@ -320,6 +346,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));
@@ -369,10 +410,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,
@@ -403,6 +450,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 );
@@ -581,6 +636,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 ,
@@ -637,6 +700,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 },
@@ -649,6 +713,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 v4 10/10] Input: cap11xx - add support for CAP1114
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] Out-of-bounds write in cap11xx_i2c_probe due to unvalidated Device Tree keycodes. --
commit 42cef688f767435c4da8af0dd519be20d4164735
Author: Jun Yan <[email protected]>
CAP1114 is a 14-channel capacitive touch sensor with 11 LED outputs and hardware reset support.
This commit adds support for the CAP1114 touch sensor, updating the driver to handle up to 14 channels and 11 LED outputs. It introduces logic to read from a secondary status register to support the expanded channel count and configures grouped sensors as independent inputs.
Quoted 4 lines
drivers/input/keyboard/cap11xx.c +0
-0
[ ... ]
drivers/input/keyboard/cap11xx.c static int cap11xx_init_keys(struct cap11xx_priv *priv) · line 308
Quoted 3 lines
drivers/input/keyboard/cap11xx.c +0
-0@@ -292,6 +307,17 @@ static int cap11xx_init_keys(struct cap11xx_priv *priv)of_property_read_u32_array (node,"linux,keycodes" , priv->keycodes, priv->model->num_channels);
[Severity: High]
This is a pre-existing issue, but I noticed that these keycodes are read directly from the Device Tree into the priv->keycodes array without any bounds validation.
Later during initialization in cap11xx_i2c_probe(), the driver loops over these keycodes and sets bits using an unchecked macro:
__set_bit(priv->keycodes[i], priv->idev->keybit);
If an exceptionally large keycode (greater than KEY_MAX) is provided via a Device Tree overlay, could this cause an out-of-bounds write on the priv->idev->keybit array and corrupt adjacent heap memory? Should we verify that each keycode read from the Device Tree is less than or equal to KEY_MAX?
Quoted 12 lines
drivers/input/keyboard/cap11xx.c +12
-0+ +/* +* 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; + } +
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=10