From 25aca2df3d89b375a164b86854faa8b12272caf7 Mon Sep 17 00:00:00 2001 From: Peter Bee Date: Sun, 17 Nov 2024 21:29:14 +0800 Subject: [PATCH] update Documentation and fix typos Signed-off-by: Peter Bee --- .../boards/raspberrypi-pico-2/README.txt | 10 ++++----- .../boards/raspberrypi-pico-2/index.rst | 6 ++--- Documentation/platforms/arm/rp23xx/index.rst | 22 +++++++++---------- arch/arm/include/rp2040/i2c_slave.h | 4 ++-- arch/arm/include/rp23xx/i2c_slave.h | 4 ++-- 5 files changed, 23 insertions(+), 23 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 index d646741c6bd44..e3d4b879e03d7 100644 --- a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/README.txt +++ b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/README.txt @@ -1,11 +1,11 @@ README ====== -This directory contains the port of NuttX to the Raspberry Pi Pico 2. +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 RP2530 capabilities: +NuttX supports the following RP2350 capabilities: - UART (console port) - GPIO 0 (UART0 TX) and GPIO 1 (UART0 RX) are used for the console. - ADC @@ -26,16 +26,16 @@ Installation $ ./tools/configure.sh raspberrypi-pico-2:nsh $ make -j -4. Connect Raspberry Pi Pico 2 board to USB port while pressing BOOTSEL. +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 USB-serial converter. + device such as a USB-serial converter. `usbnsh` configuration provides the console access by USB CDC/ACM serial - devcice. The console is available by using a terminal software on the USB + device. The console is available by using a terminal software on the USB host. Defconfigs 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 66f2a1e1ff8a5..914f6720196a4 100644 --- a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst +++ b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst @@ -23,7 +23,7 @@ Features * Accurate clock and timer on-chip * Temperature sensor * Accelerated floating point libraries on-chip -* 8 × Programmable IO (PIO) state machines for custom peripheral support +* 12 × Programmable IO (PIO) state machines for custom peripheral support Serial Console ============== @@ -41,9 +41,9 @@ 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 -mode and appear as a storage device to a computer connected via USB . +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 RP2040. +on the RP2350. Pin Mapping =========== diff --git a/Documentation/platforms/arm/rp23xx/index.rst b/Documentation/platforms/arm/rp23xx/index.rst index feda34e724502..058a112a0ecc2 100644 --- a/Documentation/platforms/arm/rp23xx/index.rst +++ b/Documentation/platforms/arm/rp23xx/index.rst @@ -16,18 +16,18 @@ Most drivers were copied from the rp2040 port with some modifications. The following list indicates peripherals currently supported in NuttX: -============== ====== ===== +============== ============ ===== Peripheral Status Notes -============== ====== ===== +============== ============ ===== GPIO Working See Supported Boards documentation for available pins. UART Working GPIO 0 (UART0 TX) and GPIO 1 (UART0 RX) are used for the console. I2C Untested -SPI Master Untested -SPI Slave Not working +SPI Master Working +SPI Slave Untested DMAC Untested PWM Untested USB Experimental usbnsh configuration is somewhat working with some data corruption -PIO Untested +PIO Working IRQs Working DMA Untested Clock Output Untested @@ -35,13 +35,13 @@ Flash ROM Boot Working Does not require boot2 from pico-sdk If picotool is available a nuttx.uf2 file will be created SRAM Boot Working Requires external SWD debugger PSRAM Working Three modes of heap allocation described below -============== ====== ===== +============== ============ ===== Installation ============ 1. Download and build picotool, make it available in the PATH:: - + git clone https://github.com/raspberrypi/picotool.git picotool cd picotool mkdir build @@ -52,7 +52,7 @@ Installation 2. Download NuttX and the companion applications. These must both be contained in the same directory:: - + git clone https://github.com/apache/nuttx.git nuttx git clone https://github.com/apache/nuttx-apps.git apps @@ -78,7 +78,7 @@ Building NuttX make menuconfig 5. Build NuttX:: - + make Flash boot @@ -94,14 +94,14 @@ the flash on startup). It is also possible to execute from SRAM, which reduces the available SRAM to the OS and applications, however it is very -useful when debugging as erasings and rewriting the flash on +useful when debugging as erasing and rewriting the flash on every build is tedious and slow. This option is enabled with `BOOT_RUNFROMISRAM` and requires `openocd`` and/or `gdb`. There is a third option which is to write the firmware on the flash and it gets copied to the SRAM. This is enabled with `CONFIG_BOOT_COPYTORAM` and might be useful for time critical -applications, on the expense of reduced useable interna SRAM +applications, on the expense of reduced usable internal SRAM memory. PSRAM diff --git a/arch/arm/include/rp2040/i2c_slave.h b/arch/arm/include/rp2040/i2c_slave.h index 638bb97a5f130..58a65b434c104 100644 --- a/arch/arm/include/rp2040/i2c_slave.h +++ b/arch/arm/include/rp2040/i2c_slave.h @@ -55,7 +55,7 @@ extern "C" * to the instance of struct i2c_slave_s. This function should only be * called once of a give controller. * - * Note: the same port cannot be initalized as both master and slave. + * Note: the same port cannot be initialized as both master and slave. * * Input Parameters: * rx_buffer - Buffer for data transmitted to us by an I2C master. @@ -84,7 +84,7 @@ struct i2c_slave_s *rp2040_i2c0_slave_initialize * to the instance of struct i2c_slave_s. This function should only be * called once of a give controller. * - * Note: the same port cannot be initalized as both master and slave. + * Note: the same port cannot be initialized as both master and slave. * * Input Parameters: * rx_buffer - Buffer for data transmitted to us by an I2C master. diff --git a/arch/arm/include/rp23xx/i2c_slave.h b/arch/arm/include/rp23xx/i2c_slave.h index 0bd0a22488f12..f3fdbb2e32809 100644 --- a/arch/arm/include/rp23xx/i2c_slave.h +++ b/arch/arm/include/rp23xx/i2c_slave.h @@ -55,7 +55,7 @@ extern "C" * to the instance of struct i2c_slave_s. This function should only be * called once of a give controller. * - * Note: the same port cannot be initalized as both master and slave. + * Note: the same port cannot be initialized as both master and slave. * * Input Parameters: * rx_buffer - Buffer for data transmitted to us by an I2C master. @@ -84,7 +84,7 @@ struct i2c_slave_s *rp23xx_i2c0_slave_initialize * to the instance of struct i2c_slave_s. This function should only be * called once of a give controller. * - * Note: the same port cannot be initalized as both master and slave. + * Note: the same port cannot be initialized as both master and slave. * * Input Parameters: * rx_buffer - Buffer for data transmitted to us by an I2C master.