Skip to content

Commit 20f7251

Browse files
lopeztellopeztel
committed
softperipheral: rev cf28ddf86b89fb647ee876546770c2676b3bc63c
softperipheral/CHANGELOG.rst contains the list of changes. Signed-off-by: Luis David Lopez <[email protected]>
1 parent 79a1524 commit 20f7251

29 files changed

+8726
-0
lines changed

‎.checkpatch.conf‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@
3131
--exclude gzll
3232
--exclude nfc
3333
--exclude nrf_modem/include
34+
--exclude softperipheral

‎CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,4 @@ doc/* @b-gent
4747
/lc3/ @koffes @alexsven
4848
/nrf_fuel_gauge/ @nordic-auko
4949
/nrf_wifi/ @udaynordic @rajb9 @srkanordic
50+
/softperipheral/ @lopeztel

‎README.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ Refer to their respective documentation for more information.
2525
openthread/README
2626
nrf_rpc/README
2727
softdevice_controller/README
28+
softperipheral/README

‎doc/links.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
.. _`nrfx`: https://github.com/NordicSemiconductor/nrfx/
99

10+
.. _`sdk-nrfxlib`: https://github.com/nrfconnect/sdk-nrfxlib
11+
1012
.. _`TinyCBOR`: https://github.com/zephyrproject-rtos/tinycbor
1113

1214
.. _`zcbor`: https://github.com/NordicSemiconductor/zcbor

‎softperipheral/CHANGELOG.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _softperipherals_changelog:
2+
3+
Changelog
4+
#########
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
All the notable changes to this project are documented on this page.
11+
12+
|NCS| v3.0.0
13+
************
14+
15+
This is an initial release for Soft Peripherals.
16+
See the following list changes:
17+
18+
* Added:
19+
* The first implementation of Soft Peripheral sQSPI for the nRF54L15 and nRF54H20 SoCs.

‎softperipheral/README.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _soft_peripherals:
2+
3+
Soft peripherals
4+
################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
This documentation outlines the concept of soft peripherals, designed to emulate hardware peripherals using the Fast Lightweight Peripheral Processor (FLPR).
11+
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.
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
:glob:
16+
:caption: Subpages:
17+
18+
doc/introduction.rst
19+
doc/sQSPI/README.rst
20+
CHANGELOG.rst

‎softperipheral/doc/images/SP_concept.svg‎

Lines changed: 454 additions & 0 deletions
Loading

‎softperipheral/doc/introduction.rst‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
.. _intro_soft_peripherals:
2+
3+
Introduction
4+
############
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
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.
11+
This functionality allows the soft peripheral to be used in a system where the hardware of a peripheral is not available.
12+
It also allows to include additional instances of a peripheral in case the platform lacks sufficient hardware peripherals.
13+
14+
In most cases, the features and performance of a soft peripheral are equivalent to those of a hardware peripheral.
15+
However, there may be some limitations. For more information, see the :ref:`sqspi_limitations` page.
16+
17+
The operation of a soft peripheral is abstracted, and its control is facilitated through a user interface managed through the nrfx driver API.
18+
This user interface is a set of functions that the application can call to interact with the peripheral.
19+
20+
The following image shows the software stack of an application:
21+
22+
.. image:: images/SP_concept.svg
23+
:alt: Soft Peripheral concept
24+
25+
.. note::
26+
27+
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.
28+
For example, ``sQSPI``.
29+
30+
31+
Comparison between QSPI and sQSPI support
32+
*****************************************
33+
34+
You should be aware of the differences between sQSPI and QSPI features:
35+
36+
.. list-table::
37+
:header-rows: 1
38+
39+
* - Feature
40+
- QSPI support
41+
- sQSPI support
42+
* - DDR Clocking
43+
- yes
44+
- no
45+
* - XIP (Execute in Place)
46+
- yes
47+
- no
48+
* - SSP (Synchronous Serial Protocol)
49+
- yes
50+
- no
51+
* - MICROWIRE
52+
- yes
53+
- no
54+
* - JEDEC xSPI
55+
- yes
56+
- no
57+
* - HyperBus
58+
- yes
59+
- no
60+
* - Data Masking
61+
- yes
62+
- no
63+
* - SPI Dynamic Wait State
64+
- yes
65+
- no
66+
* - Multi-Master Bus Topologies (Arbitration)
67+
- yes
68+
- no
69+
* - Clock Stretching
70+
- yes
71+
- no
72+
* - Toggling CS High Between Data Frames (SSTE: Target Select Toggle Enable)
73+
- yes
74+
- no
75+
* - QSPI Address/Command Lengths Using 4-Bit Increments
76+
- yes
77+
- no
78+
79+
Platform support
80+
****************
81+
82+
The following table shows which soft peripherals and their versions are supported by each platform:
83+
84+
.. list-table:: Soft peripheral device support
85+
:widths: auto
86+
:header-rows: 1
87+
88+
* - Soft Peripheral
89+
- Hardware platform
90+
- Version(s)
91+
* - sQSPI
92+
- nRF54L15 SoC
93+
- v0.1.0
94+
* - sQSPI
95+
- nRF54H20 SoC
96+
- v0.1.0

‎softperipheral/doc/sQSPI/CHANGELOG.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _sqspi_changelog:
2+
3+
sQSPI Changelog
4+
###############
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
All the notable changes to sQSPI are documented on this page.
11+
12+
v0.1.0
13+
************
14+
15+
This is an initial release.
16+
See the following list of changes:
17+
18+
* Added:
19+
20+
* TX, RX, and TX/RX :ref:`SPI transfer modes<sqspi_features_spi_modes>` support.
21+
* Configurable :ref:`clock phase and polarity<sqspi_features_clock_phase>`.
22+
* :ref:`Delayed read sampling <sqspi_features_read_sampling>`.
23+
* Support for :ref:`various packet formats <sqspi_features_packet_formats>`.

‎softperipheral/doc/sQSPI/README.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _sQSPI:
2+
3+
sQSPI
4+
################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
This documentation outlines the Soft Peripheral sQSPI.
11+
It covers setup, integration, and operational guidelines for using sQSPI through the nrfx driver API, alongside detailed descriptions of limitations and performance considerations.
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
:glob:
16+
:caption: Subpages:
17+
18+
CHANGELOG.rst
19+
features.rst
20+
limitations.rst
21+
nrf54L15_porting_v0_1_0.rst
22+
nrf54H20_porting_v0_1_0.rst
23+
api_reference_v0_1_0.rst
24+
timing.rst

0 commit comments

Comments
 (0)