xref: /freebsd/sys/contrib/device-tree/Bindings/sound/renesas,rz-ssi.yaml (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/renesas,rz-ssi.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Renesas RZ/{G2L,V2L} ASoC Sound Serial Interface (SSIF-2)
8
9maintainers:
10  - Biju Das <biju.das.jz@bp.renesas.com>
11
12allOf:
13  - $ref: dai-common.yaml#
14
15properties:
16  compatible:
17    items:
18      - enum:
19          - renesas,r9a07g043-ssi  # RZ/G2UL and RZ/Five
20          - renesas,r9a07g044-ssi  # RZ/G2{L,LC}
21          - renesas,r9a07g054-ssi  # RZ/V2L
22      - const: renesas,rz-ssi
23
24  reg:
25    maxItems: 1
26
27  interrupts:
28    minItems: 2
29    maxItems: 3
30
31  interrupt-names:
32    oneOf:
33      - items:
34          - const: int_req
35          - const: dma_rx
36          - const: dma_tx
37      - items:
38          - const: int_req
39          - const: dma_rt
40
41  clocks:
42    maxItems: 4
43
44  clock-names:
45    items:
46      - const: ssi
47      - const: ssi_sfr
48      - const: audio_clk1
49      - const: audio_clk2
50
51  power-domains:
52    maxItems: 1
53
54  resets:
55    maxItems: 1
56
57  dmas:
58    minItems: 1
59    maxItems: 2
60    description:
61      The first cell represents a phandle to dmac.
62      The second cell specifies the encoded MID/RID values of the SSI port
63      connected to the DMA client and the slave channel configuration
64      parameters.
65      bits[0:9]   - Specifies MID/RID value of a SSI channel as below
66                    MID/RID value of SSI rx0 = 0x256
67                    MID/RID value of SSI tx0 = 0x255
68                    MID/RID value of SSI rx1 = 0x25a
69                    MID/RID value of SSI tx1 = 0x259
70                    MID/RID value of SSI rt2 = 0x25f
71                    MID/RID value of SSI rx3 = 0x262
72                    MID/RID value of SSI tx3 = 0x261
73      bit[10]     - HIEN = 1, Detects a request in response to the rising edge
74                    of the signal
75      bit[11]     - LVL = 0, Detects based on the edge
76      bits[12:14] - AM = 2, Bus cycle mode
77      bit[15]     - TM = 0, Single transfer mode
78
79  dma-names:
80    oneOf:
81      - items:
82          - const: tx
83          - const: rx
84      - items:
85          - const: rt
86
87  '#sound-dai-cells':
88    const: 0
89
90required:
91  - compatible
92  - reg
93  - interrupts
94  - interrupt-names
95  - clocks
96  - clock-names
97  - resets
98  - '#sound-dai-cells'
99
100unevaluatedProperties: false
101
102examples:
103  - |
104    #include <dt-bindings/interrupt-controller/arm-gic.h>
105    #include <dt-bindings/clock/r9a07g044-cpg.h>
106
107    ssi0: ssi@10049c00 {
108        compatible = "renesas,r9a07g044-ssi",
109                     "renesas,rz-ssi";
110            reg = <0x10049c00 0x400>;
111            interrupts = <GIC_SPI 326 IRQ_TYPE_LEVEL_HIGH>,
112                         <GIC_SPI 327 IRQ_TYPE_EDGE_RISING>,
113                         <GIC_SPI 328 IRQ_TYPE_EDGE_RISING>;
114            interrupt-names = "int_req", "dma_rx", "dma_tx";
115            clocks = <&cpg CPG_MOD R9A07G044_SSI0_PCLK2>,
116                     <&cpg CPG_MOD R9A07G044_SSI0_PCLK_SFR>,
117                     <&audio_clk1>,
118                     <&audio_clk2>;
119            clock-names = "ssi", "ssi_sfr", "audio_clk1", "audio_clk2";
120            power-domains = <&cpg>;
121            resets = <&cpg R9A07G044_SSI0_RST_M2_REG>;
122            dmas = <&dmac 0x2655>,
123                   <&dmac 0x2656>;
124            dma-names = "tx", "rx";
125            #sound-dai-cells = <0>;
126    };
127