Skip to content

Commit 4330f36

Browse files
committed
doc: Update doc versions in nrfxlib for 3.1.0
Updated doc versions in nrfxlib for 3.1.0 NCSDK-34657 Signed-off-by: Richa Pandey <[email protected]>
1 parent 63f2092 commit 4330f36

File tree

9 files changed

+41
-43
lines changed

9 files changed

+41
-43
lines changed

mpsl/CHANGELOG.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ Changelog
1010

1111
All the notable changes to this project are documented on this page.
1212

13-
Main branch
14-
***********
15-
1613
nRF Connect SDK v3.1.0
1714
**********************
1815

nrf_802154/doc/CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Changelog
1010
All notable changes to this project are documented in this file.
1111
See also :ref:`nrf_802154_limitations` for permanent limitations.
1212

13-
Main branch - nRF 802.15.4 Radio Driver
14-
***************************************
13+
nRF Connect SDK v3.1.0 - nRF 802.15.4 Radio Driver
14+
**************************************************
1515

1616
Notable changes
1717
===============

nrf_802154/doc/rd_service_layer_lib.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _nrf_802154_sl:
22

33
nRF 802.15.4 Service Layer
4-
==========================
4+
##########################
55

66
The nRF 802.15.4 Service Layer (SL) is a library that implements the following features of the nRF 802.15.4 Radio Driver:
77

nrf_modem/doc/CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Changelog
99

1010
All notable changes to this project are documented in this file.
1111

12-
nrf_modem 3.0.99
13-
****************
12+
nrf_modem 3.1.0
13+
***************
1414

1515
Sockets
1616
=======

nrf_rpc/CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Changelog
99

1010
All the notable changes to this project are documented on this page.
1111

12-
nRF Connect SDK v3.0.99
13-
***********************
12+
nRF Connect SDK v3.1.0
13+
**********************
1414

1515
Added
1616
=====

softdevice_controller/CHANGELOG.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ Changelog
99

1010
All the notable changes to this project are documented on this page.
1111

12-
Main branch
13-
***********
14-
1512
nRF Connect SDK v3.1.0
1613
**********************
1714

softperipheral/doc/sQSPI/features.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Features
44
########
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
This page provides an overview of the functionalities and configurations available for soft peripherals for the current state of development.
711
See the following sections for more details.
812

softperipheral/doc/sQSPI/nrf54H20_porting_v1_0_0.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ nRF54H20 porting guide
77
:local:
88
:depth: 2
99

10-
This page provides a comprehensive overview of the code structure, file hierarchy, and essential configurations and requirements needed to successfully port and implement an sQSPI aplication on the nRF54H20 device.
10+
This page provides a comprehensive overview of the code structure, file hierarchy, and essential configurations and requirements needed to successfully port and implement an sQSPI application on the nRF54H20 device.
1111

1212
.. _nrf54h20_porting_guide_code:
1313

14-
sQSPI Application code
14+
sQSPI application code
1515
**********************
1616

1717
This structure shows the relevant files and directories in the `sdk-nrfxlib`_ repository:
@@ -70,7 +70,7 @@ The following list is a detailed breakdown of the necessary paths:
7070
#define NRFX_CONFIG_H__
7171
7272
#define nrf_sqspi_irq_handler SP_VPR_IRQHandler
73-
73+
7474
#define NRF_SQSPI_ENABLED (1)
7575
#define NRF_SQSPI_MAX_NUM_DATA_LINES (4)
7676
#define NRF_SQSPI_SP_FIRMWARE_ADDR 0x2f890200
@@ -212,9 +212,9 @@ In some cases you might have to modify the sQSPI driver configuration.
212212
For example, when changing pin drive strength to guarantee signal integrity for a new PCB design.
213213
You must address these cases on the sQSPI application code:
214214

215-
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_gpio_cfg` variable to ``true``, the GPIO configuration is not managed by the sQSPI driver and it must be manually handled by the application.
215+
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_gpio_cfg` variable to ``true``, the GPIO configuration is not managed by the sQSPI driver and it must be manually handled by the application.
216216
This is a requirement for the nRF54H20 device.
217-
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_pmux_cfg` variable to ``true``, the GPIO multiplexing is not managed by the sQSPI driver and it must be manually handled by the application.
217+
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_pmux_cfg` variable to ``true``, the GPIO multiplexing is not managed by the sQSPI driver and it must be manually handled by the application.
218218
This is a requirement for the nRF54H20 device.
219219

220220
GPIO multiplexing must be handled by setting the correct ``CTRLSEL`` value in UICR.

softperipheral/doc/sQSPI/nrf54L15_porting_v1_0_0.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ nRF54L15 porting guide
77
:local:
88
:depth: 2
99

10-
This page provides a comprehensive overview of the code structure, file hierarchy, and essential configurations and requirements needed to successfully port and implement an sQSPI aplication on the nRF54L15 device.
10+
This page provides a comprehensive overview of the code structure, file hierarchy, and essential configurations and requirements needed to successfully port and implement an sQSPI application on the nRF54L15 device.
1111

1212
.. _nrf54l15_porting_guide_code:
1313

14-
sQSPI Application code
14+
sQSPI application code
1515
**********************
1616

1717
This structure shows the relevant files and directories in the `sdk-nrfxlib`_ repository:
@@ -67,16 +67,16 @@ The following list is a detailed breakdown of the necessary paths:
6767
6868
#ifndef NRFX_CONFIG_H__
6969
#define NRFX_CONFIG_H__
70-
70+
7171
#include "softperipheral_regif.h" // To Resolve correct VPR IRQn for the SoC.
7272
#define nrf_sqspi_irq_handler SP_VPR_IRQHandler
73-
73+
7474
#define NRF_SQSPI_ENABLED (1)
7575
#define NRF_SQSPI_MAX_NUM_DATA_LINES (4)
7676
#define NRF_SQSPI_SP_FIRMWARE_ADDR 0x2003c000
7777
//^ This address is user defined, the location for the sQSPI firmware
78-
79-
78+
79+
8080
#endif // NRFX_CONFIG_H__
8181
8282
Compiling source files
@@ -176,8 +176,8 @@ In some cases you might have to modify the sQSPI driver configuration.
176176
For example, when changing pin drive strength to guarantee signal integrity for a new PCB design.
177177
You must address these cases on the sQSPI application code:
178178

