This is an automated email from the ASF dual-hosted git repository.
acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new f0c94bb64ac Documentation/spresense: rewrite board page with images
and configs
f0c94bb64ac is described below
commit f0c94bb64acff1471d4ba5b23b1e0e5c8d57019c
Author: Jorge Guzman <[email protected]>
AuthorDate: Wed Jul 1 17:00:40 2026 -0300
Documentation/spresense: rewrite board page with images and configs
Replace the bare "README.txt literal include" with a proper reStructuredText
page for the Sony Spresense board, and remove the now-redundant README.txt
(all of its content has been migrated into index.rst):
- Add board, extension and camera pinout figures (sony*.png).
- Add Features, Serial Console, Buttons and LEDs sections.
- Add "Flashing the bootloader" and "Building and Flashing" sections,
including the official firmware download link and the flash_writer.py
workflow.
- Document all board configurations (audio, audio_sdk, camera, charger,
coremark, elf, example_camera, example_lcd, fmsynth, getprime, lcd, lte,
module, mpy, nsh, nsh_automount, nsh_trace, ostest, posix_spawn, rndis,
rndis_composite, rndis_smp, smp, usbmsc, usbnsh, wifi, wifi_smp), each of
which was verified to build.
Signed-off-by: Jorge Guzman <[email protected]>
---
.../arm/cxd56xx/boards/spresense/README.txt | 116 --------
.../arm/cxd56xx/boards/spresense/index.rst | 331 ++++++++++++++++++++-
.../cxd56xx/boards/spresense/sony-base-board.png | Bin 0 -> 755422 bytes
.../arm/cxd56xx/boards/spresense/sony-camera.png | Bin 0 -> 112012 bytes
.../arm/cxd56xx/boards/spresense/sony.png | Bin 0 -> 380184 bytes
5 files changed, 329 insertions(+), 118 deletions(-)
diff --git a/Documentation/platforms/arm/cxd56xx/boards/spresense/README.txt
b/Documentation/platforms/arm/cxd56xx/boards/spresense/README.txt
deleted file mode 100644
index 8763112b37e..00000000000
--- a/Documentation/platforms/arm/cxd56xx/boards/spresense/README.txt
+++ /dev/null
@@ -1,116 +0,0 @@
-README
-======
-
-Spresense is a compact development board based on Sony’s power-efficient
-multicore microcontroller CXD5602. It allows developers to create IoT
-applications in a very short time and is supported by the Arduino IDE as well
-as the more advanced NuttX based SDK.
-
-- Integrated GPS
- The embedded GNSS with support for GPS, QZSS and GLONASS enables applications
- where tracking is required.
-- Hi-res audio output and multi mic inputs
- Advanced 192kHz/24 bit audio codec and amplifier for audio output, and
- support for up to 8 mic input channels.
-- Multicore microcontroller
- Spresense is powered by Sony's CXD5602 microcontroller (ARM® Cortex®-M4F × 6
- cores), with a clock speed of 156 MHz.
-
-Refer to https://developer.sony.com/develop/spresense/ for further information
-about this board.
-
-NOTICE:
-
-To run the nuttx, bootloader for Spresense SDK 2.1.0 or later must be
installed.
-
-Configuration sub-directories
------------------------------
-
- elf
-
- This is a configuration to test apps/examples/elf.
-
- module
-
- This is a configuration to test apps/examples/module.
-
- posix_spawn
-
- This is a configuration to test apps/examples/posix_spawn.
-
- smp
-
- This is a configuration to run Spresense in SMP mode.
-
- wifi
-
- This is a configuration for Spresense + Wi-Fi addon (Telit GS2200M) module.
- With this configuration, (1) you can connect Spresense to an existing Wi-Fi
- access point (2.4GHz 802.11b/g/n are supported) or (2) you can make
- Spresense as a Wi-Fi access point. In both cases, you can login to the
- Spresense with telnet, also access to a webserver (NOTE: this case you need
- an extension board with microSDHC card)
-
- (1) Station (STA) mode
-
- To run the module in Station mode (i.e. to connect to an existing Wi-Fi
- access point), You need to specify SSID with passcode.
-
- nsh> gs2200m ssid-to-connect passcode &
-
- If the connection succeeded, IP address is statically assigned.
-
- nsh> ifconfig
- wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:92 at UP
- inet addr:10.0.0.2 DRaddr:10.0.0.1 Mask:255.255.255.0
-
- Then, you can run DHCP client (renew command) to obtain IP address as well
- as DNS server information. (NOTE: In current configuration, DHCP client on
- GS2200M is disabled. If you enable the internal DHCP client, you can not
- use DNS client on NuttX)
-
- nsh> renew wlan0 &
- renew [6:100]
- nsh> ifconfig
- wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:92 at UP
- inet addr:192.168.1.101 DRaddr:192.168.1.1 Mask:255.255.255.0
-
- Now, you can run telnetd and webserver on Spresense.
-
- nsh> telnetd &
- telnetd [7:100]
- nsh> webserver &
- webserver [9:100]
- nsh> Starting webserver
-
- Also, you can run NTP client to adjust the RTC on Spresense. (NOTE: we
- assume your network can access to pool.ntp.org, otherwise, you can specify
- CONFIG_NETUTILS_NTPCLIENT_SERVER)
-
- nsh> date
- Jan 01 00:00:36 1970
- nsh> ntpcstart
- Started the NTP daemon as PID=11
- nsh> date
- Jul 30 06:42:13 2019
-
- (2) Access Point (AP) mode
-
- To run the module in AP mode, you need to specify SSID to advertise and
- WPA2-PSK passphrase or WEP-key. (NOTE: in AP mode, you can also specify
- channel number to use. Also, you need to set CONFIG_WL_GS2200M_ENABLE_WEP=y
- if you want to use WEP instead of WPA2-PSK)
-
- nsh> gs2200m -a ssid-to-advertise 8-to-63-wpa2-psk-passphrase &
- or
- nsh> gs2200m -a ssid-to-advertise 10-hex-digits-wep-key &
-
- If the module was initialized in AP mode, you can see a new IP address is
- assigned.
-
- nsh> ifconfig
- wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:93 at UP
- inet addr:192.168.11.1 DRaddr:192.168.11.1 Mask:255.255.255.0
-
- Now you can connect your PC to the AP with the above SSID and WPA2-PSK
- passphrase or WEP-key which you specified.
diff --git a/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst
b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst
index 4654f11e027..12d7ab610bc 100644
--- a/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst
+++ b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst
@@ -2,6 +2,333 @@
Sony Spresense
==============
-.. include:: README.txt
- :literal:
+.. tags:: chip:cxd56xx, chip:cxd5602
+The `Spresense <https://developer.sony.com/develop/spresense/>`_ is a compact
+development board based on Sony's power-efficient multicore microcontroller
+CXD5602. It allows developers to create IoT applications in a very short time
+and is supported by the Arduino IDE as well as the more advanced NuttX based
+SDK.
+
+Key features:
+
+- **Integrated GNSS**: the embedded GNSS with support for GPS, QZSS and
+ GLONASS enables applications where tracking is required.
+- **Hi-res audio output and multi mic inputs**: advanced 192 kHz/24 bit audio
+ codec and amplifier for audio output, and support for up to 8 mic input
+ channels.
+- **Multicore microcontroller**: Spresense is powered by Sony's CXD5602
+ microcontroller (ARM® Cortex®-M4F × 6 cores), with a clock speed of 156 MHz.
+
+.. figure:: sony.png
+ :align: center
+
+ Spresense main board pinout (functional, Arduino-compatible and CXD5602
+ pin names)
+
+Extension Board
+===============
+
+The Spresense extension board exposes the main board signals on an
+Arduino-compatible header layout and adds a microSD card slot, a headphone
+jack and multiple microphone inputs.
+
+.. figure:: sony-base-board.png
+ :align: center
+
+ Spresense extension (base) board pinout
+
+Camera Board
+============
+
+The CXD5602PWBCAM2 camera board connects to the dedicated camera connector on
+the main board and is supported by the ``video``/``imager`` drivers.
+
+.. figure:: sony-camera.png
+ :align: center
+
+ Spresense camera board (CXD5602PWBCAM2)
+
+Features
+========
+
+- Sony CXD5602 microcontroller (ARM® Cortex®-M4F × 6 cores @ 156 MHz)
+- 8 MB SPI-Flash (main board), 1.5 MB SRAM
+- Integrated GNSS (GPS, QZSS, GLONASS)
+- Hi-res audio codec, up to 8 mic input channels
+- Camera interface (CXD5602PWBCAM2 support)
+- Arduino Uno compatible pin layout (via extension board)
+- microSD card slot (via extension board)
+- 4 user LEDs and Reset / Boot Recovery buttons
+
+.. note::
+
+ To run NuttX, the bootloader for Spresense SDK 2.1.0 or later must be
+ installed on the board. See `Flashing the bootloader`_ below.
+
+Serial Console
+==============
+
+The default serial console is **UART2**, exposed on the ``D00`` (RX) and
+``D01`` (TX) Arduino-compatible pins and routed to the USB connector through
+the on-board USB-to-serial bridge. It shows up on the host as
+``/dev/ttyUSB0`` (Linux) or ``/dev/cu.SLAB_USBtoUART`` (macOS) at 115200 baud,
+8N1.
+
+Buttons and LEDs
+================
+
+The main board provides four user LEDs (``LED0`` .. ``LED3``), a power LED, a
+Reset button and a Boot Recovery button. The user LEDs are available to
+software through the standard NuttX user LED interface.
+
+Flashing the bootloader
+=======================
+
+Before flashing any NuttX image, the Spresense loader/bootloader binaries must
+be installed. Download the loader package matching your SDK version from the
+`Spresense firmware download page
+<https://developer.spresense.sony-semicon.com/downloads/main-board#firmware>`_
+and flash **all** of its files at once with ``flash_writer.py``::
+
+ ./tools/flash_writer.py -s -c /dev/ttyUSB0 -d -b 115200 -n \
+ /path/to/spresense-binaries/*.espk \
+ /path/to/spresense-binaries/*.spk
+
+The ``-n`` (``--no-set-bootable``) option is used because these are loader
+components, not the bootable application. The tool relies on the Python
+``xmodem`` module (``pip install xmodem`` or ``apt install python3-xmodem``).
+
+Building and Flashing
+=====================
+
+Once the bootloader is in place, configure, build and flash any of the
+board configurations below. Replace ``<example>`` with the configuration
+name you want (e.g. ``wifi``, ``smp``, ``elf``)::
+
+ $ ./tools/configure.sh spresense:<example>
+ $ make -j
+ $ ./tools/flash_writer.py -s -c /dev/ttyUSB0 -d -b 115200 nuttx.spk
+
+The resulting ``nuttx.spk`` is flashed **without** ``-n`` so it is marked as
+the bootable application. Adjust ``/dev/ttyUSB0`` to match the serial port of
+your board.
+
+Configurations
+==============
+
+Each of the following can be selected as ``<example>`` in the
+`Building and Flashing`_ step above.
+
+audio
+-----
+
+Audio playback and capture using the CXD5602 on-chip audio subsystem
+(``CONFIG_AUDIO_CXD56``).
+
+audio_sdk
+---------
+
+Audio configuration using the SDK audio stack with microSD storage
+(``CONFIG_AUDIO`` together with SDIO/MMCSD).
+
+camera
+------
+
+Camera capture using the ISX012/ISX019 image sensors through the NuttX video
+stream interface.
+
+charger
+-------
+
+Battery charger example (``apps/examples/charger``) exercising the CXD5602
+power-management/charger interface.
+
+coremark
+--------
+
+EEMBC CoreMark CPU benchmark (``CONFIG_BENCHMARK_COREMARK``).
+
+elf
+---
+
+Tests ``apps/examples/elf`` (loading and running ELF programs).
+
+example_camera
+--------------
+
+Camera capture example with live preview on an attached LCD
+(``apps/examples/camera``).
+
+example_lcd
+-----------
+
+NX graphics demos (``nxdemo``, ``nxhello``, ``nxlines``) rendered on an
+attached LCD.
+
+fmsynth
+-------
+
+FM sound synthesizer example (``apps/examples/fmsynth``).
+
+getprime
+--------
+
+``getprime`` timing/stress test (``apps/testing/getprime``).
+
+lcd
+---
+
+LCD support together with a USB composite device (CDC/ACM + mass storage).
+
+lte
+---
+
+LTE connectivity using the Spresense LTE extension board (Altair ALT1250
+modem).
+
+module
+------
+
+Tests ``apps/examples/module`` (loadable kernel modules).
+
+mpy
+---
+
+Peripheral demonstration enabling the on-chip ADC, PWM, the camera interface
+and microSD automount, started from the board ``spresense_main`` entry point.
+
+nsh
+---
+
+Basic NuttShell (NSH) console over the serial port.
+
+nsh_automount
+-------------
+
+NSH with automatic mounting of an inserted microSD card.
+
+nsh_trace
+---------
+
+NSH with the system trace subsystem enabled for scheduler/syscall tracing.
+
+ostest
+------
+
+Standard NuttX OS test suite (``apps/testing/ostest``).
+
+posix_spawn
+-----------
+
+Tests ``apps/examples/posix_spawn``.
+
+rndis
+-----
+
+USB RNDIS Ethernet gadget with networking examples (FTP client/server, web
+server and tcpblaster).
+
+rndis_composite
+---------------
+
+Same as ``rndis`` but exposed as part of a USB composite device.
+
+rndis_smp
+---------
+
+Same as ``rndis`` but running in SMP mode across the CXD5602 cores.
+
+smp
+---
+
+Runs Spresense in SMP (symmetric multiprocessing) mode.
+
+usbmsc
+------
+
+USB Mass Storage device example, exposing a microSD card as a USB drive via a
+composite (CDC/ACM + MSC) gadget.
+
+usbnsh
+------
+
+NuttShell console over USB CDC/ACM instead of the physical UART.
+
+wifi
+----
+
+This is a configuration for Spresense + Wi-Fi add-on (Telit GS2200M) module.
+With this configuration you can either (1) connect Spresense to an existing
+Wi-Fi access point (2.4 GHz 802.11b/g/n are supported) or (2) make Spresense
+act as a Wi-Fi access point. In both cases you can log in to the Spresense over
+telnet and access a web server (NOTE: for this you need an extension board with
+a microSDHC card).
+
+**(1) Station (STA) mode**
+
+To run the module in Station mode (i.e. to connect to an existing Wi-Fi access
+point), specify the SSID with its passcode::
+
+ nsh> gs2200m ssid-to-connect passcode &
+
+If the connection succeeded, an IP address is statically assigned::
+
+ nsh> ifconfig
+ wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:92 at UP
+ inet addr:10.0.0.2 DRaddr:10.0.0.1 Mask:255.255.255.0
+
+You can then run the DHCP client (``renew`` command) to obtain an IP address as
+well as DNS server information. (NOTE: in the current configuration the DHCP
+client on the GS2200M is disabled. If you enable the internal DHCP client you
+cannot use the DNS client on NuttX)::
+
+ nsh> renew wlan0 &
+ renew [6:100]
+ nsh> ifconfig
+ wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:92 at UP
+ inet addr:192.168.1.101 DRaddr:192.168.1.1 Mask:255.255.255.0
+
+Now you can run ``telnetd`` and the web server on Spresense::
+
+ nsh> telnetd &
+ telnetd [7:100]
+ nsh> webserver &
+ webserver [9:100]
+ nsh> Starting webserver
+
+You can also run the NTP client to adjust the RTC on Spresense. (NOTE: this
+assumes your network can reach pool.ntp.org, otherwise specify
+``CONFIG_NETUTILS_NTPCLIENT_SERVER``)::
+
+ nsh> date
+ Jan 01 00:00:36 1970
+ nsh> ntpcstart
+ Started the NTP daemon as PID=11
+ nsh> date
+ Jul 30 06:42:13 2019
+
+**(2) Access Point (AP) mode**
+
+To run the module in AP mode, specify the SSID to advertise and a WPA2-PSK
+passphrase or WEP key. (NOTE: in AP mode you can also specify the channel
number
+to use. Also, set ``CONFIG_WL_GS2200M_ENABLE_WEP=y`` if you want to use WEP
+instead of WPA2-PSK)::
+
+ nsh> gs2200m -a ssid-to-advertise 8-to-63-wpa2-psk-passphrase &
+ or
+ nsh> gs2200m -a ssid-to-advertise 10-hex-digits-wep-key &
+
+If the module was initialized in AP mode, a new IP address is assigned::
+
+ nsh> ifconfig
+ wlan0 Link encap:Ethernet HWaddr 3c:95:09:00:69:93 at UP
+ inet addr:192.168.11.1 DRaddr:192.168.11.1 Mask:255.255.255.0
+
+Now you can connect your PC to the AP with the above SSID and WPA2-PSK
+passphrase or WEP key that you specified.
+
+wifi_smp
+--------
+
+Same as `wifi`_ but running in SMP mode across the CXD5602 cores.
diff --git
a/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-base-board.png
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-base-board.png
new file mode 100644
index 00000000000..3356df71592
Binary files /dev/null and
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-base-board.png
differ
diff --git
a/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-camera.png
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-camera.png
new file mode 100644
index 00000000000..8e7a3f1ad29
Binary files /dev/null and
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony-camera.png differ
diff --git a/Documentation/platforms/arm/cxd56xx/boards/spresense/sony.png
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony.png
new file mode 100644
index 00000000000..ac81b64b258
Binary files /dev/null and
b/Documentation/platforms/arm/cxd56xx/boards/spresense/sony.png differ
