blob: d794525530a0b0ec731eb02cc9200dcce0f656ab [file] [log] [blame]
Patrick Ventured8012182018-03-08 08:21:38 -08001/**
2 * Copyright 2017 Google Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "thermalcontroller.hpp"
Patrick Ventureda4a5dd2018-08-31 09:42:48 -070018
James Feist734f9532018-11-15 12:13:18 -080019#include "errors/exception.hpp"
Patrick Ventured8012182018-03-08 08:21:38 -080020#include "util.hpp"
21#include "zone.hpp"
22
Patrick Venturee94bdc42018-11-15 18:41:21 -080023#include <algorithm>
24
25ThermalType getThermalType(const std::string& typeString)
26{
27 /* Currently it only supports the two types. */
28 return (typeString == "temp") ? ThermalType::absolute : ThermalType::margin;
29}
30
31bool isThermalType(const std::string& typeString)
32{
33 static const std::vector<std::string> thermalTypes = {"temp", "margin"};
34 return std::count(thermalTypes.begin(), thermalTypes.end(), typeString);
35}
36
Patrick Venture563a3562018-10-30 09:31:26 -070037std::unique_ptr<PIDController> ThermalController::createThermalPid(
Patrick Ventureda4a5dd2018-08-31 09:42:48 -070038 ZoneInterface* owner, const std::string& id,
Patrick Venture5f59c0f2018-11-11 12:55:14 -080039 const std::vector<std::string>& inputs, double setpoint,
James Feist734f9532018-11-15 12:13:18 -080040 const ec::pidinfo& initial, const ThermalType& type)
Patrick Ventured8012182018-03-08 08:21:38 -080041{
James Feist734f9532018-11-15 12:13:18 -080042 // ThermalController requires at least 1 input
43 if (inputs.empty())
Patrick Venture3349ef22018-06-12 14:09:29 -070044 {
James Feist734f9532018-11-15 12:13:18 -080045 throw ControllerBuildException("Thermal controller missing inputs");
Patrick Venture3349ef22018-06-12 14:09:29 -070046 return nullptr;
47 }
48
James Feist734f9532018-11-15 12:13:18 -080049 auto thermal = std::make_unique<ThermalController>(id, inputs, type, owner);
Patrick Ventured8012182018-03-08 08:21:38 -080050
Patrick Venture563a3562018-10-30 09:31:26 -070051 ec::pid_info_t* info = thermal->getPIDInfo();
52 thermal->setSetpoint(setpoint);
Patrick Ventured8012182018-03-08 08:21:38 -080053
Patrick Venture7af157b2018-10-30 11:24:40 -070054 initializePIDStruct(info, initial);
Patrick Ventured8012182018-03-08 08:21:38 -080055
56 return thermal;
57}
58
Patrick Venture5f59c0f2018-11-11 12:55:14 -080059// bmc_host_sensor_value_double
60double ThermalController::inputProc(void)
Patrick Ventured8012182018-03-08 08:21:38 -080061{
James Feist734f9532018-11-15 12:13:18 -080062 double value;
63 const double& (*compare)(const double&, const double&);
64 if (type == ThermalType::margin)
65 {
66 value = std::numeric_limits<double>::max();
67 compare = std::min<double>;
68 }
69 else
70 {
71 value = std::numeric_limits<double>::lowest();
72 compare = std::max<double>;
73 }
74
75 for (const auto& in : _inputs)
76 {
77 value = compare(value, _owner->getCachedValue(in));
78 }
79
Patrick Venture5f59c0f2018-11-11 12:55:14 -080080 return value;
Patrick Ventured8012182018-03-08 08:21:38 -080081}
82
83// bmc_get_setpt
Patrick Venture5f59c0f2018-11-11 12:55:14 -080084double ThermalController::setptProc(void)
Patrick Ventured8012182018-03-08 08:21:38 -080085{
Patrick Venture5f59c0f2018-11-11 12:55:14 -080086 double setpoint = getSetpoint();
Patrick Ventured8012182018-03-08 08:21:38 -080087
88 /* TODO(venture): Thermal setpoint invalid? */
89#if 0
90 if (-1 == setpoint)
91 {
92 return 0.0f;
93 }
94 else
95 {
96 return setpoint;
97 }
98#endif
99 return setpoint;
100}
101
102// bmc_set_pid_output
Patrick Venture5f59c0f2018-11-11 12:55:14 -0800103void ThermalController::outputProc(double value)
Patrick Ventured8012182018-03-08 08:21:38 -0800104{
105 _owner->addRPMSetPoint(value);
106
107 return;
108}