michaelh/zephyr
1
0
Fork 0
Code Releases Activity

boards: rpi_pico: Fix doc typos and grammar

Browse source 
Fix a few typos and grammar mistakes in the rpi_pico documentation.

Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
This commit is contained in:
Yonatan Schachter 2022-09-28 19:51:04 +03:00 • committed by Mahesh Mahadevan
commit ddba0f3c30
1 changed files with 15 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

29
boards/arm/rpi_pico/doc/index.rst
View file

@ -117,10 +117,10 @@ This example is valid for the case that the user joins to `plugdev` groups.
The Raspberry Pi Pico has an SWD interface that can be used to program
and debug the on board RP2040. This interface can be utilized by OpenOCD.
However, to use it with the RP2040, `fork of OpenOCD supporting RP2040`_ is needed.
However, to use it with the RP2040, a `fork of OpenOCD supporting RP2040`_ is needed.
If you are using Debian based system (including RaspberryPi OS, Ubuntu. and more),
using `pico_setup.sh`_ script is convenient to set up forked version of OpenOCD.
If you are using a Debian based system (including RaspberryPi OS, Ubuntu. and more),
using the `pico_setup.sh`_ script is a convenient way to set up the forked version of OpenOCD.
Depending on the interface used (such as JLink), you might need to
checkout to a branch that supports this interface, before proceeding.
@ -134,25 +134,26 @@ Here is an example of building and flashing the :ref:`blinky-sample` application
:goals: build flash
:gen-args: -DOPENOCD=/usr/local/bin/openocd -DOPENOCD_DEFAULT_PATH=/usr/local/share/openocd/scripts -DRPI_PICO_DEBUG_ADAPTER=picoprobe
Set `/usr/local/bin/openocd` to **OPENOCD** and `/usr/local/share/openocd/scripts` to **OPENOCD_DEFAULT_PATH** will works
with OpenOCD that install with default configuration.
This configuration also works with an environment that is set up by `pico_setup.sh`_ script.
Set the environment variables **OPENOCD** to `/usr/local/bin/openocd`
and **OPENOCD_DEFAULT_PATH** to `/usr/local/share/openocd/scripts`. This should work
with the OpenOCD that was installed with the default configuration.
This configuration also works with an environment that is set up by the `pico_setup.sh`_ script.
**RPI_PICO_DEBUG_ADAPTER** specifies what debug adapter is used for debugging.
If **RPI_PICO_DEBUG_ADAPTER** was not assigned, use `picoprobe` as default. And also able to use `raspberrypi-swd`.
If **RPI_PICO_DEBUG_ADAPTER** was not assigned, `picoprobe` is used by default.
The other supported adapters are `raspberrypi-swd`, `jlink` and `blackmagicprobe`.
How to connect `picoprobe` and `raspberrypi-swd` is described in `Getting Started with Raspberry Pi Pico`_.
Any other SWD debug adapter maybe also work with this configuration.
**RPI_PICO_DEBUG_ADAPTER** value remember into CMakeCache.txt.
So you can omit the option in `west flash` and `west debug` execution,
you need only the `west build` case.
The value of **RPI_PICO_DEBUG_ADAPTER** is cached, so it can be omitted from
`west flash` and `west debug` if it was previously set while running `west build`.
**RPI_PICO_DEBUG_ADAPTER** is used in an argument to OpenOCD as `"source [find interface/${RPI_PICO_DEBUG_ADAPTER}.cfg]"`.
Thus, **RPI_PICO_DEBUG_ADAPTER** needs to assign from the definition file name of debugging adapter.
Thus, **RPI_PICO_DEBUG_ADAPTER** needs to be assigned the file name of the debug adapter.
You can also flash the board with the following
command that directly call OpenOCD (assuming a SEGGER JLink adapter is used):
command that directly calls OpenOCD (assuming a SEGGER JLink adapter is used):
.. code-block:: console
@ -171,7 +172,7 @@ Debugging
=========
The SWD interface can also be used to debug the board. To achieve this, you can
either user SEGGER JLink or OpenOCD.
either use SEGGER JLink or OpenOCD.
Using SEGGER JLink
------------------
@ -201,7 +202,7 @@ Here is an example for debugging the :ref:`blinky-sample` application.
As with flashing, you can specify the debug adapter by specifying **RPI_PICO_DEBUG_ADAPTER**
at `west build` time. No needs to specify it at `west debug` time.
You can also debugging with OpenOCD and gdb launching from command-line.
You can also debug with OpenOCD and gdb launching from command-line.
Run the following command:
.. code-block:: console