1 /**
2  * Copyright © 2019 IBM Corporation
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 #pragma once
17 
18 #include "configuration.hpp"
19 #include "sensor_monitoring.hpp"
20 #include "services.hpp"
21 
22 #include <memory>
23 #include <string>
24 #include <utility>
25 
26 namespace phosphor::power::regulators
27 {
28 
29 // Forward declarations to avoid circular dependencies
30 class Chassis;
31 class Device;
32 class System;
33 
34 /**
35  * @class Rail
36  *
37  * A voltage rail produced by a voltage regulator.
38  *
39  * Voltage regulators produce one or more rails.  Each rail typically provides a
40  * different output voltage level, such as 1.1V.
41  */
42 class Rail
43 {
44   public:
45     // Specify which compiler-generated methods we want
46     Rail() = delete;
47     Rail(const Rail&) = delete;
48     Rail(Rail&&) = delete;
49     Rail& operator=(const Rail&) = delete;
50     Rail& operator=(Rail&&) = delete;
51     ~Rail() = default;
52 
53     /**
54      * Constructor.
55      *
56      * @param id unique rail ID
57      * @param configuration configuration changes to apply to this rail, if any
58      * @param sensorMonitoring sensor monitoring for this rail, if any
59      */
60     explicit Rail(
61         const std::string& id,
62         std::unique_ptr<Configuration> configuration = nullptr,
63         std::unique_ptr<SensorMonitoring> sensorMonitoring = nullptr) :
64         id{id},
65         configuration{std::move(configuration)},
66         sensorMonitoring{std::move(sensorMonitoring)}
67     {}
68 
69     /**
70      * Clears all error history.
71      *
72      * All data on previously logged errors will be deleted.  If errors occur
73      * again in the future they will be logged again.
74      *
75      * This method is normally called when the system is being powered on.
76      */
77     void clearErrorHistory();
78 
79     /**
80      * Configure this rail.
81      *
82      * Applies the configuration changes that are defined for this rail, if any.
83      *
84      * This method should be called during the boot before regulators are
85      * enabled.
86      *
87      * @param services system services like error logging and the journal
88      * @param system system that contains the chassis
89      * @param chassis chassis that contains the device
90      * @param device device that contains this rail
91      */
92     void configure(Services& services, System& system, Chassis& chassis,
93                    Device& device);
94 
95     /**
96      * Returns the configuration changes to apply to this rail, if any.
97      *
98      * @return Pointer to Configuration object.  Will equal nullptr if no
99      *         configuration changes are defined for this rail.
100      */
101     const std::unique_ptr<Configuration>& getConfiguration() const
102     {
103         return configuration;
104     }
105 
106     /**
107      * Returns the unique ID of this rail.
108      *
109      * @return rail ID
110      */
111     const std::string& getID() const
112     {
113         return id;
114     }
115 
116     /**
117      * Monitor the sensors for this rail.
118      *
119      * Sensor monitoring is optional.  If sensor monitoring is defined for this
120      * rail, the sensor values are read.
121      *
122      * This method should be called repeatedly based on a timer.
123      *
124      * @param services system services like error logging and the journal
125      * @param system system that contains the chassis
126      * @param chassis chassis that contains the device
127      * @param device device that contains this rail
128      */
129     void monitorSensors(Services& services, System& system, Chassis& chassis,
130                         Device& device);
131 
132     /**
133      * Returns the sensor monitoring for this rail, if any.
134      *
135      * @return Pointer to SensorMonitoring object.  Will equal nullptr if no
136      *         sensor monitoring is defined for this rail.
137      */
138     const std::unique_ptr<SensorMonitoring>& getSensorMonitoring() const
139     {
140         return sensorMonitoring;
141     }
142 
143   private:
144     /**
145      * Unique ID of this rail.
146      */
147     const std::string id{};
148 
149     /**
150      * Configuration changes to apply to this rail, if any.  Set to nullptr if
151      * no configuration changes are defined for this rail.
152      */
153     std::unique_ptr<Configuration> configuration{};
154 
155     /**
156      * Sensor monitoring for this rail, if any.  Set to nullptr if no sensor
157      * monitoring is defined for this rail.
158      */
159     std::unique_ptr<SensorMonitoring> sensorMonitoring{};
160 };
161 
162 } // namespace phosphor::power::regulators
163