Merge tag 'pinctrl-v5.1-1' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / davinci-mcasp-audio.txt
1 Texas Instruments McASP controller
2
3 Required properties:
4 - compatible :
5         "ti,dm646x-mcasp-audio" : for DM646x platforms
6         "ti,da830-mcasp-audio"  : for both DA830 & DA850 platforms
7         "ti,am33xx-mcasp-audio" : for AM33xx platforms (AM33xx, AM43xx, TI81xx)
8         "ti,dra7-mcasp-audio"   : for DRA7xx platforms
9
10 - reg : Should contain reg specifiers for the entries in the reg-names property.
11 - reg-names : Should contain:
12          * "mpu" for the main registers (required). For compatibility with
13            existing software, it is recommended this is the first entry.
14          * "dat" for separate data port register access (optional).
15 - op-mode : I2S/DIT ops mode. 0 for I2S mode. 1 for DIT mode used for S/PDIF,
16             IEC60958-1, and AES-3 formats.
17 - tdm-slots : Slots for TDM operation. Indicates number of channels transmitted
18               or received over one serializer.
19 - serial-dir : A list of serializer configuration. Each entry is a number
20                indication for serializer pin direction.
21                (0 - INACTIVE, 1 - TX, 2 - RX)
22 - dmas: two element list of DMA controller phandles and DMA request line
23         ordered pairs.
24 - dma-names: identifier string for each DMA request line in the dmas property.
25              These strings correspond 1:1 with the ordered pairs in dmas. The dma
26              identifiers must be "rx" and "tx".
27
28 Optional properties:
29
30 - ti,hwmods : Must be "mcasp<n>", n is controller instance starting 0
31 - tx-num-evt : FIFO levels.
32 - rx-num-evt : FIFO levels.
33 - dismod : Specify the drive on TX pin during inactive slots
34         0 : 3-state
35         2 : logic low
36         3 : logic high
37         Defaults to 'logic low' when the property is not present
38 - sram-size-playback : size of sram to be allocated during playback
39 - sram-size-capture  : size of sram to be allocated during capture
40 - interrupts : Interrupt numbers for McASP
41 - interrupt-names : Known interrupt names are "tx" and "rx"
42 - pinctrl-0: Should specify pin control group used for this controller.
43 - pinctrl-names: Should contain only one value - "default", for more details
44                  please refer to pinctrl-bindings.txt
45 - fck_parent : Should contain a valid clock name which will be used as parent
46                for the McASP fck
47
48 Optional GPIO support:
49 If any McASP pin need to be used as GPIO then the McASP node must have:
50 ...
51   gpio-controller
52   #gpio-cells = <2>;
53 ...
54
55 When requesting a GPIO, the first parameter is the PIN index in McASP_P*
56 registers.
57 For example to request the AXR2 pin of mcasp8:
58 function-gpios = <&mcasp8 2 0>;
59
60 Or to request the ACLKR pin of mcasp8:
61 function-gpios = <&mcasp8 29 0>;
62
63 For generic gpio information, please refer to bindings/gpio/gpio.txt
64
65 Example:
66
67 mcasp0: mcasp0@1d00000 {
68         compatible = "ti,da830-mcasp-audio";
69         reg = <0x100000 0x3000>;
70         reg-names "mpu";
71         interrupts = <82>, <83>;
72         interrupt-names = "tx", "rx";
73         op-mode = <0>;          /* MCASP_IIS_MODE */
74         tdm-slots = <2>;
75         serial-dir = <
76                         0 0 0 0 /* 0: INACTIVE, 1: TX, 2: RX */
77                         0 0 0 0
78                         0 0 0 1
79                         2 0 0 0 >;
80         tx-num-evt = <1>;
81         rx-num-evt = <1>;
82 };