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 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 ]
36     enum: [ genetlink, genetlink-c ]
37   uapi-header:
38     description: Path to the uAPI header, default is linux/${family-name}.h
40   # Start genetlink-c
41   c-family-name:
44   c-version-name:
47   max-by-define:
48 …description: Makes the number of attributes and commands be specified by a define, not an enum val…
50   cmd-max-name:
53   cmd-cnt-name:
56   # End genetlink-c
59     description: List of type and constant definitions (enums, flags, defines).
69           description: For C-compatible languages, header which already defines this value.
72           enum: [ const, enum, flags ]
77           description: For const - the value.
79         # For enum and flags
80         value-start:
81           description: For enum or flags the literal initializer for the first value.
84           description: For enum or flags array of values.
88               - type: string
89               - type: object
99         render-max:
100           description: Render the max members for this enum.
102         # Start genetlink-c
103         enum-name:
104           description: Name for enum, if empty no name will be used.
106         name-prefix:
107           description: For enum the prefix of the values, optional.
109         # End genetlink-c
111   attribute-sets:
124         name-prefix:
126             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
128         enum-name:
129           description: Name for the enum type of the attribute.
134         subset-of:
136             Name of another space which this is a logical part of. Sub-spaces can be used to define
139         # Start genetlink-c
140         attr-cnt-name:
143         attr-max-name:
144           description: The explicit name for last member of attribute enum.
146         # End genetlink-c
157               type: &attr-type
158                 enum: [ unused, pad, flag, binary,
160                         string, nest, array-nest, nest-type-value ]
165                 description: Value for the enum item representing this attribute in the uAPI.
167               type-value:
168 …             description: Name of the value extracted from the type of a nest-type-value attribute.
172               byte-order:
173                 enum: [ little-endian, big-endian ]
174               multi-attr:
176               nested-attributes:
177                 description: Name of the space (sub-space) used inside the attribute.
179               enum:
180                 description: Name of the enum type used for the attribute.
182               enum-as-flags:
184                   Treat the enum as flags. In most cases enum is either used as flags or as values.
185 …               Sometimes, however, both forms are necessary, in which case header contains the enum
193                   flags-mask:
194 …        description: Name of the flags constant on which to base mask (unsigned scalar types only).
198                     $ref: '#/$defs/len-or-limit'
201                     $ref: '#/$defs/len-or-limit'
202                   min-len:
204                     $ref: '#/$defs/len-or-define'
205                   max-len:
207                     $ref: '#/$defs/len-or-define'
208                   exact-len:
210                     $ref: '#/$defs/len-or-define'
211               sub-type: *attr-type
212               display-hint: &display-hint
217                 enum: [ hex, mac, fddi, ipv4, ipv6, uuid ]
218               # Start genetlink-c
219               name-prefix:
221               # End genetlink-c
223       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
225         name-prefix:
227             required: [ subset-of ]
228         subset-of:
230             required: [ name-prefix ]
235           subset-of:
250       enum-model:
254           to a single enum.
257         enum: [ unified ]
258       name-prefix:
260           Prefix for the C enum name of the command. The name is formed by concatenating
263       enum-name:
264         description: Name for the enum type with commands.
266       async-prefix:
267 …     description: Same as name-prefix but used to render notifications and events to separate enum.
269       async-enum:
270         description: Name for the enum type with notifications/events.
281               description: Name of the operation, also defining its C enum value in uAPI.
287               description: Value for the enum in the uAPI.
289             attribute-set:
294             flags: &cmd_flags
295               description: Command flags.
298                 enum: [ admin-perm ]
299             dont-validate:
300               description: Kernel attribute validation flags.
303                 enum: [ strict, dump, dump-strict ]
304             config-cond:
309             do: &subop-type
314                 request: &subop-attr-list
321                         Names of attributes from the attribute-set (not full attribute
326                 reply: *subop-attr-list
333             dump: *subop-type
349   mcast-groups:
367             # Start genetlink-c
368             c-define-name:
371             # End genetlink-c
372             flags: *cmd_flags