179-
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_gpio_cfg` variable to ``true``, the GPIO configuration is not managed by the sQSPI driver and it must be manually handled by the application.
180-
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_pmux_cfg` variable to ``true``, the GPIO multiplexing is not managed by the sQSPI driver and it must be manually handled by the application.
179+
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_gpio_cfg` variable to ``true``, the GPIO configuration is not managed by the sQSPI driver and it must be manually handled by the application.
180+
* If you set the :c:var:`nrf_sqspi_cfg_t.skip_pmux_cfg` variable to ``true``, the GPIO multiplexing is not managed by the sQSPI driver and it must be manually handled by the application.
181181

182182
The following code snippet shows how the application code can allocate the required pins and override the sQSPI driver's default configuration:
183183

@@ -254,10 +254,10 @@ The following code snippet shows how the application code can enable and disable
254254
bool result = true;
255255
uint32_t gpiohs_bias_val;
256256
uint32_t gpiohs_ctrl_val;
257-
257+
258258
gpiohs_bias_val = 0x7;
259259
NRF_GPIOHSPADCTRL->BIAS = gpiohs_bias_val;
260-
260+
261261
gpiohs_ctrl_val =
262262
(0xF << GPIOHSPADCTRL_CTRL_DATAENABLE_Pos) |
263263
(0x1 << GPIOHSPADCTRL_CTRL_CSNEN_Pos) |
@@ -273,15 +273,15 @@ The following code snippet shows how the application code can enable and disable
273273
}
274274
return result;
275275
}
276-
276+
277277
bool disable_delayed_sampling(void) {
278278
bool result = true;
279279
uint32_t gpiohs_bias_val;
280280
uint32_t gpiohs_ctrl_val;
281-
281+
282282
gpiohs_bias_val = 0x7;
283283
NRF_GPIOHSPADCTRL->BIAS = gpiohs_bias_val;
284-
284+
285285
gpiohs_ctrl_val = (0x0 << GPIOHSPADCTRL_CTRL_DATAENABLE_Pos) |
286286
(0x0 << GPIOHSPADCTRL_CTRL_CSNEN_Pos) |
287287
(0x0 << GPIOHSPADCTRL_CTRL_SCKPHASE_Pos) |
@@ -321,7 +321,7 @@ The following code snippet shows how the application code can reset **P2** pins:
321321
// NRF_GPIO_PIN_INPUT_DISCONNECT, NRF_GPIO_PIN_NOPULL,
322322
// NRF_GPIO_PIN_E0E1, NRF_GPIO_PIN_NOSENSE);
323323
}
324-
324+
325325
void set_serialPadE0E1(nrf_sqspi_dev_cfg_t qspi_dev_config){
326326
nrf_gpio_cfg(m_qspi_config.pins.sck, NRF_GPIO_PIN_DIR_OUTPUT,
327327
NRF_GPIO_PIN_INPUT_DISCONNECT, NRF_GPIO_PIN_NOPULL,
@@ -348,7 +348,7 @@ The following code snippet shows how the application code can enable and disable
348348
nrf_sqspi_spi_lines_t mspi_lines) {
349349
#pragma GCC diagnostic push
350350
#pragma GCC diagnostic ignored "-Wmissing-braces"
351-
351+
352352
nrf_sqspi_dev_cfg_t qspi_dev_config = {
353353
.csn_pin = NRF_PIN_PORT_TO_PIN_NUMBER(5, 2),
354354
.sck_freq_khz = sck_freq_khz,
@@ -361,27 +361,27 @@ The following code snippet shows how the application code can enable and disable
361361
.mspi_ddr = NRF_SQSPI_SPI_DDR_SINGLE,
362362
.spi_clk_stretch = false,
363363
.xip_cfg = NRF_SQSPI_SPI_XIP_MODE_DISABLED}}};
364-
364+
365365
if (!enable_delayed_sampling(2)) {
366366
error_exit();
367367
}
368-
368+
369369
#pragma GCC diagnostic pop
370-
370+
371371
static uint16_t context = 0x45b1;
372372
if (nrf_sqspi_dev_cfg(p_qspi, &qspi_dev_config, done_callback, &context) !=
373373
NRFX_SUCCESS) {
374374
error_exit();
375375
}
376-
376+
377377
set_serialPadE0E1(qspi_dev_config);
378378
}
379-
379+
380380
void configure_hs_r(nrf_sqspi_t *p_qspi, uint32_t sck_freq_khz,
381381
nrf_sqspi_spi_lines_t mspi_lines) {
382382
#pragma GCC diagnostic push
383383
#pragma GCC diagnostic ignored "-Wmissing-braces"
384-
384+
385385
nrf_sqspi_dev_cfg_t qspi_dev_config = {
386386
.csn_pin = NRF_PIN_PORT_TO_PIN_NUMBER(5, 2),
387387
.sck_freq_khz = sck_freq_khz,
@@ -394,19 +394,19 @@ The following code snippet shows how the application code can enable and disable
394394
.mspi_ddr = NRF_SQSPI_SPI_DDR_SINGLE,
395395
.spi_clk_stretch = false,
396396
.xip_cfg = NRF_SQSPI_SPI_XIP_MODE_DISABLED}}};
397-
397+
398398
if (!enable_delayed_sampling(2)) {
399399
error_exit();
400400
}
401-
401+
402402
#pragma GCC diagnostic pop
403-
403+
404404
static uint16_t context = 0x45b1;
405405
if (nrf_sqspi_dev_cfg(p_qspi, &qspi_dev_config, done_callback, &context) !=
406406
NRFX_SUCCESS) {
407407
error_exit();
408408
}
409-
409+
410410
set_serialPadS0S1();
411411
set_serialPadE0E1(qspi_dev_config);
412412
}

0 commit comments

Comments
 (0)