diff --git a/README.md b/README.md index caacf6b0a..05664364d 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,8 @@ No build server | [samv71-xplained-atwilc3000](https://github.com/bluekitchen/bt No build Server | [stm32-f4discovery-cc2564b](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-f4discovery-cc256x) | [STM32 F4 Discovery Board](http://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adapter Kit for ST](https://store.ti.com/CC256XEM-STADAPT-CC256xEM-Bluetooth-Adapter-Kit-P45158.aspx) and [CC2564B Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/cc2564modnem.aspx) No build Server | [stm32-l053rb-em9304](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-l053rb-em9304) | EM9304 DVK: [STM32 Nucleo development board NUCELO-L053R](http://www.st.com/en/evaluation-tools/nucleo-l053r8.html) with [EM9304 Bluetooth Controller](http://www.emmicroelectronic.com/products/wireless-rf/standard-protocols/em9304) [](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-pic32-harmony-develop) | [pic32-harmony](https://github.com/bluekitchen/btstack/tree/develop/port/pic32-harmony) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032) -[](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-develop) | [wiced-h4](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h4) | Broadcom platforms that support the WICED SDK via H4 UART, e.g. [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 -No build server | [wiced-h5](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h5) | Broadcom platforms that support the WICED SDK via H5 UART +[](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-develop) | [wiced-h4](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h4) | Broadcom platforms that support the WICED SDK via H4 UART, e.g. [RedBear Duo](https://redbear.cc/product/wifi-ble/redbear-duo.html) with Broadcom BCM43438 A1 or the [Inventek Systems ISM4334x](https://www.inventeksys.com/products-page/wifi-modules/serial-wifi/ism43341-m4g-l44-cu-embedded-serial-to-wifi-ble-nfc-module/) with Broadcom BCM43340 +No build server | [wiced-h5](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h5) | Broadcom platforms that support the WICED SDK via H5 UART, see wiced-h4 #### Other Platforms: Status | Port | Platform diff --git a/port/wiced-h4/readme.md b/port/wiced-h4/readme.md index 391d094fc..366015622 100644 --- a/port/wiced-h4/readme.md +++ b/port/wiced-h4/readme.md @@ -1,8 +1,12 @@ # BTstack port for WICED platform -Only tested on Redbear Duo platform. Please install [RedBear WICED Add-On](https://github.com/redbear/WICED-SDK) first. +Tested with: +- WICED SDK 3.4-5.2 +- [RedBear Duo](https://redbear.cc/product/wifi-ble/redbear-duo.html): Please install [RedBear WICED Add-On](https://github.com/redbear/WICED-SDK) +- [Inventek Systems ISM4334x](https://www.inventeksys.com/products-page/wifi-modules/serial-wifi/ism43341-m4g-l44-cu-embedded-serial-to-wifi-ble-nfc-module/): Please install [Inventek WICED Patches](https://www.inventeksys.com/inventekproducts/wifi-products/broadcom-wiced/) + +To integrate BTstack into the WICED SDK, please move the BTstack project into WICED-SDK-5.2/libraries. -To integrate BTstack into the WICED SDK, please move the BTstack project into WICED-SDK-3.5.2/libraries. Then create projects for BTstack examples in WICED/apps/btstack by running: ./create_examples.py @@ -11,15 +15,15 @@ Now, the BTstack examples can be build from the WICED root in the same way as ot ./make btstack.spp_and_le_counter-RB_DUO -to build the SPP-and-LE-Counter example for the RedBear Duo. +to build the SPP-and-LE-Counter example for the RedBear Duo (or use ISM43340_M4G_L44 for the Inventek Systems devices). -See WICED documentation about how to install it. +See WICED documentation about how to upload the firmware. It should work with all WICED platforms that contain a Broadcom Bluetooth chipset. -The maximal baud rate is limited to 3 mbps. +The maximal baud rate is currenty limited to 1 mbps. The port uses the generated WIFI address plus 1 as Bluetooth MAC address. -It stores Classic Link Keys using the DCT mechanism. +It persists the LE Device DB and Classic Link Keys via the DCT mechanism. All examples that rovide a GATT Server use the GATT DB in the .gatt file. Therefore you need to run ./update_gatt_db.sh in the apps/btstack/$(EXAMPLE) folder after modifying the .gatt file. diff --git a/port/wiced-h5/readme.md b/port/wiced-h5/readme.md index 5f52e5295..568632f00 100644 --- a/port/wiced-h5/readme.md +++ b/port/wiced-h5/readme.md @@ -1,8 +1,14 @@ # BTstack port for WICED platform using H5 transport and Broadcom/Cypress Bluetooth chipsets. -Only tested on Redbear Duo platform. Please install [RedBear WICED Add-On](https://github.com/redbear/WICED-SDK) first. +# BTstack port for WICED platform + +Tested with: +- WICED SDK 3.4-5.2 +- [RedBear Duo](https://redbear.cc/product/wifi-ble/redbear-duo.html): Please install [RedBear WICED Add-On](https://github.com/redbear/WICED-SDK) +- [Inventek Systems ISM4334x](https://www.inventeksys.com/products-page/wifi-modules/serial-wifi/ism43341-m4g-l44-cu-embedded-serial-to-wifi-ble-nfc-module/): Please install [Inventek WICED Patches](https://www.inventeksys.com/inventekproducts/wifi-products/broadcom-wiced/) + +To integrate BTstack into the WICED SDK, please move the BTstack project into WICED-SDK-5.2/libraries. -To integrate BTstack into the WICED SDK, please move the BTstack project into WICED-SDK-3.5.2/libraries. Then create projects for BTstack examples in WICED/apps/btstack by running: ./create_examples.py @@ -11,27 +17,28 @@ Now, the BTstack examples can be build from the WICED root in the same way as ot ./make btstack.spp_and_le_counter-RB_DUO -to build the SPP-and-LE-Counter example for the RedBear Duo. +to build the SPP-and-LE-Counter example for the RedBear Duo (or use ISM43340_M4G_L44 for the Inventek Systems devices). -See WICED documentation about how to install it. +See WICED documentation about how to upload the firmware. It should work with all WICED platforms that contain a Broadcom Bluetooth chipset. -The maximal baud rate is limited to 2 mbps. +The maximal baud rate is currenty limited to 1 mbps. The port uses the generated WIFI address plus 1 as Bluetooth MAC address. -It stores Classic Link Keys using the DCT mechanism. +It persists the LE Device DB and Classic Link Keys via the DCT mechanism. All examples that rovide a GATT Server use the GATT DB in the .gatt file. Therefore you need to run ./update_gatt_db.sh in the apps/btstack/$(EXAMPLE) folder after modifying the .gatt file. -## Notes on the H5 port + +## Additoinal notes on the H5 port If the CTR/RTS hardware control lines of the Bluetooth Controller is connected to your MCU, we recommend using the wiced-h4 port instead. -If they are not connected, H5 is required to provide a reliable connecion including retransmissions in both directions. +If they are not connected, H5 is required to provide a reliable connection including retransmissions in both directions. -There are a few oddities so far that have been worked around in H5 mode: +There are a few oddities so far that had to be worked around in H5 mode: -- It does not seem possible to upload the FW Mini Driver a.k.a. patchram a.k.a. init script via H5. BTstack uses btstack_chipset_bcm_download_firmware.c to upload the FW Mini Driver via a minimal H4 implementation, before starting up in H5 mode. BCM/CYP chipsets able to switch to H5. +- It does not seem possible to upload the FW Mini Driver a.k.a. patchram a.k.a. init script via H5. BTstack uses btstack_chipset_bcm_download_firmware.c to upload the FW Mini Driver via a minimal H4 implementation, before starting up in H5 mode. BCM/CYP chipsets are able to switch to H5. -- With the AP6212A on the RedBear Duo and the FW Mini Driver from WICED-SDK-3.5.2/libraries/drivers/bluetooth/firmware/43438A1/26MHz/bt_firmware_image.c, the HCI LE Encrypt command to perform an AES128 encryption seems to hang in H5 (but works in H4). As a work around, BTstack was configured to use a CPU implementation of AES128 (#define HAVE_AES128). +- With the AP6212A on the RedBear Duo and the FW Mini Driver from WICED-SDK-3.5.2/libraries/drivers/bluetooth/firmware/43438A1/26MHz/bt_firmware_image.c, the HCI LE Encrypt command to perform an AES128 encryption hangs in H5 (but works in H4). See [Bug Report in Community Forum](https://community.cypress.com/thread/8424) As a work around, BTstack was configured to use a CPU implementation of AES128 (#define HAVE_AES128).