diff mbox series

[04/12] dt-bindings: pinctrl: Add Cirrus Logic CS48L31/32/33

Message ID 20221109165331.29332-5-rf@opensource.cirrus.com
State New
Headers
Series Add support for the Cirrus Logic CS48L32 audio codecs |

Commit Message

Richard Fitzgerald Nov. 9, 2022, 4:53 p.m. UTC 
  Codecs in this family have multiple digital I/O functions for audio,
DSP subsystem, GPIO and various special functions. All muxable pins
are selectable as either a GPIO or one of the available alternate
functions.

Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
---
 .../bindings/pinctrl/cirrus,cs48l32.yaml      | 98 +++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml

Comments

Rob Herring Nov. 9, 2022, 9:09 p.m. UTC | #1 
On Wed, 09 Nov 2022 16:53:23 +0000, Richard Fitzgerald wrote:
> Codecs in this family have multiple digital I/O functions for audio,
> DSP subsystem, GPIO and various special functions. All muxable pins
> are selectable as either a GPIO or one of the available alternate
> functions.
> 
> Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
> ---
>  .../bindings/pinctrl/cirrus,cs48l32.yaml      | 98 +++++++++++++++++++
>  1 file changed, 98 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml:14:1: [error] syntax error: could not find expected ':' (syntax)

dtschema/dtc warnings/errors:
make[1]: *** Deleting file 'Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.example.dts'
Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml:14:1: could not find expected ':'
make[1]: *** [Documentation/devicetree/bindings/Makefile:26: Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.example.dts] Error 1
make[1]: *** Waiting for unfinished jobs....
./Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml:14:1: could not find expected ':'
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml: ignoring, error parsing file
make: *** [Makefile:1492: dt_binding_check] Error 2

doc reference errors (make refcheckdocs):
Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml: Documentation/devicetree/bindings/mfd/cirrus,cs48l32.yaml

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Krzysztof Kozlowski Nov. 14, 2022, 8:39 a.m. UTC | #2 
On 09/11/2022 17:53, Richard Fitzgerald wrote:
> Codecs in this family have multiple digital I/O functions for audio,
> DSP subsystem, GPIO and various special functions. All muxable pins
> are selectable as either a GPIO or one of the available alternate
> functions.
> 
> Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
> ---
>  .../bindings/pinctrl/cirrus,cs48l32.yaml      | 98 +++++++++++++++++++
>  1 file changed, 98 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml b/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
> new file mode 100644
> index 000000000000..b24fbae6a8f8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
> @@ -0,0 +1,98 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pinctrl/cirrus,cs48l32.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Cirrus Logic CS48L32 audio codec pinctrl driver

Drop driver.
s/pinctrl/Pin Controller/


> +
> +maintainers:
> +  - patches@opensource.cirrus.com
> +
> +description: |
> +The Cirrus Logic CS48L32 codec has a number of GPIO functions for
> +interfacing to external hardware. Certain groups of GPIO pins also
> +have an alternate function.
> +
> +The properties for this driver exist within the parent MFD driver node.

Drop driver... so probably entire sentence.

> +See the core bindings for the parent MFD driver for an example:

Drop driver. Describe hardware instead.

> +
> +    Documentation/devicetree/bindings/mfd/cirrus,cs48l32.yaml
> +
> +And the generic pinctrl bindings:
> +
> +    Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt

Drop entire sentence.

> +
> +properties:

Your schema does not match on its own. Where is the compatible? This is
not how schemas for devices (also MFD) is done.

> +  pin-settings:
> +    description:
> +      One subnode is required to contain the default settings. It
> +      contains an arbitrary number of configuration subnodes, one for
> +      each group or pin configuration you want to apply as a default.
> +    type: object
> +    patternProperties:
> +      '-pins$':
> +        type: object
> +        allOf:
> +          - $ref: "pincfg-node.yaml#"
> +          - $ref: "pinmux-node.yaml#"

