Lines Matching +full:nested +full:- +full:attributes
1 .. SPDX-License-Identifier: BSD-3-Clause
17 - the C uAPI header
18 - documentation of the protocol as a ReST file
19 - policy tables for input attribute validation
20 - operation tables
25 See :doc:`intro-specs` for a practical starting guide.
28 ``((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)``
36 Each next level inherits the attributes of the previous level, meaning that
40 - ``genetlink`` - most streamlined, should be used by all new families
41 - ``genetlink-c`` - superset of ``genetlink`` with extra attributes allowing
45 - ``genetlink-legacy`` - Generic Netlink catch all schema supporting quirks of
47 - ``netlink-raw`` - catch all schema supporting pre-Generic Netlink protocols
58 - globals
59 - definitions
60 - attributes
61 - operations
62 - multicast groups
65 sub-property documenting the defined object.
68 schema. See the documentation of :doc:`genetlink-c <c-code-gen>`
71 See also :ref:`Documentation/core-api/netlink.rst <kernel_netlink>` for
79 -------
81 Attributes listed directly at the root level of the spec file.
101 -----------
115 - const - a single, standalone constant
116 - enum - defines an integer enumeration, with values for each entry
118 - flags - defines an integer enumeration, with values for each entry
126 value-start
131 For ``flags`` ``value-start`` selects the starting bit, not the shifted value.
143 For C-compatible languages, header which already defines this value.
145 code generators for C-compatible languages may prefer to add an appropriate
148 attribute-sets
149 --------------
151 This property contains information about netlink attributes of the family.
153 ``attribute-sets`` is an array, with each entry describing a single set.
156 the format of the netlink messages (unlike certain ad-hoc documentation
159 referred to with a ``nested-attributes`` property of the container.
161 Spec may also contain fractional sets - sets which contain a ``subset-of``
163 which attributes are allowed in a nest or refining the validation criteria.
170 Uniquely identifies the attribute set, operations and nested attributes
173 subset-of
176 Re-defines a portion of another set (a fractional set).
178 or even types of attributes depending on the nest in which they
182 attributes subsection
185 List of attributes in the set.
190 --------------------
212 Attributes (and operations) use ``1`` as the default value for the first
226 enum-as-flags
231 contain an ``enum`` and attributes which need the ``flags`` form should
234 nested-attributes subsection
237 Identifies the attribute space for attributes nested within given attribute.
238 Only valid for complex attributes which may have sub-attributes.
240 multi-attr (arrays)
247 byte-order
250 For integer types specifies attribute byte order - ``little-endian``
251 or ``big-endian``.
261 definition (``type`` and ``nested-attributes``) and the ``checks``.
263 sub-type
266 Legacy families have special ways of expressing arrays. ``sub-type`` can be
268 fully defined as attributes (in a bona fide attribute space). For instance
270 ``sub-type: u32``. Binary types and legacy array formats are described in
271 more detail in :doc:`genetlink-legacy`.
273 display-hint
281 ----------
284 There are three types of entries in this section - operations, notifications
287 Operations describe the most common request - response communication. User
289 of the two modes familiar to netlink users - ``do`` and ``dump``.
291 ``response`` properties. If no explicit message with attributes is passed
295 ``request`` and ``response`` sections list the attributes allowed in a message.
296 The list contains only the names of attributes from a set referred
297 to by the ``attribute-set`` property.
319 --------------------
333 attribute-set
360 Specification of attributes in the event, holds a :ref:`attr_list`.
372 ----------------------
374 ``request``, ``reply`` and ``event`` properties have a single ``attributes``
381 mcast-groups
382 ------------
389 The only property of ``mcast-groups`` for ``genetlink``, holds the list
393 --------------------------
412 --------------------
414 Fixed-width integer types:
419 See :ref:`pad_type` for padding of 64 bit attributes.
421 The payload of the attribute is the integer in host order unless ``byte-order``
427 ---
429 Special attribute type used for padding attributes which require alignment
435 ----
440 ------
445 ------
447 Character string. Unless ``checks`` has ``unterminated-ok`` set to ``true``
449 ``max-len`` in ``checks`` indicates the longest possible string,
452 Note that ``max-len`` does not count the terminating character.
455 ----
457 Attribute containing other (nested) attributes.
458 ``nested-attributes`` specifies which attribute set is used inside.