Skip to content

Commit 1ac26d0

Browse files
greg-ferLuDuda
authored andcommitted
doc: nrfxlib doc check fixes
Applied several formatting and style edits. Checked documentation before NCS 1.7.0 release. NCSDK-11020. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 6724add commit 1ac26d0

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

mpsl/doc/clock.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
.. _mpsl_clock:
22

33
MPSL Clock
4-
**********
4+
##########
55

6-
The MPSL clock module provides access to the low-frequency clock (LFCLK) configuration and allows the application to request the crystal oscillator source of the high-frequency clock (HFCLK).
6+
.. contents::
7+
:local:
8+
:depth: 2
79

8-
Design description
9-
==================
10+
The MPSL clock module provides access to the low-frequency clock (LFCLK) configuration and allows the application to request the crystal oscillator source of the high-frequency clock (HFCLK).
1011

11-
See the following <Low-frequency clock (LFCLK)>_ and <High-frequency clock (HFCLK)>_ sections for a description of the design.
12+
See the following `Low-frequency clock (LFCLK)`_ and `High-frequency clock (HFCLK)`_ sections for a description of the design.
1213

1314
Low-frequency clock (LFCLK)
14-
---------------------------
15+
***************************
1516

16-
MPSL can use one of the two available low-frequency clock (LFCLK) sources:
17+
MPSL can use one of the following available low-frequency clock (LFCLK) sources:
1718

18-
* the 32.768 kHz internal RC oscillator (LFRC)
19-
* the 32.768 kHz crystal oscillator (LFXO)
19+
* 32.768 kHz internal RC oscillator (LFRC)
20+
* 32.768 kHz crystal oscillator (LFXO)
2021

2122
When MPSL is enabled, the application must provide the selected LFCLK source, calibration configurations, and clock accuracy.
2223
The selected accuracy is meant to be forwarded only to the protocol stacks.
@@ -35,7 +36,7 @@ As the MPSL clock module runs the calibration automatically, the application mus
3536
It is recommended to use a temperature polling interval of 4 seconds, and to force the clock calibration every second interval (``.rc_ctiv=16``, ``.rc_temp_ctiv=2``).
3637

3738
High-frequency clock (HFCLK)
38-
----------------------------
39+
****************************
3940

4041
The high-frequency clock (HFCLK) controller supports the following HFCLK sources:
4142

mpsl/doc/fem.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ Implementation
2020

2121
Two FEM implementations are provided:
2222

23-
* *nRF21540 GPIO*.
24-
It is compatible with the nRF21540 FEM and implements a 3-pin interface.
25-
* *Simple GPIO*.
26-
It is a simplified version, made to be compatible with other front-end modules.
27-
It implements a 2-pin interface.
23+
* nRF21540 GPIO.
24+
It is compatible with the nRF21540 FEM and implements a 3-pin interface.
25+
26+
* Simple GPIO.
27+
It is a simplified version, made to be compatible with other front-end modules.
28+
It implements a 2-pin interface.
2829

2930
Both implementations use PA and LNA pins for controlling the FEM.
3031
Additionally, the nRF21540 GPIO implementation uses the PDN pin for powering down the FEM internal circuits, to reduce energy consumption.

mpsl/doc/mpsl.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The descriptions are valid for both RTOS and RTOS-free environments.
1313
For the nRF53 Series, the requirements described are only relevant for applications running alongside the MPSL on the network processor.
1414

1515
The following peripherals are owned by MPSL and must not be accessed directly by the application:
16+
1617
* ``RTC0``
1718
* ``TIMER0``
1819
* ``TIMER1`` (for the nRF53 Series)

0 commit comments

Comments
 (0)