Name |
Date |
Size |
#Lines |
LOC |
||
---|---|---|---|---|---|---|
.. | - | - | ||||
README.md | H A D | 07-Dec-2022 | 3.1 KiB | 74 | 54 | |
firmware.json | H A D | 19-Feb-2025 | 767 | 21 | 20 | |
global.json | H A D | 12-Feb-2025 | 8.8 KiB | 187 | 186 | |
ibm.json | H A D | 04-Sep-2024 | 5.4 KiB | 110 | 109 | |
intel.json | H A D | 04-Sep-2024 | 779 | 30 | 29 | |
leak_detector.json | H A D | 08-Nov-2024 | 1.4 KiB | 44 | 43 | |
legacy.json | H A D | 10-Jan-2025 | 59.4 KiB | 2,003 | 2,002 | |
mctp.json | H A D | 12-Feb-2025 | 1.6 KiB | 50 | 49 | |
openbmc-dbus.json | H A D | 13-Dec-2024 | 8.1 KiB | 199 | 198 | |
pid.json | H A D | 04-Sep-2024 | 3.5 KiB | 124 | 123 | |
pid_zone.json | H A D | 04-Sep-2024 | 996 | 36 | 35 | |
satellite_controller.json | H A D | 04-Sep-2024 | 1.2 KiB | 34 | 33 | |
stepwise.json | H A D | 04-Sep-2024 | 2.2 KiB | 82 | 81 | |
virtual_sensor.json | H A D | 19-Sep-2024 | 2.4 KiB | 59 | 58 |
README.md
1 # Entity manager configuration file schema 2 3 Entity manager configuration files are JSON documents and can be validated with 4 a [JSON schema][1]. This document provides an overview of the general structure 5 of an entity manager configuration file. 6 7 An entity manager configuration file consists of one or more entity manager 8 configurations. This provides flexibility for system designers - the 9 configuration data for an entire platform or set of platforms can be expressed 10 in a single file, or can be organized into several smaller files. Thus, the top 11 most schema describes a single object or an array of objects. 12 13 To remain consistent with the OpenBMC CPP source code file name guidelines, 14 entity manager configuration file and schema file names must be 15 `lower_snake_case`. 16 17 ## A single entity manager configuration 18 19 At its core entity manager simply exports objects onto DBus when a specific 20 event occurs. As such, an entity manager configuration provides a syntax for 21 describing the dbus interfaces to export, the object paths on which to add the 22 interfaces and the event that should trigger the export. This is accomplished 23 with four properties. 24 25 ## Type 26 27 The type property identifies the type of the configuration. When exported, 28 configuration data will be instantiated as grandchildren of 29 `/xyz/openbmc_project/inventory/system/<Type>`. For a comprehensive list of 30 supported types, consult the schema (global.json). 31 32 ## Name 33 34 The name property identifies the name of the configuration. When exported, 35 configuration data will be instantiated as children of 36 `/xyz/openbmc_project/inventory/system/<Type>/<Name>`. Additionally, any DBus 37 interfaces listed in openbmc-dbus.json will be added on 38 `/xyz/openbmc_project/inventory/system/<Type>/<Name>`. 39 40 ## Probe 41 42 The probe property describes the event which will cause entity manager to export 43 the configuration to DBus, making it available to other applications. 44 45 ## Exposes 46 47 The exposes property describes the configuration data at its most specific 48 level. The exposes property is an array of heterogeneous configuration data. 49 Each exposes element has its own schema which is outlined by the subschemas in 50 the schemas directory. Each schema must require a type and name (not to be 51 confused with the Type and Name properties of the parent JSON object) property 52 since entity manager will construct the Dbus interface name and object path 53 based on those properties: 54 55 `/xyz/openbmc_project/inventory/system/Board/RiserCard1/<Name>`: 56 `xyz.openbmc_project.Configuration.<Type>`: 57 `<remaining properties defined by exposes subschema>` 58 59 ## Adding new exposes property subschema 60 61 New subschema for the exposes property must be added to the schema directory, 62 and then referenced from global.json at /definitions/EMExposesElement. Exposes 63 element subschema must require a type and name property (the validator will fail 64 otherwise) and should explicitly enumerate all properties and use 65 additionalProperties so mistakes can be found during validation. 66 67 ## Adding new Dbus interfaces 68 69 To export new interfaces on the configuration parent object e.g.: 70 /xyz/openbmc_project/inventory/system/Board/RiserCard1 add additional subschema 71 to openbmc-dbus.json. 72 73 [1]: https://json-schema.org/ 74