netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Simon Horman <horms@kernel.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Networking <netdev@vger.kernel.org>,
	Subash Abhinov Kasiviswanathan
	<subash.a.kasiviswanathan@oss.qualcomm.com>,
	Sean Tranchetti <sean.tranchetti@oss.qualcomm.com>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Sharath Chandra Vurukala <quic_sharathv@quicinc.com>
Subject: Re: [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting
Date: Wed, 15 Oct 2025 17:31:53 +0100	[thread overview]
Message-ID: <aO_MefPIlQQrCU3j@horms.kernel.org> (raw)
In-Reply-To: <20251015092540.32282-2-bagasdotme@gmail.com>

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


  reply	other threads:[~2025-10-15 16:31 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-15  9:25 [PATCH net] net: rmnet: Fix checksum offload header v5 and aggregation packet formatting Bagas Sanjaya
2025-10-15 16:31 ` Simon Horman [this message]
2025-10-15 23:57   ` Bagas Sanjaya
2025-10-16  8:12     ` Simon Horman
2025-10-16  9:01       ` Bagas Sanjaya
2025-10-16 22:51 ` Jakub Kicinski
2025-10-16 23:00 ` patchwork-bot+netdevbpf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aO_MefPIlQQrCU3j@horms.kernel.org \
    --to=horms@kernel.org \
    --cc=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=quic_sharathv@quicinc.com \
    --cc=sean.tranchetti@oss.qualcomm.com \
    --cc=subash.a.kasiviswanathan@oss.qualcomm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).