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