diff mbox series

[02/13] ASoC: dt-bindings: davinci-mcbsp: Add new properties

Message ID 20240315112745.63230-3-bastien.curutchet@bootlin.com (mailing list archive)
State Superseded
Headers show
Series ASoC: ti: davinci-i2s: Add features to McBSP driver | expand

Commit Message

Bastien Curutchet March 15, 2024, 11:27 a.m. UTC
Following features are not described in the bindings:
 - The McBSP uses an internal sample rate generator to provide bit clock
   or frame clock. This sample rate generator can be programmed to be
   driven by McBSP's internal clock source or by an external clock source
   (located on CLKS pin).
 - McBSP can be configured in 'free-running' mode so that its serial
   clocks will continue to run during emulation halt.
 - McBSP can generate a SYNCERR when unexpected frame pulses are detected

Add an optional clock item that allows to select an external clock as
sample rate generator's input.

Add a 'ti,disable-free-run' flag to disable the free-running mode. This
mode is selected by default by the driver that's why I add a disabling
flag instead of an enabling one.

Add a 'ti,enable-sync-err' flag to enable SYNCERR generation when
unexpected frame pulses are detected.

Signed-off-by: Bastien Curutchet <bastien.curutchet@bootlin.com>
---
 .../devicetree/bindings/sound/davinci-mcbsp.yaml | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

Rob Herring March 17, 2024, 8:06 p.m. UTC | #1
On Fri, 15 Mar 2024 12:27:34 +0100, Bastien Curutchet wrote:
> Following features are not described in the bindings:
>  - The McBSP uses an internal sample rate generator to provide bit clock
>    or frame clock. This sample rate generator can be programmed to be
>    driven by McBSP's internal clock source or by an external clock source
>    (located on CLKS pin).
>  - McBSP can be configured in 'free-running' mode so that its serial
>    clocks will continue to run during emulation halt.
>  - McBSP can generate a SYNCERR when unexpected frame pulses are detected
> 
> Add an optional clock item that allows to select an external clock as
> sample rate generator's input.
> 
> Add a 'ti,disable-free-run' flag to disable the free-running mode. This
> mode is selected by default by the driver that's why I add a disabling
> flag instead of an enabling one.
> 
> Add a 'ti,enable-sync-err' flag to enable SYNCERR generation when
> unexpected frame pulses are detected.
> 
> Signed-off-by: Bastien Curutchet <bastien.curutchet@bootlin.com>
> ---
>  .../devicetree/bindings/sound/davinci-mcbsp.yaml | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 

Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/davinci-mcbsp.yaml b/Documentation/devicetree/bindings/sound/davinci-mcbsp.yaml
index 8b0e9b5da08f..d8d4e7ea6e02 100644
--- a/Documentation/devicetree/bindings/sound/davinci-mcbsp.yaml
+++ b/Documentation/devicetree/bindings/sound/davinci-mcbsp.yaml
@@ -50,12 +50,16 @@  properties:
       - const: tx
 
   clocks:
+    minItems: 1
     items:
       - description: functional clock
+      - description: external input clock for sample rate generator.
 
   clock-names:
+    minItems: 1
     items:
       - const: fck
+      - const: clks
 
   power-domains:
     description: phandle to the corresponding power-domain
@@ -64,6 +68,18 @@  properties:
   "#sound-dai-cells":
     const: 0
 
+  ti,disable-free-run:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Disable free-running mode. If not present, serial clocks continue to run
+      during emulation halt.
+
+  ti,enable-sync-err:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Enable synchronisation error detections when an unexpected frame pulse is
+      received. If not present, unexpected frame pulses are ignored.
+
 required:
   - "#sound-dai-cells"
   - compatible