xref: /linux/Documentation/devicetree/bindings/sound/fsl,easrc.yaml (revision 7318234c8d7c0f209f993ee46a7ea148efdb28b9) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/fsl,easrc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: NXP Asynchronous Sample Rate Converter (ASRC) Controller
8
9maintainers:
10  - Shengjiu Wang <shengjiu.wang@nxp.com>
11
12properties:
13  $nodename:
14    pattern: "^easrc@.*"
15
16  compatible:
17    const: fsl,imx8mn-easrc
18
19  reg:
20    maxItems: 1
21
22  interrupts:
23    maxItems: 1
24
25  clocks:
26    items:
27      - description: Peripheral clock
28
29  clock-names:
30    items:
31      - const: mem
32
33  dmas:
34    maxItems: 8
35
36  dma-names:
37    items:
38      - const: ctx0_rx
39      - const: ctx0_tx
40      - const: ctx1_rx
41      - const: ctx1_tx
42      - const: ctx2_rx
43      - const: ctx2_tx
44      - const: ctx3_rx
45      - const: ctx3_tx
46
47  firmware-name:
48    allOf:
49      - $ref: /schemas/types.yaml#/definitions/string
50      - const: imx/easrc/easrc-imx8mn.bin
51    description: The coefficient table for the filters
52
53  fsl,asrc-rate:
54    allOf:
55      - $ref: /schemas/types.yaml#/definitions/uint32
56      - minimum: 8000
57      - maximum: 192000
58    description: Defines a mutual sample rate used by DPCM Back Ends
59
60  fsl,asrc-format:
61    allOf:
62      - $ref: /schemas/types.yaml#/definitions/uint32
63      - enum: [2, 6, 10, 32, 36]
64        default: 2
65    description:
66      Defines a mutual sample format used by DPCM Back Ends
67
68required:
69  - compatible
70  - reg
71  - interrupts
72  - clocks
73  - clock-names
74  - dmas
75  - dma-names
76  - firmware-name
77  - fsl,asrc-rate
78  - fsl,asrc-format
79
80examples:
81  - |
82    #include <dt-bindings/clock/imx8mn-clock.h>
83
84    easrc: easrc@300c0000 {
85           compatible = "fsl,imx8mn-easrc";
86           reg = <0x0 0x300c0000 0x0 0x10000>;
87           interrupts = <0x0 122 0x4>;
88           clocks = <&clk IMX8MN_CLK_ASRC_ROOT>;
89           clock-names = "mem";
90           dmas = <&sdma2 16 23 0> , <&sdma2 17 23 0>,
91                  <&sdma2 18 23 0> , <&sdma2 19 23 0>,
92                  <&sdma2 20 23 0> , <&sdma2 21 23 0>,
93                  <&sdma2 22 23 0> , <&sdma2 23 23 0>;
94           dma-names = "ctx0_rx", "ctx0_tx",
95                       "ctx1_rx", "ctx1_tx",
96                       "ctx2_rx", "ctx2_tx",
97                       "ctx3_rx", "ctx3_tx";
98           firmware-name = "imx/easrc/easrc-imx8mn.bin";
99           fsl,asrc-rate  = <8000>;
100           fsl,asrc-format = <2>;
101    };
102