mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-01-05 21:59:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

esp32: copywriting

Browse Source
This commit is contained in:
Matthias Ringwald 2017-05-04 23:50:49 +02:00
parent 2d4acfc3f8
commit 5d426cd2e5
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
port/esp32/README.md
View File

@ -4,47 +4,50 @@ Status: Basic port incl. all examples. BTstack runs on dedicated FreeRTOS thread
## Setup
- Follow [Espressif IoT Development Framework (IDF) setup](https://github.com/espressif/esp-idf) to install xtensa toolchain.
- Checkout our [esp-idf fork](https://github.com/mringwal/esp-idf) make IDF_PATH point to it.
- In port/esp32, configure serial port for firmware upload as described before
- Follow [Espressif IoT Development Framework (ESP-IDF) setup](https://github.com/espressif/esp-idf) to install XTensa toolchain and the ESP-IDF.
- In port/esp32, configure the serial port for firmware upload as described in the ESP-IDF setup guides.
## Usage
In port/esp32, run
./create_examples.py
Now, it creates project folders for all examples. Inside an example, e.g. in port/esp32/spp_and_le_counter, run
The script will create project folders for all examples. Each example project folder, e.g. port/esp32/spp_and_le_counter, contains a Makefile.
To compile the example, run:
make
to compile the example
Run
To upload the binary to your device, run:
make flash
to upload it to your device.
Run
To get the debug output, run:
make monitor
to get the debug output. You can quit the monitor with CTRL-]
You can quit the monitor with CTRL-].
## Limitations
### Broken Host Controller to Host Flow Control
There's currently no way to let the virtual HCI (VHCI) of the ESP32 know when data cannot be processed fast enough. For most applications, this won't be an issue, but please keep it in mind. See https://github.com/espressif/esp-idf/issues/480
### Bug in ESP32 VHCI implementation
The Host Controller to Host Flow Control of the Virtual HCI (VHCI) on the ESP32 does not work currently. Without it, it is not possible to slow down incoming data. For most applications, this won't be an issue, but please keep it in mind. See https://github.com/espressif/esp-idf/issues/480
### Multi-threading
BTstack is not thread-safe, but you're using a multi-threading OS. To call the BTstack API from other threads, there are currently two options:
BTstack is not thread-safe, but you're using a multi-threading OS. Any function that is called from BTstack, e.g. packet handlers, can directly call into BTstack without issues. For other situations, you need to provide some general 'do BTstack tasks' function and trigger BTstack to execute it on its thread.
To call a function from the BTstack thread, there are currently two options:
- *btstack_run_loop_freertos_single_threaded_execute_code_on_main_thread* allows to schedule a function callback from the BTstack thread. This function can call any BTstack function. Also, any function that is called from BTstack e.g. packet handler can directly call into BTstack without issues.
- Setup a BTstack Data Source (btstack_data_source_t) and enable the polling callback (DATA_SOURCE_CALLBACK_POLL). The process function set in the data source will be called in every iteration of the BTstack Run Loop. To trigger a run loop iteration from a different thread, you can call *btstack_run_loop_freertos_trigger*
- *btstack_run_loop_freertos_single_threaded_execute_code_on_main_thread* allows to directly schedule a function callback, i.e. 'do BTstack tasks' function, from the BTstack thread.
- Setup a BTstack Data Source (btstack_data_source_t):
set 'do BTstack tasks' function as its process function and enable its polling callback. (DATA_SOURCE_CALLBACK_POLL). The process function will be called in every iteration of the BTstack Run Loop. To trigger a run loop iteration, you can call *btstack_run_loop_freertos_trigger*.
With both options, the called function should check if there are any pending BTstack calls and execute them. The 'run on main thread' method is only provided by a few ports and requires a queue to store the calls. This should be used with care, since calling it multiple times could cause the queue to overflow.
With both options, the called function should check if there are any pending BTstack tasks and execute them.
The 'run on main thread' method is only provided by a few ports and requires a queue to store the calls. This should be used with care, since calling it multiple times could cause the queue to overflow.
We're considering different options to make BTstack thread-safe, but for now, please use one of the suggested options.
### Acknowledgments