i2c: core: Add support for 'i2c-bus' subnode
[cascardo/linux.git] / Documentation / devicetree / bindings / sound / renesas,rsrc-card.txt
1 Renesas Sampling Rate Convert Sound Card:
2
3 Renesas Sampling Rate Convert Sound Card specifies audio DAI connections of SoC <-> codec.
4
5 Required properties:
6
7 - compatible                            : "renesas,rsrc-card{,<board>}"
8                                           Examples with boards are:
9                                             - "renesas,rsrc-card"
10                                             - "renesas,rsrc-card,lager"
11                                             - "renesas,rsrc-card,koelsch"
12 Optional properties:
13
14 - card_name                             : User specified audio sound card name, one string
15                                           property.
16 - cpu                                   : CPU   sub-node
17 - codec                                 : CODEC sub-node
18
19 Optional subnode properties:
20
21 - format                                : CPU/CODEC common audio format.
22                                           "i2s", "right_j", "left_j" , "dsp_a"
23                                           "dsp_b", "ac97", "pdm", "msb", "lsb"
24 - frame-master                          : Indicates dai-link frame master.
25                                           phandle to a cpu or codec subnode.
26 - bitclock-master                       : Indicates dai-link bit clock master.
27                                           phandle to a cpu or codec subnode.
28 - bitclock-inversion                    : bool property. Add this if the
29                                           dai-link uses bit clock inversion.
30 - frame-inversion                       : bool property. Add this if the
31                                           dai-link uses frame clock inversion.
32 - convert-rate                          : platform specified sampling rate convert
33 - convert-channels                      : platform specified converted channel size (2 - 8 ch)
34 - audio-prefix                          : see audio-routing
35 - audio-routing                         : A list of the connections between audio components.
36                                           Each entry is a pair of strings, the first being the connection's sink,
37                                           the second being the connection's source. Valid names for sources.
38                                           use audio-prefix if some components is using same sink/sources naming.
39                                           it can be used if compatible was "renesas,rsrc-card";
40
41 Required CPU/CODEC subnodes properties:
42
43 - sound-dai                             : phandle and port of CPU/CODEC
44
45 Optional CPU/CODEC subnodes properties:
46
47 - clocks / system-clock-frequency       : specify subnode's clock if needed.
48                                           it can be specified via "clocks" if system has
49                                           clock node (= common clock), or "system-clock-frequency"
50                                           (if system doens't support common clock)
51                                           If a clock is specified, it is
52                                           enabled with clk_prepare_enable()
53                                           in dai startup() and disabled with
54                                           clk_disable_unprepare() in dai
55                                           shutdown().
56
57 Example
58
59 sound {
60         compatible = "renesas,rsrc-card,lager";
61
62         card-name = "rsnd-ak4643";
63         format = "left_j";
64         bitclock-master = <&sndcodec>;
65         frame-master = <&sndcodec>;
66
67         sndcpu: cpu {
68                 sound-dai = <&rcar_sound>;
69         };
70
71         sndcodec: codec {
72                 sound-dai = <&ak4643>;
73                 system-clock-frequency = <11289600>;
74         };
75 };