Skip to content

Commit 45f4037

Browse files
committed
applications: serial_lte_modem: Clarify CMUX MTU documentation
Add documentation regarding CONFIG_MODEM_CMUX_MTU. Signed-off-by: Seppo Takalo <[email protected]>
1 parent 3a4215b commit 45f4037

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

applications/serial_lte_modem/doc/CMUX_AT_commands.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ CMUX AT commands
99

1010
This page describes CMUX-related AT commands.
1111

12-
The CMUX protocol enables multiplexing multiple data streams through a single serial link, setting up one channel per data stream.
12+
The GSM 0710 multiplexer protocol (CMUX) enables multiplexing multiple data streams through a single serial link, setting up one channel per data stream.
1313
For example, it can be used to exchange AT data and have a :ref:`Point-to-Point Protocol (PPP) <CONFIG_SLM_PPP>` link up at the same time on a single UART.
1414

1515
.. note::
1616

1717
To use the nRF91 Series SiP as a standalone modem in Zephyr, see :ref:`slm_as_zephyr_modem`.
18+
To use the nRF91 Series SiP as a modem for a Linux device, see :ref:`slm_as_linux_modem`.
1819

1920
CMUX is enabled in SLM by compiling it with the appropriate configuration files, depending on your use case.
2021
See the :ref:`slm_config_files` section for more information.
@@ -38,7 +39,7 @@ See the :ref:`slm_config_files` section for more information.
3839

3940
* Only UIH frames are used.
4041
* The speed used is the configured baud rate of SLM's UART.
41-
* The maximum frame size is ``2100`` (defined by :c:macro:`SLM_AT_MAX_RSP_LEN` found in :file:`slm_defines.h`).
42+
* The maximum frame size is configured using the :kconfig:option:`CONFIG_MODEM_CMUX_MTU` Kconfig option.
4243

4344
CMUX setup #XCMUX
4445
=================

applications/serial_lte_modem/doc/PPP_linux.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Prerequisites
2121

2222
The Linux device needs to have the following packages installed:
2323

24-
* pppd from the ppp package
25-
* ldattach from the util-linux package
24+
* ``pppd`` from the ppp package
25+
* ``ldattach`` from the util-linux package
2626

2727
These should be available on all standard Linux distributions.
2828

@@ -35,13 +35,19 @@ You can adjust the serial port baud rate using the devicetree overlay file.
3535
By default, the baud rate is set to 115200.
3636
If you change the baud rate, set the same rate in the :file:`scripts/slm_start_ppp.sh` and :file:`scripts/slm_stop_ppp.sh` scripts.
3737

38+
.. note::
39+
The standard ``ldattach`` utility sets MRU and MTU to 127 bytes.
40+
This is hard-coded and cannot be changed.
41+
If you change the SLM configuration, make sure that the :kconfig:option:`CONFIG_MODEM_CMUX_MTU` Kconfig option is set to 127 bytes.
42+
This is already configured in the :file:`overlay-ppp-cmux-linux.conf` configuration overlay.
43+
3844
Building and running
3945
====================
4046

4147
To build and program the SLM application to the nRF91 Series device, use the :file:`overlay-ppp-cmux-linux.conf` overlay file.
4248

4349
Managing the connection
44-
=======================
50+
***********************
4551

4652
The start and stop scripts are provided in the :file:`scripts` directory of the SLM application.
4753
The scripts assume that the nRF91 Series SiP is connected to the Linux device using the `/dev/ttyACM0` serial port.

0 commit comments

Comments
 (0)