1# chassis
2
3## Description
4
5A chassis within the system.
6
7Chassis are large enclosures that can be independently powered off and on by the
8BMC. Small and mid-sized systems may contain a single chassis. In a large
9rack-mounted system, each drawer may correspond to a chassis.
10
11A chassis only needs to be defined in the config file if it contains regulators
12that need to be configured or monitored.
13
14## Properties
15
16| Name           | Required | Type                          | Description                                                                                                                                                                                              |
17| :------------- | :------: | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18| comments       |    no    | array of strings              | One or more comment lines describing this chassis.                                                                                                                                                       |
19| number         |   yes    | number                        | Chassis number within the system. Chassis numbers start at 1 because chassis 0 represents the entire system.                                                                                             |
20| 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". |
21| 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.                                                     |
22
23## Example
24
25```
26{
27  "comments": [ "Chassis number 1 containing CPUs and memory" ],
28  "number": 1,
29  "inventory_path": "system/chassis",
30  "devices": [
31    {
32      "id": "vdd_regulator",
33      ... details omitted ...
34    },
35    {
36      "id": "vio_regulator",
37      ... details omitted ...
38    }
39  ]
40}
41```
42