Skip to content

Commit 76743f4

Browse files
enjiamainashif
authored andcommitted
boards: xtensa: update the documentation for changes of cavstool
Update the usage for cavstool.py to remote-fw-service.py to adapt the renaming. And also correct the params --log-port and --req-port in the doc. Signed-off-by: Enjia Mai <[email protected]>
1 parent d6cb27d commit 76743f4

File tree

2 files changed

+25
-12
lines changed

2 files changed

+25
-12
lines changed

boards/xtensa/intel_adsp_cavs15/doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ ip address), and the user account is ``user``. Then copy the python tool to the
7777
``up_squared`` board from your build environment::
7878

7979
$ scp boards/xtensa/intel_adsp/tools/cavstool.py user@cavs15:
80+
$ scp boards/xtensa/intel_adsp/tools/remote-fw-service.py user@cavs15:
8081

8182

8283
Note that the ``/dev/hda`` device file created by the diagnostic driver must
@@ -85,7 +86,7 @@ loader script as root:
8586

8687
.. code-block:: console
8788
88-
cavs15$ sudo ./cavstool.py
89+
cavs15$ sudo ./remote-fw-service.py
8990
9091
Cavstool_server.py is a daemon which accepts a firmware image from a remote host
9192
and loads it into the ADSP. After successful firmware download, the daemon also

boards/xtensa/intel_adsp_cavs18/doc/generic_intel_adsp.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,20 @@ This documentation describes how to run the intel_adsp_cavs boards. Including:
1717
Set up the environment
1818
**********************
1919

20-
1. Copy soc/xtensa/intel_adsp/tools/cavstool.py to the target
21-
host machine (DUT).
20+
1. Copy following two tools to the $HOME directory of the target machine (DUT):
21+
22+
- soc/xtensa/intel_adsp/tools/cavstool.py
23+
(The firmware loader)
24+
25+
- soc/xtensa/intel_adsp/tools/remote-fw-service.py
26+
(The remote service provider)
27+
28+
You can use scp command to copy them to DUT, Ex.
29+
30+
.. code-block:: console
31+
32+
$scp boards/xtensa/intel_adsp/tools/cavstool.py user@myboard:~
33+
$scp boards/xtensa/intel_adsp/tools/remote-fw-service.py user@myboard:~
2234
2335
2. In your build machine, install the rimage tool, the signed key and
2436
the toml config file. Please refer to please refer:
@@ -55,7 +67,7 @@ Build and run the tests
5567

5668
.. code-block:: console
5769
58-
sudo ./cavstool.py
70+
sudo ./remote-fw-service.py
5971
6072
2. Build the application. Take hello world as an example:
6173

@@ -104,22 +116,22 @@ using, you can do it with following parameters:
104116
.. code-block:: console
105117
106118
# with specifying the port
107-
sudo ./cavstool.py --log-port 54321 --req-port 12345
119+
sudo ./remote-fw-service.py --log-port 54321 --req-port 12345
108120
109121
# can be simplified with
110-
sudo ./cavstool.py -p 54321 -r 12345
122+
sudo ./remote-fw-service -p 54321 -r 12345
111123
112124
# with specifying a IP address
113-
sudo ./cavstool.py -s 192.168.0.2
125+
sudo ./remote-fw-service -s 192.168.0.2
114126
115127
# with specifying the IP address with a log port
116-
sudo ./cavstool.py -s 192.168.0.2:54321
128+
sudo ./remote-fw-service -s 192.168.0.2:54321
117129
118130
# with specifying the IP, log and request port
119-
sudo ./cavstool.py -s 192.168.0.2:54321 -r 12345
131+
sudo ./remote-fw-service -s 192.168.0.2:54321 -r 12345
120132
121133
# Also works in this way
122-
sudo ./cavstool.py -s 192.168.0.2 -p 54321 -r 12345
134+
sudo ./remote-fw-service -s 192.168.0.2 -p 54321 -r 12345
123135
124136
125137
Run by twister
@@ -189,10 +201,10 @@ like following example. Assume you have a log port of 54321 and a req port
189201
platform: intel_adsp_cavs25
190202
product: None
191203
runner: intel_adsp
192-
serial_pty: "/home/user/zephyrproject/zephyr/soc/xtensa/intel_adsp/tools/cavstool_client.py,-s,192.168.1.4,--port-log,54321,-l"
204+
serial_pty: "/home/user/zephyrproject/zephyr/soc/xtensa/intel_adsp/tools/cavstool_client.py,-s,192.168.1.4,--log-port,54321,-l"
193205
runner_params:
194206
- --remote-host=192.168.1.4
195-
- --tool-opt=--port-req
207+
- --tool-opt=--req-port
196208
- --tool-opt=12345
197209
198210

0 commit comments

Comments
 (0)