85 lines
2.3 KiB
Markdown
85 lines
2.3 KiB
Markdown
this firmware template is designed for development boards based around [STM32 F1 series micro-controller](http://www.st.com/web/en/catalog/mmc/FM141/SC1169/SS1031).
|
|
|
|
project
|
|
=======
|
|
|
|
summary
|
|
-------
|
|
|
|
*describe project purpose*
|
|
|
|
technology
|
|
----------
|
|
|
|
*described electronic details*
|
|
|
|
board
|
|
=====
|
|
|
|
The current implementation uses a [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board).
|
|
|
|
The underlying template also supports following board:
|
|
|
|
- [Maple Mini](http://leaflabs.com/docs/hardware/maple-mini.html), based on a STM32F103CBT6
|
|
- [System Board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#system_board), based on a STM32F103C8T6
|
|
- [blue pill](ihttps://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill), based on a STM32F103C8T6
|
|
- [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board), based on a STM32F103C8T6
|
|
|
|
**Which board is used is defined in the Makefile**.
|
|
This is required:
|
|
|
|
- for the linker script to know the memory layout (flash and RAM)
|
|
- map the user LED and button provided on the board
|
|
|
|
connections
|
|
===========
|
|
|
|
Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment):
|
|
|
|
- *list board to preipheral pin connections*
|
|
|
|
All pins are configured using `define`s in the corresponding source code.
|
|
|
|
code
|
|
====
|
|
|
|
dependencies
|
|
------------
|
|
|
|
The source code uses the [libopencm3](http://libopencm3.org/) library.
|
|
The projects is already a git submodules.
|
|
To initialize and it you just need to run once: `git submodule init` and `git submodule update`.
|
|
|
|
firmware
|
|
--------
|
|
|
|
To compile the firmware run `make`.
|
|
|
|
documentation
|
|
-------------
|
|
|
|
To generate doxygen documentation run `make doc`.
|
|
|
|
flash
|
|
-----
|
|
|
|
The firmware will be flashed using SWD (Serial Wire Debug).
|
|
For that you need an SWD adapter.
|
|
The `Makefile` uses a Black Magic Probe (per default), or a ST-Link V2 along OpenOCD software.
|
|
To flash using SWD run `make flash`.
|
|
|
|
debug
|
|
-----
|
|
|
|
SWD also allows to debug the code running on the micro-controller using GDB.
|
|
To start the debugging session run `make debug`.
|
|
|
|
USB
|
|
---
|
|
|
|
The firmware offers serial communication over USART1 and USB (using the CDC ACM device class).
|
|
|
|
You can also reset the board by setting the serial width to 5 bits over USB.
|
|
To reset the board run `make reset`.
|
|
This only works if the USB CDC ACM is running correctly and the micro-controller isn't stuck.
|