Commit graph

2933 commits

Author SHA1 Message Date
wangjianyu3
677c2187b9 Documentation/fastboot: Add usage for fastboot oem shell
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2025-03-04 12:28:12 +08:00
Stepan Pressl
e376e22f93 Documentation/applications/benchmarks/cyclictest: -q
-q (--quiet) option added

Signed-off-by: Stepan Pressl <pressl.stepan@gmail.com>
2025-03-03 16:00:07 +01:00
Bowen Wang
6303c11b53 arm/qemu-armv7a: add discard-data-on in rpproxy_ivshmem launch command
add discard-data=on in proxy launch command, so the proxy side
will clean the share memory to make sure that the shared memory is clean
every time server and proxy are started.

Signed-off-by: Bowen Wang <wangbowen6@xiaomi.com>
2025-03-03 07:37:13 +08:00
Alan Carvalho de Assis
47d0356c65 doc: Add documentation to USERLED subsystem
The USERLED subsystem is responsible to register and to control the
user LEDs on the board.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2025-03-02 00:13:29 +08:00
Kevin Witteveen (MartiniMarter)
b698cc1338 Documentation: add SX126x plan
Added detailed information about the SX126x and its current state in development.
Added directories for wireless character driver and LPWAN.
Added indexes to each directory and its contents within.

Signed-off-by: Kevin Witteveen (MartiniMarter) <kevinwit1999@gmail.com>
2025-02-27 16:03:18 -03:00
Michal Lenc
86917b4777 drivers/pwm: add PWMIOC_FAULTS_FETCH_AND_CLEAR ioctl for fault clears
This ioctl clears the active fault inputs. Some faults can be latched
(still active even if the source is not active anymore), so they have
to be cleared from the software. The argument is a pointer to unsigned
long bitmask variable. This bitmask specifies which faults are to be
cleared.

The ioctl also can fetch the faults active prior to the clear. These
faults are saved to the argument specifying which faults are to be
cleared. Therefore passing zero bitmask means the driver will only return
active faults and clear none. Passing NULL pointer means the driver
will clear all active and return none.

The implementation of this ioctl is per driver.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2025-02-27 11:47:51 -03:00
Stepan Pressl
e53de96692 Documentation: add cyclictest benchmark utility documentation
The documentation concerns the cyclictest in apps/benchmarks/cyclictest.
The documentation describes the usage of the NuttX device timer
in this benchmark, the app usage and an example with an output.

Signed-off-by: Stepan Pressl <pressl.stepan@gmail.com>
2025-02-27 11:30:55 -03:00
Eren Terzioglu
8d86340b98 Docs/esp32: Add brickmatch config doc for esp32-devkitc
Add missing documentation for brickmatch defconfig for esp32-devkitc

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-27 12:12:20 +01:00
Eren Terzioglu
a66e58cf59 Docs/brickmatch: Update brickmatch game docs
Update brickmatch game docs after I/O option additions

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-27 12:12:20 +01:00
Eren Terzioglu
c7702894fe documentation/esp32[s2|s3]: Add I2C slave support
Add I2C Slave support into docs for xtensa based Espressif devices

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-26 16:32:40 +01:00
Eren Terzioglu
7658c39304 documentation/esp32[c3|c6|h2]: Add I2C slave support
Add I2C slave support into docs for risc-v based Espressif devices

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-26 16:32:40 +01:00
leocafonso
98b9cc25ef Documentation/ra4m1: Add documentation for Renesas RA4M1 MCU and arduino-r4-minima
Signed-off-by: leocafonso <leocafonso@gmail.com>
2025-02-25 13:14:48 -03:00
Marco Casaroli
16e2e77bdf esp32: use mcuboot for qemu_openeth config
Now, espressif qemu supports MCUboot, so we can switch the app
format.
2025-02-25 13:13:40 -03:00
Marco Casaroli
b4c827cee3 esp32s3: use mcuboot for qemu_openeth config
Now, espressif qemu supports MCUboot, so we can switch the app
format.

