xref: /openbmc/phosphor-fan-presence/monitor/gen-fan-monitor-defs.py (revision 623635c62f229008400e69d6cbfdb84c12610807)
1#!/usr/bin/env python3
2
3import os
4import sys
5import yaml
6from argparse import ArgumentParser
7from mako.template import Template
8
9"""
10This script generates the data structures for the
11phosphor-fan-monitor application.
12
13A future improvement is to get the fan inventory names
14from a separate file, so just that file could be generated
15from the MRW.
16"""
17
18
19tmpl = '''\
20<%!
21def indent(str, depth):
22    return ''.join(4*' '*depth+line for line in str.splitlines(True))
23%>\
24<%def name="getCondParams(cond)" buffered="True">
25%if (cond['name'] == 'propertiesMatch'):
26std::vector<PropertyState>{
27    %for i in cond['properties']:
28    PropertyState{
29        {
30            "${i['object']}",
31            "${i['interface']}",
32            "${i['property']['name']}"
33        },
34        static_cast<${i['property']['type']}>(${str(i['property']['value']).lower()})
35    },
36    %endfor
37}
38%endif
39</%def>\
40/* This is a generated file. */
41#include "fan_defs.hpp"
42#include "types.hpp"
43#include "groups.hpp"
44#include "conditions.hpp"
45
46using namespace phosphor::fan::monitor;
47using namespace phosphor::fan::trust;
48
49const std::vector<FanDefinition> fanDefinitions
50{
51%for fan_data in data.get('fans', {}):
52    FanDefinition{"${fan_data['inventory']}",
53                  ${fan_data.get('method', {})},
54                  ${fan_data.get('functional_delay', 0)},
55                  ${fan_data.get('allowed_out_of_range_time', {})},
56                  ${fan_data['deviation']},
57                  ${fan_data['num_sensors_nonfunc_for_fan_nonfunc']},
58                  0, // Monitor start delay - not used in YAML configs
59                  0, // Count interval - not used in YAML configs
60                  std::nullopt, // nonfuncRotorErrorDelay - also not used here
61                  std::nullopt, // fanMissingErrorDelay - also not used here
62                  std::vector<SensorDefinition>{
63                  %for sensor in fan_data['sensors']:
64                  <%
65                      #has_target is a bool, and we need a true instead of True
66                      has_target = str(sensor['has_target']).lower()
67                      target_interface = sensor.get(
68                          'target_interface',
69                          'xyz.openbmc_project.Control.FanSpeed')
70                      factor = sensor.get('factor', 1)
71                      offset = sensor.get('offset', 0)
72                      threshold = sensor.get('threshold', 1)
73                  %> \
74                      SensorDefinition{"${sensor['name']}",
75                                       ${has_target},
76                                       "${target_interface}",
77                                       ${factor},
78                                       ${offset},
79                                       ${threshold}},
80                  %endfor
81                  },
82                  %if ('condition' in fan_data) and \
83                  (fan_data['condition'] is not None):
84                  make_condition(condition::${fan_data['condition']['name']}(\
85                      ${indent(getCondParams(cond=fan_data['condition']), 5)}\
86                  ))
87                  %else:
88                  {}
89                  %endif
90    },
91%endfor
92};
93
94##Function to generate the group creation lambda.
95##If a group were to ever need a different constructor,
96##it could be handled here.
97<%def name="get_lambda_contents(group)">
98            std::vector<GroupDefinition> group{
99            %for member in group['group']:
100            <%
101                in_trust = str(member.get('in_trust', "true")).lower()
102            %>
103                GroupDefinition{"${member['name']}", ${in_trust}},
104            %endfor
105            };
106            return std::make_unique<${group['class']}>(group);
107</%def>
108const std::vector<CreateGroupFunction> trustGroups
109{
110%for group in data.get('sensor_trust_groups', {}):
111    {
112        []()
113        {\
114${get_lambda_contents(group)}\
115        }
116    },
117%endfor
118};
119'''
120
121
122if __name__ == '__main__':
123    parser = ArgumentParser(
124        description="Phosphor fan monitor definition parser")
125
126    parser.add_argument('-m', '--monitor_yaml', dest='monitor_yaml',
127                        default="example/monitor.yaml",
128                        help='fan monitor definitional yaml')
129    parser.add_argument('-o', '--output_dir', dest='output_dir',
130                        default=".",
131                        help='output directory')
132    args = parser.parse_args()
133
134    if not args.monitor_yaml:
135        parser.print_usage()
136        sys.exit(1)
137
138    with open(args.monitor_yaml, 'r') as monitor_input:
139        monitor_data = yaml.safe_load(monitor_input) or {}
140
141    #Do some minor input validation
142    for fan in monitor_data.get('fans', {}):
143        if ((fan['deviation'] < 0) or (fan['deviation'] > 100)):
144            sys.exit("Invalid deviation value " + str(fan['deviation']))
145
146    output_file = os.path.join(args.output_dir, "fan_monitor_defs.cpp")
147    with open(output_file, 'w') as output:
148        output.write(Template(tmpl).render(data=monitor_data))
149