riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: update Makefile.include instructions

Browse Source 
Specify the programmer using the PROGRAMMER variable, don't include programmer specific makefile and serial makefile
This commit is contained in:
Alexandre Abadie 2020-12-02 09:41:01 +01:00
parent 646e665a86
commit b31357eccc
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/doxygen/src/porting-boards.md
View File

@ -125,21 +125,31 @@ FEATURES_PROVIDED += periph_uart
### Makefile.include {#makefile-include} ### Makefile.include {#makefile-include}
This file contains BSP or toolchain configurations for the `BOARD`. It This file contains BSP or toolchain configurations for the `BOARD`. It
should at least define the configuration needed for flashing (i.e. a should at least define the configuration needed for flashing (i.e. specify a
programmer) as well as the serial configuration (if one is available). default programmer) as well as the serial configuration (if one is available).
The default serial port configuration is provided by
`makefiles/tools/serial.inc.mk` and define the following values for the serial
port (depends on the host OS):
e.g.: ```
PORT_LINUX ?= /dev/ttyACM0
PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.usbmodem*)))
```
So if the board is also using this, there's no need to redefine these variables
in the board configuration.
For example a board that is using a custom serial port (via an USB to serial
adapter) and that is flashed using openocd by default would have the following
content in its `Makefile.include`:
```mk ```mk
# Define the default port depending on the host OS # Define the default port depending on the host OS
PORT_LINUX ?= /dev/ttyUSB0 PORT_LINUX ?= /dev/ttyUSB0
PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.usbserial*))) PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.usbserial*)))
# setup serial terminal
include $(RIOTMAKE)/tools/serial.inc.mk
# this board uses openocd # this board uses openocd
include $(RIOTMAKE)/tools/openocd.inc.mk PROGRAMMER ?= openocd
``` ```
## doc.txt {#board-doc} ## doc.txt {#board-doc}