diff options
author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-05-01 17:44:51 +0300 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2020-05-01 22:24:42 +0300 |
commit | acfcf23597d62700f1c8e1975bca34070e0251ef (patch) | |
tree | 003f01f764df7eab995e35cf148fa824b9294fd8 /Documentation/networking/device_drivers | |
parent | f10727d3b68c8e03111436de94c922ffe304e21e (diff) | |
download | linux-acfcf23597d62700f1c8e1975bca34070e0251ef.tar.xz |
docs: networking: device drivers: convert qualcomm/rmnet.txt to ReST
- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/device_drivers')
-rw-r--r-- | Documentation/networking/device_drivers/index.rst | 1 | ||||
-rw-r--r-- | Documentation/networking/device_drivers/qualcomm/rmnet.rst (renamed from Documentation/networking/device_drivers/qualcomm/rmnet.txt) | 43 |
2 files changed, 29 insertions, 15 deletions
diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst index 55837244eaad..66ed884548cc 100644 --- a/Documentation/networking/device_drivers/index.rst +++ b/Documentation/networking/device_drivers/index.rst @@ -44,6 +44,7 @@ Contents: microsoft/netvsc neterion/s2io neterion/vxge + qualcomm/rmnet .. only:: subproject and html diff --git a/Documentation/networking/device_drivers/qualcomm/rmnet.txt b/Documentation/networking/device_drivers/qualcomm/rmnet.rst index 6b341eaf2062..70643b58de05 100644 --- a/Documentation/networking/device_drivers/qualcomm/rmnet.txt +++ b/Documentation/networking/device_drivers/qualcomm/rmnet.rst @@ -1,4 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============ +Rmnet Driver +============ + 1. Introduction +=============== rmnet driver is used for supporting the Multiplexing and aggregation Protocol (MAP). This protocol is used by all recent chipsets using Qualcomm @@ -18,17 +25,18 @@ sending aggregated bunch of MAP frames. rmnet driver will de-aggregate these MAP frames and send them to appropriate PDN's. 2. Packet format +================ a. MAP packet (data / control) MAP header has the same endianness of the IP packet. -Packet format - +Packet format:: -Bit 0 1 2-7 8 - 15 16 - 31 -Function Command / Data Reserved Pad Multiplexer ID Payload length -Bit 32 - x -Function Raw Bytes + Bit 0 1 2-7 8 - 15 16 - 31 + Function Command / Data Reserved Pad Multiplexer ID Payload length + Bit 32 - x + Function Raw Bytes Command (1)/ Data (0) bit value is to indicate if the packet is a MAP command or data packet. Control packet is used for transport level flow control. Data @@ -44,24 +52,27 @@ Multiplexer ID is to indicate the PDN on which data has to be sent. Payload length includes the padding length but does not include MAP header length. -b. MAP packet (command specific) +b. MAP packet (command specific):: -Bit 0 1 2-7 8 - 15 16 - 31 -Function Command Reserved Pad Multiplexer ID Payload length -Bit 32 - 39 40 - 45 46 - 47 48 - 63 -Function Command name Reserved Command Type Reserved -Bit 64 - 95 -Function Transaction ID -Bit 96 - 127 -Function Command data + Bit 0 1 2-7 8 - 15 16 - 31 + Function Command Reserved Pad Multiplexer ID Payload length + Bit 32 - 39 40 - 45 46 - 47 48 - 63 + Function Command name Reserved Command Type Reserved + Bit 64 - 95 + Function Transaction ID + Bit 96 - 127 + Function Command data Command 1 indicates disabling flow while 2 is enabling flow -Command types - +Command types + += ========================================== 0 for MAP command request 1 is to acknowledge the receipt of a command 2 is for unsupported commands 3 is for error during processing of commands += ========================================== c. Aggregation @@ -71,9 +82,11 @@ packets and either ACK the MAP command or deliver the IP packet to the network stack as needed MAP header|IP Packet|Optional padding|MAP header|IP Packet|Optional padding.... + MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad... 3. Userspace configuration +========================== rmnet userspace configuration is done through netlink library librmnetctl and command line utility rmnetcli. Utility is hosted in codeaurora forum git. |