mirror_ubuntu-kernels/Documentation/devicetree/bindings/sound/renesas,rsnd.yaml

539 lines
14 KiB
YAML

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/sound/renesas,rsnd.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Renesas R-Car Sound Driver
maintainers:
- Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
properties:
compatible:
oneOf:
# for Gen1 SoC
- items:
- enum:
- renesas,rcar_sound-r8a7778 # R-Car M1A
- renesas,rcar_sound-r8a7779 # R-Car H1
- const: renesas,rcar_sound-gen1
# for Gen2 SoC
- items:
- enum:
- renesas,rcar_sound-r8a7742 # RZ/G1H
- renesas,rcar_sound-r8a7743 # RZ/G1M
- renesas,rcar_sound-r8a7744 # RZ/G1N
- renesas,rcar_sound-r8a7745 # RZ/G1E
- renesas,rcar_sound-r8a77470 # RZ/G1C
- renesas,rcar_sound-r8a7790 # R-Car H2
- renesas,rcar_sound-r8a7791 # R-Car M2-W
- renesas,rcar_sound-r8a7793 # R-Car M2-N
- renesas,rcar_sound-r8a7794 # R-Car E2
- const: renesas,rcar_sound-gen2
# for Gen3 SoC
- items:
- enum:
- renesas,rcar_sound-r8a774a1 # RZ/G2M
- renesas,rcar_sound-r8a774b1 # RZ/G2N
- renesas,rcar_sound-r8a774c0 # RZ/G2E
- renesas,rcar_sound-r8a774e1 # RZ/G2H
- renesas,rcar_sound-r8a7795 # R-Car H3
- renesas,rcar_sound-r8a7796 # R-Car M3-W
- renesas,rcar_sound-r8a77961 # R-Car M3-W+
- renesas,rcar_sound-r8a77965 # R-Car M3-N
- renesas,rcar_sound-r8a77990 # R-Car E3
- renesas,rcar_sound-r8a77995 # R-Car D3
- const: renesas,rcar_sound-gen3
# for Gen4 SoC
- items:
- const: renesas,rcar_sound-r8a779g0 # R-Car V4H
- const: renesas,rcar_sound-gen4
# for Generic
- enum:
- renesas,rcar_sound-gen1
- renesas,rcar_sound-gen2
- renesas,rcar_sound-gen3
reg:
minItems: 1
maxItems: 5
reg-names:
minItems: 1
maxItems: 5
"#sound-dai-cells":
description: |
it must be 0 if your system is using single DAI
it must be 1 if your system is using multi DAIs
This is used on simple-audio-card
enum: [0, 1]
"#clock-cells":
description: |
it must be 0 if your system has audio_clkout
it must be 1 if your system has audio_clkout0/1/2/3
enum: [0, 1]
"#address-cells":
const: 1
"#size-cells":
const: 0
clock-frequency:
description: for audio_clkout0/1/2/3
clkout-lr-asynchronous:
description: audio_clkoutn is asynchronizes with lr-clock.
$ref: /schemas/types.yaml#/definitions/flag
power-domains: true
resets:
minItems: 1
maxItems: 11
reset-names:
minItems: 1
maxItems: 11
clocks:
description: References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
minItems: 1
maxItems: 31
clock-names:
description: List of necessary clock names.
# details are defined below
# ports is below
port:
$ref: audio-graph-port.yaml#/definitions/port-base
unevaluatedProperties: false
patternProperties:
"^endpoint(@[0-9a-f]+)?":
$ref: audio-graph-port.yaml#/definitions/endpoint-base
properties:
playback:
$ref: /schemas/types.yaml#/definitions/phandle-array
capture:
$ref: /schemas/types.yaml#/definitions/phandle-array
unevaluatedProperties: false
rcar_sound,dvc:
description: DVC subnode.
type: object
patternProperties:
"^dvc-[0-1]$":
type: object
additionalProperties: false
properties:
dmas:
maxItems: 1
dma-names:
const: tx
required:
- dmas
- dma-names
additionalProperties: false
rcar_sound,mix:
description: MIX subnode.
type: object
patternProperties:
"^mix-[0-1]$":
type: object
additionalProperties: false
additionalProperties: false
rcar_sound,ctu:
description: CTU subnode.
type: object
patternProperties:
"^ctu-[0-7]$":
type: object
additionalProperties: false
additionalProperties: false
rcar_sound,src:
description: SRC subnode.
type: object
patternProperties:
"^src-[0-9]$":
type: object
additionalProperties: false
properties:
interrupts:
maxItems: 1
dmas:
maxItems: 2
dma-names:
allOf:
- items:
enum:
- tx
- rx
additionalProperties: false
rcar_sound,ssiu:
description: SSIU subnode.
type: object
patternProperties:
"^ssiu-[0-9]+$":
type: object
additionalProperties: false
properties:
dmas:
maxItems: 2
dma-names:
allOf:
- items:
enum:
- tx
- rx
required:
- dmas
- dma-names
additionalProperties: false
rcar_sound,ssi:
description: SSI subnode.
type: object
patternProperties:
"^ssi-[0-9]$":
type: object
additionalProperties: false
properties:
interrupts:
maxItems: 1
dmas:
minItems: 2
maxItems: 4
dma-names:
allOf:
- items:
enum:
- tx
- rx
- txu # if no ssiu node
- rxu # if no ssiu node
shared-pin:
description: shared clock pin
$ref: /schemas/types.yaml#/definitions/flag
pio-transfer:
description: PIO transfer mode
$ref: /schemas/types.yaml#/definitions/flag
no-busif:
description: BUSIF is not used when [mem -> SSI] via DMA case
$ref: /schemas/types.yaml#/definitions/flag
required:
- interrupts
additionalProperties: false
patternProperties:
# For DAI base
'rcar_sound,dai(@[0-9a-f]+)?$':
description: DAI subnode.
type: object
patternProperties:
"^dai([0-9]+)?$":
type: object
additionalProperties: false
properties:
playback:
$ref: /schemas/types.yaml#/definitions/phandle-array
capture:
$ref: /schemas/types.yaml#/definitions/phandle-array
anyOf:
- required:
- playback
- required:
- capture
additionalProperties: false
'ports(@[0-9a-f]+)?$':
$ref: audio-graph-port.yaml#/definitions/port-base
unevaluatedProperties: false
patternProperties:
'^port(@[0-9a-f]+)?$':
$ref: "#/properties/port"
required:
- compatible
- reg
- reg-names
- clocks
- clock-names
allOf:
- $ref: dai-common.yaml#
# --------------------
# reg/reg-names
# --------------------
# for Gen1
- if:
properties:
compatible:
contains:
const: renesas,rcar_sound-gen1
then:
properties:
reg:
maxItems: 3
reg-names:
items:
enum:
- scu
- ssi
- adg
# for Gen2/Gen3
- if:
properties:
compatible:
contains:
enum:
- renesas,rcar_sound-gen2
- renesas,rcar_sound-gen3
then:
properties:
reg:
minItems: 5
reg-names:
items:
enum:
- scu
- adg
- ssiu
- ssi
- audmapp
# for Gen4
- if:
properties:
compatible:
contains:
const: renesas,rcar_sound-gen4
then:
properties:
reg:
maxItems: 4
reg-names:
items:
enum:
- adg
- ssiu
- ssi
- sdmc
# --------------------
# clock-names
# --------------------
- if:
properties:
compatible:
contains:
const: renesas,rcar_sound-gen4
then:
properties:
clock-names:
maxItems: 3
items:
enum:
- ssi.0
- ssiu.0
- clkin
else:
properties:
clock-names:
minItems: 1
maxItems: 31
items:
oneOf:
- const: ssi-all
- pattern: '^ssi\.[0-9]$'
- pattern: '^src\.[0-9]$'
- pattern: '^mix\.[0-1]$'
- pattern: '^ctu\.[0-1]$'
- pattern: '^dvc\.[0-1]$'
- pattern: '^clk_(a|b|c|i)$'
unevaluatedProperties: false
examples:
- |
#include <dt-bindings/clock/r8a7790-cpg-mssr.h>
#include <dt-bindings/interrupt-controller/arm-gic.h>
#include <dt-bindings/power/r8a7790-sysc.h>
rcar_sound: sound@ec500000 {
#sound-dai-cells = <1>;
compatible = "renesas,rcar_sound-r8a7790", "renesas,rcar_sound-gen2";
reg = <0xec500000 0x1000>, /* SCU */
<0xec5a0000 0x100>, /* ADG */
<0xec540000 0x1000>, /* SSIU */
<0xec541000 0x280>, /* SSI */
<0xec740000 0x200>; /* Audio DMAC peri peri*/
reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
clocks = <&cpg CPG_MOD 1005>, /* SSI-ALL */
<&cpg CPG_MOD 1006>, <&cpg CPG_MOD 1007>, /* SSI9, SSI8 */
<&cpg CPG_MOD 1008>, <&cpg CPG_MOD 1009>, /* SSI7, SSI6 */
<&cpg CPG_MOD 1010>, <&cpg CPG_MOD 1011>, /* SSI5, SSI4 */
<&cpg CPG_MOD 1012>, <&cpg CPG_MOD 1013>, /* SSI3, SSI2 */
<&cpg CPG_MOD 1014>, <&cpg CPG_MOD 1015>, /* SSI1, SSI0 */
<&cpg CPG_MOD 1022>, <&cpg CPG_MOD 1023>, /* SRC9, SRC8 */
<&cpg CPG_MOD 1024>, <&cpg CPG_MOD 1025>, /* SRC7, SRC6 */
<&cpg CPG_MOD 1026>, <&cpg CPG_MOD 1027>, /* SRC5, SRC4 */
<&cpg CPG_MOD 1028>, <&cpg CPG_MOD 1029>, /* SRC3, SRC2 */
<&cpg CPG_MOD 1030>, <&cpg CPG_MOD 1031>, /* SRC1, SRC0 */
<&cpg CPG_MOD 1020>, <&cpg CPG_MOD 1021>, /* MIX1, MIX0 */
<&cpg CPG_MOD 1020>, <&cpg CPG_MOD 1021>, /* CTU1, CTU0 */
<&cpg CPG_MOD 1019>, <&cpg CPG_MOD 1018>, /* DVC0, DVC1 */
<&audio_clk_a>, <&audio_clk_b>, /* CLKA, CLKB */
<&audio_clk_c>, <&audio_clk_i>; /* CLKC, CLKI */
clock-names = "ssi-all",
"ssi.9", "ssi.8",
"ssi.7", "ssi.6",
"ssi.5", "ssi.4",
"ssi.3", "ssi.2",
"ssi.1", "ssi.0",
"src.9", "src.8",
"src.7", "src.6",
"src.5", "src.4",
"src.3", "src.2",
"src.1", "src.0",
"mix.1", "mix.0",
"ctu.1", "ctu.0",
"dvc.0", "dvc.1",
"clk_a", "clk_b",
"clk_c", "clk_i";
power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
resets = <&cpg 1005>,
<&cpg 1006>, <&cpg 1007>, <&cpg 1008>, <&cpg 1009>,
<&cpg 1010>, <&cpg 1011>, <&cpg 1012>, <&cpg 1013>,
<&cpg 1014>, <&cpg 1015>;
reset-names = "ssi-all",
"ssi.9", "ssi.8", "ssi.7", "ssi.6",
"ssi.5", "ssi.4", "ssi.3", "ssi.2",
"ssi.1", "ssi.0";
rcar_sound,dvc {
dvc0: dvc-0 {
dmas = <&audma0 0xbc>;
dma-names = "tx";
};
dvc1: dvc-1 {
dmas = <&audma0 0xbe>;
dma-names = "tx";
};
};
rcar_sound,mix {
mix0: mix-0 { };
mix1: mix-1 { };
};
rcar_sound,ctu {
ctu00: ctu-0 { };
ctu01: ctu-1 { };
ctu02: ctu-2 { };
ctu03: ctu-3 { };
ctu10: ctu-4 { };
ctu11: ctu-5 { };
ctu12: ctu-6 { };
ctu13: ctu-7 { };
};
rcar_sound,src {
src0: src-0 {
status = "disabled";
};
src1: src-1 {
interrupts = <GIC_SPI 353 IRQ_TYPE_LEVEL_HIGH>;
dmas = <&audma0 0x87>, <&audma1 0x9c>;
dma-names = "rx", "tx";
};
/* skip after src-2 */
};
rcar_sound,ssiu {
ssiu00: ssiu-0 {
dmas = <&audma0 0x15>, <&audma1 0x16>;
dma-names = "rx", "tx";
};
ssiu01: ssiu-1 {
dmas = <&audma0 0x35>, <&audma1 0x36>;
dma-names = "rx", "tx";
};
/* skip after ssiu-2 */
};
rcar_sound,ssi {
ssi0: ssi-0 {
interrupts = <GIC_SPI 370 IRQ_TYPE_LEVEL_HIGH>;
dmas = <&audma0 0x01>, <&audma1 0x02>;
dma-names = "rx", "tx";
};
ssi1: ssi-1 {
interrupts = <GIC_SPI 371 IRQ_TYPE_LEVEL_HIGH>;
dmas = <&audma0 0x03>, <&audma1 0x04>;
dma-names = "rx", "tx";
};
/* skip other ssi-2 */
};
/* DAI base */
rcar_sound,dai {
dai0 {
playback = <&ssi5>, <&src5>;
capture = <&ssi6>;
};
dai1 {
playback = <&ssi3>;
};
dai2 {
capture = <&ssi4>;
};
dai3 {
playback = <&ssi7>;
};
dai4 {
capture = <&ssi8>;
};
};
/* assume audio-graph */
port {
rsnd_endpoint: endpoint {
remote-endpoint = <&codec_endpoint>;
dai-format = "left_j";
bitclock-master = <&rsnd_endpoint0>;
frame-master = <&rsnd_endpoint0>;
playback = <&ssi0>, <&src0>, <&dvc0>;
capture = <&ssi1>, <&src1>, <&dvc1>;
};
};
};
/* assume audio-graph */
codec {
port {
codec_endpoint: endpoint {
remote-endpoint = <&rsnd_endpoint>;
};
};
};