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)?$
21 required: [ name, doc, attribute-sets, operations ]
24   name:
25     description: Name of the genetlink family.
35     enum: [ genetlink, genetlink-c ]
36   uapi-header:
37     description: Path to the uAPI header, default is linux/${family-name}.h
39   # Start genetlink-c
40   c-family-name:
41     description: Name of the define for the family name.
43   c-version-name:
44     description: Name of the define for the version of the family.
46   max-by-define:
49   # End genetlink-c
56       required: [ type, name ]
59         name:
62           description: For C-compatible languages, header which already defines this value.
70           description: For const - the value.
73         value-start:
81               - type: string
82               - type: object
83                 required: [ name ]
86                   name:
92         render-max:
95         # Start genetlink-c
96         enum-name:
97           description: Name for enum, if empty no name will be used.
99         name-prefix:
100           description: For enum the prefix of the values, optional.
102         # End genetlink-c
104   attribute-sets:
110       required: [ name, attributes ]
113         name:
115 …         Name used when referring to this space in other definitions, not used outside of the spec.
117         name-prefix:
119             Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
121         enum-name:
122           description: Name for the enum type of the attribute.
127         subset-of:
129             Name of another space which this is a logical part of. Sub-spaces can be used to define
132         # Start genetlink-c
133         attr-cnt-name:
134 …       description: The explicit name for constant holding the count of attributes (last attr + 1).
136         attr-max-name:
137           description: The explicit name for last member of attribute enum.
139         # End genetlink-c
145             required: [ name, type ]
148               name:
150               type: &attr-type
152                         string, nest, array-nest, nest-type-value ]
159               type-value:
160 …             description: Name of the value extracted from the type of a nest-type-value attribute.
164               byte-order:
165                 enum: [ little-endian, big-endian ]
166               multi-attr:
168               nested-attributes:
169                 description: Name of the space (sub-space) used inside the attribute.
172                 description: Name of the enum type used for the attribute.
174               enum-as-flags:
185                   flags-mask:
186 …        description: Name of the flags constant on which to base mask (unsigned scalar types only).
191                   min-len:
193                     $ref: '#/$defs/len-or-define'
194                   max-len:
196                     $ref: '#/$defs/len-or-define'
197               sub-type: *attr-type
198               display-hint: &display-hint
204               # Start genetlink-c
205               name-prefix:
207               # End genetlink-c
209       # Make sure name-prefix does not appear in subsets (subsets inherit naming)
211         name-prefix:
213             required: [ subset-of ]
214         subset-of:
216             required: [ name-prefix ]
224       enum-model:
232       name-prefix:
234           Prefix for the C enum name of the command. The name is formed by concatenating
235           the prefix with the upper case name of the command, with dashes replaced by underscores.
237       enum-name:
238         description: Name for the enum type with commands.
240       async-prefix:
241 …     description: Same as name-prefix but used to render notifications and events to separate enum.
243       async-enum:
244         description: Name for the enum type with notifications/events.
252           required: [ name, doc ]
254             name:
255               description: Name of the operation, also defining its C enum value in uAPI.
263             attribute-set:
272                 enum: [ admin-perm ]
273             dont-validate:
277                 enum: [ strict, dump, dump-strict ]
278             do: &subop-type
283                 request: &subop-attr-list
290                         Names of attributes from the attribute-set (not full attribute
295                 reply: *subop-attr-list
302             dump: *subop-type
304               description: Name of the command sharing the reply type with this notification.
316               description: Name of the multicast group generating given notification.
318   mcast-groups:
329           required: [ name ]
332             name:
334                 The name for the group, used to form the define and the value of the define.
336             # Start genetlink-c
337             c-define-name:
338               description: Override for the name of the define in C uAPI.
340             # End genetlink-c