RTL8231 GPIO expander support
Subsystems (7)
v9 cover RTL8231 GPIO expander support
The RTL8231 GPIO and LED expander can be configured for use as an MDIO or SMI bus device. Currently only the MDIO mode is supported, although SMI mode support should be fairly straightforward, once an SMI bus driver is available.
Provided features by the RTL8231:
- Up to 37 GPIOs
- Configurable drive strength: 8mA or 4mA (currently unsupported)
- Input debouncing on GPIOs 31-36
- Up to 88 LEDs in multiple scan matrix groups
- On, off, or one of six toggling intervals
- "single-color mode": 2×36 single color LEDs + 8 bi-color LEDs
- "bi-color mode": (12 + 2×6) bi-color LEDs + 24 single color LEDs
- Up to one PWM output (currently unsupported)
- Fixed duty cycle, 8 selectable frequencies (1.2kHz - 4.8kHz)
The patches have been in use downstream by OpenWrt for some months. As the original patches are already a few years old, I would like to request all patches to be reviewed again (and I've dropped all provided tags and changelogs until v6).
---
Changes since v8:
- Rebase on top of v6.19-rc1
- Drop no longer needed __maybe_unused for PM functions
- No abbreviations in user messages
- Replace {0,RTL8231_REG_COUNT-1} with RTL8231_REG_{START,END}
- Replace led_start regmap_field with direct regmap operations
- Replace SIMPLE_DEV_PM_OPS with DEFINE_SIMPLE_DEV_PM_OPS
- Switch to REGCACHE_FLAT_S for improved cache performance
Changes since v7:
- All drivers can now be built independently with COMPILE_TEST
- Fix storage size of pinfunction flags in a more compatible way
- Add missing OF dependency to pinctrl driver
- Improve referenced properties in bindings
Changes since v6:
- Drop already merged regmap_gpio changes
- Devicetree bindings:
- Relax description formatting
- Use absolute paths for schema references
- Enforce address format for led node names
- Add pinctrl properties to led-controller node in example
- mfd driver:
- Small code refactors, variable renames
- Header include sorting
- regmap/regcache usage updates
- pinctrl driver:
- Fixed build issue on 64b platforms
- Simplify safe direction startup config
- Add GPIOLIB dependency
RFC for gpio-regmap changes:
Patch series v5 (June 2021):
Sander Vanheule (6):
dt-bindings: leds: Binding for RTL8231 scan matrix
dt-bindings: mfd: Binding for RTL8231
mfd: Add RTL8231 core device
pinctrl: Add RTL8231 pin control and GPIO support
leds: Add support for RTL8231 LED scan matrix
MAINTAINERS: Add RTL8231 MFD driver
.../bindings/leds/realtek,rtl8231-leds.yaml | 136 +++++ .../bindings/mfd/realtek,rtl8231.yaml | 199 +++++++ MAINTAINERS | 10 + drivers/leds/Kconfig | 10 + drivers/leds/Makefile | 1 + drivers/leds/leds-rtl8231.c | 285 ++++++++++ drivers/mfd/Kconfig | 9 + drivers/mfd/Makefile | 1 + drivers/mfd/rtl8231.c | 188 ++++++ drivers/pinctrl/Kconfig | 12 + drivers/pinctrl/Makefile | 1 + drivers/pinctrl/pinctrl-rtl8231.c | 533 ++++++++++++++++++ include/linux/mfd/rtl8231.h | 73 +++ 13 files changed, 1458 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml create mode 100644 Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml create mode 100644 drivers/leds/leds-rtl8231.c create mode 100644 drivers/mfd/rtl8231.c create mode 100644 drivers/pinctrl/pinctrl-rtl8231.c create mode 100644 include/linux/mfd/rtl8231.h
Signature · 1 line
2.52.0
PATCH v9 1/6 dt-bindings: leds: Binding for RTL8231 scan matrix
Add a binding description for the Realtek RTL8231's LED support, which consists of up to 88 LEDs arranged in a number of scanning matrices.
---
Changes since v8:
- Add Rob's tag
Changes since v7:
- Move $ref and add unevaluatedProperties for led nodes
- Drop example redundant with MFD binding
Changes since v6:
- Relax description formatting
- Enforce address format for led node names
- Use absolute paths for schema references
--- .../bindings/leds/realtek,rtl8231-leds.yaml | 136 ++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml
Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml new file +136 -0
@@ -0,0 +1,136 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/leds/realtek,rtl8231-leds.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Realtek RTL8231 LED scan matrix. + +maintainers: + - Sander Vanheule <[email protected]> + +description: | + The RTL8231 has support for driving a number of LED matrices, by scanning + over the LEDs pins, alternatingly lighting different columns and/or rows. + + This functionality is available on an RTL8231, when it is configured for use + as an MDIO device, or SMI device. + + In single color scan mode, 88 LEDs are supported. These are grouped into + three output matrices: + - Group A of 6×6 single color LEDs. Rows and columns are driven by GPIO + pins 0-11. + L0[n] L1[n] L2[n] L0[n+6] L1[n+6] L2[n+6] + | | | | | | + P0/P6 --<--------<--------<--------<--------<--------< (3) + | | | | | | + P1/P7 --<--------<--------<--------<--------<--------< (4) + | | | | | | + P2/P8 --<--------<--------<--------<--------<--------< (5) + | | | | | | + P3/P9 --<--------<--------<--------<--------<--------< (6) + | | | | | | + P4/P10 --<--------<--------<--------<--------<--------< (7) + | | | | | | + P5/P11 --<--------<--------<--------<--------<--------< (8) + (0) (1) (2) (9) (10) (11) + - Group B of 6×6 single color LEDs. Rows and columns are driven by GPIO + pins 12-23. + L0[n] L1[n] L2[n] L0[n+6] L1[n+6] L2[n+6] + | | | | | | + P12/P18 --<--------<--------<--------<--------<--------< (15) + | | | | | | + P13/P19 --<--------<--------<--------<--------<--------< (16) + | | | | | | + P14/P20 --<--------<--------<--------<--------<--------< (17) + | | | | | | + P15/P21 --<--------<--------<--------<--------<--------< (18) + | | | | | | + P16/P22 --<--------<--------<--------<--------<--------< (19) + | | | | | | + P17/P23 --<--------<--------<--------<--------<--------< (20) + (12) (13) (14) (21) (22) (23) + - Group C of 8 pairs of anti-parallel (or bi-color) LEDs. LED selection is + provided by GPIO pins 24-27 and 29-32, polarity selection by GPIO 28. + P24 P25 ... P30 P31 + | | | | + LED POL --X-------X---/\/---X-------X (28) + (24) (25) ... (31) (32) + + In bi-color scan mode, 72 LEDs are supported. These are grouped into four + output matrices: + - Group A of 12 pairs of anti-parallel LEDs. LED selection is provided + by GPIO pins 0-11, polarity selection by GPIO 12. + - Group B of 6 pairs of anti-parallel LEDs. LED selection is provided + by GPIO pins 23-28, polarity selection by GPIO 21. + - Group C of 6 pairs of anti-parallel LEDs. LED selection is provided + by GPIO pins 29-34, polarity selection by GPIO 22. + - Group of 4×6 single color LEDs. Rows are driven by GPIO pins 15-20, + columns by GPIO pins 13-14 and 21-22 (shared with groups B and C). + L2[n] L2[n+6] L2[n+12] L2[n+18] + | | | | + +0 --<--------<---------<---------< (15) + | | | | + +1 --<--------<---------<---------< (16) + | | | | + +2 --<--------<---------<---------< (17) + | | | | + +3 --<--------<---------<---------< (18) + | | | | + +4 --<--------<---------<---------< (19) + | | | | + +6 --<--------<---------<---------< (20) + (13) (14) (21) (22) + + This node must always be a child of a 'realtek,rtl8231' node. + +properties: + $nodename: + const: led-controller + + compatible: + const: realtek,rtl8231-leds + + "#address-cells": + const: 2 + + "#size-cells": + const: 0 + + realtek,led-scan-mode: + $ref: /schemas/types.yaml#/definitions/string + description: + Specify the scanning mode the chip should run in. See general description + for how the scanning matrices are wired up. + enum: [single-color, bi-color] + +patternProperties: + "^led@([1-2]?[0-9]|3[0-1]),[0-2]": + $ref: /schemas/leds/common.yaml# + description: + LEDs are addressed by their port index and led index. Ports 0-23 always + support three LEDs. Additionally, but only when used in single color scan + mode, ports 24-31 support two LEDs. + type: object + + properties: + reg: + items: + - items: + - description: port index + maximum: 31 + - description: led index + maximum: 2 + + required: + - reg + + unevaluatedProperties: false + +required: + - compatible + - "#address-cells" + - "#size-cells" + - realtek,led-scan-mode + +additionalProperties: false
Signature · 1 line
2.52.0
PATCH v9 2/6 dt-bindings: mfd: Binding for RTL8231
In reply to Sander VanheuleAdd a binding description for the Realtek RTL8231, a GPIO and LED expander chip commonly used in ethernet switches based on a Realtek switch SoC. These chips can be addressed via an MDIO or SMI bus, or used as a plain 36-bit shift register.
This binding only describes the feature set provided by the MDIO/SMI configuration, and covers the GPIO, PWM, and pin control properties. The LED properties are defined in a separate binding.
---
Changes since v7:
- Add Rob's tag
- Add pincfg-node reference with no additional properties for input-debounce
Changes since v6:
- Relax description formatting
- Use absolute paths for schema references
- Add pinctrl properties to led-controller node in example
--- .../bindings/mfd/realtek,rtl8231.yaml | 199 ++++++++++++++++++ 1 file changed, 199 insertions(+) create mode 100644 Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml
Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml new file +199 -0
@@ -0,0 +1,199 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/realtek,rtl8231.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Realtek RTL8231 GPIO and LED expander. + +maintainers: + - Sander Vanheule <[email protected]> + +description: | + The RTL8231 is a GPIO and LED expander chip, providing up to 37 GPIOs, up to + 88 LEDs, and up to one PWM output. This device is frequently used alongside + Realtek switch SoCs, to provide additional I/O capabilities. + + To manage the RTL8231's features, its strapping pins can be used to configure + it in one of three modes: shift register, MDIO device, or SMI device. The + shift register mode does not need special support. In MDIO or SMI mode, most + pins can be configured as a GPIO output or LED matrix scan line/column. One + pin can be used as PWM output. + + The GPIO, PWM, and pin control are part of the main node. LED support is + configured as a sub-node. + +properties: + compatible: + const: realtek,rtl8231 + + reg: + description: MDIO or SMI device address. + maxItems: 1 + + # GPIO support + gpio-controller: true + + "#gpio-cells": + const: 2 + description: + The first cell is the pin number and the second cell is used to specify + the GPIO active state. + + gpio-ranges: + description: + Must reference itself, and provide a zero-based mapping for 37 pins. + maxItems: 1 + + # Pin muxing and configuration + drive-strength: + description: + Common drive strength used for all GPIO output pins, must be 4mA or 8mA. + On reset, this value will default to 8mA. + enum: [4, 8] + + # LED scanning matrix + led-controller: + $ref: /schemas/leds/realtek,rtl8231-leds.yaml# + + # PWM output + "#pwm-cells": + description: + Twos cells with PWM index (must be 0) and PWM frequency in Hz. To use + the PWM output, gpio35 must be muxed to its "pwm" function. Valid + frequency values for consumers are 1200, 1600, 2000, 2400, 2800, 3200, + 4000, and 4800. + const: 2 + +patternProperties: + "-pins$": + type: object + + allOf: + - $ref: /schemas/pinctrl/pincfg-node.yaml# + - $ref: /schemas/pinctrl/pinmux-node.yaml# + + additionalProperties: false + + properties: + pins: + items: + enum: [gpio0, gpio1, gpio2, gpio3, gpio4, gpio5, gpio6, gpio7, + gpio8, gpio9, gpio10, gpio11, gpio12, gpio13, gpio14, gpio15, + gpio16, gpio17, gpio18, gpio19, gpio20, gpio21, gpio22, gpio23, + gpio24, gpio25, gpio26, gpio27, gpio28, gpio29, gpio30, gpio31, + gpio32, gpio33, gpio34, gpio35, gpio36] + minItems: 1 + maxItems: 37 + input-debounce: true + + function: + description: + Select which function to use. "gpio" is supported for all pins, "led" is supported + for pins 0-34, "pwm" is supported for pin 35. + enum: [gpio, led, pwm] + + required: + - pins + - function + +required: + - compatible + - reg + - gpio-controller + - "#gpio-cells" + - gpio-ranges + +additionalProperties: false + +examples: + - | + // Minimal example + mdio { + #address-cells = <1>; + #size-cells = <0>; + + expander0: expander@0 { + compatible = "realtek,rtl8231"; + reg = <0>; + + gpio-controller; + #gpio-cells = <2>; + gpio-ranges = <&expander0 0 0 37>; + }; + }; + - | + // All bells and whistles included + #include <dt-bindings/leds/common.h> + mdio { + #address-cells = <1>; + #size-cells = <0>; + + expander1: expander@1 { + compatible = "realtek,rtl8231"; + reg = <1>; + + gpio-controller; + #gpio-cells = <2>; + gpio-ranges = <&expander1 0 0 37>; + + #pwm-cells = <2>; + + drive-strength = <4>; + + button-pins { + pins = "gpio36"; + function = "gpio"; + input-debounce = <100000>; + }; + + pwm-pins { + pins = "gpio35"; + function = "pwm"; + }; + + led_matrix: led-pins { + pins = "gpio0", "gpio1", "gpio3", "gpio4"; + function = "led"; + }; + + led-controller { + compatible = "realtek,rtl8231-leds"; + #address-cells = <2>; + #size-cells = <0>; + + pinctrl-names = "default"; + pinctrl-0 = <&led_matrix>; + + realtek,led-scan-mode = "single-color"; + + led@0,0 { + reg = <0 0>; + color = <LED_COLOR_ID_GREEN>; + function = LED_FUNCTION_LAN; + function-enumerator = <0>; + }; + + led@0,1 { + reg = <0 1>; + color = <LED_COLOR_ID_AMBER>; + function = LED_FUNCTION_LAN; + function-enumerator = <0>; + }; + + led@1,0 { + reg = <1 0>; + color = <LED_COLOR_ID_GREEN>; + function = LED_FUNCTION_LAN; + function-enumerator = <1>; + }; + + led@1,1 { + reg = <1 1>; + color = <LED_COLOR_ID_AMBER>; + function = LED_FUNCTION_LAN; + function-enumerator = <1>; + }; + }; + }; + };
Signature · 1 line
2.52.0
PATCH v9 3/6 mfd: Add RTL8231 core device
In reply to Sander VanheuleThe RTL8231 is implemented as an MDIO device, and provides a regmap interface for register access by the core and child devices.
The chip can also be a device on an SMI bus, an I2C-like bus by Realtek. Since kernel support for SMI is limited, and no real-world SMI implementations have been encountered for this device, this is currently unimplemented. The use of the regmap interface should make any future support relatively straightforward.
After a soft reset, all pins are muxed to GPIO inputs before the pin drivers are enabled. This is done to prevent accidental system resets, when a pin is connected to the main SoC's reset line.
---
Changes since v8:
- Drop no longer needed __maybe_unused for PM functions
- No abbreviations in user messages
- Replace {0,RTL8231_REG_COUNT-1} with RTL8231_REG_{START,END}
- Replace led_start regmap_field with direct regmap operations
- Replace SIMPLE_DEV_PM_OPS with DEFINE_SIMPLE_DEV_PM_OPS
- Switch from REGCACHE_MAPLE to REGCACHE_FLAT_S
Changes since v6:
- Sort header includes
- Drop comment on cache type (6.19 will support REGCACHE_FLAT_S)
- Limit scope of LED_START field definition to init
- Variable renames:
- map -> regmap
- val -> status (register value) and ready_code (field value)
- val -> cfg
- Invert logic for !started, reducing code indentation
- Place __maybe_unused after function return type
- Use regmap_field_write() for LED_START field (volatile register)
- Use regcache_drop_region() to invalidate cache, replacing regcache_mark_dirty() which invalidates the device state
--- drivers/mfd/Kconfig | 9 ++ drivers/mfd/Makefile | 1 + drivers/mfd/rtl8231.c | 188 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/rtl8231.h | 73 ++++++++++++++ 4 files changed, 271 insertions(+) create mode 100644 drivers/mfd/rtl8231.c create mode 100644 include/linux/mfd/rtl8231.h
drivers/mfd/Kconfig +9 -0
@@ -1317,6 +1317,15 @@ config MFD_RDC321X southbridge which provides access to GPIOs and Watchdog using the southbridge PCI device configuration space. +config MFD_RTL8231 + tristate "Realtek RTL8231 GPIO and LED expander" + select MFD_CORE + select REGMAP_MDIO + help + Support for the Realtek RTL8231 GPIO and LED expander. + Provides up to 37 GPIOs, 88 LEDs, and one PWM output. + When built as a module, this module will be named rtl8231. + config MFD_RT4831 tristate "Richtek RT4831 four channel WLED and Display Bias Voltage" depends on I2C
drivers/mfd/Makefile +1 -0
@@ -253,6 +253,7 @@ obj-$(CONFIG_MFD_HI6421_PMIC) += hi6421-pmic-core.o obj-$(CONFIG_MFD_HI6421_SPMI) += hi6421-spmi-pmic.o obj-$(CONFIG_MFD_HI655X_PMIC) += hi655x-pmic.o obj-$(CONFIG_MFD_DLN2) += dln2.o +obj-$(CONFIG_MFD_RTL8231) += rtl8231.o obj-$(CONFIG_MFD_RT4831) += rt4831.o obj-$(CONFIG_MFD_RT5033) += rt5033.o obj-$(CONFIG_MFD_RT5120) += rt5120.o
drivers/mfd/rtl8231.c new file +188 -0
188 lines not on this page · raw message
include/linux/mfd/rtl8231.h new file +73 -0
73 lines not on this page · raw message
Signature · 1 line
2.52.0
kernel test robot
build botRe: [PATCH v9 3/6] mfd: Add RTL8231 core device
kernel test robot noticed the following build warnings:
Hi Sander,
kernel test robot noticed the following build warnings:
[auto build test WARNING on lee-mfd/for-mfd-fixes]
[also build test WARNING on lee-leds/for-leds-next linusw-pinctrl/devel linusw-pinctrl/for-next linus/master v6.19-rc2 next-20251219] [cannot apply to lee-mfd/for-mfd-next]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Sander-Vanheule/dt-bindings-leds-Binding-for-RTL8231-scan-matrix/20251216-015552 base: https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-fixes patch link: https://lore.kernel.org/r/20251215175115.135294-4-sander%40svanheule.net patch subject: [PATCH v9 3/6] mfd: Add RTL8231 core device config: alpha-kismet-CONFIG_MDIO_BUS-CONFIG_REGMAP_MDIO-0-0 (https://download.01.org/0day-ci/archive/20251222/[email protected]/config) reproduce: (https://download.01.org/0day-ci/archive/20251222/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
kismet warnings: (new ones prefixed by >>)
>> kismet: WARNING: unmet direct dependencies detected for MDIO_BUS when selected by REGMAP_MDIO
WARNING: unmet direct dependencies detected for MDIO_BUS
Depends on [n]: NETDEVICES [=n]
Selected by [y]:
- REGMAP_MDIO [=y]
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
Re: [PATCH v9 3/6] mfd: Add RTL8231 core device
Adding the netdev and regmap maintainers for extra input.
Quoted 7 lines · kernel test robot
url: https://github.com/intel-lab-lkp/linux/commits/Sander-Vanheule/dt-bindings-leds-Binding-for-RTL8231-scan-matrix/20251216-015552
base: https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-fixes
patch link: https://lore.kernel.org/r/20251215175115.135294-4-sander%40svanheule.net
patch subject: [PATCH v9 3/6] mfd: Add RTL8231 core device
config: alpha-kismet-CONFIG_MDIO_BUS-CONFIG_REGMAP_MDIO-0-0 (https://download.01.org/0day-ci/archive/20251222/[email protected]/config)
reproduce: (https://download.01.org/0day-ci/archive/20251222/[email protected]/reproduce)
For context: these patches introduce a new MFD with pinctrl and led subdevices. The RTL8231 MFD is attached to an MDIO bus, but it can also be attached to an I2C bus (not currently supported). The drivers use regmap to provide a bus abstraction.
Quoted 7 lines
kismet warnings: (new ones prefixed by >>)
Quoted 2 lines
Quoted 2 lines
kismet: WARNING: unmet direct dependencies detected for
MDIO_BUSwhen selected byREGMAP_MDIOWARNING: unmet direct dependencies detected for
MDIO_BUSDepends on [n]: NETDEVICES [=n]
Selected by [y]:
-REGMAP_MDIO[=y]
I'm a bit puzzled on how to solve this one. The issue detected here is that my driver (MFD_RTL8231) selects REGMAP_MDIO, which in turn selects MDIO_BUS. The latter is dependent on NETDEVICES, which is not selected in this test. The kernel does not yet have any other consumers of REGMAP_MDIO, which is probably the reason the dependency issue has gone undetected until now.
REGMAP_MDIO is not a visible symbol, so it must be selected by drivers.
Other REGMAP_XYZ symbols (almost) exclusively use "depends on XYZ", but if I change REGMAP_MDIO to "depends on", the warning just changes to:
WARNING: unmet direct dependencies detected for REGMAP_MDIO
Depends on [n]: MDIO_BUS [=n]
Selected by [y]:
- MFD_RTL8231 [=y] && HAS_IOMEM [=y]
Trying to make MFD_RTL8231 also depend on MDIO_BUS, like .e.g I2C dependent devices do, results in a recursive dependency:
error: recursive dependency detected!
symbol GPIOLIB is selected by PINCTRL_RTL8231 symbol PINCTRL_RTL8231 depends on MFD_RTL8231 symbol MFD_RTL8231 depends on MDIO_BUS symbol MDIO_BUS is selected by PHYLIB symbol PHYLIB is selected by ARC_EMAC_CORE symbol ARC_EMAC_CORE is selected by EMAC_ROCKCHIP symbol EMAC_ROCKCHIP depends on OF_IRQ symbol OF_IRQ depends on IRQ_DOMAIN symbol IRQ_DOMAIN is selected by GENERIC_IRQ_CHIP symbol GENERIC_IRQ_CHIP is selected by GPIO_MVEBU symbol GPIO_MVEBU depends on GPIOLIB
The 'quick fix' appears to be to add "select NETDEVICES" to REGMAP_MDIO. The platforms that use the RTL8231 MFD are typically ethernet switches, so they would have NETDEVICES enabled anway, but that feels very heavy handed and automatically pulls in a lot of extra stuff. Would this be acceptable or is there a more desirable approach I'm not seeing here?
Best,
Sander
Re: [PATCH v9 3/6] mfd: Add RTL8231 core device
Quoted 24 lines · Sander Vanheule
Adding the netdev and regmap maintainers for extra input.
Quoted 7 lines · kernel test robot
url: https://github.com/intel-lab-lkp/linux/commits/Sander-Vanheule/dt-bindings-leds-Binding-for-RTL8231-scan-matrix/20251216-015552
base: https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-fixes
patch link: https://lore.kernel.org/r/20251215175115.135294-4-sander%40svanheule.net
patch subject: [PATCH v9 3/6] mfd: Add RTL8231 core device
config: alpha-kismet-CONFIG_MDIO_BUS-CONFIG_REGMAP_MDIO-0-0 (https://download.01.org/0day-ci/archive/20251222/[email protected]/config)
reproduce: (https://download.01.org/0day-ci/archive/20251222/[email protected]/reproduce)For context: these patches introduce a new MFD with pinctrl and led subdevices. The RTL8231 MFD is attached to an MDIO bus, but it can also be attached to an I2C bus (not currently supported). The drivers use regmap to provide a bus abstraction.
Quoted 7 lines
kismet warnings: (new ones prefixed by >>)
Quoted 2 lines
Quoted 2 lines
kismet: WARNING: unmet direct dependencies detected for
MDIO_BUSwhen selected byREGMAP_MDIOWARNING: unmet direct dependencies detected for
MDIO_BUSDepends on [n]: NETDEVICES [=n]
Selected by [y]:
-REGMAP_MDIO[=y]
Quoted 7 lines
I'm a bit puzzled on how to solve this one. The issue detected here is that my driver (
MFD_RTL8231) selectsREGMAP_MDIO, which in turn selectsMDIO_BUS. The latter is dependent on NETDEVICES, which is not selected in this test. The kernel does not yet have any other consumers ofREGMAP_MDIO, which is probably the reason the dependency issue has gone undetected until now.
REGMAP_MDIOis not a visible symbol, so it must be selected by drivers.
Reminds me old problem, probably the same:
https://lore.kernel.org/all/[email protected]/
https://lore.kernel.org/all/[email protected]/
Exactly the same MDIO here and there.
Quoted 26 lines
Other
REGMAP_XYZsymbols (almost) exclusively use "depends on XYZ", but if I changeREGMAP_MDIOto "depends on", the warning just changes to:WARNING: unmet direct dependencies detected for
REGMAP_MDIO
Depends on [n]:MDIO_BUS[=n]
Selected by [y]:
-MFD_RTL8231[=y] &&HAS_IOMEM[=y]Trying to make
MFD_RTL8231also depend onMDIO_BUS, like .e.g I2C dependent devices do, results in a recursive dependency:error: recursive dependency detected!
symbol GPIOLIB is selected byPINCTRL_RTL8231symbolPINCTRL_RTL8231depends onMFD_RTL8231symbolMFD_RTL8231depends onMDIO_BUSsymbolMDIO_BUSis selected by PHYLIB symbol PHYLIB is selected byARC_EMAC_COREsymbolARC_EMAC_COREis selected byEMAC_ROCKCHIPsymbolEMAC_ROCKCHIPdepends onOF_IRQsymbolOF_IRQdepends onIRQ_DOMAINsymbolIRQ_DOMAINis selected byGENERIC_IRQ_CHIPsymbolGENERIC_IRQ_CHIPis selected byGPIO_MVEBUsymbolGPIO_MVEBUdepends on GPIOLIB
Quoted 5 lines
The 'quick fix' appears to be to add "select NETDEVICES" to
REGMAP_MDIO. The platforms that use the RTL8231 MFD are typically ethernet switches, so they would have NETDEVICES enabled anway, but that feels very heavy handed and automatically pulls in a lot of extra stuff. Would this be acceptable or is there a more desirable approach I'm not seeing here?
Rather fix the same way Andrew did it. Or maybe his patch was not merged?
Best regards,
Krzysztof
Re: [PATCH v9 3/6] mfd: Add RTL8231 core device
Hi Krzysztof,
Quoted 21 lines · Krzysztof Kozlowski
Quoted 16 lines · Sander Vanheule
Quoted 7 lines
kismet warnings: (new ones prefixed by >>)
Quoted 2 lines
Quoted 2 lines
kismet: WARNING: unmet direct dependencies detected for
MDIO_BUSwhen selected byREGMAP_MDIOWARNING: unmet direct dependencies detected for
MDIO_BUSDepends on [n]: NETDEVICES [=n]
Selected by [y]:
-REGMAP_MDIO[=y]I'm a bit puzzled on how to solve this one. The issue detected here is that my
driver (MFD_RTL8231) selectsREGMAP_MDIO, which in turn selectsMDIO_BUS. The
latter is dependent on NETDEVICES, which is not selected in this test. The kernel does not yet have any other consumers ofREGMAP_MDIO, which is probably the reason the dependency issue has gone undetected until now.Quoted 1 line
REGMAP_MDIOis not a visible symbol, so it must be selected by drivers.Reminds me old problem, probably the same:
Quoted 7 lines
https://lore.kernel.org/all/[email protected]/
https://lore.kernel.org/all/[email protected]/
Exactly the same MDIO here and there.
Quoted 1 line
[...]
Rather fix the same way Andrew did it. Or maybe his patch was not merged?
Andrew's patch was merged, that's the code I'm seeing now. I think by placing the dependency under REGMAP_MDIO (or REGMAP_IRQ) instead of REGMAP, it just made the circular dependency less visible.
Making PINCTRL_RTL8231 "depends on GPIOLIB", like the GPIO drivers, only shortens the circular dependency loop:
error: recursive dependency detected!
symbol IRQ_DOMAIN is selected by MFD_CORE symbol MFD_CORE is selected by MFD_RTL8231 symbol MFD_RTL8231 depends on MDIO_BUS symbol MDIO_BUS is selected by PHYLIB symbol PHYLIB is selected by ARC_EMAC_CORE symbol ARC_EMAC_CORE is selected by EMAC_ROCKCHIP symbol EMAC_ROCKCHIP depends on OF_IRQ symbol OF_IRQ depends on IRQ_DOMAIN
Of these symbols, IRQ_DOMAIN and OF_IRQ are hidden symbols, so they must be selected by another symbol to be used. As shown above, OF_IRQ *depends* on IRQ_DOMAIN, which means some other symbol *must* select it for the dependency to be satisfied, as IRQ_DOMAIN also cannot be selected directly by the user. OF_IRQ also appears to be the only symbol in the kernel to depend on, rather than select, IRQ_DOMAIN.
Turning the dependency of OF_IRQ on IRQ_DOMAIN around resolves the dependency loop here, and ensures the hidden IRQ_DOMAIN symbol is selected whenever any other symbol selects OF_IRQ.
The same reasoning was actually used in 2023 to suggest this change as well:
https://lore.kernel.org/lkml/[email protected]/
I found some follow-up, but it didn't look like it actually got wrapped up:
https://lore.kernel.org/lkml/[email protected]/
Randy, do you happen to recall if/why this stalled? Should we just try to invert the dependency again if there is no pressing need for the "proper" clean-up?
Best,
Sander
PATCH v9 4/6 pinctrl: Add RTL8231 pin control and GPIO support
In reply to Sander VanheuleThis driver implements the GPIO and pin muxing features provided by the RTL8231. The device should be instantiated as an MFD child, where the parent device has already configured the regmap used for register access.
Debouncing is only available for the six highest GPIOs, and must be emulated when other pins are used for (button) inputs. Although described in the bindings, drive strength selection is currently not implemented.
---
Changes since v7:
- Second attempt at fixing storage size of pinfunction flags
- Add OF dependency for pinconf_generic_dt_node_to_map symbol
- Allow building with COMPILE_TEST
Changes since v6:
- Use uintptr_t storage for enum rtl8231_pin_function
- Simplify safe direction configuration
- Add GPIOLIB dependency
- Add Linus's review tag
--- drivers/pinctrl/Kconfig | 12 + drivers/pinctrl/Makefile | 1 + drivers/pinctrl/pinctrl-rtl8231.c | 533 ++++++++++++++++++++++++++++++ 3 files changed, 546 insertions(+) create mode 100644 drivers/pinctrl/pinctrl-rtl8231.c
drivers/pinctrl/Kconfig +12 -0
@@ -538,6 +538,18 @@ config PINCTRL_ROCKCHIP help This support pinctrl and GPIO driver for Rockchip SoCs. +config PINCTRL_RTL8231 + tristate "Realtek RTL8231 GPIO expander's pin controller" + depends on OF && (MFD_RTL8231 || COMPILE_TEST) + default MFD_RTL8231 + select GENERIC_PINCONF + select GENERIC_PINMUX_FUNCTIONS + select GPIOLIB + select GPIO_REGMAP + help + Support for RTL8231 expander's GPIOs and pin controller. + When built as a module, the module will be called pinctrl-rtl8231. + config PINCTRL_SCMI tristate "Pinctrl driver using SCMI protocol interface" depends on ARM_SCMI_PROTOCOL || COMPILE_TEST
drivers/pinctrl/Makefile +1 -0
@@ -54,6 +54,7 @@ obj-$(CONFIG_PINCTRL_POLARFIRE_SOC) += pinctrl-mpfs-iomux0.o obj-$(CONFIG_PINCTRL_RK805) += pinctrl-rk805.o obj-$(CONFIG_PINCTRL_ROCKCHIP) += pinctrl-rockchip.o obj-$(CONFIG_PINCTRL_RP1) += pinctrl-rp1.o +obj-$(CONFIG_PINCTRL_RTL8231) += pinctrl-rtl8231.o obj-$(CONFIG_PINCTRL_SCMI) += pinctrl-scmi.o obj-$(CONFIG_PINCTRL_SINGLE) += pinctrl-single.o obj-$(CONFIG_PINCTRL_ST) += pinctrl-st.o
drivers/pinctrl/pinctrl-rtl8231.c new file +533 -0
533 lines not on this page · raw message
Signature · 1 line
2.52.0
Bartosz Golaszewski
maintainerRe: [PATCH v9 4/6] pinctrl: Add RTL8231 pin control and GPIO support
Quoted 13 lines · Sander Vanheule
This driver implements the GPIO and pin muxing features provided by the RTL8231. The device should be instantiated as an MFD child, where the parent device has already configured the regmap used for register access.
Debouncing is only available for the six highest GPIOs, and must be emulated when other pins are used for (button) inputs. Although described in the bindings, drive strength selection is currently not implemented.
Signed-off-by Sander Vanheule <[email protected]>Reviewed-by Linus Walleij <[email protected]>---
[snip]
drivers/pinctrl/pinctrl-rtl8231.c line 15
Quoted 13 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +13
-0+#include <linux/bitfield.h> +#include <linux/gpio/driver.h> +#include <linux/gpio/regmap.h> +#include <linux/module.h> +#include <linux/pinctrl/pinconf.h> +#include <linux/pinctrl/pinctrl.h> +#include <linux/pinctrl/pinmux.h> +#include <linux/platform_device.h> +#include <linux/regmap.h> + +#include "core.h" +#include "pinmux.h" +#include <linux/mfd/rtl8231.h>
Please put this together with other global headers.
drivers/pinctrl/pinctrl-rtl8231.c line 114
Quoted 5 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +5
-0+RTL8231_LED_PIN_DESC (33 ,RTL8231_REG_PIN_HI_CFG ,1 ), +RTL8231_LED_PIN_DESC (34 ,RTL8231_REG_PIN_HI_CFG ,2 ), +RTL8231_PWM_PIN_DESC (35 ,RTL8231_REG_FUNC1 ,3 ), + RTL8231_GPIO_PIN_DESC(36, RTL8231_REG_PIN_HI_CFG, 4), +};
Newline?
Quoted 1 line
+static const unsigned int
PWM_PIN= 35;
Please use the RTL8231 prefix for all symbols.
drivers/pinctrl/pinctrl-rtl8231.c line 202
Quoted 9 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +9
-0+static int rtl8231_set_mux (struct pinctrl_dev *pctldev,unsigned int func_selector, +unsigned int group_selector) +{ +const struct function_desc *func =pinmux_generic_get_function (pctldev, func_selector); +const struct rtl8231_pin_desc *desc = rtl8231_pins[group_selector].drv_data; +const struct rtl8231_pin_ctrl *ctrl =pinctrl_dev_get_drvdata (pctldev); +enum rtl8231_pin_function func_flag = (uintptr_t ) func->data; +unsigned int function_mask; +unsigned int gpio_function;
Can you put these on the same line here and elsewhere?
drivers/pinctrl/pinctrl-rtl8231.c line 213
Quoted 11 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +11
-0+ +if (!(desc->functions & func_flag)) +return -EINVAL ; + + function_mask =BIT (desc->offset); + gpio_function = desc->gpio_function_value << desc->offset; + +if (func_flag ==RTL8231_PIN_FUNCTION_GPIO ) +return regmap_update_bits (ctrl->map, desc->reg, function_mask, gpio_function); +else +return regmap_update_bits (ctrl->map, desc->reg, function_mask, ~gpio_function);
Just drop the else.
drivers/pinctrl/pinctrl-rtl8231.c line 424
Quoted 7 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +7
-0+/* +* Set every pin that is not muxed as a GPIO to gpio-in. That +* way the pin will be high impedance when it is muxed to GPIO, +* preventing unwanted glitches. +* The pin muxes are left as-is, so there are no signal changes. +*/ +regmap_field_write (field_dir, is_input | ~is_gpio);
This is an MDIO regmap. The operations may fail. Don't you want to check the return values of regmap routines?
drivers/pinctrl/pinctrl-rtl8231.c line 451
Quoted 10 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +10
-0+ +static int rtl8231_pinctrl_init (struct device *dev,struct rtl8231_pin_ctrl *ctrl) +{ +struct pinctrl_dev *pctldev; +int err; + + err =devm_pinctrl_register_and_init (dev->parent, &rtl8231_pctl_desc, ctrl, &pctldev); +if (err) { +dev_err (dev,"failed to register pin controller\n" ); +return err;
Please use dev_err_probe() here an elsewhere.
Quoted 8 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +8
-0+ } + + err =rtl8231_pinctrl_init_functions (pctldev, &rtl8231_pctl_desc); +if (err) +return err; + + err =pinctrl_enable (pctldev); +if (err)
drivers/pinctrl/pinctrl-rtl8231.c line 469
Quoted 10 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +10
-0+dev_err (dev,"failed to enable pin controller\n" ); + +return err; +} + +/* +* GPIO controller functionality +*/ +static int rtl8231_gpio_reg_mask_xlate (struct gpio_regmap *gpio,unsigned int base, +unsigned int offset,unsigned int *reg,unsigned int *mask)
Can you align the start of the line with the opening bracket?
Bart
Re: [PATCH v9 4/6] pinctrl: Add RTL8231 pin control and GPIO support
Hi Bartosz,
Quoted 18 lines · Bartosz Golaszewski
Quoted 13 lines · Sander Vanheule
This driver implements the GPIO and pin muxing features provided by the RTL8231. The device should be instantiated as an MFD child, where the parent device has already configured the regmap used for register access.
Debouncing is only available for the six highest GPIOs, and must be emulated when other pins are used for (button) inputs. Although described in the bindings, drive strength selection is currently not implemented.
Signed-off-by Sander Vanheule <[email protected]>Reviewed-by Linus Walleij <[email protected]>---
[snip]
Quoted 15 lines
drivers/pinctrl/pinctrl-rtl8231.c line 15
Quoted 13 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +13
-0+#include <linux/bitfield.h> +#include <linux/gpio/driver.h> +#include <linux/gpio/regmap.h> +#include <linux/module.h> +#include <linux/pinctrl/pinconf.h> +#include <linux/pinctrl/pinctrl.h> +#include <linux/pinctrl/pinmux.h> +#include <linux/platform_device.h> +#include <linux/regmap.h> + +#include "core.h" +#include "pinmux.h" +#include <linux/mfd/rtl8231.h> Please put this together with other global headers.
Updated here and in the other driver files.
Quoted 3 lines
Quoted 1 line
+static const unsigned int
PWM_PIN= 35;Please use the RTL8231 prefix for all symbols.
Added the prefix here and also for a struct defined in this file (rtl8231_...).
Quoted 6 lines
Quoted 6 lines
+static int rtl8231_set_mux(struct
pinctrl_dev*pctldev, unsigned intfunc_selector,
+ unsigned intgroup_selector)
+{
+ const structfunction_desc*func =pinmux_generic_get_function(pctldev, func_selector);
Quoted 8 lines
Quoted 6 lines
+ const struct
rtl8231_pin_desc*desc = rtl8231_pins[group_selector].drv_data;
+ const structrtl8231_pin_ctrl*ctrl =pinctrl_dev_get_drvdata(pctldev);
+ enumrtl8231_pin_functionfunc_flag= (uintptr_t)func->data;
+ unsigned intfunction_mask;
+ unsigned intgpio_function;Can you put these on the same line here and elsewhere?
I am aware this is often done, and also mentioned in the kernel docs [1], but I actually prefer this style and have always used it in my kernel patches. IMHO placing these on separate lines helps with:
* readability: every line is either [type] [name] or [type] [name] = [value]
* reducing churn: changing the type of one variable doesn't impact other lines
* quickly assessing code complexity: number of local variables is simply the number of lines
Editors aren't typically 80x24 anymore. The maximum line length has been relaxed to 100 characters, so I feel like a developer can also be expected to have more lines available on their display nowadays.
[1]
https://docs.kernel.org/6.18/process/maintainer-tip.html#variable-declarations
Quoted 10 lines
Quoted 7 lines
+ /*
+ * Set every pin that is not muxed as a GPIO to gpio-in. That
+ * way the pin will be high impedance when it is muxed to GPIO,
+ * preventing unwanted glitches.
+ * The pin muxes are left as-is, so there are no signal changes.
+ */
+regmap_field_write(field_dir, is_input | ~is_gpio);This is an MDIO regmap. The operations may fail. Don't you want to check the return values of regmap routines?
Error checking was indeed not done consistently, so I've now added checks to all regmap_*() calls that return an error code. Also updated in the other drivers.
Quoted 6 lines
Quoted 6 lines
(quoted diff) +2
-0+ +static int rtl8231_pinctrl_init(struct device *dev, struct rtl8231_pin_ctrl*ctrl)
+{
+ structpinctrl_dev*pctldev;
+ int err;
Quoted 8 lines
Quoted 6 lines
+
+ err =devm_pinctrl_register_and_init(dev->parent, &rtl8231_pctl_desc, ctrl, &pctldev);
+ if (err) {
+dev_err(dev, "failed to register pin controller\n");
+ return err;Please use
dev_err_probe()here an elsewhere.
Updated here and in the other drivers.
Quoted 13 lines
Quoted 13 lines
+ }
drivers/pinctrl/pinctrl-rtl8231.c new file +12
-0+ + err =rtl8231_pinctrl_init_functions (pctldev, &rtl8231_pctl_desc); +if (err) +return err; + + err =pinctrl_enable (pctldev); +if (err) +dev_err (dev,"failed to enable pin controller\n" ); + +return err; +} +
Quoted 8 lines
Quoted 6 lines
drivers/pinctrl/pinctrl-rtl8231.c new file +4
-0+/* +* GPIO controller functionality +*/ +static int rtl8231_gpio_reg_mask_xlate(struct gpio_regmap *gpio, unsignedint base,
+ unsigned int offset, unsigned int *reg, unsigned int *mask)Can you align the start of the line with the opening bracket?
Will do.
Best,
Sander
PATCH v9 5/6 leds: Add support for RTL8231 LED scan matrix
In reply to Sander VanheuleBoth single and bi-color scanning modes are supported. The driver will verify that the addresses are valid for the current mode, before registering the LEDs. LEDs can be turned on, off, or toggled at one of six predefined rates from 40ms to 1280ms.
Implements a platform device for use as a child device with RTL8231 MFD, and uses the parent regmap to access the required registers.
---
Changes since v7:
- Allow building with COMPILE_TEST
--- drivers/leds/Kconfig | 10 ++ drivers/leds/Makefile | 1 + drivers/leds/leds-rtl8231.c | 285 ++++++++++++++++++++++++++++++++++++ 3 files changed, 296 insertions(+) create mode 100644 drivers/leds/leds-rtl8231.c
drivers/leds/Kconfig +10 -0
@@ -662,6 +662,16 @@ config LEDS_REGULATOR help This option enables support for regulator driven LEDs. +config LEDS_RTL8231 + tristate "RTL8231 LED matrix support" + depends on LEDS_CLASS + depends on MFD_RTL8231 || COMPILE_TEST + default MFD_RTL8231 + help + This option enables support for using the LED scanning matrix output + of the RTL8231 GPIO and LED expander chip. + When built as a module, this module will be named leds-rtl8231. + config LEDS_BD2606MVV tristate "LED driver for BD2606MVV" depends on LEDS_CLASS
drivers/leds/Makefile +1 -0
@@ -84,6 +84,7 @@ obj-$(CONFIG_LEDS_POWERNV) += leds-powernv.o obj-$(CONFIG_LEDS_PWM) += leds-pwm.o obj-$(CONFIG_LEDS_QNAP_MCU) += leds-qnap-mcu.o obj-$(CONFIG_LEDS_REGULATOR) += leds-regulator.o +obj-$(CONFIG_LEDS_RTL8231) += leds-rtl8231.o obj-$(CONFIG_LEDS_SC27XX_BLTC) += leds-sc27xx-bltc.o obj-$(CONFIG_LEDS_ST1202) += leds-st1202.o obj-$(CONFIG_LEDS_SUN50I_A100) += leds-sun50i-a100.o
drivers/leds/leds-rtl8231.c new file +285 -0
285 lines not on this page · raw message
Signature · 1 line
2.52.0
PATCH v9 6/6 MAINTAINERS: Add RTL8231 MFD driver
In reply to Sander VanheuleAdd the files associated with the RTL8231 support, and list Sander Vanheule (myself) as maintainer.
--- MAINTAINERS | 10 ++++++++++ 1 file changed, 10 insertions(+)
MAINTAINERS +10 -0
@@ -21962,6 +21962,16 @@ S: Maintained F: Documentation/devicetree/bindings/watchdog/realtek,otto-wdt.yaml F: drivers/watchdog/realtek_otto_wdt.c +REALTEK RTL8231 MFD DRIVER +M: Sander Vanheule <[email protected]> +S: Maintained +F: Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml +F: Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml +F: drivers/leds/leds-rtl8231.c +F: drivers/mfd/rtl8231.c +F: drivers/pinctrl/pinctrl-rtl8231.c +F: include/linux/mfd/rtl8231.h + REALTEK RTL83xx SMI DSA ROUTER CHIPS M: Linus Walleij <[email protected]> M: Alvin Šipraga <[email protected]>
Signature · 1 line
2.52.0