xref: /btstack/port/windows-winusb/README.md (revision 29502c9b6278f5ef85634162beef9b6a43c78688)
1# BTstack Port for Windows Systems using the WinUSB Driver
2
3The Windows-WinUSB port uses the native run loop and WinUSB API to access a USB Bluetooth dongle.
4
5The 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).
6
7## Access to Bluetooth USB Dongle with Zadig
8
9To allow WinUSB to access an USB Bluetooth dongle, you need to install a special device driver to make it accessible to user space processes.
10
11It works like this:
12
13-  Download [Zadig](http://zadig.akeo.ie)
14-  Start Zadig
15-  Select Options -> “List all devices”
16-  Select USB Bluetooth dongle in the big pull down list
17-  Select WinUSB in the right pull down list
18-  Select “Replace Driver”
19
20![Zadig showing CYW20704A2](zadig-cyw20704.png)
21
22After the new driver was installed, your device is shown in the Device Manager with Device Provider 'libwdi'
23
24![Device Manager showing CYW20704A2](device-manager-cyw20704.png)
25
26## Visual Studio 2022
27
28Visual Studio can directly open the provided `port/windows-winusb/CMakeLists.txt` and allows to compile and run all examples.
29For this, the C++ CMake tools for Windows is required. They are part of the Desktop development with C++ workloads.
30
31## mingw64
32
33It can also be compiles with a regular Unix-style toolchain like [mingw-w64](https://www.mingw-w64.org).
34mingw64-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.'
35
36In the MSYS2 shell, you can install everything with pacman:
37
38    $ pacman -S git
39    $ pacman -S cmake
40    $ pacman -S make
41    $ pacman -S mingw-w64-x86_64-toolchain
42    $ pacman -S mingw-w64-x86_64-portaudio
43    $ pacman -S python
44    $ pacman -S winpty
45
46### Compilation with CMake
47
48With mingw64-w64 installed, just go to the port/windows-h4 directory and use CMake as usual
49
50    $ cd port/windows-h4
51    $ mkdir build
52    $ cd build
53    $ cmake ..
54    $ make
55
56Note: When compiling with msys2-32 bit and/or the 32-bit toolchain, compilation fails
57as `conio.h` seems to be mission. Please use msys2-64 bit with the 64-bit toolchain for now.
58
59## Console Output
60
61When 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:
62
63    $ winpty ./spp_and_le_counter.exe
64
65