1 /**
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 
17 #include "device.hpp"
18 
19 #include "chassis.hpp"
20 #include "error_logging_utils.hpp"
21 #include "exception_utils.hpp"
22 #include "system.hpp"
23 
24 #include <exception>
25 
26 namespace phosphor::power::regulators
27 {
28 
29 void Device::addToIDMap(IDMap& idMap)
30 {
31     // Add this device to the map
32     idMap.addDevice(*this);
33 
34     // Add rails to the map
35     for (std::unique_ptr<Rail>& rail : rails)
36     {
37         idMap.addRail(*rail);
38     }
39 }
40 
41 void Device::clearCache()
42 {
43     // If presence detection is defined for this device
44     if (presenceDetection)
45     {
46         // Clear cached presence data
47         presenceDetection->clearCache();
48     }
49 }
50 
51 void Device::close(Services& services)
52 {
53     try
54     {
55         // Close I2C interface if it is open
56         if (i2cInterface->isOpen())
57         {
58             i2cInterface->close();
59         }
60     }
61     catch (const std::exception& e)
62     {
63         // Log error messages in journal
64         services.getJournal().logError(exception_utils::getMessages(e));
65         services.getJournal().logError("Unable to close device " + id);
66 
67         // Create error log entry
68         error_logging_utils::logError(std::current_exception(),
69                                       Entry::Level::Notice, services);
70     }
71 }
72 
73 void Device::configure(Services& services, System& system, Chassis& chassis)
74 {
75     // Verify device is present
76     if (isPresent(services, system, chassis))
77     {
78         // If configuration changes are defined for this device, apply them
79         if (configuration)
80         {
81             configuration->execute(services, system, chassis, *this);
82         }
83 
84         // Configure rails
85         for (std::unique_ptr<Rail>& rail : rails)
86         {
87             rail->configure(services, system, chassis, *this);
88         }
89     }
90 }
91 
92 void Device::monitorSensors(Services& services, System& system,
93                             Chassis& chassis)
94 {
95     // Verify device is present
96     if (isPresent(services, system, chassis))
97     {
98         // Monitor sensors in each rail
99         for (std::unique_ptr<Rail>& rail : rails)
100         {
101             rail->monitorSensors(services, system, chassis, *this);
102         }
103     }
104 }
105 
106 } // namespace phosphor::power::regulators
107