Linux 6.7-rc7
[linux-modified.git] / Documentation / devicetree / bindings / sound / renesas,fsi.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/sound/renesas,fsi.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Renesas FIFO-buffered Serial Interface (FSI)
8
9 maintainers:
10   - Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
11
12 allOf:
13   - $ref: dai-common.yaml#
14
15 properties:
16   $nodename:
17     pattern: "^sound@.*"
18
19   compatible:
20     oneOf:
21       # for FSI2 SoC
22       - items:
23           - enum:
24               - renesas,fsi2-sh73a0  # SH-Mobile AG5
25               - renesas,fsi2-r8a7740 # R-Mobile A1
26           - enum:
27               - renesas,sh_fsi2
28       # for Generic
29       - items:
30           - enum:
31               - renesas,sh_fsi
32               - renesas,sh_fsi2
33
34   reg:
35     maxItems: 1
36
37   interrupts:
38     maxItems: 1
39
40   clocks:
41     maxItems: 1
42
43   power-domains:
44     maxItems: 1
45
46   '#sound-dai-cells':
47     const: 1
48
49 patternProperties:
50   "^fsi(a|b),spdif-connection$":
51     $ref: /schemas/types.yaml#/definitions/flag
52     description: FSI is connected by S/PDIF
53
54   "^fsi(a|b),stream-mode-support$":
55     $ref: /schemas/types.yaml#/definitions/flag
56     description: FSI supports 16bit stream mode
57
58   "^fsi(a|b),use-internal-clock$":
59     $ref: /schemas/types.yaml#/definitions/flag
60     description: FSI uses internal clock when master mode
61
62 required:
63   - compatible
64   - reg
65   - interrupts
66   - clocks
67   - power-domains
68   - '#sound-dai-cells'
69
70 unevaluatedProperties: false
71
72 examples:
73   - |
74     #include <dt-bindings/clock/r8a7740-clock.h>
75     #include <dt-bindings/interrupt-controller/arm-gic.h>
76     sh_fsi2: sound@fe1f0000 {
77             compatible = "renesas,fsi2-r8a7740", "renesas,sh_fsi2";
78             reg = <0xfe1f0000 0x400>;
79             interrupts = <GIC_SPI 9 0x4>;
80             clocks = <&mstp3_clks R8A7740_CLK_FSI>;
81             power-domains = <&pd_a4mp>;
82
83             #sound-dai-cells = <1>;
84             fsia,spdif-connection;
85             fsia,stream-mode-support;
86             fsia,use-internal-clock;
87     };