xref: /freebsd-src/sys/contrib/device-tree/Bindings/net/btusb.txt (revision 5def4c47d4bd90b209b9b4a4ba9faec15846d8fd)
1c66ec88fSEmmanuel VadotGeneric Bluetooth controller over USB (btusb driver)
2c66ec88fSEmmanuel Vadot---------------------------------------------------
3c66ec88fSEmmanuel Vadot
4c66ec88fSEmmanuel VadotRequired properties:
5c66ec88fSEmmanuel Vadot
6c66ec88fSEmmanuel Vadot  - compatible : should comply with the format "usbVID,PID" specified in
7*5def4c47SEmmanuel Vadot		 Documentation/devicetree/bindings/usb/usb-device.yaml
8c66ec88fSEmmanuel Vadot		 At the time of writing, the only OF supported devices
9c66ec88fSEmmanuel Vadot		 (more may be added later) are:
10c66ec88fSEmmanuel Vadot
11c66ec88fSEmmanuel Vadot		  "usb1286,204e" (Marvell 8997)
12c66ec88fSEmmanuel Vadot		  "usbcf3,e300" (Qualcomm QCA6174A)
13c66ec88fSEmmanuel Vadot		  "usb4ca,301a" (Qualcomm QCA6174A (Lite-On))
14c66ec88fSEmmanuel Vadot
15c66ec88fSEmmanuel Vadot
16c66ec88fSEmmanuel VadotAlso, vendors that use btusb may have device additional properties, e.g:
17c66ec88fSEmmanuel VadotDocumentation/devicetree/bindings/net/marvell-bt-8xxx.txt
18c66ec88fSEmmanuel Vadot
19c66ec88fSEmmanuel VadotOptional properties:
20c66ec88fSEmmanuel Vadot
21c66ec88fSEmmanuel Vadot  - interrupt-names: (see below)
22c66ec88fSEmmanuel Vadot  - interrupts : The interrupt specified by the name "wakeup" is the interrupt
23c66ec88fSEmmanuel Vadot		 that shall be used for out-of-band wake-on-bt. Driver will
24c66ec88fSEmmanuel Vadot		 request this interrupt for wakeup. During system suspend, the
25c66ec88fSEmmanuel Vadot		 irq will be enabled so that the bluetooth chip can wakeup host
26c66ec88fSEmmanuel Vadot		 platform out of band. During system resume, the irq will be
27c66ec88fSEmmanuel Vadot		 disabled to make sure unnecessary interrupt is not received.
28c66ec88fSEmmanuel Vadot
29c66ec88fSEmmanuel VadotExample:
30c66ec88fSEmmanuel Vadot
31c66ec88fSEmmanuel VadotFollowing example uses irq pin number 3 of gpio0 for out of band wake-on-bt:
32c66ec88fSEmmanuel Vadot
33c66ec88fSEmmanuel Vadot&usb_host1_ehci {
34c66ec88fSEmmanuel Vadot    #address-cells = <1>;
35c66ec88fSEmmanuel Vadot    #size-cells = <0>;
36c66ec88fSEmmanuel Vadot
37c66ec88fSEmmanuel Vadot    mvl_bt1: bt@1 {
38c66ec88fSEmmanuel Vadot	compatible = "usb1286,204e";
39c66ec88fSEmmanuel Vadot	reg = <1>;
40c66ec88fSEmmanuel Vadot	interrupt-parent = <&gpio0>;
41*5def4c47SEmmanuel Vadot	interrupt-names = "wakeup";
42c66ec88fSEmmanuel Vadot	interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
43c66ec88fSEmmanuel Vadot    };
44c66ec88fSEmmanuel Vadot};
45