Drop quotes.

Except this, test your patches before sending.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml b/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
new file mode 100644
index 000000000000..b24fbae6a8f8
--- /dev/null
+++ b/Documentation/devicetree/bindings/pinctrl/cirrus,cs48l32.yaml
@@ -0,0 +1,98 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pinctrl/cirrus,cs48l32.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cirrus Logic CS48L32 audio codec pinctrl driver
+
+maintainers:
+  - patches@opensource.cirrus.com
+
+description: |
+The Cirrus Logic CS48L32 codec has a number of GPIO functions for
+interfacing to external hardware. Certain groups of GPIO pins also
+have an alternate function.
+
+The properties for this driver exist within the parent MFD driver node.
+See the core bindings for the parent MFD driver for an example:
+
+    Documentation/devicetree/bindings/mfd/cirrus,cs48l32.yaml
+
+And the generic pinctrl bindings:
+
+    Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
+
+properties:
+  pin-settings:
+    description:
+      One subnode is required to contain the default settings. It
+      contains an arbitrary number of configuration subnodes, one for
+      each group or pin configuration you want to apply as a default.
+    type: object
+    patternProperties:
+      '-pins$':
+        type: object
+        allOf:
+          - $ref: "pincfg-node.yaml#"
+          - $ref: "pinmux-node.yaml#"
+        properties:
+          groups:
+            description:
+              Name of one pin group to configure.
+            enum: [ asp1, asp2, in1-pdm, in2-pdm,
+                    gpio1, gpio2, gpio3, gpio4, gpio5, gpio6, gpio7,
+                    gpio8, gpio9, gpio10, gpio11, gpio12, gpio13,
+                    gpio14, gpio15, gpio16 ]
+
+          function:
+            description:
+              Name of function to assign to this group.
+            enum: [ asp1, asp2, in1-pdm, in2-pdm, spi2, io, dsp-gpio,
+                    irq1, fll1-clk, fll1-lock, opclk, opclk-dsp, uart,
+                    input-path-signal-detect,
+                    ultrasonic-in1-activity-detect, ultrasonic-in2-activity-detect,
+                    dma-ch0-programmable-transfer-complete,
+                    dma-ch1-programmable-transfer-complete,
+                    dma-ch2-programmable-transfer-complete,
+                    dma-ch3-programmable-transfer-complete,
+                    dma-ch4-programmable-transfer-complete,
+                    dma-ch5-programmable-transfer-complete,
+                    dma-ch6-programmable-transfer-complete,
+                    dma-ch7-programmable-transfer-complete,
+                    sample-rate-change-trigger-a, sample-rate-change-trigger-b,
+                    sample-rate-change-trigger-c, sample-rate-change-trigger-d,
+                    timer1-irq-ch1, timer1-irq-ch2, timer1-irq-ch3, timer1-irq-ch4,
+                    timer2-irq-ch1, timer2-irq-ch2, timer2-irq-ch3, timer2-irq-ch4,
+                    timer3-irq-ch1, timer3-irq-ch2, timer3-irq-ch3, timer3-irq-ch4,
+                    timer4-irq-ch1, timer4-irq-ch2, timer4-irq-ch3, timer4-irq-ch4,
+                    timer5-irq-ch1, timer5-irq-ch2, timer5-irq-ch3, timer5-irq-ch4,
+                    timer-1, timer-2, timer-3, timer-4, timer-5 ]
+
+          bias-disable: true
+
+          bias-bus-hold: true
+
+          bias-pull-up: true
+
+          bias-pull-down: true
+
+          drive-push-pull: true
+
+          drive-open-drain: true
+
+          drive-strength:
+            description:
+              Drive strength in mA.
+            enum: [ 4, 8 ]
+
+          output-low: true
+
+          output-high: true
+
+        additionalProperties: false
+
+        required:
+          - groups
+
+    additionalProperties: false