blob: 0ba4154519ba6e460824bc54e7f56868d3b149f4 [file] [log] [blame]
Shawn McCarney8a3afd72020-03-12 14:28:44 -05001/**
2 * Copyright © 2020 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 "device.hpp"
Shawn McCarneydb0b8332020-04-06 14:13:04 -050019#include "id_map.hpp"
Bob King23243f82020-07-29 10:38:57 +080020#include "services.hpp"
Shawn McCarney8a3afd72020-03-12 14:28:44 -050021
22#include <memory>
23#include <stdexcept>
24#include <string>
25#include <utility>
26#include <vector>
27
28namespace phosphor::power::regulators
29{
30
Shawn McCarney525e20c2020-04-14 11:05:39 -050031// Forward declarations to avoid circular dependencies
32class System;
33
Shawn McCarney8a3afd72020-03-12 14:28:44 -050034/**
35 * @class Chassis
36 *
37 * A chassis within the system.
38 *
39 * Chassis are large enclosures that can be independently powered off and on by
40 * the BMC. Small and mid-sized systems may contain a single chassis. In a
41 * large rack-mounted system, each drawer may correspond to a chassis.
42 *
43 * A C++ Chassis object only needs to be created if the physical chassis
44 * contains regulators that need to be configured or monitored.
45 */
46class Chassis
47{
48 public:
49 // Specify which compiler-generated methods we want
50 Chassis() = delete;
51 Chassis(const Chassis&) = delete;
52 Chassis(Chassis&&) = delete;
53 Chassis& operator=(const Chassis&) = delete;
54 Chassis& operator=(Chassis&&) = delete;
55 ~Chassis() = default;
56
57 /**
58 * Constructor.
59 *
60 * Throws an exception if any of the input parameters are invalid.
61 *
62 * @param number Chassis number within the system. Chassis numbers start at
63 * 1 because chassis 0 represents the entire system.
Shawn McCarneycb3f6a62021-04-30 10:54:30 -050064 * @param inventoryPath D-Bus inventory path for this chassis
Shawn McCarney8a3afd72020-03-12 14:28:44 -050065 * @param devices Devices within this chassis, if any. The vector should
66 * contain regulator devices and any related devices required
67 * to perform regulator operations.
68 */
Shawn McCarneycb3f6a62021-04-30 10:54:30 -050069 explicit Chassis(unsigned int number, const std::string& inventoryPath,
Shawn McCarney8a3afd72020-03-12 14:28:44 -050070 std::vector<std::unique_ptr<Device>> devices =
71 std::vector<std::unique_ptr<Device>>{}) :
72 number{number},
Shawn McCarneycb3f6a62021-04-30 10:54:30 -050073 inventoryPath{inventoryPath}, devices{std::move(devices)}
Shawn McCarney8a3afd72020-03-12 14:28:44 -050074 {
75 if (number < 1)
76 {
77 throw std::invalid_argument{"Invalid chassis number: " +
78 std::to_string(number)};
79 }
80 }
81
82 /**
Shawn McCarneydb0b8332020-04-06 14:13:04 -050083 * Adds the Device and Rail objects in this chassis to the specified IDMap.
84 *
85 * @param idMap mapping from IDs to the associated Device/Rail/Rule objects
86 */
87 void addToIDMap(IDMap& idMap);
88
89 /**
Shawn McCarney9bd94d32021-01-25 19:40:42 -060090 * Clear any cached data about hardware devices.
91 */
92 void clearCache();
93
94 /**
Shawn McCarney9f3e54e2021-05-14 14:56:13 -050095 * Clears all error history.
96 *
97 * All data on previously logged errors will be deleted. If errors occur
98 * again in the future they will be logged again.
99 *
100 * This method is normally called when the system is being powered on.
101 */
102 void clearErrorHistory();
103
104 /**
Shawn McCarney050531f2020-06-02 14:17:12 -0500105 * Close the devices within this chassis, if any.
Bob Kingd692d6d2020-09-14 13:42:57 +0800106 *
107 * @param services system services like error logging and the journal
Shawn McCarney050531f2020-06-02 14:17:12 -0500108 */
Bob Kingd692d6d2020-09-14 13:42:57 +0800109 void closeDevices(Services& services);
Shawn McCarney050531f2020-06-02 14:17:12 -0500110
111 /**
Shawn McCarney525e20c2020-04-14 11:05:39 -0500112 * Configure the devices within this chassis, if any.
113 *
114 * This method should be called during the boot before regulators are
115 * enabled.
116 *
Bob King23243f82020-07-29 10:38:57 +0800117 * @param services system services like error logging and the journal
Shawn McCarney525e20c2020-04-14 11:05:39 -0500118 * @param system system that contains this chassis
119 */
Bob King23243f82020-07-29 10:38:57 +0800120 void configure(Services& services, System& system);
Shawn McCarney525e20c2020-04-14 11:05:39 -0500121
122 /**
Shawn McCarney8a3afd72020-03-12 14:28:44 -0500123 * Returns the devices within this chassis, if any.
124 *
125 * The vector contains regulator devices and any related devices
126 * required to perform regulator operations.
127 *
128 * @return devices in chassis
129 */
130 const std::vector<std::unique_ptr<Device>>& getDevices() const
131 {
132 return devices;
133 }
134
135 /**
Shawn McCarneycb3f6a62021-04-30 10:54:30 -0500136 * Returns the D-Bus inventory path for this chassis.
137 *
138 * @return inventory path
139 */
140 const std::string& getInventoryPath() const
141 {
142 return inventoryPath;
143 }
144
145 /**
Shawn McCarney8a3afd72020-03-12 14:28:44 -0500146 * Returns the chassis number within the system.
147 *
148 * @return chassis number
149 */
150 unsigned int getNumber() const
151 {
152 return number;
153 }
154
Bob Kinga2c81a62020-07-08 13:31:16 +0800155 /**
156 * Monitors the sensors for the voltage rails produced by this chassis, if
157 * any.
158 *
159 * This method should be called once per second.
160 *
Bob King8a552922020-08-05 17:02:31 +0800161 * @param services system services like error logging and the journal
Bob Kinga2c81a62020-07-08 13:31:16 +0800162 * @param system system that contains the chassis
163 */
Bob King8a552922020-08-05 17:02:31 +0800164 void monitorSensors(Services& services, System& system);
Bob Kinga2c81a62020-07-08 13:31:16 +0800165
Shawn McCarney8a3afd72020-03-12 14:28:44 -0500166 private:
167 /**
168 * Chassis number within the system.
169 *
170 * Chassis numbers start at 1 because chassis 0 represents the entire
171 * system.
172 */
173 const unsigned int number{};
174
175 /**
Shawn McCarneycb3f6a62021-04-30 10:54:30 -0500176 * D-Bus inventory path for this chassis.
177 */
178 const std::string inventoryPath{};
179
180 /**
Shawn McCarney8a3afd72020-03-12 14:28:44 -0500181 * Devices within this chassis, if any.
182 *
183 * The vector contains regulator devices and any related devices
184 * required to perform regulator operations.
185 */
186 std::vector<std::unique_ptr<Device>> devices{};
187};
188
189} // namespace phosphor::power::regulators