Skip to content

Commit

Permalink
docs: netlink: document the sub-type attribute property
Browse files Browse the repository at this point in the history
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>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
  • Loading branch information
Donald Hunter authored and Jakub Kicinski committed Mar 29, 2023
1 parent 88e2889 commit 04eac39
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Documentation/userspace-api/netlink/genetlink-legacy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,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
----------------

Expand Down
10 changes: 10 additions & 0 deletions Documentation/userspace-api/netlink/specs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,16 @@ 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
~~~~~~~~

Legacy families have special ways of expressing arrays. ``sub-type`` can be
used to define the type of array members in case array members are not
fully defined as attributes (in a bona fide attribute space). For instance
a C array of u32 values can be specified with ``type: binary`` and
``sub-type: u32``. Binary types and legacy array formats are described in
more detail in :doc:`genetlink-legacy`.

operations
----------

Expand Down

0 comments on commit 04eac39

Please sign in to comment.