openbmc/phosphor-fan-presence/README.md

5 - [Overview](#overview)
6 - [Building](#building)
7 - [Contents](#contents)
11 The phosphor-fan-presence repository provides a set of thermal related
29 - [Fan Control](#fan-control)
30   - To disable from building, use the `-Dcontrol-service=disabled` meson option:
32     meson build -Dcontrol-service=disabled
34 - [Fan Presence Detection](#fan-presence-detection)
35   - To disable from building, use the `-Dpresence-service=disabled` meson
38     meson build -Dpresence-service=disabled
40 - [Fan Monitoring](#fan-monitoring)
41   - To disable from building, use the `-Dmonitor-service=disabled` meson option:
43     meson build -Dmonitor-service=disabled
45 - [Sensor Monitoring](#sensor-monitoring)
46   - To disable from building, use the `-Dsensor-monitor-service=disabled` meson
49     meson build -Dsensor-monitor-service=disabled
53 - [Cooling Type](#cooling-type)
54   - To enable building this, set the `-Dcooling-type-service=enable` meson
57     meson build -Dcooling-type-service=enabled
69 configuration use the '-Djson-config=disabled' option when building:
71 1. meson build -Djson-config=disabled
72 2. ninja -C build
84 2. ninja -C build
91 - [Fan Presence Detection](#fan-presence-detection)
92   - Error logging for missing fans
93 - [Fan Monitoring](#fan-monitoring)
94   - Error logging for nonfunctional fans
95   - System power off due to missing or nonfunctional fans
96 - [Sensor Monitoring](#sensor-monitoring) - Only supports JSON
100 ### Fan Control
103 D-Bus objects and one-or-more triggers that run a configured set of actions.
107 D-Bus objects.
109 - Available meson options:
110   - `control-persist-root-path` - Base location to persist zone property states
112     - Default = '/var/lib/phosphor-fan-presence/control'
116 - Available meson options:
117   - `fan-def-yaml-file` - Build time fan configuration file
118     - Default = ['control/example/fans.yaml'](control/example/fans.yaml)
119   - `fan-zone-yaml-file` - Build time zone configuration file
120     - Default = ['control/example/zones.yaml'](control/example/zones.yaml)
121   - `fan-events-yaml-file` - Build time events configuration file
122     - Default = ['control/example/events.yaml'](control/example/events.yaml)
123   - `zone-conditions-yaml-file` Build time zone conditions configuration file
124     - Default =
133 ---
135 ### Fan Presence Detection
137 Monitors the presence state of fans using GPIOs, nonzero tach feedbacks, or a
138 combination of both. This updates a configured location of a fan D-Bus object's
140 fan's presence.
142 - Available meson options:
143   - `num-presence-log-entries` - Maximum number of entries in the message log
144     - Default = 50
148 - Available meson options:
149   - `presence-config` - Location of the config file
150     - Default = ['presence/example/example.yaml'](presence/example/example.yaml)
152 Example: [example.yaml](presence/example/example.yaml)
156 [README](docs/presence/README.md)
158 ---
160 ### Fan Monitoring
162 Monitors the functional state of fans by comparing the fan feedback speed
164 due to fan hardware properties. In addition to updating the configured location
165 of a fan D-Bus object's `Functional` property in inventory, actions can be
170 of a set of fans that may be necessary to workaround designs of the fan hardware
176 - Available meson options:
177   - `num-monitor-log-entries` - Maximum number of entries in the message log
178     - Default = 75
182 - Available meson options:
183   - `fan-monitor-yaml-file` - Location of the config file
184     - Default = ['monitor/example/monitor.yaml'](monitor/example/monitor.yaml)
192 ---
201 ---
208 - Available meson options:
209   - `sensor-monitor-persist-root-path` - Base location to persist sensor
211     - Default = '/var/lib/phosphor-fan-presence/sensor-monitor'
212   - `sensor-monitor-hard-shutdown-delay` - Milliseconds to delay the alarm hard
214     - Default = 23000
215   - `sensor-monitor-soft-shutdown-delay` - Milliseconds to delay the alarm soft
217     - Default = 900000
218   - `use-host-power-state` - Use the host state for the power state as opposed
220   - `skip-power-checking` - Skip power state checking while sending threshold
223 [README](docs/sensor-monitor/README.md)
225 ---