Lines Matching +full:name +full:- +full:prefix
1 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
3 ---
4 $id: http://kernel.org/schemas/netlink/netlink-raw.yaml#
5 $schema: https://json-schema.org/draft-07/schema
9 name:
11 pattern: ^[0-9a-z-]+$
12 name-cap:
14 pattern: ^[0-9a-zA-Z-]+$
18 len-or-define:
20 pattern: ^[0-9A-Za-z_-]+( - 1)?$
27 required: [ name, doc, attribute-sets, operations ]
30 name:
31 description: Name of the netlink family.
37 enum: [ netlink-raw ] # Trim
38 # Start netlink-raw
40 description: Protocol number to use for netlink-raw
42 # End netlink-raw
43 uapi-header:
44 description: Path to the uAPI header, default is linux/${family-name}.h
46 # Start genetlink-c
47 c-family-name:
48 description: Name of the define for the family name.
50 c-version-name:
51 description: Name of the define for the version of the family.
53 max-by-define:
56 cmd-max-name:
57 description: Name of the define for the last operation in the list.
59 cmd-cnt-name:
60 … description: The explicit name for constant holding the count of operations (last operation + 1).
62 # End genetlink-c
63 # Start genetlink-legacy
64 kernel-policy:
66 … Defines if the input policy in the kernel is global, per-operation, or split per operation type.
68 enum: [ split, per-op, global ]
69 # End genetlink-legacy
76 required: [ type, name ]
79 name:
80 $ref: '#/$defs/name'
82 description: For C-compatible languages, header which already defines this value.
90 description: For const - the value.
93 value-start:
101 - type: string
102 - type: object
103 required: [ name ]
106 name:
107 $ref: '#/$defs/name'
112 render-max:
115 # Start genetlink-c
116 enum-name:
117 description: Name for enum, if empty no name will be used.
119 name-prefix:
120 description: For enum the prefix of the values, optional.
122 # End genetlink-c
123 # Start genetlink-legacy
129 required: [ name, type ]
132 name:
133 $ref: '#/$defs/name-cap'
140 $ref: '#/$defs/len-or-define'
141 byte-order:
142 enum: [ little-endian, big-endian ]
147 description: Name of the enum type used for the attribute.
149 enum-as-flags:
155 display-hint: &display-hint
162 description: Name of the nested struct type.
176 - required: [ len ]
177 - required: [ struct ]
178 # End genetlink-legacy
180 attribute-sets:
186 required: [ name, attributes ]
189 name:
191 … Name used when referring to this space in other definitions, not used outside of the spec.
192 $ref: '#/$defs/name'
193 name-prefix:
195 Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
197 enum-name:
199 Name for the enum type of the attribute, if empty no name will be used.
204 subset-of:
206 Name of another space which this is a logical part of. Sub-spaces can be used to define
209 # Start genetlink-c
210 attr-cnt-name:
211 … description: The explicit name for constant holding the count of attributes (last attr + 1).
213 attr-max-name:
214 description: The explicit name for last member of attribute enum.
217 description: For C-compatible languages, header which already defines this attribute set.
219 # End genetlink-c
225 required: [ name ]
228 name:
229 $ref: '#/$defs/name'
230 type: &attr-type
234 string, nest, indexed-array, nest-type-value,
235 sub-message ]
242 type-value:
243 … description: Name of the value extracted from the type of a nest-type-value attribute.
247 byte-order:
248 enum: [ little-endian, big-endian ]
249 multi-attr:
251 nested-attributes:
252 description: Name of the space (sub-space) used inside the attribute.
255 description: Name of the enum type used for the attribute.
257 enum-as-flags:
268 flags-mask:
269 … description: Name of the flags constant on which to base mask (unsigned scalar types only).
274 min-len:
276 $ref: '#/$defs/len-or-define'
277 max-len:
279 $ref: '#/$defs/len-or-define'
280 exact-len:
282 $ref: '#/$defs/len-or-define'
283 unterminated-ok:
288 sub-type: *attr-type
289 display-hint: *display-hint
290 # Start genetlink-c
291 name-prefix:
293 # End genetlink-c
294 # Start genetlink-legacy
296 description: Name of the struct type used for the attribute.
298 # End genetlink-legacy
299 # Start netlink-raw
300 sub-message:
302 Name of the sub-message definition to use for the attribute.
306 Name of the attribute to use for dynamic selection of sub-message
309 # End netlink-raw
311 # Make sure name-prefix does not appear in subsets (subsets inherit naming)
313 name-prefix:
315 required: [ subset-of ]
316 subset-of:
318 required: [ name-prefix ]
323 subset-of:
332 # Start netlink-raw
333 sub-messages:
339 required: [ name, formats ]
341 name:
342 description: Name of the sub-message definition
354 Value to match for dynamic selection of sub-message format
357 fixed-header:
359 Name of the struct definition to use as the fixed header
362 attribute-set:
364 Name of the attribute space from which to resolve attributes
367 # End netlink-raw
375 enum-model:
383 name-prefix:
385 Prefix for the C enum name of the command. The name is formed by concatenating
386 the prefix with the upper case name of the command, with dashes replaced by underscores.
388 enum-name:
390 Name for the enum type with commands, if empty no name will be used.
392 async-prefix:
393 … description: Same as name-prefix but used to render notifications and events to separate enum.
395 async-enum:
397 Name for the enum type with commands, if empty no name will be used.
399 # Start genetlink-legacy
400 fixed-header: &fixed-header
402 Name of the structure defining the optional fixed-length protocol
406 # End genetlink-legacy
413 required: [ name, doc ]
415 name:
416 description: Name of the operation, also defining its C enum value in uAPI.
417 $ref: '#/$defs/name'
424 attribute-set:
433 enum: [ admin-perm ]
434 dont-validate:
439 # Start genetlink-legacy
440 fixed-header: *fixed-header
441 # End genetlink-legacy
442 do: &subop-type
447 request: &subop-attr-list
454 Names of attributes from the attribute-set (not full attribute
459 # Start genetlink-legacy
465 # End genetlink-legacy
466 reply: *subop-attr-list
473 dump: *subop-type
475 description: Name of the command sharing the reply type with this notification.
487 description: Name of the multicast group generating given notification.
489 mcast-groups:
500 required: [ name ]
503 name:
505 The name for the group, used to form the define and the value of the define.
507 # Start genetlink-c
508 c-define-name:
509 description: Override for the name of the define in C uAPI.
511 # End genetlink-c
513 # Start netlink-raw
517 # End netlink-raw