Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add missing openocd install instructions #14583

Merged
merged 3 commits into from
Feb 8, 2022

Conversation

lmpprk
Copy link
Contributor

@lmpprk lmpprk commented Jan 30, 2022

Problem

  • The Mbed OS examples did not provide the instructions for install OpenOCD
  • The generic OpenOCD version one can download and build does not work with the build script, instead one must use the Cypress OpenOCD but it wasn't mentioned
  • The script requires env var OPENOCD_PATH which needs to be set manually but wasn't mentioned

Change overview

Add instructions to docs to do all abovementioned issued

Testing

Manually tested the steps and the building/flashing was successful

@github-actions
Copy link

github-actions bot commented Jan 30, 2022

PR #14583: Size comparison from 2cd1e1e to 37182f5

Full report (33 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 2cd1e1e 37182f5 change % change
cyw30739 light cyw930739m2evb_01 (read/write) 580230 580230 0 0.0
.app_xip_area 486204 486204 0 0.0
.bss 76772 76772 0 0.0
.data 596 596 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock-app CYW30739 (read/write) 538278 538278 0 0.0
.app_xip_area 445820 445820 0 0.0
.bss 75244 75244 0 0.0
.data 560 560 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
efr32 lighting-app BRD4161A (read only) 845512 845512 0 0.0
(read/write) 126320 126320 0 0.0
.bss 124416 124416 0 0.0
.data 1900 1900 0 0.0
.text 845504 845504 0 0.0
BRD4161A+rpc (read only) 832872 832872 0 0.0
(read/write) 142976 142976 0 0.0
.bss 140976 140976 0 0.0
.data 2000 2000 0 0.0
.text 832864 832864 0 0.0
window-app BRD4161A (read only) 818112 818112 0 0.0
(read/write) 124948 124948 0 0.0
.bss 123092 123092 0 0.0
.data 1856 1856 0 0.0
.text 818104 818104 0 0.0
esp32 all-clusters-app c3devkit (read only) 936186 936186 0 0.0
(read/write) 1399426 1399426 0 0.0
.dram0.bss 69992 69992 0 0.0
.dram0.data 14276 14276 0 0.0
.flash.rodata 196248 196248 0 0.0
.flash.text 936186 936186 0 0.0
.iram0.text 62056 62056 0 0.0
m5stack (read only) 983511 983511 0 0.0
(read/write) 463748 463748 0 0.0
.dram0.bss 74744 74744 0 0.0
.dram0.data 34024 34024 0 0.0
.flash.rodata 222852 222852 0 0.0
.flash.text 978127 978127 0 0.0
.iram0.text 123399 123399 0 0.0
k32w light k32w061+release (read/write) 664928 664928 0 0.0
.bss 76468 76468 0 0.0
.data 1868 1868 0 0.0
.text 580792 580792 0 0.0
lock k32w061+release (read/write) 665992 665992 0 0.0
.bss 76780 76780 0 0.0
.data 1892 1892 0 0.0
.text 581520 581520 0 0.0
linux chip-tool-ipv6only arm64 (read only) 7054876 7054876 0 0.0
(read/write) 284689 284689 0 0.0
.bss 55553 55553 0 0.0
.data 1128 1128 0 0.0
.data.rel.ro 179152 179152 0 0.0
.dynamic 560 560 0 0.0
.got 45080 45080 0 0.0
.init 24 24 0 0.0
.init_array 200 200 0 0.0
.rodata 398660 398660 0 0.0
.text 6069796 6069796 0 0.0
thermostat-no-ble arm64 (read only) 2091764 2091764 0 0.0
(read/write) 149745 149745 0 0.0
.bss 67329 67329 0 0.0
.data 960 960 0 0.0
.data.rel.ro 74312 74312 0 0.0
.dynamic 560 560 0 0.0
.got 4176 4176 0 0.0
.init 24 24 0 0.0
.init_array 336 336 0 0.0
.rodata 131060 131060 0 0.0
.text 1743088 1743088 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2385640 2385640 0 0.0
.bss 188892 188892 0 0.0
.data 5288 5288 0 0.0
.text 1348240 1348240 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2339968 2339968 0 0.0
.bss 179424 179424 0 0.0
.data 5584 5584 0 0.0
.text 1302568 1302568 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2304072 2304072 0 0.0
.bss 179296 179296 0 0.0
.data 5552 5552 0 0.0
.text 1266672 1266672 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1139712 1139712 0 0.0
.bss 11756 11756 0 0.0
.data 4368 4368 0 0.0
.text 103096 103096 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2294684 2294684 0 0.0
.bss 176572 176572 0 0.0
.data 5384 5384 0 0.0
.text 1257256 1257256 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 983563 983563 0 0.0
bss 119780 119780 0 0.0
rodata 115904 115904 0 0.0
text 670072 670072 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 969111 969111 0 0.0
bss 116824 116824 0 0.0
rodata 107380 107380 0 0.0
text 666516 666516 0 0.0
nrf52840dongle_nrf52840 (read/write) 999635 999635 0 0.0
bss 120952 120952 0 0.0
rodata 114740 114740 0 0.0
text 675484 675484 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 892734 892734 0 0.0
bss 116568 116568 0 0.0
rodata 109184 109184 0 0.0
text 586252 586252 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 916191 916191 0 0.0
bss 118132 118132 0 0.0
rodata 104540 104540 0 0.0
text 616120 616120 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 826246 826246 0 0.0
bss 114948 114948 0 0.0
rodata 97752 97752 0 0.0
text 533080 533080 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 541779 541779 0 0.0
bss 52588 52588 0 0.0
rodata 50048 50048 0 0.0
text 376940 376940 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 919039 919039 0 0.0
bss 117888 117888 0 0.0
rodata 105052 105052 0 0.0
text 618644 618644 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 914223 914223 0 0.0
bss 117896 117896 0 0.0
rodata 104156 104156 0 0.0
text 614692 614692 0 0.0
shell nrf52840dk_nrf52840 (read/write) 798379 798379 0 0.0
bss 109776 109776 0 0.0
rodata 78352 78352 0 0.0
text 533752 533752 0 0.0
p6 all-clusters-app default (read/write) 2446680 2446680 0 0.0
.bss 117044 117044 0 0.0
.data 2584 2584 0 0.0
.text 1404944 1404944 0 0.0
light-app default (read/write) 2342048 2342048 0 0.0
.bss 104604 104604 0 0.0
.data 2408 2408 0 0.0
.text 1300312 1300312 0 0.0
lock-app default (read/write) 2307552 2307552 0 0.0
.bss 104324 104324 0 0.0
.data 2360 2360 0 0.0
.text 1265816 1265816 0 0.0
qpg lighting-app qpg6105+debug (read only) 572876 572876 0 0.0
(read/write) 146936 146936 0 0.0
.bss 88760 88760 0 0.0
.data 1060 1060 0 0.0
.text 567556 567556 0 0.0
lock-app qpg6105+debug (read only) 519044 519044 0 0.0
(read/write) 146940 146940 0 0.0
.bss 88200 88200 0 0.0
.data 992 992 0 0.0
.text 513724 513724 0 0.0
persistent-storage-app qpg6105+debug (read only) 107140 107140 0 0.0
(read/write) 146940 146940 0 0.0
.bss 38504 38504 0 0.0
.data 288 288 0 0.0
.text 101820 101820 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 848354 848354 0 0.0
bss 86560 86560 0 0.0
noinit 37160 37160 0 0.0
text 594748 594748 0 0.0

@andy31415
Copy link
Contributor

@lmpprk - apparently you have to add xzvf to .github/.wordlist.txt for the misspell check.

@boring-cyborg boring-cyborg bot added the github label Feb 2, 2022
@lmpprk
Copy link
Contributor Author

lmpprk commented Feb 2, 2022

@lmpprk - apparently you have to add xzvf to .github/.wordlist.txt for the misspell check.

Just added, seems to be passing, thanks for the pointer!

@woody-apple
Copy link
Contributor

Fast tracking documentation changes.

@woody-apple woody-apple merged commit 78776ac into project-chip:master Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants