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)?$
16   len-or-limit:
17     # literal int, const name, or limit based on fixed-width type
18     # e.g. u8-min, u16-max, etc.
20     pattern: ^[0-9A-Za-z_-]+$
27 required: [ name, doc, attribute-sets, operations ]
37     enum: [ genetlink ]
38   uapi-header:
39     description: Path to the uAPI header, default is linux/${family-name}.h
43     description: List of type and constant definitions (enums, flags, defines).
53           description: For C-compatible languages, header which already defines this value.
56           enum: [ const, enum, flags ]
61           description: For const - the value.
63         # For enum and flags
64         value-start:
65           description: For enum or flags the literal initializer for the first value.
68           description: For enum or flags array of values.
72               - type: string
73               - type: object
83         render-max:
84           description: Render the max members for this enum.
87   attribute-sets:
100         name-prefix:
102             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
104         enum-name:
105           description: Name for the enum type of the attribute.
110         subset-of:
112             Name of another space which this is a logical part of. Sub-spaces can be used to define
125               type: &attr-type
126                 enum: [ unused, pad, flag, binary,
128                         string, nest, indexed-array, nest-type-value ]
133                 description: Value for the enum item representing this attribute in the uAPI.
135               type-value:
136 …             description: Name of the value extracted from the type of a nest-type-value attribute.
140               byte-order:
141                 enum: [ little-endian, big-endian ]
142               multi-attr:
144               nested-attributes:
145                 description: Name of the space (sub-space) used inside the attribute.
147               enum:
148                 description: Name of the enum type used for the attribute.
150               enum-as-flags:
152                   Treat the enum as flags. In most cases enum is either used as flags or as values.
153 …               Sometimes, however, both forms are necessary, in which case header contains the enum
161                   flags-mask:
162 …        description: Name of the flags constant on which to base mask (unsigned scalar types only).
166                     $ref: '#/$defs/len-or-limit'
169                     $ref: '#/$defs/len-or-limit'
170                   min-len:
172                     $ref: '#/$defs/len-or-define'
173                   max-len:
175                     $ref: '#/$defs/len-or-define'
176                   exact-len:
178                     $ref: '#/$defs/len-or-define'
179               sub-type: *attr-type
180               display-hint: &display-hint
185                 enum: [ hex, mac, fddi, ipv4, ipv6, uuid ]
187       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
189         name-prefix:
191             required: [ subset-of ]
192         subset-of:
194             required: [ name-prefix ]
199           subset-of:
214       enum-model:
218           to a single enum.
221         enum: [ unified ]
222       name-prefix:
224           Prefix for the C enum name of the command. The name is formed by concatenating
227       enum-name:
228         description: Name for the enum type with commands.
230       async-prefix:
231 …     description: Same as name-prefix but used to render notifications and events to separate enum.
233       async-enum:
234         description: Name for the enum type with notifications/events.
245               description: Name of the operation, also defining its C enum value in uAPI.
251               description: Value for the enum in the uAPI.
253             attribute-set:
258             flags: &cmd_flags
259               description: Command flags.
262                 enum: [ admin-perm ]
263             dont-validate:
264               description: Kernel attribute validation flags.
267                 enum: [ strict, dump, dump-strict ]
268             config-cond:
273             do: &subop-type
278                 request: &subop-attr-list
285                         Names of attributes from the attribute-set (not full attribute
290                 reply: *subop-attr-list
297             dump: *subop-type
313   mcast-groups:
331             flags: *cmd_flags
333   kernel-family:
345       sock-priv: