tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Mauro Carvalho Chehab
and committed by
David S. Miller
acfcf235
f10727d3
+30
-16
+1
Documentation/networking/device_drivers/index.rst
+1
Documentation/networking/device_drivers/index.rst
+28
-15
Documentation/networking/device_drivers/qualcomm/rmnet.txt
Documentation/networking/device_drivers/qualcomm/rmnet.rst
+28
-15
Documentation/networking/device_drivers/qualcomm/rmnet.txt
Documentation/networking/device_drivers/qualcomm/rmnet.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
============
4
+
Rmnet Driver
5
+
============
6
+
1
7
1. Introduction
8
+
===============
2
9
3
10
rmnet driver is used for supporting the Multiplexing and aggregation
4
11
Protocol (MAP). This protocol is used by all recent chipsets using Qualcomm
···
25
18
these MAP frames and send them to appropriate PDN's.
26
19
27
20
2. Packet format
21
+
================
28
22
29
23
a. MAP packet (data / control)
30
24
31
25
MAP header has the same endianness of the IP packet.
32
26
33
-
Packet format -
27
+
Packet format::
34
28
35
-
Bit 0 1 2-7 8 - 15 16 - 31
36
-
Function Command / Data Reserved Pad Multiplexer ID Payload length
37
-
Bit 32 - x
38
-
Function Raw Bytes
29
+
Bit 0 1 2-7 8 - 15 16 - 31
30
+
Function Command / Data Reserved Pad Multiplexer ID Payload length
31
+
Bit 32 - x
32
+
Function Raw Bytes
39
33
40
34
Command (1)/ Data (0) bit value is to indicate if the packet is a MAP command
41
35
or data packet. Control packet is used for transport level flow control. Data
···
52
44
Payload length includes the padding length but does not include MAP header
53
45
length.
54
46
55
-
b. MAP packet (command specific)
47
+
b. MAP packet (command specific)::
56
48
57
-
Bit 0 1 2-7 8 - 15 16 - 31
58
-
Function Command Reserved Pad Multiplexer ID Payload length
59
-
Bit 32 - 39 40 - 45 46 - 47 48 - 63
60
-
Function Command name Reserved Command Type Reserved
61
-
Bit 64 - 95
62
-
Function Transaction ID
63
-
Bit 96 - 127
64
-
Function Command data
49
+
Bit 0 1 2-7 8 - 15 16 - 31
50
+
Function Command Reserved Pad Multiplexer ID Payload length
51
+
Bit 32 - 39 40 - 45 46 - 47 48 - 63
52
+
Function Command name Reserved Command Type Reserved
53
+
Bit 64 - 95
54
+
Function Transaction ID
55
+
Bit 96 - 127
56
+
Function Command data
65
57
66
58
Command 1 indicates disabling flow while 2 is enabling flow
67
59
68
-
Command types -
60
+
Command types
61
+
62
+
= ==========================================
69
63
0 for MAP command request
70
64
1 is to acknowledge the receipt of a command
71
65
2 is for unsupported commands
72
66
3 is for error during processing of commands
67
+
= ==========================================
73
68
74
69
c. Aggregation
75
70
···
82
71
network stack as needed
83
72
84
73
MAP header|IP Packet|Optional padding|MAP header|IP Packet|Optional padding....
74
+
85
75
MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad...
86
76
87
77
3. Userspace configuration
78
+
==========================
88
79
89
80
rmnet userspace configuration is done through netlink library librmnetctl
90
81
and command line utility rmnetcli. Utility is hosted in codeaurora forum git.
+1
-1
MAINTAINERS
+1
-1
MAINTAINERS
···
14031
14031
M: Sean Tranchetti <stranche@codeaurora.org>
14032
14032
L: netdev@vger.kernel.org
14033
14033
S: Maintained
14034
-
F: Documentation/networking/device_drivers/qualcomm/rmnet.txt
14034
+
F: Documentation/networking/device_drivers/qualcomm/rmnet.rst
14035
14035
F: drivers/net/ethernet/qualcomm/rmnet/
14036
14036
F: include/linux/if_rmnet.h
14037
14037