Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ============
   4 Rmnet Driver
   5 ============
   6
   7 1. Introduction
   8 ===============
   9
  10 rmnet driver is used for supporting the Multiplexing and aggregation
  11 Protocol (MAP). This protocol is used by all recent chipsets using Qualcomm
  12 Technologies, Inc. modems.
  13
  14 This driver can be used to register onto any physical network device in
  15 IP mode. Physical transports include USB, HSIC, PCIe and IP accelerator.
  16
  17 Multiplexing allows for creation of logical netdevices (rmnet devices) to
  18 handle multiple private data networks (PDN) like a default internet, tethering,
  19 multimedia messaging service (MMS) or IP media subsystem (IMS). Hardware sends
  20 packets with MAP headers to rmnet. Based on the multiplexer id, rmnet
  21 routes to the appropriate PDN after removing the MAP header.
  22
  23 Aggregation is required to achieve high data rates. This involves hardware
  24 sending aggregated bunch of MAP frames. rmnet driver will de-aggregate
  25 these MAP frames and send them to appropriate PDN's.
  26
  27 2. Packet format
  28 ================
  29
  30 a. MAP packet (data / control)
  31
  32 MAP header has the same endianness of the IP packet.
  33
  34 Packet format::
  35
  36   Bit             0             1           2-7      8 - 15           16 - 31
  37   Function   Command / Data   Reserved     Pad   Multiplexer ID    Payload length
  38   Bit            32 - x
  39   Function     Raw  Bytes
  40
  41 Command (1)/ Data (0) bit value is to indicate if the packet is a MAP command
  42 or data packet. Control packet is used for transport level flow control. Data
  43 packets are standard IP packets.
  44
  45 Reserved bits are usually zeroed out and to be ignored by receiver.
  46
  47 Padding is number of bytes to be added for 4 byte alignment if required by
  48 hardware.
  49
  50 Multiplexer ID is to indicate the PDN on which data has to be sent.
  51
  52 Payload length includes the padding length but does not include MAP header
  53 length.
  54
  55 b. MAP packet (command specific)::
  56
  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
  65
  66 Command 1 indicates disabling flow while 2 is enabling flow
  67
  68 Command types
  69
  70 = ==========================================
  71 0 for MAP command request
  72 1 is to acknowledge the receipt of a command
  73 2 is for unsupported commands
  74 3 is for error during processing of commands
  75 = ==========================================
  76
  77 c. Aggregation
  78
  79 Aggregation is multiple MAP packets (can be data or command) delivered to
  80 rmnet in a single linear skb. rmnet will process the individual
  81 packets and either ACK the MAP command or deliver the IP packet to the
  82 network stack as needed
  83
  84 MAP header|IP Packet|Optional padding|MAP header|IP Packet|Optional padding....
  85
  86 MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad...
  87
  88 3. Userspace configuration
  89 ==========================
  90
  91 rmnet userspace configuration is done through netlink library librmnetctl
  92 and command line utility rmnetcli. Utility is hosted in codeaurora forum git.
  93 The driver uses rtnl_link_ops for communication.
  94
  95 https://source.codeaurora.org/quic/la/platform/vendor/qcom-opensource/dataservices/tree/rmnetctl