dt-bindings: pinctrl: convert nsp-gpio binding
Subsystems (3)
PATCH v2 1/1 dt-bindings: pinctrl: convert nsp-gpio binding
The brcm,nsp-gpio-a compatible used by the NSP GPIO controller was only documented in the legacy text binding, so dtbs_check reported "failed to match any schema" for the gpio@20 node present in the bcm958625 and related broadcom boards.
Convert Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.txt to a YAML schema and drop the text binding. Keep the existing required and optional properties (reg, #gpio-cells, gpio-controller, ngpios, and the optional interrupt/gpio-ranges support), including the generic pinconf child nodes with pin bias and drive-strength.
Pin configuration nodes may be direct children of the controller or grouped under a "-pins" node; both forms are recognized, and each "-pins" node may group further pin configuration children. Child nodes named "-hog" are supported as GPIO hogs.
---
v2: don't drop gpio-hog
.../bindings/pinctrl/brcm,nsp-gpio.txt | 80 ---------- .../bindings/pinctrl/brcm,nsp-gpio.yaml | 139 ++++++++++++++++++ 2 files changed, 139 insertions(+), 80 deletions(-) delete mode 100644 Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.txt create mode 100644 Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.txt deleted +0 -80
@@ -1,80 +0,0 @@ -Broadcom Northstar plus (NSP) GPIO/PINCONF Controller - -Required properties: -- compatible: - Must be "brcm,nsp-gpio-a" - -- reg: - Should contain the register physical address and length for each of - GPIO base, IO control registers - -- #gpio-cells: - Must be two. The first cell is the GPIO pin number (within the - controller's pin space) and the second cell is used for the following: - bit[0]: polarity (0 for active high and 1 for active low) - -- gpio-controller: - Specifies that the node is a GPIO controller - -- ngpios: - Number of gpios supported (58x25 supports 32 and 58x23 supports 24) - -Optional properties: -- interrupts: - Interrupt ID - -- interrupt-controller: - Specifies that the node is an interrupt controller - -- gpio-ranges: - Specifies the mapping between gpio controller and pin-controllers pins. - This requires 4 fields in cells defined as - - 1. Phandle of pin-controller. - 2. GPIO base pin offset. - 3 Pin-control base pin offset. - 4. number of gpio pins which are linearly mapped from pin base. - -Supported generic PINCONF properties in child nodes: -- pins: - The list of pins (within the controller's own pin space) that properties - in the node apply to. Pin names are "gpio-<pin>" - -- bias-disable: - Disable pin bias - -- bias-pull-up: - Enable internal pull up resistor - -- bias-pull-down: - Enable internal pull down resistor - -- drive-strength: - Valid drive strength values include 2, 4, 6, 8, 10, 12, 14, 16 (mA) - -Example: - - gpioa: gpio@18000020 { - compatible = "brcm,nsp-gpio-a"; - reg = <0x18000020 0x100>, - <0x1803f1c4 0x1c>; - #gpio-cells = <2>; - gpio-controller; - ngpios = <32>; - gpio-ranges = <&pinctrl 0 0 31>; - interrupt-controller; - interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>; - - /* Hog a few default settings */ - pinctrl-names = "default"; - pinctrl-0 = <&led>; - led: led { - pins = "gpio-1"; - bias-pull-up; - }; - - pwr: pwr { - gpio-hog; - gpios = <3 1>; - output-high; - }; - };
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +139 -0
139 lines not on this page · raw message
Signature · 1 line
2.55.0
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [High] dt-bindings: validation failure due to top-level additionalProperties restricting scalar…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] dt-bindings: validation failure due to top-level additionalProperties restricting scalar properties
- [Medium] dt-bindings: missing constraint in nsp-gpio-pinconf bypasses typo validation
--
commit 7f4d084d5f13cdd135dd4287165b9406e5c21963
Author: Rosen Penev <[email protected]>
dt-bindings: pinctrl: convert nsp-gpio binding
The brcm,nsp-gpio-a compatible used by the NSP GPIO controller was only documented in the legacy text binding, so dtbs_check reported "failed to match any schema" for the gpio@20 node present in the bcm958625 and related broadcom boards.
Quoted 5 lines
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +0
-0
[ ... ]
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml line 65
Quoted 6 lines
+$defs:
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +5
-0+ nsp-gpio-pinconf: + type: object + allOf: + - $ref: pincfg-node.yaml# + - $ref: pinmux-node.yaml#
[Severity: Medium]
Will this allow misspelled or unsupported properties inside pin configuration child nodes to pass validation?
Because neither additionalProperties: false nor unevaluatedProperties: false is specified in this definition, the object schema relies on default JSON schema behavior, which permits arbitrary undefined properties. Properties like bias-pullup (typo) or slew-rate (unsupported) will pass dtbs_check without warning.
[ ... ]
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml
Quoted 2 lines
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +2
-0+additionalProperties: + $ref: '#/$defs/nsp-gpio-pinconf'
[Severity: High]
Does this inappropriately apply pinconf constraints to all unmatched top-level properties?
In JSON Schema, this forces all properties not explicitly listed in the properties block to conform to $defs/nsp-gpio-pinconf. Since that reference enforces type: object and requires a pins property, scalar or array properties will unconditionally fail.
Device trees utilizing this controller and standard generic properties (like pinctrl-names or implicit ones like phandle) will fail schema validation.
[ ... ]
Quoted 9 lines
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +9
-0+examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + + gpio@18000020 { + compatible = "brcm,nsp-gpio-a"; + reg = <0x18000020 0x100>, + <0x1803f1c4 0x1c>; + #gpio-cells = <2>;
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml line 118
Quoted 10 lines
Documentation/devicetree/bindings/pinctrl/brcm,nsp-gpio.yaml new file +10
-0+ gpio-controller; + ngpios = <32>; + gpio-ranges = <&pinctrl 0 0 31>; + interrupt-controller; + #interrupt-cells = <2>; + interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>; + + /* Pin configuration node applied as a pinctrl state */ + pinctrl-names = "default"; + pinctrl-0 = <&led>;
[Severity: High]
Will these standard properties in the example fail validation?
Because of the additionalProperties directive restricting scalar properties, pinctrl-names and pinctrl-0 will fail validation because they are not objects and lack a pins property.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1