blob: 9c7f41cad008712d4d32617c33a2924e50d4a0e1 [file] [log] [blame]
Sampa Misraaea5dde2020-08-31 08:33:47 -05001#pragma once
2
3#include "common/utils.hpp"
Sagar Srinivas78a225a2020-08-27 00:52:20 -05004#include "libpldmresponder/pdr_utils.hpp"
Sampa Misraaea5dde2020-08-31 08:33:47 -05005#include "libpldmresponder/platform.hpp"
6
7#include <string>
8
Sampa Misraaea5dde2020-08-31 08:33:47 -05009namespace pldm
10{
11namespace responder
12{
13
14static constexpr uint8_t pSideNum = 1;
15static constexpr uint8_t tSideNum = 2;
16static constexpr auto Pside = "P";
17static constexpr auto Tside = "T";
18
19static constexpr auto redundancyIntf =
20 "xyz.openbmc_project.Software.RedundancyPriority";
21
22/** @class CodeUpdate
23 *
24 * @brief This class performs the necessary operation in pldm for
25 * inband code update. That includes taking actions on the
26 * setStateEffecterStates calls from Host and also sending
27 * notification to phosphor-software-manager app
28 */
29class CodeUpdate
30{
31 public:
32 /** @brief Constructor to create an inband codeupdate object
33 * @param[in] dBusIntf - D-Bus handler pointer
34 */
35 CodeUpdate(const pldm::utils::DBusHandler* dBusIntf) : dBusIntf(dBusIntf)
36 {
37 currBootSide = Tside;
38 nextBootSide = Tside;
Sampa Misra3a0e3b92020-10-21 05:58:00 -050039 markerLidSensorId = PLDM_INVALID_EFFECTER_ID;
40 firmwareUpdateSensorId = PLDM_INVALID_EFFECTER_ID;
Sagar Srinivas9a64b4a2021-02-09 07:55:38 -060041 imageActivationMatch = nullptr;
Sampa Misraaea5dde2020-08-31 08:33:47 -050042 }
43
44 /* @brief Method to return the current boot side
45 */
46 std::string fetchCurrentBootSide();
47
48 /* @brief Method to return the next boot side
49 */
50 std::string fetchNextBootSide();
51
52 /* @brief Method to set the current boot side or
53 * perform a rename operation on current boot side
54 * @param[in] currSide - current side to be set to
55 * @return PLDM_SUCCESS codes
56 */
57 int setCurrentBootSide(const std::string& currSide);
58
59 /* @brief Method to set the next boot side
60 * @param[in] nextSide - next boot side to be set to
61 * @return PLDM_SUCCESS codes
62 */
63 int setNextBootSide(const std::string& nextSide);
64
65 /* @brief Method to set the running and non-running
66 * images
67 */
68 virtual void setVersions();
69
70 /* @brief Method to return the newly upoaded image id in
71 * /tmp
72 */
73 std::string fetchnewImageId()
74 {
75 return newImageId;
76 }
77
78 /* @brief Method to set the oem platform handler in CodeUpdate class */
79 void setOemPlatformHandler(pldm::responder::oem_platform::Handler* handler);
80
Sampa Misra69508502020-09-08 00:08:21 -050081 /* @brief Method to check whether code update is
82 * going on
83 * @return - bool
84 */
85 bool isCodeUpdateInProgress()
86 {
87 return codeUpdateInProgress;
88 }
89
90 /* @brief Method to indicate whether code update
91 * is going on
92 * @param[in] progress - yes/no
93 */
94 void setCodeUpdateProgress(bool progress)
95 {
96 codeUpdateInProgress = progress;
97 }
98
Varsha Kaverappa3ca29df2020-09-27 12:39:22 -050099 /** @brief Method to clear contents the LID staging directory that contains
100 * images such as host firmware and BMC.
101 * @param[in] dirPath - directory system path that has to be cleared
102 * @return none
103 */
104 void clearDirPath(const std::string& dirPath);
105
Sagar Srinivascfdbca72020-09-22 10:03:35 -0500106 /* @brief Method to set the RequestApplyTime D-Bus property
107 * on start update to OnReset
108 * @return - Completion codes
109 */
110 int setRequestedApplyTime();
111
112 /* @brief Method to set the RequestedActivation D-Bus property
113 * on end update to Active by fetching the newImageID and
114 * clearning it once RequestedActivation is set or on error
115 * @param[in] codeUpdate - codeUpdate pointer
116 * @return - Completion codes
117 */
118 int setRequestedActivation();
119
Sampa Misra3a0e3b92020-10-21 05:58:00 -0500120 /* @brief Method to fetch the sensor id for marker lid
121 * validation PDR
122 * @return - sensor id
123 */
124 uint16_t getMarkerLidSensor()
125 {
126 return markerLidSensorId;
127 }
128
129 /* @brief Method to set the sensor id for marker lid
130 * validation
131 * @param[in] sensorId - sensor id for marker lid validation
132 */
133 void setMarkerLidSensor(uint16_t sensorId)
134 {
135 markerLidSensorId = sensorId;
136 }
137
138 /* @brief Method to set the sensor id for firmware update state
139 * @param[in] sensorId - sensor id for firmware update state
140 */
141 void setFirmwareUpdateSensor(uint16_t sensorId)
142 {
143 firmwareUpdateSensorId = sensorId;
144 }
145
146 /* @brief Method to fetch the sensor id for firmware update state
147 * @return - sensor id
148 */
149 uint16_t getFirmwareUpdateSensor()
150 {
151 return firmwareUpdateSensorId;
152 }
153
154 /* @brief Method to send a state sensor event to Host from CodeUpdate class
155 * @param[in] sensorId - sensor id for the event
156 * @param[in] sensorEventClass - sensor event class wrt DSP0248
157 * @param[in] sensorOffset - sensor offset
158 * @param[in] eventState - new event state
159 * @param[in] prevEventState - previous state
160 */
161 void sendStateSensorEvent(uint16_t sensorId,
162 enum sensor_event_class_states sensorEventClass,
163 uint8_t sensorOffset, uint8_t eventState,
164 uint8_t prevEventState);
165
166 /* @brief Method to delete the image from non running side prior to
167 * an inband code update
168 */
169 void deleteImage();
170
Adriana Kobylak9296f242021-09-22 15:52:00 +0000171 /** @brief Method to assemble the code update tarball and trigger the
172 * phosphor software manager to create a version interface
173 * @return - PLDM_SUCCESS codes
174 */
175 int assembleCodeUpdateImage();
176
Sampa Misraaea5dde2020-08-31 08:33:47 -0500177 virtual ~CodeUpdate()
178 {}
179
180 private:
181 std::string currBootSide; //!< current boot side
182 std::string nextBootSide; //!< next boot side
183 std::string runningVersion; //!< currently running image
184 std::string nonRunningVersion; //!< alternate image
185 std::string newImageId; //!< new image id
186 bool codeUpdateInProgress =
187 false; //!< indicates whether codeupdate is going on
188 const pldm::utils::DBusHandler* dBusIntf; //!< D-Bus handler
Patrick Williams84b790c2022-07-22 19:26:56 -0500189 std::vector<std::unique_ptr<sdbusplus::bus::match_t>>
Sampa Misraaea5dde2020-08-31 08:33:47 -0500190 captureNextBootSideChange; //!< vector to catch the D-Bus property
191 //!< change for next boot side
Patrick Williams84b790c2022-07-22 19:26:56 -0500192 std::vector<std::unique_ptr<sdbusplus::bus::match_t>>
Sampa Misraaea5dde2020-08-31 08:33:47 -0500193 fwUpdateMatcher; //!< pointer to capture the interface added signal for
194 //!< new image
195 pldm::responder::oem_platform::Handler*
196 oemPlatformHandler; //!< oem platform handler
Sampa Misra3a0e3b92020-10-21 05:58:00 -0500197 uint16_t markerLidSensorId;
198 uint16_t firmwareUpdateSensorId;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500199
Sagar Srinivas9a64b4a2021-02-09 07:55:38 -0600200 /** @brief D-Bus property changed signal match for image activation */
Patrick Williams84b790c2022-07-22 19:26:56 -0500201 std::unique_ptr<sdbusplus::bus::match_t> imageActivationMatch;
Sagar Srinivas9a64b4a2021-02-09 07:55:38 -0600202
Sampa Misraaea5dde2020-08-31 08:33:47 -0500203 /* @brief Method to take action when the subscribed D-Bus property is
204 * changed
205 * @param[in] chProperties - list of properties which have changed
206 * @return - none
207 */
Brad Bishop5079ac42021-08-19 18:35:06 -0400208 void processPriorityChangeNotification(
209 const pldm::utils::DbusChangedProps& chProperties);
Sampa Misraaea5dde2020-08-31 08:33:47 -0500210};
211
212/* @brief Method to fetch current or next boot side
213 * @param[in] entityInstance - entity instance for the sensor
214 * @param[in] codeUpdate - pointer to the CodeUpdate object
215 *
216 * @return - boot side
217 */
218uint8_t fetchBootSide(uint16_t entityInstance, CodeUpdate* codeUpdate);
219
220/* @brief Method to set current or next boot side
221 * @param[in] entityInstance - entity instance for the effecter
222 * @param[in] currState - state to be set
223 * @param[in] stateField - state field set as sent by Host
224 * @return - PLDM_SUCCESS codes
225 */
226int setBootSide(uint16_t entityInstance, uint8_t currState,
227 const std::vector<set_effecter_state_field>& stateField,
228 CodeUpdate* codeUpdate);
229
Adriana Kobylak727f7382020-09-01 14:38:25 -0500230/* @brief Method to process LIDs during inband update, such as verifying and
231 * removing the header to get them ready to be written to flash
232 * @param[in] filePath - Path to the LID file
233 * @return - PLDM_SUCCESS codes
234 */
235int processCodeUpdateLid(const std::string& filePath);
Adriana Kobylak837fb472020-10-16 16:53:42 -0500236
Sampa Misraaea5dde2020-08-31 08:33:47 -0500237} // namespace responder
238} // namespace pldm