[PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Bagas Sanjaya]

Packet format for checksum offload header v5 and aggregation, and header
type table for the former, are shown in normal paragraphs instead.

Use appropriate markup.

Fixes: 710b797cf61b ("docs: networking: Add documentation for MAPv5")
Fixes: ceed73a2cf4a ("drivers: net: ethernet: qualcomm: rmnet: Initial implementation")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../device_drivers/cellular/qualcomm/rmnet.rst       | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
index 289c146a829153..6877a326058206 100644
--- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
+++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
@@ -137,16 +137,20 @@ d. Checksum offload header v5
 
 Checksum offload header fields are in big endian format.
 
+Packet format::
+
   Bit            0 - 6          7               8-15              16-31
   Function     Header Type    Next Header     Checksum Valid    Reserved
 
 Header Type is to indicate the type of header, this usually is set to CHECKSUM
 
 Header types
-= ==========================================
+
+= ===============
 0 Reserved
 1 Reserved
 2 checksum header
+= ===============
 
 Checksum Valid is to indicate whether the header checksum is valid. Value of 1
 implies that checksum is calculated on this packet and is valid, value of 0
@@ -183,9 +187,11 @@ rmnet in a single linear skb. rmnet will process the individual
 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....
+Packet format::
 
-MAP header|IP Packet|Optional padding|MAP header|Command Packet|Optional pad...
+  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
 ==========================

base-commit: 7f0fddd817ba6daebea1445ae9fab4b6d2294fa8
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Simon Horman]

On Wed, Oct 15, 2025 at 04:25:41PM +0700, Bagas Sanjaya wrote:
> Packet format for checksum offload header v5 and aggregation, and header
> type table for the former, are shown in normal paragraphs instead.
> 
> Use appropriate markup.
> 
> Fixes: 710b797cf61b ("docs: networking: Add documentation for MAPv5")
> Fixes: ceed73a2cf4a ("drivers: net: ethernet: qualcomm: rmnet: Initial implementation")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks Bagas,

I agree these are all good improvements.

I would like to add the following, which I noticed during review, for your
consideration.

diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
index 6877a3260582..b532128ee709 100644
--- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
+++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
@@ -27,7 +27,8 @@ these MAP frames and send them to appropriate PDN's.
 2. Packet format
 ================

-a. MAP packet v1 (data / control)
+A. MAP packet v1 (data / control)
+---------------------------------

 MAP header fields are in big endian format.

@@ -53,7 +54,8 @@ 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 v4 (data / control)
+B. Map packet v4 (data / control)
+---------------------------------

 MAP header fields are in big endian format.

@@ -80,7 +82,7 @@ Payload length includes the padding length but does not include MAP header
 length.

 Checksum offload header, has the information about the checksum processing done
-by the hardware.Checksum offload header fields are in big endian format.
+by the hardware. Checksum offload header fields are in big endian format.

 Packet format::

@@ -106,7 +108,8 @@ over which checksum is computed.

 Checksum value, indicates the checksum computed.

-c. MAP packet v5 (data / control)
+C. MAP packet v5 (data / control)
+---------------------------------

 MAP header fields are in big endian format.

@@ -133,7 +136,8 @@ 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.

-d. Checksum offload header v5
+D. Checksum offload header v5
+-----------------------------

 Checksum offload header fields are in big endian format.

@@ -158,7 +162,10 @@ indicates that the calculated packet checksum is invalid.

 Reserved bits must be zero when sent and ignored when received.

-e. MAP packet v1/v5 (command specific)::
+E. MAP packet v1/v5 (command specific)
+--------------------------------------
+
+Packet format::

     Bit             0             1         2-7      8 - 15           16 - 31
     Function   Command         Reserved     Pad   Multiplexer ID    Payload length
@@ -169,7 +176,7 @@ e. MAP packet v1/v5 (command specific)::
     Bit          96 - 127
     Function   Command data

-Command 1 indicates disabling flow while 2 is enabling flow
+Command 1 indicates disabling flow while 2 enables flow.

 Command types

@@ -180,7 +187,8 @@ Command types
 3 is for error during processing of commands
 = ==========================================

-f. Aggregation
+F. Aggregation
+--------------

 Aggregation is multiple MAP packets (can be data or command) delivered to
 rmnet in a single linear skb. rmnet will process the individual

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 3423 bytes --]

