CuVoodoo STM32F1 firmware template
README.md
1 This is the firmware for the [BusVoodoo](https://bus.cuvoodoo.info/).
2 
3 project
4 =======
5 
6 summary
7 -------
8 
9 The BusVoodoo is a multi-protocol debugging adapter.
10 This tool allows to quickly communicate with various other electronic devices.
11 
12 An overview of the BusVoodoo can be found [here](https://bus.cuvoodoo.info/)
13 A more detailed manual is available [here](https://bus.cuvoodoo.info/manual/).
14 
15 USB
16 ---
17 
18 The firmware offers serial communication over USART 1 and USB (using the CDC ACM device class).
19 
20 board
21 =====
22 
23 The BusVoodoo uses the a [custom board](https://bus.cuvoodoo.info/manual/index.html#_hardware_development) based on an [STM32F103RC](http://www.st.com/en/microcontrollers/stm32f103rc.html) micro-controller.
24 
25 firmware
26 ========
27 
28 binaries
29 --------
30 
31 There are two firmware files:
32 
33 - _bootloader_: a USB DFU bootloader
34 - _application_: the main application
35 
36 flash
37 -----
38 
39 How to flash the binary firmware files in described in the [manual](https://bus.cuvoodoo.info/manual/index.html#_flashing).
40 
41 source
42 ------
43 
44 The source code is available in [git](https://git.cuvoodoo.info/busvoodoo_firmware/), under the **busvoodoo** branch (or **busvoodoo_v0** for hardware version 0).
45 This firmware also uses the [LibOpenCM3](http://libopencm3.org/) library.
46 
47 development
48 -----------
49 
50 For information about firmware development, check the _HACKING.md_ instructions.