blob: 86899148c7b305f9c3b9e98b52737dee0fa1a86e [file] [log] [blame]
Dawid Fryckia642a942018-06-12 10:44:23 -07001/* Copyright 2018 Intel
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16#include "ipmbbridged.hpp"
17
18#include "ipmbdefines.hpp"
19#include "ipmbutils.hpp"
20
Qiang XU8edcf1a2019-06-14 22:18:15 +080021#include <boost/algorithm/string/replace.hpp>
Ed Tanous09027c02020-08-31 17:28:36 -070022#include <boost/asio/write.hpp>
Qiang XU8edcf1a2019-06-14 22:18:15 +080023#include <filesystem>
Amithash Prasad314862d2019-03-26 11:14:03 -070024#include <fstream>
25#include <nlohmann/json.hpp>
Dawid Fryckia642a942018-06-12 10:44:23 -070026#include <phosphor-logging/log.hpp>
27#include <tuple>
Amithash Prasad314862d2019-03-26 11:14:03 -070028#include <unordered_map>
Dawid Fryckia642a942018-06-12 10:44:23 -070029
Dawid Fryckia642a942018-06-12 10:44:23 -070030/**
31 * @brief Dbus
32 */
33static constexpr const char *ipmbBus = "xyz.openbmc_project.Ipmi.Channel.Ipmb";
34static constexpr const char *ipmbObj = "/xyz/openbmc_project/Ipmi/Channel/Ipmb";
Dawid Fryckia642a942018-06-12 10:44:23 -070035static constexpr const char *ipmbDbusIntf = "org.openbmc.Ipmb";
36
37boost::asio::io_service io;
38auto conn = std::make_shared<sdbusplus::asio::connection>(io);
39
Dawid Fryckia642a942018-06-12 10:44:23 -070040static std::list<IpmbChannel> ipmbChannels;
Amithash Prasad314862d2019-03-26 11:14:03 -070041static const std::unordered_map<std::string, ipmbChannelType>
42 ipmbChannelTypeMap = {{"me", ipmbChannelType::me},
43 {"ipmb", ipmbChannelType::ipmb}};
Dawid Fryckia642a942018-06-12 10:44:23 -070044
45/**
46 * @brief Ipmb request class methods
47 */
48IpmbRequest::IpmbRequest()
49{
50 data.reserve(ipmbMaxDataSize);
51}
52
53IpmbRequest::IpmbRequest(uint8_t address, uint8_t netFn, uint8_t rsLun,
54 uint8_t rqSA, uint8_t seq, uint8_t rqLun, uint8_t cmd,
Dawid Frycki8188d762019-04-01 18:03:48 -070055 const std::vector<uint8_t> &inputData) :
Dawid Fryckia642a942018-06-12 10:44:23 -070056 address(address),
57 netFn(netFn), rsLun(rsLun), rqSA(rqSA), seq(seq), rqLun(rqLun), cmd(cmd),
58 timer(io)
59{
60 data.reserve(ipmbMaxDataSize);
61 state = ipmbRequestState::invalid;
62
63 if (inputData.size() > 0)
64 {
65 data = std::move(inputData);
66 }
67}
68
Dawid Fryckia642a942018-06-12 10:44:23 -070069void IpmbRequest::i2cToIpmbConstruct(IPMB_HEADER *ipmbBuffer,
70 size_t bufferLength)
71{
72 // constructing ipmb request from i2c buffer
73 netFn = ipmbNetFnGet(ipmbBuffer->Header.Req.rsNetFnLUN);
74 rsLun = ipmbLunFromNetFnLunGet(ipmbBuffer->Header.Req.rsNetFnLUN);
75 rqSA = ipmbBuffer->Header.Req.rqSA;
76 seq = ipmbSeqGet(ipmbBuffer->Header.Req.rqSeqLUN);
77 rqLun = ipmbLunFromSeqLunGet(ipmbBuffer->Header.Req.rqSeqLUN);
78 cmd = ipmbBuffer->Header.Req.cmd;
79
80 size_t dataLength =
81 bufferLength - (ipmbConnectionHeaderLength +
82 ipmbRequestDataHeaderLength + ipmbChecksumSize);
83
84 if (dataLength > 0)
85 {
86 data.insert(data.end(), ipmbBuffer->Header.Req.data,
87 &ipmbBuffer->Header.Req.data[dataLength]);
88 }
89}
90
91int IpmbRequest::ipmbToi2cConstruct(std::vector<uint8_t> &buffer)
92{
Vijay Khemka37a7eac2019-12-06 13:52:28 -080093 /* Add one byte for length byte as per required by driver */
94 size_t bufferLength = 1 + data.size() + ipmbRequestDataHeaderLength +
Dawid Fryckia642a942018-06-12 10:44:23 -070095 ipmbConnectionHeaderLength + ipmbChecksumSize;
96
97 if (bufferLength > ipmbMaxFrameLength)
98 {
99 return -1;
100 }
101
102 buffer.resize(bufferLength);
103 static_assert(ipmbMaxFrameLength >= sizeof(IPMB_HEADER));
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800104 IPMB_PKT *ipmbPkt = reinterpret_cast<IPMB_PKT *>(buffer.data());
105 ipmbPkt->len = bufferLength - 1;
106 IPMB_HEADER *ipmbBuffer = &(ipmbPkt->hdr);
Dawid Fryckia642a942018-06-12 10:44:23 -0700107
108 // constructing buffer from ipmb request
109 ipmbBuffer->Header.Req.address = address;
110 ipmbBuffer->Header.Req.rsNetFnLUN = ipmbNetFnLunSet(netFn, rsLun);
111 ipmbBuffer->Header.Req.rqSA = rqSA;
112 ipmbBuffer->Header.Req.rqSeqLUN = ipmbSeqLunSet(seq, rqLun);
113 ipmbBuffer->Header.Req.cmd = cmd;
114
Qiang XUbbfd00a2019-06-27 21:10:06 +0800115 ipmbBuffer->Header.Req.checksum1 = ipmbChecksumCompute(
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800116 (uint8_t *)ipmbBuffer, ipmbConnectionHeaderLength - ipmbChecksumSize);
Dawid Fryckia642a942018-06-12 10:44:23 -0700117
118 if (data.size() > 0)
119 {
120 std::copy(data.begin(), data.end(), ipmbBuffer->Header.Req.data);
121 }
122
123 buffer[bufferLength - ipmbChecksumSize] =
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800124 ipmbChecksumCompute((uint8_t *)ipmbBuffer + ipmbChecksum2StartOffset,
Dawid Fryckia642a942018-06-12 10:44:23 -0700125 (ipmbRequestDataHeaderLength + data.size()));
126
127 return 0;
128}
129
130std::tuple<int, uint8_t, uint8_t, uint8_t, uint8_t, std::vector<uint8_t>>
131 IpmbRequest::returnMatchedResponse()
132{
133 return std::make_tuple(
134 static_cast<int>(ipmbResponseStatus::success), matchedResponse->netFn,
135 matchedResponse->rsLun, matchedResponse->cmd,
136 matchedResponse->completionCode, matchedResponse->data);
137}
138
139static std::tuple<int, uint8_t, uint8_t, uint8_t, uint8_t, std::vector<uint8_t>>
140 returnStatus(ipmbResponseStatus status)
141{
142 // we only want to send status here, other fields are not relevant
143 return std::make_tuple(static_cast<int>(status), 0, 0, 0, 0,
144 std::vector<uint8_t>(0));
145}
146
Dawid Fryckia642a942018-06-12 10:44:23 -0700147/**
148 * @brief Ipmb response class methods
149 */
150IpmbResponse::IpmbResponse()
151{
152 data.reserve(ipmbMaxDataSize);
153}
154
155IpmbResponse::IpmbResponse(uint8_t address, uint8_t netFn, uint8_t rqLun,
156 uint8_t rsSA, uint8_t seq, uint8_t rsLun,
157 uint8_t cmd, uint8_t completionCode,
Dawid Frycki8188d762019-04-01 18:03:48 -0700158 const std::vector<uint8_t> &inputData) :
Dawid Fryckia642a942018-06-12 10:44:23 -0700159 address(address),
160 netFn(netFn), rqLun(rqLun), rsSA(rsSA), seq(seq), rsLun(rsLun), cmd(cmd),
161 completionCode(completionCode)
162{
163 data.reserve(ipmbMaxDataSize);
164
165 if (inputData.size() > 0)
166 {
167 data = std::move(inputData);
168 }
169}
170
171void IpmbResponse::i2cToIpmbConstruct(IPMB_HEADER *ipmbBuffer,
172 size_t bufferLength)
173{
174 netFn = ipmbNetFnGet(ipmbBuffer->Header.Resp.rqNetFnLUN);
175 rqLun = ipmbLunFromNetFnLunGet(ipmbBuffer->Header.Resp.rqNetFnLUN);
176 rsSA = ipmbBuffer->Header.Resp.rsSA;
177 seq = ipmbSeqGet(ipmbBuffer->Header.Resp.rsSeqLUN);
178 rsLun = ipmbLunFromSeqLunGet(ipmbBuffer->Header.Resp.rsSeqLUN);
179 cmd = ipmbBuffer->Header.Resp.cmd;
180 completionCode = ipmbBuffer->Header.Resp.completionCode;
181
182 size_t dataLength =
183 bufferLength - (ipmbConnectionHeaderLength +
184 ipmbResponseDataHeaderLength + ipmbChecksumSize);
185
186 if (dataLength > 0)
187 {
188 data.insert(data.end(), ipmbBuffer->Header.Resp.data,
189 &ipmbBuffer->Header.Resp.data[dataLength]);
190 }
191}
192
Dawid Frycki8188d762019-04-01 18:03:48 -0700193std::shared_ptr<std::vector<uint8_t>> IpmbResponse::ipmbToi2cConstruct()
Dawid Fryckia642a942018-06-12 10:44:23 -0700194{
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800195 /* Add one byte for length byte as per required by driver */
196 size_t bufferLength = 1 + data.size() + ipmbResponseDataHeaderLength +
Dawid Fryckia642a942018-06-12 10:44:23 -0700197 ipmbConnectionHeaderLength + ipmbChecksumSize;
198
199 if (bufferLength > ipmbMaxFrameLength)
200 {
Dawid Frycki8188d762019-04-01 18:03:48 -0700201 return nullptr;
Dawid Fryckia642a942018-06-12 10:44:23 -0700202 }
203
Dawid Frycki8188d762019-04-01 18:03:48 -0700204 std::shared_ptr<std::vector<uint8_t>> buffer =
205 std::make_shared<std::vector<uint8_t>>(bufferLength);
206
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800207 IPMB_PKT *ipmbPkt = reinterpret_cast<IPMB_PKT *>(buffer->data());
208 ipmbPkt->len = bufferLength - 1;
209 IPMB_HEADER *ipmbBuffer = &(ipmbPkt->hdr);
Dawid Fryckia642a942018-06-12 10:44:23 -0700210
211 ipmbBuffer->Header.Resp.address = address;
212 ipmbBuffer->Header.Resp.rqNetFnLUN = ipmbNetFnLunSet(netFn, rqLun);
213 ipmbBuffer->Header.Resp.rsSA = rsSA;
214 ipmbBuffer->Header.Resp.rsSeqLUN = ipmbSeqLunSet(seq, rsLun);
215 ipmbBuffer->Header.Resp.cmd = cmd;
216 ipmbBuffer->Header.Resp.completionCode = completionCode;
217
218 ipmbBuffer->Header.Resp.checksum1 = ipmbChecksumCompute(
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800219 (uint8_t *)ipmbBuffer, ipmbConnectionHeaderLength - ipmbChecksumSize);
Dawid Fryckia642a942018-06-12 10:44:23 -0700220
221 if (data.size() > 0)
222 {
223 std::copy(data.begin(), data.end(), ipmbBuffer->Header.Resp.data);
224 }
225
Dawid Frycki8188d762019-04-01 18:03:48 -0700226 (*buffer)[bufferLength - ipmbChecksumSize] =
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800227 ipmbChecksumCompute((uint8_t *)ipmbBuffer + ipmbChecksum2StartOffset,
Dawid Fryckia642a942018-06-12 10:44:23 -0700228 (ipmbResponseDataHeaderLength + data.size()));
229
Dawid Frycki8188d762019-04-01 18:03:48 -0700230 return buffer;
Dawid Fryckia642a942018-06-12 10:44:23 -0700231}
232
233bool IpmbCommandFilter::isBlocked(const uint8_t reqNetFn, const uint8_t cmd)
234{
235 auto blockedCmd = unhandledCommands.find({reqNetFn, cmd});
236
237 if (blockedCmd != unhandledCommands.end())
238 {
239 return true;
240 }
241
242 return false;
243}
244
245void IpmbCommandFilter::addFilter(const uint8_t reqNetFn, const uint8_t cmd)
246{
247 if (unhandledCommands.insert({reqNetFn, cmd}).second)
248 {
249 phosphor::logging::log<phosphor::logging::level::INFO>(
250 "addFilter: added command to filter",
251 phosphor::logging::entry("netFn = %d", reqNetFn),
252 phosphor::logging::entry("cmd = %d", cmd));
253 }
254}
255
256/**
257 * @brief Ipmb channel
258 */
Qiang XUbbfd00a2019-06-27 21:10:06 +0800259void IpmbChannel::ipmbSendI2cFrame(std::shared_ptr<std::vector<uint8_t>> buffer,
Dawid Fryckia642a942018-06-12 10:44:23 -0700260 size_t retriesAttempted = 0)
261{
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800262 IPMB_PKT *ipmbPkt = reinterpret_cast<IPMB_PKT *>(buffer->data());
263 uint8_t targetAddr = ipmbIsResponse(&(ipmbPkt->hdr))
264 ? ipmbPkt->hdr.Header.Resp.address
265 : ipmbPkt->hdr.Header.Req.address;
266 boost::asio::async_write(
267 i2cSlaveDescriptor, boost::asio::buffer(*buffer),
268 [this, buffer, retriesAttempted,
269 targetAddr](const boost::system::error_code &ec, size_t bytesSent) {
270 if (ec)
Dawid Fryckia642a942018-06-12 10:44:23 -0700271 {
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800272 size_t currentRetryCnt = retriesAttempted;
273
274 if (currentRetryCnt > ipmbI2cNumberOfRetries)
275 {
276 std::string msgToLog =
277 "ipmbSendI2cFrame: send to I2C failed after retries."
278 " busId=" +
279 std::to_string(ipmbBusId) +
280 ", targetAddr=" + std::to_string(targetAddr) +
281 ", error=" + ec.message();
282 phosphor::logging::log<phosphor::logging::level::ERR>(
283 msgToLog.c_str());
284 return;
285 }
286 currentRetryCnt++;
287 ipmbSendI2cFrame(buffer, currentRetryCnt);
Dawid Fryckia642a942018-06-12 10:44:23 -0700288 }
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800289 });
Dawid Fryckia642a942018-06-12 10:44:23 -0700290}
291
292/**
293 * @brief Ipmb Outstanding Requests
294 */
295void IpmbChannel::makeRequestInvalid(IpmbRequest &request)
296{
297 // change request state to invalid and remove it from outstanding requests
298 // list
299 request.state = ipmbRequestState::invalid;
300 outstandingRequests[request.seq] = nullptr;
301}
302
303void IpmbChannel::makeRequestValid(std::shared_ptr<IpmbRequest> request)
304{
305 // change request state to valid and add it to outstanding requests list
306 request->state = ipmbRequestState::valid;
307 outstandingRequests[request->seq] = request;
308}
309
310bool IpmbChannel::seqNumGet(uint8_t &seq)
311{
312 static uint8_t seqNum = 0;
313
314 for (int i = 0; i < ipmbMaxOutstandingRequestsCount; i++)
315 {
316 seqNum = ++seqNum & ipmbSeqMask;
317 if (seqNum == ipmbMaxOutstandingRequestsCount)
318 {
319 seqNum = 0;
320 }
321
322 if (outstandingRequests[seqNum] == nullptr)
323 {
324 seq = seqNum;
325 return true;
326 }
327 }
328
329 return false;
330}
331
332void IpmbChannel::responseMatch(std::unique_ptr<IpmbResponse> &response)
333{
334 std::shared_ptr<IpmbRequest> request = outstandingRequests[response->seq];
335
336 if (request != nullptr)
337 {
338 if (((ipmbRespNetFn(request->netFn)) == (response->netFn)) &&
339 ((request->rqLun) == (response->rqLun)) &&
340 ((request->rsLun) == (response->rsLun)) &&
341 ((request->cmd) == (response->cmd)))
342 {
343 // match, response is corresponding to previously sent request
344 request->state = ipmbRequestState::matched;
345 request->timer->cancel();
346 request->matchedResponse = std::move(response);
347 }
348 }
349}
350
351void IpmbChannel::processI2cEvent()
352{
353 std::array<uint8_t, ipmbMaxFrameLength> buffer{};
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800354 IPMB_PKT *ipmbPkt = reinterpret_cast<IPMB_PKT *>(buffer.data());
355 IPMB_HEADER *ipmbFrame = &(ipmbPkt->hdr);
Dawid Fryckia642a942018-06-12 10:44:23 -0700356
357 lseek(ipmbi2cSlaveFd, 0, SEEK_SET);
358 int r = read(ipmbi2cSlaveFd, buffer.data(), ipmbMaxFrameLength);
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800359
360 /* Substract first byte len size from total frame length */
361 r--;
362
Dawid Fryckia642a942018-06-12 10:44:23 -0700363 if ((r < ipmbMinFrameLength) || (r > ipmbMaxFrameLength))
364 {
365 goto end;
366 }
367
368 // valiate the frame
369 if (!isFrameValid(ipmbFrame, r))
370 {
371 goto end;
372 }
373
Qiang XUbbfd00a2019-06-27 21:10:06 +0800374 // if it is broadcast message from ipmb channel, send out dbus signal
375 if (ipmbFrame->Header.Req.address == broadcastAddress &&
376 getChannelType() == ipmbChannelType::ipmb)
377 {
378 auto ipmbMessageReceived = IpmbRequest();
379 ipmbMessageReceived.i2cToIpmbConstruct(ipmbFrame, r);
380 sdbusplus::message::message msg =
381 conn->new_signal(ipmbObj, ipmbDbusIntf, "receiveBroadcast");
382 msg.append(ipmbMessageReceived.netFn, ipmbMessageReceived.cmd,
383 ipmbMessageReceived.data);
384 msg.signal_send();
385 }
386
Dawid Fryckia642a942018-06-12 10:44:23 -0700387 // copy frame to ipmib message buffer
Qiang XUbbfd00a2019-06-27 21:10:06 +0800388 else if (ipmbIsResponse(ipmbFrame))
Dawid Fryckia642a942018-06-12 10:44:23 -0700389 {
390 std::unique_ptr<IpmbResponse> ipmbMessageReceived =
391 std::make_unique<IpmbResponse>();
392
393 ipmbMessageReceived->i2cToIpmbConstruct(ipmbFrame, r);
394
395 // try to match response with outstanding request
396 responseMatch(ipmbMessageReceived);
397 }
398 else
399 {
400 // if command is blocked - respond with 'invalid command'
401 // completion code
402 if (commandFilter)
403 {
404 uint8_t netFn = ipmbNetFnGet(ipmbFrame->Header.Req.rsNetFnLUN);
405 uint8_t cmd = ipmbFrame->Header.Req.cmd;
Qiang XUbbfd00a2019-06-27 21:10:06 +0800406 uint8_t rqSA = ipmbFrame->Header.Req.rqSA;
Dawid Fryckia642a942018-06-12 10:44:23 -0700407
408 if (commandFilter->isBlocked(netFn, cmd))
409 {
410 uint8_t seq = ipmbSeqGet(ipmbFrame->Header.Req.rqSeqLUN);
411 uint8_t lun =
412 ipmbLunFromSeqLunGet(ipmbFrame->Header.Req.rqSeqLUN);
Dawid Fryckia642a942018-06-12 10:44:23 -0700413
414 // prepare generic response
Qiang XUbbfd00a2019-06-27 21:10:06 +0800415 auto ipmbResponse = IpmbResponse(
416 rqSA, ipmbRespNetFn(netFn), lun, ipmbBmcSlaveAddress, seq,
417 ipmbRsLun, cmd, ipmbIpmiInvalidCmd, {});
Dawid Fryckia642a942018-06-12 10:44:23 -0700418
Dawid Frycki8188d762019-04-01 18:03:48 -0700419 auto buffer = ipmbResponse.ipmbToi2cConstruct();
420 if (buffer)
Dawid Fryckia642a942018-06-12 10:44:23 -0700421 {
Qiang XUbbfd00a2019-06-27 21:10:06 +0800422 ipmbSendI2cFrame(buffer);
Dawid Fryckia642a942018-06-12 10:44:23 -0700423 }
424
425 goto end;
426 }
427 }
428
429 auto ipmbMessageReceived = IpmbRequest();
Dawid Fryckia642a942018-06-12 10:44:23 -0700430 ipmbMessageReceived.i2cToIpmbConstruct(ipmbFrame, r);
431
Dawid Frycki8188d762019-04-01 18:03:48 -0700432 std::map<std::string, std::variant<int>> options{
Qiang XUbbfd00a2019-06-27 21:10:06 +0800433 {"rqSA", ipmbAddressTo7BitSet(ipmbMessageReceived.rqSA)}};
Dawid Frycki8188d762019-04-01 18:03:48 -0700434 using IpmiDbusRspType = std::tuple<uint8_t, uint8_t, uint8_t, uint8_t,
435 std::vector<uint8_t>>;
436 conn->async_method_call(
437 [this, rqLun{ipmbMessageReceived.rqLun},
Qiang XUbbfd00a2019-06-27 21:10:06 +0800438 seq{ipmbMessageReceived.seq}, address{ipmbMessageReceived.rqSA}](
439 const boost::system::error_code &ec,
440 const IpmiDbusRspType &response) {
Dawid Frycki8188d762019-04-01 18:03:48 -0700441 const auto &[netfn, lun, cmd, cc, payload] = response;
442 if (ec)
443 {
444 phosphor::logging::log<phosphor::logging::level::ERR>(
445 "processI2cEvent: error getting response from IPMI");
446 return;
447 }
Dawid Fryckia642a942018-06-12 10:44:23 -0700448
Dawid Frycki8188d762019-04-01 18:03:48 -0700449 uint8_t bmcSlaveAddress = getBmcSlaveAddress();
450
451 if (payload.size() > ipmbMaxDataSize)
452 {
453 phosphor::logging::log<phosphor::logging::level::ERR>(
454 "processI2cEvent: response exceeding maximum size");
455
456 // prepare generic response
457 auto ipmbResponse = IpmbResponse(
Qiang XUbbfd00a2019-06-27 21:10:06 +0800458 address, netfn, rqLun, bmcSlaveAddress, seq, ipmbRsLun,
459 cmd, ipmbIpmiCmdRespNotProvided, {});
Dawid Frycki8188d762019-04-01 18:03:48 -0700460
461 auto buffer = ipmbResponse.ipmbToi2cConstruct();
462 if (buffer)
463 {
Qiang XUbbfd00a2019-06-27 21:10:06 +0800464 ipmbSendI2cFrame(buffer);
Dawid Frycki8188d762019-04-01 18:03:48 -0700465 }
466
467 return;
468 }
469
470 if (!(netfn & ipmbNetFnResponseMask))
471 {
472 // we are not expecting request here
473 phosphor::logging::log<phosphor::logging::level::ERR>(
474 "processI2cEvent: got a request instead of response");
475 return;
476 }
477
478 // if command is not supported, add it to filter
479 if (cc == ipmbIpmiInvalidCmd)
480 {
481 addFilter(ipmbReqNetFnFromRespNetFn(netfn), cmd);
482 }
483
484 // payload is empty after constructor invocation
485 auto ipmbResponse =
Qiang XUbbfd00a2019-06-27 21:10:06 +0800486 IpmbResponse(address, netfn, rqLun, bmcSlaveAddress, seq,
487 lun, cmd, cc, payload);
Dawid Frycki8188d762019-04-01 18:03:48 -0700488
489 auto buffer = ipmbResponse.ipmbToi2cConstruct();
490 if (!buffer)
491 {
492 phosphor::logging::log<phosphor::logging::level::ERR>(
493 "processI2cEvent: error constructing a request");
494 return;
495 }
496
Qiang XUbbfd00a2019-06-27 21:10:06 +0800497 ipmbSendI2cFrame(buffer);
Dawid Frycki8188d762019-04-01 18:03:48 -0700498 },
499 "xyz.openbmc_project.Ipmi.Host", "/xyz/openbmc_project/Ipmi",
500 "xyz.openbmc_project.Ipmi.Server", "execute",
501 ipmbMessageReceived.netFn, ipmbMessageReceived.rsLun,
502 ipmbMessageReceived.cmd, ipmbMessageReceived.data, options);
Dawid Fryckia642a942018-06-12 10:44:23 -0700503 }
504
505end:
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800506 i2cSlaveDescriptor.async_wait(
507 boost::asio::posix::descriptor_base::wait_read,
Dawid Fryckia642a942018-06-12 10:44:23 -0700508 [this](const boost::system::error_code &ec) {
509 if (ec)
510 {
511 phosphor::logging::log<phosphor::logging::level::ERR>(
512 "Error: processI2cEvent()");
513 return;
514 }
515
516 processI2cEvent();
517 });
518}
519
520IpmbChannel::IpmbChannel(boost::asio::io_service &io,
521 uint8_t ipmbBmcSlaveAddress,
522 uint8_t ipmbRqSlaveAddress, ipmbChannelType type,
523 std::shared_ptr<IpmbCommandFilter> commandFilter) :
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800524 i2cSlaveDescriptor(io),
525 ipmbBmcSlaveAddress(ipmbBmcSlaveAddress),
Dawid Fryckia642a942018-06-12 10:44:23 -0700526 ipmbRqSlaveAddress(ipmbRqSlaveAddress), type(type),
527 commandFilter(commandFilter)
528{
529}
530
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800531int IpmbChannel::ipmbChannelInit(const char *ipmbI2cSlave)
Dawid Fryckia642a942018-06-12 10:44:23 -0700532{
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800533 // extract bus id from slave path and save
534 std::string ipmbI2cSlaveStr(ipmbI2cSlave);
535 auto findHyphen = ipmbI2cSlaveStr.find("-");
536 std::string busStr = ipmbI2cSlaveStr.substr(findHyphen + 1);
Qiang XU8edcf1a2019-06-14 22:18:15 +0800537 try
538 {
539 ipmbBusId = std::stoi(busStr);
540 }
541 catch (std::invalid_argument)
542 {
543 phosphor::logging::log<phosphor::logging::level::ERR>(
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800544 "ipmbChannelInit: invalid bus id in slave-path config");
Qiang XU8edcf1a2019-06-14 22:18:15 +0800545 return -1;
546 }
547
548 // Check if sysfs has device. If not, enable I2C slave driver by command
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800549 // echo "ipmb-dev 0x1010" > /sys/bus/i2c/devices/i2c-0/new_device
Qiang XU8edcf1a2019-06-14 22:18:15 +0800550 bool hasSysfs = std::filesystem::exists(ipmbI2cSlave);
551 if (!hasSysfs)
552 {
553 std::string deviceFileName =
554 "/sys/bus/i2c/devices/i2c-" + busStr + "/new_device";
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800555 std::string para = "ipmb-dev 0x1010"; // init with BMC addr 0x20
Qiang XU8edcf1a2019-06-14 22:18:15 +0800556 std::fstream deviceFile;
557 deviceFile.open(deviceFileName, std::ios::out);
558 if (!deviceFile.good())
559 {
560 phosphor::logging::log<phosphor::logging::level::ERR>(
561 "ipmbChannelInit: error opening deviceFile");
562 return -1;
563 }
564 deviceFile << para;
565 deviceFile.close();
566 }
567
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800568 // open fd to i2c slave device for read write
569 ipmbi2cSlaveFd = open(ipmbI2cSlave, O_RDWR | O_NONBLOCK | O_CLOEXEC);
Dawid Fryckia642a942018-06-12 10:44:23 -0700570 if (ipmbi2cSlaveFd < 0)
571 {
572 phosphor::logging::log<phosphor::logging::level::ERR>(
573 "ipmbChannelInit: error opening ipmbI2cSlave");
574 return -1;
575 }
576
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800577 i2cSlaveDescriptor.assign(ipmbi2cSlaveFd);
Dawid Fryckia642a942018-06-12 10:44:23 -0700578
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800579 i2cSlaveDescriptor.async_wait(
580 boost::asio::posix::descriptor_base::wait_read,
Dawid Fryckia642a942018-06-12 10:44:23 -0700581 [this](const boost::system::error_code &ec) {
582 if (ec)
583 {
584 phosphor::logging::log<phosphor::logging::level::ERR>(
585 "Error: processI2cEvent()");
586 return;
587 }
588
589 processI2cEvent();
590 });
591
592 return 0;
593}
594
Qiang XU8edcf1a2019-06-14 22:18:15 +0800595int IpmbChannel::ipmbChannelUpdateSlaveAddress(const uint8_t newBmcSlaveAddr)
596{
597 if (ipmbi2cSlaveFd > 0)
598 {
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800599 i2cSlaveDescriptor.close();
Qiang XU8edcf1a2019-06-14 22:18:15 +0800600 close(ipmbi2cSlaveFd);
601 ipmbi2cSlaveFd = 0;
602 }
603
604 // disable old I2C slave driver by command:
605 // echo "0x1010" > /sys/bus/i2c/devices/i2c-0/delete_device
606 std::string deviceFileName;
607 std::string para;
608 std::fstream deviceFile;
609 deviceFileName = "/sys/bus/i2c/devices/i2c-" + std::to_string(ipmbBusId) +
610 "/delete_device";
611 para = "0x1010"; // align with removed ipmb0 definition in dts file
612 deviceFile.open(deviceFileName, std::ios::out);
613 if (!deviceFile.good())
614 {
615 phosphor::logging::log<phosphor::logging::level::ERR>(
616 "ipmbChannelUpdateSlaveAddress: error opening deviceFile to delete "
617 "sysfs");
618 return -1;
619 }
620 deviceFile << para;
621 deviceFile.close();
622
623 // enable new I2C slave driver by command:
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800624 // echo "ipmb-dev 0x1012" > /sys/bus/i2c/devices/i2c-0/new_device
Qiang XU8edcf1a2019-06-14 22:18:15 +0800625 deviceFileName =
626 "/sys/bus/i2c/devices/i2c-" + std::to_string(ipmbBusId) + "/new_device";
627 std::ostringstream hex;
628 uint16_t addr = 0x1000 + (newBmcSlaveAddr >> 1);
629 hex << std::hex << static_cast<uint16_t>(addr);
630 const std::string &addressHexStr = hex.str();
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800631 para = "ipmb-dev 0x" + addressHexStr;
Qiang XU8edcf1a2019-06-14 22:18:15 +0800632 deviceFile.open(deviceFileName, std::ios::out);
633 if (!deviceFile.good())
634 {
635 phosphor::logging::log<phosphor::logging::level::ERR>(
636 "ipmbChannelUpdateSlaveAddress: error opening deviceFile to create "
637 "sysfs");
638 return -1;
639 }
640 deviceFile << para;
641 deviceFile.close();
642
643 // open fd to i2c slave device
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800644 std::string ipmbI2cSlaveStr = "/dev/ipmb-" + std::to_string(ipmbBusId);
645 ipmbi2cSlaveFd = open(ipmbI2cSlaveStr.c_str(), O_RDWR | O_NONBLOCK);
Qiang XU8edcf1a2019-06-14 22:18:15 +0800646 if (ipmbi2cSlaveFd < 0)
647 {
648 phosphor::logging::log<phosphor::logging::level::ERR>(
649 "ipmbChannelInit: error opening ipmbI2cSlave");
650 return -1;
651 }
652
653 // start to receive i2c data as slave
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800654 i2cSlaveDescriptor.assign(ipmbi2cSlaveFd);
655 i2cSlaveDescriptor.async_wait(
656 boost::asio::posix::descriptor_base::wait_read,
Qiang XU8edcf1a2019-06-14 22:18:15 +0800657 [this](const boost::system::error_code &ec) {
658 if (ec)
659 {
660 phosphor::logging::log<phosphor::logging::level::ERR>(
661 "Error: processI2cEvent()");
662 return;
663 }
664
665 processI2cEvent();
666 });
667
Qiang XUbbfd00a2019-06-27 21:10:06 +0800668 ipmbBmcSlaveAddress = newBmcSlaveAddr;
669
Qiang XU8edcf1a2019-06-14 22:18:15 +0800670 return 0;
671}
672
673uint8_t IpmbChannel::getBusId()
674{
675 return ipmbBusId;
676}
677
Dawid Fryckia642a942018-06-12 10:44:23 -0700678uint8_t IpmbChannel::getBmcSlaveAddress()
679{
680 return ipmbBmcSlaveAddress;
681}
682
683uint8_t IpmbChannel::getRqSlaveAddress()
684{
685 return ipmbRqSlaveAddress;
686}
687
688ipmbChannelType IpmbChannel::getChannelType()
689{
690 return type;
691}
692
693void IpmbChannel::addFilter(const uint8_t respNetFn, const uint8_t cmd)
694{
695 if (commandFilter)
696 {
697 commandFilter->addFilter(respNetFn, cmd);
698 }
699}
700
701std::tuple<int, uint8_t, uint8_t, uint8_t, uint8_t, std::vector<uint8_t>>
702 IpmbChannel::requestAdd(boost::asio::yield_context &yield,
703 std::shared_ptr<IpmbRequest> request)
704{
705 makeRequestValid(request);
706
707 std::vector<uint8_t> buffer(0);
708 if (request->ipmbToi2cConstruct(buffer) != 0)
709 {
710 return returnStatus(ipmbResponseStatus::error);
711 }
712
713 for (int i = 0; i < ipmbNumberOfTries; i++)
714 {
715 boost::system::error_code ec;
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800716 int i2cRetryCnt = 0;
Dawid Fryckia642a942018-06-12 10:44:23 -0700717
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800718 for (; i2cRetryCnt < ipmbI2cNumberOfRetries; i2cRetryCnt++)
Dawid Fryckia642a942018-06-12 10:44:23 -0700719 {
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800720 boost::asio::async_write(i2cSlaveDescriptor,
721 boost::asio::buffer(buffer), yield[ec]);
Dawid Fryckia642a942018-06-12 10:44:23 -0700722
723 if (ec)
724 {
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800725 continue; // retry
Dawid Fryckia642a942018-06-12 10:44:23 -0700726 }
727 break;
728 }
729
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800730 if (i2cRetryCnt == ipmbI2cNumberOfRetries)
731 {
Qiang XUbbfd00a2019-06-27 21:10:06 +0800732 std::string msgToLog =
733 "requestAdd: Sent to I2C failed after retries."
734 " busId=" +
735 std::to_string(ipmbBusId) + ", error=" + ec.message();
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800736 phosphor::logging::log<phosphor::logging::level::INFO>(
Qiang XUbbfd00a2019-06-27 21:10:06 +0800737 msgToLog.c_str());
Jae Hyun Yoo25e85c72019-03-05 14:28:13 -0800738 }
739
Dawid Fryckia642a942018-06-12 10:44:23 -0700740 request->timer->expires_after(
741 std::chrono::milliseconds(ipmbRequestRetryTimeout));
742 request->timer->async_wait(yield[ec]);
743
744 if (ec && ec != boost::asio::error::operation_aborted)
745 {
746 // unexpected error - invalidate request and return generic error
747 phosphor::logging::log<phosphor::logging::level::ERR>(
748 "requestAdd: async_wait error");
749 makeRequestInvalid(*request);
750 return returnStatus(ipmbResponseStatus::error);
751 }
752
753 if (request->state == ipmbRequestState::matched)
754 {
755 // matched response, send it to client application
756 makeRequestInvalid(*request);
757 return request->returnMatchedResponse();
758 }
759 }
760
761 makeRequestInvalid(*request);
762 return returnStatus(ipmbResponseStatus::timeout);
763}
764
765static IpmbChannel *getChannel(ipmbChannelType channelType)
766{
767 auto channel =
768 std::find_if(ipmbChannels.begin(), ipmbChannels.end(),
769 [channelType](IpmbChannel &channel) {
770 return channel.getChannelType() == channelType;
771 });
772 if (channel != ipmbChannels.end())
773 {
774 return &(*channel);
775 }
776
777 return nullptr;
778}
779
780static int initializeChannels()
781{
782 std::shared_ptr<IpmbCommandFilter> commandFilter =
783 std::make_shared<IpmbCommandFilter>();
784
Amithash Prasad314862d2019-03-26 11:14:03 -0700785 constexpr const char *configFilePath =
786 "/usr/share/ipmbbridge/ipmb-channels.json";
787 std::ifstream configFile(configFilePath);
788 if (!configFile.is_open())
Dawid Fryckia642a942018-06-12 10:44:23 -0700789 {
Amithash Prasad314862d2019-03-26 11:14:03 -0700790 phosphor::logging::log<phosphor::logging::level::ERR>(
791 "initializeChannels: Cannot open config path");
792 return -1;
793 }
794 try
795 {
796 auto data = nlohmann::json::parse(configFile, nullptr);
797 for (const auto &channelConfig : data["channels"])
Dawid Fryckia642a942018-06-12 10:44:23 -0700798 {
Amithash Prasad314862d2019-03-26 11:14:03 -0700799 const std::string &typeConfig = channelConfig["type"];
Amithash Prasad314862d2019-03-26 11:14:03 -0700800 const std::string &slavePath = channelConfig["slave-path"];
801 uint8_t bmcAddr = channelConfig["bmc-addr"];
802 uint8_t reqAddr = channelConfig["remote-addr"];
803 ipmbChannelType type = ipmbChannelTypeMap.at(typeConfig);
804
805 auto channel = ipmbChannels.emplace(ipmbChannels.end(), io, bmcAddr,
806 reqAddr, type, commandFilter);
Vijay Khemka37a7eac2019-12-06 13:52:28 -0800807 if (channel->ipmbChannelInit(slavePath.c_str()) < 0)
Amithash Prasad314862d2019-03-26 11:14:03 -0700808 {
809 phosphor::logging::log<phosphor::logging::level::ERR>(
810 "initializeChannels: channel initialization failed");
811 return -1;
812 }
Dawid Fryckia642a942018-06-12 10:44:23 -0700813 }
814 }
Amithash Prasad314862d2019-03-26 11:14:03 -0700815 catch (nlohmann::json::exception &e)
816 {
817 phosphor::logging::log<phosphor::logging::level::ERR>(
818 "initializeChannels: Error parsing config file");
819 return -1;
820 }
821 catch (std::out_of_range &e)
822 {
823 phosphor::logging::log<phosphor::logging::level::ERR>(
824 "initializeChannels: Error invalid type");
825 return -1;
826 }
Dawid Fryckia642a942018-06-12 10:44:23 -0700827 return 0;
828}
829
Dawid Fryckia642a942018-06-12 10:44:23 -0700830auto ipmbHandleRequest = [](boost::asio::yield_context yield,
831 uint8_t reqChannel, uint8_t netfn, uint8_t lun,
832 uint8_t cmd, std::vector<uint8_t> dataReceived) {
833 IpmbChannel *channel = getChannel(static_cast<ipmbChannelType>(reqChannel));
834 if (channel == nullptr)
835 {
836 phosphor::logging::log<phosphor::logging::level::ERR>(
837 "ipmbHandleRequest: requested channel does not exist");
838 return returnStatus(ipmbResponseStatus::invalid_param);
839 }
840
841 // check outstanding request list for valid sequence number
842 uint8_t seqNum = 0;
843 bool seqValid = channel->seqNumGet(seqNum);
844 if (!seqValid)
845 {
846 phosphor::logging::log<phosphor::logging::level::WARNING>(
847 "ipmbHandleRequest: cannot add more requests to the list");
848 return returnStatus(ipmbResponseStatus::busy);
849 }
850
851 uint8_t bmcSlaveAddress = channel->getBmcSlaveAddress();
852 uint8_t rqSlaveAddress = channel->getRqSlaveAddress();
853
854 // construct the request to add it to outstanding request list
855 std::shared_ptr<IpmbRequest> request = std::make_shared<IpmbRequest>(
856 rqSlaveAddress, netfn, ipmbRsLun, bmcSlaveAddress, seqNum, lun, cmd,
857 dataReceived);
858
859 if (!request->timer)
860 {
861 phosphor::logging::log<phosphor::logging::level::ERR>(
862 "ipmbHandleRequest: timer object does not exist");
863 return returnStatus(ipmbResponseStatus::error);
864 }
865
866 return channel->requestAdd(yield, request);
867};
868
Qiang XU8edcf1a2019-06-14 22:18:15 +0800869void addUpdateSlaveAddrHandler()
870{
871 // callback to handle dbus signal of updating slave addr
872 std::function<void(sdbusplus::message::message &)> updateSlaveAddrHandler =
873 [](sdbusplus::message::message &message) {
874 uint8_t reqChannel, busId, slaveAddr;
875
876 // valid source of signal, check whether from multi-node manager
877 std::string pathName = message.get_path();
878 if (pathName != "/xyz/openbmc_project/MultiNode/Status")
879 {
880 phosphor::logging::log<phosphor::logging::level::ERR>(
881 "addUpdateSlaveAddrHandler: invalid obj path");
882 return;
883 }
884
885 message.read(reqChannel, busId, slaveAddr);
886
887 IpmbChannel *channel =
888 getChannel(static_cast<ipmbChannelType>(reqChannel));
889 if (channel == nullptr ||
890 reqChannel != static_cast<uint8_t>(ipmbChannelType::ipmb))
891 {
892 phosphor::logging::log<phosphor::logging::level::ERR>(
893 "addUpdateSlaveAddrHandler: invalid channel");
894 return;
895 }
896 if (busId != channel->getBusId())
897 {
898 phosphor::logging::log<phosphor::logging::level::ERR>(
899 "addUpdateSlaveAddrHandler: invalid busId");
900 return;
901 }
902 if (channel->getBmcSlaveAddress() == slaveAddr)
903 {
904 phosphor::logging::log<phosphor::logging::level::INFO>(
905 "addUpdateSlaveAddrHandler: channel bmc slave addr is "
906 "unchanged, do nothing");
907 return;
908 }
909
910 channel->ipmbChannelUpdateSlaveAddress(slaveAddr);
911 };
912
913 static auto match = std::make_unique<sdbusplus::bus::match::match>(
914 static_cast<sdbusplus::bus::bus &>(*conn),
915 "type='signal',member='updateBmcSlaveAddr',", updateSlaveAddrHandler);
916}
917
Qiang XUbbfd00a2019-06-27 21:10:06 +0800918void addSendBroadcastHandler()
919{
920 // callback to handle dbus signal of sending broadcast message
921 std::function<void(sdbusplus::message::message &)> sendBroadcastHandler =
922 [](sdbusplus::message::message &message) {
923 uint8_t reqChannel, netFn, lun, cmd;
924 std::vector<uint8_t> dataReceived;
925 message.read(reqChannel, netFn, lun, cmd, dataReceived);
926
927 IpmbChannel *channel =
928 getChannel(static_cast<ipmbChannelType>(reqChannel));
929 if (channel == nullptr)
930 {
931 phosphor::logging::log<phosphor::logging::level::ERR>(
932 "addSendBroadcastMsgHandler: requested channel does not "
933 "exist");
934 return;
935 }
936
937 uint8_t bmcSlaveAddress = channel->getBmcSlaveAddress();
938 uint8_t seqNum = 0; // seqNum is not used in broadcast msg
939 uint8_t targetAddr = broadcastAddress;
940
941 std::shared_ptr<IpmbRequest> request =
942 std::make_shared<IpmbRequest>(targetAddr, netFn, ipmbRsLun,
943 bmcSlaveAddress, seqNum, lun, cmd,
944 dataReceived);
945
946 std::shared_ptr<std::vector<uint8_t>> buffer =
947 std::make_shared<std::vector<uint8_t>>();
948
949 if (request->ipmbToi2cConstruct(*buffer) != 0)
950 {
951 return;
952 }
953
954 channel->ipmbSendI2cFrame(buffer);
955 };
956
957 static auto match = std::make_unique<sdbusplus::bus::match::match>(
958 static_cast<sdbusplus::bus::bus &>(*conn),
959 "type='signal',member='sendBroadcast',", sendBroadcastHandler);
960}
961
Dawid Fryckia642a942018-06-12 10:44:23 -0700962/**
963 * @brief Main
964 */
965int main(int argc, char *argv[])
966{
967 conn->request_name(ipmbBus);
968
969 auto server = sdbusplus::asio::object_server(conn);
970
Dawid Fryckia642a942018-06-12 10:44:23 -0700971 std::shared_ptr<sdbusplus::asio::dbus_interface> ipmbIface =
972 server.add_interface(ipmbObj, ipmbDbusIntf);
973
Dawid Fryckia642a942018-06-12 10:44:23 -0700974 ipmbIface->register_method("sendRequest", std::move(ipmbHandleRequest));
Dawid Fryckia642a942018-06-12 10:44:23 -0700975 ipmbIface->initialize();
976
977 if (initializeChannels() < 0)
978 {
979 phosphor::logging::log<phosphor::logging::level::ERR>(
980 "Error initializeChannels");
981 return -1;
982 }
983
Qiang XU8edcf1a2019-06-14 22:18:15 +0800984 addUpdateSlaveAddrHandler();
985
Qiang XUbbfd00a2019-06-27 21:10:06 +0800986 addSendBroadcastHandler();
987
Dawid Fryckia642a942018-06-12 10:44:23 -0700988 io.run();
989 return 0;
990}