netdev - [PATCH v2] can: j1939: convert PGN structure to a table

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20201022132534.22888-1-yegorslists@googlemail.com>
Date:   Thu, 22 Oct 2020 15:25:34 +0200
From:   yegorslists@...glemail.com
To:     linux-can@...r.kernel.org
Cc:     mkl@...gutronix.de, netdev@...r.kernel.org,
        dev.kurt@...dijck-laurijssen.be,
        Yegor Yefremov <yegorslists@...glemail.com>
Subject: [PATCH v2] can: j1939: convert PGN structure to a table

From: Yegor Yefremov <yegorslists@...glemail.com>

Use table markup to show the PGN structure.

Signed-off-by: Yegor Yefremov <yegorslists@...glemail.com>
---
Changes v1 -> v2:
  - add descrption for the bit position

 Documentation/networking/j1939.rst | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/networking/j1939.rst b/Documentation/networking/j1939.rst
index faf2eb5c5052..bd1584ec90f9 100644
--- a/Documentation/networking/j1939.rst
+++ b/Documentation/networking/j1939.rst
@@ -71,10 +71,14 @@ PGN
 
 The PGN (Parameter Group Number) is a number to identify a packet. The PGN
 is composed as follows:
-1 bit  : Reserved Bit
-1 bit  : Data Page
-8 bits : PF (PDU Format)
-8 bits : PS (PDU Specific)
+
+  ============  ==============  ===============  =================
+  Bit position of PGN fields in the 29-bit CAN identifier
+  ----------------------------------------------------------------
+  25            24              23 ... 16        15 ... 8
+  ============  ==============  ===============  =================
+  R (Reserved)  DP (Data Page)  PF (PDU Format)  PS (PDU Specific)
+  ============  ==============  ===============  =================
 
 In J1939-21 distinction is made between PDU1 format (where PF < 240) and PDU2
 format (where PF >= 240). Furthermore, when using the PDU2 format, the PS-field
-- 
2.17.0