docs/config_file/README.md

1 # phosphor-power-sequencer Configuration File
5 - [Overview](#overview)
6 - [Data Format](#data-format)
7 - [Name](#name)
8 - [Contents](#contents)
9 - [Installation](#installation)
13 The `phosphor-power-sequencer` application is controlled by a configuration file
17 This information is used to power the system on/off, detect
24 - Assume this is a single chassis system.
25 - Assume the standard [GPIO names](../named_gpios.md) are used to power the
26   system on/off and detect pgood faults.
27 - Log a general error if a pgood fault occurs. No specific voltage rail will be
39 A config file is normally system-specific. Each system type usually has a
42 The system type is obtained from a D-Bus Chassis object created by the
43 [Entity Manager](https://github.com/openbmc/entity-manager) application. The
52 - `com.acme.Hardware.Chassis.Model.MegaServer4CPU`
53 - `com.acme.Hardware.Chassis.Model.MegaServer`
54 - `com.acme.Hardware.Chassis.Model.Server`
56 The `phosphor-power-sequencer` application searches for a config file name that
63 - The complete compatible system type plus a '.json' suffix
64 - The last node of the compatible system type plus a '.json' suffix
68 - `com.acme.Hardware.Chassis.Model.MegaServer4CPU.json`
69 - `MegaServer4CPU.json`
74 the root level. That object contains arrays of other JSON objects.
82 `phosphor-power-sequencer` application.
92              "Controls/monitors rails 0-15."]
108 The config file is installed in the `/usr/share/phosphor-power-sequencer`