The build was failing with the legacy app format because
_ext_ram_bss_end and _ext_ram_bss_start are not defined in the
legacy linker file.
2025-02-25 13:13:40 -03:00
Tiago Medicci Serrano
798a73ac1a Documentation/python: Fix tutorial for running Python
After https://github.com/apache/nuttx-apps/pull/2982, there is no
need to mount the modules and manually set the required environment
variables: they are all set by the new Python wrapper application.

Signed-off-by: Tiago Medicci Serrano <tiago.medicci@espressif.com>
2025-02-21 15:34:48 +01:00
Rodrigo Sim
9d8a66717c Documentation:Fix Seeed Studio XIAO nRF52840
Change XIAO nRF52840 name at Documentation to
match product name and other Seeed Studio boards.

Signed-off-by: Rodrigo Sim <rcsim10@gmail.com>
2025-02-21 11:16:23 -03:00
Eren Terzioglu
3661cdeed9 esp32[c3|c6|h2]: Add I2S support
Add I2S support for risc-v based Espressif devices

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-21 20:48:15 +08:00
Eren Terzioglu
2d069231c5 esp32[s3]: Add Documentation for esp32s3-lcd-ev board 2025-02-20 14:00:58 -05:00
Eren Terzioglu
3170af2fd0 esp32[c6|h2]: Update peripheral support docs 2025-02-20 14:00:58 -05:00
Tiago Medicci Serrano
436dbe3f0b Documentation/esp32s3: Add ESP32-S3's PSRAM entry
Add entry for the external PSRAM support on ESP32-S3 and document
how to move data to the external PSRAM to free the internal memory.
2025-02-19 11:44:18 -03:00
wangjianyu3
32bc95182a Documentation/esp32s3-devkit: Add doc for USB Fastboot
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2025-02-19 14:25:28 +08:00
Neo Xu
05e1cb736c doc: add GDB Plugin commands table
Add a table of commands we extend using GDB python API.
Add irqinfo command documentation.

Signed-off-by: Neo Xu <neo.xu1990@gmail.com>
2025-02-18 11:16:17 -03:00
Neo Xu
504c3dddf0 doc: update GDB python plugin path
The NuttX GDB python plugin has been moved to tools/pynuttx/nxgdb.
Update all documentation including this path.

Signed-off-by: Neo Xu <neo.xu1990@gmail.com>
2025-02-18 11:16:17 -03:00
Alan Carvalho de Assis
edba1b5701 DOC: Fix documentation to include checkpatch.sh
Unfortunately new contributors used to submit code with many coding
issues. And in fact it is our guilt: our codign style documentation
doesn't say to them how to use the checkpatch to find the issues.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2025-02-14 18:25:44 +01:00
Alan Carvalho de Assis
5a6e5a8fb4 serial: Add struct serial_icounter_s and CONFIG_SERIAL_TIOCGICOUNT
This commit add support to the serial_icounter_s struct used with
TIOCGICOUNT to report U[S]ART errors such as frame, parity, overrun,
etc.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2025-02-14 18:24:47 +01:00
Huang Qi
285a846af1 docs: Add editor integration guide for Rust development in NuttX
Summary:
- Added a section on editor integration for Rust development in NuttX, focusing on VS Code and rust-analyzer
- Provides steps to configure `.vscode/settings.json` to recognize Rust project structure and optional settings for custom target specifications

Impact:
- Enhances developer productivity by providing better IDE support for Rust in NuttX
- No impact on existing functionality; the guide is purely informational and configuration-based

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-02-14 13:23:13 -03:00
chao an
2e21426683 qemu-armv8a/ivshmem: add ivshmem chapter
An example implementation for OpenAMP based on the Inter-VM share memory(ivshmem)::

rpproxy_ivshmem:  Remote slave(client) proxy process.
rpserver_ivshmem: Remote master(host) server process.

Please refer to the official Qemu ivshmem documentation for more information:

https://www.qemu.org/docs/master/system/devices/ivshmem.html

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-02-13 11:03:26 -03:00
Huang Qi
df65980273 docs: enhance Rust guide with CPU optimization instructions
Summary:
- Added a section to the Rust guide that explains how to use the `RUSTFLAGS` environment variable to specify the target CPU for optimization.
- Provides examples and instructions for setting `RUSTFLAGS` for different CPU models, such as Cortex-M33 and Cortex-M55, to generate performance-optimized code.

