Skip to content

Commit 9e059a6

Browse files
Add docs for new upload method
1 parent bb1889d commit 9e059a6

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

tools/cmake/UploadMethodConfig-Sample.cmake

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ set(GDB_PORT 23331)
1616
# -------------------------------------------------------------
1717

1818
set(MBED_UPLOAD_ENABLED TRUE)
19+
set(MBED_RESET_BAUDRATE 9600)
1920

2021
# Config options for JLINK
2122
# -------------------------------------------------------------

tools/cmake/UploadMethods.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This controls the port that GDB servers will be run on when debugging. A value
3737

3838
## MBed USB Upload Method
3939

40-
This upload method interfaces with standard MBed boards which present themselves as USB drives. Given the folder where the USB drive is mounted, it first removes any other .bin files from the folder, then automatically copies the compiled program on.
40+
This upload method interfaces with standard MBed boards which present themselves as USB drives. The Mbed python tools are used to automatically locate and flash boards connected to the system.
4141

4242
### Parameters
4343

@@ -47,13 +47,21 @@ This upload method interfaces with standard MBed boards which present themselves
4747

4848
Whether the MBed upload method can be activated.
4949

50+
> MBED_RESET_BAUDRATE
51+
52+
**Type:** Integer
53+
54+
**Default:** 9600
55+
56+
On some boards, Mbed Tools has to connect to the board's serial port in order to reset them. This configuration requires Mbed Tools to know the board rate the board is operating at (though you can also likely get away with setting a slower baud rate here than what's in use).
57+
5058
### Options
5159

52-
> MBED_DRIVE_PATH
60+
> MBED_TARGET_UID
5361
54-
**Type:** Folder Path
62+
**Type:** String
5563

56-
Path that the MBed device is mounted to on your machine. On Windows, this is usually a drive letter, such as `D:/`.
64+
UID of the Mbed board to be programmed. This is only needed if multiple of the same target are connected to your machine -- if it is not set, any one target will be flashed. You can get a the list of UIDs from `python -m pyocd list`.
5765

5866
## J-Link Upload Method
5967

tools/cmake/upload_methods/UploadMethodMBED.cmake

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# This method needs the following parameters:
33
# MBED_RESET_BAUDRATE - Serial baudrate to connect to the target at when resetting it.
44
# This method creates the following options:
5-
# MBED_TARGET_UID - Probe UID to pass to pyOCD commands. You can get the UIDs from `python -m pyocd list`.
5+
# MBED_TARGET_UID - Probe UID to pass to commands. You can get the UIDs from `python -m pyocd list`.
66

77
set(UPLOAD_SUPPORTS_DEBUG FALSE)
88

@@ -11,7 +11,6 @@ check_python_package(mbed_os_tools HAVE_MBED_OS_TOOLS)
1111
set(UPLOAD_MBED_FOUND ${HAVE_MBED_OS_TOOLS})
1212

1313
if(NOT DEFINED MBED_RESET_BAUDRATE)
14-
message(STATUS "No MBED_RESET_BAUDRATE defined in upload method config file. Using default of 9600")
1514
set(MBED_RESET_BAUDRATE 9600)
1615
endif()
1716

0 commit comments

Comments
 (0)