Commit acfcf235 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent f10727d3
...@@ -44,6 +44,7 @@ Contents: ...@@ -44,6 +44,7 @@ Contents:
microsoft/netvsc microsoft/netvsc
neterion/s2io neterion/s2io
neterion/vxge neterion/vxge
qualcomm/rmnet
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0
============
Rmnet Driver
============
1. Introduction 1. Introduction
===============
rmnet driver is used for supporting the Multiplexing and aggregation rmnet driver is used for supporting the Multiplexing and aggregation
Protocol (MAP). This protocol is used by all recent chipsets using Qualcomm 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 ...@@ -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. these MAP frames and send them to appropriate PDN's.
2. Packet format 2. Packet format
================
a. MAP packet (data / control) a. MAP packet (data / control)
MAP header has the same endianness of the IP packet. MAP header has the same endianness of the IP packet.
Packet format - Packet format::
Bit 0 1 2-7 8 - 15 16 - 31 Bit 0 1 2-7 8 - 15 16 - 31
Function Command / Data Reserved Pad Multiplexer ID Payload length Function Command / Data Reserved Pad Multiplexer ID Payload length
Bit 32 - x Bit 32 - x
Function Raw Bytes Function Raw Bytes
Command (1)/ Data (0) bit value is to indicate if the packet is a MAP command 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 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. ...@@ -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 Payload length includes the padding length but does not include MAP header
length. length.
b. MAP packet (command specific) b. MAP packet (command specific)::
Bit 0 1 2-7 8 - 15 16 - 31 Bit 0 1 2-7 8 - 15 16 - 31
Function Command Reserved Pad Multiplexer ID Payload length Function Command Reserved Pad Multiplexer ID Payload length
Bit 32 - 39 40 - 45 46 - 47 48 - 63 Bit 32 - 39 40 - 45 46 - 47 48 - 63
Function Command name Reserved Command Type Reserved Function Command name Reserved Command Type Reserved
Bit 64 - 95 Bit 64 - 95
Function Transaction ID Function Transaction ID
Bit 96 - 127 Bit 96 - 127
Function Command data Function Command data
Command 1 indicates disabling flow while 2 is enabling flow Command 1 indicates disabling flow while 2 is enabling flow
Command types - Command types
= ==========================================
0 for MAP command request 0 for MAP command request
1 is to acknowledge the receipt of a command 1 is to acknowledge the receipt of a command
2 is for unsupported commands 2 is for unsupported commands
3 is for error during processing of commands 3 is for error during processing of commands
= ==========================================
c. Aggregation c. Aggregation
...@@ -71,9 +82,11 @@ packets and either ACK the MAP command or deliver the IP packet to the ...@@ -71,9 +82,11 @@ packets and either ACK the MAP command or deliver the IP packet to the
network stack as needed network stack as needed
MAP header|IP Packet|Optional padding|MAP header|IP Packet|Optional padding.... MAP header|IP Packet|Optional padding|MAP header|IP Packet|Optional padding....
MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad... MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad...
3. Userspace configuration 3. Userspace configuration
==========================
rmnet userspace configuration is done through netlink library librmnetctl rmnet userspace configuration is done through netlink library librmnetctl
and command line utility rmnetcli. Utility is hosted in codeaurora forum git. and command line utility rmnetcli. Utility is hosted in codeaurora forum git.
......
...@@ -14031,7 +14031,7 @@ M: Subash Abhinov Kasiviswanathan <subashab@codeaurora.org> ...@@ -14031,7 +14031,7 @@ M: Subash Abhinov Kasiviswanathan <subashab@codeaurora.org>
M: Sean Tranchetti <stranche@codeaurora.org> M: Sean Tranchetti <stranche@codeaurora.org>
L: netdev@vger.kernel.org L: netdev@vger.kernel.org
S: Maintained S: Maintained
F: Documentation/networking/device_drivers/qualcomm/rmnet.txt F: Documentation/networking/device_drivers/qualcomm/rmnet.rst
F: drivers/net/ethernet/qualcomm/rmnet/ F: drivers/net/ethernet/qualcomm/rmnet/
F: include/linux/if_rmnet.h F: include/linux/if_rmnet.h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment