Merge tag 'sound-fix-5.1-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / net / mediatek-bluetooth.txt
1 MediaTek SoC built-in Bluetooth Devices
2 ==================================
3
4 This device is a serial attached device to BTIF device and thus it must be a
5 child node of the serial node with BTIF. The dt-bindings details for BTIF
6 device can be known via Documentation/devicetree/bindings/serial/8250.txt.
7
8 Required properties:
9
10 - compatible:   Must be
11                   "mediatek,mt7622-bluetooth": for MT7622 SoC
12 - clocks:       Should be the clock specifiers corresponding to the entry in
13                 clock-names property.
14 - clock-names:  Should contain "ref" entries.
15 - power-domains: Phandle to the power domain that the device is part of
16
17 Example:
18
19         btif: serial@1100c000 {
20                 compatible = "mediatek,mt7622-btif",
21                              "mediatek,mtk-btif";
22                 reg = <0 0x1100c000 0 0x1000>;
23                 interrupts = <GIC_SPI 90 IRQ_TYPE_LEVEL_LOW>;
24                 clocks = <&pericfg CLK_PERI_BTIF_PD>;
25                 clock-names = "main";
26                 reg-shift = <2>;
27                 reg-io-width = <4>;
28
29                 bluetooth {
30                         compatible = "mediatek,mt7622-bluetooth";
31                         power-domains = <&scpsys MT7622_POWER_DOMAIN_WB>;
32                         clocks = <&clk25m>;
33                         clock-names = "ref";
34                 };
35         };
36
37 MediaTek UART based Bluetooth Devices
38 ==================================
39
40 This device is a serial attached device to UART device and thus it must be a
41 child node of the serial node with UART.
42
43 Please refer to the following documents for generic properties:
44
45         Documentation/devicetree/bindings/serial/slave-device.txt
46
47 Required properties:
48
49 - compatible:   Must be
50                   "mediatek,mt7663u-bluetooth": for MT7663U device
51                   "mediatek,mt7668u-bluetooth": for MT7668U device
52 - vcc-supply:   Main voltage regulator
53 - pinctrl-names: Should be "default", "runtime"
54 - pinctrl-0: Should contain UART RXD low when the device is powered up to
55              enter proper bootstrap mode.
56 - pinctrl-1: Should contain UART mode pin ctrl
57
58 Optional properties:
59
60 - reset-gpios:  GPIO used to reset the device whose initial state keeps low,
61                 if the GPIO is missing, then board-level design should be
62                 guaranteed.
63 - current-speed:  Current baud rate of the device whose defaults to 921600
64
65 Example:
66
67         uart1_pins_boot: uart1-default {
68                 pins-dat {
69                         pinmux = <MT7623_PIN_81_URXD1_FUNC_GPIO81>;
70                         output-low;
71                 };
72         };
73
74         uart1_pins_runtime: uart1-runtime {
75                 pins-dat {
76                         pinmux = <MT7623_PIN_81_URXD1_FUNC_URXD1>,
77                                  <MT7623_PIN_82_UTXD1_FUNC_UTXD1>;
78                 };
79         };
80
81         uart1: serial@11003000 {
82                 compatible = "mediatek,mt7623-uart",
83                              "mediatek,mt6577-uart";
84                 reg = <0 0x11003000 0 0x400>;
85                 interrupts = <GIC_SPI 52 IRQ_TYPE_LEVEL_LOW>;
86                 clocks = <&pericfg CLK_PERI_UART1_SEL>,
87                          <&pericfg CLK_PERI_UART1>;
88                 clock-names = "baud", "bus";
89
90                 bluetooth {
91                         compatible = "mediatek,mt7663u-bluetooth";
92                         vcc-supply = <&reg_5v>;
93                         reset-gpios = <&pio 24 GPIO_ACTIVE_LOW>;
94                         pinctrl-names = "default", "runtime";
95                         pinctrl-0 = <&uart1_pins_boot>;
96                         pinctrl-1 = <&uart1_pins_runtime>;
97                         current-speed = <921600>;
98                 };
99         };