On Tue, Jul 26, 2022 at 4:05 AM Krzysztof Kozlowski < krzysztof.kozlowski@linaro.org> wrote:
On 25/07/2022 11:31, Shengjiu Wang wrote:
Convert the NXP SAI binding to DT schema format using json-schema.
The Synchronous Audio Interface (SAI) provides an interface that supports full-duplex serial interfaces with frame synchronization formats such as I2S, AC97, TDM, and codec/DSP interfaces.
Signed-off-by: Shengjiu Wang shengjiu.wang@nxp.com
.../devicetree/bindings/sound/fsl,sai.yaml | 175 ++++++++++++++++++ .../devicetree/bindings/sound/fsl-sai.txt | 95 ---------- 2 files changed, 175 insertions(+), 95 deletions(-) create mode 100644 Documentation/devicetree/bindings/sound/fsl,sai.yaml delete mode 100644 Documentation/devicetree/bindings/sound/fsl-sai.txt
diff --git a/Documentation/devicetree/bindings/sound/fsl,sai.yaml
b/Documentation/devicetree/bindings/sound/fsl,sai.yaml
new file mode 100644 index 000000000000..adcd77531eba --- /dev/null +++ b/Documentation/devicetree/bindings/sound/fsl,sai.yaml @@ -0,0 +1,175 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/fsl,sai.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Freescale Synchronous Audio Interface (SAI).
+maintainers:
- Shengjiu Wang shengjiu.wang@nxp.com
+description: |
- The SAI is based on I2S module that used communicating with audio
codecs,
- which provides a synchronous audio interface that supports fullduplex
- serial interfaces with frame synchronization such as I2S, AC97, TDM,
and
- codec/DSP interfaces.
+properties:
- compatible:
- minItems: 1
- maxItems: 2
You allow anything here, so it's not acceptable. This has to be strictly defined.
ok, I will update it.
- items:
enum:- fsl,vf610-sai- fsl,imx6sx-sai- fsl,imx6ul-sai- fsl,imx7ulp-sai- fsl,imx8mq-sai- fsl,imx8qm-sai- fsl,imx8mm-sai- fsl,imx8mn-sai- fsl,imx8mp-sai- fsl,imx8ulp-sai- reg:
- maxItems: 1
- interrupts:
- items:
- description: receive and transmit interrupt- dmas:
- minItems: 2
No need for minItems.
ok
- maxItems: 2
- description:
Must contain a list of pairs of references to DMA specifiers, onefor
transmission, and one for reception.Skip description and instead describe items like you did for interrupts.
ok, will update it
- dma-names:
- minItems: 2
- maxItems: 2
- items:
enum:- tx- rxNo, this has to be strictly defined, so items with tx and rx (or reversed order).
two kind of order is needed, seems I need to use if - then -else
- clocks:
- minItems: 4
- items:
- description: The ipg clock for register access- description: master clock source 0 (obsoleted, compatible forold dts)
- description: master clock source 1- description: master clock source 2- description: master clock source 3- description: PLL clock source for 8kHz series- description: PLL clock source for 11kHz series- clock-names:
- minItems: 4
- maxItems: 7
- items:
enum:- bus- mclk0- mclk1- mclk2- mclk3- pll8k- pll11kDitto. minItems:4 could stay, but the rest is not correct. This has to be strictly ordered/defined list.
ok, I will update it, also I need two orders.
- lsb-first:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
Configures whether the LSB or the MSB is transmittedfirst for the fifo data. If this property is absent,the MSB is transmitted first as default, or the LSBis transmitted first.- big-endian:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
Boolean property, required if all the SAIregisters are big-endian rather than little-endian.- fsl,sai-synchronous-rx:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
This is a boolean property.Skip such description, it's useless... Further as well.
If present, indicating
that SAI will work in the synchronous mode (sync Txwith Rx) which means both the transmitter and thereceiver will send and receive data by followingreceiver's bit clocks and frame sync clocks.fsl,sai-asynchronous and fsl,sai-synchronous-rx are exclusive.- fsl,sai-asynchronous:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
This is a boolean property. If present, indicatingthat SAI will work in the asynchronous mode, whichmeans both transmitter and receiver will send andreceive data by following their own bit clocks andframe sync clocks separately.If both fsl,sai-asynchronous and fsl,sai-synchronous-rx areabsent, the
default synchronous mode (sync Rx with Tx) will be used, whichmeans both
transmitter and receiver will send and receive data by followingclocks
of transmitter.fsl,sai-asynchronous and fsl,sai-synchronous-rx are exclusive.- fsl,dataline:
- $ref: /schemas/types.yaml#/definitions/uint32-matrix
- description: |
configure the dataline. it has 3 value for each configurationfirst one means the type: I2S(1) or PDM(2)second one is dataline mask for 'rx'third one is dataline mask for 'tx'.for example: fsl,dataline = <1 0xff 0xff 2 0xff 0x11>;it means I2S type rx mask is 0xff, tx mask is 0xff, PDM typerx mask is 0xff, tx mask is 0x11 (dataline 1 and 5 enabled).- fsl,sai-mclk-direction-output:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
This is a boolean property. If present,indicates that SAI will output the SAI MCLK clock.- fsl,shared-interrupt:
- $ref: /schemas/types.yaml#/definitions/flag
- description: |
This is a boolean property. If present,indicates that interrupt is shared with other modules.- "#sound-dai-cells":
- const: 0
+required:
- compatible
- reg
- interrupts
- dmas
- dma-names
- clocks
- clock-names
You need to express the exclusiveness of properties. allOf:if:required:then:... would work, like here:
https://elixir.bootlin.com/linux/v5.17-rc2/source/Documentation/devicetree/b...
Yes, that is I wanted
best regards wang shengjiu
Best regards, Krzysztof