xref: /freebsd/sys/contrib/device-tree/Bindings/net/broadcom-bluetooth.txt (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1Broadcom Bluetooth Chips
2---------------------
3
4This documents the binding structure and common properties for serial
5attached Broadcom devices.
6
7Serial attached Broadcom devices shall be a child node of the host UART
8device the slave device is attached to.
9
10Required properties:
11
12 - compatible: should contain one of the following:
13   * "brcm,bcm20702a1"
14   * "brcm,bcm4329-bt"
15   * "brcm,bcm4330-bt"
16   * "brcm,bcm43438-bt"
17   * "brcm,bcm4345c5"
18   * "brcm,bcm43540-bt"
19   * "brcm,bcm4335a0"
20
21Optional properties:
22
23 - max-speed: see Documentation/devicetree/bindings/serial/serial.yaml
24 - shutdown-gpios: GPIO specifier, used to enable the BT module
25 - device-wakeup-gpios: GPIO specifier, used to wakeup the controller
26 - host-wakeup-gpios: GPIO specifier, used to wakeup the host processor.
27                      deprecated, replaced by interrupts and
28                      "host-wakeup" interrupt-names
29 - clocks: 1 or 2 clocks as defined in clock-names below, in that order
30 - clock-names: names for clock inputs, matching the clocks given
31   - "extclk": deprecated, replaced by "txco"
32   - "txco": external reference clock (not a standalone crystal)
33   - "lpo": external low power 32.768 kHz clock
34 - vbat-supply: phandle to regulator supply for VBAT
35 - vddio-supply: phandle to regulator supply for VDDIO
36 - brcm,bt-pcm-int-params: configure PCM parameters via a 5-byte array
37    - sco-routing: 0 = PCM, 1 = Transport, 2 = Codec, 3 = I2S
38    - pcm-interface-rate: 128KBps, 256KBps, 512KBps, 1024KBps, 2048KBps
39    - pcm-frame-type: short, long
40    - pcm-sync-mode: slave, master
41    - pcm-clock-mode: slave, master
42 - interrupts: must be one, used to wakeup the host processor
43 - interrupt-names: must be "host-wakeup"
44
45Example:
46
47&uart2 {
48       pinctrl-names = "default";
49       pinctrl-0 = <&uart2_pins>;
50
51       bluetooth {
52               compatible = "brcm,bcm43438-bt";
53               max-speed = <921600>;
54               brcm,bt-pcm-int-params = [01 02 00 01 01];
55       };
56};
57