Skip to content

Commit 78776ac

Browse files
lmpprkrestyled-commits
lmpprk
and
restyled-commits
authored
add missing openocd install instructions (project-chip#14583)
* add missing openocd install instructions * Restyled by prettier-markdown * resolve failing spell check Co-authored-by: Restyled.io <commits@restyled.io>
1 parent 0a33a10 commit 78776ac

File tree

9 files changed

+123
-26
lines changed

9 files changed

+123
-26
lines changed

‎.github/.wordlist.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1164,6 +1164,7 @@ XXXX
11641164
XXXXXXXX
11651165
xyz
11661166
xz
1167+
xzvf
11671168
yaml
11681169
yearday
11691170
yml

‎examples/all-clusters-app/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,21 @@ using the following command:
7777
$ git submodule update --init
7878

7979
Building the example application requires the use of **ARM Mbed-OS** sources and
80-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
81-
purpose. <br> Some additional packages may be needed, depending on selected
82-
build target and its requirements.
80+
the **arm-none-gnu-eabi** toolchain.
81+
82+
The Cypress OpenOCD package is required for flashing purpose. Install the
83+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
84+
script.
85+
86+
```
87+
cd ~
88+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
89+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
90+
export OPENOCD_PATH=$HOME/openocd
91+
```
92+
93+
Some additional packages may be needed, depending on selected build target and
94+
its requirements.
8395

8496
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
8597
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎examples/lighting-app/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,21 @@ using the following command:
9090
$ git submodule update --init
9191

9292
Building the example application requires the use of **ARM Mbed-OS** sources and
93-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
94-
purpose. <br> Some additional packages may be needed, depending on selected
95-
build target and its requirements.
93+
the **arm-none-gnu-eabi** toolchain.
94+
95+
The Cypress OpenOCD package is required for flashing purpose. Install the
96+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
97+
script.
98+
99+
```
100+
cd ~
101+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
102+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
103+
export OPENOCD_PATH=$HOME/openocd
104+
```
105+
106+
Some additional packages may be needed, depending on selected build target and
107+
its requirements.
96108

97109
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
98110
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎examples/lock-app/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,21 @@ using the following command:
8080
$ git submodule update --init
8181

8282
Building the example application requires the use of **ARM Mbed-OS** sources and
83-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
84-
purpose. <br> Some additional packages may be needed, depending on selected
85-
build target and its requirements.
83+
the **arm-none-gnu-eabi** toolchain.
84+
85+
The Cypress OpenOCD package is required for flashing purpose. Install the
86+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
87+
script.
88+
89+
```
90+
cd ~
91+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
92+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
93+
export OPENOCD_PATH=$HOME/openocd
94+
```
95+
96+
Some additional packages may be needed, depending on selected build target and
97+
its requirements.
8698

8799
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
88100
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎examples/ota-requestor-app/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,21 @@ using the following command:
8282
$ git submodule update --init
8383

8484
Building the example application requires the use of **ARM Mbed-OS** sources and
85-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
86-
purpose. <br> Some additional packages may be needed, depending on selected
87-
build target and its requirements.
85+
the **arm-none-gnu-eabi** toolchain.
86+
87+
The Cypress OpenOCD package is required for flashing purpose. Install the
88+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
89+
script.
90+
91+
```
92+
cd ~
93+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
94+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
95+
export OPENOCD_PATH=$HOME/openocd
96+
```
97+
98+
Some additional packages may be needed, depending on selected build target and
99+
its requirements.
88100

89101
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
90102
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎examples/pigweed-app/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,21 @@ using the following command:
5555
$ git submodule update --init
5656

5757
Building the example application requires the use of **ARM Mbed-OS** sources and
58-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
59-
purpose. <br> Some additional packages may be needed, depending on selected
60-
build target and its requirements.
58+
the **arm-none-gnu-eabi** toolchain.
59+
60+
The Cypress OpenOCD package is required for flashing purpose. Install the
61+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
62+
script.
63+
64+
```
65+
cd ~
66+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
67+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
68+
export OPENOCD_PATH=$HOME/openocd
69+
```
70+
71+
Some additional packages may be needed, depending on selected build target and
72+
its requirements.
6173

6274
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
6375
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎examples/shell/mbed/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,21 @@ using the following command:
4848
$ git submodule update --init
4949

5050
Building the example application requires the use of **ARM Mbed-OS** sources and
51-
the **arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
52-
purpose. <br> Some additional packages may be needed, depending on selected
53-
build target and its requirements.
51+
the **arm-none-gnu-eabi** toolchain.
52+
53+
The Cypress OpenOCD package is required for flashing purpose. Install the
54+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
55+
script.
56+
57+
```
58+
cd ~
59+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
60+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
61+
export OPENOCD_PATH=$HOME/openocd
62+
```
63+
64+
Some additional packages may be needed, depending on selected build target and
65+
its requirements.
5466

5567
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
5668
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎src/test_driver/mbed/integration_tests/README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,22 @@ following command:
8282

8383
$ git submodule update --init
8484

85-
Building the application requires the use of **ARM Mbed-OS** sources and the
86-
**arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
87-
purpose. <br> Some additional packages may be needed, depending on selected
88-
build target and its requirements.
85+
Building the example application requires the use of **ARM Mbed-OS** sources and
86+
the **arm-none-gnu-eabi** toolchain.
87+
88+
The Cypress OpenOCD package is required for flashing purpose. Install the
89+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
90+
script.
91+
92+
```
93+
cd ~
94+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
95+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
96+
export OPENOCD_PATH=$HOME/openocd
97+
```
98+
99+
Some additional packages may be needed, depending on selected build target and
100+
its requirements.
89101

90102
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
91103
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

‎src/test_driver/mbed/unit_tests/README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,22 @@ submodules using the following command:
4242

4343
$ git submodule update --init
4444

45-
Building the application requires the use of **ARM Mbed-OS** sources and the
46-
**arm-none-gnu-eabi** toolchain. The OpenOCD package is used for flashing
47-
purpose. <br> Some additional packages may be needed, depending on selected
48-
build target and its requirements.
45+
Building the example application requires the use of **ARM Mbed-OS** sources and
46+
the **arm-none-gnu-eabi** toolchain.
47+
48+
The Cypress OpenOCD package is required for flashing purpose. Install the
49+
Cypress OpenOCD and set env var `OPENOCD_PATH` before calling the flashing
50+
script.
51+
52+
```
53+
cd ~
54+
wget https://github.com/Infineon/openocd/releases/download/release-v4.3.0/openocd-4.3.0.1746-linux.tar.gz
55+
tar xzvf openocd-4.3.0.1746-linux.tar.gz
56+
export OPENOCD_PATH=$HOME/openocd
57+
```
58+
59+
Some additional packages may be needed, depending on selected build target and
60+
its requirements.
4961

5062
> **The VSCode devcontainer has these components pre-installed. Using the VSCode
5163
> devcontainer is the recommended way to interact with Arm Mbed-OS port of the

0 commit comments

Comments
 (0)