Documentation/netlink/genetlink-c.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-c.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, genetlink-c ]
38   uapi-header:
39     description: Path to the uAPI header, default is linux/${family-name}.h
41   # Start genetlink-c
42   c-family-name:
43     description: Name of the define for the family name.
45   c-version-name:
46     description: Name of the define for the version of the family.
48   max-by-define:
49 …description: Makes the number of attributes and commands be specified by a define, not an enum val…
51   cmd-max-name:
52     description: Name of the define for the last operation in the list.
54   cmd-cnt-name:
57   # End genetlink-c
70           description: For C-compatible languages, header which already defines this value.
78           description: For const - the value.
81         value-start:
89               - type: string
90               - type: object
100         render-max:
101           description: Render the max members for this enum.
103         # Start genetlink-c
104         enum-name:
107         name-prefix:
110         enum-cnt-name:
111           description: Name of the render-max counter enum entry.
113         # End genetlink-c
115   attribute-sets:
128         name-prefix:
130             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
132         enum-name:
139         subset-of:
141             Name of another space which this is a logical part of. Sub-spaces can be used to define
144         # Start genetlink-c
145         attr-cnt-name:
148         attr-max-name:
151         # End genetlink-c
162               type: &attr-type
165                         string, nest, indexed-array, nest-type-value ]
172               type-value:
173 …             description: Name of the value extracted from the type of a nest-type-value attribute.
177               byte-order:
178                 enum: [ little-endian, big-endian ]
179               multi-attr:
181               nested-attributes:
182                 description: Name of the space (sub-space) used inside the attribute.
187               enum-as-flags:
198                   flags-mask:
203                     $ref: '#/$defs/len-or-limit'
204                   max:
205                     description: Max value for an integer attribute.
206                     $ref: '#/$defs/len-or-limit'
207                   min-len:
209                     $ref: '#/$defs/len-or-define'
210                   max-len:
211                     description: Max length for a string or a binary attribute.
212                     $ref: '#/$defs/len-or-define'
213                   exact-len:
215                     $ref: '#/$defs/len-or-define'
216                   unterminated-ok:
221               sub-type: *attr-type
222               display-hint: &display-hint
228               # Start genetlink-c
229               name-prefix:
231               # End genetlink-c
233       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
235         name-prefix:
237             required: [ subset-of ]
238         subset-of:
240             required: [ name-prefix ]
245           subset-of:
255     description: Operations supported by the protocol.
260       enum-model:
268       name-prefix:
270           Prefix for the C enum name of the command. The name is formed by concatenating
271           the prefix with the upper case name of the command, with dashes replaced by underscores.
273       enum-name:
277       async-prefix:
278 …     description: Same as name-prefix but used to render notifications and events to separate enum.
280       async-enum:
301             attribute-set:
310                 enum: [ admin-perm ]
311             dont-validate:
315                 enum: [ strict, dump, dump-strict ]
316             config-cond:
321             do: &subop-type
326                 request: &subop-attr-list
333                         Names of attributes from the attribute-set (not full attribute
338                 reply: *subop-attr-list
345             dump: *subop-type
361   mcast-groups:
377                 The name for the group, used to form the define and the value of the define.
379             # Start genetlink-c
380             c-define-name:
381               description: Override for the name of the define in C uAPI.
383             # End genetlink-c
386   kernel-family:
398       sock-priv: