Skip to content

Commit 02b783f

Browse files
Add some new upload method vars
1 parent c9cf11d commit 02b783f

File tree

3 files changed

+51
-30
lines changed

3 files changed

+51
-30
lines changed

docs/getting-started/ide_cli_setup/vscode_setup.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,36 +28,36 @@ You can watch this part in video version - [Youtube guide](https://youtu.be/9ZDH
2828
// By using this setting, each variant has its own build dir.
2929
"cmake.buildDirectory": "${workspaceFolder}/build/${variant:board}-${variant:buildType}",
3030

31-
"cmake.generator": "Ninja"
31+
"cmake.generator": "Ninja",
32+
33+
// This reconfigures the UI to add variant & build target selection to the bottom bar, and to hide
34+
// features not used in embedded development.
35+
"cmake.configureOnOpen": false,
36+
"cmake.options.statusBarVisibility": "compact",
37+
"cmake.options.advanced": {
38+
"build": {
39+
"statusBarVisibility": "visible",
40+
"inheritDefault": "hidden"
41+
},
42+
"launch": {
43+
"statusBarVisibility": "visible",
44+
"inheritDefault": "hidden"
45+
},
46+
"debug": {
47+
"statusBarVisibility": "visible",
48+
"inheritDefault": "hidden"
49+
},
50+
"cpack": {
51+
"statusBarVisibility": "hidden",
52+
"inheritDefault": "hidden"
53+
},
54+
"workflow": {
55+
"statusBarVisibility": "hidden",
56+
"inheritDefault": "hidden"
57+
}
58+
}
3259
}
3360
```
34-
Optionally, you can add the below into the workspace or user `settings.json` file for more comfortable work. This will prevent CMake auto configuration directly after VS Code app starts and set the CMake bar to a more friendly look.
35-
```json
36-
"cmake.configureOnOpen": false,
37-
"cmake.options.statusBarVisibility": "compact",
38-
"cmake.options.advanced": {
39-
"build": {
40-
"statusBarVisibility": "visible",
41-
"inheritDefault": "hidden"
42-
},
43-
"launch": {
44-
"statusBarVisibility": "visible",
45-
"inheritDefault": "hidden"
46-
},
47-
"debug": {
48-
"statusBarVisibility": "visible",
49-
"inheritDefault": "hidden"
50-
},
51-
"cpack": {
52-
"statusBarVisibility": "hidden",
53-
"inheritDefault": "hidden"
54-
},
55-
"workflow": {
56-
"statusBarVisibility": "hidden",
57-
"inheritDefault": "hidden"
58-
}
59-
}
60-
```
6161

6262
2. If the project is new or does not already contain a `cmake-variants.yaml` file, you will need to create one in your project's root directory as below.
6363
This file does two things:

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ Below is the list of supported microcontroller families, by manufacturer. In gen
134134
| Nuvoton | M48x, M46x, M45x, Nano130, NUC472, M2354, M251, M261 |
135135
| Raspberry Pi | RP2040 |
136136
| Ambiq Micro | Apollo3 |
137-
| Infineon (formerly Cypress) | PSOC 62\*, PSOC 64\* |
138-
| Maxim | MAX32620\*, MAX32630\*, MAX32660\*, MAX32670\* |
137+
| Infineon (formerly Cypress) | PSOC 62, PSOC 64\* |
138+
| Maxim | MAX32620\*, MAX32630\*, MAX32660\*, MAX32670 |
139139
| Nordic Semiconductor | nRF52832, nRF52840 |
140140
| Renesas | RZ/A1xx\*, RZ/A2xx\* |
141141
| Silicon Labs | EFM32GG\* |

docs/upload-methods.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ Base address for uploading code, i.e. the memory address where the first byte of
5353

5454
*Note:* Unlike bin files, hex files contain a base address, which appears to be set based on the linker script. If the `output_ext` property in JSON is set to hex, uploading will use hex files instead of bin files, so the value of this parameter may not be respected by certain upload methods (e.g. J-Link). More investigation into this area may be needed.
5555

56+
> MBED_DEBUG_CORE_INDEX
57+
58+
**Type:** Integer
59+
60+
For multicore targets, this gives the index of the core that GDB should connect to. If unset, defaults to core 0.
61+
62+
See [here](https://pyocd.io/docs/multicore_debug.html) for more info about multicore debugging in PyOCD.
63+
64+
5665
## Common Options (for all methods)
5766

5867
> MBED_GDB_PORT
@@ -187,6 +196,18 @@ This config option specifies all OpenOCD commands needed to configure the progra
187196

188197
Acceptable version range of OpenOCD. This may be a single version (e.g. "0.12"), in which case it is treated as a minimum, or a versionMin...<versionMax constraint, e.g. "0.12...<0.13", to accept any 0.12.x version but not 0.13 or higher.
189198

199+
> OPENOCD_GDB_RESET_SEQUENCE
200+
201+
**Type:** List of Strings
202+
203+
Sequence of GDB commands that should be sent to cause a chip reset and halt. This defaults to just
204+
205+
```
206+
monitor reset halt
207+
```
208+
209+
but can be overridden to use chip-specific commands.
210+
190211
## STM32Cube
191212

192213
This uploader uses STMicroelectronics' official upload and debugging tools for its ST-LINK programmers. The upload tool can be obtained from the standalone [STM32CubeProg package](https://www.st.com/en/development-tools/stm32cubeprog.html), but for the GDB server you need the [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html)(3.3GB) or [STM32CubeCLT](https://www.st.com/en/development-tools/stm32cubeclt.html)(1.7GB), which includes both programs.

0 commit comments

Comments
 (0)