doc: guides: sanity_chk: add documentation on hardware map keyword
The probe_id keyword was added to support overriding the inferred id when determining the board-id to use when flashing. Document the keyword. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
This commit is contained in:
parent
3c36b42d03
commit
d6a492d8f1
1 changed files with 18 additions and 0 deletions
|
@ -595,3 +595,21 @@ example::
|
||||||
product: J-Link
|
product: J-Link
|
||||||
runner: jlink
|
runner: jlink
|
||||||
serial: null
|
serial: null
|
||||||
|
|
||||||
|
Overriding Board Identifier
|
||||||
|
+++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
When (re-)generated the hardware map file will contain an "id" keyword
|
||||||
|
that serves as the argument to ``--board-id`` when flashing. In some
|
||||||
|
cases the detected ID is not the correct one to use, for example when
|
||||||
|
using an external J-Link probe. The "probe_id" keyword overrides the
|
||||||
|
"id" keyword for this purpose. For example::
|
||||||
|
|
||||||
|
- available: true
|
||||||
|
connected: false
|
||||||
|
id: 0229000005d9ebc600000000000000000000000097969905
|
||||||
|
platform: mimxrt1060_evk
|
||||||
|
probe_id: 000609301751
|
||||||
|
product: DAPLink CMSIS-DAP
|
||||||
|
runner: jlink
|
||||||
|
serial: null
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue