docs/control/README.md

1 # Fan Control Configuration File
5 - [Overview](#overview)
6 - [Data Format](#data-format)
7 - [System Config Location](#system-config-location)
8 - [Contents](#contents)
9 - [Validation](#validation)
10 - [Firmware Updates](#firmware-updates)
11 - [Loading and Reloading](#loading-and-reloading)
12 - [Debug](#debug)
16 The `phosphor-fan-control` application is comprised of as set of configuration
26 ## System Config Location
30 - `manager.json`
31 - `profiles.json`
32 - `fans.json`
33 - `zones.json`
34 - `groups.json`
35 - `events.json`
39 `/usr/share/phosphor-fan-presence/control/`
41 The supported version of the config files are installed under this read-only
48 Where a single set of config files for 1-or-more system types can be used, the
52 `/usr/share/phosphor-fan-presence/control/manager.json`
53 `/usr/share/phosphor-fan-presence/control/profiles.json`
54 `/usr/share/phosphor-fan-presence/control/fans.json`
55 `/usr/share/phosphor-fan-presence/control/zones.json`
56 `/usr/share/phosphor-fan-presence/control/groups.json`
57 `/usr/share/phosphor-fan-presence/control/events.json`
59 #### Compatible System Type Location
61 The config files location can also be based on a system type. This is necessary
63 and those system types can not share any one common config file.
65 A system type sub-directory can be obtained from the
66 `Inventory.Decorator.Compatible` D-Bus interface's `Names` property. The
67 property holds a list of one or more compatible system types.
71 - `com.ampere.Hardware.Chassis.Model.MtJade`
72 - `com.ampere.Hardware.Chassis.Model.MtMitchell`
74 The `phosphor-fan-control` application then traverses the supported directory,
75 appending each compatible system type entry as a sub-directory on each config
80 1. `/usr/share/phosphor-fan-presence/control/com.ampere.Hardware.Chassis.Model.MtJade/`
81    - (directory/config file does not exist)
82 2. `/usr/share/phosphor-fan-presence/control/com.ampere.Hardware.Chassis.Model.MtMitchell/events.js…
83    - (config file found)
86 is logged and `phosphor-fan-control` application terminates preventing the
91 `/etc/phosphor-fan-presence/control/`
102 `mkdir -p /etc/phosphor-fan-presence/control`
106 The `phosphor-fan-control` application will search for each config file at the
111    - Default location
112    - Compatible System Type location
121 system.
129         "target_interface": "xyz.openbmc_project.Control.FanSpeed"
159 consist of one or more D-Bus object paths and a name.
166        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan0",
167        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan1",
168        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan2",
169        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan3",
170        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan4",
171        "/xyz/openbmc_project/inventory/system/chassis/motherboard/fan5"
182 This file contains the fan control events, where each event can contain groups,
242 <https://github.com/openbmc/phosphor-fan-presence/blob/master/docs/control/fanctl/README.md>
260 The config files are loaded when the `phosphor-fan-control` application starts.
265 `systemctl kill -s HUP phosphor-fan-control@0.service`
269 `journalctl -u phosphor-fan-control@0.service | grep Loading`
273 Fan control maintains internal data structures that can be be dumped at runtime.