Skip to content

Commit 75a366c

Browse files
committed
doc: doc review p1 build fix
made some small initial changes added the missing ref Signed-off-by: Anna Wojdylo <[email protected]>
1 parent ea1197b commit 75a366c

File tree

8 files changed

+37
-33
lines changed

8 files changed

+37
-33
lines changed

softperipheral/CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ nRF Connect SDK v3.2.0
1515
This version contains an initial release of the Soft Peripheral sEMMC.
1616
See the following list of changes:
1717

18-
1918
* Added:
2019

2120
* The first implementation of Soft Peripheral sEMMC for nRF54H Series and nRF54L Series SoCs.
2221
For details, see the :ref:`semmc_changelog` page.
2322

24-
* New virtual register for sQSPI. Updates sQSPI to version 1.2.0. Now supports the nRF54LM20 device.
23+
* New virtual register for sQSPI.
24+
It updates sQSPI to version 1.2.0 and also supports the nRF54LM20 device.
2525
For details, see the :ref:`sqspi_changelog` page.
2626

2727
nRF Connect SDK v3.1.0

softperipheral/doc/introduction.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,22 +46,22 @@ The following table shows which soft peripherals and their versions are supporte
4646
- - nRF54L Series SoCs
4747
- nRF54H Series SoCs
4848
- - nRF54L15 SoC:
49-
- v0.1.0 with NCS v3.0.0
50-
- v1.0.0 with NCS v3.1.0
51-
- v1.1.0 with NCS v3.1.0
52-
- v1.2.0 with NCS v3.2.0
49+
- v0.1.0 with the NCS v3.0.0
50+
- v1.0.0 with the NCS v3.1.0
51+
- v1.1.0 with the NCS v3.1.0
52+
- v1.2.0 with the NCS v3.2.0
5353
- nRF54LM20 SoC:
54-
- v1.2.0 with NCS v3.2.0
54+
- v1.2.0 with the NCS v3.2.0
5555
- nRF54H20 SoC:
56-
- v0.1.0 with NCS v3.0.0
57-
- v1.1.0 with NCS v3.1.0
58-
- v1.2.0 with NCS v3.2.0
56+
- v0.1.0 with the NCS v3.0.0
57+
- v1.1.0 with the NCS v3.1.0
58+
- v1.2.0 with the NCS v3.2.0
5959
* - sEMMC
6060
- - nRF54L Series SoCs
6161
- nRF54H Series SoCs
6262
- - nRF54L15 SoC:
63-
- v0.1.0 with NCS v3.2.0
63+
- v0.1.0 with the NCS v3.2.0
6464
- nRF54LM20 SoC:
65-
- v0.1.0 with NCS v3.2.0
65+
- v0.1.0 with the NCS v3.2.0
6666
- nRF54H20 SoC:
67-
- v0.1.0 with NCS v3.2.0
67+
- v0.1.0 with the NCS v3.2.0

softperipheral/doc/sEMMC/CHANGELOG.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ sEMMC changelog
77
:local:
88
:depth: 2
99

10-
All the notable changes to sEMMC are documented on this page. Refer to :ref:`intro_soft_peripherals_platform_support` for supported Nordic devices for each version.
10+
All the notable changes to sEMMC are documented on this page.
11+
Refer to :ref:`intro_soft_peripherals_platform_support` for supported Nordic devices for each version.
1112

1213
v0.1.0
1314
******
1415

1516
This is an initial release.
1617

17-
* Added the following for the nRF54H Series and nRF54L Series devices:
18+
* Added the following support for the nRF54H Series and nRF54L Series devices:
1819

19-
* 1-lane and 4-lane data transmission support
20-
* Support for Class 0 commands - Basic
21-
* Support for Class 2 commands - Block read
22-
* Support for Class 4 commands - Block write
23-
* Support for Class 5 commands - Erase
24-
* Support for Class 6 commands - Write protection
25-
* Support for Class 7 commands - Lock device
26-
* Support for Class 11 commands - Command queuing
27-
* Support for all response types
20+
* 1-lane and 4-lane data transmission
21+
* Class 0 commands - Basic
22+
* Class 2 commands - Block read
23+
* Class 4 commands - Block write
24+
* Class 5 commands - Erase
25+
* Class 6 commands - Write protection
26+
* Class 7 commands - Lock device
27+
* Class 11 commands - Command queuing
28+
* All response types

softperipheral/doc/sEMMC/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sEMMC
77
:local:
88
:depth: 2
99

