This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 6d9971296bd9ab76f3e9c8627ef33410c3f7e79b
Author: Serg Podtynnyi <s...@podtynnyi.com>
AuthorDate: Tue May 13 10:35:12 2025 +0700
Documentation: pico-2: migrate to rst and update the board docs
Migrate from readme.txt to index.rst
Update Pico 2 board documentation
Signed-off-by: Serg Podtynnyi <s...@podtynnyi.com>
---
.../rp23xx/boards/raspberrypi-pico-2/README.txt | 48 --------
.../arm/rp23xx/boards/raspberrypi-pico-2/index.rst | 136 +++++++++++++++++----
2 files changed, 109 insertions(+), 75 deletions(-)
diff --git
a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/README.txt
b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/README.txt
deleted file mode 100644
index e3d4b879e0..0000000000
--- a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/README.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-README
-======
-
-This directory contains the porting of NuttX to the Raspberry Pi Pico 2.
-See https://www.raspberrypi.org/products/raspberry-pi-pico-2/ for information
-about Raspberry Pi Pico 2.
-
-NuttX supports the following RP2350 capabilities:
- - UART (console port)
- - GPIO 0 (UART0 TX) and GPIO 1 (UART0 RX) are used for the console.
- - ADC
- - USB device
- - CDC/ACM serial device can be used for the console.
- - Flash ROM Boot
- - SRAM Boot
-
-Installation
-============
-
-1. Configure and build NuttX
-
- $ git clone https://github.com/apache/nuttx.git nuttx
- $ git clone https://github.com/apache/nuttx-apps.git apps
- $ cd nuttx
- $ make distclean
- $ ./tools/configure.sh raspberrypi-pico-2:nsh
- $ make -j
-
-4. Connect Raspberry Pi Pico 2 board to the USB port while pressing BOOTSEL.
- The board will be detected as USB Mass Storage Device.
- Then copy "nuttx.uf2" into the device.
- (Same manner as the standard Pico SDK applications installation.)
-
-5. To access the console, GPIO 0 and 1 pins must be connected to the
- device such as a USB-serial converter.
-
- `usbnsh` configuration provides the console access by USB CDC/ACM serial
- device. The console is available by using a terminal software on the USB
- host.
-
-Defconfigs
-==========
-
-- nsh
- Minimum configuration with NuttShell
-
-- usbnsh
- USB CDC/ACM serial console with NuttShell
diff --git
a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst
b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst
index ea1dcee49d..dce77f43c7 100644
--- a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst
+++ b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst
@@ -31,7 +31,7 @@ Serial Console
==============
By default a serial console appears on pins 1 (TX GPIO0) and pin 2
-(RX GPIO1). This console runs a 115200-8N1.
+(RX GPIO1). This console runs a 115200-8N1.
The board can be configured to use the USB connection as the serial console.
See the `usbnsh` configuration.
@@ -42,10 +42,10 @@ Buttons and LEDs
User LED controlled by GPIO25 and is configured as autoled by default.
A BOOTSEL button, which if held down when power is first
-applied to the board, will cause the RP2350 to boot into programming
+applied to the board, will cause the Pico 2 to boot into programming
mode and appear as a storage device to the computer connected via USB.
Saving a .UF2 file to this device will replace the Flash ROM contents
-on the RP2350.
+on the Pico 2.
Pin Mapping
===========
@@ -59,28 +59,28 @@ Pad Signal Notes
3 Ground
4 GPIO2
5 GPIO3
-6 GPIO4
-7 GPIO5
+6 GPIO4 Default SDA for I2C0
+7 GPIO5 Default SCL for I2C0
8 Ground
-9 GPIO6
-10 GPIO7
-11 GPIO8
-12 GPIO9
+9 GPIO6 Default SDA for I2C1
+10 GPIO7 Default SCL for I2C1
+11 GPIO8 Default RX for SPI1
+12 GPIO9 Default CSn for SPI1
13 Ground
-14 GPIO10
-15 GPIO11
+14 GPIO10 Default SCK for SPI1
+15 GPIO11 Default TX for SPI1
16 GPIO12
17 GPIO13
18 Ground
19 GPIO14
20 GPIO15
-21 GPIO16
-22 GPIO17
+21 GPIO16 Default RX for SPI0
+22 GPIO17 Default CSn for SPI0
23 Ground
-24 GPIO18
-25 GPIO19
-26 GPIO20
-27 GPIO21
+24 GPIO18 Default SCK for SPI0
+25 GPIO19 Default TX for SPI0
+26 GPIO20 Default TX for UART1 serial console
+27 GPIO21 Default RX for UART1 serial console
28 Ground
29 GPIO22
30 Run
@@ -88,7 +88,7 @@ Pad Signal Notes
32 GPIO27 ADC1
33 AGND Analog Ground
34 GPIO28 ADC2
-35 ADC_VREF
+35 ADC_VREF Analog reference voltage
36 3V3 Power output to peripherals
37 3V3_EN Pull to ground to turn off.
38 Ground
@@ -96,7 +96,7 @@ Pad Signal Notes
40 VBUS Connected to USB +5V
===== ========== ==========
-Other RP2350 Pins
+Other Pico 2 Pins
=================
GPIO23 Output - Power supply control.
@@ -110,19 +110,102 @@ Power Supply
============
The Raspberry Pi Pico 2 can be powered via the USB connector,
-or by supplying +5V to pin 39. The board had a diode that prevents
+or by supplying +5V to pin 39. The board had a diode that prevents
power from pin 39 from flowing back to the USB socket, although
the socket can be power via pin 30.
-The Raspberry Pi Pico chip run on 3.3 volts. This is supplied
+The Raspberry Pi Pico chip run on 3.3 volts. This is supplied
by an onboard voltage regulator. This regulator can be disabled
by pulling pin 37 to ground.
-The regulator can run in two modes. By default the regulator runs
+The regulator can run in two modes. By default the regulator runs
in PFM mode which provides the best efficiency, but may be
switched to PWM mode for improved ripple by outputting a one
on GPIO23.
+Supported Capabilities
+======================
+
+NuttX supports the following Pico 2 capabilities:
+
+* UART (console port)
+
+ * GPIO 0 (UART0 TX) and GPIO 1 (UART0 RX) are used for the console.
+
+* I2C
+* SPI (master only)
+* DMAC
+* PWM
+* ADC
+* Watchdog
+* USB device
+
+ * MSC, CDC/ACM serial and these composite device are supported.
+ * CDC/ACM serial device can be used for the console.
+
+* PIO (RP2350 Programmable I/O)
+* Flash ROM Boot
+* SRAM Boot
+
+ * If Pico SDK is available, nuttx.uf2 file which can be used in BOOTSEL mode
will be created.
+
+* Persistent flash filesystem in unused flash ROM
+
+There is currently no direct user mode access to these RP2350 hardware
features:
+
+* SPI Slave Mode
+* SSI
+* RTC
+* Timers
+
+Installation
+============
+
+1. Download Raspberry Pi Pico SDK
+
+.. code-block:: console
+
+ $ git clone -b 2.1.1 https://github.com/raspberrypi/pico-sdk.git
+
+2. Download and install picotool
+
+ Instructions can be found here: https://github.com/raspberrypi/picotool
+
+ If you are on Arch Linux, you can install the picotool through the AUR:
+
+.. code-block:: console
+
+ $ yay -S picotool
+
+3. Set PICO_SDK_PATH environment variable
+
+.. code-block:: console
+
+ $ export PICO_SDK_PATH=<absolute_path_to_pico-sdk_directory>
+
+4. Configure and build NuttX
+
+.. code-block:: console
+
+ $ git clone https://github.com/apache/nuttx.git nuttx
+ $ git clone https://github.com/apache/nuttx-apps.git apps
+ $ cd nuttx
+ $ make distclean
+ $ ./tools/configure.sh raspberrypi-pico:nsh
+ $ make V=1
+
+5. Connect Raspberry Pi Pico 2 board to USB port while pressing BOOTSEL.
+ The board will be detected as USB Mass Storage Device.
+ Then copy "nuttx.uf2" into the device.
+ (Same manner as the standard Pico SDK applications installation.)
+
+6. To access the console, GPIO 0 and 1 pins must be connected to the
+ device such as USB-serial converter.
+
+ `usbnsh` configuration provides the console access by USB CDC/ACM serial
+ device. The console is available by using a terminal software on the USB
+ host.
+
Configurations
==============
@@ -131,9 +214,8 @@ nsh
Basic NuttShell configuration (console enabled in UART0, at 115200 bps).
+smp
+---
-README.txt
-==========
-
-.. include:: README.txt
- :literal:
+Basic NuttShell configuration (console enabled in UART0, at 115200 bps) with
+both ARM cores enabled.
