Lines Matching +full:subset +full:- +full:of
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
12 len-or-define:
14 pattern: ^[0-9A-Za-z_-]+( - 1)?$
19 description: Specification of a raw netlink protocol
21 required: [ name, doc, attribute-sets, operations ]
25 description: Name of the netlink family.
31 enum: [ netlink-raw ] # Trim
32 # Start netlink-raw
34 description: Protocol number to use for netlink-raw
36 # End netlink-raw
37 uapi-header:
38 description: Path to the uAPI header, default is linux/${family-name}.h
40 # Start genetlink-c
41 c-family-name:
42 description: Name of the define for the family name.
44 c-version-name:
45 description: Name of the define for the version of the family.
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:
51 description: Name of the define for the last operation in the list.
53 cmd-cnt-name:
54 … description: The explicit name for constant holding the count of operations (last operation + 1).
56 # End genetlink-c
57 # Start genetlink-legacy
58 kernel-policy:
60 … Defines if the input policy in the kernel is global, per-operation, or split per operation type.
62 enum: [ split, per-op, global ]
63 # End genetlink-legacy
66 description: List of type and constant definitions (enums, flags, defines).
76 description: For C-compatible languages, header which already defines this value.
84 description: For const - the value.
87 value-start:
91 description: For enum or flags array of values.
95 - type: string
96 - type: object
106 render-max:
109 # Start genetlink-c
110 enum-name:
113 name-prefix:
114 description: For enum the prefix of the values, optional.
116 # End genetlink-c
117 # Start genetlink-legacy
119 description: List of struct members. Only scalars and strings members allowed.
130 The netlink attribute type. Members of type 'binary' or 'pad'
134 $ref: '#/$defs/len-or-define'
135 byte-order:
136 enum: [ little-endian, big-endian ]
141 description: Name of the enum type used for the attribute.
143 enum-as-flags:
149 display-hint: &display-hint
152 the right formatting mechanism when displaying values of this
156 description: Name of the nested struct type.
170 - required: [ len ]
171 - required: [ struct ]
172 # End genetlink-legacy
174 attribute-sets:
175 description: Definition of attribute spaces for this family.
178 description: Definition of a single attribute space.
185 … Name used when referring to this space in other definitions, not used outside of the spec.
187 name-prefix:
189 Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
191 enum-name:
193 Name for the enum type of the attribute, if empty no name will be used.
196 description: Documentation of the space.
198 subset-of:
200 Name of another space which this is a logical part of. Sub-spaces can be used to define
201 a limited group of attributes which are used in a nest.
203 # Start genetlink-c
204 attr-cnt-name:
205 … description: The explicit name for constant holding the count of attributes (last attr + 1).
207 attr-max-name:
208 description: The explicit name for last member of attribute enum.
210 # End genetlink-c
212 description: List of attributes in the space.
221 type: &attr-type
225 string, nest, indexed-array, nest-type-value,
226 sub-message ]
228 description: Documentation of the attribute.
233 type-value:
234 … description: Name of the value extracted from the type of a nest-type-value attribute.
238 byte-order:
239 enum: [ little-endian, big-endian ]
240 multi-attr:
242 nested-attributes:
243 description: Name of the space (sub-space) used inside the attribute.
246 description: Name of the enum type used for the attribute.
248 enum-as-flags:
259 flags-mask:
260 … description: Name of the flags constant on which to base mask (unsigned scalar types only).
265 min-len:
267 $ref: '#/$defs/len-or-define'
268 max-len:
270 $ref: '#/$defs/len-or-define'
271 exact-len:
273 $ref: '#/$defs/len-or-define'
274 unterminated-ok:
279 sub-type: *attr-type
280 display-hint: *display-hint
281 # Start genetlink-c
282 name-prefix:
284 # End genetlink-c
285 # Start genetlink-legacy
287 description: Name of the struct type used for the attribute.
289 # End genetlink-legacy
290 # Start netlink-raw
291 sub-message:
293 Name of the sub-message definition to use for the attribute.
297 Name of the attribute to use for dynamic selection of sub-message
300 # End netlink-raw
302 # Make sure name-prefix does not appear in subsets (subsets inherit naming)
304 name-prefix:
306 required: [ subset-of ]
307 subset-of:
309 required: [ name-prefix ]
311 # type property is only required if not in subset definition
314 subset-of:
323 # Start netlink-raw
324 sub-messages:
325 description: Definition of sub message attributes
333 description: Name of the sub-message definition
345 Value to match for dynamic selection of sub-message format
348 fixed-header:
350 Name of the struct definition to use as the fixed header
353 attribute-set:
355 Name of the attribute space from which to resolve attributes
358 # End netlink-raw
366 enum-model:
368 The model of assigning values to the operations.
374 name-prefix:
376 Prefix for the C enum name of the command. The name is formed by concatenating
377 the prefix with the upper case name of the command, with dashes replaced by underscores.
379 enum-name:
383 async-prefix:
384 … description: Same as name-prefix but used to render notifications and events to separate enum.
386 async-enum:
390 # Start genetlink-legacy
391 fixed-header: &fixed-header
393 Name of the structure defining the optional fixed-length protocol
397 # End genetlink-legacy
399 description: List of commands
407 description: Name of the operation, also defining its C enum value in uAPI.
415 attribute-set:
424 enum: [ admin-perm ]
425 dont-validate:
430 # Start genetlink-legacy
431 fixed-header: *fixed-header
432 # End genetlink-legacy
433 do: &subop-type
438 request: &subop-attr-list
439 description: Definition of the request message for a given command.
445 Names of attributes from the attribute-set (not full attribute
450 # Start genetlink-legacy
453 ID of this message if value for request and response differ,
456 # End genetlink-legacy
457 reply: *subop-attr-list
464 dump: *subop-type
466 description: Name of the command sharing the reply type with this notification.
473 description: Explicit list of the attributes for the notification.
478 description: Name of the multicast group generating given notification.
480 mcast-groups:
481 description: List of multicast groups.
487 description: List of groups.
496 The name for the group, used to form the define and the value of the define.
498 # Start genetlink-c
499 c-define-name:
500 description: Override for the name of the define in C uAPI.
502 # End genetlink-c
504 # Start netlink-raw
506 description: Value of the netlink multicast group in the uAPI.
508 # End netlink-raw