Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 1 | // SPDX-License-Identifier: Apache-2.0 |
| 2 | // Copyright (C) 2018 IBM Corp. |
| 3 | |
| 4 | #include "config.h" |
| 5 | |
| 6 | #include "hiomap.hpp" |
| 7 | |
| 8 | #include <endian.h> |
| 9 | #include <host-ipmid/ipmid-api.h> |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 10 | #include <signal.h> |
| 11 | #include <string.h> |
| 12 | #include <systemd/sd-bus.h> |
| 13 | #include <systemd/sd-event.h> |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 14 | |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 15 | #include <cassert> |
Patrick Venture | ee70196 | 2018-10-31 14:51:37 -0700 | [diff] [blame] | 16 | #include <cstring> |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 17 | #include <fstream> |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 18 | #include <functional> |
| 19 | #include <host-ipmid/ipmid-host-cmd-utils.hpp> |
| 20 | #include <host-ipmid/ipmid-host-cmd.hpp> |
| 21 | #include <iostream> |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 22 | #include <ipmid/api.hpp> |
Patrick Venture | ee70196 | 2018-10-31 14:51:37 -0700 | [diff] [blame] | 23 | #include <map> |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 24 | #include <phosphor-logging/log.hpp> |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 25 | #include <sdbusplus/bus.hpp> |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 26 | #include <sdbusplus/bus/match.hpp> |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 27 | #include <sdbusplus/exception.hpp> |
Patrick Venture | ee70196 | 2018-10-31 14:51:37 -0700 | [diff] [blame] | 28 | #include <string> |
| 29 | #include <tuple> |
| 30 | #include <utility> |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 31 | |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 32 | /* |
| 33 | |
| 34 | Design and integration notes |
| 35 | ============================ |
| 36 | |
| 37 | The primary motivation of the Host I/O Mapping protocol (HIOMAP) is to mediate |
| 38 | host access to a BMC-controlled flash chip housing the host's boot firmware. |
| 39 | |
| 40 | openpower-host-ipmi-flash facilitates the system design of transporting the |
| 41 | HIOMAP protocol[1] over IPMI. This is somewhat abusive of IPMI, basically |
| 42 | treating the BT interface as a mailbox with an interrupt each way between the |
| 43 | BMC and the host. |
| 44 | |
| 45 | [1] https://github.com/openbmc/mboxbridge/blob/master/Documentation/protocol.md |
| 46 | |
| 47 | Using IPMI in this way has a number of challenges, a lot of them on the host |
| 48 | side where we need to bring up the LPC and BT interfaces to enable IPMI before |
| 49 | accessing the flash, and before any interrupts are enabled. There are also |
| 50 | challenges on the BMC side with the design of the current implementation. We |
| 51 | will cover those here. |
| 52 | |
| 53 | BMC-side System Design and Integration Issues |
| 54 | --------------------------------------------- |
| 55 | |
| 56 | The current design is that we have the HIOMAP daemon, mboxd (to be renamed), |
| 57 | exposing a set of DBus interfaces. Whilst the spec defines the IPMI transport |
| 58 | message packing, mboxd knows nothing of IPMI itself, instead relying on the |
| 59 | DBus interface to receive messages from ipmid. ipmid in-turn knows nothing of |
| 60 | the interfaces communicating with it, also relying on DBus to receive messages |
| 61 | from interface-specific daemons, e.g. btbridged[2]. |
| 62 | |
| 63 | [2] https://github.com/openbmc/btbridge |
| 64 | |
| 65 | For this design to function correctly we must ensure that the daemons are |
| 66 | started and shut down in a reasonable order, however defining that order is |
| 67 | somewhat tricky: |
| 68 | |
| 69 | 1. systemd uses Wants=/Before=/After= relationships in units to define both |
| 70 | start-up *and* shutdown order, in stack push / pop order respectively. |
| 71 | 2. Clearly ipmid depends on btbridged to receive messages sent by signals and |
| 72 | replied to by method calls, so it needs a Wants=/After= relationship on |
| 73 | btbridged |
| 74 | 3. mboxd depends on ipmid to receive messages sent by method call, and issues a |
| 75 | PropertiesChanged signal to notify of state changes. |
| 76 | |
| 77 | Point 3. suggests mboxd should have a Wants=/Before= relationship with ipmid to |
| 78 | ensure ipmid can call into mboxd as messages arrive. However, this causes some |
| 79 | grief with shutdown of the BMC, as mboxd needs to issue a state-change |
| 80 | notification when it is shut down to inform the host that will not repsond to |
| 81 | future requests and that the protocol state has been reset. If mboxd has a |
| 82 | Wants=/Before= relationship with ipmid this message will never propagate to the |
| 83 | host, as ipmid will be shut by systemd before mboxd. |
| 84 | |
| 85 | The above leads to mboxd having a Wants=/After= relationship with ipmid. This |
| 86 | ensures that if mboxd is restarted on its own the correct state changes will be |
| 87 | propagated to the host. The case where ipmid attempts to call into mboxd's DBus |
| 88 | interface before mboxd is ready is mitigated by the ready bit in the protocol's |
| 89 | BMC status, which will not yet be set, preventing a conforming host from |
| 90 | attempting to contact mboxd. |
| 91 | |
| 92 | While this ordering prevents mboxd from being terminated before ipmid, there is |
| 93 | no control over the *scheduling* of processes to ensure the PropertiesChanged |
| 94 | signal emitted by mboxd before mboxd is terminated is seen by ipmid before |
| 95 | *ipmid* is also terminated. This leads to our first implementation wart: |
| 96 | |
| 97 | On the basis that mboxd has a Wants=/After= relationship with ipmid, |
| 98 | openpower-host-ipmi-flash will emit an HIOMAP BMC status event to the host |
| 99 | with the value BMC_EVENT_PROTOCOL_RESET upon receiving SIGTERM iff the BMC |
| 100 | state is not already set to BMC_EVENT_PROTOCOL_RESET. |
| 101 | |
| 102 | If ipmid has received SIGTERM the assumption is that it is systemd that is |
| 103 | sending it, and that the Wants=/After= relationship requires that mboxd has |
| 104 | been terminated before ipmid receives SIGTERM. By ensuring |
| 105 | openpower-host-ipmi-flash emits the BMC event state we close the race where the |
| 106 | host is not informed of the termination of mboxd due to scheduling ipmid (to |
| 107 | deliver SIGTERM) prior to scheduling dbus-daemon, where the PropertiesChanged |
| 108 | event would be delivered from mboxd to ipmid. |
| 109 | |
| 110 | Observations on the IPMI Specification and Design Details of ipmid |
| 111 | ------------------------------------------------------------------ |
| 112 | |
| 113 | In addition to the system-level design problems with delivering |
| 114 | PropertiesChanged signals during shutdown, IPMI specification and ipmid design |
| 115 | issues exist that make it tedious to ensure that events will be correctly |
| 116 | delivered to the host. |
| 117 | |
| 118 | The first necessary observation is that the mechanism for delivering BMC state |
| 119 | change events from mboxd to the host over IPMI uses the SMS ATN bit to indicate |
| 120 | a message is ready for delivery from the BMC to the host system. Retrieving the |
| 121 | BMC state data involves the host recognising that the SMS ATN bit is set, |
| 122 | performing Get Message Flags transaction with the BMC followed by a subsequent |
| 123 | Get Message transaction. Thus, delivery of the HIOMAP protocol's BMC status is |
| 124 | not an atomic event. |
| 125 | |
| 126 | The second necessary observation is that the kernel delivers signals |
| 127 | asynchronously. This couples badly with IPMI's event delivery not being atomic: |
| 128 | ipmid can win the race against SIGTERM to receive the PropertiesChanged event |
| 129 | from mboxd, but lose the race to complete delivery to the host. |
| 130 | |
| 131 | On this basis, we need to block the delivery of SIGTERM to ipmid until ipmid |
| 132 | has completed the set of `SMS ATN`/`Get Message Flags`/`Get Message` |
| 133 | transactions with the host |
| 134 | |
| 135 | One approach to this would be to configure a custom SIGTERM handler that sets |
| 136 | some global application state to indicate that SIGTERM has been delivered. A |
| 137 | better approach that avoids the need for global application state is to simply |
| 138 | block the signal until we are ready to handle it, which we can do via |
| 139 | sigprocmask(2). |
| 140 | |
| 141 | The existing design of ipmid makes it feasible to block and unblock |
| 142 | asynchronous SIGTERM as we require. ipmid_send_cmd_to_host() takes a CallBack |
| 143 | function as an argument, which is invoked by |
| 144 | phosphor::host::command::Manager::getNextCommand(). The documentation for |
| 145 | phosphor::host::command::Manager::getNextCommand() says: |
| 146 | |
| 147 | @brief Extracts the next entry in the queue and returns |
| 148 | Command and data part of it. |
| 149 | |
| 150 | @detail Also calls into the registered handlers so that they can now |
| 151 | send the CommandComplete signal since the interface contract |
| 152 | is that we emit this signal once the message has been |
| 153 | passed to the host (which is required when calling this) |
| 154 | |
| 155 | Also, if the queue has more commands, then it will alert the |
| 156 | host |
| 157 | |
| 158 | However, its description is not entirely accurate. The callback function is |
| 159 | invoked when ipmid *dequeues* the data to send to the host: Delivery of the |
| 160 | data to the host occurs at some *after* the callback has been invoked. |
| 161 | |
| 162 | Invoking the callback before completion of delivery of the data to the host |
| 163 | nullifies the approach of unblocking asynchronous SIGTERM in the callback |
| 164 | associated with sending the HIOMAP BMC state event to the host, as the BMC |
| 165 | kernel can asynchronously terminate the process between the callback being |
| 166 | invoked and the host receiving the BMC state event data. |
| 167 | |
| 168 | Overcoming this issue hinges on a significant implementation detail of ipmid: |
| 169 | |
| 170 | ipmid uses an sd_event loop in the main function to pump DBus events. |
| 171 | |
| 172 | This leads to a third necessary observation: |
| 173 | |
| 174 | sd_event can be used to process UNIX signals as well as other events by way |
| 175 | of Linux's signalfd(2) interface. |
| 176 | |
| 177 | The fact that sd_event is used to pump DBus events means that ipmid can remain |
| 178 | a single-threaded process. By remaining single-threaded we know that events |
| 179 | processing is sequencial and no two events can be processed simultaneously. A |
| 180 | corollary of this is that DBus events and UNIX signals are serialised with |
| 181 | respect to eachother. |
| 182 | |
| 183 | The fourth necessary observation is that we do not need to pump sd_event in |
| 184 | order to complete DBus method calls; sd_bus will handle the pumping independent |
| 185 | of the main loop in order to complete the method invocation. |
| 186 | |
| 187 | Implementing Reliable HIOMAP BMC Status Event Delivery |
| 188 | ------------------------------------------------------ |
| 189 | |
| 190 | We achieve reliable delivery of HIOMAP BMC status events in the following way: |
| 191 | |
| 192 | 1. During plugin initialisation, mask SIGTERM using sigprocmask(2) |
| 193 | 2. Subsequent to masking SIGTERM, register |
| 194 | openpower::flash::hiomap_protocol_reset() as the SIGTERM handler using |
| 195 | sd_event_add_signal() to hook a signalfd(2) into sd_event |
| 196 | 3. openpower::flash::hiomap_protocol_reset() implements the logic to send the |
| 197 | BMC_EVENT_PROTOCOL_RESET state to the host if necessary, otherwise terminate |
| 198 | the sd_event loop. |
| 199 | 4. If it is necessary to send BMC_EVENT_PROTOCOL_RESET to the host in 3, assign |
| 200 | a callback handler that terminates the sd_event loop, which is only |
| 201 | processed after the current iteration is complete. |
| 202 | |
| 203 | This process and its use of signalfd integration in the sd_event loop |
| 204 | eliminates the following three races: |
| 205 | |
| 206 | 1. The scheduler race between mboxd, dbus-daemon and ipmid, by having |
| 207 | openpower-host-ipmi-flash conditionally deliver the protocol reset event if |
| 208 | no such message has been received from mboxd |
| 209 | 2. The race between delivering the BMC status event to the host and ipmid |
| 210 | receiving asynchronous SIGTERM after receiving the PropertiesChanged event |
| 211 | from mboxd |
| 212 | 3. The race to deliver the BMC status data to the host after unblocking |
| 213 | asynchronous SIGTERM in the host command callback and before receiving |
| 214 | asynchronous SIGTERM. |
| 215 | |
| 216 | Ultimately, ipmid could benefit from a redesign that fires the callback *after* |
| 217 | delivering the associated data to the host, but brief inspection determined |
| 218 | that this involved a non-trivial amount of effort. |
| 219 | |
| 220 | */ |
| 221 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 222 | using namespace sdbusplus; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 223 | using namespace phosphor::host::command; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 224 | |
| 225 | static void register_openpower_hiomap_commands() __attribute__((constructor)); |
| 226 | |
| 227 | namespace openpower |
| 228 | { |
| 229 | namespace flash |
| 230 | { |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 231 | constexpr auto BMC_EVENT_DAEMON_READY = 1 << 7; |
| 232 | constexpr auto BMC_EVENT_FLASH_CTRL_LOST = 1 << 6; |
| 233 | constexpr auto BMC_EVENT_WINDOW_RESET = 1 << 1; |
| 234 | constexpr auto BMC_EVENT_PROTOCOL_RESET = 1 << 0; |
| 235 | |
| 236 | constexpr auto IPMI_CMD_HIOMAP_EVENT = 0x0f; |
| 237 | |
| 238 | constexpr auto HIOMAPD_SERVICE = "xyz.openbmc_project.Hiomapd"; |
| 239 | constexpr auto HIOMAPD_OBJECT = "/xyz/openbmc_project/Hiomapd"; |
| 240 | constexpr auto HIOMAPD_IFACE = "xyz.openbmc_project.Hiomapd.Protocol"; |
| 241 | constexpr auto HIOMAPD_IFACE_V2 = "xyz.openbmc_project.Hiomapd.Protocol.V2"; |
| 242 | |
| 243 | constexpr auto DBUS_IFACE_PROPERTIES = "org.freedesktop.DBus.Properties"; |
| 244 | |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 245 | /* XXX: ipmid is currently single-threaded, pumping dbus events in sequence |
| 246 | * via the main event loop. Thus the code is not forced to be re-entrant. We |
| 247 | * also know that the callback and DBus event handling will not be running |
| 248 | * concurrently. |
| 249 | * |
| 250 | * ipmid_send_cmd_to_host() takes a callback that doesn't define a context |
| 251 | * pointer, so instead use a global. active_event_updates gates manipulation of |
| 252 | * process state, so its definition as a global at least aligns with its use. |
| 253 | */ |
| 254 | static int active_event_updates; |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 255 | |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 256 | struct hiomap |
| 257 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 258 | bus::bus* bus; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 259 | |
| 260 | /* Signals */ |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 261 | bus::match::match* properties; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 262 | |
| 263 | /* Protocol state */ |
| 264 | std::map<std::string, int> event_lookup; |
| 265 | uint8_t bmc_events; |
Andrew Jeffery | 04d7513 | 2018-09-26 00:58:52 +0930 | [diff] [blame] | 266 | uint8_t seq; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 267 | }; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 268 | |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 269 | SignalResponse sigtermResponse = SignalResponse::continueExecution; |
| 270 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 271 | /* TODO: Replace get/put with packed structs and direct assignment */ |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 272 | template <typename T> |
| 273 | static inline T get(void* buf) |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 274 | { |
| 275 | T t; |
Patrick Venture | ee70196 | 2018-10-31 14:51:37 -0700 | [diff] [blame] | 276 | std::memcpy(&t, buf, sizeof(t)); |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 277 | return t; |
| 278 | } |
| 279 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 280 | template <typename T> |
| 281 | static inline void put(void* buf, T&& t) |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 282 | { |
Patrick Venture | ee70196 | 2018-10-31 14:51:37 -0700 | [diff] [blame] | 283 | std::memcpy(buf, &t, sizeof(t)); |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 284 | } |
| 285 | |
| 286 | typedef ipmi_ret_t (*hiomap_command)(ipmi_request_t req, ipmi_response_t resp, |
| 287 | ipmi_data_len_t data_len, |
| 288 | ipmi_context_t context); |
| 289 | |
| 290 | struct errno_cc_entry |
| 291 | { |
| 292 | int err; |
| 293 | int cc; |
| 294 | }; |
| 295 | |
| 296 | static const errno_cc_entry errno_cc_map[] = { |
| 297 | {0, IPMI_CC_OK}, |
| 298 | {EBUSY, IPMI_CC_BUSY}, |
| 299 | {ENOTSUP, IPMI_CC_INVALID}, |
| 300 | {ETIMEDOUT, 0xc3}, /* FIXME: Replace when defined in ipmid-api.h */ |
| 301 | {ENOSPC, 0xc4}, /* FIXME: Replace when defined in ipmid-api.h */ |
| 302 | {EINVAL, IPMI_CC_PARM_OUT_OF_RANGE}, |
| 303 | {ENODEV, IPMI_CC_SENSOR_INVALID}, |
| 304 | {EPERM, IPMI_CC_INSUFFICIENT_PRIVILEGE}, |
| 305 | {EACCES, IPMI_CC_INSUFFICIENT_PRIVILEGE}, |
| 306 | {-1, IPMI_CC_UNSPECIFIED_ERROR}, |
| 307 | }; |
| 308 | |
| 309 | static int hiomap_xlate_errno(int err) |
| 310 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 311 | const errno_cc_entry* entry = &errno_cc_map[0]; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 312 | |
| 313 | while (!(entry->err == err || entry->err == -1)) |
| 314 | { |
| 315 | entry++; |
| 316 | } |
| 317 | |
| 318 | return entry->cc; |
| 319 | } |
| 320 | |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 321 | static void ipmi_hiomap_event_response(IpmiCmdData cmd, bool status) |
| 322 | { |
| 323 | using namespace phosphor::logging; |
| 324 | |
| 325 | if (!status) |
| 326 | { |
| 327 | log<level::ERR>("Failed to deliver host command", |
| 328 | entry("SEL_COMMAND=%x:%x", cmd.first, cmd.second)); |
| 329 | } |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 330 | |
| 331 | assert(active_event_updates); |
| 332 | active_event_updates--; |
| 333 | if (!active_event_updates) |
| 334 | { |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 335 | sigtermResponse = SignalResponse::continueExecution; |
| 336 | log<level::DEBUG>("Unblocked SIGTERM"); |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 337 | } |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 338 | } |
| 339 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 340 | static int hiomap_handle_property_update(struct hiomap* ctx, |
| 341 | sdbusplus::message::message& msg) |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 342 | { |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 343 | using namespace phosphor::logging; |
| 344 | |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 345 | std::map<std::string, sdbusplus::message::variant<bool>> msgData; |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 346 | |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 347 | sigtermResponse = SignalResponse::breakExecution; |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 348 | if (!active_event_updates) |
| 349 | { |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 350 | sigtermResponse = SignalResponse::breakExecution; |
| 351 | log<level::DEBUG>("Blocked SIGTERM"); |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 352 | } |
| 353 | active_event_updates++; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 354 | |
| 355 | std::string iface; |
| 356 | msg.read(iface, msgData); |
| 357 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 358 | for (auto const& x : msgData) |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 359 | { |
| 360 | if (!ctx->event_lookup.count(x.first)) |
| 361 | { |
| 362 | /* Unsupported event? */ |
| 363 | continue; |
| 364 | } |
| 365 | |
| 366 | uint8_t mask = ctx->event_lookup[x.first]; |
| 367 | auto value = sdbusplus::message::variant_ns::get<bool>(x.second); |
| 368 | |
| 369 | if (value) |
| 370 | { |
| 371 | ctx->bmc_events |= mask; |
| 372 | } |
| 373 | else |
| 374 | { |
| 375 | ctx->bmc_events &= ~mask; |
| 376 | } |
| 377 | } |
| 378 | |
| 379 | auto cmd = std::make_pair(IPMI_CMD_HIOMAP_EVENT, ctx->bmc_events); |
| 380 | |
| 381 | ipmid_send_cmd_to_host(std::make_tuple(cmd, ipmi_hiomap_event_response)); |
| 382 | |
| 383 | return 0; |
| 384 | } |
| 385 | |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 386 | static int hiomap_protocol_reset_response(IpmiCmdData cmd, bool status) |
| 387 | { |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 388 | // If this is running in signal context, ipmid will shutdown |
| 389 | // the event queue as the last signal handler |
| 390 | return 0; |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 391 | } |
| 392 | |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 393 | static int hiomap_protocol_reset(struct hiomap* ctx) |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 394 | { |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 395 | if (ctx->bmc_events == BMC_EVENT_PROTOCOL_RESET) |
| 396 | { |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 397 | // If this is running in signal context, ipmid will shutdown |
| 398 | // the event queue as the last signal handler |
| 399 | return 0; |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 400 | } |
| 401 | |
| 402 | /* |
| 403 | * Send an attention indicating the hiomapd has died |
| 404 | * (BMC_EVENT_DAEMON_READY cleared) and that the protocol has been reset |
| 405 | * (BMC_EVENT_PROTOCOL_RESET set) to indicate to the host that it needs to |
| 406 | * wait for the BMC to come back and renegotiate the protocol. |
| 407 | * |
| 408 | * We know this to be the case in systems that integrate |
| 409 | * openpower-host-ipmi-flash, as hiomapd's unit depends on |
| 410 | * phosphor-ipmi-host, and thus hiomapd has been terminated before ipmid |
| 411 | * receives SIGTERM. |
| 412 | */ |
| 413 | auto cmd = std::make_pair(IPMI_CMD_HIOMAP_EVENT, BMC_EVENT_PROTOCOL_RESET); |
| 414 | |
| 415 | auto cmdHandler = std::make_tuple(cmd, hiomap_protocol_reset_response); |
| 416 | ipmid_send_cmd_to_host(cmdHandler); |
| 417 | |
| 418 | return 0; |
| 419 | } |
| 420 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 421 | static bus::match::match hiomap_match_properties(struct hiomap* ctx) |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 422 | { |
| 423 | auto properties = |
| 424 | bus::match::rules::propertiesChanged(HIOMAPD_OBJECT, HIOMAPD_IFACE_V2); |
| 425 | |
| 426 | bus::match::match match( |
| 427 | *ctx->bus, properties, |
| 428 | std::bind(hiomap_handle_property_update, ctx, std::placeholders::_1)); |
| 429 | |
| 430 | return match; |
| 431 | } |
| 432 | |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 433 | static ipmi_ret_t hiomap_reset(ipmi_request_t request, ipmi_response_t response, |
| 434 | ipmi_data_len_t data_len, ipmi_context_t context) |
| 435 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 436 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 437 | |
| 438 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 439 | HIOMAPD_IFACE, "Reset"); |
| 440 | try |
| 441 | { |
| 442 | ctx->bus->call(m); |
| 443 | |
| 444 | *data_len = 0; |
| 445 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 446 | catch (const exception::SdBusError& e) |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 447 | { |
| 448 | return hiomap_xlate_errno(e.get_errno()); |
| 449 | } |
| 450 | |
| 451 | return IPMI_CC_OK; |
| 452 | } |
| 453 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 454 | static ipmi_ret_t hiomap_get_info(ipmi_request_t request, |
| 455 | ipmi_response_t response, |
| 456 | ipmi_data_len_t data_len, |
| 457 | ipmi_context_t context) |
| 458 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 459 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 460 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 461 | if (*data_len < 1) |
| 462 | { |
| 463 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 464 | } |
| 465 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 466 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 467 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 468 | HIOMAPD_IFACE, "GetInfo"); |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 469 | m.append(reqdata[0]); |
| 470 | |
| 471 | try |
| 472 | { |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 473 | auto reply = ctx->bus->call(m); |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 474 | |
| 475 | uint8_t version; |
| 476 | uint8_t blockSizeShift; |
| 477 | uint16_t timeout; |
| 478 | reply.read(version, blockSizeShift, timeout); |
| 479 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 480 | uint8_t* respdata = (uint8_t*)response; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 481 | |
| 482 | /* FIXME: Assumes v2! */ |
| 483 | put(&respdata[0], version); |
| 484 | put(&respdata[1], blockSizeShift); |
| 485 | put(&respdata[2], htole16(timeout)); |
| 486 | |
| 487 | *data_len = 4; |
| 488 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 489 | catch (const exception::SdBusError& e) |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 490 | { |
| 491 | return hiomap_xlate_errno(e.get_errno()); |
| 492 | } |
| 493 | |
| 494 | return IPMI_CC_OK; |
| 495 | } |
| 496 | |
Andrew Jeffery | db688e9 | 2018-08-23 21:21:30 +0930 | [diff] [blame] | 497 | static ipmi_ret_t hiomap_get_flash_info(ipmi_request_t request, |
| 498 | ipmi_response_t response, |
| 499 | ipmi_data_len_t data_len, |
| 500 | ipmi_context_t context) |
| 501 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 502 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | db688e9 | 2018-08-23 21:21:30 +0930 | [diff] [blame] | 503 | |
| 504 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 505 | HIOMAPD_IFACE_V2, "GetFlashInfo"); |
| 506 | try |
| 507 | { |
| 508 | auto reply = ctx->bus->call(m); |
| 509 | |
| 510 | uint16_t flashSize, eraseSize; |
| 511 | reply.read(flashSize, eraseSize); |
| 512 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 513 | uint8_t* respdata = (uint8_t*)response; |
Andrew Jeffery | db688e9 | 2018-08-23 21:21:30 +0930 | [diff] [blame] | 514 | put(&respdata[0], htole16(flashSize)); |
| 515 | put(&respdata[2], htole16(eraseSize)); |
| 516 | |
| 517 | *data_len = 4; |
| 518 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 519 | catch (const exception::SdBusError& e) |
Andrew Jeffery | db688e9 | 2018-08-23 21:21:30 +0930 | [diff] [blame] | 520 | { |
| 521 | return hiomap_xlate_errno(e.get_errno()); |
| 522 | } |
| 523 | |
| 524 | return IPMI_CC_OK; |
| 525 | } |
| 526 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 527 | static ipmi_ret_t hiomap_create_window(struct hiomap* ctx, bool ro, |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 528 | ipmi_request_t request, |
| 529 | ipmi_response_t response, |
| 530 | ipmi_data_len_t data_len) |
| 531 | { |
| 532 | if (*data_len < 4) |
| 533 | { |
| 534 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 535 | } |
| 536 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 537 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 538 | auto windowType = ro ? "CreateReadWindow" : "CreateWriteWindow"; |
| 539 | |
| 540 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 541 | HIOMAPD_IFACE_V2, windowType); |
| 542 | m.append(le16toh(get<uint16_t>(&reqdata[0]))); |
| 543 | m.append(le16toh(get<uint16_t>(&reqdata[2]))); |
| 544 | |
| 545 | try |
| 546 | { |
| 547 | auto reply = ctx->bus->call(m); |
| 548 | |
| 549 | uint16_t lpcAddress, size, offset; |
| 550 | reply.read(lpcAddress, size, offset); |
| 551 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 552 | uint8_t* respdata = (uint8_t*)response; |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 553 | |
| 554 | /* FIXME: Assumes v2! */ |
| 555 | put(&respdata[0], htole16(lpcAddress)); |
| 556 | put(&respdata[2], htole16(size)); |
| 557 | put(&respdata[4], htole16(offset)); |
| 558 | |
| 559 | *data_len = 6; |
| 560 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 561 | catch (const exception::SdBusError& e) |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 562 | { |
| 563 | return hiomap_xlate_errno(e.get_errno()); |
| 564 | } |
| 565 | |
| 566 | return IPMI_CC_OK; |
| 567 | } |
| 568 | |
| 569 | static ipmi_ret_t hiomap_create_read_window(ipmi_request_t request, |
| 570 | ipmi_response_t response, |
| 571 | ipmi_data_len_t data_len, |
| 572 | ipmi_context_t context) |
| 573 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 574 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 575 | |
| 576 | return hiomap_create_window(ctx, true, request, response, data_len); |
| 577 | } |
| 578 | |
| 579 | static ipmi_ret_t hiomap_create_write_window(ipmi_request_t request, |
| 580 | ipmi_response_t response, |
| 581 | ipmi_data_len_t data_len, |
| 582 | ipmi_context_t context) |
| 583 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 584 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | a00f59b | 2018-08-23 22:25:49 +0930 | [diff] [blame] | 585 | |
| 586 | return hiomap_create_window(ctx, false, request, response, data_len); |
| 587 | } |
| 588 | |
Andrew Jeffery | b52822c | 2018-08-23 23:01:39 +0930 | [diff] [blame] | 589 | static ipmi_ret_t hiomap_close_window(ipmi_request_t request, |
| 590 | ipmi_response_t response, |
| 591 | ipmi_data_len_t data_len, |
| 592 | ipmi_context_t context) |
| 593 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 594 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | b52822c | 2018-08-23 23:01:39 +0930 | [diff] [blame] | 595 | |
| 596 | if (*data_len < 1) |
| 597 | { |
| 598 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 599 | } |
| 600 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 601 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | b52822c | 2018-08-23 23:01:39 +0930 | [diff] [blame] | 602 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 603 | HIOMAPD_IFACE_V2, "CloseWindow"); |
| 604 | m.append(reqdata[0]); |
| 605 | |
| 606 | try |
| 607 | { |
| 608 | auto reply = ctx->bus->call(m); |
| 609 | |
| 610 | *data_len = 0; |
| 611 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 612 | catch (const exception::SdBusError& e) |
Andrew Jeffery | b52822c | 2018-08-23 23:01:39 +0930 | [diff] [blame] | 613 | { |
| 614 | return hiomap_xlate_errno(e.get_errno()); |
| 615 | } |
| 616 | |
| 617 | return IPMI_CC_OK; |
| 618 | } |
| 619 | |
Andrew Jeffery | 9847f1c | 2018-08-24 09:13:40 +0930 | [diff] [blame] | 620 | static ipmi_ret_t hiomap_mark_dirty(ipmi_request_t request, |
| 621 | ipmi_response_t response, |
| 622 | ipmi_data_len_t data_len, |
| 623 | ipmi_context_t context) |
| 624 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 625 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 9847f1c | 2018-08-24 09:13:40 +0930 | [diff] [blame] | 626 | |
| 627 | if (*data_len < 4) |
| 628 | { |
| 629 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 630 | } |
| 631 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 632 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | 9847f1c | 2018-08-24 09:13:40 +0930 | [diff] [blame] | 633 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 634 | HIOMAPD_IFACE_V2, "MarkDirty"); |
| 635 | /* FIXME: Assumes v2 */ |
| 636 | m.append(le16toh(get<uint16_t>(&reqdata[0]))); /* offset */ |
| 637 | m.append(le16toh(get<uint16_t>(&reqdata[2]))); /* size */ |
| 638 | |
| 639 | try |
| 640 | { |
| 641 | auto reply = ctx->bus->call(m); |
| 642 | |
| 643 | *data_len = 0; |
| 644 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 645 | catch (const exception::SdBusError& e) |
Andrew Jeffery | 9847f1c | 2018-08-24 09:13:40 +0930 | [diff] [blame] | 646 | { |
| 647 | return hiomap_xlate_errno(e.get_errno()); |
| 648 | } |
| 649 | |
| 650 | return IPMI_CC_OK; |
| 651 | } |
| 652 | |
Andrew Jeffery | 7b225fb | 2018-08-24 09:19:21 +0930 | [diff] [blame] | 653 | static ipmi_ret_t hiomap_flush(ipmi_request_t request, ipmi_response_t response, |
| 654 | ipmi_data_len_t data_len, ipmi_context_t context) |
| 655 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 656 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 7b225fb | 2018-08-24 09:19:21 +0930 | [diff] [blame] | 657 | |
| 658 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 659 | HIOMAPD_IFACE_V2, "Flush"); |
| 660 | |
| 661 | try |
| 662 | { |
| 663 | /* FIXME: No argument call assumes v2 */ |
| 664 | auto reply = ctx->bus->call(m); |
| 665 | |
| 666 | *data_len = 0; |
| 667 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 668 | catch (const exception::SdBusError& e) |
Andrew Jeffery | 7b225fb | 2018-08-24 09:19:21 +0930 | [diff] [blame] | 669 | { |
| 670 | return hiomap_xlate_errno(e.get_errno()); |
| 671 | } |
| 672 | |
| 673 | return IPMI_CC_OK; |
| 674 | } |
| 675 | |
Andrew Jeffery | 99f277a | 2018-08-24 09:24:04 +0930 | [diff] [blame] | 676 | static ipmi_ret_t hiomap_ack(ipmi_request_t request, ipmi_response_t response, |
| 677 | ipmi_data_len_t data_len, ipmi_context_t context) |
| 678 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 679 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 99f277a | 2018-08-24 09:24:04 +0930 | [diff] [blame] | 680 | |
| 681 | if (*data_len < 1) |
| 682 | { |
| 683 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 684 | } |
| 685 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 686 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | 99f277a | 2018-08-24 09:24:04 +0930 | [diff] [blame] | 687 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 688 | HIOMAPD_IFACE_V2, "Ack"); |
| 689 | auto acked = reqdata[0]; |
| 690 | m.append(acked); |
| 691 | |
| 692 | try |
| 693 | { |
| 694 | auto reply = ctx->bus->call(m); |
| 695 | |
Andrew Jeffery | 99f277a | 2018-08-24 09:24:04 +0930 | [diff] [blame] | 696 | *data_len = 0; |
| 697 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 698 | catch (const exception::SdBusError& e) |
Andrew Jeffery | 99f277a | 2018-08-24 09:24:04 +0930 | [diff] [blame] | 699 | { |
| 700 | return hiomap_xlate_errno(e.get_errno()); |
| 701 | } |
| 702 | |
| 703 | return IPMI_CC_OK; |
| 704 | } |
| 705 | |
Andrew Jeffery | a1e35b8 | 2018-08-24 09:39:10 +0930 | [diff] [blame] | 706 | static ipmi_ret_t hiomap_erase(ipmi_request_t request, ipmi_response_t response, |
| 707 | ipmi_data_len_t data_len, ipmi_context_t context) |
| 708 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 709 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | a1e35b8 | 2018-08-24 09:39:10 +0930 | [diff] [blame] | 710 | |
| 711 | if (*data_len < 4) |
| 712 | { |
| 713 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 714 | } |
| 715 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 716 | uint8_t* reqdata = (uint8_t*)request; |
Andrew Jeffery | a1e35b8 | 2018-08-24 09:39:10 +0930 | [diff] [blame] | 717 | auto m = ctx->bus->new_method_call(HIOMAPD_SERVICE, HIOMAPD_OBJECT, |
| 718 | HIOMAPD_IFACE_V2, "Erase"); |
| 719 | /* FIXME: Assumes v2 */ |
| 720 | m.append(le16toh(get<uint16_t>(&reqdata[0]))); /* offset */ |
| 721 | m.append(le16toh(get<uint16_t>(&reqdata[2]))); /* size */ |
| 722 | |
| 723 | try |
| 724 | { |
| 725 | auto reply = ctx->bus->call(m); |
| 726 | |
| 727 | *data_len = 0; |
| 728 | } |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 729 | catch (const exception::SdBusError& e) |
Andrew Jeffery | a1e35b8 | 2018-08-24 09:39:10 +0930 | [diff] [blame] | 730 | { |
| 731 | return hiomap_xlate_errno(e.get_errno()); |
| 732 | } |
| 733 | |
| 734 | return IPMI_CC_OK; |
| 735 | } |
| 736 | |
Andrew Jeffery | 04d7513 | 2018-09-26 00:58:52 +0930 | [diff] [blame] | 737 | #define HIOMAP_C_RESET 1 |
| 738 | #define HIOMAP_C_GET_INFO 2 |
| 739 | #define HIOMAP_C_GET_FLASH_INFO 3 |
| 740 | #define HIOMAP_C_CREATE_READ_WINDOW 4 |
| 741 | #define HIOMAP_C_CLOSE_WINDOW 5 |
| 742 | #define HIOMAP_C_CREATE_WRITE_WINDOW 6 |
| 743 | #define HIOMAP_C_MARK_DIRTY 7 |
| 744 | #define HIOMAP_C_FLUSH 8 |
| 745 | #define HIOMAP_C_ACK 9 |
| 746 | #define HIOMAP_C_ERASE 10 |
| 747 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 748 | static const hiomap_command hiomap_commands[] = { |
Andrew Jeffery | 04d7513 | 2018-09-26 00:58:52 +0930 | [diff] [blame] | 749 | [0] = NULL, /* Invalid command ID */ |
| 750 | [HIOMAP_C_RESET] = hiomap_reset, |
| 751 | [HIOMAP_C_GET_INFO] = hiomap_get_info, |
| 752 | [HIOMAP_C_GET_FLASH_INFO] = hiomap_get_flash_info, |
| 753 | [HIOMAP_C_CREATE_READ_WINDOW] = hiomap_create_read_window, |
| 754 | [HIOMAP_C_CLOSE_WINDOW] = hiomap_close_window, |
| 755 | [HIOMAP_C_CREATE_WRITE_WINDOW] = hiomap_create_write_window, |
| 756 | [HIOMAP_C_MARK_DIRTY] = hiomap_mark_dirty, |
| 757 | [HIOMAP_C_FLUSH] = hiomap_flush, |
| 758 | [HIOMAP_C_ACK] = hiomap_ack, |
| 759 | [HIOMAP_C_ERASE] = hiomap_erase, |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 760 | }; |
| 761 | |
| 762 | /* FIXME: Define this in the "right" place, wherever that is */ |
| 763 | /* FIXME: Double evaluation */ |
| 764 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) |
| 765 | |
| 766 | static ipmi_ret_t hiomap_dispatch(ipmi_netfn_t netfn, ipmi_cmd_t cmd, |
| 767 | ipmi_request_t request, |
| 768 | ipmi_response_t response, |
| 769 | ipmi_data_len_t data_len, |
| 770 | ipmi_context_t context) |
| 771 | { |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 772 | struct hiomap* ctx = static_cast<struct hiomap*>(context); |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 773 | |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 774 | if (*data_len < 2) |
| 775 | { |
| 776 | *data_len = 0; |
| 777 | return IPMI_CC_REQ_DATA_LEN_INVALID; |
| 778 | } |
| 779 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 780 | uint8_t* ipmi_req = (uint8_t*)request; |
| 781 | uint8_t* ipmi_resp = (uint8_t*)response; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 782 | uint8_t hiomap_cmd = ipmi_req[0]; |
| 783 | |
| 784 | if (hiomap_cmd == 0 || hiomap_cmd > ARRAY_SIZE(hiomap_commands) - 1) |
| 785 | { |
| 786 | *data_len = 0; |
| 787 | return IPMI_CC_PARM_OUT_OF_RANGE; |
| 788 | } |
Andrew Jeffery | 04d7513 | 2018-09-26 00:58:52 +0930 | [diff] [blame] | 789 | |
| 790 | bool is_unversioned = |
| 791 | (hiomap_cmd == HIOMAP_C_RESET || hiomap_cmd == HIOMAP_C_GET_INFO || |
| 792 | hiomap_cmd == HIOMAP_C_ACK); |
| 793 | if (!is_unversioned && ctx->seq == ipmi_req[1]) |
| 794 | { |
| 795 | *data_len = 0; |
| 796 | return IPMI_CC_INVALID_FIELD_REQUEST; |
| 797 | } |
| 798 | |
| 799 | ctx->seq = ipmi_req[1]; |
| 800 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 801 | uint8_t* flash_req = ipmi_req + 2; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 802 | size_t flash_len = *data_len - 2; |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 803 | uint8_t* flash_resp = ipmi_resp + 2; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 804 | |
| 805 | ipmi_ret_t cc = |
| 806 | hiomap_commands[hiomap_cmd](flash_req, flash_resp, &flash_len, context); |
| 807 | if (cc != IPMI_CC_OK) |
| 808 | { |
| 809 | *data_len = 0; |
| 810 | return cc; |
| 811 | } |
| 812 | |
| 813 | /* Populate the response command and sequence */ |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 814 | ipmi_resp[0] = hiomap_cmd; |
Andrew Jeffery | 04d7513 | 2018-09-26 00:58:52 +0930 | [diff] [blame] | 815 | ipmi_resp[1] = ctx->seq; |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 816 | |
| 817 | *data_len = flash_len + 2; |
| 818 | |
| 819 | return cc; |
| 820 | } |
| 821 | } // namespace flash |
| 822 | } // namespace openpower |
| 823 | |
| 824 | static void register_openpower_hiomap_commands() |
| 825 | { |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 826 | using namespace phosphor::logging; |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 827 | using namespace openpower::flash; |
| 828 | |
Patrick Venture | 5b35506 | 2018-10-31 14:42:42 -0700 | [diff] [blame] | 829 | struct hiomap* ctx = new hiomap(); |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 830 | |
| 831 | /* Initialise mapping from signal and property names to status bit */ |
| 832 | ctx->event_lookup["DaemonReady"] = BMC_EVENT_DAEMON_READY; |
| 833 | ctx->event_lookup["FlashControlLost"] = BMC_EVENT_FLASH_CTRL_LOST; |
| 834 | ctx->event_lookup["WindowReset"] = BMC_EVENT_WINDOW_RESET; |
| 835 | ctx->event_lookup["ProtocolReset"] = BMC_EVENT_PROTOCOL_RESET; |
| 836 | |
| 837 | ctx->bus = new bus::bus(ipmid_get_sd_bus_connection()); |
| 838 | |
| 839 | /* Initialise signal handling */ |
| 840 | |
| 841 | /* |
| 842 | * Can't use temporaries here because that causes SEGFAULTs due to slot |
| 843 | * destruction (!?), so enjoy the weird wrapping. |
| 844 | */ |
| 845 | ctx->properties = |
| 846 | new bus::match::match(std::move(hiomap_match_properties(ctx))); |
Andrew Jeffery | 619207d | 2018-11-22 13:09:17 +1100 | [diff] [blame] | 847 | |
Vernon Mauery | ee3064b | 2019-03-18 10:19:58 -0700 | [diff] [blame^] | 848 | std::function<SignalResponse(int)> shutdownHandler = |
| 849 | [ctx](int signalNumber) { |
| 850 | hiomap_protocol_reset(ctx); |
| 851 | return sigtermResponse; |
| 852 | }; |
| 853 | registerSignalHandler(ipmi::prioMax, SIGTERM, shutdownHandler); |
Andrew Jeffery | 0a3358e | 2018-08-21 10:42:09 +0930 | [diff] [blame] | 854 | |
| 855 | ipmi_register_callback(NETFUN_IBM_OEM, IPMI_CMD_HIOMAP, ctx, |
Andrew Jeffery | 2c07f6f | 2018-08-10 16:24:32 +0930 | [diff] [blame] | 856 | openpower::flash::hiomap_dispatch, SYSTEM_INTERFACE); |
| 857 | } |