stm32-f4discovery-cc256x: update REAMDE for CMake

This commit is contained in:
Matthias Ringwald 2025-01-14 11:51:05 +01:00
parent e0450d1ec7
commit d5880e8db0

View File

@ -1,7 +1,7 @@
# BTstack Port for STM32 F4 Discovery Board with CC256x
This port uses the STM32 F4 Discovery Board with TI's CC256XEM ST Adapter Kit that allows to plug in a CC256xB or CC256xC Bluetooth module.
STCubeMX was used to provide the HAL, initialize the device, and the Makefile. For easy development, Ozone project files are generated as well.
STCubeMX was used to provide the HAL, initialize the device, and create an initial CMakeLists.txt. For easy development, Ozone project files are generated as well.
## Hardware
@ -17,16 +17,18 @@ The module with the older CC2564B is around USD 20, while the one with the new C
## Software
To build all examples, run make
$ make
The build system uses CMake. To build all examples, run `cmake` and `make` in the build folder. The examples are built with
$ mkdir build
$ cd build
$ cmake ..
$ make
All examples and the .jedbug Ozone project files are placed in the 'build' folder.
## Flash And Run The Examples
The Makefile builds different versions:
Cmake builds different versions:
- example.elf: .elf file with all debug information
- example.bin: .bin file that can be used for flashing
@ -48,7 +50,7 @@ In src/btstack_config.h resp. in example/btstack_config.h of the generated proje
Also, the full packet log can be enabled in src/port.c resp. btstack/port/stm32-f4discovery-cc256x/src/port.c by uncommenting the hci_dump_init(..) line. The console output can then be converted into .pklg files for OS X PacketLogger or WireShark by running tool/create_packet_log.py
## GATT Database
In BTstack, the GATT Database is defined via the .gatt file in the example folder. The Makefile contains rules to update the .h file when the .gatt was modified.
In BTstack, the GATT Database is defined via the .gatt file in the example folder. The CMakeLists.txt contains rules to update the .h file when the .gatt was modified.
## Maintainer Notes - Updating The Port