README.md (c30869498fb8e98c1408c9db0e7624f02f483b73) README.md (c63d0213aecaddf9702f96b37fb80ca90bff17bb)
1# Welcome to BTstack
2
3BTstack is [BlueKitchen's](https://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
4It is well suited for small, resource-constraint devices
5such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
6
7Targeting a variety of platforms is as simple as providing the necessary UART, CPU, and CLOCK implementations. BTstack is currently capable of connecting to Bluetooth-modules via: (H2) HCI USB, (H4) HCI UART + TI's eHCILL, and (H5) HCI Three-Wire UART.
8

--- 52 unchanged lines hidden (view full) ---

61#### Other Platforms:
62| Status | Port | Platform |
63|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
64| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-libusb-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-libusb-develop) | [libusb](https://github.com/bluekitchen/btstack/tree/develop/port/libusb) | Unix-based system with dedicated USB Bluetooth dongle |
65| No build server | [libusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/libusb-intel) | Unix-based system with Intel Wireless 8260/8265 Controller |
66| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-posix-h4-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-posix-h4-develop) | [posix-h4](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4) | Unix-based system connected to Bluetooth module via H4 over serial port |
67| No build server | [posix-h4-da14581](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14581) | Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port |
68| No build server | [posix-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14585) | Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
1# Welcome to BTstack
2
3BTstack is [BlueKitchen's](https://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
4It is well suited for small, resource-constraint devices
5such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
6
7Targeting a variety of platforms is as simple as providing the necessary UART, CPU, and CLOCK implementations. BTstack is currently capable of connecting to Bluetooth-modules via: (H2) HCI USB, (H4) HCI UART + TI's eHCILL, and (H5) HCI Three-Wire UART.
8

--- 52 unchanged lines hidden (view full) ---

61#### Other Platforms:
62| Status | Port | Platform |
63|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
64| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-libusb-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-libusb-develop) | [libusb](https://github.com/bluekitchen/btstack/tree/develop/port/libusb) | Unix-based system with dedicated USB Bluetooth dongle |
65| No build server | [libusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/libusb-intel) | Unix-based system with Intel Wireless 8260/8265 Controller |
66| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-posix-h4-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-posix-h4-develop) | [posix-h4](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4) | Unix-based system connected to Bluetooth module via H4 over serial port |
67| No build server | [posix-h4-da14581](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14581) | Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port |
68| No build server | [posix-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14585) | Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
69| No build server | [posix-h4-nxp](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-nxp) | Unix-based system connected to NXP controllers via H4 over serial port |
70| No build server | [posix-h4-zephyr](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-zephyr) | Unix-based system connected to Bluetooth module with Zephyr HCI firmware via H4 over serial port |
69| No build server | [posix-h5](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h5) | Unix-based system connected to Bluetooth module via H5 over serial port |
70| No build server | [qt-h4](https://github.com/bluekitchen/btstack/tree/develop/port/qt-h4) | Unix- or Win32-based [Qt application](https://qt.io) connected to Bluetooth module via H4 over serial port |
71| No build server | [qt-usb](https://github.com/bluekitchen/btstack/tree/develop/port/qt-usb) | Unix- or Win32-based [Qt application](https://qt.io) with dedicated USB Bluetooth dongle |
72| No build server | [windows-h4](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4) | Win32-based system connected to Bluetooth module via serial port |
73| No build server | [windows-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4-da14585) | Win32-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
74| No build server | [windows-winusb](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb) | Win32-based system with dedicated USB Bluetooth dongle |
75| No build server | [windows-winusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb-intel) | Win32-based system with Intel Wireless 8260/8265 Controller |
76| No build server | [raspi](https://github.com/bluekitchen/btstack/tree/develop/port/raspi) | Raspberry Pi 3 or Raspberry Pi Zero W with built-in BCM4343 Bluetooth/Wifi Controller |

--- 6 unchanged lines hidden (view full) ---

83
84| Chipset | Type | HCI Transport | SCO over HCI | BTstack folder | Comment |
85|--------------------------------------|------------------|----------------|------------------|----------------|------------------------------------------------|
86| Atmel ATWILC3000 | LE | H4 | n.a. | atwilc3000 | Firmware size: 60 kB |
87| Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps |
88| Broadcom USB Dongles | Dual mode | USB | Yes | bcm | |
89| CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | |
90| CSR USB Dongles | Dual mode | USB | Yes | csr | |
71| No build server | [posix-h5](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h5) | Unix-based system connected to Bluetooth module via H5 over serial port |
72| No build server | [qt-h4](https://github.com/bluekitchen/btstack/tree/develop/port/qt-h4) | Unix- or Win32-based [Qt application](https://qt.io) connected to Bluetooth module via H4 over serial port |
73| No build server | [qt-usb](https://github.com/bluekitchen/btstack/tree/develop/port/qt-usb) | Unix- or Win32-based [Qt application](https://qt.io) with dedicated USB Bluetooth dongle |
74| No build server | [windows-h4](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4) | Win32-based system connected to Bluetooth module via serial port |
75| No build server | [windows-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4-da14585) | Win32-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
76| No build server | [windows-winusb](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb) | Win32-based system with dedicated USB Bluetooth dongle |
77| No build server | [windows-winusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb-intel) | Win32-based system with Intel Wireless 8260/8265 Controller |
78| No build server | [raspi](https://github.com/bluekitchen/btstack/tree/develop/port/raspi) | Raspberry Pi 3 or Raspberry Pi Zero W with built-in BCM4343 Bluetooth/Wifi Controller |

--- 6 unchanged lines hidden (view full) ---

85
86| Chipset | Type | HCI Transport | SCO over HCI | BTstack folder | Comment |
87|--------------------------------------|------------------|----------------|------------------|----------------|------------------------------------------------|
88| Atmel ATWILC3000 | LE | H4 | n.a. | atwilc3000 | Firmware size: 60 kB |
89| Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps |
90| Broadcom USB Dongles | Dual mode | USB | Yes | bcm | |
91| CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | |
92| CSR USB Dongles | Dual mode | USB | Yes | csr | |
91| Cypress CYW20704/20707 | Dual mode | H4, H5, USB | Probably | bcm | |
92| Cypress CYW20819 | Dual mode | H4, H5, USB | Probably | bcm | Keep CTS high during power cycle |
93| Cypress CYW43xxx | Dual mode + Wifi | H4, H5 | Don't know | bcm | Bluetooth + Wifi Combo Controller |
94| Cypress PSoC 4 | LE | H4 | n.a. | | HCI Firmware part of PSoC Creator kit examples |
93| Infineon CYW207xx | Dual mode | H4, H5, USB | Probably | bcm | |
94| Infineon CYW20819 | Dual mode | H4, H5, USB | Probably | bcm | Keep CTS high during power cycle |
95| Infineon CYW43xxx | Dual mode + Wifi | H4, H5 | Don't know | bcm | Bluetooth + Wifi Combo Controller |
96| Infineon PSoC 4 | LE | H4 | n.a. | | HCI Firmware part of PSoC Creator kit examples |
95| Dialog Semiconductor DA145xx | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used |
96| Dialog Semiconductor DA1469x | LE | H4, SPI | n.a | | HCI Firmware part of DA1469x SDK |
97| Espressif ESP32 | Dual mode + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
98| Espressif ESP32-S3, ESP32-C3 | LE + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
97| Dialog Semiconductor DA145xx | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used |
98| Dialog Semiconductor DA1469x | LE | H4, SPI | n.a | | HCI Firmware part of DA1469x SDK |
99| Espressif ESP32 | Dual mode + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
100| Espressif ESP32-S3, ESP32-C3 | LE + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
99| EM 9301, 9304 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation |
101| EM 9301, 9304, 9305 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation |
100| Intel Dual Wireless 3165, 8260, 8265 | Dual mode | USB | Probably | intel | Firmware size: 400 kB |
101| Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware |
102| Intel Dual Wireless 3165, 8260, 8265 | Dual mode | USB | Probably | intel | Firmware size: 400 kB |
103| Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware |
104| NXP 88W88997 | Dual mode + Wifi | H4 | Yes | nxp | Requires initial firmware |
102| Realtek RTL8822CS | Dual mode + Wifi | H5 | Yes | | Requires initial firmware and config |
103| Realtek USB Dongles | Dual mode + Wifi | USB | Yes | realtek | Requires initial firmware and config |
104| Renesas RX23W | LE | H4 | n.a. | | HCI Firmware part of BTTS |
105| STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported |
106| STM32-WB5x | LE | VHCI | n.a. | | SoC with multi-protocol Radio co-processor |
107| Toshiba TC35661 | Dual mode | H4 | No | tc3566 | |
108| TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x |
109

--- 13 unchanged lines hidden --- 		105| Realtek RTL8822CS | Dual mode + Wifi | H5 | Yes | | Requires initial firmware and config |
106| Realtek USB Dongles | Dual mode + Wifi | USB | Yes | realtek | Requires initial firmware and config |
107| Renesas RX23W | LE | H4 | n.a. | | HCI Firmware part of BTTS |
108| STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported |
109| STM32-WB5x | LE | VHCI | n.a. | | SoC with multi-protocol Radio co-processor |
110| Toshiba TC35661 | Dual mode | H4 | No | tc3566 | |
111| TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x |
112

--- 13 unchanged lines hidden ---