On Wed, Oct 15, 2025 at 05:31:53PM +0100, Simon Horman wrote:
> I would like to add the following, which I noticed during review, for your
> consideration.
> 
> diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> index 6877a3260582..b532128ee709 100644
> --- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> +++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> @@ -27,7 +27,8 @@ these MAP frames and send them to appropriate PDN's.
>  2. Packet format
>  ================
> 
> -a. MAP packet v1 (data / control)
> +A. MAP packet v1 (data / control)
> +---------------------------------
> 
>  MAP header fields are in big endian format.
> 
> @@ -53,7 +54,8 @@ 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 v4 (data / control)
> +B. Map packet v4 (data / control)
> +---------------------------------
> 
>  MAP header fields are in big endian format.
> 
> @@ -80,7 +82,7 @@ Payload length includes the padding length but does not include MAP header
>  length.
> 
>  Checksum offload header, has the information about the checksum processing done
> -by the hardware.Checksum offload header fields are in big endian format.
> +by the hardware. Checksum offload header fields are in big endian format.
> 
>  Packet format::
> 
> @@ -106,7 +108,8 @@ over which checksum is computed.
> 
>  Checksum value, indicates the checksum computed.
> 
> -c. MAP packet v5 (data / control)
> +C. MAP packet v5 (data / control)
> +---------------------------------
> 
>  MAP header fields are in big endian format.
> 
> @@ -133,7 +136,8 @@ 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.
> 
> -d. Checksum offload header v5
> +D. Checksum offload header v5
> +-----------------------------
> 
>  Checksum offload header fields are in big endian format.
> 
> @@ -158,7 +162,10 @@ indicates that the calculated packet checksum is invalid.
> 
>  Reserved bits must be zero when sent and ignored when received.
> 
> -e. MAP packet v1/v5 (command specific)::
> +E. MAP packet v1/v5 (command specific)
> +--------------------------------------
> +
> +Packet format::
> 
>      Bit             0             1         2-7      8 - 15           16 - 31
>      Function   Command         Reserved     Pad   Multiplexer ID    Payload length
> @@ -169,7 +176,7 @@ e. MAP packet v1/v5 (command specific)::
>      Bit          96 - 127
>      Function   Command data
> 
> -Command 1 indicates disabling flow while 2 is enabling flow
> +Command 1 indicates disabling flow while 2 enables flow.
> 
>  Command types
> 
> @@ -180,7 +187,8 @@ Command types
>  3 is for error during processing of commands
>  = ==========================================
> 
> -f. Aggregation
> +F. Aggregation
> +--------------
> 
>  Aggregation is multiple MAP packets (can be data or command) delivered to
>  rmnet in a single linear skb. rmnet will process the individual
> 

I think that can go on separate net-next patch.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Simon Horman]

On Thu, Oct 16, 2025 at 06:57:59AM +0700, Bagas Sanjaya wrote:

...

> I think that can go on separate net-next patch.

Yes, sure.

Would you like to send that patch or should I?

In any case, the current patch looks good time.

Reviewed-by: Simon Horman <horms@kernel.org>

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 364 bytes --]

On Thu, Oct 16, 2025 at 09:12:09AM +0100, Simon Horman wrote:
> On Thu, Oct 16, 2025 at 06:57:59AM +0700, Bagas Sanjaya wrote:
> 
> ...
> 
> > I think that can go on separate net-next patch.
> 
> Yes, sure.
> 
> Would you like to send that patch or should I?

I'll do it myself.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[Jakub Kicinski]

On Wed, 15 Oct 2025 16:25:41 +0700 Bagas Sanjaya wrote:
> Fixes: 710b797cf61b ("docs: networking: Add documentation for MAPv5")
> Fixes: ceed73a2cf4a ("drivers: net: ethernet: qualcomm: rmnet: Initial implementation")

Please don't add Fixes tags to markup improvements.
The patch is probably fine for net but there's no need for the extra
tags.

Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 15 Oct 2025 16:25:41 +0700 you wrote:
> Packet format for checksum offload header v5 and aggregation, and header
> type table for the former, are shown in normal paragraphs instead.
> 
> Use appropriate markup.
> 
> Fixes: 710b797cf61b ("docs: networking: Add documentation for MAPv5")
> Fixes: ceed73a2cf4a ("drivers: net: ethernet: qualcomm: rmnet: Initial implementation")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> [...]

Here is the summary with links:
  - [net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting
    https://git.kernel.org/netdev/net/c/1b0124ad5039

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html