xref: /btstack/port/windows-h4-zephyr/README.md (revision da8e14c5aa3783b6bb7dd63e71572a901bcf168b)
1# BTstack Port for Windows Systems with Zephyr-based Controller
2
3The main difference to the regular windows-h4 port is that that the Zephyr Contoller uses 1000000 as baud rate.
4In addition, the port defaults to use the fixed static address stored during production.
5
6The port provides both a regular Makefile as well as a CMake build file. It uses native Win32 APIs for file access and does not require the Cygwin or mingw64 build/runtine. All examples can also be build with Visual Studio 2022 (e.g. Community Edition).
7
8## Prepare Zephyr Controller
9
10Please follow [this](https://devzone.nordicsemi.com/blogs/1059/nrf5x-support-within-the-zephyr-project-rtos/) blog post about how to compile and flash `samples/bluetooth/hci_uart` to a connected nRF5 dev kit.
11
12In short: you need to install an arm-none-eabi gcc toolchain and the nRF5x Command Line Tools incl. the J-Link drivers, checkout the Zephyr project, and flash an example project onto the chipset:
13
14  * Install [J-Link Software and documentation pack](https://www.segger.com/jlink-software.html).
15  * Get nrfjprog as part of the [nRFx-Command-Line-Tools](http://www.nordicsemi.com/eng/Products/Bluetooth-low-energy/nRF52-DK). Click on Downloads tab on the top and look for your OS.
16  * [Checkout Zephyr and install toolchain](https://www.zephyrproject.org/doc/getting_started/getting_started.html). We recommend using the [arm-non-eabi gcc binaries](https://launchpad.net/gcc-arm-embedded) instead of compiling it yourself. At least on OS X, this failed for us.
17
18  * In *samples/bluetooth/hci_uart*, compile the firmware for nRF52 Dev Kit
19
20      $ make BOARD=nrf52_pca10040
21
22   * Upload the firmware
23
24      $ make flash
25
26   * For the nRF51 Dev Kit, use `make BOARD=nrf51_pca10028`.
27
28## Configure serial port
29
30To set the serial port of your Zephyr Controller, you can either update config.device_name in main.c or
31always start the examples with the correct `-u COMx` option.
32
33## Visual Studio 2022
34
35Visual Studio can directly open the provided `port/windows-windows-h4-zephyr/CMakeLists.txt` and allows to compile and run all examples.
36
37## mingw64
38
39It can also be compiles with a regular Unix-style toolchain like [mingw-w64](https://www.mingw-w64.org).
40mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
41
42In the MSYS2 shell, you can install everything with pacman:
43
44    $ pacman -S git
45    $ pacman -S make
46    $ pacman -S mingw-w64-x86_64-toolchain
47    $ pacman -S python
48    $ pacman -S winpty
49
50## Compile Examples
51
52With mingw64-w64 installed, just go to the port/windows-h4-zephyr directory and run make
53
54    $ cd btstack/port/windows-h4-zephyr
55    $ make
56
57Note: When compiling with msys2-32 bit and/or the 32-bit toolchain, compilation fails
58as `conio.h` seems to be mission. Please use msys2-64 bit with the 64-bit toolchain for now.
59
60## Console Output
61
62When running the examples in the MSYS2 shell, the console input (via btstack_stdin_support) doesn't work. It works in the older MSYS and also the regular CMD.exe environment. Another option is to install WinPTY and then start the example via WinPTY like this:
63
64    $ winpty ./gatt_counter.exe
65
66The packet log will be written to hci_dump.pklg
67