Documentation/netlink/genetlink.yaml

1 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
3 ---
4 $id: http://kernel.org/schemas/netlink/genetlink-legacy.yaml#
5 $schema: https://json-schema.org/draft-07/schema
12   len-or-define:
14     pattern: ^[0-9A-Za-z_]+( - 1)?$
21 required: [ name, doc, attribute-sets, operations ]
35     enum: [ genetlink ]
36   uapi-header:
37     description: Path to the uAPI header, default is linux/${family-name}.h
41     description: List of type and constant definitions (enums, flags, defines).
51           description: For C-compatible languages, header which already defines this value.
54           enum: [ const, enum, flags ]
59           description: For const - the value.
61         # For enum and flags
62         value-start:
63           description: For enum or flags the literal initializer for the first value.
66           description: For enum or flags array of values.
70               - type: string
71               - type: object
81         render-max:
82           description: Render the max members for this enum.
85   attribute-sets:
98         name-prefix:
100             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
102         enum-name:
103           description: Name for the enum type of the attribute.
108         subset-of:
110             Name of another space which this is a logical part of. Sub-spaces can be used to define
123               type: &attr-type
124                 enum: [ unused, pad, flag, binary, u8, u16, u32, u64, s32, s64,
125                         string, nest, array-nest, nest-type-value ]
130                 description: Value for the enum item representing this attribute in the uAPI.
132               type-value:
133 …             description: Name of the value extracted from the type of a nest-type-value attribute.
137               byte-order:
138                 enum: [ little-endian, big-endian ]
139               multi-attr:
141               nested-attributes:
142                 description: Name of the space (sub-space) used inside the attribute.
144               enum:
145                 description: Name of the enum type used for the attribute.
147               enum-as-flags:
149                   Treat the enum as flags. In most cases enum is either used as flags or as values.
150 …               Sometimes, however, both forms are necessary, in which case header contains the enum
158                   flags-mask:
159 …        description: Name of the flags constant on which to base mask (unsigned scalar types only).
164                   min-len:
166                     $ref: '#/$defs/len-or-define'
167                   max-len:
169                     $ref: '#/$defs/len-or-define'
170               sub-type: *attr-type
171               display-hint: &display-hint
176                 enum: [ hex, mac, fddi, ipv4, ipv6, uuid ]
178       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
180         name-prefix:
182             required: [ subset-of ]
183         subset-of:
185             required: [ name-prefix ]
193       enum-model:
197           to a single enum.
200         enum: [ unified ]
201       name-prefix:
203           Prefix for the C enum name of the command. The name is formed by concatenating
206       enum-name:
207         description: Name for the enum type with commands.
209       async-prefix:
210 …     description: Same as name-prefix but used to render notifications and events to separate enum.
212       async-enum:
213         description: Name for the enum type with notifications/events.
224               description: Name of the operation, also defining its C enum value in uAPI.
230               description: Value for the enum in the uAPI.
232             attribute-set:
237             flags: &cmd_flags
238               description: Command flags.
241                 enum: [ admin-perm ]
242             dont-validate:
243               description: Kernel attribute validation flags.
246                 enum: [ strict, dump, dump-strict ]
247             do: &subop-type
252                 request: &subop-attr-list
259                         Names of attributes from the attribute-set (not full attribute
264                 reply: *subop-attr-list
271             dump: *subop-type
287   mcast-groups:
305             flags: *cmd_flags