lkml.org 
[lkml]   [2021]   [Dec]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v4] ASoC: dt-bindings: davinci-mcasp: convert McASP bindings to yaml schema
Hi,

On 03/12/2021 14:02, Jayesh Choudhary wrote:
> Convert the bindings for McASP controllers for TI SOCs from txt
> to YAML schema.
>
> Adds additional properties 'clocks', 'clock-names', 'power-domains',
> '#sound-dai-cells' and 'port' which were missing from txt file.
> Removes properties 'sram-size-playback' and 'sram-size-capture'
> since they are not used.
> Adds 'dmas' and 'dma-names' in the example which were missing from
> the txt file.
> Changes 'interrupts' and 'interrupt-names' from optional to
> required properties.
> Changes 'op-mode', 'serial-dir' and 'tdm-slots' to optional properties
> as they are not needed if the McASP is used only as GPIO.
>
> Adds the yaml file in the 'MAINTAINERS' under the heading 'TEXAS
> INSTRUMENTS ASoC DRIVERS'
>
> Signed-off-by: Jayesh Choudhary <j-choudhary@ti.com>
> ---
> Changelog:
> v4:
> - changes the commit message
> - adds type and description to relevant properties
> - changes maxItems for 'serial-dir'
> - removes properties 'sram-size-playback' and 'sram-size-capture'
> as they are not used
> - removes 'function-gpios'
> - removes 'num-serializer'
> - marks 'tdm-slots', 'serial-dir' and 'op-mode' as optional properties
> - adds the yaml file in MAINTAINERS
>

...

> diff --git a/Documentation/devicetree/bindings/sound/davinci-mcasp-audio.yaml b/Documentation/devicetree/bindings/sound/davinci-mcasp-audio.yaml
> new file mode 100644
> index 000000000000..5b553c90771a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/davinci-mcasp-audio.yaml
> @@ -0,0 +1,185 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/davinci-mcasp-audio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: McASP Controller for TI SoCs
> +
> +maintainers:
> + - Jayesh Choudhary <j-choudhary@ti.com>
> +
> +properties:
> + compatible:
> + enum:
> + - ti,dm646x-mcasp-audio
> + - ti,da830-mcasp-audio
> + - ti,am33xx-mcasp-audio
> + - ti,dra7-mcasp-audio
> + - ti,omap4-mcasp-audio
> +
> + reg:
> + minItems: 1
> + items:
> + - description: main registers

The TRM refers to this area as CFG registers

> + - description: data port register

Data registers

> +
> + reg-names:
> + minItems: 1
> + items:
> + - const: mpu
> + - const: dat
> +
> + op-mode:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: I2S - 0 or DIT - 1 operation mode

0 - I2S, or 1 - DIT operation mode

> + enum:
> + - 0
> + - 1
> +
> + tdm-slots:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: number of channels over one serializer
> + maxItems: 1

and it has to be between 2 and 32, ignored in DIT mode (384 slots)

> +
> + serial-dir:
> + description:
> + A list of serializer configuration
> + Entry is indication for serializer pin direction
> + 0 - Inactive, 1 - TX, 2 - RX
> + All AXR pins should be present in the array even if inactive
> + $ref: /schemas/types.yaml#/definitions/uint32-array
> + minItems: 1
> + maxItems: 25
> + items:
> + minimum: 0
> + maximum: 2
> + default: 0

There is no default as all pins must be accounted for.

> +
> + dmas:
> + minItems: 1
> + items:
> + - description: transmission DMA channel
> + - description: reception DMA channel
> +
> + dma-names:
> + minItems: 1
> + items:
> + - const: tx
> + - const: rx
> +
> + ti,hwmods:
> + $ref: /schemas/types.yaml#/definitions/string
> + description: Name of hwmod associated with McASP
> + maxItems: 1
> + deprecated: true
> +
> + tx-num-evt:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: configures WFIFO threshold

0 disables the FIFO use
If the property is missing, it also disables the FIFO use.

> + maxItems: 1
> +
> + rx-num-evt:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: configures RFIFO threshold
> + maxItems: 1
> +
> + dismod:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description:
> + specify the drive on TX pin during inactive time slots
> + 0 - 3-state, 2 - logic low, 3 - logic high
> + enum:
> + - 0
> + - 2
> + - 3
> + default: 2
> +
> + interrupts:
> + anyOf:
> + - minItems: 1
> + items:
> + - description: TX FIFO interrupt
> + - description: RX FIFO interrupt
> + - items:
> + - description: common FIFO interrupt

These has nothing to do with FIFO, they are just transmit, receive and
common or combined

> +
> + interrupt-names:
> + oneOf:
> + - minItems: 1
> + items:
> + - const: tx
> + - const: rx
> + - const: common
> +
> + fck_parent:
> + $ref: /schemas/types.yaml#/definitions/string
> + description: parent clock name for McASP fck
> + maxItems: 1
> +
> + auxclk-fs-ratio:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: ratio of AUCLK and FS rate if applicable
> + maxItems: 1
> +
> + gpio-controller: true
> +
> + "#gpio-cells":
> + const: 2
> +
> + clocks:
> + minItems: 1
> + items:
> + - description: functional clock
> + - description: module specific optional ahclkx clock
> + - description: module specific optional ahclkr clock
> +
> + clock-names:
> + minItems: 1
> + items:
> + - const: fck
> + - const: ahclkx
> + - const: ahclkr
> +
> + power-domains:
> + description: phandle to the corresponding power-domain
> + maxItems: 1
> +
> + "#sound-dai-cells":
> + const: 0
> +
> + port:
> + description: connection for when McASP is used via graph card
> + type: object

I understand that it can be present under the mcasp node as it is part
of the graph card binding (or a card binding using graph).
I mean if a new card binding comes around then we need to document it
here as well?

> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - dmas
> + - dma-names
> + - interrupts
> + - interrupt-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + mcasp0: mcasp0@1d00000 {
> + compatible = "ti,da830-mcasp-audio";
> + reg = <0x100000 0x3000>;
> + reg-names = "mpu";
> + interrupts = <82>, <83>;
> + interrupt-names = "tx", "rx";
> + op-mode = <0>; /* MCASP_IIS_MODE */
> + tdm-slots = <2>;
> + dmas = <&main_udmap 0xc400>, <&main_udmap 0x4400>;
> + dma-names = "tx", "rx";
> + serial-dir = <
> + 0 0 0 0 /* 0: INACTIVE, 1: TX, 2: RX */
> + 0 0 0 0
> + 0 0 0 1
> + 2 0 0 0 >;
> + tx-num-evt = <1>;
> + rx-num-evt = <1>;
> + };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 00ad0cb5cb05..3fdf1e23f7d7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -18855,6 +18855,7 @@ TEXAS INSTRUMENTS ASoC DRIVERS
> M: Peter Ujfalusi <peter.ujfalusi@gmail.com>
> L: alsa-devel@alsa-project.org (moderated for non-subscribers)
> S: Maintained
> +F: Documentation/devicetree/bindings/sound/davinci-mcasp-audio.yaml
> F: sound/soc/ti/
>
> TEXAS INSTRUMENTS' DAC7612 DAC DRIVER
>

--
Péter

\
 
 \ /
  Last update: 2021-12-04 09:21    [W:0.066 / U:4.488 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site