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/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 ]
30 name:
31 description: Name of the genetlink family.
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:
51 cmd-max-name:
52 description: Name of the define for the last operation in the list.
54 cmd-cnt-name:
55 description: The explicit name for constant holding the count of operations (last operation + 1).
57 # End genetlink-c
64 required: [ type, name ]
67 name:
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
91 required: [ name ]
94 name:
100 render-max:
103 # Start genetlink-c
104 enum-name:
105 description: Name for enum, if empty no name will be used.
107 name-prefix:
108 description: For enum the prefix of the values, optional.
110 enum-cnt-name:
111 description: Name of the render-max counter enum entry.
113 # End genetlink-c
115 attribute-sets:
121 required: [ name, attributes ]
124 name:
126 Name used when referring to this space in other definitions, not used outside of the spec.
128 name-prefix:
130 Prefix for the C enum name of the attributes. Default family[name]-set[name]-a-
132 enum-name:
134 Name for the enum type of the attribute, if empty no name will be used.
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:
146 description: The explicit name for constant holding the count of attributes (last attr + 1).
148 attr-max-name:
149 description: The explicit name for last member of attribute enum.
152 description: For C-compatible languages, header which already defines this attribute set.
154 # End genetlink-c
160 required: [ name ]
163 name:
165 type: &attr-type
168 string, nest, indexed-array, nest-type-value ]
175 type-value:
176 description: Name of the value extracted from the type of a nest-type-value attribute.
180 byte-order:
181 enum: [ little-endian, big-endian ]
182 multi-attr:
184 nested-attributes:
185 description: Name of the space (sub-space) used inside the attribute.
188 description: Name of the enum type used for the attribute.
190 enum-as-flags:
201 flags-mask:
202 description: Name of the flags constant on which to base mask (unsigned scalar types only).
206 $ref: '#/$defs/len-or-limit'
209 $ref: '#/$defs/len-or-limit'
210 min-len:
212 $ref: '#/$defs/len-or-define'
213 max-len:
215 $ref: '#/$defs/len-or-define'
216 exact-len:
218 $ref: '#/$defs/len-or-define'
219 unterminated-ok:
224 sub-type: *attr-type
225 display-hint: &display-hint
231 # Start genetlink-c
232 name-prefix:
234 # End genetlink-c
236 # Make sure name-prefix does not appear in subsets (subsets inherit naming)
238 name-prefix:
240 required: [ subset-of ]
241 subset-of:
243 required: [ name-prefix ]
248 subset-of:
263 enum-model:
271 name-prefix:
273 Prefix for the C enum name of the command. The name is formed by concatenating
274 the prefix with the upper case name of the command, with dashes replaced by underscores.
276 enum-name:
278 Name for the enum type with commands, if empty no name will be used.
280 async-prefix:
281 description: Same as name-prefix but used to render notifications and events to separate enum.
283 async-enum:
285 Name for the enum type with commands, if empty no name will be used.
293 required: [ name, doc ]
295 name:
296 description: Name of the operation, also defining its C enum value in uAPI.
304 attribute-set:
313 enum: [ admin-perm ]
314 dont-validate:
318 enum: [ strict, dump, dump-strict ]
319 config-cond:
321 Name of the kernel config option gating the presence of
322 the operation, without the 'CONFIG_' prefix.
324 do: &subop-type
329 request: &subop-attr-list
336 Names of attributes from the attribute-set (not full attribute
341 reply: *subop-attr-list
348 dump: *subop-type
350 description: Name of the command sharing the reply type with this notification.
362 description: Name of the multicast group generating given notification.
364 mcast-groups:
375 required: [ name ]
378 name:
380 The name for the group, used to form the define and the value of the define.
382 # Start genetlink-c
383 c-define-name:
384 description: Override for the name of the define in C uAPI.
386 # End genetlink-c
389 kernel-family:
401 sock-priv:
403 Literal name of the type which is used within the kernel