userspace-api/netlink/c-code-gen.rst

1 .. SPDX-License-Identifier: BSD-3-Clause
9 allowed in older families by the ``genetlink-c`` protocol level,
14 of ``name`` in an attribute, and ``$family`` is the name of the
17 The upper case is used to denote literal values, e.g. ``$family-CMD``
22 and with dashes (``-``) replaced by underscores (``_``).
25 appended (``do`` -> ``do_``).
30 ``c-family-name`` controls the name of the ``#define`` for the family
31 name, default is ``$family-FAMILY-NAME``.
33 ``c-version-name`` controls the name of the ``#define`` for the version
34 of the family, default is ``$family-FAMILY-VERSION``.
36 ``max-by-define`` selects if max values for enums are defined as a
43 ---------
46 The name of the constant is ``$family-$constant`` and the value
50 ---------------
52 Enums are named ``$family-$enum``. The full name can be set directly
53 or suppressed by specifying the ``enum-name`` property.
54 Default entry name is ``$family-$enum-$entry``.
55 If ``name-prefix`` is specified it replaces the ``$family-$enum``
58 Boolean ``render-max`` controls creation of the max values
59 (which are enabled by default for attribute enums).
64 Each attribute set (excluding fractional sets) is rendered as an enum.
66 Attribute enums are traditionally unnamed in netlink headers.
67 If naming is desired ``enum-name`` can be used to specify the name.
69 The default attribute name prefix is ``$family-A`` if the name of the set
70 is the same as the name of the family and ``$family-A-$set`` if the names
71 differ. The prefix can be overridden by the ``name-prefix`` property of a set.
74 Attributes are named ``$pfx-$attribute``.
76 Attribute enums end with two special values ``__$pfx-MAX`` and ``$pfx-MAX``
77 which are used for sizing attribute tables.
78 These two names can be specified directly with the ``attr-cnt-name``
79 and ``attr-max-name`` properties respectively.
81 If ``max-by-define`` is set to ``true`` at the global level ``attr-max-name``
87 Operations are named ``$family-CMD-$operation``.
88 If ``name-prefix`` is specified it replaces the ``$family-CMD``
91 Similarly to attribute enums operation enums end with special count and max
93 ``cmd-cnt-name`` and ``cmd-max-name``. Max will be a define if ``max-by-define``
100 The name of the define is ``$family-MCGRP-$group``, and can be overwritten
101 with the ``c-define-name`` property.
107 search path. It can be changed using the ``uapi-header`` global property.