Received-SPF: pass (google.com: domain of linux-kernel+bounces-104334-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: Bastien Curutchet <bastien.curutchet@bootlin.com>
To: Liam Girdwood <lgirdwood@gmail.com>,
	Mark Brown <broonie@kernel.org>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Peter Ujfalusi <peter.ujfalusi@gmail.com>,
	Jaroslav Kysela <perex@perex.cz>,
	Takashi Iwai <tiwai@suse.com>,
	Bastien Curutchet <bastien.curutchet@bootlin.com>
Cc: linux-sound@vger.kernel.org,
	devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	alsa-devel@alsa-project.org,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	herve.codina@bootlin.com,
	christophercordahi@nanometrics.ca
Subject: [PATCH 02/13] ASoC: dt-bindings: davinci-mcbsp: Add new properties
Date: Fri, 15 Mar 2024 12:27:34 +0100
Message-ID: <20240315112745.63230-3-bastien.curutchet@bootlin.com>
In-Reply-To: <20240315112745.63230-1-bastien.curutchet@bootlin.com>
References: <20240315112745.63230-1-bastien.curutchet@bootlin.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

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(+)

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
-- 
2.43.2