Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / google,cros-ec-codec.txt
1 Audio codec controlled by ChromeOS EC
2
3 Google's ChromeOS EC codec is a digital mic codec provided by the
4 Embedded Controller (EC) and is controlled via a host-command interface.
5
6 An EC codec node should only be found as a sub-node of the EC node (see
7 Documentation/devicetree/bindings/mfd/cros-ec.txt).
8
9 Required properties:
10 - compatible: Must contain "google,cros-ec-codec"
11 - #sound-dai-cells: Should be 1. The cell specifies number of DAIs.
12
13 Optional properties:
14 - reg: Pysical base address and length of shared memory region from EC.
15        It contains 3 unsigned 32-bit integer.  The first 2 integers
16        combine to become an unsigned 64-bit physical address.  The last
17        one integer is length of the shared memory.
18 - memory-region: Shared memory region to EC.  A "shared-dma-pool".  See
19                  ../reserved-memory/reserved-memory.txt for details.
20
21 Example:
22
23 {
24         ...
25
26         reserved_mem: reserved_mem {
27                 compatible = "shared-dma-pool";
28                 reg = <0 0x52800000 0 0x100000>;
29                 no-map;
30         };
31 }
32
33 cros-ec@0 {
34         compatible = "google,cros-ec-spi";
35
36         ...
37
38         cros_ec_codec: ec-codec {
39                 compatible = "google,cros-ec-codec";
40                 #sound-dai-cells = <1>;
41                 reg = <0x0 0x10500000 0x80000>;
42                 memory-region = <&reserved_mem>;
43         };
44 };