xref: /openbmc/phosphor-fan-presence/control/example/fans.yaml (revision 44872b07392236c5aed8667c00bebbc2ea099a89)
177d32d1bSMatt Spinler#Example fan definitions for phosphor-fan-control
277d32d1bSMatt Spinler
377d32d1bSMatt Spinler#List all fans that need to be known to phosphor-fan-control.
477d32d1bSMatt Spinler#For each fan, the inventory path, cooling zone, cooling zone
577d32d1bSMatt Spinler#profile, and sensor name(s).
677d32d1bSMatt Spinler
777d32d1bSMatt Spinler#fans:
877d32d1bSMatt Spinler# - inventory: [The system inventory location for the fan]
977d32d1bSMatt Spinler#   cooling_zone: [The cooling zone number for the fan]
1077d32d1bSMatt Spinler#   cooling_profile: [The cooling profile for the fan]
1177d32d1bSMatt Spinler#   sensors: [The list of sensors for this fan]
12069e4405SLei YU#   target_interface: [The interface implemented by the fan target.
13069e4405SLei YU#                      Default is xyz.openbmc_project.Control.FanSpeed]
14*44872b07SChau Ly#   target_path: [The relative target path, which implements
15*44872b07SChau Ly#                 xyz.openbmc_project.Control.FanSpeed or
16*44872b07SChau Ly#                 xyz.openbmc_project.Control.FanPwm interface.
17*44872b07SChau Ly#                 Default is /xyz/openbmc_project/sensors/fan_tach/]
1877d32d1bSMatt Spinler
1977d32d1bSMatt Spinler#The cooling zone, a number, and the cooling profile, a string,
2077d32d1bSMatt Spinler#have to match the corresponding values in the fan zone yaml
2177d32d1bSMatt Spinler#so the fans can be merged into the zone definition.
2277d32d1bSMatt Spinler
23069e4405SLei YU#Example entries for 2 fan system where fan0 uses default FanSpeed and
24069e4405SLei YU#fan1 uses FanPwm:
2577d32d1bSMatt Spinler#fans:
2677d32d1bSMatt Spinler#  - inventory: /system/chassis/motherboard/fan0
2777d32d1bSMatt Spinler#    cooling_zone: 0
2877d32d1bSMatt Spinler#    cooling_profile: all
2977d32d1bSMatt Spinler#    sensors:
3077d32d1bSMatt Spinler#     - fan0
3177d32d1bSMatt Spinler#  - inventory: /system/chassis/motherboard/fan1
3277d32d1bSMatt Spinler#    cooling_zone: 0
3377d32d1bSMatt Spinler#    cooling_profile: air
3477d32d1bSMatt Spinler#    sensors:
3577d32d1bSMatt Spinler#     - fan1
36069e4405SLei YU#    target_interface: xyz.openbmc_project.Control.FanPwm
37*44872b07SChau Ly#    target_path: /xyz/openbmc_project/control/fanpwm/
38