From: Donald Hunter <donald.hunter@gmail•com>
To: netdev@vger•kernel.org, Jakub Kicinski <kuba@kernel•org>,
"David S. Miller" <davem@davemloft•net>,
Eric Dumazet <edumazet@google•com>,
Paolo Abeni <pabeni@redhat•com>, Jonathan Corbet <corbet@lwn•net>,
linux-doc@vger•kernel.org
Cc: donald.hunter@redhat•com, Donald Hunter <donald.hunter@gmail•com>
Subject: [PATCH net-next v4 7/7] docs: netlink: document the sub-type attribute property
Date: Fri, 24 Mar 2023 19:19:00 +0000 [thread overview]
Message-ID: <20230324191900.21828-8-donald.hunter@gmail.com> (raw)
In-Reply-To: <20230324191900.21828-1-donald.hunter@gmail.com>
Add a definition for sub-type to the protocol spec doc and a description of
its usage for C arrays in genetlink-legacy.
Signed-off-by: Donald Hunter <donald.hunter@gmail•com>
---
.../userspace-api/netlink/genetlink-legacy.rst | 14 ++++++++++++++
Documentation/userspace-api/netlink/specs.rst | 9 +++++++++
2 files changed, 23 insertions(+)
diff --git a/Documentation/userspace-api/netlink/genetlink-legacy.rst b/Documentation/userspace-api/netlink/genetlink-legacy.rst
index 6b385a9e6d0b..afd9c4947a1c 100644
--- a/Documentation/userspace-api/netlink/genetlink-legacy.rst
+++ b/Documentation/userspace-api/netlink/genetlink-legacy.rst
@@ -216,6 +216,20 @@ specify a sub-type.
type: binary
struct: vport-stats
+C Arrays
+--------
+
+Legacy families also use ``binary`` attributes to encapsulate C arrays. The
+``sub-type`` is used to identify the type of scalar to extract.
+
+.. code-block:: yaml
+
+ attributes:
+ -
+ name: ports
+ type: binary
+ sub-type: u32
+
Multi-message DO
----------------
diff --git a/Documentation/userspace-api/netlink/specs.rst b/Documentation/userspace-api/netlink/specs.rst
index a22442ba1d30..7931322d3238 100644
--- a/Documentation/userspace-api/netlink/specs.rst
+++ b/Documentation/userspace-api/netlink/specs.rst
@@ -254,6 +254,15 @@ rather than depend on what is specified in the spec file.
The validation policy in the kernel is formed by combining the type
definition (``type`` and ``nested-attributes``) and the ``checks``.
+sub-type
+~~~~~~~~
+
+Attributes can have a ``sub-type`` that is interpreted in a ``type``
+specific way. For example, an attribute with ``type: binary`` can have
+``sub-type: u32`` which says to interpret the binary blob as an array of
+``u32``. Binary types are described in more detail in
+:doc:`genetlink-legacy`.
+
operations
----------
--
2.39.0
next prev parent reply other threads:[~2023-03-24 19:19 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-24 19:18 [PATCH net-next v4 0/7] ynl: add support for user headers and struct attrs Donald Hunter
2023-03-24 19:18 ` [PATCH net-next v4 1/7] tools: ynl: Add struct parsing to nlspec Donald Hunter
2023-03-25 3:36 ` Jakub Kicinski
2023-03-24 19:18 ` [PATCH net-next v4 2/7] tools: ynl: Add C array attribute decoding to ynl Donald Hunter
2023-03-25 3:38 ` Jakub Kicinski
2023-03-27 7:57 ` Donald Hunter
2023-03-24 19:18 ` [PATCH net-next v4 3/7] tools: ynl: Add struct attr " Donald Hunter
2023-03-25 3:42 ` Jakub Kicinski
2023-03-24 19:18 ` [PATCH net-next v4 4/7] tools: ynl: Add fixed-header support " Donald Hunter
2023-03-25 3:47 ` Jakub Kicinski
2023-03-27 8:10 ` Donald Hunter
2023-03-24 19:18 ` [PATCH net-next v4 5/7] netlink: specs: add partial specification for openvswitch Donald Hunter
2023-03-24 19:18 ` [PATCH net-next v4 6/7] docs: netlink: document struct support for genetlink-legacy Donald Hunter
2023-03-25 3:52 ` Jakub Kicinski
2023-03-27 8:12 ` Donald Hunter
2023-03-24 19:19 ` Donald Hunter [this message]
2023-03-25 3:57 ` [PATCH net-next v4 7/7] docs: netlink: document the sub-type attribute property Jakub Kicinski
2023-03-27 8:13 ` Donald Hunter
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=20230324191900.21828-8-donald.hunter@gmail.com \
--to=donald.hunter@gmail$(echo .)com \
--cc=corbet@lwn$(echo .)net \
--cc=davem@davemloft$(echo .)net \
--cc=donald.hunter@redhat$(echo .)com \
--cc=edumazet@google$(echo .)com \
--cc=kuba@kernel$(echo .)org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=netdev@vger$(echo .)kernel.org \
--cc=pabeni@redhat$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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