Skip to content

Commit 38efc3e

Browse files
committed
doc: a few doc edits
please squash Signed-off-by: Bartosz Gentkowski <[email protected]>
1 parent 0595356 commit 38efc3e

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

doc/nrf-bm/drivers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Only nrfx drivers and the drivers located under :file:`nrf-bm/drivers` are in th
1010
All other drivers that are included in the distribution must be ignored when working with the |BMshort| option.
1111

1212
.. toctree::
13-
:maxdepth: 2
13+
:maxdepth: 1
1414
:glob:
1515
:caption: Subpages:
1616

17-
drivers/lpuarte.rst
17+
drivers/*

doc/nrf-bm/drivers/lpuarte.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _lpuarte:
1+
.. _driver_lpuarte:
22

33
Low Power UART with EasyDMA (LPUARTE)
44
#####################################
@@ -22,6 +22,9 @@ It is configured as an output and set to low.
2222

2323
The RDY line is configured as input without pull-up and the interrupt is configured to detect the transition from low to high state.
2424

25+
Implementation
26+
**************
27+
2528
The driver implements the control protocol in the following way:
2629

2730
#. The transmitter initiates the transmission by calling :c:func:`bm_lpuarte_tx`.
@@ -46,4 +49,7 @@ This requirement can be fulfilled in two ways:
4649
The latency of the event handling must be taken into account in that case.
4750
For example, a flash page erase on some devices might have a significant impact.
4851

49-
See :ref:`bm_lpuarte_sample` sample for the implementation of this driver.
52+
Sample usage
53+
************
54+
55+
See the :ref:`bm_lpuarte_sample` sample for the implementation of this driver.

doc/nrf-bm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ The |BMlong| is a distinct repository that incorporates elements from the existi
3535
:caption: Contents
3636

3737
install_nrf_bm.rst
38+
drivers.rst
3839
libraries/index.rst
3940
samples.rst
4041
ug_dfu.rst

samples/bluetooth/ble_nus/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ This sample can be found under :file:`samples/bluetooth/ble_nus/` in the |BMshor
6363
Building and running with LPUARTE
6464
*********************************
6565

66-
The :file:`overlay-lpuarte.conf` file configures the sample to use the :ref:`lpuarte` driver for the NUS Service.
67-
This is useful to reduce power consumption.
66+
The :file:`overlay-lpuarte.conf` file configures the sample to use the :ref:`LPUARTE <driver_lpuarte>` driver for the NUS Service.
67+
This is useful for reducing the power consumption.
6868
The overlay must be added to the build configuration is VS Code or as an extra argument to west: ``-DEXTRA_CONF_FILE="overlay-lpuarte.conf"``.
6969

70-
To test the NUS sample with the :ref:`lpuarte` driver in loopback mode, connect pin ``P1.08`` (REQ) with ``P1.09`` (RDY) and ``P1.10`` (RX) with ``P1.11`` (TX) on the nRF54L15DK as given in the ``board-config.h``.
70+
To test the NUS sample with the :ref:`LPUARTE <driver_lpuarte>` driver in loopback mode, connect pin ``P1.08`` (REQ) with ``P1.09`` (RDY) and ``P1.10`` (RX) with ``P1.11`` (TX) on the nRF54L15DK, as given in the :file:`board-config.h`.
7171
It is also possible to test between two devices running NUS with LPUART by connecting the above mentioned pins and ``GND`` between the devices.
72-
Make sure the ``REQ`` pin on one bord is connected to the ``RDY`` on the other board, and vice versa.
72+
Make sure the ``REQ`` pin on one board is connected to the ``RDY`` on the other board, and vice versa.
7373

7474
Testing
7575
=======

0 commit comments

Comments
 (0)