softperipheral: rev cf28ddf86b89fb647ee876546770c2676b3bc63c

softperipheral/CHANGELOG.rst contains the list of changes.

Signed-off-by: Luis Lopez <[email protected]>

Author: lopeztel

.checkpatch.conf

@@ -31,3 +31,4 @@
 --exclude gzll
 --exclude nfc
 --exclude nrf_modem/include
+--exclude softperipheral

CODEOWNERS

@@ -47,3 +47,4 @@ doc/*                                     @b-gent
 /lc3/                                     @koffes @alexsven
 /nrf_fuel_gauge/                          @nordic-auko
 /nrf_wifi/                                @udaynordic @rajb9 @srkanordic
+/softperipheral/                          @lopeztel

README.rst

@@ -25,3 +25,4 @@ Refer to their respective documentation for more information.
    openthread/README
    nrf_rpc/README
    softdevice_controller/README
+   softperipheral/README

doc/links.txt

@@ -7,6 +7,8 @@
 
 .. _`nrfx`: https://github.com/NordicSemiconductor/nrfx/
 
+.. _`sdk-nrfxlib`: https://github.com/nrfconnect/sdk-nrfxlib
+
 .. _`TinyCBOR`: https://github.com/zephyrproject-rtos/tinycbor
 
 .. _`zcbor`: https://github.com/NordicSemiconductor/zcbor

softperipheral/CHANGELOG.rst

@@ -0,0 +1,19 @@
+.. _softperipherals_changelog:
+
+Changelog
+#########
+
+.. contents::
+   :local:
+   :depth: 2
+
+All the notable changes to this project are documented on this page.
+
+|NCS| v3.0.0
+************
+
+This is an initial release for Soft Peripherals.
+See the following list changes:
+
+* Added:
+  * First implementation of Soft Peripheral **sQSPI**.

softperipheral/README.rst

@@ -0,0 +1,20 @@
+.. _soft_peripherals:
+
+Soft peripherals
+################
+
+.. contents::
+   :local:
+   :depth: 2
+
+This documentation outlines the concept of soft peripherals, designed to emulate hardware peripherals using the Fast Lightweight Peripheral Processor (FLPR).
+It covers setup, integration, and operational guidelines for using each soft peripheral through the nrfx driver API, alongside detailed descriptions of limitations and performance considerations.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Subpages:
+
+   doc/introduction.rst
+   doc/sQSPI/README.rst
+   CHANGELOG.rst

softperipheral/doc/images/SP_concept.svg

@@ -0,0 +1,44 @@
+.. _intro_soft_peripherals:
+
+Introduction
+############
+
+.. contents::
+   :local:
+   :depth: 2
+
+Soft peripherals enable the emulation of a digital hardware peripheral (IP) by executing it on the Fast Lightweight Peripheral Processor (FLPR) through an application-controlled user interface.
+This functionality allows the soft peripheral to be used in a system where the hardware of a peripheral is not available.
+It also allows to include additional instances of a peripheral in case the platform lacks sufficient hardware peripherals.
+
+In most cases, the features and performance of a soft peripheral are equivalent to those of a hardware peripheral.
+However, there may be some limitations. For more information, see the corresponding limitations page.
+
+The operation of a soft peripheral is abstracted, and its control is facilitated through a user interface managed through the nrfx driver API.
+This user interface is a set of functions that the application can call to interact with the peripheral.
+
+The following image shows the software stack of an application:
+
+.. image:: images/SP_concept.svg
+  :alt: Soft Peripheral concept
+
+.. note::
+
+   Note that in both the documentation and source files, soft peripherals are referred to by prefixing the letter *s* before the name of the peripheral.
+   For example, ``sQSPI``.
+
+Platform support
+****************
+
+The following table shows which soft peripherals and their versions are supported by each platform:
+
+.. list-table:: Soft peripheral device support
+   :widths: auto
+   :header-rows: 1
+
+   * - Soft Peripheral
+     - Hardware platform
+     - Version(s)
+   * - sQSPI
+     - nRF54L15 SoC
+     - v0.1.0

softperipheral/doc/introduction.rst

@@ -0,0 +1,23 @@
+.. _sqspi_changelog:
+
+sQSPI Changelog
+###############
+
+.. contents::
+   :local:
+   :depth: 2
+
+All the notable changes to sQSPI are documented on this page.
+
+v0.1.0
+************
+
+This is an initial release.
+See the following list of changes:
+
+* Added:
+
+  * TX, RX, and TX/RX :ref:`SPI transfer modes<sqspi_features_spi_modes>`.
+  * Configurable :ref:`clock phase and polarity<sqspi_features_clock_phase>`.
+  * :ref:`Delayed read sampling <sqspi_features_read_sampling>`.
+  * Support for :ref:`various packet formats <sqspi_features_packet_formats>`.

softperipheral/doc/sQSPI/CHANGELOG.rst

@@ -0,0 +1,23 @@
+.. _sQSPI:
+
+sQSPI
+################
+
+.. contents::
+   :local:
+   :depth: 2
+
+This documentation outlines the Soft Peripheral **sQSPI**.
+It covers setup, integration, and operational guidelines for using **sQSPI** through the nrfx driver API, alongside detailed descriptions of limitations and performance considerations.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Subpages:
+
+   CHANGELOG.rst
+   features.rst
+   limitations.rst
+   nrf54L15_porting_v0_1_0.rst
+   nrf54H20_porting_v0_1_0.rst
+   api_reference_v0_1_0.rst