Skip to content

Commit 1022deb

Browse files
Add section 'Flashing tool' in guides/flashing.md to indicate the user how to select their flashing tool.
1 parent 7d90226 commit 1022deb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

guides/flashing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Before flashing code on your device, there are some things to be checked first.
1414

1515
Each template contains a make file located at the root of the template and is called `Makefile`. This make file contains a variable called `DEVICE`. This variable should contain the name of the device you want to compile your code for. You should format the name of your device like this: `STM32____x_`, where the "_" should be replaced by characters from the actual name (uppercase!) and the "x" is fixed. There are some exceptions to this naming scheme for STM32F4 devices, see the [Device name mapping page]({{ site.url }}/cheatsheets/device-name-mapping) for more information.
1616

17+
### Flashing tool
18+
19+
There are differennt interfaces (serial, I2C, SPI, SWD, etc.) and programs you can use to flash code to your device. Make sure to set the `FLASHING_TOOL` variable in your makefile to the name of your flashing tool. Currently the project has two options available:
20+
21+
- [st-flash](https://github.com/stlink-org/stlink) uses SWD interface. (default)
22+
- [stm32flash](https://github.com/stm32duino/stm32flash) uses serial interface.
23+
1724
### Connect an LED
1825

1926
This step is optional. You should not have to do this if your board already has an LED built-in.
@@ -41,6 +48,7 @@ Most development boards come with jumpers or (DIP-)switches to set the BOOT-mode
4148
Before flashing your device, make sure to have done all the things on this checklist:
4249

4350
- Make sure to change the `DEVICE` variable value in the make file to the name of your device;
51+
- Make sure to set the `FLASHING_TOOL` variable to the name of your flashing tool;
4452
- Make sure to have changed the pin to "blink" if the LED on your development board is not connected to pin `PC13`;
4553
- Optionally, make sure to connect an LED to your development board if your development board does not have one built-in;
4654
- Make sure that you have properly connected the debugger to your development board;

0 commit comments

Comments
 (0)