Impact:
- Enhances the developer's ability to produce more efficient Rust applications on NuttX by leveraging CPU-specific optimizations.
- No runtime or functional changes; only documentation improvements to guide users in optimizing their build configurations for specific hardware.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-02-12 15:23:28 -03:00
Huang Qi
081588c1c5 docs: update rust guide to include X86 and X86_64 support
Summary:
- Updated the Rust guide documentation to include X86 and X86_64 platforms in the supported platforms list.
- Ensured that the guide provides accurate and up-to-date information for developers using these new platforms.

Impact:
- Expands the platform support section of the Rust guide, making it more inclusive and useful for a wider range of developers.
- No functional changes to the code itself; this update only affects the documentation.
- Enhances the usability of the guide by providing necessary setup and configuration details for the X86 and X86_64 architectures.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-02-12 15:23:28 -03:00
Matteo Golin
729f8a75f7 drivers/sensors: Added uORB driver for LSM6DSO32 IMU.
Adds support for the LSM6DSO32 IMU by STM using the uORB framework. This
only contains limited support for the I2C interface, interrupt and
polling driven measurement and standard modes of operation (high
performance ODRs). Features like interrupts besides DRDY, filtering,
gesture recognition and acting as a bus master are not implemented.
2025-02-12 10:44:15 -03:00
zhengyu9
ac019bbfa2 drivers/mtd: cfi-flash driver
Realization of cfi-flash driver.
Add the interfaces of intel and amd command sets.

Signed-off-by: zhengyu9 <zhengyu9@xiaomi.com>
Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-02-11 17:23:44 +08:00
Laczen JMS
6b5fccb32c esp32: add espnow documentation and defconfig.
Added documentation for espnow and a default defconfig to illustrate
the use of espnow for udp communication.

Signed-off-by: Laczen JMS <laczenjms@gmail.com>
2025-02-10 16:15:25 -03:00
Rodrigo Sim
2d6d52c84a Documentation: Add XIAO nRF52840 Board
Signed-off-by: Rodrigo Sim <rcsim10@gmail.com>
2025-02-10 15:42:53 -03:00
Kyle Wilson
ac0ba3f413 Add STM32H5 architecture documentation.
Add documentation for nucleo-h563zi development board.

Removed whitespace at the end of lines.

Fixed column formatting.

Fixed Title overline too short error.

Added image to nucleo-h563zi documentation.
2025-02-09 00:01:45 +08:00
Jukka Laitinen
e56eaffe76 Documentation/platforms/risc-v/mpfs/boards/icicle/index.rst: Add documentation for "hwtest" board configuration
Signed-off-by: Jukka Laitinen <jukkax@ssrc.tii.ae>
2025-02-08 19:31:13 +08:00
zouboan
6dbb2edd2c Documentation:add documentation about ethernet for Zynq MPSoC and ZCU111
This commit add documentation Description for ZYNQ-MPSOC's NET driver key
features and ethernet config of ZCU111.
2025-02-07 20:21:18 +08:00
chao an
9754fdf63c mps/mps3-an547: correct command line of genromfs
genromfs -a 128 -f ../romfs.img -d pic

f: -f output
a: -a alignment

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-02-07 17:41:04 +08:00
chao an
c3426325d8 qemu-armv7a/ivshmem: add ivshmem chapter
An example implementation for OpenAMP based on the Inter-VM share memory(ivshmem)::

rpproxy_ivshmem:  Remote slave(client) proxy process.
rpserver_ivshmem: Remote master(host) server process.

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-02-07 17:40:38 +08:00
Michal Lenc
7af7655234 samv7/serial: allow TX/RX DMA for UART drivers
So far only USART drivers could use TX/RX DMA. This commit adds the
support for UART drivers as well (with the exception of serial console).

UART peripheral does not have timeout interrupt, so external polling
is required to flush the RX data from DMA buffers even if the buffer
is not yet full. The board layer can do this by calling
sam_serial_dma_poll function.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2025-01-30 13:55:13 +08:00
Huang Qi
69495f8a40 docs: Add Rust examples including JSON handling and Slint UI framework
Summary:
- Added two new Rust example applications to the documentation:
  - `hello` example showcasing JSON serialization/deserialization, async runtime usage, and C interoperability in a NuttX environment
  - `slint` example demonstrating the integration of the Slint UI framework with NuttX's framebuffer and touchscreen devices for creating GUI applications in Rust
- Each example includes detailed explanations of key features and how they are implemented using Rust's modern language capabilities

Impact:
- Enhances the documentation for Rust development within NuttX, providing clear and practical examples for developers
- Facilitates easier adoption of Rust for new projects by demonstrating how to leverage its features while maintaining compatibility with existing NuttX infrastructure
- No changes to the core NuttX system; the additions are entirely within the documentation and examples directory

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-01-30 13:45:01 +08:00
Jorge Guzman
7240565ca3 boards/linum-stm32h753bi: Fix LVGL video memory allocation
Previously, the LVGL example had a workaround in lv_nuttx_fbdev.c to prevent
video memory invasion. This fix properly addresses the issue by:

- Reducing total SDRAM size from 8MB to 6MB
- Moving LTDC base address to 0xC0600000
- Reserving dedicated space for video memory outside NuttX heap

This ensures proper memory separation between video buffer and system heap.

Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
2025-01-29 12:43:39 +08:00
Huang Qi
68d1750c12 docs: Rename hello_rust to rust/baremetal to reflect the actual codebase
Summary:
- The `hello_rust` example has been moved to `rust/baremetal` to better reflect its purpose as a bare-metal Rust application.
- The move also helps in organizing the Rust examples more clearly, separating them into categories based on their environment (bare-metal vs. non-bare-metal).
- A new directory structure has been created under `rust/baremetal`, and the `index.rst` file has been updated to describe the `baremetal` example in detail.
- The top-level `rust/index.rst` file has been created to include the new `rust/baremetal` directory in the toctree.

Impact:
- The new file structure and documentation improvements will help new contributors and users understand the purpose and setup of the example more easily.
- This change aligns the documentation with the actual codebase, enhancing the overall maintainability and clarity of the project.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-01-29 12:41:06 +08:00
Matteo Golin
044879e7a3 sensors/lis2mdl: Create a UORB driver for the LIS2MDL magnetometer. 2025-01-28 16:34:17 +08:00
Alan Carvalho de Assis
06722d65ec boards/stm32h7: Fix wrong usbnsh name and fix Documentation
Fixes the incorrect board profile name to 'usbnsh' used on
WeAct-STM32H743 board.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2025-01-24 09:10:04 +08:00
wangmingrong1
49460518a9 Doc: Fortify Instructions
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2025-01-23 15:36:14 +08:00
wangmingrong1
7774271ad6 Docu: Stack overflow check
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2025-01-23 14:14:38 +08:00
wangmingrong1
cd9f2d7099 Docu/gcov: Modify the description and fix the script error
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2025-01-22 21:41:06 +08:00
wangjianyu3
72d793b26e Documentation: Add usage of Wireshark for USB monitor
For: https://github.com/apache/nuttx/issues/15595
Ref: https://wiki.wireshark.org/CaptureSetup/USB

Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2025-01-22 15:17:38 +08:00
Huang Qi
de4135afdd Documentation: Update supported platforms for Rust guide
Summary:
Please refer to https://github.com/rust-lang/rust/pull/135757

- Updated the supported platforms list in the Rust guide to reflect that ARMv7-A and AArch64 are ready
- Removed the "WIP" (Work In Progress) label from ARMv7-A and AArch64 in the supported platforms section

Impact:
- Provides accurate information to developers about the current state of Rust support for ARMv7-A and AArch64 platforms
- Aligns the documentation with the latest developments in the Rust ecosystem
- No functional changes to the codebase, only documentation updates

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-01-21 10:59:08 +08:00
dongjiuzhu1
9711323208 Documentation/uorb: remove uncalibrated member
Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-01-21 09:43:14 +08:00