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

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

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -44,6 +44,7 @@ Contents: 
   microsoft/netvsc

   neterion/s2io

   neterion/vxge

   qualcomm/rmnet



.. only::  subproject and html

Documentation/networking/device_drivers/qualcomm/rmnet.txt→Documentation/networking/device_drivers/qualcomm/rmnet.rst

+28 −15
Original line number Diff line number Diff line 
.. 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,12 +25,13 @@ 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
@@ -44,7 +52,7 @@ 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
@@ -57,11 +65,14 @@ 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.

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -14031,7 +14031,7 @@ M: Subash Abhinov Kasiviswanathan <subashab@codeaurora.org> 
M:	Sean Tranchetti <stranche@codeaurora.org>

L:	netdev@vger.kernel.org

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:	include/linux/if_rmnet.h