Plain-text help output
Command line modes:
How STM32CubeMX is started and how long it stays open. Pick one first: it decides whether the tool answers a single command and exits, or keeps a session alive.
--query <cpn> [load options] -- <command> [--log-file <path> [--log-level <level>] [--log-overwrite]]: load one MCU, run one command, print JSON, then exit.
<cpn>: MCU reference name or commercial part number.
[load options]: options of the load command, for example project-context=CortexM7.
-- <command>: the separator, followed by the command to run.
[--log-file <path>]: write the normal STM32CubeMX log to a file, so that it does not pollute the JSON output.
[--log-level <level>]: trace, debug, info, warn, error or off.
[--log-overwrite]: truncate the log file instead of appending to it.
Best for: one question about one device, from a script or a build step, with no session to manage.
Limits: it loads the device on every call, which costs a few seconds each time, and the configuration
is lost when the process exits. Use --query-batch for several questions, -qi to keep the result.
Example: --query STM32H745XGHx -- get mcu name
With load options: --query STM32H745XGHx project-context=CortexM7 mpu-cache-preconfig=false -- get mcu peripherals
--query-batch <cpn> [load options] --and <command> [--and <command> ...] [--stop-on-error]: load one MCU once, run several commands, print one JSON line each, then exit.
<cpn>: MCU reference name or commercial part number.
[load options]: options of the load command, for example project-context=CortexM7.
--and <command>: the command to run. Repeat it for every command of the batch.
[--stop-on-error]: stop at the first failure. By default the batch continues.
[--log-file <path>]: write the normal STM32CubeMX log to a file, so that it does not pollute the JSON output.
[--log-level <level>]: trace, debug, info, warn, error or off.
[--log-overwrite]: truncate the log file instead of appending to it.
Best for: a known sequence of commands on one device. The device is loaded once, so it is much faster
than calling --query several times, and it still needs no session to manage.
Limits: the whole sequence is fixed before the run, so no command can depend on the answer of the
previous one. Use -qi when the next command depends on what the tool just answered.
Example: --query-batch STM32H745XGHx --and get mcu name --and get mcu peripherals
With load options: --query-batch STM32H745XGHx project-context=CortexM7 mpu-cache-preconfig=false --and get mcu name --and dma used_flows
Fail fast: --query-batch --stop-on-error STM32H745XGHx --and get mcu name --and dma used_flows
-qi [--log-file <path> [--log-level <level>] [--log-overwrite]]: keep an interactive session open and answer each command with one JSON line.
[--log-file <path>]: write the normal STM32CubeMX log to a file, so that it does not pollute the JSON output.
[--log-level <level>]: trace, debug, info (default), warn, error or off.
[--log-overwrite]: truncate the log file instead of appending to it.
Send one command per line on standard input; every answer is a JSON command result or event.
Wait for the {"event":"ready","ok":true,...} line before sending the first command.
End the session with exit_mx. The alias -iq behaves identically.
Best for: anything that builds a configuration step by step, and for a program that decides the next
command from the previous answer. The device is loaded once and the configuration is kept.
Limits: the caller owns the session; it must read the ready event, send exit_mx, and stop the process.
Answers are one JSON object per line, so avoid --pretty when a program parses them.
Example: -qi --log-file C:/logs/stm32cubemx-qi.log --log-level debug --log-overwrite
-iq [--log-file <path> [--log-level <level>] [--log-overwrite]]: alias of -qi.
Example: -iq --log-file C:/logs/stm32cubemx-qi.log
-q <script-file>: run a script with minimal console output, then exit.
<script-file>: path of the script file, one command per line.
Best for: replaying a fixed sequence unattended, for example from CI, when only the exit matters.
Limits: the console output is plain text, so a program cannot parse the result of each command.
Use -qs for the same script with a JSON result per command.
Example: -q C:/work/build-project.txt
-qs <script-file>: run a script and print the result of each command as JSON, then exit.
<script-file>: path of the script file, one command per line.
Best for: a fixed sequence whose per-command result has to be checked by a program.
Limits: the sequence is fixed before the run, exactly as with -q. Use -qi to react to an answer.
Example: -qs C:/work/build-project.txt
-i: open an interactive command prompt.
Best for: exploring the commands by hand, since the answers are meant to be read.
Limits: the answers are plain text and not stable, so no program should parse them. Use -qi instead.
Example: -i
-s <script-file>: run a script with the normal console output.
<script-file>: path of the script file, one command per line.
Best for: debugging a script, because the full application output stays visible.
Limits: the log noise is mixed with the command answers. Use -q or -qs once the script is stable.
Example: -s C:/work/build-project.txt
--pretty (-p): indent the JSON printed by every JSON mode.
It applies to --list, --jsonhelp, --htmlhelp, --query, --query-batch, -qi, -iq and -qs.
It can be placed anywhere on the command line.
Best for: reading an answer yourself, since the content is unchanged and stays parsable.
Limits: an indented answer spans several lines, which breaks a client that reads one JSON per line.
Leave it off in -qi automation.
Example: --pretty --query STM32G071RBTx status
Discovery modes:
Read-only lookups that answer questions about the databases and about a device. They never open or modify a project.
--list <target> [args] [--log-file <path> [--log-level <level>] [--log-overwrite]]: print read-only data as JSON, then exit.
<target>: what to list. Start with mcus, boards or examples; the discovery targets are listed below.
[args]: arguments of the selected target.
[--log-file <path>]: write the normal STM32CubeMX log to a file, so that it does not pollute the JSON output.
[--log-level <level>]: amount of detail kept in the log file:
trace
debug
info
warn
error
off
[--log-overwrite]: truncate the log file instead of appending to it.
MCU filtering:
--list mcus [--<field> <value>] [--limit <n>] [--verbose] [--memory]
filterable fields: family, package, core, line, cpn, ref, flashSize, ramTotal, quadspi and more
values match without case sensitivity; --quadspi 1:2 gives a range, --flashSize 2048 a minimum
--list mcus --help prints the full field reference
Board filtering:
--list boards [--<field> <value>] [--limit <n>] [--verbose] [--memory]
filterable fields: board, type, series, device, manufacturer, mx, bsp, connector, display and more
values match without case sensitivity; --led 2:4 gives a range, --led 2 a minimum
--list boards --help prints the full field reference
Example filtering:
--list examples [--<field> <value>] [--limit <n>] [--verbose]
filterable fields: name, board, mcu, series, line, type, keyword, middleware, toolchain and more
values match without case sensitivity
--list examples --help prints the full field reference
Load targets:
--list load-options <cpn>
Clock discovery targets:
--list discover-clock-multiplexers <mcu>
--list discover-clock-active-outputs <mcu>
--list discover-clock-dividers <mcu>
--list discover-clock-fractionals <mcu>
--list discover-clock-sources <mcu>
--list discover-clock-xbars <mcu>
--list discover-clocktree-controls <mcu> [hint] [--diagram|--no-diagram] [--diagram-path <path>]
Peripheral discovery targets:
--list discover-ip-instances <mcu> [filter]
--list discover-ip-parameters <mcu> [ip]
--list discover-ip-modes <mcu> [ip] [--verbose]
--list discover-ip-mode-params <mcu> <ip> <mode>
--list discover-mode-context <ip> <mode>
Best for: learning the exact device, peripheral, mode and parameter spellings before configuring
anything. It answers from the databases, so most targets need no device to be loaded.
Limits: it is read-only and exits after one answer; it can neither change nor generate a project.
Run it first, then apply what it reports with --query, --query-batch or -qi.
Example: --list mcus --family STM32U5 --log-file C:/logs/mx-list.log --log-level debug --log-overwrite
Help modes:
Ways to read this reference, as plain text, as JSON for a program, or as an HTML page.
--help [filter] [--output <path>]: print the command reference as plain text, then exit.
[filter]: text used to keep only the commands whose name or description contains it.
[--output <path>]: write the text to a file instead of standard output.
Best for: reading the reference in a terminal, or grepping it.
Limits: the layout is meant for a human; use --jsonhelp when a program has to read it.
Example: --help load --output load-help.txt
--jsonhelp [filter] [--verbose] [--output <path>]: print the command reference as a JSON document, then exit.
[filter]: text used to keep only the commands whose name or description contains it.
[--verbose]: also include the captured output lines in the document.
[--output <path>]: write the document to a file instead of standard output. The name must end in .json.
Best for: a program that has to discover the commands of the installed version by itself.
Limits: the full document is large; filter it, or write it to a file with --output.
Example: --jsonhelp load --output load-help.json
Full reference: --jsonhelp --verbose --output mx-help.json
--htmlhelp [filter] [--output <path>]: build a self-contained HTML command reference, then exit.
[filter]: text used to keep only the commands whose name or description contains it.
[--output <path>]: write the page to a file instead of standard output. The name must end in .html or .htm.
The page works offline and offers a search field, every command and ready to run examples.
Best for: browsing and searching the reference, and for sharing it with someone else.
Limits: it is one HTML file meant to be opened in a browser, not to be parsed.
Example: --htmlhelp --output mx-cli-help.html
Filtered page: --htmlhelp load --output load-help.html
Available commands:
Usage:
Help [filter]: list the available commands with their usage.
[filter]: text used to keep only the commands whose name or description contains it.
The command name is not case sensitive, so 'help' works as well.
Use 'htmlhelp' or 'jsonhelp' to get the same reference as an HTML page or a JSON document.
Example: help dma
script <file>: run every command written in a file.
<file>: path of the script file, one command per line.
Quote the path when it contains spaces.
The commands run in order, exactly as if they had been typed in the session.
Use 'export script <file>' to produce such a file from the current configuration.
Example: script "C:/work/build-project.txt"
exit: Exit process
modes: print the running modes of the command line.
It describes --list, --help, --jsonhelp, --htmlhelp, --query, --query-batch, the -qi and -iq
interactive modes and the script modes.
Example: modes
tooltip log on: write the content of the tooltips to the application log.
Used to capture the documentation shown in the user interface.
Example: tooltip log on
tooltip log off: stop writing the content of the tooltips to the application log.
Example: tooltip log off
log <level>: set how much detail the application log keeps.
<level>: one of the supported values:
- trace
- debug
- info
- warn
- error
- off
In the JSON modes it needs a session started with --log-file <path>, so the log never mixes
with the answers on standard output.
Example: log debug
jsonhelp [filter] [--verbose] [--output <path>]
print the complete help as a JSON document, from inside a session.
[filter]: text used to keep only the commands whose name or description contains it.
[--verbose]: add the raw help lines to the document.
[--output <path>]: write the document to a file instead of the console.
The name must end in .json.
It produces the same document as the --jsonhelp start-up mode.
Example: jsonhelp load --output load-help.json
htmlhelp [filter] [--output <path>]
produce the command reference as a single self-contained HTML page.
[filter]: text used to keep only the commands whose name or description contains it.
[--output <path>]: write the page to a file instead of the console.
The name must end in .html or .htm.
The page works offline and offers a search field over every command.
Example: htmlhelp --output stm32cubemx-help.html
status: summarise the state of the session.
It takes no argument and always succeeds, so it can be used to probe a session at any time.
In the JSON modes the data object holds:
- version: the running STM32CubeMX version.
- modelLoaded: true once an MCU or a configuration is loaded.
- mcu, cpn, family, package, die, board: the loaded device, empty when nothing is loaded.
- iocPath, iocSaved: the .ioc file attached to the configuration and whether it exists on
disk.
- projectName, projectPath, toolchain: the project settings used by 'project generate'.
- activeContext, contexts: the selected context and every context of the device.
- dirty: true when the configuration has unsaved changes.
- generationStatus: success, warning, failure, or unknown when nothing was generated yet.
- lastGeneration: null when nothing was generated in this session, otherwise an object with
- command, result, outcome, status, message, outputPath, warnings and timestamp.
The generation fields describe the last 'generate code' or 'project generate' of the
session, and they are reset when another device or configuration is loaded.
Outside the JSON modes the same information is printed as one field per line.
Example: status
load-options <ref-or-cpn>
report everything needed to write a non-interactive load command for a device.
<ref-or-cpn>: MCU reference name or commercial part number, for example STM32H745ZITx.
It validates the device, lists the project-context values with their description, tells
whether the mpu-cache-preconfig option applies, and returns a ready to use load command.
Run it before 'load' in any script, so that no popup blocks the session.
Example: load-options STM32H745ZITx
load <ref-or-cpn> [project-context=<value>] [mpu-cache-preconfig=<true|false>]
create a new configuration for the given STM32 device.
<ref-or-cpn>: MCU reference name or commercial part number, for example STM32H745ZITx or
STM32H745ZIT6.
project-context=<value> (alias pctx): project type to create, also called context project.
It has nothing to do with the 'context' argument of the IP commands.
The available values depend on the device: multi-core devices expose one value per core (for
example CortexM7, CortexM4) and TrustZone capable devices expose TrustZoneEnabled and
TrustZoneDisabled.
Run 'load-options <ref-or-cpn>' to get the exact values and their description for a given
device.
When the device offers several project types and this option is omitted, the tool asks for
the value with a popup, which blocks headless runs.
mpu-cache-preconfig=<true|false> (alias mcp): STM32H7, STM32F7 and STM32H5 devices only.
On the Cortex-M7 devices (STM32H7, STM32F7), when true, the Memory Protection Unit is
preconfigured with the recommended settings that optimize the speculative read accesses of
the Cortex-M7 core.
On the STM32H5 devices, when true, the instruction cache (ICACHE) is enabled and the Memory
Protection Unit is configured to access the OTP and RO areas, as recommended for best
performance.
These two options are the only ones accepted; any other argument is rejected.
They can be given in any order, and an option that does not apply to the selected device is
ignored.
For automation or headless use, run 'load-options <ref-or-cpn>' first.
It lists the available project-context values, reports which device specific options apply,
and returns a ready to use non-interactive load command.
Example: load STM32H745ZITx project-context=CortexM7 mpu-cache-preconfig=false
Same example with the aliases: load STM32H745ZITx pctx=CortexM7 mcp=false
selector list mcus [filters]: search the available selector entries.
Supported forms: --<field> <value>, --<field>=<value>, <field>=<value>, <free text>
Options: --limit <number>, --verbose | --v | -v, --json [<output path>], --mem|--memory
Filterable fields:
- adc10Ch, adc12, adc12Ch, adc14, adc14Ch, adc16, adc16Ch, adcTotal,
additionalInterfacesList, amctimer
- blockDiagramURL, boardsList, can, can2, canTotal, ccmRamSize, comp, connectivityList,
coprocessorTypeList, coproFrequency
- core, cpn, cryptographyList, cubeEnvironment, currentLow, currentRun, currentStandby,
dac12, description, dfsdm
- displayControllerList, docsList, dramSupport, dualBankFlash, e2promSize, ethernetList,
ethernetPort, extMemInterfacesList, fdcan, featuresDescription
- flashSize, flashSupportList, fmpi2c, fpuList, frequency, fullPackage,
graphicAcceleratorList, i2c, i2cTotal, i2s
- i3c, ioCount, ipcc, isFavorite, itcmDtcmRam, juncTempHigh, juncTempLow, line, linuart,
longDescription
- lptimer, lpuart, marketingStatus, mx2Supported, mxSupported, name, nbExamples, octospi,
opamp, otherTimerFunctionsList
- packageType, periphsList, pinCount, powerHigh, powerLow, price, productURL, quadspi,
quadspiTotal, ramSize
- ramTotal, refName, rpn, rxCurrent, rxSensitivity, sai, sdmmc, securityFunctionsList,
segment, series
- smps, spi, spiTotal, sramSize, tempHigh, tempLow, timer16, timer32, timer8, timerTotal
- txCurrent, uart, uartTotal, ucpd, usart, usb2, usbdrdfs, usbhhs, usbsList, voltageHigh
- voltageLow
Aliases:
- additionalInterfaces=additionalInterfacesList, boards=boardsList,
connectivity=connectivityList, coprocessorType=coprocessorTypeList, core=core,
cryptography=cryptographyList, displayController=displayControllerList, docs=docsList,
ethernet=ethernetList, extMemInterfaces=extMemInterfacesList
- family=series, flashSupport=flashSupportList, fpu=fpuList,
graphicAccelerator=graphicAcceleratorList, line=line, mcu=cpn, package=fullPackage,
part=cpn, periphs=periphsList, pkg=fullPackage
- ref=refName, rpn=rpn, securityFunctions=securityFunctionsList,
TimerFunctions=otherTimerFunctionsList, usbs=usbsList
Example: selector list mcus --family STM32H7 --core Cortex-M7
Example: selector list mcus flashSize=2048
Example: selector list mcus --flashSize 2048 --limit 10
Example: selector list mcus --quadspi 1:2
Example: selector list mcus --quadspi 2
Example: selector list mcus --family STM32H7 --memory
Example: selector list mcus --core Arm Cortex-M33 --flashSize 2048 --limit 10 --verbose
Example: selector list mcus LQFP Cortex-M7
selector list boards [filters]: search the available selector entries.
Supported forms: --<field> <value>, --<field>=<value>, <field>=<value>, <free text>
Options: --limit <number>, --verbose | --v | -v, --json [<output path>], --mem|--memory
Filterable fields:
- audioLineInput, audioLineOutput, audioProcessor, bigImageURL, bspSupported, button,
camera, can, connectorList, cpn
- cryptographyList, debugConnectorList, description, deviceType, displayList, docsList,
e2promSize, ethernetList, featuresDescription, flashSize
- fromKitList, imageFilename, initAllIp, isFavorite, isKitItem, joystick, kitContentsList,
led, longDescription, manufacturer
- marketingStatus, mcuSeries, memoryCard, microphone, mountedDevice, mxSupported,
nbExamples, onboardfeatureList, periphsList, potentiometer
- powersupplyList, price, productURL, ramSize, rpn, rs232, rs485, sensorList, smps, speaker
- stlinkList, supplier, touchFeatureList, type, usbPortList, wirelessList
Aliases:
- board=cpn, bsp=bspSupported, connector=connectorList, cryptography=cryptographyList,
debugConnector=debugConnectorList, device=mountedDevice, display=displayList,
docs=docsList, ethernet=ethernetList, favorite=isFavorite
- fromKit=fromKitList, kitContents=kitContentsList, mount=mountedDevice, mx=mxSupported,
onboardfeature=onboardfeatureList, periphs=periphsList, powersupply=powersupplyList,
price=price, sensor=sensorList, series=mcuSeries
- sfb=bspSupported, startFromBoard=bspSupported, stlink=stlinkList,
touchFeature=touchFeatureList, usbPort=usbPortList, wireless=wirelessList
Example: selector list boards --cpn NUCLEO-F030R8
Example: selector list boards --rpn NUCLEO-F030R8
Example: selector list boards --type Nucleo-64
Example: selector list boards --mcuSeries STM32F7
selector list examples [filters]: search the available selector entries.
Supported forms: --<field> <value>, --<field>=<value>, <field>=<value>, <free text>
Options: --limit <number>, --verbose | --v | -v, --json [<output path>]
Filterable fields:
- boardName, boardPeriphList, boardType, boardVendor, description, examplePath, hwList, id,
iocFilename, iocMxVersion
- isFavorite, keywordList, libraryType, longDescription, mainProject, marketingStatus,
mcuLine, mcuName, mcuPeriphList, mcuSeries
- middlewareList, mxCompatibleOption, name, projectMulti, projectType, swPackName,
swPackType, swPackVendor, swPackVersion, toolchainList
- version
Aliases:
- board=boardName, boardPeriph=boardPeriphList, hw=hwList, keyword=keywordList,
line=mcuLine, mcu=mcuName, mcuPeriph=mcuPeriphList, middleware=middlewareList,
mxCompatible=mxCompatibleOption, pack=swPackName
- project=name, series=mcuSeries, toolchain=toolchainList, type=projectType,
vendor=swPackVendor
Example: selector list examples --name Audio_playback_and_record
Example: selector list examples --version 1.0.0
Example: selector list examples --projectType Application
Example: selector list examples --boardName NUCLEO-G070RB
freertos add_task <name> <priority> <stack-words> <entry> [code-generation-option] [parameters]
[allocation] [buffer] [control-block] [--instance <ip-instance>]
add a task to the FreeRTOS configuration.
<name>: task name, a C identifier that no other FreeRTOS object uses yet.
<priority>: task priority.
The accepted values depend on the interface selected with 'set mode':
- CMSIS_V2: osPriorityLow to osPriorityRealtime7, for example osPriorityNormal
- CMSIS_V1: osPriorityIdle, osPriorityLow, osPriorityBelowNormal, osPriorityNormal,
osPriorityAboveNormal, osPriorityHigh, osPriorityRealtime
- native FreeRTOS: a decimal integer starting at 0
<stack-words>: stack size in words, not in bytes.
It must be at least configMINIMAL_STACK_SIZE.
<entry>: name of the task entry function, a C identifier different from the task name.
[code-generation-option]: how the entry function is generated, default when omitted:
- default
- weak
- external
[parameters]: argument passed to the entry function, NULL when omitted.
[allocation]: Dynamic or Static, Dynamic when omitted.
It must be allowed by MEMORY_ALLOCATION.
[buffer]: stack buffer name.
NULL for a Dynamic task, a C identifier for a Static task.
[control-block]: control block name.
NULL for a Dynamic task, a C identifier for a Static task.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
The optional fields are positional, so give the earlier ones to set a later one.
Keywords such as priority names, weak, static or null are not case sensitive.
Names and functions are.
Run 'freertos list_tasks' to check the result.
Example: freertos add_task worker osPriorityNormal 256 WorkerEntry
Example: freertos add_task logger osPriorityLow 512 LoggerEntry weak NULL Static loggerStack
loggerCb
Dual-core example: freertos add_task m7Worker osPriorityAboveNormal 256 M7WorkerEntry
--instance FREERTOS_M7
Dual-core example: freertos add_task m4Worker osPriorityNormal 256 M4WorkerEntry --instance
FREERTOS_M4
freertos update_task <name> [--priority <value>] [--stack <value>] [--entry <value>]
[--code-generation-option <value>] [--parameters <value>] [--allocation <value>] [--buffer
<value>] [--control-block <value>] [--instance <ip-instance>]
change some fields of an existing FreeRTOS task.
<name>: name of the task to change.
--priority <value>: new priority, with the same accepted values as 'freertos add_task'.
--stack <value>: new stack size in words.
It must be at least configMINIMAL_STACK_SIZE.
--entry <value>: new entry function name.
--code-generation-option <value>: how the entry function is generated:
- default
- weak
- external
--parameters <value>: new argument passed to the entry function.
--allocation <value>: Dynamic or Static.
Switching to Dynamic resets buffer and control-block to NULL unless they are given too.
--buffer <value>: stack buffer name, required with Static allocation.
--control-block <value>: control block name, required with Static allocation.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Give at least one option.
The fields not given keep their current value.
Options can come in any order, and each one can be given only once.
Option names and keywords are not case sensitive.
The task cannot be renamed.
Example: freertos update_task worker --stack 512
Example: freertos update_task worker --priority osPriorityAboveNormal
--code-generation-option weak
Example: freertos update_task worker --allocation Static --buffer workerStack
--control-block workerCb
Dual-core example: freertos update_task m4Worker --stack 384 --instance FREERTOS_M4
freertos delete_task <name> [--instance <ip-instance>]
remove a task from the FreeRTOS configuration.
<name>: name of the task to remove.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
The first task, defaultTask by default, initializes the middleware and cannot be removed.
Example: freertos delete_task worker
Dual-core example: freertos delete_task m7Worker --instance FREERTOS_M7
freertos add_queue <name> <length> <item-type> [allocation] [buffer] [control-block] [--instance
<ip-instance>]
add a message queue to the FreeRTOS configuration.
<name>: queue name, a C identifier that no other FreeRTOS object uses yet.
<length>: maximum number of items the queue holds, a decimal integer of at least 1.
<item-type>: C type of one item, for example uint16_t or struct msg_t, or its size in bytes.
Quote the type when it contains spaces.
[allocation]: Dynamic or Static, Dynamic when omitted.
It must be allowed by MEMORY_ALLOCATION.
[buffer]: storage buffer name.
NULL for a Dynamic queue, a C identifier for a Static queue.
[control-block]: control block name.
NULL for a Dynamic queue, a C identifier for a Static queue.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Keywords such as static or null are not case sensitive.
Run 'freertos list_queues' to check the result.
Example: freertos add_queue messages 16 uint32_t
Example: freertos add_queue events 8 uint16_t Static eventsBuffer eventsCb
Dual-core example: freertos add_queue m4Messages 16 uint32_t --instance FREERTOS_M4
freertos update_queue <name> [--length <value>] [--item-type <value>] [--allocation <value>]
[--buffer <value>] [--control-block <value>] [--instance <ip-instance>]
change some fields of an existing FreeRTOS queue.
<name>: name of the queue to change.
--length <value>: new maximum number of items, a decimal integer of at least 1.
--item-type <value>: new item C type or size in bytes.
--allocation <value>: Dynamic or Static.
Switching to Dynamic resets buffer and control-block to NULL unless they are given too.
--buffer <value>: storage buffer name, required with Static allocation.
--control-block <value>: control block name, required with Static allocation.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Give at least one option.
The fields not given keep their current value.
Options can come in any order, and each one can be given only once.
Option names and keywords are not case sensitive.
The queue cannot be renamed.
Example: freertos update_queue messages --length 32
Example: freertos update_queue messages --allocation Static --buffer msgBuffer
--control-block msgCb
Dual-core example: freertos update_queue m4Messages --item-type uint16_t --instance
FREERTOS_M4
freertos delete_queue <name> [--instance <ip-instance>]
remove a message queue from the FreeRTOS configuration.
<name>: name of the queue to remove.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Example: freertos delete_queue messages
Dual-core example: freertos delete_queue m4Messages --instance FREERTOS_M4
freertos add_timer <name> <callback> <type> [code-generation-option] [parameters] [allocation]
[control-block] [--instance <ip-instance>]
add a software timer to the FreeRTOS configuration.
<name>: timer name, a C identifier that no other FreeRTOS object uses yet.
<callback>: name of the callback function, a C identifier different from the timer name.
<type>: timer type.
The accepted values depend on the interface selected with 'set mode':
- CMSIS_V1 and CMSIS_V2: osTimerOnce or osTimerPeriodic
- native FreeRTOS: one-shot or auto-reload
[code-generation-option]: how the callback function is generated, default when omitted:
- default
- weak
- external
[parameters]: argument passed to the callback, NULL when omitted.
[allocation]: Dynamic or Static, Dynamic when omitted.
It must be allowed by MEMORY_ALLOCATION.
[control-block]: control block name.
NULL for a Dynamic timer, a C identifier for a Static timer.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
The configUSE_TIMERS parameter must be enabled first.
The optional fields are positional, so give the earlier ones to set a later one.
Keywords such as the timer type, weak, static or null are not case sensitive.
Run 'freertos list_timers' to check the result.
Example: freertos add_timer blink BlinkCallback osTimerPeriodic
Example: freertos add_timer timeout TimeoutCallback osTimerOnce external NULL Static
timeoutCb
Dual-core example: freertos add_timer m7Blink M7BlinkCallback osTimerPeriodic --instance
FREERTOS_M7
freertos update_timer <name> [--callback <value>] [--type <value>] [--code-generation-option
<value>] [--parameters <value>] [--allocation <value>] [--control-block <value>] [--instance
<ip-instance>]
change some fields of an existing FreeRTOS timer.
<name>: name of the timer to change.
--callback <value>: new callback function name.
--type <value>: new timer type, with the same accepted values as 'freertos add_timer'.
--code-generation-option <value>: how the callback function is generated:
- default
- weak
- external
--parameters <value>: new argument passed to the callback.
--allocation <value>: Dynamic or Static.
Switching to Dynamic resets control-block to NULL unless it is given too.
--control-block <value>: control block name, required with Static allocation.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Give at least one option.
The fields not given keep their current value.
Options can come in any order, and each one can be given only once.
Option names and keywords are not case sensitive.
The timer cannot be renamed.
Example: freertos update_timer blink --type osTimerOnce
Example: freertos update_timer blink --callback OnBlink --code-generation-option weak
Dual-core example: freertos update_timer m7Blink --type osTimerOnce --instance FREERTOS_M7
freertos delete_timer <name> [--instance <ip-instance>]
remove a software timer from the FreeRTOS configuration.
<name>: name of the timer to remove.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Example: freertos delete_timer blink
Dual-core example: freertos delete_timer m7Blink --instance FREERTOS_M7
freertos add_binary_semaphore <name> <initial-state> [allocation] [control-block] [--instance
<ip-instance>]
add a binary semaphore to the FreeRTOS configuration.
<name>: semaphore name, a C identifier that no other FreeRTOS object uses yet.
<initial-state>: state of the semaphore when it is created:
- Available
- Depleted
[allocation]: Dynamic or Static, Dynamic when omitted.
It must be allowed by MEMORY_ALLOCATION.
[control-block]: control block name.
NULL for a Dynamic semaphore, a C identifier for a Static semaphore.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Keywords such as available, static or null are not case sensitive.
Run 'freertos list_binary_semaphores' to check the result.
Example: freertos add_binary_semaphore dataReady Depleted
Example: freertos add_binary_semaphore txDone Available Static txDoneCb
Dual-core example: freertos add_binary_semaphore m4DataReady Depleted --instance FREERTOS_M4
freertos update_binary_semaphore <name> [--initial-state <value>] [--allocation <value>]
[--control-block <value>] [--instance <ip-instance>]
change some fields of an existing FreeRTOS binary semaphore.
<name>: name of the semaphore to change.
--initial-state <value>: new initial state, Available or Depleted.
--allocation <value>: Dynamic or Static.
Switching to Dynamic resets control-block to NULL unless it is given too.
--control-block <value>: control block name, required with Static allocation.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Give at least one option.
The fields not given keep their current value.
Option names and keywords are not case sensitive.
The semaphore cannot be renamed.
Example: freertos update_binary_semaphore dataReady --initial-state Available
Example: freertos update_binary_semaphore dataReady --allocation Static --control-block
dataReadyCb
Dual-core example: freertos update_binary_semaphore m4DataReady --initial-state Available
--instance FREERTOS_M4
freertos delete_binary_semaphore <name> [--instance <ip-instance>]
remove a binary semaphore from the FreeRTOS configuration.
<name>: name of the semaphore to remove.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Example: freertos delete_binary_semaphore dataReady
Dual-core example: freertos delete_binary_semaphore m4DataReady --instance FREERTOS_M4
freertos add_counting_semaphore <name> <max-count> <initial-count> [allocation] [control-block]
[--instance <ip-instance>]
add a counting semaphore to the FreeRTOS configuration.
<name>: semaphore name, a C identifier that no other FreeRTOS object uses yet.
<max-count>: highest count the semaphore can reach, a decimal integer of at least 1.
<initial-count>: count when the semaphore is created, from 0 to max-count.
[allocation]: Dynamic or Static, Dynamic when omitted.
It must be allowed by MEMORY_ALLOCATION.
[control-block]: control block name.
NULL for a Dynamic semaphore, a C identifier for a Static semaphore.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
The configUSE_COUNTING_SEMAPHORES parameter must be enabled first.
Keywords such as static or null are not case sensitive.
Run 'freertos list_counting_semaphores' to check the result.
Example: freertos add_counting_semaphore slots 4 4
Example: freertos add_counting_semaphore credits 10 0 Static creditsCb
Dual-core example: freertos add_counting_semaphore m7Slots 4 0 --instance FREERTOS_M7
freertos update_counting_semaphore <name> [--max-count <value>] [--initial-count <value>]
[--allocation <value>] [--control-block <value>] [--instance <ip-instance>]
change some fields of an existing FreeRTOS counting semaphore.
<name>: name of the semaphore to change.
--max-count <value>: new highest count, a decimal integer of at least 1.
--initial-count <value>: new initial count, from 0 to the maximum count.
--allocation <value>: Dynamic or Static.
Switching to Dynamic resets control-block to NULL unless it is given too.
--control-block <value>: control block name, required with Static allocation.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Give at least one option.
The fields not given keep their current value.
The initial count is checked against the maximum count after the change.
Option names and keywords are not case sensitive.
The semaphore cannot be renamed.
Example: freertos update_counting_semaphore slots --max-count 8 --initial-count 8
Dual-core example: freertos update_counting_semaphore m7Slots --initial-count 2 --instance
FREERTOS_M7
freertos delete_counting_semaphore <name> [--instance <ip-instance>]
remove a counting semaphore from the FreeRTOS configuration.
<name>: name of the semaphore to remove.
--instance <ip-instance>: FreeRTOS instance to change, for example FREERTOS_M7 or
FREERTOS_M4 on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
Example: freertos delete_counting_semaphore slots
Dual-core example: freertos delete_counting_semaphore m7Slots --instance FREERTOS_M7
freertos list_tasks [--instance <ip-instance>]
print the tasks of a FreeRTOS instance with all their fields.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints a title line with the count, a header line, then one tab-separated line per task.
It never changes the configuration.
Example: freertos list_tasks
Dual-core example: freertos list_tasks --instance FREERTOS_M4
freertos list_queues [--instance <ip-instance>]
print the message queues of a FreeRTOS instance with all their fields.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints a title line with the count, a header line, then one tab-separated line per queue.
It never changes the configuration.
Example: freertos list_queues
Dual-core example: freertos list_queues --instance FREERTOS_M4
freertos list_timers [--instance <ip-instance>]
print the software timers of a FreeRTOS instance with all their fields.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints a title line with the count, a header line, then one tab-separated line per timer.
It never changes the configuration.
Example: freertos list_timers
Dual-core example: freertos list_timers --instance FREERTOS_M7
freertos list_binary_semaphores [--instance <ip-instance>]
print the binary semaphores of a FreeRTOS instance with all their fields.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints a title line with the count, a header line, then one tab-separated line per
semaphore.
It never changes the configuration.
Example: freertos list_binary_semaphores
Dual-core example: freertos list_binary_semaphores --instance FREERTOS_M4
freertos list_counting_semaphores [--instance <ip-instance>]
print the counting semaphores of a FreeRTOS instance with all their fields.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints a title line with the count, a header line, then one tab-separated line per
semaphore.
It never changes the configuration.
Example: freertos list_counting_semaphores
Dual-core example: freertos list_counting_semaphores --instance FREERTOS_M7
freertos list_all [--instance <ip-instance>]
print the tasks, queues, timers, binary and counting semaphores of a FreeRTOS instance.
--instance <ip-instance>: FreeRTOS instance to read, for example FREERTOS_M7 or FREERTOS_M4
on a dual-core STM32H745.
Leave it out when a single FreeRTOS instance is enabled.
It is required when several are enabled.
It prints the same sections as the five list commands, one after the other.
It never changes the configuration.
Example: freertos list_all
Dual-core example: freertos list_all --instance FREERTOS_M7
Dual-core example: freertos list_all --instance FREERTOS_M4
config load <ioc-file>: open a saved configuration.
<ioc-file>: path of the .ioc file to open.
It replaces the configuration currently loaded.
Use 'load <ref-or-cpn>' instead to start from an empty configuration for a device.
Example: config load C:/work/hello_uart/hello_uart.ioc
config save: save the current configuration into the file it was opened from.
Use 'config saveas <ioc-file>' when no file is attached to the configuration yet.
Example: config save
config saveas <ioc-file>: save the current configuration into a new file.
<ioc-file>: path of the .ioc file to write.
The following 'config save' calls reuse it.
Example: config saveas C:/work/hello_uart/hello_uart.ioc
exit_mx: close STM32CubeMX, as the Exit menu entry does.
End every script with this command so that the process stops.
Example: exit_mx
get version: print the running STM32CubeMX version.
Example: get version
generate code <path>: generate the code of the loaded configuration into a directory.
<path>: destination directory of the generated code.
Use 'project generate' instead to produce a complete toolchain project.
Example: generate code C:/work/hello_uart
set tpl_path <path>: set the directory holding the user code-generation templates.
<path>: directory containing the .ftl template files.
Example: set tpl_path C:/work/templates
set dest_path <path>
set the directory where the files produced from the user templates are written.
<path>: destination directory, relative to the project folder or absolute.
Example: set dest_path C:/work/hello_uart/generated
get tpl_path: print the directory holding the user code-generation templates.
Example: get tpl_path
get dest_path: print the directory where the files produced from the user templates are written.
Example: get dest_path
setprop <property> <value>: set a Java system property of the running process.
<property>: name of the property.
<value>: value to give it.
Example: setprop MX_SKIP_POPUP true
getprop <property>: print a Java system property of the running process.
<property>: name of the property.
Example: getprop java.version
getenv <variable>: print an environment variable of the running process.
<variable>: name of the variable.
Example: getenv PATH
xcopy <vendor> <version> <example> <example path> [ide] [copy fw] [target path] [fw path]
[board]
copy a Cube example out of a software pack and open it.
<vendor>: software pack vendor, for example STMicroelectronics.
<version>: full pack name with its version, for example X-CUBE-BLE2_V3.2.0.
<example>: name of the example to copy, for example Beacon.
<example path>: path of the example inside the pack, for example
/Projects/NUCLEO-L476RG/Applications/Beacon.
[ide]: toolchain the example is opened for, all by default:
- all
- iar
- keil
- swb
- cube
[copy fw]: how much firmware is copied next to the example, LITE by default:
- NONE
- LITE
- FULL
[target path]: folder the example is copied to.
Defaults to $HOME/STM32CubEX.
[fw path]: firmware repository to copy from.
Defaults to $HOME/STM32Cube/Repository.
[board]: board the example targets, for example NUCLEO-L476RG.
Empty by default.
Pass an empty string to keep the default of an optional argument you want to skip.
Example: xcopy "STMicroelectronics" "X-CUBE-BLE2_V3.2.0" "Beacon"
"/Projects/NUCLEO-L476RG/Applications/Beacon" "all" "LITE" "" "" "NUCLEO-L476RG"
popupwrapper set: answer the popups automatically instead of waiting for a user.
Declare the answers with 'popupwrapper record_answer'; it is what makes a script run
unattended.
Example: popupwrapper set
popupwrapper unset: stop answering the popups automatically.
Example: popupwrapper unset
popupwrapper record_answer <title> <answer>: decide in advance how a popup is answered.
<title>: title of the popup to answer.
<answer>: one of the supported values:
- OK
- YES
- NO
- CANCEL
- CLOSE
- BUTTON_1 to BUTTON_9
Call 'popupwrapper set' as well, otherwise the recorded answers are not used.
Example: popupwrapper record_answer "Code Generation" YES
popupwrapper unrecord_answer <title>: forget the answer recorded for a popup.
<title>: title of the popup.
Example: popupwrapper unrecord_answer "Code Generation"
xcubedl <pack>: download an X-CUBE expansion package.
<pack>: full name of the package to download.
Use 'swmgr install' to install a package that is already downloaded.
Example: xcubedl X-CUBE-AI
set mode <peripheral> <mode>: activate a mode on a peripheral.
<peripheral>: peripheral instance name, for example USART2, TIM1 or ADC1.
<mode>: name of the mode to activate, for example Asynchronous.
For a third party component the form is: set mode <third party> <bundle> <class>
Run 'get mode available <peripheral>' to list the modes you can activate.
On a multi-context device prefer 'set mode safe', which assigns the context first when it is
required.
Example: set mode USART2 Asynchronous
set mode safe <peripheral> <mode>
activate a mode, assigning the context first when the device requires it.
<peripheral>: peripheral instance name, for example USART2, TIM1 or ADC1.
<mode>: name of the mode to activate, for example Asynchronous.
This is the recommended form in scripts: on failure it prints the commands to run to make
the mode reachable.
Example: set mode safe USART2 Asynchronous
set username <peripheral> <name>: give a user label to a peripheral instance.
<peripheral>: peripheral instance name, for example USART2.
<name>: label shown in the user interface and used in the generated code comments.
Example: set username USART2 DEBUG_UART
get modes <peripheral>: list every leaf mode of the matching peripherals.
<peripheral>: regular expression matching the peripheral instance names; use .* for all of
them.
Example: get modes USART.*
get mapped modes <peripheral>: list the modes currently activated on the matching peripherals.
<peripheral>: regular expression matching the peripheral instance names; use .* for all of
them.
Example: get mapped modes .*
get mode <active|available|all> <peripheral>: list the modes of the matching peripherals.
<active|available|all>: active lists the modes already set, available the modes that can
still be set, all both of them.
<peripheral>: regular expression matching the peripheral instance names; use .* for all of
them.
Example: get mode available USART2
get mode_param_list <peripheral> <mode>: list the parameters of one active mode.
<peripheral>: peripheral instance name, for example USART2.
<mode>: name of a mode already activated on that peripheral.
Example: get mode_param_list USART2 Asynchronous
get mode_param_possvalue <peripheral> <mode> <parameter>
list the values accepted by one parameter of an active mode.
<peripheral>: peripheral instance name, for example USART2.
<mode>: name of a mode already activated on that peripheral.
<parameter>: parameter name, as returned by 'get mode_param_list'.
Example: get mode_param_possvalue USART2 Asynchronous WordLength
get mode_param_pattern <peripheral> <mode> <pattern>
list the parameters of an active mode whose name matches a pattern.
<peripheral>: peripheral instance name, for example USART2.
<mode>: name of a mode already activated on that peripheral.
<pattern>: regular expression matched against the parameter names.
Example: get mode_param_pattern USART2 Asynchronous Baud.*
get available modes <peripheral>
list the modes that can still be activated on the matching peripherals.
<peripheral>: regular expression matching the peripheral instance names; use .* for all of
them.
Example: get available modes TIM.*
get signal <pin>: print the signal currently mapped on a pin.
<pin>: pin name, for example PA9.
Example: get signal PA9
set pin <pin> <signal>: map a signal on a pin.
<pin>: pin name, for example PA9.
<signal>: signal to map, for example USART1_TX.
Run 'get functions <pin>' to list the signals a pin accepts.
Example: set pin PA9 USART1_TX
lock pin <pin> <locked>
lock or unlock the signal mapped on a pin so that it is not moved automatically.
<pin>: pin name, for example PA9.
<locked>: true to lock the pin, false to unlock it.
Example: lock pin PA9 true
reset pin <pin>: remove the signal mapped on a pin.
<pin>: pin name, for example PA9.
Example: reset pin PA9
set pinreservation <pin>: reserve a pin so that it is not used by the automatic pin allocation.
<pin>: pin name, for example PA9.
Example: set pinreservation PA9
reset pinreservation <pin>: release a pin previously reserved with 'set pinreservation'.
<pin>: pin name, for example PA9.
Example: reset pinreservation PA9
reset signal <signal>: unmap a signal from the pin it is currently assigned to.
<signal>: signal name, for example USART1_TX.
Example: reset signal USART1_TX
reset pin-signal <pin> <signal>: unmap one signal from one pin.
<pin>: pin name, for example PA9.
<signal>: signal mapped on that pin, for example USART1_TX.
Example: reset pin-signal PA9 USART1_TX
get pinout: print the pin mapping of the loaded MCU.
Use 'csv pinout <file>' to export the same information as a CSV file.
Example: get pinout
clearpinout: remove every signal mapped on the pins of the loaded MCU.
The peripheral modes are not reset, only the pin mapping is cleared.
The command fails when no MCU is loaded.
Example: clearpinout
get gpio parameters <pin> <parameter>: print the GPIO parameter values of the matching pins.
<pin>: regular expression matching the pin names, for example PA9 or PA.*.
<parameter>: regular expression matching the GPIO parameter names, for example GPIO_Pu.* or
.* for all of them.
Example: get gpio parameters PA9 GPIO_PuPd
set gpio parameters <pin> <parameter> <value>: set a GPIO parameter on the matching pins.
<pin>: regular expression matching the pin names, for example PA9 or PA.*.
<parameter>: GPIO parameter name, for example GPIO_PuPd or GPIO_Speed.
<value>: value to apply; run 'get gpio parameters <pin> <parameter>' first to see the
current value.
Example: set gpio parameters PA9 GPIO_PuPd GPIO_PULLUP
set ip MMTControlled <ip> <true|false>
make the mode and the parameters of a peripheral read-only because the Memory Map Tool drives
them.
<ip>: peripheral instance name, for example FMC.
The name is matched without case sensitivity.
<true|false>: true hands the peripheral over to the Memory Map Tool, false gives it back.
Example: set ip MMTControlled FMC true
set ip parameters <ip> <parameter> <value>: set a configuration parameter of a peripheral.
<ip>: peripheral instance name, for example USART2.
The name is matched without case sensitivity.
<parameter>: parameter name, for example BaudRate.
Use the <parameter>-<id> form to target one entry of an indexed parameter.
<value>: value to apply.
Use 'possible_value ip parameters' to check a value before applying it.
The peripheral mode must be set first, otherwise its parameters do not exist yet, and
read-only parameters are rejected.
Example: set ip parameters USART2 BaudRate 115200
get ip parameters <ip> <parameter>: print a configuration parameter of a peripheral.
<ip>: peripheral instance name, for example USART2.
The name is matched without case sensitivity.
<parameter>: parameter name, for example BaudRate.
Example: get ip parameters USART2 BaudRate
set ip no_ui_warning <ip>
stop reporting the configuration warnings of a peripheral in the user interface.
<ip>: peripheral instance name, for example USART2.
The name is matched without case sensitivity.
Example: set ip no_ui_warning USART2
possible_value ip parameters <ip> <parameter> <value>
check that a value is accepted by a peripheral parameter.
<ip>: peripheral instance name, for example USART2.
The name is matched without case sensitivity.
<parameter>: parameter name, for example BaudRate.
<value>: value to check.
The command succeeds when the value is allowed.
Example: possible_value ip parameters USART2 BaudRate 115200
not_a_possible_value ip parameters <ip> <parameter> <value>
check that a value is rejected by a peripheral parameter.
<ip>: peripheral instance name, for example USART2.
The name is matched without case sensitivity.
<parameter>: parameter name, for example BaudRate.
<value>: value to check.
The command succeeds when the value is not allowed.
Example: not_a_possible_value ip parameters USART2 BaudRate 1
reset mode <peripheral> <mode>: deactivate a mode on a peripheral.
<peripheral>: peripheral instance name, for example USART2.
<mode>: name of a mode currently activated on that peripheral.
Example: reset mode USART2 Asynchronous
get sub-mode-state <peripheral> <mode path>: print the state of a mode and of its sub-modes.
<peripheral>: peripheral instance name, for example USART2.
<mode path>: comma separated path from the root mode down to the sub-mode, for example
moderoot,submode1,submode1.1
Example: get sub-mode-state RCC HSE,Crystal/Ceramic Resonator
get available-analog-signals <pin>: list the analog signals that can be mapped on a pin.
<pin>: pin name, for example PA0.
Example: get available-analog-signals PA0
get sub-modes <peripheral>: list the sub-modes of a peripheral.
<peripheral>: peripheral instance name, for example RCC.
Example: get sub-modes RCC
get mcu name: print the reference name of the loaded MCU.
Example: get mcu name
get mcu package: print the package of the loaded MCU.
Example: get mcu package
get mcu peripherals: list the peripherals available on the loaded MCU.
Use 'get mode available <peripheral>' next to see what each peripheral can do.
Example: get mcu peripherals
get functions <pin>: list the signals that can be mapped on the matching pins.
<pin>: regular expression matching the pin names, for example PA9 or PA.*.
Example: get functions PA9
get possible remaps <signal>: list the pins a signal can be moved to.
<signal>: regular expression matching the signal names, for example USART1_TX.
The command fails when no MCU is loaded.
Example: get possible remaps USART1_TX
csv pinout <file>: export the pin mapping of the loaded MCU as a CSV file.
<file>: path of the .csv file to write.
Example: csv pinout C:/work/pinout.csv
check mode enabled <peripheral> <mode>
report whether a mode can currently be activated on a peripheral.
<peripheral>: peripheral instance name, for example USART2.
<mode>: mode name, for example Asynchronous.
A mode can be disabled because its pins or its resources are already taken by another
peripheral.
Example: check mode enabled USART2 Asynchronous
discover mode context <peripheral> <mode>
report whether a mode needs the peripheral to be assigned to exactly one context first.
<peripheral>: peripheral instance name, for example USART1.
<mode>: mode name, for example Asynchronous.
It works on the MCU currently loaded; use 'discover mcu ip mode context <ref> ...' to ask
the same question without loading it.
Example: discover mode context USART1 Asynchronous
get codegeneratormode: report whether the generator produces HAL compliant code.
Example: get codegeneratormode
discover mcu ip parameters <ref> [ip]
list the configuration parameters of a peripheral, read straight from the device XML.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
[ip]: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
Only the first peripheral that matches is reported; with no value the first peripheral of
the XML is used.
Run 'discover mcu ip instances <ref>' to learn the exact instance names.
Each parameter comes with its possible values and the 'set ip parameters' command that
applies it.
Example: discover mcu ip parameters STM32G071RBTx USART2
discover mcu clock multiplexers <ref>
list the clock multiplexers of a device and the index of each input.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
The names and indexes it reports are the ones expected by 'clock set <multiplexer> <value>'.
Example: discover mcu clock multiplexers STM32G071RBTx
discover mcu clock active outputs <ref>
list the clock outputs of a device with the commands that drive them.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
Example: discover mcu clock active outputs STM32G071RBTx
discover mcu clock dividers <ref>
list the clock dividers and multipliers of a device with the values they accept.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
The names and values it reports are the ones expected by 'clock set <divider> <value>'.
Example: discover mcu clock dividers STM32G071RBTx
discover mcu clock fractionals <ref>
list the fractional clock parameters of a device with the values they accept.
<ref>: MCU reference name, for example STM32H563VITx.
The MCU does not need to be loaded.
The names and values it reports are the ones expected by 'clock set <fractional> <value>'.
Example: discover mcu clock fractionals STM32H563VITx
discover mcu clock sources <ref>
list the configurable clock sources of a device with the values they accept.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
The names and values it reports are the ones expected by 'clock set <source> <value>'.
Example: discover mcu clock sources STM32G071RBTx
discover mcu clock xbars <ref>: list the clock crossbars of a device with the values they accept.
<ref>: MCU reference name, for example STM32MP257FAIx.
The MCU does not need to be loaded.
Crossbars exist on the devices whose clock tree routes many outputs through a matrix, such
as the STM32MP family.
Example: discover mcu clock xbars STM32MP257FAIx
discover mcu clocktree controls <ref> [hint] [--diagram|--no-diagram] [--diagram-path <path>]
list every clock control of a device in one call.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
[hint]: text used to keep only the controls whose name matches it.
[--diagram|--no-diagram]: produce a diagram of the clock tree, or not.
No diagram is produced unless --diagram is given.
[--diagram-path <path>]: file the diagram is written to.
It aggregates what the multiplexers, dividers, fractionals, sources and xbars commands
report separately.
Example: discover mcu clocktree controls STM32G071RBTx PLL
discover mcu ip parameter info <ref> <ip> <parameter>
describe one parameter of a peripheral, read straight from the device XML.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
<ip>: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
<parameter>: parameter name, for example BaudRate.
It reports the type, the unit, the default value and the allowed range of the parameter.
Example: discover mcu ip parameter info STM32G071RBTx USART2 BaudRate
discover mcu ip parameter values <ref> <ip> <parameter>
list the values one parameter of a peripheral accepts.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
<ip>: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
<parameter>: parameter name, for example WordLength.
Example: discover mcu ip parameter values STM32G071RBTx USART2 WordLength
discover mcu ip instances <ref> [filter]
list the peripherals of a device with their exact instance name, IP name and version.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
[filter]: text matched as a substring, without case sensitivity, to narrow the list.
This is the command to run first: the other discover commands expect the instance names it
reports.
Example: discover mcu ip instances STM32G071RBTx USART
discover mcu ip modes <ref> [ip] [--verbose]
list the modes of a peripheral, read straight from the device XML.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
[ip]: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
Only the first peripheral that matches is reported; with no value the first peripheral of
the XML is used.
[--verbose]: add the detailed mode definition to the output.
Each mode comes with the 'set mode safe' command that activates it and with the context it
needs, if any.
Example: discover mcu ip modes STM32G071RBTx USART2
discover mcu ip mode params <ref> <ip> <mode>: list the parameters of one mode of a peripheral.
<ref>: MCU reference name, for example STM32G071RBTx.
The MCU does not need to be loaded.
<ip>: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
<mode>: mode name, for example Asynchronous.
The name is matched without case sensitivity.
Each parameter comes with its possible values and the 'set ip parameters' command that
applies it.
Example: discover mcu ip mode params STM32G071RBTx USART2 Asynchronous
discover mcu ip mode context <ref> <ip> <mode>
report, for each project type of the device, whether the peripheral must be assigned to a
context before the mode can be set.
<ref>: MCU reference name, for example STM32H745ZITx.
The MCU does not need to be loaded.
<ip>: text matched, without case sensitivity, against the instance name, the IP name and the
IP version.
<mode>: mode name, for example Asynchronous.
The name is matched without case sensitivity.
Use it to know whether a 'set context' call is needed; 'set mode safe' applies that call for
you.
Example: discover mcu ip mode context STM32H745ZITx USART1 Asynchronous
waitclock <seconds>: wait until the clock tree has finished its initialization.
<seconds>: how long to wait at most, in seconds.
Useful in scripts between a clock change and the commands that read the resulting
frequencies.
Example: waitclock 5
set AllIpInContext <context>: assign every peripheral of a multi-context device to one context.
<context>: context name, for example CortexM7 or CortexM33NS.
Reserved for headless automation: the user interface is not refreshed by this command.
Example: set AllIpInContext CortexM7
switch context <context> <ip>: move a peripheral to another context, keeping its configuration.
<context>: target context name, for example CortexM4.
<ip>: peripheral instance name, for example USART1.
Unlike 'set context', which adds the peripheral to a context, this command moves it and
preserves its settings.
Example: switch context CortexM4 USART1
set contextProject <ref> <context project>: select the project type of a multi-context device.
<ref>: MCU reference name, for example STM32H745ZITx.
<context project>: project type name, for example CortexM7 or TrustZoneEnabled, or DEFAULT
to restore the default one.
Run 'load-options <ref>' to list the values a device accepts.
The 'load' command already sets this with its project-context option; use this command to
change it afterwards.
Example: set contextProject STM32H745ZITx CortexM7
set context <context> <ip>: assign a peripheral to a context on a multi-context device.
<context>: context name, for example CortexM7, CortexM4 or CortexM33NS.
<ip>: peripheral instance name, for example USART1.
This is the 'context' of the peripherals; it is not the project-context option of the load
command.
Assign the context before setting the mode, or use 'set mode safe' which does it for you.
Example: set context CortexM7 USART1
unset context <context> <ip>: remove a peripheral from a context on a multi-context device.
<context>: context name, for example CortexM7, CortexM4 or CortexM33NS.
<ip>: peripheral instance name, for example USART1.
Example: unset context CortexM7 USART1
set noparam <ip>: stop generating the initialization parameters of the matching peripherals.
<ip>: regular expression matching the peripheral instance names, for example USART.* or .*
for all of them.
It can be set before an MCU is loaded: the pattern is kept for the MCUs loaded afterwards.
The command fails when the regular expression is invalid.
Example: set noparam USART2
reset noparam <ip>: generate again the initialization parameters of the matching peripherals.
<ip>: the exact pattern given to 'set noparam'.
The command fails when that pattern was not set.
Example: reset noparam USART2
set userconst <name> <value>: add a user constant or update its value.
<name>: name of the constant, as it appears in the generated code.
<value>: value of the constant.
An MCU must be loaded first: loading an MCU or a project clears the user constants.
Example: set userconst SYSTEM_CLOCK 80000000
reset userconst <name>: remove a user constant.
<name>: name of the constant.
Removing a constant that does not exist is not reported as an error.
The command fails when no MCU is loaded.
Example: reset userconst SYSTEM_CLOCK
list ipdependencies: print the dependencies between the peripherals of the loaded MCU.
The command fails when no MCU is loaded.
Example: list ipdependencies
export script <file>: write the current configuration as a script of STM32CubeMX commands.
<file>: path of the script file to write.
Replay it later with the -q mode to rebuild the same configuration.
Example: export script C:/work/hello_uart.txt
swmgr getSelectedDB: print the software package database currently selected.
Example: swmgr getSelectedDB
swmgr refresh: download again the list of available packages from the ST servers.
It needs a working network connection; check it first with 'swmgr connection check'.
Example: swmgr refresh
swmgr set repository <path>: set the folder where the firmware packages are stored.
<path>: full path of the repository folder.
Example: swmgr set repository C:/Users/me/STM32Cube/Repository
swmgr connection check: test the network connection to the ST servers.
Example: swmgr connection check
swmgr connection status: print the result of the last network connection check.
Example: swmgr connection status
swmgr wait [timeout]: wait until the updater has finished its background work.
[timeout]: optional maximum wait in seconds; without it, wait indefinitely.
The ready event of -qi fires while the updater is still refreshing, so an immediate 'swmgr
install' can fail with 'Updater is busy'.
Run this first in a script.
It succeeds as soon as the updater is idle.
An explicit timeout that expires while the updater is still busy returns TIMEOUT.
Example: swmgr wait
Example: swmgr wait 120
swmgr install <package> [licence mode]: install a Cube firmware package or a CMSIS pack.
<package>: one of:
- stm32cube_<series>_<version> for a Cube firmware, in lower case, for example
stm32cube_g0_1.6.2
- <vendor>.<pack>.<version> for a CMSIS pack, for example STMicroelectronics.X-CUBE-AI.7.1.0
- the path of a local .zip file holding either of them
[licence mode]: how the licence agreement is answered:
- deny
- ask
- accept
In JSON output mode only accept is allowed; omitting the mode prints the licence and accepts
it.
The firmware name is case sensitive: STM32Cube_FW_G0_V1.6.2 is rejected, stm32cube_g0_1.6.2
works.
On failure the error says whether the name is unknown or the update servers cannot be
reached.
Example: swmgr install stm32cube_g0_1.6.2 accept
From a file: swmgr install C:/downloads/stm32cube_fw_g0.zip accept
swmgr remove <package>: remove an installed Cube firmware package or CMSIS pack.
<package>: stm32cube_<series>_<version> in lower case, or <vendor>.<pack>.<version>.
Example: swmgr remove stm32cube_g0_1.6.2
swmgr set proxy authentication <true|false>: declare whether the proxy asks for credentials.
<true|false>: true when a login and a password are required.
Example: swmgr set proxy authentication true
swmgr set proxy login <login>: set the login used to authenticate on the proxy.
<login>: user name.
Example: swmgr set proxy login jdoe
swmgr set proxy password <password>: set the password used to authenticate on the proxy.
<password>: password of the proxy account.
It appears in the command history, so prefer a session without logging.
Example: swmgr set proxy password <password>
swmgr set proxy host <host>: set the host name of the proxy.
<host>: host name or IP address.
Example: swmgr set proxy host proxy.example.com
swmgr set proxy port <port>: set the port of the proxy.
<port>: port number.
Example: swmgr set proxy port 8080
swmgr set proxy type <type>: choose how STM32CubeMX reaches the network.
<type>: one of the supported values:
- none
- manual
- system
The host, port and credentials are used only with the manual type.
Example: swmgr set proxy type system
pack enable <vendor> <pack> <version> <class> <group> [variant] [-resolve]
activate a software component of an installed pack.
<vendor>: pack vendor, for example STMicroelectronics.
<pack>: pack name.
The <pack>/<bundle> form is still accepted for backward compatibility.
<version>: pack version, for example 1.2.0.
<class>: component class.
Use the <class>/<bundle> form to select a bundle.
<group>: component group.
Use the <group>/<subgroup> form to select a subgroup.
[variant]: component variant, when the component declares several of them.
[-resolve]: let the tool activate the components the selected one depends on.
Example: pack enable STMicroelectronics X-CUBE-AI 7.1.0 Artificial Intelligence -resolve
pack disable <vendor> <pack> <version> <class> <group> [variant]
deactivate a software component of an installed pack.
<vendor>: pack vendor, for example STMicroelectronics.
<pack>: pack name.
The <pack>/<bundle> form is still accepted for backward compatibility.
<version>: pack version, for example 1.2.0.
<class>: component class.
Use the <class>/<bundle> form to select a bundle.
<group>: component group.
Use the <group>/<subgroup> form to select a subgroup.
[variant]: component variant, when the component declares several of them.
Example: pack disable STMicroelectronics X-CUBE-AI 7.1.0 Artificial Intelligence
pack validate: check the selected software components and report the unresolved dependencies.
Example: pack validate
pack context <context>: choose the context the following pack commands apply to.
<context>: context name or context short name, for example CortexM7.
Only useful on a multi-context device, where each context has its own component selection.
Example: pack context CortexM7
pack migrate <source pack> <target pack> [cancel if issues]
move the selected components from one pack version to another.
<source pack>: full name of the pack currently used.
<target pack>: full name of the pack to migrate to.
[cancel if issues]: pass true to abort the migration when a component cannot be migrated.
Example: pack migrate X-CUBE-AI.7.0.0 X-CUBE-AI.7.1.0 true
pack status [output file]: report the installed packs and the state of their components.
[output file]: optional file the report is written to.
With no argument the report is printed.
Example: pack status C:/work/pack-status.txt
pinout check keep user placement
keep the pins you placed yourself where they are when the pinout is recomputed.
The choice is saved as a preference, so it also applies to the MCUs loaded afterwards.
Example: pinout check keep user placement
pinout uncheck keep user placement: let the pinout solver move the pins you placed yourself.
The choice is saved as a preference, so it also applies to the MCUs loaded afterwards.
Example: pinout uncheck keep user placement
clock resolution: let the tool solve the pending clock tree issues.
Run it after changing clock settings to propagate the values through the clock tree.
The command fails when no MCU is loaded or when the loaded MCU has no clock tree.
Example: clock resolution
clock set <multiplexer> <value>: select the input of a clock multiplexer.
'clock set multiplexer' only names this help entry.
Type the multiplexer name in place of the word multiplexer.
The command exists once an MCU is loaded, with one command per multiplexer of its clock
tree.
<multiplexer>: multiplexer name as reported by 'discover mcu clock multiplexers', for
example SysClkSource or PLLSource.
It is the clock tree element name, not the RCC parameter name, so PLLSource and not
PLLSourceVirtual.
<value>: input to select, given either as its 0-based index or as its signal name, for
example PLLCLK.
Run 'discover mcu clock multiplexers <ref>' to list the multiplexers with the index and the
signal of each input.
The command fails when the multiplexer or the requested input is disabled in the current
configuration.
Example on STM32G071RBTx: clock set SysClkSource 3
Same example with the signal name: clock set SysClkSource PLLCLK
clock set <divider> <value>: set the value of a clock divider or multiplier.
'clock set divider' only names this help entry.
Type the divider or multiplier name in place of the word divider.
The command exists once an MCU is loaded, with one command per divider and multiplier of its
clock tree.
Dividers and multipliers that have a single fixed value have no command.
<divider>: divider or multiplier parameter name, for example PLLM or PLLN.
<value>: one of the values the element accepts, as shown in the clock tree.
The leading / or X sign is optional.
Run 'discover mcu clock dividers <ref>' to list the dividers and multipliers with the values
each one accepts.
Example on STM32G071RBTx: clock set PLLN 16
Same kind of example for a divider: clock set PLLM /2
clock set hclk <frequency>
set the HCLK frequency and let the tool search the clock settings that reach it.
<frequency>: target frequency in MHz.
The command exists once an MCU is loaded.
It fails when the frequency is out of range or cannot be reached.
The other clock outputs are set the same way with 'clock set <output> <frequency>'.
Run 'discover mcu clock active outputs <ref>' to list them with their exact command.
Example on STM32G071RBTx: clock set hclk 64
clock set <fractional> <value>: set the fractional part of a PLL multiplier.
'clock set fractional' only names this help entry.
Type the fractional parameter name in place of the word fractional.
The command exists once an MCU is loaded, only on the devices whose PLLs have a fractional
part.
<fractional>: fractional parameter name, for example PLLFRACN or PLL2FRACN.
<value>: number within the range of the parameter, for example 0 to 8191 for PLLFRACN on
STM32H5.
Run 'discover mcu clock fractionals <ref>' to list the fractional parameter names of a
device.
Example on STM32H563VITx: clock set PLLFRACN 4096
clock set <source> <value>
set a configurable clock source or select the input of a clock crossbar.
'clock set source' only names this help entry.
Type the source or crossbar name in place of the word source.
The command exists once an MCU is loaded, with one command per configurable source and
crossbar of its clock tree.
<source>: source or crossbar parameter name, for example HSE_VALUE, LSE_VALUE or
XBAR0CLKSource.
<value>: for an oscillator, its frequency in the unit shown in the clock tree, such as MHz
for HSE_VALUE.
For a source with a fixed list of values, and for a crossbar, one of the listed values, such
as PLL4 or HSI.
Run 'discover mcu clock sources <ref>' or 'discover mcu clock xbars <ref>' to list the names
and the accepted values.
The command fails while the source is disabled.
HSE_VALUE, for example, needs HSE enabled in RCC first.
On STM32G071RBTx, run 'set mode RCC HSE-External-Oscillator' before the example below.
Example on STM32G071RBTx: clock set HSE_VALUE 16
Example on STM32MP257FAIx: clock set XBAR0CLKSource PLL4
cpload project2 <ioc-file>: load the second configuration of an .ioc comparison.
<ioc-file>: path of the .ioc file to compare against the first one.
Load project1 first, then project2, then export the result with 'cpexport'.
Example: cpload project2 C:/work/new/new.ioc
cpload project1 <ioc-file> <in-home>: load the first configuration of an .ioc comparison.
<ioc-file>: path of the .ioc file to use as the reference.
<in-home>: true when the path is relative to the user home directory, false when it is a
full path.
Example: cpload project1 C:/work/old/old.ioc false
cpexport <xlsx-file>: write the report of the .ioc comparison as an Excel workbook.
<xlsx-file>: path of the .xlsx file to write.
Load both projects with 'cpload project1' and 'cpload project2' before calling it.
Example: cpexport C:/work/compare.xlsx
user_analytics <true|false>: choose whether STM32CubeMX sends usage analytics to ST.
<true|false>: true enables the collection, false disables it.
Example: user_analytics false
config saveext <file>
save the extended configuration, which adds the internal state to the .ioc content.
<file>: path of the file to write.
Example: config saveext C:/work/hello_uart/hello_uart.ext
loadboard <board> <allmodes|nomode>: create a configuration from a board.
<board>: board name, for example NUCLEO-G071RB.
Run 'selector list boards' to list them.
<allmodes|nomode>: allmodes applies the default peripheral configuration of the board,
nomode loads the pinout only.
Example: loadboard NUCLEO-G071RB allmodes
updateIpUI <ip>: redraw the configuration panel of a peripheral.
<ip>: peripheral instance name, for example USART2.
Only useful in interactive mode, to refresh a panel after a change made from the command
line.
Example: updateIpUI USART2
excel export <file> <mcus>: export the pinout of one or more devices as an Excel workbook.
<file>: path of the workbook to write.
<mcus>: device or list of devices whose pinout is exported.
Example: excel export C:/work/pinout.xlsx STM32G071RBTx
excel import <file>: read a pinout from an Excel workbook and save it.
<file>: path of the workbook to read.
Example: excel import C:/work/pinout.xlsx
dump gpio: print the internal GPIO table of the loaded MCU.
Diagnostic command, meant for investigating a database or configuration issue.
Example: dump gpio
dump refparam: print the reference parameters of the loaded MCU.
Diagnostic command, meant for investigating a database or configuration issue.
Example: dump refparam
dump refmode: print the reference modes of the loaded MCU.
Diagnostic command, meant for investigating a database or configuration issue.
Example: dump refmode
set bsp <middleware> <bsp> <mode> <solution>
apply a board support package solution to a middleware.
<middleware>: middleware name that consumes the BSP.
<bsp>: name of the board support package.
<mode>: BSP mode to activate.
<solution>: solution to bind to that mode.
Run 'get bsp status' to see the current bindings.
Example: set bsp TouchGFX BSP_TS Display ST_TS_Driver
unset bsp <middleware> <bsp>: remove the solution bound to a board support package.
<middleware>: middleware name that consumes the BSP.
<bsp>: name of the board support package.
Example: unset bsp TouchGFX BSP_TS
get bsp status: print, as JSON, the board support packages and the solution bound to each one.
The command fails when no MCU is loaded.
Example: get bsp status
set ip GTZCSparameters <ip> <parameter> <value>: set a GTZC security parameter of a peripheral.
<ip>: peripheral instance name, for example USART1.
<parameter>: GTZC parameter name.
<value>: value to apply.
GTZC drives the security and privilege attributes of the peripherals on the TrustZone
capable devices.
Example: set ip GTZCSparameters USART1 SecureMode Secure
project couplefilesbyip <0|1>: choose where the peripheral initialization code is generated.
<0|1>: 0 keeps every peripheral initialization in the main file, 1 generates one pair of
.c/.h files per peripheral.
This is the 'Generate peripheral initialization as a pair of .c/.h files per peripheral'
option of the Project Manager.
Example: project couplefilesbyip 1
project generateunderroot <0|1>
choose where the generated files are written inside the project folder.
<0|1>: 1 writes the generated files directly under the project root, 0 writes them in the
toolchain specific sub-folder.
Example: project generateunderroot 1
project compiler <compiler>: select the compiler and linker used by the generated project.
<compiler>: one of the supported values, case insensitive:
- GCC
- ST Arm Clang
Only the CMake toolchain offers this choice; with any other toolchain the command fails.
Set the toolchain first with 'project toolchain CMake'.
Example: project compiler "ST Arm Clang"
project toolchain <toolchain>: set the toolchain or IDE the project is generated for.
<toolchain>: name of the toolchain, for example STM32CubeIDE, EWARM V9.40, MDK-ARM V5.42,
CMake, Makefile or VS Code Compatible.
The supported list depends on the selected device; when the value is rejected the command
prints the accepted names.
Example: project toolchain STM32CubeIDE
project toolchainlocation <path>: set the folder where the generated toolchain project is written.
<path>: directory path; it is created when it does not exist.
'project path' already sets this location, so use this command only to override it.
Example: project toolchainlocation C:/work/hello_uart
project set heapsize <heapsize>: set the minimum heap size of a single core device.
<heapsize>: size in bytes, written as a C literal, for example 0x200 or 512.
On a multi-core or multi-context device use 'project set heapbycontext' instead.
An MCU must be loaded first: loading an MCU or a project resets the heap and stack sizes.
Example: project set heapsize 0x200
project set heapbycontext <context> <heapsize>: set the minimum heap size of one context.
<context>: context short name, for example CortexM7, CortexM4 or CortexM33NS.
<heapsize>: size in bytes, written as a C literal, for example 0x200 or 512.
An MCU must be loaded first: loading an MCU or a project resets the heap and stack sizes.
Example: project set heapbycontext CortexM7 0x200
project set stacksize <stacksize>: set the minimum stack size of a single core device.
<stacksize>: size in bytes, written as a C literal, for example 0x400 or 1024.
On a multi-core or multi-context device use 'project set stackbycontext' instead.
An MCU must be loaded first: loading an MCU or a project resets the heap and stack sizes.
Example: project set stacksize 0x400
project set stackbycontext <context> <stacksize>: set the minimum stack size of one context.
<context>: context short name, for example CortexM7, CortexM4 or CortexM33NS.
<stacksize>: size in bytes, written as a C literal, for example 0x400 or 1024.
An MCU must be loaded first: loading an MCU or a project resets the heap and stack sizes.
Example: project set stackbycontext CortexM4 0x400
project get heapsize: print the minimum heap size of a single core device.
The command fails when no MCU is loaded.
Example: project get heapsize
project get heapbycontext <context>: print the minimum heap size of one context.
<context>: context short name, for example CortexM7, CortexM4 or CortexM33NS.
The command fails when no MCU is loaded or when the device has no heap size for that
context.
Example: project get heapbycontext CortexM7
project get stacksize: print the minimum stack size of a single core device.
The command fails when no MCU is loaded.
Example: project get stacksize
project get stackbycontext <context>: print the minimum stack size of one context.
<context>: context short name, for example CortexM7, CortexM4 or CortexM33NS.
The command fails when no MCU is loaded or when the device has no stack size for that
context.
Example: project get stackbycontext CortexM4
project path <path>: set the folder where the project is created.
<path>: directory path; it is created when it does not exist.
When the project name is already set and the path does not end with it, the project name is
appended to the path.
Set the project name first, then the path, so that the .ioc file lands in the expected
folder.
Example: project path C:/work
project name <name>: set the project name.
<name>: name of the project; it is also the name of the generated .ioc file and of the
project sub-folder.
Example: project name hello_uart
project import: re-apply the Project Manager settings of the imported configuration.
The board name and the 'use default firmware location' option are intentionally not
imported.
Example: project import
project save <ioc-file>: write the current Project Manager settings into the given .ioc file.
<ioc-file>: path of the target .ioc file.
When no project name is set yet, 'cft' is used as project name.
Example: project save C:/work/hello_uart/hello_uart.ioc
project setCustomFWPath <path>
use a custom firmware package location instead of the default repository.
<path>: folder containing the firmware package; it is created when it does not exist.
Calling this command turns off the 'use default firmware location' option.
Example: project setCustomFWPath C:/firmware/STM32Cube_FW_G0_V1.6.2
setDriver <ip> <HAL|LL>
choose the driver used to generate the initialization code of a peripheral type or of one
peripheral instance.
<ip>: peripheral name without the instance number, for example USART, I2C or TIM, applies to
every instance and replaces the choices made per instance.
A peripheral instance name, for example USART2 or TIM1, applies to that instance only.
<HAL|LL>: HAL generates the HAL driver code, LL generates the Low Layer code.
The value is case sensitive.
An MCU must be loaded and <ip> must be active: activate it first, for example with 'set
mode'.
With a peripheral name, at least one of its instances must be active.
The command fails when <ip> is not a peripheral of the loaded MCU or is not active,
and LL fails when the loaded MCU has no LL driver for that peripheral.
Example: setDriver USART LL
Example: setDriver USART2 HAL
SetStructure <Advanced|Basic>: set the folder structure of the generated application.
<Advanced|Basic>: Advanced splits the application into Core and Drivers folders, Basic keeps
a flat layout.
The value is case insensitive.
Example: SetStructure Advanced
SetCopyLibrary <mode>: set how the firmware library files are added to the generated project.
<mode>: one of the supported values, quoted because they contain spaces:
- "copy all"
- "copy only"
- "copy as reference"
"copy all" copies the whole firmware package, "copy only" copies the used files only, "copy
as reference" links the repository files.
Example: SetCopyLibrary "copy only"
project generate [noFirmwareDownload] [stopOnWarnings]
generate the project of the current configuration.
noFirmwareDownload: if the required firmware is unavailable, stop the generation, report the
missing package, and do not download it.
stopOnWarnings: stop the generation with a failure status as soon as generation warnings are
detected, and print those warnings.
With no option the existing download and warning behavior is preserved.
The options can be combined and given in any order.
Set the project name, path and toolchain before generating.
Example: project generate noFirmwareDownload stopOnWarnings
project report [<report file|directory>]
generate the project reports (Pdf and Text) without any dialog.
<report file|directory>: optional output.
With a file the .pdf and .txt extensions are forced on the given base name, with a directory
the reports are written in that directory using the project name.
With no argument the reports are written next to the project .ioc file, using the project
name.
Paths containing spaces must be quoted.
Example: project report "C:/My Projects/report.pdf"
dma add <request>: add a DMA request, letting the tool pick a free stream or channel for it.
<request>: DMA request name, for example USART2_RX or MEMTOMEM.
Run 'dma available_periph_requests <peripheral>' to list the request names of a peripheral.
Use 'dma set_flow' instead when you want to choose the stream or channel yourself.
Example: dma add USART2_RX
dma delete <request>: remove the DMA requests carrying a given name.
<request>: DMA request name, for example USART2_RX.
Example: dma delete USART2_RX
dma delete_all: remove every DMA request of every DMA controller.
Example: dma delete_all
dma listbriefly <request>: print one summary line per DMA request carrying a given name.
<request>: DMA request name, for example USART2_RX.
Use 'dma list' to print the parameters of each request as well.
Example: dma listbriefly USART2_RX
dma list <request>: print the DMA requests carrying a given name, with their parameters.
<request>: DMA request name, for example USART2_RX.
Example: dma list USART2_RX
dma list_controller <controller>: print the DMA requests mapped on a controller.
<controller>: DMA controller name, for example DMA1 or DMA2.
Example: dma list_controller DMA1
dma list_periph <peripheral>: print the DMA requests mapped for a peripheral.
<peripheral>: peripheral instance name, for example USART2.
Example: dma list_periph USART2
dma list_all: print every DMA request currently mapped.
Example: dma list_all
dma available_controller_requests <controller>: list the requests a controller can still host.
<controller>: DMA controller name, for example DMA1 or DMA2.
Example: dma available_controller_requests DMA1
dma available_periph_requests <peripheral>: list the DMA requests a peripheral can still use.
<peripheral>: peripheral instance name, for example USART2.
This is the command to run before 'dma add' to learn the exact request names.
Example: dma available_periph_requests USART2
dma available_controller_streams <request> <controller>
list the free streams or channels of a controller that can host a request.
<request>: DMA request name, for example USART2_RX.
<controller>: DMA controller name, for example DMA1 or DMA2.
Example: dma available_controller_streams USART2_RX DMA1
dma available_streams <request>
list every free stream or channel that can host a request, on all controllers.
<request>: DMA request name, for example USART2_RX.
Example: dma available_streams USART2_RX
dma set_flow <request> <flow>: map a DMA request on a chosen stream or channel.
<request>: DMA request name, for example USART2_RX.
<flow>: stream or channel that carries the request, for example DMA1_Stream5 or
DMA1_Channel4.
Run 'dma available_streams <request>' to list the values that can be used.
The request is created when it is not mapped yet, so this command replaces 'dma add' when
the flow matters.
Example: dma set_flow USART2_RX DMA1_Stream5
dma get_param <request> <parameter> [flow]: print a parameter of a mapped DMA request.
<request>: DMA request name, for example USART2_RX.
<parameter>: parameter name, for example Direction, Mode or MemDataAlignment.
[flow]: stream or channel name.
Only useful for MEMTOMEM, which can be mapped several times; it selects which of those
mappings is read.
Example: dma get_param USART2_RX Mode
dma set_param <request> <parameter> <value> [flow]: set a parameter of a DMA request.
<request>: DMA request name, for example USART2_RX.
<parameter>: parameter name, for example Direction, Mode or MemDataAlignment.
<value>: value to apply; run 'dma list <request>' to see the current parameters.
[flow]: stream or channel name.
Only useful for MEMTOMEM, which can be mapped several times; it selects which of those
mappings is written.
The request is created when it is not mapped yet, except for MEMTOMEM which must be added
first.
Example: dma set_param USART2_RX Mode DMA_CIRCULAR
dma is_available_in <request> <controller>: report whether a controller can still host a request.
<request>: DMA request name, for example USART2_RX.
<controller>: DMA controller name, for example DMA1 or DMA2.
Example: dma is_available_in USART2_RX DMA1
dma is_available <request>: report whether a request can still be mapped on any controller.
<request>: DMA request name, for example USART2_RX.
Example: dma is_available USART2_RX
dma used_flows: list the streams and channels currently carrying a DMA request.
Example: dma used_flows
dma3 list_controllers: list the DMA3 controllers of the device with their channel count.
DMA3 controllers are named GPDMA1, LPDMA1 or HPDMA1 depending on the device.
Example: dma3 list_controllers
dma3 list_channels <controller>: list the channels of a DMA3 controller with their state.
<controller>: DMA3 controller name, for example GPDMA1.
Example: dma3 list_channels GPDMA1
dma3 available_channels <controller>: list the free channels of a DMA3 controller.
<controller>: DMA3 controller name, for example GPDMA1.
Example: dma3 available_channels GPDMA1
dma3 available_controller_requests <controller>: list the requests a DMA3 controller supports.
<controller>: DMA3 controller name, for example GPDMA1.
Example: dma3 available_controller_requests GPDMA1
dma3 available_periph_requests <peripheral>: list the DMA3 requests a peripheral can still use.
<peripheral>: peripheral instance name, for example USART1.
This is the command to run before 'dma3 add_request' to learn the exact request names.
Example: dma3 available_periph_requests USART1
dma3 add_request <request>: map a DMA3 request on the first free channel able to host it.
<request>: DMA3 request name, for example USART1_RX.
Use 'dma3 add_channel_request' instead when you want to choose the channel yourself.
Example: dma3 add_request USART1_RX
dma3 add_channel_request <channel> <request>: map a DMA3 request on a chosen channel.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
<request>: DMA3 request name, for example USART1_RX.
Example: dma3 add_channel_request GPDMA1_CH0 USART1_RX
dma3 set_channel_mode <channel> <mode>: choose how a DMA3 channel is driven.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
<mode>: one of the supported values:
- SIMPLEREQUEST
- LINKEDLIST
A channel must be in LINKEDLIST mode before the linkedlist commands can use it.
Example: dma3 set_channel_mode GPDMA1_CH0 LINKEDLIST
dma3 delete_channel <channel>: release a DMA3 channel.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
Example: dma3 delete_channel GPDMA1_CH0
dma3 delete_request <request>: release every DMA3 channel mapped on a request.
<request>: DMA3 request name, for example USART1_RX.
Example: dma3 delete_request USART1_RX
dma3 delete_all_requests: release every channel of every DMA3 controller.
Example: dma3 delete_all_requests
dma3 list_request <request>: list the DMA3 channels mapped on a request.
<request>: DMA3 request name, for example USART1_RX.
Example: dma3 list_request USART1_RX
dma3 list_periph_requests <peripheral>: list the DMA3 requests mapped for a peripheral.
<peripheral>: peripheral instance name, for example USART1.
Example: dma3 list_periph_requests USART1
dma3 list_all_requests: list every DMA3 request currently mapped.
Example: dma3 list_all_requests
dma3 used_flows: list the DMA3 channels currently carrying a request.
Example: dma3 used_flows
dma3 get_params <channel>
print every parameter of a DMA3 channel with its current and possible values.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
Run this first to learn the parameter names accepted by 'dma3 set_param'.
Example: dma3 get_params GPDMA1_CH0
dma3 get_param <channel> <parameter>: print one parameter of a DMA3 channel.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
<parameter>: parameter name, for example DIRECTION.
Example: dma3 get_param GPDMA1_CH0 DIRECTION
dma3 set_param <channel> <parameter> <value>: set one parameter of a DMA3 channel.
<channel>: DMA3 channel name, for example GPDMA1_CH0.
<parameter>: parameter name, for example DIRECTION.
<value>: value to apply; 'dma3 get_params <channel>' lists the values each parameter
accepts.
Example: dma3 set_param GPDMA1_CH0 DIRECTION DMA_MEMORY_TO_PERIPH
gic enable <irq>: enable an interrupt vector of the generic interrupt controller.
<irq>: interrupt name ending with _IRQn, as listed by 'gic get_interrupts'.
The GIC is the interrupt controller of the Cortex-A cores of the STM32MP devices.
Example: gic enable UART4_IRQn
gic disable <irq>: disable an interrupt vector of the generic interrupt controller.
<irq>: interrupt name ending with _IRQn, as listed by 'gic get_interrupts'.
Example: gic disable UART4_IRQn
gic get_enable_state <irq>
print whether an interrupt vector of the generic interrupt controller is enabled.
<irq>: interrupt name ending with _IRQn, as listed by 'gic get_interrupts'.
Example: gic get_enable_state UART4_IRQn
gic set_triggering_mode <irq> <mode>
set how an interrupt of the generic interrupt controller is triggered.
<irq>: interrupt name ending with _IRQn, as listed by 'gic get_interrupts'.
<mode>: triggering mode; run 'gic get_triggering_mode <irq>' to see the current value.
Example: gic set_triggering_mode UART4_IRQn LEVEL
gic get_triggering_mode <irq>
print how an interrupt of the generic interrupt controller is triggered.
<irq>: interrupt name ending with _IRQn, as listed by 'gic get_interrupts'.
Example: gic get_triggering_mode UART4_IRQn
gic get_ip_interrupts <ip>: list the generic interrupt controller interrupts of one peripheral.
<ip>: peripheral instance name, for example UART4.
Example: gic get_ip_interrupts UART4
gic get_interrupts: list every interrupt of the generic interrupt controller with its state.
This is the command to run first to learn the exact interrupt names.
Example: gic get_interrupts
nvic enable <irq>: enable an interrupt vector.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Run 'nvic get_interrupts' to list the names of the device.
On a TrustZone device the controllers are named NVIC1 and NVIC2; use 'nvic1 enable' or
'nvic2 enable'.
Example: nvic enable USART2_IRQn
nvic disable <irq>: disable an interrupt vector.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic disable USART2_IRQn
nvic get_enable_state <irq>: print whether an interrupt vector is enabled.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic get_enable_state USART2_IRQn
nvic set_prioritygroup <bits>
set how the priority bits are split between preemption priority and subpriority.
<bits>: number of preemption priority bits, from 0 to 4. It selects
NVIC_PRIORITYGROUP_<bits>.
Cortex-M0 and Cortex-M0+ devices have no priority group; the command fails on them.
Example: nvic set_prioritygroup 4
nvic get_prioritygroup: print the current priority group.
Example: nvic get_prioritygroup
nvic set_usesfreertosfunctions <irq> <true|false>
declare whether the handler of an interrupt calls FreeRTOS API functions.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
<true|false>: true when the handler calls FreeRTOS functions, which constrains its allowed
priority.
Example: nvic set_usesfreertosfunctions USART2_IRQn true
nvic get_usesfreertosfunctions <irq>
print whether the handler of an interrupt is declared as calling FreeRTOS API functions.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic get_usesfreertosfunctions USART2_IRQn
nvic set_priority <irq> <priority>: set the preemption priority of an interrupt.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
<priority>: preemption priority; the allowed range depends on the priority group.
Example: nvic set_priority USART2_IRQn 5
nvic get_priority <irq>: print the preemption priority of an interrupt.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic get_priority USART2_IRQn
nvic set_subpriority <irq> <subpriority>: set the subpriority of an interrupt.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
<subpriority>: subpriority; the allowed range depends on the priority group.
Example: nvic set_subpriority USART2_IRQn 0
nvic get_subpriority <irq>: print the subpriority of an interrupt.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic get_subpriority USART2_IRQn
nvic set_irqhandlergenerated <irq> <true|false>
choose whether the handler of an interrupt is written in the generated code.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
<true|false>: false leaves the handler out so that you can write it yourself.
Example: nvic set_irqhandlergenerated USART2_IRQn false
nvic get_irqhandlergenerated <irq>
print whether the handler of an interrupt is written in the generated code.
<irq>: interrupt name ending with _IRQn, for example USART2_IRQn.
Example: nvic get_irqhandlergenerated USART2_IRQn
nvic get_ip_interrupts <ip>: list the interrupts of one peripheral.
<ip>: peripheral instance name, for example USART2.
Example: nvic get_ip_interrupts USART2
nvic get_interrupts: list every interrupt of the device with its state.
This is the command to run first to learn the exact interrupt names.
Example: nvic get_interrupts
mdma add_request <request>: add an MDMA request, letting the tool pick a free channel for it.
<request>: MDMA request name, for example SDMMC1_END_DATA or a software request.
Example: mdma add_request SDMMC1_END_DATA
mdma add_channel_request <channel> <request>: add an MDMA request on a chosen channel.
<channel>: MDMA channel name, for example MDMA_Channel0.
<request>: MDMA request name, for example SDMMC1_END_DATA.
A channel can carry several requests; they are ordered by rank, starting at 0.
Example: mdma add_channel_request MDMA_Channel0 SDMMC1_END_DATA
mdma delete_channel <channel>: remove every MDMA request carried by a channel.
<channel>: MDMA channel name, for example MDMA_Channel0.
Example: mdma delete_channel MDMA_Channel0
mdma delete_request <request>: remove the MDMA requests carrying a given name.
<request>: MDMA request name, for example SDMMC1_END_DATA.
Example: mdma delete_request SDMMC1_END_DATA
mdma delete_all_requests: remove every MDMA request of every channel.
Example: mdma delete_all_requests
mdma list_channel_requests <channel>: print the MDMA requests carried by a channel.
<channel>: MDMA channel name, for example MDMA_Channel0.
Example: mdma list_channel_requests MDMA_Channel0
mdma list_request <request>: print the MDMA requests carrying a given name.
<request>: MDMA request name, for example SDMMC1_END_DATA.
Example: mdma list_request SDMMC1_END_DATA
mdma list_nth_request_on_channel <channel> <rank> <request>
print one request of a channel, selected by its rank.
<channel>: MDMA channel name, for example MDMA_Channel0.
<rank>: position of the request inside the channel, starting at 0.
<request>: expected MDMA request name; the command fails when the rank holds another
request.
Example: mdma list_nth_request_on_channel MDMA_Channel0 0 SDMMC1_END_DATA
mdma list_nth_request_parameters <channel> <rank>
print the parameters of one request of a channel, selected by its rank.
<channel>: MDMA channel name, for example MDMA_Channel0.
<rank>: position of the request inside the channel, starting at 0.
Example: mdma list_nth_request_parameters MDMA_Channel0 0
mdma list_peripheral_requests <peripheral>: print the MDMA requests mapped for a peripheral.
<peripheral>: peripheral instance name, for example SDMMC1.
Example: mdma list_peripheral_requests SDMMC1
mdma list_all_requests: print every MDMA request currently mapped.
Example: mdma list_all_requests
linkedlist list_queues: list the linked list queues of the configuration.
Each line has the form <channel>:<queue name>:<node count>.
Example: linkedlist list_queues
linkedlist available_queues: list the DMA3 channels that can still host a new linked list queue.
A channel is eligible once 'dma3 set_channel_mode <channel> LINKEDLIST' has been applied to
it.
Example: linkedlist available_queues
linkedlist available_requests: list the requests that can be used to create a linked list node.
Example: linkedlist available_requests
linkedlist add_queue
create a linked list queue on the first free channel, with a default first node.
Run 'linkedlist list_queues' afterwards to learn the name given to the new queue.
Example: linkedlist add_queue
linkedlist delete_queue <queue>: delete a linked list queue and all its nodes.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
Example: linkedlist delete_queue GPDMA1_CH0
linkedlist delete_all_queues: delete every linked list queue of the configuration.
Example: linkedlist delete_all_queues
linkedlist list_nodes <queue>: list the nodes of a queue, in execution order.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
Each line has the form <channel>:<rank>:<node name>:<request>, the rank starting at 0.
Example: linkedlist list_nodes GPDMA1_CH0
linkedlist add_node <queue> <request>: append a node at the end of a queue.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<request>: request executed by the node; run 'linkedlist available_requests' to list the
valid names.
Example: linkedlist add_node GPDMA1_CH0 USART1_TX
linkedlist delete_node <queue> <node>: delete one node of a queue.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
Example: linkedlist delete_node GPDMA1_CH0 1
linkedlist move_node_up <queue> <node>: move a node one rank earlier in its queue.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
Example: linkedlist move_node_up GPDMA1_CH0 2
linkedlist move_node_down <queue> <node>: move a node one rank later in its queue.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
Example: linkedlist move_node_down GPDMA1_CH0 0
linkedlist get_queue_params <queue>
print every queue level parameter with its current and possible values.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
Run this first to learn the parameter names accepted by 'linkedlist set_queue_param'.
Example: linkedlist get_queue_params GPDMA1_CH0
linkedlist get_queue_param <queue> <parameter>: print one queue level parameter.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<parameter>: parameter name, for example LL_NAME, LL_TYPE or LL_MASTERDMA.
Example: linkedlist get_queue_param GPDMA1_CH0 LL_TYPE
linkedlist set_queue_param <queue> <parameter> <value>
set one queue level parameter on the whole queue.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<parameter>: parameter name, for example LL_NAME, LL_TYPE or LL_MASTERDMA.
<value>: value to apply; 'linkedlist get_queue_params <queue>' lists the values each
parameter accepts.
Example: linkedlist set_queue_param GPDMA1_CH0 LL_NAME MyQueue
linkedlist get_node_params <queue> <node>
print every parameter of a node with its current and possible values.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
Example: linkedlist get_node_params GPDMA1_CH0 0
linkedlist get_node_param <queue> <node> <parameter>: print one parameter of a node.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
<parameter>: parameter name, for example NODE_NAME or Direction.
Example: linkedlist get_node_param GPDMA1_CH0 0 Direction
linkedlist set_node_param <queue> <node> <parameter> <value>: set one parameter of a node.
<queue>: queue name or name of the channel carrying it, for example GPDMA1_CH0.
<node>: node name, or its rank in the queue starting at 0.
<parameter>: parameter name, for example NODE_NAME or Direction.
<value>: value to apply; 'linkedlist get_node_params <queue> <node>' lists the values each
parameter accepts.
Queue level parameters are rejected here; set them with 'linkedlist set_queue_param'.
Example: linkedlist set_node_param GPDMA1_CH0 0 Direction DMA_MEMORY_TO_PERIPH
MMT dump HRegion: print every hardware region known by the Memory Map Tool.
Example: MMT dump HRegion
MMT dump HRange: print every hardware range known by the Memory Map Tool.
Example: MMT dump HRange
MMT dump AppReg [all]: print the application ranges of the Memory Map Tool.
[all]: pass all to include the ranges that are not assigned to the current configuration.
Example: MMT dump AppReg all
MMT dump free [context:<context>|core:<core>]: print the memory still free in the Memory Map Tool.
[context:<context>]: restrict the report to one context, for example context:CortexM7.
[core:<core>]: restrict the report to one core, for example core:CortexM4.
With no argument the free memory of the whole device is reported.
Example: MMT dump free context:CortexM7
MMT save pre-config <file>
write the current Memory Map Tool settings as a pre-configuration file.
<file>: path of the pre-configuration file to write.
Example: MMT save pre-config C:/work/mmt-preconfig.xml
MMT load pre-config <file>: apply a Memory Map Tool pre-configuration file.
<file>: path of a file written by 'MMT save pre-config'.
Example: MMT load pre-config C:/work/mmt-preconfig.xml
MMT ThreadX <y|n>: declare whether the memory map must reserve the areas needed by ThreadX.
<y|n>: y to reserve them, n to leave them free.
Example: MMT ThreadX y
MMT resetReserved: clear the hardware regions reserved in the Memory Map Tool.
Example: MMT resetReserved
MMT reserved <HW|SW> <region> [<region> ...]: reserve memory regions in the Memory Map Tool.
<HW|SW>: HW reserves hardware regions, SW reserves software regions.
<region>: one or more region names, separated by spaces.
Use 'MMT resetReserved' to clear the hardware reservations.
Example: MMT reserved HW FLASH_BANK1
bootpath wizard
print the boot paths available for the loaded device, as the wizard presents them.
Only devices that declare several boot paths, such as the STM32MP and STM32N6 families,
answer this command.
Example: bootpath wizard
generate deviceTree <db path> <project path> <manifest version> <output dir>
generate the Linux device tree files of an STM32MP project.
<db path>: path of the device tree database.
<project path>: path of the project the device tree is generated for.
<manifest version>: version of the manifest to apply.
<output dir>: directory the generated files are written to.
Example: generate deviceTree C:/db C:/work/mp2_project 5.15 C:/work/mp2_project/dt