tree: 294ce13b6b1a5954b4e667a998ac435ce73f40ad [path history] [tgz]
  1. config_file.md
  2. gpio.md
  3. rail.md
  4. README.md
phosphor-power-sequencer/docs/config_file/README.md

phosphor-power-sequencer Configuration File

Table of Contents

Overview

The phosphor-power-sequencer configuration file (config file) contains information about the power sequencer device within a system. This device is responsible for enabling the voltage rails in order and monitoring them for pgood faults.

The information in the config file is used to determine which voltage rail caused a pgood fault.

The config file is optional. If no file is found, the application will log a general error when a pgood fault occurs. No specific rail will be identified.

Data Format

The config file is a text file in the JSON (JavaScript Object Notation) data format.

Name

The config file name is based on the system type that it supports.

A config file is normally system-specific. Each system type usually has a different set of voltage rails and GPIOs.

The system type is obtained from a D-Bus Chassis object created by the Entity Manager application. The object must implement the xyz.openbmc_project.Inventory.Decorator.Compatible interface.

The Names property of this interface contains a list of one or more compatible system types. The types are ordered from most specific to least specific.

Example:

  • com.ibm.Hardware.Chassis.Model.Rainier4U
  • com.ibm.Hardware.Chassis.Model.Rainier

The phosphor-power-sequencer application converts each compatible system type into a config file name by adding a .json suffix.

Example:

  • com.ibm.Hardware.Chassis.Model.Rainier.json

The application searches for a config file that exists with one of these file names. It searches from most specific to least specific. The first config file found, if any, will be used.

Contents

The config file contains a single JSON config_file object at the root level. That object contains arrays of other JSON objects.

Installation

The config file is installed in the /usr/share/phosphor-power-sequencer directory on the BMC.