14e16b6a7SJakub Kicinski# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 2e616c07cSJakub Kicinski%YAML 1.2 3e616c07cSJakub Kicinski--- 4e616c07cSJakub Kicinski$id: http://kernel.org/schemas/netlink/genetlink-legacy.yaml# 5e616c07cSJakub Kicinski$schema: https://json-schema.org/draft-07/schema 6e616c07cSJakub Kicinski 7e616c07cSJakub Kicinski# Common defines 8e616c07cSJakub Kicinski$defs: 9e616c07cSJakub Kicinski uint: 10e616c07cSJakub Kicinski type: integer 11e616c07cSJakub Kicinski minimum: 0 12e616c07cSJakub Kicinski len-or-define: 13e616c07cSJakub Kicinski type: [ string, integer ] 14e616c07cSJakub Kicinski pattern: ^[0-9A-Za-z_]+( - 1)?$ 15e616c07cSJakub Kicinski minimum: 0 16e616c07cSJakub Kicinski 17e616c07cSJakub Kicinski# Schema for specs 18e616c07cSJakub Kicinskititle: Protocol 19e616c07cSJakub Kicinskidescription: Specification of a genetlink protocol 20e616c07cSJakub Kicinskitype: object 21e616c07cSJakub Kicinskirequired: [ name, doc, attribute-sets, operations ] 22e616c07cSJakub KicinskiadditionalProperties: False 23e616c07cSJakub Kicinskiproperties: 24e616c07cSJakub Kicinski name: 25e616c07cSJakub Kicinski description: Name of the genetlink family. 26e616c07cSJakub Kicinski type: string 27e616c07cSJakub Kicinski doc: 28e616c07cSJakub Kicinski type: string 29e616c07cSJakub Kicinski version: 30e616c07cSJakub Kicinski description: Generic Netlink family version. Default is 1. 31e616c07cSJakub Kicinski type: integer 32e616c07cSJakub Kicinski minimum: 1 33e616c07cSJakub Kicinski protocol: 34e616c07cSJakub Kicinski description: Schema compatibility level. Default is "genetlink". 35e616c07cSJakub Kicinski enum: [ genetlink, genetlink-c, genetlink-legacy ] # Trim 36e616c07cSJakub Kicinski uapi-header: 37e616c07cSJakub Kicinski description: Path to the uAPI header, default is linux/${family-name}.h 38e616c07cSJakub Kicinski type: string 3982b32970SJakub Kicinski # Start genetlink-c 40e616c07cSJakub Kicinski c-family-name: 41e616c07cSJakub Kicinski description: Name of the define for the family name. 42e616c07cSJakub Kicinski type: string 43e616c07cSJakub Kicinski c-version-name: 44e616c07cSJakub Kicinski description: Name of the define for the verion of the family. 45e616c07cSJakub Kicinski type: string 46e616c07cSJakub Kicinski max-by-define: 47e616c07cSJakub Kicinski description: Makes the number of attributes and commands be specified by a define, not an enum value. 48e616c07cSJakub Kicinski type: boolean 49e616c07cSJakub Kicinski # End genetlink-c 50e616c07cSJakub Kicinski # Start genetlink-legacy 51e616c07cSJakub Kicinski kernel-policy: 52e616c07cSJakub Kicinski description: | 53e616c07cSJakub Kicinski Defines if the input policy in the kernel is global, per-operation, or split per operation type. 54e616c07cSJakub Kicinski Default is split. 55e616c07cSJakub Kicinski enum: [ split, per-op, global ] 56e616c07cSJakub Kicinski # End genetlink-legacy 57e616c07cSJakub Kicinski 58e616c07cSJakub Kicinski definitions: 59e616c07cSJakub Kicinski description: List of type and constant definitions (enums, flags, defines). 60e616c07cSJakub Kicinski type: array 61e616c07cSJakub Kicinski items: 62e616c07cSJakub Kicinski type: object 63e616c07cSJakub Kicinski required: [ type, name ] 64e616c07cSJakub Kicinski additionalProperties: False 65e616c07cSJakub Kicinski properties: 66e616c07cSJakub Kicinski name: 67e616c07cSJakub Kicinski type: string 68e616c07cSJakub Kicinski header: 69e616c07cSJakub Kicinski description: For C-compatible languages, header which already defines this value. 70e616c07cSJakub Kicinski type: string 71e616c07cSJakub Kicinski type: 72e616c07cSJakub Kicinski enum: [ const, enum, flags, struct ] # Trim 73e616c07cSJakub Kicinski doc: 74e616c07cSJakub Kicinski type: string 75e616c07cSJakub Kicinski # For const 76e616c07cSJakub Kicinski value: 77e616c07cSJakub Kicinski description: For const - the value. 78e616c07cSJakub Kicinski type: [ string, integer ] 79e616c07cSJakub Kicinski # For enum and flags 80e616c07cSJakub Kicinski value-start: 81e616c07cSJakub Kicinski description: For enum or flags the literal initializer for the first value. 82e616c07cSJakub Kicinski type: [ string, integer ] 83e616c07cSJakub Kicinski entries: 84e616c07cSJakub Kicinski description: For enum or flags array of values. 85e616c07cSJakub Kicinski type: array 86e616c07cSJakub Kicinski items: 87e616c07cSJakub Kicinski oneOf: 88e616c07cSJakub Kicinski - type: string 89e616c07cSJakub Kicinski - type: object 90e616c07cSJakub Kicinski required: [ name ] 91e616c07cSJakub Kicinski additionalProperties: False 92e616c07cSJakub Kicinski properties: 93e616c07cSJakub Kicinski name: 94e616c07cSJakub Kicinski type: string 95e616c07cSJakub Kicinski value: 96e616c07cSJakub Kicinski type: integer 97e616c07cSJakub Kicinski doc: 98e616c07cSJakub Kicinski type: string 99e616c07cSJakub Kicinski render-max: 100e616c07cSJakub Kicinski description: Render the max members for this enum. 101e616c07cSJakub Kicinski type: boolean 102e616c07cSJakub Kicinski # Start genetlink-c 103e616c07cSJakub Kicinski enum-name: 104e616c07cSJakub Kicinski description: Name for enum, if empty no name will be used. 105e616c07cSJakub Kicinski type: [ string, "null" ] 106e616c07cSJakub Kicinski name-prefix: 107e616c07cSJakub Kicinski description: For enum the prefix of the values, optional. 108e616c07cSJakub Kicinski type: string 109e616c07cSJakub Kicinski # End genetlink-c 110e616c07cSJakub Kicinski # Start genetlink-legacy 111e616c07cSJakub Kicinski members: 112e616c07cSJakub Kicinski description: List of struct members. Only scalars and strings members allowed. 113e616c07cSJakub Kicinski type: array 114e616c07cSJakub Kicinski items: 115e616c07cSJakub Kicinski type: object 116e616c07cSJakub Kicinski required: [ name, type ] 117e616c07cSJakub Kicinski additionalProperties: False 118e616c07cSJakub Kicinski properties: 119e616c07cSJakub Kicinski name: 120e616c07cSJakub Kicinski type: string 121e616c07cSJakub Kicinski type: 122e616c07cSJakub Kicinski enum: [ u8, u16, u32, u64, s8, s16, s32, s64, string ] 123e616c07cSJakub Kicinski len: 124e616c07cSJakub Kicinski $ref: '#/$defs/len-or-define' 125e616c07cSJakub Kicinski # End genetlink-legacy 126e616c07cSJakub Kicinski 127e616c07cSJakub Kicinski attribute-sets: 128e616c07cSJakub Kicinski description: Definition of attribute spaces for this family. 129e616c07cSJakub Kicinski type: array 130e616c07cSJakub Kicinski items: 131e616c07cSJakub Kicinski description: Definition of a single attribute space. 132e616c07cSJakub Kicinski type: object 133e616c07cSJakub Kicinski required: [ name, attributes ] 134e616c07cSJakub Kicinski additionalProperties: False 135e616c07cSJakub Kicinski properties: 136e616c07cSJakub Kicinski name: 137e616c07cSJakub Kicinski description: | 138e616c07cSJakub Kicinski Name used when referring to this space in other definitions, not used outside of the spec. 139e616c07cSJakub Kicinski type: string 140e616c07cSJakub Kicinski name-prefix: 141e616c07cSJakub Kicinski description: | 142e616c07cSJakub Kicinski Prefix for the C enum name of the attributes. Default family[name]-set[name]-a- 143e616c07cSJakub Kicinski type: string 144e616c07cSJakub Kicinski enum-name: 145e616c07cSJakub Kicinski description: Name for the enum type of the attribute. 146e616c07cSJakub Kicinski type: string 147e616c07cSJakub Kicinski doc: 148e616c07cSJakub Kicinski description: Documentation of the space. 149e616c07cSJakub Kicinski type: string 150e616c07cSJakub Kicinski subset-of: 151e616c07cSJakub Kicinski description: | 152e616c07cSJakub Kicinski Name of another space which this is a logical part of. Sub-spaces can be used to define 153e616c07cSJakub Kicinski a limited group of attributes which are used in a nest. 154e616c07cSJakub Kicinski type: string 155e616c07cSJakub Kicinski # Start genetlink-c 156e616c07cSJakub Kicinski attr-cnt-name: 157e616c07cSJakub Kicinski description: The explicit name for constant holding the count of attributes (last attr + 1). 158e616c07cSJakub Kicinski type: string 159e616c07cSJakub Kicinski attr-max-name: 160e616c07cSJakub Kicinski description: The explicit name for last member of attribute enum. 161e616c07cSJakub Kicinski type: string 162e616c07cSJakub Kicinski # End genetlink-c 163e616c07cSJakub Kicinski attributes: 164e616c07cSJakub Kicinski description: List of attributes in the space. 165e616c07cSJakub Kicinski type: array 166e616c07cSJakub Kicinski items: 167e616c07cSJakub Kicinski type: object 168e616c07cSJakub Kicinski required: [ name, type ] 169e616c07cSJakub Kicinski additionalProperties: False 170e616c07cSJakub Kicinski properties: 171e616c07cSJakub Kicinski name: 172e616c07cSJakub Kicinski type: string 173e616c07cSJakub Kicinski type: &attr-type 174e616c07cSJakub Kicinski enum: [ unused, pad, flag, binary, u8, u16, u32, u64, s32, s64, 175e616c07cSJakub Kicinski string, nest, array-nest, nest-type-value ] 176e616c07cSJakub Kicinski doc: 177e616c07cSJakub Kicinski description: Documentation of the attribute. 178e616c07cSJakub Kicinski type: string 179e616c07cSJakub Kicinski value: 180e616c07cSJakub Kicinski description: Value for the enum item representing this attribute in the uAPI. 181e616c07cSJakub Kicinski $ref: '#/$defs/uint' 182e616c07cSJakub Kicinski type-value: 183e616c07cSJakub Kicinski description: Name of the value extracted from the type of a nest-type-value attribute. 184e616c07cSJakub Kicinski type: array 185e616c07cSJakub Kicinski items: 186e616c07cSJakub Kicinski type: string 187e616c07cSJakub Kicinski byte-order: 188e616c07cSJakub Kicinski enum: [ little-endian, big-endian ] 189e616c07cSJakub Kicinski multi-attr: 190e616c07cSJakub Kicinski type: boolean 191e616c07cSJakub Kicinski nested-attributes: 192e616c07cSJakub Kicinski description: Name of the space (sub-space) used inside the attribute. 193e616c07cSJakub Kicinski type: string 194e616c07cSJakub Kicinski enum: 195e616c07cSJakub Kicinski description: Name of the enum type used for the attribute. 196e616c07cSJakub Kicinski type: string 197e616c07cSJakub Kicinski enum-as-flags: 198e616c07cSJakub Kicinski description: | 199e616c07cSJakub Kicinski Treat the enum as flags. In most cases enum is either used as flags or as values. 200e616c07cSJakub Kicinski Sometimes, however, both forms are necessary, in which case header contains the enum 201e616c07cSJakub Kicinski form while specific attributes may request to convert the values into a bitfield. 202e616c07cSJakub Kicinski type: boolean 203e616c07cSJakub Kicinski checks: 204e616c07cSJakub Kicinski description: Kernel input validation. 205e616c07cSJakub Kicinski type: object 206e616c07cSJakub Kicinski additionalProperties: False 207e616c07cSJakub Kicinski properties: 208e616c07cSJakub Kicinski flags-mask: 209e616c07cSJakub Kicinski description: Name of the flags constant on which to base mask (unsigned scalar types only). 210e616c07cSJakub Kicinski type: string 211e616c07cSJakub Kicinski min: 212e616c07cSJakub Kicinski description: Min value for an integer attribute. 213e616c07cSJakub Kicinski type: integer 214e616c07cSJakub Kicinski min-len: 215e616c07cSJakub Kicinski description: Min length for a binary attribute. 216e616c07cSJakub Kicinski $ref: '#/$defs/len-or-define' 217e616c07cSJakub Kicinski max-len: 218e616c07cSJakub Kicinski description: Max length for a string or a binary attribute. 219e616c07cSJakub Kicinski $ref: '#/$defs/len-or-define' 220e616c07cSJakub Kicinski sub-type: *attr-type 22126071913SDonald Hunter # Start genetlink-legacy 22226071913SDonald Hunter struct: 22326071913SDonald Hunter description: Name of the struct type used for the attribute. 22426071913SDonald Hunter type: string 22526071913SDonald Hunter # End genetlink-legacy 226e616c07cSJakub Kicinski 227e616c07cSJakub Kicinski # Make sure name-prefix does not appear in subsets (subsets inherit naming) 228e616c07cSJakub Kicinski dependencies: 229e616c07cSJakub Kicinski name-prefix: 230e616c07cSJakub Kicinski not: 231e616c07cSJakub Kicinski required: [ subset-of ] 232e616c07cSJakub Kicinski subset-of: 233e616c07cSJakub Kicinski not: 234e616c07cSJakub Kicinski required: [ name-prefix ] 235e616c07cSJakub Kicinski 236e616c07cSJakub Kicinski operations: 237e616c07cSJakub Kicinski description: Operations supported by the protocol. 238e616c07cSJakub Kicinski type: object 239e616c07cSJakub Kicinski required: [ list ] 240e616c07cSJakub Kicinski additionalProperties: False 241e616c07cSJakub Kicinski properties: 242e616c07cSJakub Kicinski enum-model: 243e616c07cSJakub Kicinski description: | 244e616c07cSJakub Kicinski The model of assigning values to the operations. 245e616c07cSJakub Kicinski "unified" is the recommended model where all message types belong 246e616c07cSJakub Kicinski to a single enum. 247e616c07cSJakub Kicinski "directional" has the messages sent to the kernel and from the kernel 248e616c07cSJakub Kicinski enumerated separately. 2498403bf04SJakub Kicinski enum: [ unified, directional ] # Trim 250e616c07cSJakub Kicinski name-prefix: 251e616c07cSJakub Kicinski description: | 252e616c07cSJakub Kicinski Prefix for the C enum name of the command. The name is formed by concatenating 253e616c07cSJakub Kicinski the prefix with the upper case name of the command, with dashes replaced by underscores. 254e616c07cSJakub Kicinski type: string 255e616c07cSJakub Kicinski enum-name: 256e616c07cSJakub Kicinski description: Name for the enum type with commands. 257e616c07cSJakub Kicinski type: string 258e616c07cSJakub Kicinski async-prefix: 259e616c07cSJakub Kicinski description: Same as name-prefix but used to render notifications and events to separate enum. 260e616c07cSJakub Kicinski type: string 261e616c07cSJakub Kicinski async-enum: 262e616c07cSJakub Kicinski description: Name for the enum type with notifications/events. 263e616c07cSJakub Kicinski type: string 264*f036d936SDonald Hunter # Start genetlink-legacy 265*f036d936SDonald Hunter fixed-header: &fixed-header 266*f036d936SDonald Hunter description: | 267*f036d936SDonald Hunter Name of the structure defining the optional fixed-length protocol 268*f036d936SDonald Hunter header. This header is placed in a message after the netlink and 269*f036d936SDonald Hunter genetlink headers and before any attributes. 270*f036d936SDonald Hunter type: string 271*f036d936SDonald Hunter # End genetlink-legacy 272e616c07cSJakub Kicinski list: 273e616c07cSJakub Kicinski description: List of commands 274e616c07cSJakub Kicinski type: array 275e616c07cSJakub Kicinski items: 276e616c07cSJakub Kicinski type: object 277e616c07cSJakub Kicinski additionalProperties: False 278e616c07cSJakub Kicinski required: [ name, doc ] 279e616c07cSJakub Kicinski properties: 280e616c07cSJakub Kicinski name: 281e616c07cSJakub Kicinski description: Name of the operation, also defining its C enum value in uAPI. 282e616c07cSJakub Kicinski type: string 283e616c07cSJakub Kicinski doc: 284e616c07cSJakub Kicinski description: Documentation for the command. 285e616c07cSJakub Kicinski type: string 286e616c07cSJakub Kicinski value: 287e616c07cSJakub Kicinski description: Value for the enum in the uAPI. 288e616c07cSJakub Kicinski $ref: '#/$defs/uint' 289e616c07cSJakub Kicinski attribute-set: 290e616c07cSJakub Kicinski description: | 291e616c07cSJakub Kicinski Attribute space from which attributes directly in the requests and replies 292e616c07cSJakub Kicinski to this command are defined. 293e616c07cSJakub Kicinski type: string 294e616c07cSJakub Kicinski flags: &cmd_flags 295e616c07cSJakub Kicinski description: Command flags. 296e616c07cSJakub Kicinski type: array 297e616c07cSJakub Kicinski items: 298e616c07cSJakub Kicinski enum: [ admin-perm ] 299e616c07cSJakub Kicinski dont-validate: 300e616c07cSJakub Kicinski description: Kernel attribute validation flags. 301e616c07cSJakub Kicinski type: array 302e616c07cSJakub Kicinski items: 303e616c07cSJakub Kicinski enum: [ strict, dump ] 304*f036d936SDonald Hunter # Start genetlink-legacy 305*f036d936SDonald Hunter fixed-header: *fixed-header 306*f036d936SDonald Hunter # End genetlink-legacy 307e616c07cSJakub Kicinski do: &subop-type 308e616c07cSJakub Kicinski description: Main command handler. 309e616c07cSJakub Kicinski type: object 310e616c07cSJakub Kicinski additionalProperties: False 311e616c07cSJakub Kicinski properties: 312e616c07cSJakub Kicinski request: &subop-attr-list 313e616c07cSJakub Kicinski description: Definition of the request message for a given command. 314e616c07cSJakub Kicinski type: object 315e616c07cSJakub Kicinski additionalProperties: False 316e616c07cSJakub Kicinski properties: 317e616c07cSJakub Kicinski attributes: 318e616c07cSJakub Kicinski description: | 319e616c07cSJakub Kicinski Names of attributes from the attribute-set (not full attribute 320e616c07cSJakub Kicinski definitions, just names). 321e616c07cSJakub Kicinski type: array 322e616c07cSJakub Kicinski items: 323e616c07cSJakub Kicinski type: string 3248403bf04SJakub Kicinski # Start genetlink-legacy 3258403bf04SJakub Kicinski value: 3268403bf04SJakub Kicinski description: | 3278403bf04SJakub Kicinski ID of this message if value for request and response differ, 3288403bf04SJakub Kicinski i.e. requests and responses have different message enums. 3298403bf04SJakub Kicinski $ref: '#/$defs/uint' 3308403bf04SJakub Kicinski # End genetlink-legacy 331e616c07cSJakub Kicinski reply: *subop-attr-list 332e616c07cSJakub Kicinski pre: 333e616c07cSJakub Kicinski description: Hook for a function to run before the main callback (pre_doit or start). 334e616c07cSJakub Kicinski type: string 335e616c07cSJakub Kicinski post: 336e616c07cSJakub Kicinski description: Hook for a function to run after the main callback (post_doit or done). 337e616c07cSJakub Kicinski type: string 338e616c07cSJakub Kicinski dump: *subop-type 339e616c07cSJakub Kicinski notify: 340e616c07cSJakub Kicinski description: Name of the command sharing the reply type with this notification. 341e616c07cSJakub Kicinski type: string 342e616c07cSJakub Kicinski event: 343e616c07cSJakub Kicinski type: object 344e616c07cSJakub Kicinski additionalProperties: False 345e616c07cSJakub Kicinski properties: 346e616c07cSJakub Kicinski attributes: 347e616c07cSJakub Kicinski description: Explicit list of the attributes for the notification. 348e616c07cSJakub Kicinski type: array 349e616c07cSJakub Kicinski items: 350e616c07cSJakub Kicinski type: string 351e616c07cSJakub Kicinski mcgrp: 352e616c07cSJakub Kicinski description: Name of the multicast group generating given notification. 353e616c07cSJakub Kicinski type: string 354e616c07cSJakub Kicinski mcast-groups: 355e616c07cSJakub Kicinski description: List of multicast groups. 356e616c07cSJakub Kicinski type: object 357e616c07cSJakub Kicinski required: [ list ] 358e616c07cSJakub Kicinski additionalProperties: False 359e616c07cSJakub Kicinski properties: 360e616c07cSJakub Kicinski list: 361e616c07cSJakub Kicinski description: List of groups. 362e616c07cSJakub Kicinski type: array 363e616c07cSJakub Kicinski items: 364e616c07cSJakub Kicinski type: object 365e616c07cSJakub Kicinski required: [ name ] 366e616c07cSJakub Kicinski additionalProperties: False 367e616c07cSJakub Kicinski properties: 368e616c07cSJakub Kicinski name: 369e616c07cSJakub Kicinski description: | 370e616c07cSJakub Kicinski The name for the group, used to form the define and the value of the define. 371e616c07cSJakub Kicinski type: string 372e616c07cSJakub Kicinski # Start genetlink-c 373e616c07cSJakub Kicinski c-define-name: 374e616c07cSJakub Kicinski description: Override for the name of the define in C uAPI. 375e616c07cSJakub Kicinski type: string 376e616c07cSJakub Kicinski # End genetlink-c 377e616c07cSJakub Kicinski flags: *cmd_flags 378