RTL8231 GPIO expander support
Subsystems (5)
v8 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 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 | 193 +++++++ drivers/pinctrl/Kconfig | 12 + drivers/pinctrl/Makefile | 1 + drivers/pinctrl/pinctrl-rtl8231.c | 533 ++++++++++++++++++ include/linux/mfd/rtl8231.h | 71 +++ 13 files changed, 1461 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.51.1
PATCH v8 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 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.51.1
Re: [PATCH v8 1/6] dt-bindings: leds: Binding for RTL8231 scan matrix
Quoted 9 lines · Sander Vanheule
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.
Signed-off-by Sander Vanheule <[email protected]>---
Changes since v7:
- Move $ref and add unevaluatedProperties for led nodes
- Drop example redundant with MFD binding
Quoted 9 lines
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
PATCH v8 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.51.1
PATCH v8 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 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 | 193 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/rtl8231.h | 71 +++++++++++++ 4 files changed, 274 insertions(+) create mode 100644 drivers/mfd/rtl8231.c create mode 100644 include/linux/mfd/rtl8231.h
drivers/mfd/Kconfig +9 -0
@@ -1301,6 +1301,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
@@ -252,6 +252,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 +193 -0
193 lines not on this page · raw message
include/linux/mfd/rtl8231.h new file +71 -0
71 lines not on this page · raw message
Signature · 1 line
2.51.1
Lee Jones
maintainerRe: [PATCH v8 3/6] mfd: Add RTL8231 core device
Quoted 75 lines · Sander Vanheule
The 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.
Signed-off-by Sander Vanheule <[email protected]>---
Changes since v6:
- Sort header includes
- Drop comment on cache type (6.19 will supportREGCACHE_FLAT_S)
- Limit scope ofLED_STARTfield definition to init
- Variable renames:
- map -> regmap
- val -> status (register value) andready_code(field value)
- val -> cfg
- Invert logic for !started, reducing code indentation
- Place__maybe_unusedafter function return type
- Useregmap_field_write()forLED_STARTfield (volatile register)
- Useregcache_drop_region()to invalidate cache, replacingregcache_mark_dirty()which invalidates the device state--- drivers/mfd/Kconfig | 9 ++ drivers/mfd/Makefile | 1 + drivers/mfd/rtl8231.c | 193 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/rtl8231.h | 71 +++++++++++++ 4 files changed, 274 insertions(+) create mode 100644 drivers/mfd/rtl8231.c create mode 100644 include/linux/mfd/rtl8231.hdrivers/mfd/Kconfig +9
-0@@ -1301,6 +1301,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 I2Cdrivers/mfd/Makefile +1
-0@@ -252,6 +252,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.odrivers/mfd/rtl8231.c new file +0
-0
drivers/mfd/rtl8231.c line 1
Quoted 1 line
drivers/mfd/rtl8231.c new file +1
-0@@ -0,0 +1,193 @@ +// SPDX-License-Identifier: GPL-2.0-only
No company copyright or author tags?
Quoted 47 lines
drivers/mfd/rtl8231.c new file +47
-0+#include <linux/bitfield.h> +#include <linux/bits.h> +#include <linux/delay.h> +#include <linux/gpio/consumer.h> +#include <linux/mdio.h> +#include <linux/mfd/core.h> +#include <linux/module.h> +#include <linux/platform_device.h> +#include <linux/property.h> +#include <linux/regmap.h> + +#include <linux/mfd/rtl8231.h> + +static bool rtl8231_volatile_reg (struct device *dev,unsigned int reg) +{ +switch (reg) { +/* +* Registers with self-clearing bits, strapping pin values. +* Don't mark the data registers as volatile, since we need +* caching for the output values. +*/ +case RTL8231_REG_FUNC0 : +case RTL8231_REG_FUNC1 : +case RTL8231_REG_PIN_HI_CFG : +case RTL8231_REG_LED_END : +return true; +default : +return false; + } +} + +static const struct mfd_cell rtl8231_cells[] = { + { + .name ="rtl8231-pinctrl" , + }, + { + .name ="rtl8231-leds" , + .of_compatible ="realtek,rtl8231-leds" , + }, +}; + +static int rtl8231_soft_reset (struct regmap *regmap) +{ +const unsigned int all_pins_mask =GENMASK (RTL8231_BITS_VAL -1 ,0 ); +unsigned int cfg; +int err; +
drivers/mfd/rtl8231.c line 59
Quoted 10 lines
drivers/mfd/rtl8231.c new file +10
-0+/* SOFT_RESET bit self-clears when done */ +regmap_write_bits (regmap,RTL8231_REG_PIN_HI_CFG , +RTL8231_PIN_HI_CFG_SOFT_RESET ,RTL8231_PIN_HI_CFG_SOFT_RESET ); + + err =regmap_read_poll_timeout (regmap,RTL8231_REG_PIN_HI_CFG , cfg, + !(cfg &RTL8231_PIN_HI_CFG_SOFT_RESET ),50 ,1000 ); +if (err) +return err; + +regcache_drop_region (regmap,0 ,RTL8231_REG_COUNT -1 );
Nit:
RTL8231_REG_FUNC0, RTL8231_REG_GPIO_DATA2
I'll also accept additional devices for each of these which would make things very clear.
RTL8231_REG_START 0RTL8231_REG_END RTL8231_REG_COUNT - 1
Or similar.
Quoted 40 lines
drivers/mfd/rtl8231.c new file +40
-0+ +/* +* Chip reset results in a pin configuration that is a mix of LED and GPIO outputs. +* Select GPI functionality for all pins before enabling pin outputs. +*/ +regmap_write (regmap,RTL8231_REG_PIN_MODE0 , all_pins_mask); +regmap_write (regmap,RTL8231_REG_GPIO_DIR0 , all_pins_mask); +regmap_write (regmap,RTL8231_REG_PIN_MODE1 , all_pins_mask); +regmap_write (regmap,RTL8231_REG_GPIO_DIR1 , all_pins_mask); +regmap_write (regmap,RTL8231_REG_PIN_HI_CFG , +RTL8231_PIN_HI_CFG_MODE_MASK |RTL8231_PIN_HI_CFG_DIR_MASK ); + +return 0 ; +} + +static int rtl8231_init (struct device *dev,struct regmap *regmap) +{ +struct regmap_field *led_start; +unsigned int ready_code; +unsigned int started; +unsigned int status; +int err; + + err =regmap_read (regmap,RTL8231_REG_FUNC1 , &status); +if (err) { +dev_err (dev,"failed to read READY_CODE\n" ); +return err; + } + + ready_code =FIELD_GET (RTL8231_FUNC1_READY_CODE_MASK , status); +if (ready_code !=RTL8231_FUNC1_READY_CODE_VALUE ) { +dev_err (dev,"RTL8231 not present or ready 0x%x != 0x%x\n" , + ready_code,RTL8231_FUNC1_READY_CODE_VALUE ); +return -ENODEV ; + } + + led_start =dev_get_drvdata (dev); + err =regmap_field_read (led_start, &started); +if (err) +return err;
drivers/mfd/rtl8231.c line 109
Quoted 10 lines
drivers/mfd/rtl8231.c new file +10
-0+ +if (started) +return 0 ; + + err =rtl8231_soft_reset (regmap); +if (err) +return err; + +/* LED_START enables power to output pins, and starts the LED engine */ +return regmap_field_write (led_start,1 );
Why can't the dedicated LED driver initialise itself?
Quoted 15 lines
drivers/mfd/rtl8231.c new file +15
-0+} + +static const struct regmap_config rtl8231_mdio_regmap_config = { + .val_bits =RTL8231_BITS_VAL , + .reg_bits =RTL8231_BITS_REG , + .volatile_reg = rtl8231_volatile_reg, + .max_register =RTL8231_REG_COUNT -1 , + .use_single_read = true, + .use_single_write = true, + .reg_format_endian =REGMAP_ENDIAN_BIG , + .val_format_endian =REGMAP_ENDIAN_BIG , + .cache_type =REGCACHE_MAPLE , +}; + +static int rtl8231_mdio_probe (struct mdio_device *mdiodev)
drivers/mfd/rtl8231.c line 134
Quoted 10 lines
drivers/mfd/rtl8231.c new file +10
-0+{ +const struct reg_field field_led_start =REG_FIELD (RTL8231_REG_FUNC0 ,1 ,1 ); +struct device *dev = &mdiodev->dev; +struct regmap_field *led_start; +struct regmap *regmap; +int err; + + regmap =devm_regmap_init_mdio (mdiodev, &rtl8231_mdio_regmap_config); +if (IS_ERR (regmap)) { +dev_err (dev,"failed to init regmap\n" );
Nit: Let's not shorten user messages - "initialise".
drivers/mfd/rtl8231.c line 142
Quoted 8 lines
drivers/mfd/rtl8231.c new file +8
-0+return PTR_ERR (regmap); + } + + led_start =devm_regmap_field_alloc (dev, regmap, field_led_start); +if (IS_ERR (led_start)) +return PTR_ERR (led_start); + +dev_set_drvdata (dev, led_start);
I'd pass the whole Regmap through and let the LED extract its own part.
drivers/mfd/rtl8231.c line 151
Quoted 8 lines
drivers/mfd/rtl8231.c new file +8
-0+ mdiodev->reset_gpio =devm_gpiod_get_optional (dev,"reset" ,GPIOD_OUT_LOW ); +if (IS_ERR (mdiodev->reset_gpio)) +return PTR_ERR (mdiodev->reset_gpio); + +device_property_read_u32 (dev,"reset-assert-delay" , &mdiodev->reset_assert_delay); +device_property_read_u32 (dev,"reset-deassert-delay" , &mdiodev->reset_deassert_delay); + + err =rtl8231_init (dev, regmap);
... then you can omit the 'regmap' argument.
drivers/mfd/rtl8231.c line 163
Quoted 12 lines
drivers/mfd/rtl8231.c new file +12
-0+if (err) +return err; + +return devm_mfd_add_devices (dev,PLATFORM_DEVID_AUTO , rtl8231_cells, +ARRAY_SIZE (rtl8231_cells),NULL ,0 ,NULL ); +} + +static int __maybe_unused rtl8231_suspend (struct device *dev) +{ +struct regmap_field *led_start =dev_get_drvdata (dev); + +return regmap_field_write (led_start,0 );
The LED driver doesn't have its own suspend support?
drivers/mfd/rtl8231.c line 172
Quoted 9 lines
drivers/mfd/rtl8231.c new file +9
-0+} + +static int __maybe_unused rtl8231_resume (struct device *dev) +{ +struct regmap_field *led_start =dev_get_drvdata (dev); + +return regmap_field_write (led_start,1 ); +} +
Nit: Remove this line.
Quoted 101 lines
drivers/mfd/rtl8231.c new file +21
-0+static SIMPLE_DEV_PM_OPS(rtl8231_pm_ops, rtl8231_suspend, rtl8231_resume); + +static const struct of_device_id rtl8231_of_match[] = { + { .compatible ="realtek,rtl8231" }, + {} +}; +MODULE_DEVICE_TABLE (of, rtl8231_of_match); + +static struct mdio_driver rtl8231_mdio_driver = { + .mdiodrv.driver = { + .name ="rtl8231-expander" , + .of_match_table = rtl8231_of_match, + .pm =pm_ptr (&rtl8231_pm_ops), + }, + .probe = rtl8231_mdio_probe, +}; +mdio_module_driver (rtl8231_mdio_driver); + +MODULE_AUTHOR ("Sander Vanheule <[email protected]>" ); +MODULE_DESCRIPTION ("Realtek RTL8231 GPIO and LED expander" ); +MODULE_LICENSE ("GPL" );include/linux/mfd/rtl8231.h new file +71
-0@@ -0,0 +1,71 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Register definitions the RTL8231 GPIO and LED expander chip +*/ + +#ifndef __LINUX_MFD_RTL8231_H +#define __LINUX_MFD_RTL8231_H + +#include <linux/bits.h> + +/* +* Registers addresses are 5 bit, values are 16 bit +* Also define a duplicated range of virtual addresses, to enable +* different read/write behaviour on the GPIO data registers +*/ +#define RTL8231_BITS_VAL 16 +#define RTL8231_BITS_REG 5 + +/* Chip control */ +#define RTL8231_REG_FUNC0 0x00 +#define RTL8231_FUNC0_SCAN_MODE BIT(0) +#define RTL8231_FUNC0_SCAN_SINGLE 0 +#define RTL8231_FUNC0_SCAN_BICOLOR BIT(0) + +#define RTL8231_REG_FUNC1 0x01 +#define RTL8231_FUNC1_READY_CODE_VALUE 0x37 +#define RTL8231_FUNC1_READY_CODE_MASK GENMASK(9, 4) +#define RTL8231_FUNC1_DEBOUNCE_MASK GENMASK(15, 10) + +/* Pin control */ +#define RTL8231_REG_PIN_MODE0 0x02 +#define RTL8231_REG_PIN_MODE1 0x03 + +#define RTL8231_PIN_MODE_LED 0 +#define RTL8231_PIN_MODE_GPIO 1 + +/* Pin high config: pin and GPIO control for pins 32-26 */ +#define RTL8231_REG_PIN_HI_CFG 0x04 +#define RTL8231_PIN_HI_CFG_MODE_MASK GENMASK(4, 0) +#define RTL8231_PIN_HI_CFG_DIR_MASK GENMASK(9, 5) +#define RTL8231_PIN_HI_CFG_INV_MASK GENMASK(14, 10) +#define RTL8231_PIN_HI_CFG_SOFT_RESET BIT(15) + +/* GPIO control registers */ +#define RTL8231_REG_GPIO_DIR0 0x05 +#define RTL8231_REG_GPIO_DIR1 0x06 +#define RTL8231_REG_GPIO_INVERT0 0x07 +#define RTL8231_REG_GPIO_INVERT1 0x08 + +#define RTL8231_GPIO_DIR_IN 1 +#define RTL8231_GPIO_DIR_OUT 0 + +/* +* GPIO data registers +* Only the output data can be written to these registers, and only the input +* data can be read. +*/ +#define RTL8231_REG_GPIO_DATA0 0x1c +#define RTL8231_REG_GPIO_DATA1 0x1d +#define RTL8231_REG_GPIO_DATA2 0x1e +#define RTL8231_PIN_HI_DATA_MASK GENMASK(4, 0) + +/* LED control base registers */ +#define RTL8231_REG_LED0_BASE 0x09 +#define RTL8231_REG_LED1_BASE 0x10 +#define RTL8231_REG_LED2_BASE 0x17 +#define RTL8231_REG_LED_END 0x1b + +#define RTL8231_REG_COUNT 0x1f + +#endif /* __LINUX_MFD_RTL8231_H */ Signature · 1 line
2.51.1
Signature · 1 line
Lee Jones [李琼斯]
Re: [PATCH v8 3/6] mfd: Add RTL8231 core device
Hi Lee,
Quoted 8 lines · Lee Jones
drivers/mfd/rtl8231.c line 1
Quoted 4 lines · Sander Vanheule
drivers/mfd/rtl8231.c new file +1
-0@@ -0,0 +1,193 @@ +// SPDX-License-Identifier: GPL-2.0-only No company copyright or author tags?
I'm writing this driver on my own time, so there's no company. My name is at the bottom of the driver, in the MODULE_AUTHOR() macro. That's enough for me.
Quoted 24 lines
Quoted 15 lines
drivers/mfd/rtl8231.c new file +3
-0+static int rtl8231_soft_reset (struct regmap *regmap) +{ + const unsigned int all_pins_mask = GENMASK(RTL8231_BITS_VAL - 1,0);
drivers/mfd/rtl8231.c new file +6
-0+unsigned int cfg; +int err; + +/* SOFT_RESET bit self-clears when done */ + regmap_write_bits(regmap, RTL8231_REG_PIN_HI_CFG, + RTL8231_PIN_HI_CFG_SOFT_RESET,
RTL8231_PIN_HI_CFG_SOFT_RESET);drivers/mfd/rtl8231.c new file +3
-0+ + err = regmap_read_poll_timeout(regmap, RTL8231_REG_PIN_HI_CFG, cfg, + !(cfg &
RTL8231_PIN_HI_CFG_SOFT_RESET), 50, 1000);drivers/mfd/rtl8231.c line 59
Quoted 4 lines
drivers/mfd/rtl8231.c new file +4
-0+if (err) +return err; + +regcache_drop_region (regmap,0 ,RTL8231_REG_COUNT -1 );Nit:
RTL8231_REG_FUNC0,RTL8231_REG_GPIO_DATA2
Quoted 7 lines
I'll also accept additional devices for each of these which would make things very clear.
RTL8231_REG_START0RTL8231_REG_ENDRTL8231_REG_COUNT- 1Or similar.
I went with:
#define RTL8231_REG_START 0x00
#define RTL8231_REG_END 0x1e
I will also use RTL8231_REG_END for the regmap config's max_register, so RTL8231_REG_COUNT can even be dropped.
Quoted 30 lines
Quoted 30 lines
drivers/mfd/rtl8231.c new file +30
-0+static int rtl8231_init (struct device *dev,struct regmap *regmap) +{ +struct regmap_field *led_start; +unsigned int ready_code; +unsigned int started; +unsigned int status; +int err; + + err =regmap_read (regmap,RTL8231_REG_FUNC1 , &status); +if (err) { +dev_err (dev,"failed to read READY_CODE\n" ); +return err; + } + + ready_code =FIELD_GET (RTL8231_FUNC1_READY_CODE_MASK , status); +if (ready_code !=RTL8231_FUNC1_READY_CODE_VALUE ) { +dev_err (dev,"RTL8231 not present or ready 0x%x != 0x%x\n" , + ready_code,RTL8231_FUNC1_READY_CODE_VALUE ); +return -ENODEV ; + } + + led_start =dev_get_drvdata (dev); + err =regmap_field_read (led_start, &started); +if (err) +return err; + +if (started) +return 0 ; + + err =rtl8231_soft_reset (regmap);
Quoted 8 lines
drivers/mfd/rtl8231.c
Quoted 6 lines
drivers/mfd/rtl8231.c new file +4
-0+if (err) +return err; + +/* LED_START enables power to output pins, and starts the LED engine */
drivers/mfd/rtl8231.c new file +1
-0+return regmap_field_write (led_start,1 );Why can't the dedicated LED driver initialise itself?
Perhaps I didn't explain this clearly enough in my previous message, but the "led_start" bit must also be set if all pins are configured for use as GPIO and the LED driver isn't even loaded in the kernel. Otherwise the output drivers of the pins remain disabled.
I can rename "led_start" to "output_enable" if that would make things clearer.
Quoted 8 lines
drivers/mfd/rtl8231.c line 116
Quoted 8 lines
drivers/mfd/rtl8231.c new file +7
-0+} + +static const struct regmap_config rtl8231_mdio_regmap_config = { + .val_bits =RTL8231_BITS_VAL , + .reg_bits =RTL8231_BITS_REG , + .volatile_reg = rtl8231_volatile_reg, + .max_register =RTL8231_REG_COUNT -1 ,
Changed to RTL8231_REG_END.
Quoted 6 lines
drivers/mfd/rtl8231.c line 134
Quoted 4 lines
drivers/mfd/rtl8231.c new file +1
-0+ regmap = devm_regmap_init_mdio(mdiodev,
&rtl8231_mdio_regmap_config);drivers/mfd/rtl8231.c new file +2
-0+if (IS_ERR (regmap)) { +dev_err (dev,"failed to init regmap\n" );Nit: Let's not shorten user messages - "initialise".
Ack.
Quoted 17 lines
drivers/mfd/rtl8231.c line 142
Quoted 8 lines
drivers/mfd/rtl8231.c new file +8
-0+return PTR_ERR (regmap); + } + + led_start =devm_regmap_field_alloc (dev, regmap, field_led_start); +if (IS_ERR (led_start)) +return PTR_ERR (led_start); + +dev_set_drvdata (dev, led_start);I'd pass the whole Regmap through and let the LED extract its own part.
Quoted 6 lines
drivers/mfd/rtl8231.c new file +1
-0+ mdiodev->reset_gpio = devm_gpiod_get_optional(dev, "reset",
GPIOD_OUT_LOW);drivers/mfd/rtl8231.c new file +4
-0+if (IS_ERR (mdiodev->reset_gpio)) +return PTR_ERR (mdiodev->reset_gpio); + + device_property_read_u32(dev, "reset-assert-delay", &mdiodev-
Quoted 7 lines
drivers/mfd/rtl8231.c
Quoted 5 lines
Quoted 1 line
reset_assert_delay);drivers/mfd/rtl8231.c new file +1
-0+ device_property_read_u32(dev, "reset-deassert-delay", &mdiodev-Quoted 1 line
reset_deassert_delay);drivers/mfd/rtl8231.c new file +2
-0+ + err =rtl8231_init (dev, regmap);... then you can omit the 'regmap' argument.
Sure, that's one less allocation too. The field writes become a bit more verbose, but it's not too unwieldy.
Quoted 10 lines
drivers/mfd/rtl8231.c line 159
Quoted 10 lines
drivers/mfd/rtl8231.c new file +4
-0+if (err) +return err; + + return devm_mfd_add_devices(dev, PLATFORM_DEVID_AUTO,
rtl8231_cells,drivers/mfd/rtl8231.c new file +1
-0+ ARRAY_SIZE(rtl8231_cells), NULL, 0,NULL);
drivers/mfd/rtl8231.c new file +3
-0+} + +static int __maybe_unused rtl8231_suspend (struct device *dev)
I've learned the __maybe_unused is (no longer) required, so I dropped these.
Quoted 6 lines
drivers/mfd/rtl8231.c line 163
Quoted 4 lines
drivers/mfd/rtl8231.c new file +4
-0+{ +struct regmap_field *led_start =dev_get_drvdata (dev); + +return regmap_field_write (led_start,0 );The LED driver doesn't have its own suspend support?
Because this affects both the GPIO outputs and the LED scanning feature, this does belong in the core driver IMHO.
Quoted 12 lines
drivers/mfd/rtl8231.c line 172
Quoted 10 lines
drivers/mfd/rtl8231.c new file +9
-0+} + +static int __maybe_unused rtl8231_resume (struct device *dev) +{ +struct regmap_field *led_start =dev_get_drvdata (dev); + +return regmap_field_write (led_start,1 ); +} +Nit: Remove this line.
You mean the blank line above "SIMPLE_DEV_PM_OPS"? AFAICT this is standard style for this kind of statement. It feels "ugly" to me to glue the PM_OPS macro to the resume function, while the suspend function is separated from it.
Quoted 1 line
Best,
Sander
PATCH v8 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
@@ -520,6 +520,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
@@ -52,6 +52,7 @@ obj-$(CONFIG_PINCTRL_PISTACHIO) += pinctrl-pistachio.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.51.1
PATCH v8 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
@@ -666,6 +666,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.51.1
PATCH v8 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
@@ -21663,6 +21663,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.51.1
Quoted 16 lines · Sander Vanheule
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)
Quoted 6 lines
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).
---
Forgot to list the 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 references properties in bindings
Best,
Sander