10-
This documentation outlines the soft peripheral sEMMC.
10+
This documentation outlines the sEMMC Soft Peripheral.
1111
It covers setup, integration, and operational guidelines for using sEMMC through the nrfx driver API, alongside detailed descriptions of limitations and performance considerations.
1212

1313
.. note::

softperipheral/doc/sEMMC/features.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sEMMC features
77
:local:
88
:depth: 2
99

10-
This page provides an overview of the functionalities and configurations available for the soft peripheral sEMMC for the current state of development.
10+
This page provides an overview of the functionalities and configurations available for the Soft Peripheral sEMMC for the current state of development.
1111
See the following sections for more details.
1212

1313
.. _semmc_features_command_support:
@@ -28,13 +28,14 @@ sEMMC supports the following JEDEC Standard No. 84-B51A command groups:
2828
.. note::
2929
Refer to the :file:`nrf_semmc.h` header for a list of supported commands.
3030

31-
3231
.. _semmc_features_hs200_mode:
3332

3433
HS200 mode support
3534
******************
3635

37-
sEMMC supports the HS200 mode for high-speed transfers. This allows sEMMC to operate at frequencies up to 80MHz on the nRF54H20 device.
36+
sEMMC supports the HS200 mode for high-speed transfers.
37+
This allows sEMMC to operate at frequencies up to 80MHz on the nRF54H20 device.
3838

3939
.. note::
40-
A tuning cycle using CMD21 might be necessary to find the optimal sampling point for reads. After doing a tuning cycle, apply the sampling value to :c:var:`nrf_semmc_config_t.read_delay`.
40+
You need to perform a tuning cycle using CMD21 to find the optimal sampling point for reads.
41+
After completing the tuning cycle, set the sampling value in the :c:var:`nrf_semmc_config_t.read_delay` variable.

softperipheral/doc/sQSPI/CHANGELOG.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ sQSPI changelog
77
:local:
88
:depth: 2
99

10-
All the notable changes to sQSPI are documented on this page. Refer to :ref:`intro_soft_peripherals_platform_support` for supported devices for each version.
10+
All the notable changes to sQSPI are documented on this page.
11+
Refer to :ref:`intro_soft_peripherals_platform_support` for supported devices for each version.
1112

1213
v1.2.0
1314
******

softperipheral/doc/sQSPI/sqspi_nrf54H_series_porting_v1_2_0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ GPIO multiplexing must be handled by setting the correct ``CTRLSEL`` value in UI
214214
Additionally, the sQSPI application requires FastPad bias configuration to run at high frequency on SCLK.
215215

216216
Any conflicting peripherals and existing memory partitions on the same port as sQSPI must be disabled in the overlay depending on your needs.
217-
An example code snippet of a devicetree overlay to give FLPR access to the pins on port P7 follows below. First in the snippet, the `pinctrl` block
217+
An example code snippet of a devicetree overlay to give FLPR access to the pins on port P7 follows below. First in the snippet, the `pinctrl` block
218218
does GPIO configuration, setting up the pins as described in :ref:`sqspi_nrf54h_series_porting_guide_gpio_config`.
219219
The `cpuflpr_vpr` block and the following block will do the memory partitioning of VPR and the RAM used by sQSPI.
220220

@@ -312,7 +312,7 @@ You will need the following lines in your application to apply the pin configura
312312
// The following line initializes sQSPI
313313
static nrf_sqpsi_t m_sqspi = {.p_reg = (void *)SP_REGIF_BASE, .drv_inst_idx = 0};
314314
315-
315+
.. _nrf54h20_porting_guide_ram_configuration:
316316
.. _nrf54H_series_porting_guide_ram_configuration:
317317

318318
RAM configuration
@@ -359,7 +359,7 @@ For nRF54H Series devices the firmware has been tested with values after the con
359359
IRQ connection
360360
**************
361361

362-
For sQSPI to communicate with the application core, the sQSPI IRQ handler must be registered.
362+
For sQSPI to communicate with the application core, the sQSPI IRQ handler must be registered.
363363
The following code line registers the IRQ handler to FLPR:
364364

365365
.. code-block:: c

softperipheral/doc/sQSPI/sqspi_nrf54L_series_porting_v1_2_0.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,7 @@ Assuming there is an access to the peripheral ``MEMCONF``, the following code sn
432432
nrf_qspi_activate(&m_qspi);
433433
nrf_memconf_ramblock_ret_enable_set(NRF_MEMCONF, 1, MEMCONF_POWER_RET_MEM0_Pos, false);
434434
435+
.. _nrf54l15_porting_guide_ram_configuration:
435436
.. _nrf54L_series_porting_guide_ram_configuration:
436437

437438
RAM configuration

0 commit comments

Comments
 (0)