xref: /openbmc/phosphor-power/phosphor-regulators/docs/config_file/chassis.md (revision 8b38b177315d40f1f9bc1e4d0784d45ea17cbd5c)
1# chassis
2
3## Description
4
5A chassis within the system.
6
7Chassis are typically a physical enclosure that contains system components such
8as CPUs, fans, power supplies, and PCIe cards. A chassis can be stand-alone,
9such as a tower or desktop. A chassis can also be designed to be mounted in an
10equipment rack.
11
12A chassis only needs to be defined in the config file if it contains regulators
13that need to be configured or monitored.
14
15## Properties
16
17| Name           | Required | Type                          | Description                                                                                                                                                                                              |
18| :------------- | :------: | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19| comments       |    no    | array of strings              | One or more comment lines describing this chassis.                                                                                                                                                       |
20| number         |   yes    | number                        | Chassis number within the system. Chassis numbers start at 1 because chassis 0 represents the entire system.                                                                                             |
21| inventory_path |   yes    | string                        | Specify the relative D-Bus inventory path of the chassis. Full inventory paths begin with the root "/xyz/openbmc_project/inventory". Specify the relative path below the root, such as "system/chassis". |
22| devices        |    no    | array of [devices](device.md) | One or more devices within the chassis. The array should contain regulator devices and any related devices required to perform regulator operations.                                                     |
23
24## Example
25
26```json
27{
28  "comments": [ "Chassis number 1 containing CPUs and memory" ],
29  "number": 1,
30  "inventory_path": "system/chassis",
31  "devices": [
32    {
33      "id": "vdd_regulator",
34      ... details omitted ...
35    },
36    {
37      "id": "vio_regulator",
38      ... details omitted ...
39    }
40  ]
41}
42```
43