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