From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3326431A046 for ; Mon, 17 Nov 2025 21:51:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416317; cv=none; b=mI1nPyf3iS7dundkqi/2SpeUUZR+ZR5nLC1h274inbCig2dKX/RBR9fbSAtVlCBwJ6AxdCtY8XQKSzpMQXSEPOoW5cxeO/T2ONhIuRA1raADzfT6lyRVE24eHWvmoii3uw/8KnhQV8ugHDxfrqEL7VQzck57vYsADTLA+yyb2iw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416317; c=relaxed/simple; bh=mwURn2uqF2afNYtwojzFjypPQ+vko7I9Vc5NRvyTtXw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=KLieRT+3E5hS12rONHvp/zTGr0Cw7dHg4h4GriS91tUZqCPmAPsWcdUe+xsBwdXE0KtFwE9TrNOKH3KR37HlhJL322IBsx3d+iw0b5AOcWkjl02BnQix7QBVPbMarYUjK9Awhm87IgqYZgNA/OtAGCeWqgPh+gscEkwM9j9lRzw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=vJPOIt+s; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="vJPOIt+s" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id 6B0846A0B5C; Mon, 17 Nov 2025 22:51:46 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416306; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=NTKBIKFZ7Mv8bneuGPPut4kLMTt2ZEb0q2ZsBMGiM20=; b=vJPOIt+sZ4uDOlwWCwkO0JcBA0TVWSBg6oNOU4YTzUa+zwxRq55Uz56DK0xcPVuHYAdeoo uPgh0GKdhfIwOpN5P9mlnCWczuv2X3VlQBUHmPs3STFQuuUmfvrU+d30cjxr9LBTs0uieL cZc2YxJPZaQOXsBppZzcRxPNZg8k4K3rXQ31P1VfjFdppbMlWb+Qd/z57nN2hnfZ4UJrOy KwwSxnTzK6m6y1qzHPhtPoiJcs69TsfbOm5oslHgcgfUHVlJWWMxzdTVqnc/TNDONAO/f6 y9PwuemVPlhRS42WpSuhILbckjei2hb7oOyxY6fTln+8Y75wXIbEOeb2BAUkww== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 1/6] dt-bindings: leds: Binding for RTL8231 scan matrix Date: Mon, 17 Nov 2025 22:51:31 +0100 Message-ID: <20251117215138.4353-2-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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 --- 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 | 167 ++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/realtek,rtl8231-= leds.yaml diff --git a/Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.ya= ml b/Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml new file mode 100644 index 000000000000..222cd08914da --- /dev/null +++ b/Documentation/devicetree/bindings/leds/realtek,rtl8231-leds.yaml @@ -0,0 +1,167 @@ +# 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 + +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=C3=976 single color LEDs. Rows and columns are driven b= y 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=C3=976 single color LEDs. Rows and columns are driven b= y 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 selectio= n 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=C3=976 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 descri= ption + for how the scanning matrices are wired up. + enum: [single-color, bi-color] + +patternProperties: + "^led@([1-2]?[0-9]|3[0-1]),[0-2]": + description: + LEDs are addressed by their port index and led index. Ports 0-23 alw= ays + 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 + + allOf: + - $ref: /schemas/leds/common.yaml# + + required: + - reg + +required: + - compatible + - "#address-cells" + - "#size-cells" + - realtek,led-scan-mode + +additionalProperties: false + +examples: + - | + #include + led-controller { + compatible =3D "realtek,rtl8231-leds"; + #address-cells =3D <2>; + #size-cells =3D <0>; + + realtek,led-scan-mode =3D "single-color"; + + led@0,0 { + reg =3D <0 0>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <0>; + }; + + led@0,1 { + reg =3D <0 1>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <0>; + }; + + led@0,2 { + reg =3D <0 2>; + color =3D ; + function =3D LED_FUNCTION_STATUS; + }; + }; --=20 2.51.1 From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3304729A9CD for ; Mon, 17 Nov 2025 21:51:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416317; cv=none; b=mYLaAg0PlrP/iAdsJwiBvMfTwlCeXMrYRVjynHpCmTvb1jrtQJ4k7rvat158YZjv6vuKMgVjy59lsVqjkU20SAPD3+iYGGHVUusjxXFUSy3YqUI5owrnoAIm0yF/s379B3KucpJ2kQii45lvXRYc9/kQ0V22DIEdA+tsNf2oPeM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416317; c=relaxed/simple; bh=zdmtwhELRKjmlBCz0c0RMPi3+X265l7IC4n8BA51XxM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=XvhX7lXZD1z2GiKBowk07Fme3ZNc4KgTjwVm9gqOXAtH6PAxH+6c82EjZaLNOOirjlaexPTo7tnoFokJhOEg/cqmjInZ1Kbe7/p5h1ByJp+dhpOZ9BrEaYoe+6PP6DO6pmgjVoL4CKBPJaRif/L/PEkY6IhYIssIBp159O68vx4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=qaOjfOur; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="qaOjfOur" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id E8A266A0B5D; Mon, 17 Nov 2025 22:51:46 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416307; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=bqixPmI4NkVF4KtMAWaNvWPQbt6Vq5rRkO3NubLTZTU=; b=qaOjfOurdbanM0ibPAAoKn+stt7KMi1505Xsj6EgOKybQqPr7f59IrhsbhfX/ub2PnNyaW hUaMbK5XnCrq+w3Qh3m62FJhscrMW5RBCLnphpw29zukyUka5AuxxQAnxCdua3EjJJj4Tg oEWIo+Q6xaSYthDu+Hdf76i9zqEAbj1JntYQvlboxfULoF2m2OZFlZmmgs1ZkRQV4MEBdH aL6miXCANf16oG6cz91e/82GcxV2j81ObBaIK7wjy5dgrQK+NQOUJPExLEGHEtUWL/guUS dS0cvkUifzwXVVlMAz6WrAxvJ4N+8bO8FtTv4u6JwrGIjxdJ5FTwoMlUOk0YDg== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 2/6] dt-bindings: mfd: Binding for RTL8231 Date: Mon, 17 Nov 2025 22:51:32 +0100 Message-ID: <20251117215138.4353-3-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add 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. Signed-off-by: Sander Vanheule Reviewed-by: Rob Herring (Arm) --- 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 | 193 ++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100644 Documentation/devicetree/bindings/mfd/realtek,rtl8231.y= aml diff --git a/Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml b/D= ocumentation/devicetree/bindings/mfd/realtek,rtl8231.yaml new file mode 100644 index 000000000000..5669dd58654e --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/realtek,rtl8231.yaml @@ -0,0 +1,193 @@ +# 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 + +description: | + The RTL8231 is a GPIO and LED expander chip, providing up to 37 GPIOs, u= p to + 88 LEDs, and up to one PWM output. This device is frequently used alongs= ide + Realtek switch SoCs, to provide additional I/O capabilities. + + To manage the RTL8231's features, its strapping pins can be used to conf= igure + 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 spec= ify + 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, 320= 0, + 4000, and 4800. + const: 2 + +patternProperties: + "-pins$": + type: object + $ref: /schemas/pinctrl/pinmux-node.yaml# + + properties: + pins: + items: + enum: [gpio0, gpio1, gpio2, gpio3, gpio4, gpio5, gpio6, gpio7, + gpio8, gpio9, gpio10, gpio11, gpio12, gpio13, gpio14, gpi= o15, + gpio16, gpio17, gpio18, gpio19, gpio20, gpio21, gpio22, g= pio23, + gpio24, gpio25, gpio26, gpio27, gpio28, gpio29, gpio30, g= pio31, + gpio32, gpio33, gpio34, gpio35, gpio36] + minItems: 1 + maxItems: 37 + + 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 =3D <1>; + #size-cells =3D <0>; + + expander0: expander@0 { + compatible =3D "realtek,rtl8231"; + reg =3D <0>; + + gpio-controller; + #gpio-cells =3D <2>; + gpio-ranges =3D <&expander0 0 0 37>; + }; + }; + - | + // All bells and whistles included + #include + mdio { + #address-cells =3D <1>; + #size-cells =3D <0>; + + expander1: expander@1 { + compatible =3D "realtek,rtl8231"; + reg =3D <1>; + + gpio-controller; + #gpio-cells =3D <2>; + gpio-ranges =3D <&expander1 0 0 37>; + + #pwm-cells =3D <2>; + + drive-strength =3D <4>; + + button-pins { + pins =3D "gpio36"; + function =3D "gpio"; + input-debounce =3D <100000>; + }; + + pwm-pins { + pins =3D "gpio35"; + function =3D "pwm"; + }; + + led_matrix: led-pins { + pins =3D "gpio0", "gpio1", "gpio3", "gpio4"; + function =3D "led"; + }; + + led-controller { + compatible =3D "realtek,rtl8231-leds"; + #address-cells =3D <2>; + #size-cells =3D <0>; + + pinctrl-names =3D "default"; + pinctrl-0 =3D <&led_matrix>; + + realtek,led-scan-mode =3D "single-color"; + + led@0,0 { + reg =3D <0 0>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <0>; + }; + + led@0,1 { + reg =3D <0 1>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <0>; + }; + + led@1,0 { + reg =3D <1 0>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <1>; + }; + + led@1,1 { + reg =3D <1 1>; + color =3D ; + function =3D LED_FUNCTION_LAN; + function-enumerator =3D <1>; + }; + }; + }; + }; --=20 2.51.1 From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 55A8C325734 for ; Mon, 17 Nov 2025 21:51:55 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416318; cv=none; b=VzRGqrZ3zNtKQJcqTgnuUb5zcZZ8Wlgb/yq3XUbnze7WOVbqT95KUzt9+GLWPSYwRJTz2AMs/vhqQtyphrHjpq/39ItFE0DgpvQm6dpqO6DAX7QlGXPX6MKQFluD9qmVuqzAsp4Ip50zMtrZy1OlvHV550SPQ7nHKWzjcab7ulY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416318; c=relaxed/simple; bh=AIkpBYWcXaEi0OLIpf4waPsTGB2gymcCsLBRGZQZrhE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=WXS9Zzc9tXvo9ayVkOygf2hDtO6/OPmpuct6xaRSQ281NR60nWjtDGLXNRFVbcYh7RIVoX1gnhcA3I7VevYxIrSO3/LFc+VwE9zo2Lj1Mt3JspfTB1jXJB9E9qgR1quv0QzEQCDCjrqHYq4jmjo2DHiWkAikc6xVu3ys89N6Hns= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=a6XvPQcg; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="a6XvPQcg" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id 7A5976A0B5E; Mon, 17 Nov 2025 22:51:47 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416307; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=SeSGawNYxVyxkyDt5qcmR4QqcVeb//xCR+OkjctEfs4=; b=a6XvPQcghr36RMjv7vXS0n5UuZvkB/UGYviJpbZ8wv0M0sa4rwtGSu/IrpcGMEABaVfdzF CC89NHgKmY+WEhEHqia84MKypf1Ln02Xxtmm6X7N9DQ2Doq4vt4oJPT7B7NvedDm7SY51n yTcmeqCM0sZrPyIZUn92r7edPQA/AQODoDNiGFEcY/Qaxi+dv0BLwJ7VrpvikT3MDXMfn9 uBZpLWoenK4zGCAayQQgp1k7oNOnHq/d4AwpZkRVlWSmknu7a38MmFYIlXJkFkkyxqtwup FSHT3sxUXso+IBvcY1/JeQM3vdVSDcoO5bRYm3avqZdJ1URjqQy5zQmNAj34bA== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 3/6] mfd: Add RTL8231 core device Date: Mon, 17 Nov 2025 22:51:33 +0100 Message-ID: <20251117215138.4353-4-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 --- 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 diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index 6cec1858947b..e13e2df63fee 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -1301,6 +1301,15 @@ config MFD_RDC321X southbridge which provides access to GPIOs and Watchdog using the southbridge PCI device configuration space. =20 +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 diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index 865e9f12faff..ba973382a20f 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -252,6 +252,7 @@ obj-$(CONFIG_MFD_HI6421_PMIC) +=3D hi6421-pmic-core.o obj-$(CONFIG_MFD_HI6421_SPMI) +=3D hi6421-spmi-pmic.o obj-$(CONFIG_MFD_HI655X_PMIC) +=3D hi655x-pmic.o obj-$(CONFIG_MFD_DLN2) +=3D dln2.o +obj-$(CONFIG_MFD_RTL8231) +=3D rtl8231.o obj-$(CONFIG_MFD_RT4831) +=3D rt4831.o obj-$(CONFIG_MFD_RT5033) +=3D rt5033.o obj-$(CONFIG_MFD_RT5120) +=3D rt5120.o diff --git a/drivers/mfd/rtl8231.c b/drivers/mfd/rtl8231.c new file mode 100644 index 000000000000..8c74a3497045 --- /dev/null +++ b/drivers/mfd/rtl8231.c @@ -0,0 +1,193 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +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[] =3D { + { + .name =3D "rtl8231-pinctrl", + }, + { + .name =3D "rtl8231-leds", + .of_compatible =3D "realtek,rtl8231-leds", + }, +}; + +static int rtl8231_soft_reset(struct regmap *regmap) +{ + const unsigned int all_pins_mask =3D GENMASK(RTL8231_BITS_VAL - 1, 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); + + err =3D 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); + + /* + * Chip reset results in a pin configuration that is a mix of LED and GPI= O 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 =3D regmap_read(regmap, RTL8231_REG_FUNC1, &status); + if (err) { + dev_err(dev, "failed to read READY_CODE\n"); + return err; + } + + ready_code =3D FIELD_GET(RTL8231_FUNC1_READY_CODE_MASK, status); + if (ready_code !=3D RTL8231_FUNC1_READY_CODE_VALUE) { + dev_err(dev, "RTL8231 not present or ready 0x%x !=3D 0x%x\n", + ready_code, RTL8231_FUNC1_READY_CODE_VALUE); + return -ENODEV; + } + + led_start =3D dev_get_drvdata(dev); + err =3D regmap_field_read(led_start, &started); + if (err) + return err; + + if (started) + return 0; + + err =3D 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); +} + +static const struct regmap_config rtl8231_mdio_regmap_config =3D { + .val_bits =3D RTL8231_BITS_VAL, + .reg_bits =3D RTL8231_BITS_REG, + .volatile_reg =3D rtl8231_volatile_reg, + .max_register =3D RTL8231_REG_COUNT - 1, + .use_single_read =3D true, + .use_single_write =3D true, + .reg_format_endian =3D REGMAP_ENDIAN_BIG, + .val_format_endian =3D REGMAP_ENDIAN_BIG, + .cache_type =3D REGCACHE_MAPLE, +}; + +static int rtl8231_mdio_probe(struct mdio_device *mdiodev) +{ + const struct reg_field field_led_start =3D REG_FIELD(RTL8231_REG_FUNC0, 1= , 1); + struct device *dev =3D &mdiodev->dev; + struct regmap_field *led_start; + struct regmap *regmap; + int err; + + regmap =3D devm_regmap_init_mdio(mdiodev, &rtl8231_mdio_regmap_config); + if (IS_ERR(regmap)) { + dev_err(dev, "failed to init regmap\n"); + return PTR_ERR(regmap); + } + + led_start =3D 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); + + mdiodev->reset_gpio =3D devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_L= OW); + if (IS_ERR(mdiodev->reset_gpio)) + return PTR_ERR(mdiodev->reset_gpio); + + device_property_read_u32(dev, "reset-assert-delay", &mdiodev->reset_asser= t_delay); + device_property_read_u32(dev, "reset-deassert-delay", &mdiodev->reset_dea= ssert_delay); + + err =3D rtl8231_init(dev, regmap); + 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 =3D dev_get_drvdata(dev); + + return regmap_field_write(led_start, 0); +} + +static int __maybe_unused rtl8231_resume(struct device *dev) +{ + struct regmap_field *led_start =3D dev_get_drvdata(dev); + + return regmap_field_write(led_start, 1); +} + +static SIMPLE_DEV_PM_OPS(rtl8231_pm_ops, rtl8231_suspend, rtl8231_resume); + +static const struct of_device_id rtl8231_of_match[] =3D { + { .compatible =3D "realtek,rtl8231" }, + {} +}; +MODULE_DEVICE_TABLE(of, rtl8231_of_match); + +static struct mdio_driver rtl8231_mdio_driver =3D { + .mdiodrv.driver =3D { + .name =3D "rtl8231-expander", + .of_match_table =3D rtl8231_of_match, + .pm =3D pm_ptr(&rtl8231_pm_ops), + }, + .probe =3D rtl8231_mdio_probe, +}; +mdio_module_driver(rtl8231_mdio_driver); + +MODULE_AUTHOR("Sander Vanheule "); +MODULE_DESCRIPTION("Realtek RTL8231 GPIO and LED expander"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/mfd/rtl8231.h b/include/linux/mfd/rtl8231.h new file mode 100644 index 000000000000..003eda3797a3 --- /dev/null +++ b/include/linux/mfd/rtl8231.h @@ -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 + +/* + * 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 in= put + * 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 */ --=20 2.51.1 From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 59B0B327204 for ; Mon, 17 Nov 2025 21:51:55 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416319; cv=none; b=lAplGWEt05FtJmWrAZEJpu026jchka2xTJDk0b1M25RzeaF6G++EoVn2qGV8SWNcmZgLJwsb7XqUB3SFR5wWVObUt2gN//mhGI17V+FJ5FdISvfJKb5K4NSBoaG92TIxDUehW/O3nuNyx/WmZKpTKK54LlhqY5MepLh8I2Gh80c= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416319; c=relaxed/simple; bh=Et9nl2dHU6hmBc/Mh2s+n8fZtK8RmNlW8srdvzorQkw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=mYReioefmS+29NVXemFKXCKxsAe4bl6Ue1zTmDTCSkOBcR6uBcz4pC1Y3RBU4KjA5x075e+EBcUGngL419MJDysp8pDaWf70woWjD4XBGrZEyd+73uirWHmJU6I8LZt6GfGU9/QBcUZnd05eRrOXVqoCwsjwJL7ngewpYAFVJ7Y= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=jX1rtcE0; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="jX1rtcE0" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id 0D56E6A0B5F; Mon, 17 Nov 2025 22:51:48 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416308; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=7fyn0/11zV+5OWce88QU56rP2zzMRIZ30C428AtCGl0=; b=jX1rtcE0zxAbluH+jtg8IF4W7akUWVMOt3wbiGNidBmcO41GWRiLd3QPGr5n679uaFPGXV l/zAT2KbxqwI9sLzfVkEhNnQgmHWh7FJF3zKLU8153jUqARaki530luZJ4D2zPQbp6C6bI TtYBEDfUGkRqUTZFAQ6d+t+SeBjKZ4KjdOJip1Zle6HXbYZOM4+C4O16zw/A/GyB8TWhtO +OLabOnwmLZo2G4KCFaSEDCbNV6IvWySfOoUoAp21v4iDapkFmSCTbANp7SpHHbFS7yO3m w1OZPrOiw1cX8SFgYAvIR4W3JlkMjxwN+6RC3XgVHyOae5Sx6/eJEa8B6r0tOQ== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 4/6] pinctrl: Add RTL8231 pin control and GPIO support Date: Mon, 17 Nov 2025 22:51:34 +0100 Message-ID: <20251117215138.4353-5-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 Reviewed-by: Linus Walleij --- 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 diff --git a/drivers/pinctrl/Kconfig b/drivers/pinctrl/Kconfig index 4f8507ebbdac..107c59f8aa7d 100644 --- a/drivers/pinctrl/Kconfig +++ b/drivers/pinctrl/Kconfig @@ -520,6 +520,18 @@ config PINCTRL_ROCKCHIP help This support pinctrl and GPIO driver for Rockchip SoCs. =20 +config PINCTRL_RTL8231 + tristate "Realtek RTL8231 GPIO expander's pin controller" + depends on MFD_RTL8231 + 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 diff --git a/drivers/pinctrl/Makefile b/drivers/pinctrl/Makefile index e0cfb9b7c99b..ded51723d452 100644 --- a/drivers/pinctrl/Makefile +++ b/drivers/pinctrl/Makefile @@ -52,6 +52,7 @@ obj-$(CONFIG_PINCTRL_PISTACHIO) +=3D pinctrl-pistachio.o obj-$(CONFIG_PINCTRL_RK805) +=3D pinctrl-rk805.o obj-$(CONFIG_PINCTRL_ROCKCHIP) +=3D pinctrl-rockchip.o obj-$(CONFIG_PINCTRL_RP1) +=3D pinctrl-rp1.o +obj-$(CONFIG_PINCTRL_RTL8231) +=3D pinctrl-rtl8231.o obj-$(CONFIG_PINCTRL_SCMI) +=3D pinctrl-scmi.o obj-$(CONFIG_PINCTRL_SINGLE) +=3D pinctrl-single.o obj-$(CONFIG_PINCTRL_ST) +=3D pinctrl-st.o diff --git a/drivers/pinctrl/pinctrl-rtl8231.c b/drivers/pinctrl/pinctrl-rt= l8231.c new file mode 100644 index 000000000000..a06cbdbb2018 --- /dev/null +++ b/drivers/pinctrl/pinctrl-rtl8231.c @@ -0,0 +1,533 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "core.h" +#include "pinmux.h" +#include + +#define RTL8231_NUM_GPIOS 37 +#define RTL8231_DEBOUNCE_USEC 100000 +#define RTL8231_DEBOUNCE_MIN_OFFSET 31 + +struct rtl8231_pin_ctrl { + struct regmap *map; +}; + +/* + * Pin controller functionality + */ +enum rtl8231_pin_function : uintptr_t { + RTL8231_PIN_FUNCTION_GPIO =3D BIT(0), + RTL8231_PIN_FUNCTION_LED =3D BIT(1), + RTL8231_PIN_FUNCTION_PWM =3D BIT(2), +}; + +struct rtl8231_function_info { + enum rtl8231_pin_function flag; + const char *name; +}; + +#define RTL8231_FUNCTION(_name, _flag) \ +((struct rtl8231_function_info) { \ + .flag =3D (_flag), \ + .name =3D (_name), \ + }) + +static const struct rtl8231_function_info rtl8231_pin_functions[] =3D { + RTL8231_FUNCTION("gpio", RTL8231_PIN_FUNCTION_GPIO), + RTL8231_FUNCTION("led", RTL8231_PIN_FUNCTION_LED), + RTL8231_FUNCTION("pwm", RTL8231_PIN_FUNCTION_PWM), +}; + +struct rtl8231_pin_desc { + enum rtl8231_pin_function functions:8; + u8 reg; + u8 offset; + u8 gpio_function_value; +}; + +#define RTL8231_PIN_DESC(_num, _func, _reg, _fld, _val) \ + [(_num)] =3D ((struct rtl8231_pin_desc) { \ + .functions =3D RTL8231_PIN_FUNCTION_GPIO | (_func), \ + .reg =3D (_reg), \ + .offset =3D (_fld), \ + .gpio_function_value =3D (_val), \ + }) +#define RTL8231_GPIO_PIN_DESC(_num, _reg, _fld) \ + RTL8231_PIN_DESC(_num, 0, _reg, _fld, RTL8231_PIN_MODE_GPIO) +#define RTL8231_LED_PIN_DESC(_num, _reg, _fld) \ + RTL8231_PIN_DESC(_num, RTL8231_PIN_FUNCTION_LED, _reg, _fld, RTL8231_PIN_= MODE_GPIO) +#define RTL8231_PWM_PIN_DESC(_num, _reg, _fld) \ + RTL8231_PIN_DESC(_num, RTL8231_PIN_FUNCTION_PWM, _reg, _fld, 0) + +/* + * All pins have a GPIO/LED mux bit, but the bits for pins 35/36 are read-= only. Use this bit + * for the GPIO-only pin instead of a placeholder, so the rest of the logi= c can stay generic. + */ +static const struct rtl8231_pin_desc rtl8231_pin_data[RTL8231_NUM_GPIOS] = =3D { + RTL8231_LED_PIN_DESC(0, RTL8231_REG_PIN_MODE0, 0), + RTL8231_LED_PIN_DESC(1, RTL8231_REG_PIN_MODE0, 1), + RTL8231_LED_PIN_DESC(2, RTL8231_REG_PIN_MODE0, 2), + RTL8231_LED_PIN_DESC(3, RTL8231_REG_PIN_MODE0, 3), + RTL8231_LED_PIN_DESC(4, RTL8231_REG_PIN_MODE0, 4), + RTL8231_LED_PIN_DESC(5, RTL8231_REG_PIN_MODE0, 5), + RTL8231_LED_PIN_DESC(6, RTL8231_REG_PIN_MODE0, 6), + RTL8231_LED_PIN_DESC(7, RTL8231_REG_PIN_MODE0, 7), + RTL8231_LED_PIN_DESC(8, RTL8231_REG_PIN_MODE0, 8), + RTL8231_LED_PIN_DESC(9, RTL8231_REG_PIN_MODE0, 9), + RTL8231_LED_PIN_DESC(10, RTL8231_REG_PIN_MODE0, 10), + RTL8231_LED_PIN_DESC(11, RTL8231_REG_PIN_MODE0, 11), + RTL8231_LED_PIN_DESC(12, RTL8231_REG_PIN_MODE0, 12), + RTL8231_LED_PIN_DESC(13, RTL8231_REG_PIN_MODE0, 13), + RTL8231_LED_PIN_DESC(14, RTL8231_REG_PIN_MODE0, 14), + RTL8231_LED_PIN_DESC(15, RTL8231_REG_PIN_MODE0, 15), + RTL8231_LED_PIN_DESC(16, RTL8231_REG_PIN_MODE1, 0), + RTL8231_LED_PIN_DESC(17, RTL8231_REG_PIN_MODE1, 1), + RTL8231_LED_PIN_DESC(18, RTL8231_REG_PIN_MODE1, 2), + RTL8231_LED_PIN_DESC(19, RTL8231_REG_PIN_MODE1, 3), + RTL8231_LED_PIN_DESC(20, RTL8231_REG_PIN_MODE1, 4), + RTL8231_LED_PIN_DESC(21, RTL8231_REG_PIN_MODE1, 5), + RTL8231_LED_PIN_DESC(22, RTL8231_REG_PIN_MODE1, 6), + RTL8231_LED_PIN_DESC(23, RTL8231_REG_PIN_MODE1, 7), + RTL8231_LED_PIN_DESC(24, RTL8231_REG_PIN_MODE1, 8), + RTL8231_LED_PIN_DESC(25, RTL8231_REG_PIN_MODE1, 9), + RTL8231_LED_PIN_DESC(26, RTL8231_REG_PIN_MODE1, 10), + RTL8231_LED_PIN_DESC(27, RTL8231_REG_PIN_MODE1, 11), + RTL8231_LED_PIN_DESC(28, RTL8231_REG_PIN_MODE1, 12), + RTL8231_LED_PIN_DESC(29, RTL8231_REG_PIN_MODE1, 13), + RTL8231_LED_PIN_DESC(30, RTL8231_REG_PIN_MODE1, 14), + RTL8231_LED_PIN_DESC(31, RTL8231_REG_PIN_MODE1, 15), + RTL8231_LED_PIN_DESC(32, RTL8231_REG_PIN_HI_CFG, 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), +}; +static const unsigned int PWM_PIN =3D 35; + +#define RTL8231_PIN(_num) \ + ((struct pinctrl_pin_desc) { \ + .number =3D (_num), \ + .name =3D "gpio" #_num, \ + .drv_data =3D (void *) &rtl8231_pin_data[(_num)] \ + }) + +static const struct pinctrl_pin_desc rtl8231_pins[RTL8231_NUM_GPIOS] =3D { + RTL8231_PIN(0), + RTL8231_PIN(1), + RTL8231_PIN(2), + RTL8231_PIN(3), + RTL8231_PIN(4), + RTL8231_PIN(5), + RTL8231_PIN(6), + RTL8231_PIN(7), + RTL8231_PIN(8), + RTL8231_PIN(9), + RTL8231_PIN(10), + RTL8231_PIN(11), + RTL8231_PIN(12), + RTL8231_PIN(13), + RTL8231_PIN(14), + RTL8231_PIN(15), + RTL8231_PIN(16), + RTL8231_PIN(17), + RTL8231_PIN(18), + RTL8231_PIN(19), + RTL8231_PIN(20), + RTL8231_PIN(21), + RTL8231_PIN(22), + RTL8231_PIN(23), + RTL8231_PIN(24), + RTL8231_PIN(25), + RTL8231_PIN(26), + RTL8231_PIN(27), + RTL8231_PIN(28), + RTL8231_PIN(29), + RTL8231_PIN(30), + RTL8231_PIN(31), + RTL8231_PIN(32), + RTL8231_PIN(33), + RTL8231_PIN(34), + RTL8231_PIN(35), + RTL8231_PIN(36), +}; + +static int rtl8231_get_groups_count(struct pinctrl_dev *pctldev) +{ + return ARRAY_SIZE(rtl8231_pins); +} + +static const char *rtl8231_get_group_name(struct pinctrl_dev *pctldev, uns= igned int selector) +{ + return rtl8231_pins[selector].name; +} + +static int rtl8231_get_group_pins(struct pinctrl_dev *pctldev, unsigned in= t selector, + const unsigned int **pins, unsigned int *num_pins) +{ + if (selector >=3D ARRAY_SIZE(rtl8231_pins)) + return -EINVAL; + + *pins =3D &rtl8231_pins[selector].number; + *num_pins =3D 1; + + return 0; +} + +static const struct pinctrl_ops rtl8231_pinctrl_ops =3D { + .get_groups_count =3D rtl8231_get_groups_count, + .get_group_name =3D rtl8231_get_group_name, + .get_group_pins =3D rtl8231_get_group_pins, + .dt_node_to_map =3D pinconf_generic_dt_node_to_map_all, + .dt_free_map =3D pinconf_generic_dt_free_map, +}; + +static int rtl8231_set_mux(struct pinctrl_dev *pctldev, unsigned int func_= selector, + unsigned int group_selector) +{ + const struct function_desc *func =3D pinmux_generic_get_function(pctldev,= func_selector); + const struct rtl8231_pin_desc *desc =3D rtl8231_pins[group_selector].drv_= data; + const struct rtl8231_pin_ctrl *ctrl =3D pinctrl_dev_get_drvdata(pctldev); + enum rtl8231_pin_function func_flag =3D (uintptr_t) func->data; + unsigned int function_mask; + unsigned int gpio_function; + + if (!(desc->functions & func_flag)) + return -EINVAL; + + function_mask =3D BIT(desc->offset); + gpio_function =3D desc->gpio_function_value << desc->offset; + + if (func_flag =3D=3D RTL8231_PIN_FUNCTION_GPIO) + return regmap_update_bits(ctrl->map, desc->reg, function_mask, gpio_func= tion); + else + return regmap_update_bits(ctrl->map, desc->reg, function_mask, ~gpio_fun= ction); +} + +static int rtl8231_gpio_request_enable(struct pinctrl_dev *pctldev, + struct pinctrl_gpio_range *range, unsigned int offset) +{ + const struct rtl8231_pin_desc *desc =3D rtl8231_pins[offset].drv_data; + const struct rtl8231_pin_ctrl *ctrl =3D pinctrl_dev_get_drvdata(pctldev); + unsigned int function_mask; + unsigned int gpio_function; + + function_mask =3D BIT(desc->offset); + gpio_function =3D desc->gpio_function_value << desc->offset; + + return regmap_update_bits(ctrl->map, desc->reg, function_mask, gpio_funct= ion); +} + +static const struct pinmux_ops rtl8231_pinmux_ops =3D { + .get_functions_count =3D pinmux_generic_get_function_count, + .get_function_name =3D pinmux_generic_get_function_name, + .get_function_groups =3D pinmux_generic_get_function_groups, + .function_is_gpio =3D pinmux_generic_function_is_gpio, + .set_mux =3D rtl8231_set_mux, + .gpio_request_enable =3D rtl8231_gpio_request_enable, + .strict =3D true, +}; + +static int rtl8231_pin_config_get(struct pinctrl_dev *pctldev, unsigned in= t offset, + unsigned long *config) +{ + const struct rtl8231_pin_ctrl *ctrl =3D pinctrl_dev_get_drvdata(pctldev); + unsigned int param =3D pinconf_to_config_param(*config); + unsigned int arg; + int err; + int v; + + switch (param) { + case PIN_CONFIG_INPUT_DEBOUNCE: + if (offset < RTL8231_DEBOUNCE_MIN_OFFSET) + return -EINVAL; + + err =3D regmap_read(ctrl->map, RTL8231_REG_FUNC1, &v); + if (err) + return err; + + v =3D FIELD_GET(RTL8231_FUNC1_DEBOUNCE_MASK, v); + if (v & BIT(offset - RTL8231_DEBOUNCE_MIN_OFFSET)) + arg =3D RTL8231_DEBOUNCE_USEC; + else + arg =3D 0; + break; + default: + return -ENOTSUPP; + } + + *config =3D pinconf_to_config_packed(param, arg); + + return 0; +} + +static int rtl8231_pin_config_set(struct pinctrl_dev *pctldev, unsigned in= t offset, + unsigned long *configs, unsigned int num_configs) +{ + const struct rtl8231_pin_ctrl *ctrl =3D pinctrl_dev_get_drvdata(pctldev); + unsigned int param, arg; + unsigned int pin_mask; + int err; + int i; + + for (i =3D 0; i < num_configs; i++) { + param =3D pinconf_to_config_param(configs[i]); + arg =3D pinconf_to_config_argument(configs[i]); + + switch (param) { + case PIN_CONFIG_INPUT_DEBOUNCE: + if (offset < RTL8231_DEBOUNCE_MIN_OFFSET) + return -EINVAL; + + pin_mask =3D FIELD_PREP(RTL8231_FUNC1_DEBOUNCE_MASK, + BIT(offset - RTL8231_DEBOUNCE_MIN_OFFSET)); + + switch (arg) { + case 0: + err =3D regmap_update_bits(ctrl->map, RTL8231_REG_FUNC1, + pin_mask, 0); + break; + case RTL8231_DEBOUNCE_USEC: + err =3D regmap_update_bits(ctrl->map, RTL8231_REG_FUNC1, + pin_mask, pin_mask); + break; + default: + return -EINVAL; + } + + break; + default: + return -ENOTSUPP; + } + } + + return err; +} + +static const struct pinconf_ops rtl8231_pinconf_ops =3D { + .is_generic =3D true, + .pin_config_get =3D rtl8231_pin_config_get, + .pin_config_set =3D rtl8231_pin_config_set, +}; + +static int rtl8231_pinctrl_init_functions(struct pinctrl_dev *pctl, + const struct pinctrl_desc *pctl_desc) +{ + enum rtl8231_pin_function flag; + struct pinfunction func; + const char **groups; + unsigned int f_idx; + const char *name; + unsigned int pin; + int num_groups; + int err; + + for (f_idx =3D 0; f_idx < ARRAY_SIZE(rtl8231_pin_functions); f_idx++) { + name =3D rtl8231_pin_functions[f_idx].name; + flag =3D rtl8231_pin_functions[f_idx].flag; + + for (pin =3D 0, num_groups =3D 0; pin < pctl_desc->npins; pin++) + if (rtl8231_pin_data[pin].functions & flag) + num_groups++; + + groups =3D devm_kcalloc(pctl->dev, num_groups, sizeof(*groups), GFP_KERN= EL); + if (!groups) + return -ENOMEM; + + for (pin =3D 0, num_groups =3D 0; pin < pctl_desc->npins; pin++) + if (rtl8231_pin_data[pin].functions & flag) + groups[num_groups++] =3D rtl8231_pins[pin].name; + + func =3D PINCTRL_PINFUNCTION(name, groups, num_groups); + if (flag =3D=3D RTL8231_PIN_FUNCTION_GPIO) + func.flags |=3D PINFUNCTION_FLAG_GPIO; + + err =3D pinmux_generic_add_pinfunction(pctl, &func, (void *) flag); + if (err < 0) + return err; + } + + return 0; +} + +struct pin_field_info { + const struct reg_field gpio_dir; + const struct reg_field mode; +}; + +static const struct pin_field_info pin_fields[] =3D { + { + .gpio_dir =3D REG_FIELD(RTL8231_REG_GPIO_DIR0, 0, 15), + .mode =3D REG_FIELD(RTL8231_REG_PIN_MODE0, 0, 15), + }, + { + .gpio_dir =3D REG_FIELD(RTL8231_REG_GPIO_DIR1, 0, 15), + .mode =3D REG_FIELD(RTL8231_REG_PIN_MODE1, 0, 15), + }, + { + .gpio_dir =3D REG_FIELD(RTL8231_REG_PIN_HI_CFG, 5, 9), + .mode =3D REG_FIELD(RTL8231_REG_PIN_HI_CFG, 0, 4), + }, +}; + +static int rtl8231_configure_safe(struct device *dev, struct regmap *map) +{ + struct regmap_field *field_mode; + struct regmap_field *field_dir; + unsigned int is_input; + unsigned int is_gpio; + int err; + + for (unsigned int i =3D 0; i < ARRAY_SIZE(pin_fields); i++) { + field_dir =3D devm_regmap_field_alloc(dev, map, pin_fields[i].gpio_dir); + if (IS_ERR(field_dir)) + return PTR_ERR(field_dir); + + field_mode =3D devm_regmap_field_alloc(dev, map, pin_fields[i].mode); + if (IS_ERR(field_mode)) + return PTR_ERR(field_mode); + + err =3D regmap_field_read(field_dir, &is_input); + if (err) + return err; + + err =3D regmap_field_read(field_mode, &is_gpio); + if (err) + return err; + + /* Enable field for PWM (on GPIO35) is in another register */ + if (pin_fields[i].mode.reg =3D=3D RTL8231_REG_PIN_HI_CFG) { + err =3D regmap_test_bits(map, rtl8231_pin_data[PWM_PIN].reg, + BIT(rtl8231_pin_data[PWM_PIN].offset)); + if (err < 0) + return err; + + if (err) + is_gpio &=3D ~BIT(PWM_PIN % RTL8231_BITS_VAL); + } + + /* + * 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); + + devm_regmap_field_free(dev, field_dir); + devm_regmap_field_free(dev, field_mode); + } + + return 0; +} + +static const struct pinctrl_desc rtl8231_pctl_desc =3D { + .name =3D "rtl8231-pinctrl", + .owner =3D THIS_MODULE, + .confops =3D &rtl8231_pinconf_ops, + .pctlops =3D &rtl8231_pinctrl_ops, + .pmxops =3D &rtl8231_pinmux_ops, + .npins =3D ARRAY_SIZE(rtl8231_pins), + .pins =3D rtl8231_pins, +}; + +static int rtl8231_pinctrl_init(struct device *dev, struct rtl8231_pin_ctr= l *ctrl) +{ + struct pinctrl_dev *pctldev; + int err; + + err =3D devm_pinctrl_register_and_init(dev->parent, &rtl8231_pctl_desc, c= trl, &pctldev); + if (err) { + dev_err(dev, "failed to register pin controller\n"); + return err; + } + + err =3D rtl8231_pinctrl_init_functions(pctldev, &rtl8231_pctl_desc); + if (err) + return err; + + err =3D pinctrl_enable(pctldev); + if (err) + 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) +{ + unsigned int pin_mask =3D BIT(offset % RTL8231_BITS_VAL); + + if (base =3D=3D RTL8231_REG_GPIO_DATA0 || offset < 32) { + *reg =3D base + offset / RTL8231_BITS_VAL; + *mask =3D pin_mask; + } else if (base =3D=3D RTL8231_REG_GPIO_DIR0) { + *reg =3D RTL8231_REG_PIN_HI_CFG; + *mask =3D FIELD_PREP(RTL8231_PIN_HI_CFG_DIR_MASK, pin_mask); + } else { + return -EINVAL; + } + + return 0; +} + +static int rtl8231_pinctrl_probe(struct platform_device *pdev) +{ + struct device *dev =3D &pdev->dev; + struct rtl8231_pin_ctrl *ctrl; + struct gpio_regmap_config gpio_cfg =3D {}; + int err; + + ctrl =3D devm_kzalloc(dev, sizeof(*ctrl), GFP_KERNEL); + if (!ctrl) + return -ENOMEM; + + ctrl->map =3D dev_get_regmap(dev->parent, NULL); + if (!ctrl->map) + return -ENODEV; + + err =3D rtl8231_configure_safe(dev, ctrl->map); + if (err) + return err; + + err =3D rtl8231_pinctrl_init(dev, ctrl); + if (err) + return err; + + gpio_cfg.regmap =3D ctrl->map; + gpio_cfg.parent =3D dev->parent; + gpio_cfg.ngpio =3D RTL8231_NUM_GPIOS; + gpio_cfg.ngpio_per_reg =3D RTL8231_BITS_VAL; + + gpio_cfg.reg_dat_base =3D GPIO_REGMAP_ADDR(RTL8231_REG_GPIO_DATA0); + gpio_cfg.reg_set_base =3D GPIO_REGMAP_ADDR(RTL8231_REG_GPIO_DATA0); + gpio_cfg.reg_dir_in_base =3D GPIO_REGMAP_ADDR(RTL8231_REG_GPIO_DIR0); + + gpio_cfg.reg_mask_xlate =3D rtl8231_gpio_reg_mask_xlate; + + return PTR_ERR_OR_ZERO(devm_gpio_regmap_register(dev, &gpio_cfg)); +} + +static struct platform_driver rtl8231_pinctrl_driver =3D { + .driver =3D { + .name =3D "rtl8231-pinctrl", + }, + .probe =3D rtl8231_pinctrl_probe, +}; +module_platform_driver(rtl8231_pinctrl_driver); + +MODULE_AUTHOR("Sander Vanheule "); +MODULE_DESCRIPTION("Realtek RTL8231 pin control and GPIO support"); +MODULE_LICENSE("GPL"); --=20 2.51.1 From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 28CD534C820 for ; Mon, 17 Nov 2025 21:51:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416321; cv=none; b=TZSPO+w7OSfcVs41ttsZzPm21V3layb8DnusYiFxRD5D8B6zxwERjtaR9O6MtWtsjuA/iY9p6/y3k3Lz3bG9RSmoGJcyUtJwq3zNxsxYJSkHzFK7RfqlAAZjW66Dx3Wsfj5nPaCvr+4hKMgNTzJLsWywlUewSR+zjNMSmpvX+Dg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416321; c=relaxed/simple; bh=IxmwnFcIb5YYJKy3VZvyXh0YKNaCM3WPo4pxvRpyc0k=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Ico+g1JcAH3EqL2oX+P8WfGOXLIxXhm7LMIt/v3EWXt4q6+3pewAPaBMZDnpd4YOqPeJDsC5C9bPy+sHZe6zwDmH8OnWldd9McuIC1hLX4RX5TuehmtctMCye+V8GVEFh+EYy+Mobedbceud/M/zzy2qZ8wd/DOK8zpQF0HABsE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=H8NOXvOq; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="H8NOXvOq" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id 833CC6A0B60; Mon, 17 Nov 2025 22:51:48 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416308; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=exqymdxjJ5FhF8jOfeTm35pWs+CO4VSFEXsm0Pbqp9g=; b=H8NOXvOqooFLr9+yibME4hnKrWQH5H6PbmUrd7bGJ7hCHjGxYtCQAt9PNGTf2nKcIKEFjH gr5E3hbA0DdKdmDw5mp+wx80woan4IbzBH7PnBrffR0vIsMjHfmNUkYq9vy3P5622Zwdo9 u8VIzvoK9YoD+yV0EMzf+7hijM31oCWgIx6FQHrV2xuaXiegg7WKmgANgliZYQFOsE8glo hbyHVeuwDct+MoLBDxHyHEnpqVR11s+FbTHkRT7zQ+wTQFERihruAGebg9gY/p5emF5e1L 7XaZklrWc3v7ETHXiIVD4KG2t0nAJB2f3tI7WpFCF7/p74MUb1RzsZC4vf0G8Q== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 5/6] leds: Add support for RTL8231 LED scan matrix Date: Mon, 17 Nov 2025 22:51:35 +0100 Message-ID: <20251117215138.4353-6-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Both 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. Signed-off-by: Sander Vanheule --- 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 diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index 06e6291be11b..bb4429bcd7a2 100644 --- a/drivers/leds/Kconfig +++ b/drivers/leds/Kconfig @@ -666,6 +666,16 @@ config LEDS_REGULATOR help This option enables support for regulator driven LEDs. =20 +config LEDS_RTL8231 + tristate "RTL8231 LED matrix support" + depends on LEDS_CLASS + depends on MFD_RTL8231 + 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 diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index 9a0333ec1a86..27c32204aebc 100644 --- a/drivers/leds/Makefile +++ b/drivers/leds/Makefile @@ -84,6 +84,7 @@ obj-$(CONFIG_LEDS_POWERNV) +=3D leds-powernv.o obj-$(CONFIG_LEDS_PWM) +=3D leds-pwm.o obj-$(CONFIG_LEDS_QNAP_MCU) +=3D leds-qnap-mcu.o obj-$(CONFIG_LEDS_REGULATOR) +=3D leds-regulator.o +obj-$(CONFIG_LEDS_RTL8231) +=3D leds-rtl8231.o obj-$(CONFIG_LEDS_SC27XX_BLTC) +=3D leds-sc27xx-bltc.o obj-$(CONFIG_LEDS_ST1202) +=3D leds-st1202.o obj-$(CONFIG_LEDS_SUN50I_A100) +=3D leds-sun50i-a100.o diff --git a/drivers/leds/leds-rtl8231.c b/drivers/leds/leds-rtl8231.c new file mode 100644 index 000000000000..8ff20cc7ea98 --- /dev/null +++ b/drivers/leds/leds-rtl8231.c @@ -0,0 +1,285 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include +#include +#include +#include +#include +#include +#include + +#include + +/** + * struct led_toggle_rate - description of an LED blinking mode + * @interval_ms: LED toggle rate in milliseconds + * @mode: Register field value used to activate this mode + * + * For LED hardware accelerated blinking, with equal on and off delay. + * Both delays are given by @interval, so the interval at which the LED bl= inks + * (i.e. turn on and off once) is double this value. + */ +struct led_toggle_rate { + u16 interval_ms; + u8 mode; +}; + +/** + * struct led_modes - description of all LED modes + * @toggle_rates: Array of led_toggle_rate values, sorted by ascending int= erval + * @num_toggle_rates: Number of elements in @led_toggle_rate + * @off: Register field value to turn LED off + * @on: Register field value to turn LED on + */ +struct led_modes { + const struct led_toggle_rate *toggle_rates; + unsigned int num_toggle_rates; + u8 off; + u8 on; +}; + +struct rtl8231_led { + struct led_classdev led; + const struct led_modes *modes; + struct regmap_field *reg_field; +}; +#define to_rtl8231_led(_cdev) container_of(_cdev, struct rtl8231_led, led) + +#define RTL8231_NUM_LEDS 3 +#define RTL8231_LED_PER_REG 5 +#define RTL8231_BITS_PER_LED 3 + +static const unsigned int rtl8231_led_port_counts_single[RTL8231_NUM_LEDS]= =3D {32, 32, 24}; +static const unsigned int rtl8231_led_port_counts_bicolor[RTL8231_NUM_LEDS= ] =3D {24, 24, 24}; + +static const unsigned int rtl8231_led_base[RTL8231_NUM_LEDS] =3D { + RTL8231_REG_LED0_BASE, + RTL8231_REG_LED1_BASE, + RTL8231_REG_LED2_BASE, +}; + +#define RTL8231_DEFAULT_TOGGLE_INTERVAL_MS 500 + +static const struct led_toggle_rate rtl8231_toggle_rates[] =3D { + { 40, 1}, + { 80, 2}, + { 160, 3}, + { 320, 4}, + { 640, 5}, + {1280, 6}, +}; + +static const struct led_modes rtl8231_led_modes =3D { + .off =3D 0, + .on =3D 7, + .num_toggle_rates =3D ARRAY_SIZE(rtl8231_toggle_rates), + .toggle_rates =3D rtl8231_toggle_rates, +}; + +static void rtl8231_led_brightness_set(struct led_classdev *led_cdev, + enum led_brightness brightness) +{ + struct rtl8231_led *pled =3D to_rtl8231_led(led_cdev); + + if (brightness) + regmap_field_write(pled->reg_field, pled->modes->on); + else + regmap_field_write(pled->reg_field, pled->modes->off); +} + +static enum led_brightness rtl8231_led_brightness_get(struct led_classdev = *led_cdev) +{ + struct rtl8231_led *pled =3D to_rtl8231_led(led_cdev); + u32 current_mode =3D pled->modes->off; + + regmap_field_read(pled->reg_field, ¤t_mode); + + if (current_mode =3D=3D pled->modes->off) + return LED_OFF; + else + return LED_ON; +} + +static unsigned int rtl8231_led_current_interval(struct rtl8231_led *pled) +{ + unsigned int mode; + unsigned int i; + + if (regmap_field_read(pled->reg_field, &mode)) + return 0; + + for (i =3D 0; i < pled->modes->num_toggle_rates; i++) + if (mode =3D=3D pled->modes->toggle_rates[i].mode) + return pled->modes->toggle_rates[i].interval_ms; + + return 0; +} + +static int rtl8231_led_blink_set(struct led_classdev *led_cdev, unsigned l= ong *delay_on, + unsigned long *delay_off) +{ + struct rtl8231_led *pled =3D to_rtl8231_led(led_cdev); + const struct led_toggle_rate *rates =3D pled->modes->toggle_rates; + unsigned int num_rates =3D pled->modes->num_toggle_rates; + unsigned int interval_ms; + unsigned int i; + int err; + + if (*delay_on =3D=3D 0 && *delay_off =3D=3D 0) { + interval_ms =3D RTL8231_DEFAULT_TOGGLE_INTERVAL_MS; + } else { + /* + * If the current mode is blinking, choose the delay that (likely) chang= ed. + * Otherwise, choose the interval that would have the same total delay. + */ + interval_ms =3D rtl8231_led_current_interval(pled); + if (interval_ms > 0 && interval_ms =3D=3D *delay_off) + interval_ms =3D *delay_on; + else if (interval_ms > 0 && interval_ms =3D=3D *delay_on) + interval_ms =3D *delay_off; + else + interval_ms =3D (*delay_on + *delay_off) / 2; + } + + /* Find clamped toggle interval */ + for (i =3D 0; i < (num_rates - 1); i++) + if (interval_ms > rates[i].interval_ms) + break; + + interval_ms =3D rates[i].interval_ms; + + err =3D regmap_field_write(pled->reg_field, rates[i].mode); + if (err) + return err; + + *delay_on =3D interval_ms; + *delay_off =3D interval_ms; + + return 0; +} + +static int rtl8231_led_read_address(struct fwnode_handle *fwnode, unsigned= int *addr_port, + unsigned int *addr_led) +{ + u32 addr[2]; + int err; + + err =3D fwnode_property_count_u32(fwnode, "reg"); + if (err < 0) + return err; + if (err !=3D ARRAY_SIZE(addr)) + return -EINVAL; + + err =3D fwnode_property_read_u32_array(fwnode, "reg", addr, ARRAY_SIZE(ad= dr)); + if (err) + return err; + + *addr_port =3D addr[0]; + *addr_led =3D addr[1]; + + return 0; +} + +static struct regmap_field *rtl8231_led_get_field(struct device *dev, stru= ct regmap *map, + unsigned int port_index, unsigned int led_index) +{ + unsigned int offset =3D port_index / RTL8231_LED_PER_REG; + unsigned int shift =3D (port_index % RTL8231_LED_PER_REG) * RTL8231_BITS_= PER_LED; + const struct reg_field field =3D REG_FIELD(rtl8231_led_base[led_index] + = offset, shift, + shift + RTL8231_BITS_PER_LED - 1); + + return devm_regmap_field_alloc(dev, map, field); +} + +static int rtl8231_led_probe_single(struct device *dev, struct regmap *map, + const unsigned int *port_counts, struct fwnode_handle *fwnode) +{ + struct led_init_data init_data =3D {}; + struct rtl8231_led *pled; + unsigned int port_index; + unsigned int led_index; + int err; + + pled =3D devm_kzalloc(dev, sizeof(*pled), GFP_KERNEL); + if (!pled) + return -ENOMEM; + + err =3D rtl8231_led_read_address(fwnode, &port_index, &led_index); + if (err) { + dev_err(dev, "LED address invalid"); + return err; + } + + if (led_index >=3D RTL8231_NUM_LEDS || port_index >=3D port_counts[led_in= dex]) { + dev_err(dev, "LED address (%d.%d) invalid", port_index, led_index); + return -EINVAL; + } + + pled->reg_field =3D rtl8231_led_get_field(dev, map, port_index, led_index= ); + if (IS_ERR(pled->reg_field)) + return PTR_ERR(pled->reg_field); + + pled->modes =3D &rtl8231_led_modes; + + pled->led.max_brightness =3D 1; + pled->led.brightness_get =3D rtl8231_led_brightness_get; + pled->led.brightness_set =3D rtl8231_led_brightness_set; + pled->led.blink_set =3D rtl8231_led_blink_set; + + init_data.fwnode =3D fwnode; + + return devm_led_classdev_register_ext(dev, &pled->led, &init_data); +} + +static int rtl8231_led_probe(struct platform_device *pdev) +{ + struct device *dev =3D &pdev->dev; + const unsigned int *port_counts; + struct fwnode_handle *child; + struct regmap *map; + int err; + + map =3D dev_get_regmap(dev->parent, NULL); + if (!map) + return -ENODEV; + + if (device_property_match_string(dev, "realtek,led-scan-mode", "single-co= lor") >=3D 0) { + port_counts =3D rtl8231_led_port_counts_single; + regmap_update_bits(map, RTL8231_REG_FUNC0, + RTL8231_FUNC0_SCAN_MODE, RTL8231_FUNC0_SCAN_SINGLE); + } else if (device_property_match_string(dev, "realtek,led-scan-mode", "bi= -color") >=3D 0) { + port_counts =3D rtl8231_led_port_counts_bicolor; + regmap_update_bits(map, RTL8231_REG_FUNC0, + RTL8231_FUNC0_SCAN_MODE, RTL8231_FUNC0_SCAN_BICOLOR); + } else { + dev_err(dev, "scan mode missing or invalid"); + return -EINVAL; + } + + fwnode_for_each_available_child_node(dev->fwnode, child) { + err =3D rtl8231_led_probe_single(dev, map, port_counts, child); + if (err) + dev_warn(dev, "failed to register LED %pfwP", child); + } + + return 0; +} + +static const struct of_device_id of_rtl8231_led_match[] =3D { + { .compatible =3D "realtek,rtl8231-leds" }, + {} +}; +MODULE_DEVICE_TABLE(of, of_rtl8231_led_match); + +static struct platform_driver rtl8231_led_driver =3D { + .driver =3D { + .name =3D "rtl8231-leds", + .of_match_table =3D of_rtl8231_led_match, + }, + .probe =3D rtl8231_led_probe, +}; +module_platform_driver(rtl8231_led_driver); + +MODULE_AUTHOR("Sander Vanheule "); +MODULE_DESCRIPTION("Realtek RTL8231 LED support"); +MODULE_LICENSE("GPL"); --=20 2.51.1 From nobody Tue Dec 2 02:51:10 2025 Received: from polaris.svanheule.net (polaris.svanheule.net [84.16.241.116]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2C7BA34CFB4 for ; Mon, 17 Nov 2025 21:51:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=84.16.241.116 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416321; cv=none; b=upnzrRl08vluuVbTsgQLzPSckgrTsEixhOHO/rHhLrL/dJx+sCZVbzdkGQI/b+Yp98xdFDIPsIMWvWGe2okt4m0rIBVPvNXl2L8Ahiwbdh2/sPXyrbeE/frWO98TfBrNDR0H020d0+Iuv090uwqRhDy2+aitVlfSwvgJhIhtMC0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763416321; c=relaxed/simple; bh=rJqy6GzZyBFkqGBlnC+kbUd2Jg6Ouw8WXt0uyhQGxSM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=RnkVFxUfFsVHrYNQ5a158dtBSJUIrTgyZ9V0hkRJP+Fu1LQ5X7L4SWe5wWKO/7UF/0sHSBmDlxnKDeFxqe3Li7D3qQjeT4fkFEEZHOhg10rpSKmYOnBsLK6IvT2xHSikezlMqeTziYEm+xGpV8eFM93jIfs8YNkre482G/jHGEA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net; spf=pass smtp.mailfrom=svanheule.net; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b=xk9VjEVX; arc=none smtp.client-ip=84.16.241.116 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=svanheule.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=svanheule.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=svanheule.net header.i=@svanheule.net header.b="xk9VjEVX" Received: from terra.vega.svanheule.net (2a02-1812-162c-8f00-1e2d-b404-3319-eba8.ip6.access.telenet.be [IPv6:2a02:1812:162c:8f00:1e2d:b404:3319:eba8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: sander@svanheule.net) by polaris.svanheule.net (Postfix) with ESMTPSA id 062A86A0B61; Mon, 17 Nov 2025 22:51:49 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=svanheule.net; s=mail1707; t=1763416309; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=RD3ewx8m9AdAzNtxCLFnTysOmpu3pl3ZjHoTwYVS87o=; b=xk9VjEVX3krgstltidznYx0O3tqhUz5e3G8+08B2lxkg/LcV06qo1c2JDv9dQ8eXxXIY+/ ZzTOuLSVzIzPPTZ90njg4sMRER+tXE8ERXwH+L5oHRAkMokoIURPKn1t2PoFWd5eIx/YpA WZBv2DfrCXlOehlaOIV6R6OHsiGRpPoDxCupeVTW+3YY93P0nRb6ZIvb8Me0IKLqqKyMWE pG+sBwnyQWwA0E/C7bU71bfwcWXkR7fYdW/8k2iCr2VQe61ucNOBrS5MQALJt7uHrp2vSB lBMUY0R2ubbFnv13m/AHybT6kfQyWgqMhOxGVFvrIfHYhTgt380fizpZ90s5KQ== From: Sander Vanheule To: Lee Jones , Pavel Machek , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Linus Walleij , Michael Walle , Bartosz Golaszewski Cc: linux-leds@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Sander Vanheule Subject: [PATCH v7 6/6] MAINTAINERS: Add RTL8231 MFD driver Date: Mon, 17 Nov 2025 22:51:36 +0100 Message-ID: <20251117215138.4353-7-sander@svanheule.net> X-Mailer: git-send-email 2.51.1 In-Reply-To: <20251117215138.4353-1-sander@svanheule.net> References: <20251117215138.4353-1-sander@svanheule.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Add the files associated with the RTL8231 support, and list Sander Vanheule (myself) as maintainer. Signed-off-by: Sander Vanheule --- MAINTAINERS | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 3da2c26a796b..d0b4e93ec58e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -21656,6 +21656,16 @@ S: Maintained F: Documentation/devicetree/bindings/watchdog/realtek,otto-wdt.yaml F: drivers/watchdog/realtek_otto_wdt.c =20 +REALTEK RTL8231 MFD DRIVER +M: Sander Vanheule +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 M: Alvin =C5=A0ipraga --=20 2.51.1