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 or limit based on fixed-width type e.g. u8-min, u16-max, etc.
19     pattern: ^[su](8|16|32|64)-(min|max)$
26 required: [ name, doc, attribute-sets, operations ]
37   uapi-header:
38     description: Path to the uAPI header, default is linux/${family-name}.h
52           description: For C-compatible languages, header which already defines this value.
60           description: For const - the value.
63         value-start:
64           description: For enum or flags the literal initializer for the first value.
67           description: For enum or flags array of values.
71               - type: string
72               - type: object
82         render-max:
86   attribute-sets:
99         name-prefix:
101             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
103         enum-name:
109         subset-of:
111             Name of another space which this is a logical part of. Sub-spaces can be used to define
124               type: &attr-type
127                         string, nest, indexed-array, nest-type-value ]
134               type-value:
135 …             description: Name of the value extracted from the type of a nest-type-value attribute.
139               byte-order:
140                 enum: [ little-endian, big-endian ]
141               multi-attr:
143               nested-attributes:
144                 description: Name of the space (sub-space) used inside the attribute.
149               enum-as-flags:
151                   Treat the enum as flags. In most cases enum is either used as flags or as values.
160                   flags-mask:
165                     $ref: '#/$defs/len-or-limit'
168                     $ref: '#/$defs/len-or-limit'
169                   min-len:
171                     $ref: '#/$defs/len-or-define'
172                   max-len:
173                     description: Max length for a string or a binary attribute.
174                     $ref: '#/$defs/len-or-define'
175                   exact-len:
176                     description: Exact length for a string or a binary attribute.
177                     $ref: '#/$defs/len-or-define'
178               sub-type: *attr-type
179               display-hint: &display-hint
186       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
188         name-prefix:
190             required: [ subset-of ]
191         subset-of:
193             required: [ name-prefix ]
198           subset-of:
213       enum-model:
221       name-prefix:
226       enum-name:
229       async-prefix:
230 …     description: Same as name-prefix but used to render notifications and events to separate enum.
232       async-enum:
252             attribute-set:
261                 enum: [ admin-perm ]
262             dont-validate:
266                 enum: [ strict, dump, dump-strict ]
267             config-cond:
272             do: &subop-type
277                 request: &subop-attr-list
284                         Names of attributes from the attribute-set (not full attribute
289                 reply: *subop-attr-list
291 …              description: Hook for a function to run before the main callback (pre_doit or start).
294 …               description: Hook for a function to run after the main callback (post_doit or done).
296             dump: *subop-type
312   mcast-groups:
332   kernel-family:
344       sock-priv: