blob: f82f6d4788644422996cab79e1857304e33585e9 [file] [log] [blame]
James Feist3cb5fec2018-01-23 14:41:51 -08001/*
2// Copyright (c) 2018 Intel 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
Patrick Venturea49dc332019-10-26 08:32:02 -070017#include "Utils.hpp"
18
James Feist3b860982018-10-02 14:34:07 -070019#include <errno.h>
James Feist3cb5fec2018-01-23 14:41:51 -080020#include <fcntl.h>
James Feist3b860982018-10-02 14:34:07 -070021#include <sys/inotify.h>
22#include <sys/ioctl.h>
23
James Feist3b860982018-10-02 14:34:07 -070024#include <boost/algorithm/string/predicate.hpp>
Brad Bishop82c84bb2020-08-26 14:12:50 -040025#include <boost/asio/deadline_timer.hpp>
26#include <boost/asio/io_service.hpp>
James Feist3b860982018-10-02 14:34:07 -070027#include <boost/container/flat_map.hpp>
James Feist8c505da2020-05-28 10:06:33 -070028#include <nlohmann/json.hpp>
29#include <sdbusplus/asio/connection.hpp>
30#include <sdbusplus/asio/object_server.hpp>
31
32#include <array>
James Feist3b860982018-10-02 14:34:07 -070033#include <chrono>
34#include <ctime>
Patrick Venturee3754002019-08-06 09:39:12 -070035#include <filesystem>
James Feist3cb5fec2018-01-23 14:41:51 -080036#include <fstream>
Patrick Venturebaba7672019-10-26 09:26:41 -070037#include <functional>
James Feist3cb5fec2018-01-23 14:41:51 -080038#include <future>
Patrick Venturec50e1ff2019-08-06 10:22:28 -070039#include <iomanip>
James Feist3cb5fec2018-01-23 14:41:51 -080040#include <iostream>
Patrick Venturee26395d2019-10-29 14:05:16 -070041#include <limits>
James Feist3f8a2782018-02-12 09:24:42 -080042#include <regex>
Patrick Venturec50e1ff2019-08-06 10:22:28 -070043#include <set>
44#include <sstream>
Patrick Venture11f1ff42019-08-01 10:42:12 -070045#include <string>
James Feist3b860982018-10-02 14:34:07 -070046#include <thread>
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +080047#include <utility>
James Feista465ccc2019-02-08 12:51:01 -080048#include <variant>
Patrick Venturec274f2f2019-10-26 09:27:23 -070049#include <vector>
James Feist3b860982018-10-02 14:34:07 -070050
James Feist8c505da2020-05-28 10:06:33 -070051extern "C"
52{
James Feist3b860982018-10-02 14:34:07 -070053#include <i2c/smbus.h>
54#include <linux/i2c-dev.h>
55}
James Feist3cb5fec2018-01-23 14:41:51 -080056
Ed Tanous072e25d2018-12-16 21:45:20 -080057namespace fs = std::filesystem;
James Feist3cb5fec2018-01-23 14:41:51 -080058static constexpr bool DEBUG = false;
59static size_t UNKNOWN_BUS_OBJECT_COUNT = 0;
James Feistb49ffc32018-05-02 11:10:43 -070060constexpr size_t MAX_FRU_SIZE = 512;
61constexpr size_t MAX_EEPROM_PAGE_INDEX = 255;
James Feist26c27ad2018-07-25 15:09:40 -070062constexpr size_t busTimeoutSeconds = 5;
James Feist3cb5fec2018-01-23 14:41:51 -080063
Patrick Venture11f1ff42019-08-01 10:42:12 -070064constexpr const char* blacklistPath = PACKAGE_DIR "blacklist.json";
65
James Feista465ccc2019-02-08 12:51:01 -080066const static constexpr char* BASEBOARD_FRU_LOCATION =
James Feist3cb5fec2018-01-23 14:41:51 -080067 "/etc/fru/baseboard.fru.bin";
68
James Feista465ccc2019-02-08 12:51:01 -080069const static constexpr char* I2C_DEV_LOCATION = "/dev";
James Feist4131aea2018-03-09 09:47:30 -080070
James Feista465ccc2019-02-08 12:51:01 -080071static constexpr std::array<const char*, 5> FRU_AREAS = {
James Feist3cb5fec2018-01-23 14:41:51 -080072 "INTERNAL", "CHASSIS", "BOARD", "PRODUCT", "MULTIRECORD"};
Jae Hyun Yoo3936e7a2018-03-23 17:26:16 -070073const static std::regex NON_ASCII_REGEX("[^\x01-\x7f]");
Andrei Kartashev1c5b7062020-08-19 14:47:30 +030074using DeviceMap = boost::container::flat_map<int, std::vector<uint8_t>>;
James Feist3cb5fec2018-01-23 14:41:51 -080075using BusMap = boost::container::flat_map<int, std::shared_ptr<DeviceMap>>;
76
James Feist444830e2019-04-05 08:38:16 -070077static std::set<size_t> busBlacklist;
James Feist6ebf9de2018-05-15 15:01:17 -070078struct FindDevicesWithCallback;
79
Nikhil Potaded8884f12019-03-27 13:27:13 -070080static BusMap busMap;
81
James Feistcb5661d2020-06-12 15:05:01 -070082static bool powerIsOn = false;
83
James Feist8a983922019-10-24 17:11:56 -070084static boost::container::flat_map<
85 std::pair<size_t, size_t>, std::shared_ptr<sdbusplus::asio::dbus_interface>>
86 foundDevices;
87
James Feist7972bb92019-11-13 15:59:24 -080088static boost::container::flat_map<size_t, std::set<size_t>> failedAddresses;
89
James Feist5cb06082019-10-24 17:11:13 -070090boost::asio::io_service io;
91auto systemBus = std::make_shared<sdbusplus::asio::connection>(io);
92auto objServer = sdbusplus::asio::object_server(systemBus);
93
Joshi-Mansid73b7442020-03-27 19:10:21 +053094static const std::vector<const char*> CHASSIS_FRU_AREAS = {
95 "PART_NUMBER", "SERIAL_NUMBER", "INFO_AM1", "INFO_AM2"};
96
97static const std::vector<const char*> BOARD_FRU_AREAS = {
98 "MANUFACTURER", "PRODUCT_NAME", "SERIAL_NUMBER", "PART_NUMBER",
99 "FRU_VERSION_ID", "INFO_AM1", "INFO_AM2"};
100
101static const std::vector<const char*> PRODUCT_FRU_AREAS = {
102 "MANUFACTURER", "PRODUCT_NAME", "PART_NUMBER", "VERSION", "SERIAL_NUMBER",
103 "ASSET_TAG", "FRU_VERSION_ID", "INFO_AM1", "INFO_AM2"};
104
Patrick Venturebaba7672019-10-26 09:26:41 -0700105bool validateHeader(const std::array<uint8_t, I2C_SMBUS_BLOCK_MAX>& blockData);
Joshi-Mansid73b7442020-03-27 19:10:21 +0530106bool updateFruProperty(
107 const std::string& assetTag, uint32_t bus, uint32_t address,
108 std::string propertyName,
109 boost::container::flat_map<
110 std::pair<size_t, size_t>,
111 std::shared_ptr<sdbusplus::asio::dbus_interface>>& dbusInterfaceMap);
Patrick Venturebaba7672019-10-26 09:26:41 -0700112
Xiang Liu2801a702020-01-20 14:29:34 -0800113using ReadBlockFunc =
114 std::function<int64_t(int flag, int file, uint16_t address, uint16_t offset,
115 uint8_t length, uint8_t* outBuf)>;
Patrick Venturebaba7672019-10-26 09:26:41 -0700116
117// Read and validate FRU contents, given the flag required for raw i2c, the open
118// file handle, a read method, and a helper string for failures.
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300119std::vector<uint8_t> readFruContents(int flag, int file, uint16_t address,
120 ReadBlockFunc readBlock,
121 const std::string& errorHelp)
Patrick Venturebaba7672019-10-26 09:26:41 -0700122{
123 std::array<uint8_t, I2C_SMBUS_BLOCK_MAX> blockData;
124
Xiang Liu2801a702020-01-20 14:29:34 -0800125 if (readBlock(flag, file, address, 0x0, 0x8, blockData.data()) < 0)
Patrick Venturebaba7672019-10-26 09:26:41 -0700126 {
127 std::cerr << "failed to read " << errorHelp << "\n";
128 return {};
129 }
130
131 // check the header checksum
132 if (!validateHeader(blockData))
133 {
134 if (DEBUG)
135 {
136 std::cerr << "Illegal header " << errorHelp << "\n";
137 }
138
139 return {};
140 }
141
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300142 std::vector<uint8_t> device;
Patrick Venturebaba7672019-10-26 09:26:41 -0700143 device.insert(device.end(), blockData.begin(), blockData.begin() + 8);
144
Patrick Venturee26395d2019-10-29 14:05:16 -0700145 bool hasMultiRecords = false;
Patrick Venturebaba7672019-10-26 09:26:41 -0700146 int fruLength = 0;
147 for (size_t jj = 1; jj <= FRU_AREAS.size(); jj++)
148 {
Patrick Venturef2ad76b2019-10-30 08:49:27 -0700149 // Offset value can be 255.
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300150 int areaOffset = device[jj];
Patrick Venturebaba7672019-10-26 09:26:41 -0700151 if (areaOffset == 0)
152 {
153 continue;
154 }
155
Patrick Venturee26395d2019-10-29 14:05:16 -0700156 // MultiRecords are different. jj is not tracking section, it's walking
157 // the common header.
158 if (std::string(FRU_AREAS[jj - 1]) == std::string("MULTIRECORD"))
159 {
160 hasMultiRecords = true;
161 break;
162 }
163
Patrick Venturebaba7672019-10-26 09:26:41 -0700164 areaOffset *= 8;
165
Xiang Liu2801a702020-01-20 14:29:34 -0800166 if (readBlock(flag, file, address, static_cast<uint16_t>(areaOffset),
167 0x2, blockData.data()) < 0)
Patrick Venturebaba7672019-10-26 09:26:41 -0700168 {
169 std::cerr << "failed to read " << errorHelp << "\n";
170 return {};
171 }
172
Patrick Venturef2ad76b2019-10-30 08:49:27 -0700173 // Ignore data type (blockData is already unsigned).
Patrick Venturebaba7672019-10-26 09:26:41 -0700174 int length = blockData[1] * 8;
175 areaOffset += length;
176 fruLength = (areaOffset > fruLength) ? areaOffset : fruLength;
177 }
178
Patrick Venturee26395d2019-10-29 14:05:16 -0700179 if (hasMultiRecords)
180 {
181 // device[area count] is the index to the last area because the 0th
182 // entry is not an offset in the common header.
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300183 int areaOffset = device[FRU_AREAS.size()];
Patrick Venturee26395d2019-10-29 14:05:16 -0700184 areaOffset *= 8;
185
186 // the multi-area record header is 5 bytes long.
187 constexpr int multiRecordHeaderSize = 5;
188 constexpr int multiRecordEndOfList = 0x80;
189
190 // Sanity hard-limit to 64KB.
191 while (areaOffset < std::numeric_limits<uint16_t>::max())
192 {
193 // In multi-area, the area offset points to the 0th record, each
194 // record has 3 bytes of the header we care about.
Xiang Liu2801a702020-01-20 14:29:34 -0800195 if (readBlock(flag, file, address,
196 static_cast<uint16_t>(areaOffset), 0x3,
Patrick Venturee26395d2019-10-29 14:05:16 -0700197 blockData.data()) < 0)
198 {
199 std::cerr << "failed to read " << errorHelp << "\n";
200 return {};
201 }
202
203 // Ok, let's check the record length, which is in bytes (unsigned,
204 // up to 255, so blockData should hold uint8_t not char)
205 int recordLength = blockData[2];
206 areaOffset += (recordLength + multiRecordHeaderSize);
207 fruLength = (areaOffset > fruLength) ? areaOffset : fruLength;
208
209 // If this is the end of the list bail.
210 if ((blockData[1] & multiRecordEndOfList))
211 {
212 break;
213 }
214 }
215 }
216
Patrick Venturebaba7672019-10-26 09:26:41 -0700217 // You already copied these first 8 bytes (the ipmi fru header size)
218 fruLength -= 8;
219
220 int readOffset = 8;
221
222 while (fruLength > 0)
223 {
224 int requestLength = std::min(I2C_SMBUS_BLOCK_MAX, fruLength);
225
Xiang Liu2801a702020-01-20 14:29:34 -0800226 if (readBlock(flag, file, address, static_cast<uint16_t>(readOffset),
Patrick Venturebaba7672019-10-26 09:26:41 -0700227 static_cast<uint8_t>(requestLength),
228 blockData.data()) < 0)
229 {
230 std::cerr << "failed to read " << errorHelp << "\n";
231 return {};
232 }
233
234 device.insert(device.end(), blockData.begin(),
235 blockData.begin() + requestLength);
236
237 readOffset += requestLength;
238 fruLength -= requestLength;
239 }
240
241 return device;
242}
243
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700244// Given a bus/address, produce the path in sysfs for an eeprom.
245static std::string getEepromPath(size_t bus, size_t address)
246{
247 std::stringstream output;
248 output << "/sys/bus/i2c/devices/" << bus << "-" << std::right
249 << std::setfill('0') << std::setw(4) << std::hex << address
250 << "/eeprom";
251 return output.str();
252}
253
254static bool hasEepromFile(size_t bus, size_t address)
255{
256 auto path = getEepromPath(bus, address);
257 try
258 {
259 return fs::exists(path);
260 }
261 catch (...)
262 {
263 return false;
264 }
265}
266
Patrick Venture3ac8e4f2019-10-28 13:07:21 -0700267static int64_t readFromEeprom(int flag __attribute__((unused)), int fd,
Xiang Liu2801a702020-01-20 14:29:34 -0800268 uint16_t address __attribute__((unused)),
Patrick Venture3ac8e4f2019-10-28 13:07:21 -0700269 uint16_t offset, uint8_t len, uint8_t* buf)
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700270{
271 auto result = lseek(fd, offset, SEEK_SET);
272 if (result < 0)
273 {
274 std::cerr << "failed to seek\n";
275 return -1;
276 }
277
Patrick Venture3ac8e4f2019-10-28 13:07:21 -0700278 return read(fd, buf, len);
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700279}
280
James Feist5d7f4692020-06-17 18:22:33 -0700281static int busStrToInt(const std::string& busName)
282{
283 auto findBus = busName.rfind("-");
284 if (findBus == std::string::npos)
285 {
286 return -1;
287 }
288 return std::stoi(busName.substr(findBus + 1));
289}
290
James Feist7972bb92019-11-13 15:59:24 -0800291static int getRootBus(size_t bus)
292{
293 auto ec = std::error_code();
294 auto path = std::filesystem::read_symlink(
295 std::filesystem::path("/sys/bus/i2c/devices/i2c-" +
296 std::to_string(bus) + "/mux_device"),
297 ec);
298 if (ec)
299 {
300 return -1;
301 }
302
303 std::string filename = path.filename();
304 auto findBus = filename.find("-");
305 if (findBus == std::string::npos)
306 {
307 return -1;
308 }
309 return std::stoi(filename.substr(0, findBus));
310}
311
James Feistc95cb142018-02-26 10:41:42 -0800312static bool isMuxBus(size_t bus)
313{
Ed Tanous072e25d2018-12-16 21:45:20 -0800314 return is_symlink(std::filesystem::path(
James Feistc95cb142018-02-26 10:41:42 -0800315 "/sys/bus/i2c/devices/i2c-" + std::to_string(bus) + "/mux_device"));
316}
317
James Feist8a983922019-10-24 17:11:56 -0700318static void makeProbeInterface(size_t bus, size_t address)
319{
320 if (isMuxBus(bus))
321 {
322 return; // the mux buses are random, no need to publish
323 }
324 auto [it, success] = foundDevices.emplace(
325 std::make_pair(bus, address),
326 objServer.add_interface(
327 "/xyz/openbmc_project/FruDevice/" + std::to_string(bus) + "_" +
328 std::to_string(address),
329 "xyz.openbmc_project.Inventory.Item.I2CDevice"));
330 if (!success)
331 {
332 return; // already added
333 }
334 it->second->register_property("Bus", bus);
335 it->second->register_property("Address", address);
336 it->second->initialize();
337}
338
Vijay Khemka2d681f62018-11-06 15:51:00 -0800339static int isDevice16Bit(int file)
340{
341 /* Get first byte */
342 int byte1 = i2c_smbus_read_byte_data(file, 0);
343 if (byte1 < 0)
344 {
345 return byte1;
346 }
347 /* Read 7 more bytes, it will read same first byte in case of
348 * 8 bit but it will read next byte in case of 16 bit
349 */
350 for (int i = 0; i < 7; i++)
351 {
352 int byte2 = i2c_smbus_read_byte_data(file, 0);
353 if (byte2 < 0)
354 {
355 return byte2;
356 }
357 if (byte2 != byte1)
358 {
359 return 1;
360 }
361 }
362 return 0;
363}
364
Xiang Liu2801a702020-01-20 14:29:34 -0800365// Issue an I2C transaction to first write to_slave_buf_len bytes,then read
366// from_slave_buf_len bytes.
367static int i2c_smbus_write_then_read(int file, uint16_t address,
368 uint8_t* toSlaveBuf, uint8_t toSlaveBufLen,
369 uint8_t* fromSlaveBuf,
370 uint8_t fromSlaveBufLen)
Vijay Khemka2d681f62018-11-06 15:51:00 -0800371{
Xiang Liu2801a702020-01-20 14:29:34 -0800372 if (toSlaveBuf == NULL || toSlaveBufLen == 0 || fromSlaveBuf == NULL ||
373 fromSlaveBufLen == 0)
374 {
375 return -1;
376 }
Vijay Khemka2d681f62018-11-06 15:51:00 -0800377
Xiang Liu2801a702020-01-20 14:29:34 -0800378#define SMBUS_IOCTL_WRITE_THEN_READ_MSG_COUNT 2
379 struct i2c_msg msgs[SMBUS_IOCTL_WRITE_THEN_READ_MSG_COUNT];
380 struct i2c_rdwr_ioctl_data rdwr;
381
382 msgs[0].addr = address;
383 msgs[0].flags = 0;
384 msgs[0].len = toSlaveBufLen;
385 msgs[0].buf = toSlaveBuf;
386 msgs[1].addr = address;
387 msgs[1].flags = I2C_M_RD;
388 msgs[1].len = fromSlaveBufLen;
389 msgs[1].buf = fromSlaveBuf;
390
391 rdwr.msgs = msgs;
392 rdwr.nmsgs = SMBUS_IOCTL_WRITE_THEN_READ_MSG_COUNT;
393
394 int ret = ioctl(file, I2C_RDWR, &rdwr);
395
396 return (ret == SMBUS_IOCTL_WRITE_THEN_READ_MSG_COUNT) ? ret : -1;
397}
398
399static int64_t readBlockData(int flag, int file, uint16_t address,
400 uint16_t offset, uint8_t len, uint8_t* buf)
401{
Vijay Khemka2d681f62018-11-06 15:51:00 -0800402 if (flag == 0)
403 {
Xiang Liu2801a702020-01-20 14:29:34 -0800404 return i2c_smbus_read_i2c_block_data(file, static_cast<uint8_t>(offset),
405 len, buf);
Vijay Khemka2d681f62018-11-06 15:51:00 -0800406 }
407
Xiang Liu2801a702020-01-20 14:29:34 -0800408 offset = htobe16(offset);
409 return i2c_smbus_write_then_read(
410 file, address, reinterpret_cast<uint8_t*>(&offset), 2, buf, len);
Vijay Khemka2d681f62018-11-06 15:51:00 -0800411}
412
James Feist24bae7a2019-04-03 09:50:56 -0700413bool validateHeader(const std::array<uint8_t, I2C_SMBUS_BLOCK_MAX>& blockData)
414{
415 // ipmi spec format version number is currently at 1, verify it
416 if (blockData[0] != 0x1)
417 {
418 return false;
419 }
420
421 // verify pad is set to 0
422 if (blockData[6] != 0x0)
423 {
424 return false;
425 }
426
427 // verify offsets are 0, or don't point to another offset
428 std::set<uint8_t> foundOffsets;
429 for (int ii = 1; ii < 6; ii++)
430 {
431 if (blockData[ii] == 0)
432 {
433 continue;
434 }
James Feist0eb40352019-04-09 14:44:04 -0700435 auto inserted = foundOffsets.insert(blockData[ii]);
436 if (!inserted.second)
James Feist24bae7a2019-04-03 09:50:56 -0700437 {
438 return false;
439 }
440 }
441
442 // validate checksum
443 size_t sum = 0;
444 for (int jj = 0; jj < 7; jj++)
445 {
446 sum += blockData[jj];
447 }
448 sum = (256 - sum) & 0xFF;
449
450 if (sum != blockData[7])
451 {
452 return false;
453 }
454 return true;
455}
456
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700457// TODO: This code is very similar to the non-eeprom version and can be merged
458// with some tweaks.
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300459static std::vector<uint8_t> processEeprom(int bus, int address)
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700460{
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700461 auto path = getEepromPath(bus, address);
462
463 int file = open(path.c_str(), O_RDONLY);
464 if (file < 0)
465 {
466 std::cerr << "Unable to open eeprom file: " << path << "\n";
Patrick Venturebaba7672019-10-26 09:26:41 -0700467 return {};
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700468 }
469
Patrick Venturebaba7672019-10-26 09:26:41 -0700470 std::string errorMessage = "eeprom at " + std::to_string(bus) +
471 " address " + std::to_string(address);
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300472 std::vector<uint8_t> device = readFruContents(
Xiang Liu2801a702020-01-20 14:29:34 -0800473 0, file, static_cast<uint16_t>(address), readFromEeprom, errorMessage);
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700474
475 close(file);
476 return device;
477}
478
479std::set<int> findI2CEeproms(int i2cBus, std::shared_ptr<DeviceMap> devices)
480{
481 std::set<int> foundList;
482
483 std::string path = "/sys/bus/i2c/devices/i2c-" + std::to_string(i2cBus);
484
485 // For each file listed under the i2c device
486 // NOTE: This should be faster than just checking for each possible address
487 // path.
488 for (const auto& p : fs::directory_iterator(path))
489 {
490 const std::string node = p.path().string();
491 std::smatch m;
492 bool found =
493 std::regex_match(node, m, std::regex(".+\\d+-([0-9abcdef]+$)"));
494
495 if (!found)
496 {
497 continue;
498 }
499 if (m.size() != 2)
500 {
501 std::cerr << "regex didn't capture\n";
502 continue;
503 }
504
505 std::ssub_match subMatch = m[1];
506 std::string addressString = subMatch.str();
507
508 std::size_t ignored;
509 const int hexBase = 16;
510 int address = std::stoi(addressString, &ignored, hexBase);
511
512 const std::string eeprom = node + "/eeprom";
513
514 try
515 {
516 if (!fs::exists(eeprom))
517 {
518 continue;
519 }
520 }
521 catch (...)
522 {
523 continue;
524 }
525
526 // There is an eeprom file at this address, it may have invalid
527 // contents, but we found it.
528 foundList.insert(address);
529
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300530 std::vector<uint8_t> device = processEeprom(i2cBus, address);
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700531 if (!device.empty())
532 {
533 devices->emplace(address, device);
534 }
535 }
536
537 return foundList;
538}
539
Patrick Venture4f47fe62019-08-08 16:30:38 -0700540int getBusFrus(int file, int first, int last, int bus,
541 std::shared_ptr<DeviceMap> devices)
James Feist3cb5fec2018-01-23 14:41:51 -0800542{
James Feist3cb5fec2018-01-23 14:41:51 -0800543
James Feist26c27ad2018-07-25 15:09:40 -0700544 std::future<int> future = std::async(std::launch::async, [&]() {
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700545 // NOTE: When reading the devices raw on the bus, it can interfere with
546 // the driver's ability to operate, therefore read eeproms first before
547 // scanning for devices without drivers. Several experiments were run
548 // and it was determined that if there were any devices on the bus
549 // before the eeprom was hit and read, the eeprom driver wouldn't open
550 // while the bus device was open. An experiment was not performed to see
551 // if this issue was resolved if the i2c bus device was closed, but
552 // hexdumps of the eeprom later were successful.
553
554 // Scan for i2c eeproms loaded on this bus.
555 std::set<int> skipList = findI2CEeproms(bus, devices);
James Feist7972bb92019-11-13 15:59:24 -0800556 std::set<size_t>& failedItems = failedAddresses[bus];
557
558 std::set<size_t>* rootFailures = nullptr;
559 int rootBus = getRootBus(bus);
560
561 if (rootBus >= 0)
562 {
563 rootFailures = &(failedAddresses[rootBus]);
564 }
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700565
Rajashekar Gade Reddyfa8d3222020-05-13 08:27:03 +0530566 constexpr int startSkipSlaveAddr = 0;
567 constexpr int endSkipSlaveAddr = 12;
568
James Feist26c27ad2018-07-25 15:09:40 -0700569 for (int ii = first; ii <= last; ii++)
James Feist3cb5fec2018-01-23 14:41:51 -0800570 {
Patrick Venturec50e1ff2019-08-06 10:22:28 -0700571 if (skipList.find(ii) != skipList.end())
572 {
573 continue;
574 }
Rajashekar Gade Reddyfa8d3222020-05-13 08:27:03 +0530575 // skipping since no device is present in this range
576 if (ii >= startSkipSlaveAddr && ii <= endSkipSlaveAddr)
577 {
578 continue;
579 }
James Feist26c27ad2018-07-25 15:09:40 -0700580 // Set slave address
Rajashekar Gade Reddyfa8d3222020-05-13 08:27:03 +0530581 if (ioctl(file, I2C_SLAVE, ii) < 0)
James Feist3cb5fec2018-01-23 14:41:51 -0800582 {
Patrick Venture98e0cf32019-08-02 11:11:03 -0700583 std::cerr << "device at bus " << bus << " register " << ii
Patrick Venture5d8b61d2019-08-06 12:36:10 -0700584 << " busy\n";
James Feist26c27ad2018-07-25 15:09:40 -0700585 continue;
586 }
587 // probe
588 else if (i2c_smbus_read_byte(file) < 0)
589 {
590 continue;
591 }
James Feist3cb5fec2018-01-23 14:41:51 -0800592
James Feist26c27ad2018-07-25 15:09:40 -0700593 if (DEBUG)
594 {
Patrick Venture98e0cf32019-08-02 11:11:03 -0700595 std::cout << "something at bus " << bus << " addr " << ii
James Feist26c27ad2018-07-25 15:09:40 -0700596 << "\n";
597 }
Vijay Khemka2d681f62018-11-06 15:51:00 -0800598
James Feist8a983922019-10-24 17:11:56 -0700599 makeProbeInterface(bus, ii);
600
James Feist7972bb92019-11-13 15:59:24 -0800601 if (failedItems.find(ii) != failedItems.end())
602 {
603 // if we failed to read it once, unlikely we can read it later
604 continue;
605 }
606
607 if (rootFailures != nullptr)
608 {
609 if (rootFailures->find(ii) != rootFailures->end())
610 {
611 continue;
612 }
613 }
614
Vijay Khemka2d681f62018-11-06 15:51:00 -0800615 /* Check for Device type if it is 8 bit or 16 bit */
616 int flag = isDevice16Bit(file);
617 if (flag < 0)
618 {
619 std::cerr << "failed to read bus " << bus << " address " << ii
620 << "\n";
James Feistcb5661d2020-06-12 15:05:01 -0700621 if (powerIsOn)
622 {
623 failedItems.insert(ii);
624 }
Vijay Khemka2d681f62018-11-06 15:51:00 -0800625 continue;
626 }
627
Patrick Venturebaba7672019-10-26 09:26:41 -0700628 std::string errorMessage =
629 "bus " + std::to_string(bus) + " address " + std::to_string(ii);
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300630 std::vector<uint8_t> device =
Xiang Liu2801a702020-01-20 14:29:34 -0800631 readFruContents(flag, file, static_cast<uint16_t>(ii),
632 readBlockData, errorMessage);
Patrick Venturebaba7672019-10-26 09:26:41 -0700633 if (device.empty())
James Feist26c27ad2018-07-25 15:09:40 -0700634 {
James Feist26c27ad2018-07-25 15:09:40 -0700635 continue;
636 }
James Feist26c27ad2018-07-25 15:09:40 -0700637
Patrick Venture786f1792019-08-05 16:33:44 -0700638 devices->emplace(ii, device);
James Feist3cb5fec2018-01-23 14:41:51 -0800639 }
James Feist26c27ad2018-07-25 15:09:40 -0700640 return 1;
641 });
642 std::future_status status =
643 future.wait_for(std::chrono::seconds(busTimeoutSeconds));
644 if (status == std::future_status::timeout)
645 {
646 std::cerr << "Error reading bus " << bus << "\n";
James Feistcb5661d2020-06-12 15:05:01 -0700647 if (powerIsOn)
648 {
649 busBlacklist.insert(bus);
650 }
James Feist444830e2019-04-05 08:38:16 -0700651 close(file);
James Feist26c27ad2018-07-25 15:09:40 -0700652 return -1;
James Feist3cb5fec2018-01-23 14:41:51 -0800653 }
654
James Feist444830e2019-04-05 08:38:16 -0700655 close(file);
James Feist26c27ad2018-07-25 15:09:40 -0700656 return future.get();
James Feist3cb5fec2018-01-23 14:41:51 -0800657}
658
Patrick Venture11f1ff42019-08-01 10:42:12 -0700659void loadBlacklist(const char* path)
660{
661 std::ifstream blacklistStream(path);
662 if (!blacklistStream.good())
663 {
664 // File is optional.
665 std::cerr << "Cannot open blacklist file.\n\n";
666 return;
667 }
668
669 nlohmann::json data =
670 nlohmann::json::parse(blacklistStream, nullptr, false);
671 if (data.is_discarded())
672 {
673 std::cerr << "Illegal blacklist file detected, cannot validate JSON, "
674 "exiting\n";
675 std::exit(EXIT_FAILURE);
Patrick Venture11f1ff42019-08-01 10:42:12 -0700676 }
677
678 // It's expected to have at least one field, "buses" that is an array of the
679 // buses by integer. Allow for future options to exclude further aspects,
680 // such as specific addresses or ranges.
681 if (data.type() != nlohmann::json::value_t::object)
682 {
683 std::cerr << "Illegal blacklist, expected to read dictionary\n";
684 std::exit(EXIT_FAILURE);
Patrick Venture11f1ff42019-08-01 10:42:12 -0700685 }
686
687 // If buses field is missing, that's fine.
688 if (data.count("buses") == 1)
689 {
690 // Parse the buses array after a little validation.
691 auto buses = data.at("buses");
692 if (buses.type() != nlohmann::json::value_t::array)
693 {
694 // Buses field present but invalid, therefore this is an error.
695 std::cerr << "Invalid contents for blacklist buses field\n";
696 std::exit(EXIT_FAILURE);
Patrick Venture11f1ff42019-08-01 10:42:12 -0700697 }
698
699 // Catch exception here for type mis-match.
700 try
701 {
702 for (const auto& bus : buses)
703 {
704 busBlacklist.insert(bus.get<size_t>());
705 }
706 }
707 catch (const nlohmann::detail::type_error& e)
708 {
709 // Type mis-match is a critical error.
710 std::cerr << "Invalid bus type: " << e.what() << "\n";
711 std::exit(EXIT_FAILURE);
Patrick Venture11f1ff42019-08-01 10:42:12 -0700712 }
713 }
714
715 return;
716}
717
James Feista465ccc2019-02-08 12:51:01 -0800718static void FindI2CDevices(const std::vector<fs::path>& i2cBuses,
James Feist98132792019-07-09 13:29:09 -0700719 BusMap& busmap)
James Feist3cb5fec2018-01-23 14:41:51 -0800720{
James Feista465ccc2019-02-08 12:51:01 -0800721 for (auto& i2cBus : i2cBuses)
James Feist3cb5fec2018-01-23 14:41:51 -0800722 {
James Feist5d7f4692020-06-17 18:22:33 -0700723 int bus = busStrToInt(i2cBus);
James Feist0c3980a2019-12-19 11:09:27 -0800724
James Feist5d7f4692020-06-17 18:22:33 -0700725 if (bus < 0)
726 {
727 std::cerr << "Cannot translate " << i2cBus << " to int\n";
728 continue;
729 }
James Feist444830e2019-04-05 08:38:16 -0700730 if (busBlacklist.find(bus) != busBlacklist.end())
731 {
732 continue; // skip previously failed busses
733 }
James Feist3cb5fec2018-01-23 14:41:51 -0800734
James Feist0c3980a2019-12-19 11:09:27 -0800735 int rootBus = getRootBus(bus);
736 if (busBlacklist.find(rootBus) != busBlacklist.end())
737 {
738 continue;
739 }
740
James Feist3cb5fec2018-01-23 14:41:51 -0800741 auto file = open(i2cBus.c_str(), O_RDWR);
742 if (file < 0)
743 {
744 std::cerr << "unable to open i2c device " << i2cBus.string()
745 << "\n";
746 continue;
747 }
748 unsigned long funcs = 0;
749
750 if (ioctl(file, I2C_FUNCS, &funcs) < 0)
751 {
752 std::cerr
Patrick Venture98e0cf32019-08-02 11:11:03 -0700753 << "Error: Could not get the adapter functionality matrix bus "
James Feist3cb5fec2018-01-23 14:41:51 -0800754 << bus << "\n";
755 continue;
756 }
757 if (!(funcs & I2C_FUNC_SMBUS_READ_BYTE) ||
758 !(I2C_FUNC_SMBUS_READ_I2C_BLOCK))
759 {
760 std::cerr << "Error: Can't use SMBus Receive Byte command bus "
761 << bus << "\n";
762 continue;
763 }
James Feist98132792019-07-09 13:29:09 -0700764 auto& device = busmap[bus];
James Feist3cb5fec2018-01-23 14:41:51 -0800765 device = std::make_shared<DeviceMap>();
766
Nikhil Potaded8884f12019-03-27 13:27:13 -0700767 // i2cdetect by default uses the range 0x03 to 0x77, as
768 // this is what we have tested with, use this range. Could be
769 // changed in future.
770 if (DEBUG)
James Feistc95cb142018-02-26 10:41:42 -0800771 {
Nikhil Potaded8884f12019-03-27 13:27:13 -0700772 std::cerr << "Scanning bus " << bus << "\n";
James Feistc95cb142018-02-26 10:41:42 -0800773 }
Nikhil Potaded8884f12019-03-27 13:27:13 -0700774
775 // fd is closed in this function in case the bus locks up
Patrick Venture4f47fe62019-08-08 16:30:38 -0700776 getBusFrus(file, 0x03, 0x77, bus, device);
Nikhil Potaded8884f12019-03-27 13:27:13 -0700777
778 if (DEBUG)
James Feistc95cb142018-02-26 10:41:42 -0800779 {
Nikhil Potaded8884f12019-03-27 13:27:13 -0700780 std::cerr << "Done scanning bus " << bus << "\n";
James Feistc95cb142018-02-26 10:41:42 -0800781 }
James Feist3cb5fec2018-01-23 14:41:51 -0800782 }
James Feist3cb5fec2018-01-23 14:41:51 -0800783}
784
James Feist6ebf9de2018-05-15 15:01:17 -0700785// this class allows an async response after all i2c devices are discovered
James Feist8c505da2020-05-28 10:06:33 -0700786struct FindDevicesWithCallback :
787 std::enable_shared_from_this<FindDevicesWithCallback>
James Feist6ebf9de2018-05-15 15:01:17 -0700788{
James Feista465ccc2019-02-08 12:51:01 -0800789 FindDevicesWithCallback(const std::vector<fs::path>& i2cBuses,
James Feist5cb06082019-10-24 17:11:13 -0700790 BusMap& busmap,
James Feista465ccc2019-02-08 12:51:01 -0800791 std::function<void(void)>&& callback) :
James Feist6ebf9de2018-05-15 15:01:17 -0700792 _i2cBuses(i2cBuses),
James Feist5cb06082019-10-24 17:11:13 -0700793 _busMap(busmap), _callback(std::move(callback))
James Feist8c505da2020-05-28 10:06:33 -0700794 {}
James Feist6ebf9de2018-05-15 15:01:17 -0700795 ~FindDevicesWithCallback()
796 {
797 _callback();
798 }
799 void run()
800 {
James Feist98132792019-07-09 13:29:09 -0700801 FindI2CDevices(_i2cBuses, _busMap);
James Feist6ebf9de2018-05-15 15:01:17 -0700802 }
803
James Feista465ccc2019-02-08 12:51:01 -0800804 const std::vector<fs::path>& _i2cBuses;
James Feista465ccc2019-02-08 12:51:01 -0800805 BusMap& _busMap;
James Feist6ebf9de2018-05-15 15:01:17 -0700806 std::function<void(void)> _callback;
807};
808
James Feist3cb5fec2018-01-23 14:41:51 -0800809static const std::tm intelEpoch(void)
810{
James Feist98132792019-07-09 13:29:09 -0700811 std::tm val = {};
James Feist3cb5fec2018-01-23 14:41:51 -0800812 val.tm_year = 1996 - 1900;
813 return val;
814}
815
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +0800816static char sixBitToChar(uint8_t val)
817{
818 return static_cast<char>((val & 0x3f) + ' ');
819}
820
821/* 0xd - 0xf are reserved values, but not fatal; use a placeholder char. */
822static const char bcdHighChars[] = {
823 ' ', '-', '.', 'X', 'X', 'X',
824};
825
826static char bcdPlusToChar(uint8_t val)
827{
828 val &= 0xf;
829 return (val < 10) ? static_cast<char>(val + '0') : bcdHighChars[val - 10];
830}
831
832enum class DecodeState
833{
834 ok,
835 end,
836 err,
837};
838
839enum FRUDataEncoding
840{
841 binary = 0x0,
842 bcdPlus = 0x1,
843 sixBitASCII = 0x2,
844 languageDependent = 0x3,
845};
846
847/* Decode FRU data into a std::string, given an input iterator and end. If the
848 * state returned is fruDataOk, then the resulting string is the decoded FRU
849 * data. The input iterator is advanced past the data consumed.
850 *
851 * On fruDataErr, we have lost synchronisation with the length bytes, so the
852 * iterator is no longer usable.
853 */
854static std::pair<DecodeState, std::string>
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300855 decodeFruData(std::vector<uint8_t>::const_iterator& iter,
856 const std::vector<uint8_t>::const_iterator& end)
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +0800857{
858 std::string value;
859 unsigned int i;
860
861 /* we need at least one byte to decode the type/len header */
862 if (iter == end)
863 {
864 std::cerr << "Truncated FRU data\n";
865 return make_pair(DecodeState::err, value);
866 }
867
868 uint8_t c = *(iter++);
869
870 /* 0xc1 is the end marker */
871 if (c == 0xc1)
872 {
873 return make_pair(DecodeState::end, value);
874 }
875
876 /* decode type/len byte */
877 uint8_t type = static_cast<uint8_t>(c >> 6);
878 uint8_t len = static_cast<uint8_t>(c & 0x3f);
879
880 /* we should have at least len bytes of data available overall */
881 if (iter + len > end)
882 {
883 std::cerr << "FRU data field extends past end of FRU data\n";
884 return make_pair(DecodeState::err, value);
885 }
886
887 switch (type)
888 {
889 case FRUDataEncoding::binary:
890 case FRUDataEncoding::languageDependent:
891 /* For language-code dependent encodings, assume 8-bit ASCII */
892 value = std::string(iter, iter + len);
893 iter += len;
894 break;
895
896 case FRUDataEncoding::bcdPlus:
897 value = std::string();
898 for (i = 0; i < len; i++, iter++)
899 {
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300900 uint8_t val = *iter;
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +0800901 value.push_back(bcdPlusToChar(val >> 4));
902 value.push_back(bcdPlusToChar(val & 0xf));
903 }
904 break;
905
906 case FRUDataEncoding::sixBitASCII:
907 {
Andrei Kartasheve707de62020-08-10 18:33:29 +0300908 unsigned int accum = 0;
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +0800909 unsigned int accumBitLen = 0;
910 value = std::string();
911 for (i = 0; i < len; i++, iter++)
912 {
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300913 accum |= *iter << accumBitLen;
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +0800914 accumBitLen += 8;
915 while (accumBitLen >= 6)
916 {
917 value.push_back(sixBitToChar(accum & 0x3f));
918 accum >>= 6;
919 accumBitLen -= 6;
920 }
921 }
922 }
923 break;
924 }
925
926 return make_pair(DecodeState::ok, value);
927}
928
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300929bool formatFru(const std::vector<uint8_t>& fruBytes,
James Feista465ccc2019-02-08 12:51:01 -0800930 boost::container::flat_map<std::string, std::string>& result)
James Feist3cb5fec2018-01-23 14:41:51 -0800931{
James Feistd068e932018-09-20 10:53:07 -0700932 if (fruBytes.size() <= 8)
James Feist3cb5fec2018-01-23 14:41:51 -0800933 {
934 return false;
935 }
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300936 std::vector<uint8_t>::const_iterator fruAreaOffsetField = fruBytes.begin();
James Feist9eb0b582018-04-27 12:15:46 -0700937 result["Common_Format_Version"] =
James Feist3cb5fec2018-01-23 14:41:51 -0800938 std::to_string(static_cast<int>(*fruAreaOffsetField));
939
James Feista465ccc2019-02-08 12:51:01 -0800940 const std::vector<const char*>* fieldData;
James Feist3cb5fec2018-01-23 14:41:51 -0800941
James Feist0eb40352019-04-09 14:44:04 -0700942 for (const std::string& area : FRU_AREAS)
James Feist3cb5fec2018-01-23 14:41:51 -0800943 {
Patrick Venture4b7a7452019-10-28 08:41:02 -0700944 ++fruAreaOffsetField;
James Feist3cb5fec2018-01-23 14:41:51 -0800945 if (fruAreaOffsetField >= fruBytes.end())
946 {
947 return false;
948 }
949 size_t offset = (*fruAreaOffsetField) * 8;
950
951 if (offset > 1)
952 {
953 // +2 to skip format and length
Andrei Kartashev1c5b7062020-08-19 14:47:30 +0300954 std::vector<uint8_t>::const_iterator fruBytesIter =
James Feist3cb5fec2018-01-23 14:41:51 -0800955 fruBytes.begin() + offset + 2;
956
957 if (fruBytesIter >= fruBytes.end())
958 {
959 return false;
960 }
961
962 if (area == "CHASSIS")
963 {
964 result["CHASSIS_TYPE"] =
965 std::to_string(static_cast<int>(*fruBytesIter));
966 fruBytesIter += 1;
967 fieldData = &CHASSIS_FRU_AREAS;
968 }
969 else if (area == "BOARD")
970 {
971 result["BOARD_LANGUAGE_CODE"] =
972 std::to_string(static_cast<int>(*fruBytesIter));
973 fruBytesIter += 1;
974 if (fruBytesIter >= fruBytes.end())
975 {
976 return false;
977 }
978
979 unsigned int minutes = *fruBytesIter |
980 *(fruBytesIter + 1) << 8 |
981 *(fruBytesIter + 2) << 16;
982 std::tm fruTime = intelEpoch();
Patrick Venturee0e6f5f2019-08-12 19:00:11 -0700983 std::time_t timeValue = std::mktime(&fruTime);
James Feist3cb5fec2018-01-23 14:41:51 -0800984 timeValue += minutes * 60;
Patrick Venturee0e6f5f2019-08-12 19:00:11 -0700985 fruTime = *std::gmtime(&timeValue);
James Feist3cb5fec2018-01-23 14:41:51 -0800986
Patrick Venturee0e6f5f2019-08-12 19:00:11 -0700987 // Tue Nov 20 23:08:00 2018
988 char timeString[32] = {0};
989 auto bytes = std::strftime(timeString, sizeof(timeString),
Patrick Venturefff050a2019-08-13 11:44:30 -0700990 "%Y-%m-%d - %H:%M:%S", &fruTime);
Patrick Venturee0e6f5f2019-08-12 19:00:11 -0700991 if (bytes == 0)
992 {
993 std::cerr << "invalid time string encountered\n";
994 return false;
995 }
996
997 result["BOARD_MANUFACTURE_DATE"] = std::string(timeString);
James Feist3cb5fec2018-01-23 14:41:51 -0800998 fruBytesIter += 3;
999 fieldData = &BOARD_FRU_AREAS;
1000 }
1001 else if (area == "PRODUCT")
1002 {
1003 result["PRODUCT_LANGUAGE_CODE"] =
1004 std::to_string(static_cast<int>(*fruBytesIter));
1005 fruBytesIter += 1;
1006 fieldData = &PRODUCT_FRU_AREAS;
1007 }
1008 else
1009 {
1010 continue;
1011 }
James Feista465ccc2019-02-08 12:51:01 -08001012 for (auto& field : *fieldData)
James Feist3cb5fec2018-01-23 14:41:51 -08001013 {
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001014 auto res = decodeFruData(fruBytesIter, fruBytes.end());
1015 std::string name = area + "_" + field;
James Feist3cb5fec2018-01-23 14:41:51 -08001016
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001017 if (res.first == DecodeState::end)
Vijay Khemka5d5de442018-11-07 10:51:25 -08001018 {
1019 break;
1020 }
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001021 else if (res.first == DecodeState::err)
James Feist3cb5fec2018-01-23 14:41:51 -08001022 {
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001023 std::cerr << "Error while parsing " << name << "\n";
James Feist3cb5fec2018-01-23 14:41:51 -08001024 return false;
1025 }
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001026
1027 std::string value = res.second;
James Feist3cb5fec2018-01-23 14:41:51 -08001028
Ed Tanous2147e672019-02-27 13:59:56 -08001029 // Strip non null characters from the end
1030 value.erase(std::find_if(value.rbegin(), value.rend(),
1031 [](char ch) { return ch != 0; })
1032 .base(),
1033 value.end());
1034
Jeremy Kerr4e6a62f2020-06-09 11:26:40 +08001035 result[name] = std::move(value);
James Feist3cb5fec2018-01-23 14:41:51 -08001036 }
1037 }
1038 }
1039
1040 return true;
1041}
1042
Nikhil Potaded8884f12019-03-27 13:27:13 -07001043std::vector<uint8_t>& getFruInfo(const uint8_t& bus, const uint8_t& address)
1044{
1045 auto deviceMap = busMap.find(bus);
1046 if (deviceMap == busMap.end())
1047 {
1048 throw std::invalid_argument("Invalid Bus.");
1049 }
1050 auto device = deviceMap->second->find(address);
1051 if (device == deviceMap->second->end())
1052 {
1053 throw std::invalid_argument("Invalid Address.");
1054 }
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001055 std::vector<uint8_t>& ret = device->second;
Nikhil Potaded8884f12019-03-27 13:27:13 -07001056
1057 return ret;
1058}
1059
James Feist3cb5fec2018-01-23 14:41:51 -08001060void AddFruObjectToDbus(
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001061 std::vector<uint8_t>& device,
James Feista465ccc2019-02-08 12:51:01 -08001062 boost::container::flat_map<
1063 std::pair<size_t, size_t>,
1064 std::shared_ptr<sdbusplus::asio::dbus_interface>>& dbusInterfaceMap,
James Feist13b86d62018-05-29 11:24:35 -07001065 uint32_t bus, uint32_t address)
James Feist3cb5fec2018-01-23 14:41:51 -08001066{
1067 boost::container::flat_map<std::string, std::string> formattedFru;
1068 if (!formatFru(device, formattedFru))
1069 {
Patrick Ventureb755c832019-08-07 11:09:14 -07001070 std::cerr << "failed to format fru for device at bus " << bus
1071 << " address " << address << "\n";
James Feist3cb5fec2018-01-23 14:41:51 -08001072 return;
1073 }
Patrick Venture96cdaef2019-07-30 13:30:52 -07001074
James Feist3cb5fec2018-01-23 14:41:51 -08001075 auto productNameFind = formattedFru.find("BOARD_PRODUCT_NAME");
1076 std::string productName;
Patrick Venture96cdaef2019-07-30 13:30:52 -07001077 // Not found under Board section or an empty string.
1078 if (productNameFind == formattedFru.end() ||
1079 productNameFind->second.empty())
James Feist3cb5fec2018-01-23 14:41:51 -08001080 {
1081 productNameFind = formattedFru.find("PRODUCT_PRODUCT_NAME");
1082 }
Patrick Venture96cdaef2019-07-30 13:30:52 -07001083 // Found under Product section and not an empty string.
1084 if (productNameFind != formattedFru.end() &&
1085 !productNameFind->second.empty())
James Feist3cb5fec2018-01-23 14:41:51 -08001086 {
1087 productName = productNameFind->second;
James Feist3f8a2782018-02-12 09:24:42 -08001088 std::regex illegalObject("[^A-Za-z0-9_]");
1089 productName = std::regex_replace(productName, illegalObject, "_");
James Feist3cb5fec2018-01-23 14:41:51 -08001090 }
1091 else
1092 {
1093 productName = "UNKNOWN" + std::to_string(UNKNOWN_BUS_OBJECT_COUNT);
1094 UNKNOWN_BUS_OBJECT_COUNT++;
1095 }
1096
James Feist918e18c2018-02-13 15:51:07 -08001097 productName = "/xyz/openbmc_project/FruDevice/" + productName;
James Feist918e18c2018-02-13 15:51:07 -08001098 // avoid duplicates by checking to see if on a mux
James Feist79e9c0b2018-03-15 15:21:17 -07001099 if (bus > 0)
James Feist918e18c2018-02-13 15:51:07 -08001100 {
Patrick Venture015fb0a2019-08-16 09:33:31 -07001101 int highest = -1;
1102 bool found = false;
1103
James Feista465ccc2019-02-08 12:51:01 -08001104 for (auto const& busIface : dbusInterfaceMap)
James Feist918e18c2018-02-13 15:51:07 -08001105 {
Patrick Venture015fb0a2019-08-16 09:33:31 -07001106 std::string path = busIface.second->get_object_path();
1107 if (std::regex_match(path, std::regex(productName + "(_\\d+|)$")))
James Feist918e18c2018-02-13 15:51:07 -08001108 {
Nikhil Potaded8884f12019-03-27 13:27:13 -07001109 if (isMuxBus(bus) && address == busIface.first.second &&
James Feist98132792019-07-09 13:29:09 -07001110 (getFruInfo(static_cast<uint8_t>(busIface.first.first),
1111 static_cast<uint8_t>(busIface.first.second)) ==
1112 getFruInfo(static_cast<uint8_t>(bus),
1113 static_cast<uint8_t>(address))))
James Feist79e9c0b2018-03-15 15:21:17 -07001114 {
Nikhil Potaded8884f12019-03-27 13:27:13 -07001115 // This device is already added to the lower numbered bus,
1116 // do not replicate it.
1117 return;
James Feist79e9c0b2018-03-15 15:21:17 -07001118 }
Patrick Venture015fb0a2019-08-16 09:33:31 -07001119
1120 // Check if the match named has extra information.
1121 found = true;
1122 std::smatch base_match;
1123
1124 bool match = std::regex_match(
1125 path, base_match, std::regex(productName + "_(\\d+)$"));
1126 if (match)
James Feist79e9c0b2018-03-15 15:21:17 -07001127 {
Patrick Venture015fb0a2019-08-16 09:33:31 -07001128 if (base_match.size() == 2)
1129 {
1130 std::ssub_match base_sub_match = base_match[1];
1131 std::string base = base_sub_match.str();
1132
1133 int value = std::stoi(base);
1134 highest = (value > highest) ? value : highest;
1135 }
James Feist79e9c0b2018-03-15 15:21:17 -07001136 }
James Feist918e18c2018-02-13 15:51:07 -08001137 }
Patrick Venture015fb0a2019-08-16 09:33:31 -07001138 } // end searching objects
1139
1140 if (found)
1141 {
1142 // We found something with the same name. If highest was still -1,
1143 // it means this new entry will be _0.
1144 productName += "_";
1145 productName += std::to_string(++highest);
James Feist918e18c2018-02-13 15:51:07 -08001146 }
1147 }
James Feist3cb5fec2018-01-23 14:41:51 -08001148
James Feist9eb0b582018-04-27 12:15:46 -07001149 std::shared_ptr<sdbusplus::asio::dbus_interface> iface =
1150 objServer.add_interface(productName, "xyz.openbmc_project.FruDevice");
1151 dbusInterfaceMap[std::pair<size_t, size_t>(bus, address)] = iface;
1152
James Feista465ccc2019-02-08 12:51:01 -08001153 for (auto& property : formattedFru)
James Feist3cb5fec2018-01-23 14:41:51 -08001154 {
James Feist9eb0b582018-04-27 12:15:46 -07001155
Jae Hyun Yoo3936e7a2018-03-23 17:26:16 -07001156 std::regex_replace(property.second.begin(), property.second.begin(),
1157 property.second.end(), NON_ASCII_REGEX, "_");
Joshi-Mansid73b7442020-03-27 19:10:21 +05301158 if (property.second.empty() && property.first != "PRODUCT_ASSET_TAG")
James Feist9eb0b582018-04-27 12:15:46 -07001159 {
1160 continue;
1161 }
1162 std::string key =
1163 std::regex_replace(property.first, NON_ASCII_REGEX, "_");
Joshi-Mansid73b7442020-03-27 19:10:21 +05301164
1165 if (property.first == "PRODUCT_ASSET_TAG")
1166 {
1167 std::string propertyName = property.first;
1168 iface->register_property(
1169 key, property.second + '\0',
1170 [bus, address, propertyName,
1171 &dbusInterfaceMap](const std::string& req, std::string& resp) {
1172 if (strcmp(req.c_str(), resp.c_str()))
1173 {
1174 // call the method which will update
1175 if (updateFruProperty(req, bus, address, propertyName,
1176 dbusInterfaceMap))
1177 {
1178 resp = req;
1179 }
1180 else
1181 {
1182 throw std::invalid_argument(
1183 "Fru property update failed.");
1184 }
1185 }
1186 return 1;
1187 });
1188 }
1189 else if (!iface->register_property(key, property.second + '\0'))
James Feist9eb0b582018-04-27 12:15:46 -07001190 {
1191 std::cerr << "illegal key: " << key << "\n";
1192 }
Jae Hyun Yoo3936e7a2018-03-23 17:26:16 -07001193 if (DEBUG)
1194 {
1195 std::cout << property.first << ": " << property.second << "\n";
1196 }
James Feist3cb5fec2018-01-23 14:41:51 -08001197 }
James Feist2a9d6db2018-04-27 15:48:28 -07001198
1199 // baseboard will be 0, 0
James Feist13b86d62018-05-29 11:24:35 -07001200 iface->register_property("BUS", bus);
1201 iface->register_property("ADDRESS", address);
James Feist2a9d6db2018-04-27 15:48:28 -07001202
James Feist9eb0b582018-04-27 12:15:46 -07001203 iface->initialize();
James Feist3cb5fec2018-01-23 14:41:51 -08001204}
1205
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001206static bool readBaseboardFru(std::vector<uint8_t>& baseboardFru)
James Feist3cb5fec2018-01-23 14:41:51 -08001207{
1208 // try to read baseboard fru from file
1209 std::ifstream baseboardFruFile(BASEBOARD_FRU_LOCATION, std::ios::binary);
1210 if (baseboardFruFile.good())
1211 {
1212 baseboardFruFile.seekg(0, std::ios_base::end);
James Feist98132792019-07-09 13:29:09 -07001213 size_t fileSize = static_cast<size_t>(baseboardFruFile.tellg());
James Feist3cb5fec2018-01-23 14:41:51 -08001214 baseboardFru.resize(fileSize);
1215 baseboardFruFile.seekg(0, std::ios_base::beg);
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001216 baseboardFruFile.read(reinterpret_cast<char*>(baseboardFru.data()),
1217 fileSize);
James Feist3cb5fec2018-01-23 14:41:51 -08001218 }
1219 else
1220 {
1221 return false;
1222 }
1223 return true;
1224}
1225
James Feista465ccc2019-02-08 12:51:01 -08001226bool writeFru(uint8_t bus, uint8_t address, const std::vector<uint8_t>& fru)
James Feistb49ffc32018-05-02 11:10:43 -07001227{
1228 boost::container::flat_map<std::string, std::string> tmp;
1229 if (fru.size() > MAX_FRU_SIZE)
1230 {
1231 std::cerr << "Invalid fru.size() during writeFru\n";
1232 return false;
1233 }
1234 // verify legal fru by running it through fru parsing logic
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001235 if (!formatFru(fru, tmp))
James Feistb49ffc32018-05-02 11:10:43 -07001236 {
1237 std::cerr << "Invalid fru format during writeFru\n";
1238 return false;
1239 }
1240 // baseboard fru
1241 if (bus == 0 && address == 0)
1242 {
1243 std::ofstream file(BASEBOARD_FRU_LOCATION, std::ios_base::binary);
1244 if (!file.good())
1245 {
1246 std::cerr << "Error opening file " << BASEBOARD_FRU_LOCATION
1247 << "\n";
James Feistddb78302018-09-06 11:45:42 -07001248 throw DBusInternalError();
James Feistb49ffc32018-05-02 11:10:43 -07001249 return false;
1250 }
James Feista465ccc2019-02-08 12:51:01 -08001251 file.write(reinterpret_cast<const char*>(fru.data()), fru.size());
James Feistb49ffc32018-05-02 11:10:43 -07001252 return file.good();
1253 }
1254 else
1255 {
Patrick Venturec50e1ff2019-08-06 10:22:28 -07001256 if (hasEepromFile(bus, address))
1257 {
1258 auto path = getEepromPath(bus, address);
1259 int eeprom = open(path.c_str(), O_RDWR | O_CLOEXEC);
1260 if (eeprom < 0)
1261 {
1262 std::cerr << "unable to open i2c device " << path << "\n";
1263 throw DBusInternalError();
1264 return false;
1265 }
1266
1267 ssize_t writtenBytes = write(eeprom, fru.data(), fru.size());
1268 if (writtenBytes < 0)
1269 {
1270 std::cerr << "unable to write to i2c device " << path << "\n";
1271 close(eeprom);
1272 throw DBusInternalError();
1273 return false;
1274 }
1275
1276 close(eeprom);
1277 return true;
1278 }
1279
James Feistb49ffc32018-05-02 11:10:43 -07001280 std::string i2cBus = "/dev/i2c-" + std::to_string(bus);
1281
1282 int file = open(i2cBus.c_str(), O_RDWR | O_CLOEXEC);
1283 if (file < 0)
1284 {
1285 std::cerr << "unable to open i2c device " << i2cBus << "\n";
James Feistddb78302018-09-06 11:45:42 -07001286 throw DBusInternalError();
James Feistb49ffc32018-05-02 11:10:43 -07001287 return false;
1288 }
1289 if (ioctl(file, I2C_SLAVE_FORCE, address) < 0)
1290 {
1291 std::cerr << "unable to set device address\n";
1292 close(file);
James Feistddb78302018-09-06 11:45:42 -07001293 throw DBusInternalError();
James Feistb49ffc32018-05-02 11:10:43 -07001294 return false;
1295 }
1296
1297 constexpr const size_t RETRY_MAX = 2;
1298 uint16_t index = 0;
1299 size_t retries = RETRY_MAX;
1300 while (index < fru.size())
1301 {
1302 if ((index && ((index % (MAX_EEPROM_PAGE_INDEX + 1)) == 0)) &&
1303 (retries == RETRY_MAX))
1304 {
1305 // The 4K EEPROM only uses the A2 and A1 device address bits
1306 // with the third bit being a memory page address bit.
1307 if (ioctl(file, I2C_SLAVE_FORCE, ++address) < 0)
1308 {
1309 std::cerr << "unable to set device address\n";
1310 close(file);
James Feistddb78302018-09-06 11:45:42 -07001311 throw DBusInternalError();
James Feistb49ffc32018-05-02 11:10:43 -07001312 return false;
1313 }
1314 }
1315
James Feist98132792019-07-09 13:29:09 -07001316 if (i2c_smbus_write_byte_data(file, static_cast<uint8_t>(index),
1317 fru[index]) < 0)
James Feistb49ffc32018-05-02 11:10:43 -07001318 {
1319 if (!retries--)
1320 {
1321 std::cerr << "error writing fru: " << strerror(errno)
1322 << "\n";
1323 close(file);
James Feistddb78302018-09-06 11:45:42 -07001324 throw DBusInternalError();
James Feistb49ffc32018-05-02 11:10:43 -07001325 return false;
1326 }
1327 }
1328 else
1329 {
1330 retries = RETRY_MAX;
1331 index++;
1332 }
1333 // most eeproms require 5-10ms between writes
1334 std::this_thread::sleep_for(std::chrono::milliseconds(10));
1335 }
1336 close(file);
1337 return true;
1338 }
1339}
1340
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001341void rescanOneBus(
1342 BusMap& busmap, uint8_t busNum,
1343 boost::container::flat_map<
1344 std::pair<size_t, size_t>,
James Feist5d7f4692020-06-17 18:22:33 -07001345 std::shared_ptr<sdbusplus::asio::dbus_interface>>& dbusInterfaceMap,
1346 bool dbusCall)
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001347{
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001348 for (auto& [pair, interface] : foundDevices)
1349 {
1350 if (pair.first == static_cast<size_t>(busNum))
1351 {
1352 objServer.remove_interface(interface);
1353 foundDevices.erase(pair);
1354 }
1355 }
1356
James Feist5d7f4692020-06-17 18:22:33 -07001357 fs::path busPath = fs::path("/dev/i2c-" + std::to_string(busNum));
1358 if (!fs::exists(busPath))
1359 {
1360 if (dbusCall)
1361 {
1362 std::cerr << "Unable to access i2c bus " << static_cast<int>(busNum)
1363 << "\n";
1364 throw std::invalid_argument("Invalid Bus.");
1365 }
1366 return;
1367 }
1368
1369 std::vector<fs::path> i2cBuses;
1370 i2cBuses.emplace_back(busPath);
1371
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001372 auto scan = std::make_shared<FindDevicesWithCallback>(
1373 i2cBuses, busmap, [busNum, &busmap, &dbusInterfaceMap]() {
1374 for (auto& busIface : dbusInterfaceMap)
1375 {
1376 if (busIface.first.first == static_cast<size_t>(busNum))
1377 {
1378 objServer.remove_interface(busIface.second);
1379 }
1380 }
Wludzik, Jozefc1136b72020-06-24 11:58:32 +02001381 auto found = busmap.find(busNum);
1382 if (found == busmap.end() || found->second == nullptr)
1383 {
1384 return;
1385 }
1386 for (auto& device : *(found->second))
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001387 {
1388 AddFruObjectToDbus(device.second, dbusInterfaceMap,
1389 static_cast<uint32_t>(busNum), device.first);
1390 }
1391 });
1392 scan->run();
1393}
1394
James Feist9eb0b582018-04-27 12:15:46 -07001395void rescanBusses(
James Feist5cb06082019-10-24 17:11:13 -07001396 BusMap& busmap,
James Feista465ccc2019-02-08 12:51:01 -08001397 boost::container::flat_map<
1398 std::pair<size_t, size_t>,
James Feist5cb06082019-10-24 17:11:13 -07001399 std::shared_ptr<sdbusplus::asio::dbus_interface>>& dbusInterfaceMap)
James Feist918e18c2018-02-13 15:51:07 -08001400{
James Feist6ebf9de2018-05-15 15:01:17 -07001401 static boost::asio::deadline_timer timer(io);
1402 timer.expires_from_now(boost::posix_time::seconds(1));
James Feist918e18c2018-02-13 15:51:07 -08001403
Gunnar Mills6f0ae942018-08-31 12:38:03 -05001404 // setup an async wait in case we get flooded with requests
James Feist98132792019-07-09 13:29:09 -07001405 timer.async_wait([&](const boost::system::error_code&) {
James Feist4131aea2018-03-09 09:47:30 -08001406 auto devDir = fs::path("/dev/");
James Feist4131aea2018-03-09 09:47:30 -08001407 std::vector<fs::path> i2cBuses;
James Feist918e18c2018-02-13 15:51:07 -08001408
Nikhil Potaded8884f12019-03-27 13:27:13 -07001409 boost::container::flat_map<size_t, fs::path> busPaths;
1410 if (!getI2cDevicePaths(devDir, busPaths))
James Feist918e18c2018-02-13 15:51:07 -08001411 {
James Feist4131aea2018-03-09 09:47:30 -08001412 std::cerr << "unable to find i2c devices\n";
1413 return;
James Feist918e18c2018-02-13 15:51:07 -08001414 }
Nikhil Potaded8884f12019-03-27 13:27:13 -07001415
1416 for (auto busPath : busPaths)
1417 {
1418 i2cBuses.emplace_back(busPath.second);
1419 }
James Feist4131aea2018-03-09 09:47:30 -08001420
James Feist98132792019-07-09 13:29:09 -07001421 busmap.clear();
James Feist8a983922019-10-24 17:11:56 -07001422 for (auto& [pair, interface] : foundDevices)
1423 {
1424 objServer.remove_interface(interface);
1425 }
1426 foundDevices.clear();
1427
James Feist5cb06082019-10-24 17:11:13 -07001428 auto scan =
1429 std::make_shared<FindDevicesWithCallback>(i2cBuses, busmap, [&]() {
James Feista465ccc2019-02-08 12:51:01 -08001430 for (auto& busIface : dbusInterfaceMap)
James Feist6ebf9de2018-05-15 15:01:17 -07001431 {
1432 objServer.remove_interface(busIface.second);
1433 }
James Feist4131aea2018-03-09 09:47:30 -08001434
James Feist6ebf9de2018-05-15 15:01:17 -07001435 dbusInterfaceMap.clear();
1436 UNKNOWN_BUS_OBJECT_COUNT = 0;
James Feist4131aea2018-03-09 09:47:30 -08001437
James Feist6ebf9de2018-05-15 15:01:17 -07001438 // todo, get this from a more sensable place
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001439 std::vector<uint8_t> baseboardFru;
James Feist6ebf9de2018-05-15 15:01:17 -07001440 if (readBaseboardFru(baseboardFru))
1441 {
Andrei Kartashev1c5b7062020-08-19 14:47:30 +03001442 boost::container::flat_map<int, std::vector<uint8_t>>
James Feist6ebf9de2018-05-15 15:01:17 -07001443 baseboardDev;
1444 baseboardDev.emplace(0, baseboardFru);
James Feist98132792019-07-09 13:29:09 -07001445 busmap[0] = std::make_shared<DeviceMap>(baseboardDev);
James Feist6ebf9de2018-05-15 15:01:17 -07001446 }
James Feist98132792019-07-09 13:29:09 -07001447 for (auto& devicemap : busmap)
James Feist6ebf9de2018-05-15 15:01:17 -07001448 {
James Feista465ccc2019-02-08 12:51:01 -08001449 for (auto& device : *devicemap.second)
James Feist6ebf9de2018-05-15 15:01:17 -07001450 {
James Feist5cb06082019-10-24 17:11:13 -07001451 AddFruObjectToDbus(device.second, dbusInterfaceMap,
1452 devicemap.first, device.first);
James Feist6ebf9de2018-05-15 15:01:17 -07001453 }
1454 }
1455 });
1456 scan->run();
1457 });
James Feist918e18c2018-02-13 15:51:07 -08001458}
1459
Joshi-Mansid73b7442020-03-27 19:10:21 +05301460// Calculate new checksum for fru info area
1461size_t calculateChecksum(std::vector<uint8_t>& fruAreaData)
1462{
1463 constexpr int checksumMod = 256;
1464 constexpr uint8_t modVal = 0xFF;
1465 int sum = std::accumulate(fruAreaData.begin(), fruAreaData.end(), 0);
1466 return (checksumMod - sum) & modVal;
1467}
1468
1469// Update new fru area length &
1470// Update checksum at new checksum location
1471static void updateFruAreaLenAndChecksum(std::vector<uint8_t>& fruData,
1472 size_t fruAreaStartOffset,
1473 size_t fruAreaNoMoreFieldOffset)
1474{
1475 constexpr size_t fruAreaMultipleBytes = 8;
1476 size_t traverseFruAreaIndex = fruAreaNoMoreFieldOffset - fruAreaStartOffset;
1477
1478 // fill zeros for any remaining unused space
1479 std::fill(fruData.begin() + fruAreaNoMoreFieldOffset, fruData.end(), 0);
1480
1481 size_t mod = traverseFruAreaIndex % fruAreaMultipleBytes;
1482 size_t checksumLoc;
1483 if (!mod)
1484 {
1485 traverseFruAreaIndex += (fruAreaMultipleBytes);
1486 checksumLoc = fruAreaNoMoreFieldOffset + (fruAreaMultipleBytes - 1);
1487 }
1488 else
1489 {
1490 traverseFruAreaIndex += (fruAreaMultipleBytes - mod);
1491 checksumLoc =
1492 fruAreaNoMoreFieldOffset + (fruAreaMultipleBytes - mod - 1);
1493 }
1494
1495 size_t newFruAreaLen = (traverseFruAreaIndex / fruAreaMultipleBytes) +
1496 ((traverseFruAreaIndex % fruAreaMultipleBytes) != 0);
1497 size_t fruAreaLengthLoc = fruAreaStartOffset + 1;
1498 fruData[fruAreaLengthLoc] = static_cast<uint8_t>(newFruAreaLen);
1499
1500 // Calculate new checksum
1501 std::vector<uint8_t> finalFruData;
1502 std::copy_n(fruData.begin() + fruAreaStartOffset,
1503 checksumLoc - fruAreaStartOffset,
1504 std::back_inserter(finalFruData));
1505
1506 size_t checksumVal = calculateChecksum(finalFruData);
1507
1508 fruData[checksumLoc] = static_cast<uint8_t>(checksumVal);
1509}
1510
1511static size_t getTypeLength(uint8_t fruFieldTypeLenValue)
1512{
1513 constexpr uint8_t typeLenMask = 0x3F;
1514 return fruFieldTypeLenValue & typeLenMask;
1515}
1516
1517// Details with example of Asset Tag Update
1518// To find location of Product Info Area asset tag as per FRU specification
1519// 1. Find product Info area starting offset (*8 - as header will be in
1520// multiple of 8 bytes).
1521// 2. Skip 3 bytes of product info area (like format version, area length,
1522// and language code).
1523// 3. Traverse manufacturer name, product name, product version, & product
1524// serial number, by reading type/length code to reach the Asset Tag.
1525// 4. Update the Asset Tag, reposition the product Info area in multiple of
1526// 8 bytes. Update the Product area length and checksum.
1527
1528bool updateFruProperty(
1529 const std::string& updatePropertyReq, uint32_t bus, uint32_t address,
1530 std::string propertyName,
1531 boost::container::flat_map<
1532 std::pair<size_t, size_t>,
1533 std::shared_ptr<sdbusplus::asio::dbus_interface>>& dbusInterfaceMap)
1534{
1535 size_t updatePropertyReqLen = updatePropertyReq.length();
1536 if (updatePropertyReqLen == 1 || updatePropertyReqLen > 63)
1537 {
1538 std::cerr
1539 << "Fru field data cannot be of 1 char or more than 63 chars. "
1540 "Invalid Length "
1541 << updatePropertyReqLen << "\n";
1542 return false;
1543 }
1544
1545 std::vector<uint8_t> fruData;
1546 try
1547 {
1548 fruData = getFruInfo(static_cast<uint8_t>(bus),
1549 static_cast<uint8_t>(address));
1550 }
1551 catch (std::invalid_argument& e)
1552 {
1553 std::cerr << "Failure getting Fru Info" << e.what() << "\n";
1554 return false;
1555 }
1556
1557 if (fruData.empty())
1558 {
1559 return false;
1560 }
1561
1562 const std::vector<const char*>* fieldData;
1563
1564 constexpr size_t commonHeaderMultipleBytes = 8; // in multiple of 8 bytes
1565 uint8_t fruAreaOffsetFieldValue = 1;
1566 size_t offset = 0;
1567
1568 if (propertyName.find("CHASSIS") == 0)
1569 {
1570 constexpr size_t fruAreaOffsetField = 2;
1571 fruAreaOffsetFieldValue = fruData[fruAreaOffsetField];
1572
1573 offset = 3; // chassis part number offset. Skip fixed first 3 bytes
1574
1575 fieldData = &CHASSIS_FRU_AREAS;
1576 }
1577 else if (propertyName.find("BOARD") == 0)
1578 {
1579 constexpr size_t fruAreaOffsetField = 3;
1580 fruAreaOffsetFieldValue = fruData[fruAreaOffsetField];
1581
1582 offset = 6; // board manufacturer offset. Skip fixed first 6 bytes
1583
1584 fieldData = &BOARD_FRU_AREAS;
1585 }
1586 else if (propertyName.find("PRODUCT") == 0)
1587 {
1588 constexpr size_t fruAreaOffsetField = 4;
1589 fruAreaOffsetFieldValue = fruData[fruAreaOffsetField];
1590
1591 offset = 3;
1592 // Manufacturer name offset. Skip fixed first 3 product fru bytes i.e.
1593 // version, area length and language code
1594
1595 fieldData = &PRODUCT_FRU_AREAS;
1596 }
1597 else
1598 {
1599 std::cerr << "ProperyName doesn't exist in Fru Area Vector \n";
1600 return false;
1601 }
1602
1603 size_t fruAreaStartOffset =
1604 fruAreaOffsetFieldValue * commonHeaderMultipleBytes;
1605 size_t fruDataIter = fruAreaStartOffset + offset;
1606 size_t fruUpdateFieldLoc = 0;
1607 size_t typeLength;
1608 size_t skipToFruUpdateField = 0;
1609
1610 for (auto& field : *fieldData)
1611 {
1612 skipToFruUpdateField++;
1613 if (propertyName.find(field) != std::string::npos)
1614 {
1615 break;
1616 }
1617 }
1618
1619 for (size_t i = 1; i < skipToFruUpdateField; i++)
1620 {
1621 typeLength = getTypeLength(fruData[fruDataIter]);
1622 fruUpdateFieldLoc = fruDataIter + typeLength;
1623 fruDataIter = ++fruUpdateFieldLoc;
1624 }
1625
1626 // Push post update fru field bytes to a vector
1627 typeLength = getTypeLength(fruData[fruUpdateFieldLoc]);
1628 size_t postFruUpdateFieldLoc = fruUpdateFieldLoc + typeLength;
1629 postFruUpdateFieldLoc++;
1630 skipToFruUpdateField++;
1631 fruDataIter = postFruUpdateFieldLoc;
1632 size_t endLengthLoc = 0;
1633 size_t fruFieldLoc = 0;
1634 constexpr uint8_t endLength = 0xC1;
1635 for (size_t i = fruDataIter; i < fruData.size(); i++)
1636 {
1637 typeLength = getTypeLength(fruData[fruDataIter]);
1638 fruFieldLoc = fruDataIter + typeLength;
1639 fruDataIter = ++fruFieldLoc;
1640 if (fruData[fruDataIter] == endLength)
1641 {
1642 endLengthLoc = fruDataIter;
1643 break;
1644 }
1645 }
1646 endLengthLoc++;
1647
1648 std::vector<uint8_t> postUpdatedFruData;
1649 std::copy_n(fruData.begin() + postFruUpdateFieldLoc,
1650 endLengthLoc - postFruUpdateFieldLoc,
1651 std::back_inserter(postUpdatedFruData));
1652
1653 // write new requested property field length and data
1654 constexpr uint8_t newTypeLenMask = 0xC0;
1655 fruData[fruUpdateFieldLoc] =
1656 static_cast<uint8_t>(updatePropertyReqLen | newTypeLenMask);
1657 fruUpdateFieldLoc++;
1658 std::copy(updatePropertyReq.begin(), updatePropertyReq.end(),
1659 fruData.begin() + fruUpdateFieldLoc);
1660
1661 // Copy remaining data to main fru area - post updated fru field vector
1662 postFruUpdateFieldLoc = fruUpdateFieldLoc + updatePropertyReqLen;
1663 size_t fruAreaEndOffset = postFruUpdateFieldLoc + postUpdatedFruData.size();
1664 if (fruAreaEndOffset > fruData.size())
1665 {
1666 std::cerr << "Fru area offset: " << fruAreaEndOffset
1667 << "should not be greater than Fru data size: "
1668 << fruData.size() << std::endl;
1669 throw std::invalid_argument(
1670 "Fru area offset should not be greater than Fru data size");
1671 }
1672 std::copy(postUpdatedFruData.begin(), postUpdatedFruData.end(),
1673 fruData.begin() + postFruUpdateFieldLoc);
1674
1675 // Update final fru with new fru area length and checksum
1676 updateFruAreaLenAndChecksum(fruData, fruAreaStartOffset, fruAreaEndOffset);
1677
1678 if (fruData.empty())
1679 {
1680 return false;
1681 }
1682
1683 if (!writeFru(static_cast<uint8_t>(bus), static_cast<uint8_t>(address),
1684 fruData))
1685 {
1686 return false;
1687 }
1688
1689 // Rescan the bus so that GetRawFru dbus-call fetches updated values
1690 rescanBusses(busMap, dbusInterfaceMap);
1691 return true;
1692}
1693
James Feist98132792019-07-09 13:29:09 -07001694int main()
James Feist3cb5fec2018-01-23 14:41:51 -08001695{
1696 auto devDir = fs::path("/dev/");
James Feistc9dff1b2019-02-13 13:33:13 -08001697 auto matchString = std::string(R"(i2c-\d+$)");
James Feist3cb5fec2018-01-23 14:41:51 -08001698 std::vector<fs::path> i2cBuses;
1699
James Feista3c180a2018-08-09 16:06:04 -07001700 if (!findFiles(devDir, matchString, i2cBuses))
James Feist3cb5fec2018-01-23 14:41:51 -08001701 {
1702 std::cerr << "unable to find i2c devices\n";
1703 return 1;
1704 }
James Feist3cb5fec2018-01-23 14:41:51 -08001705
Patrick Venture11f1ff42019-08-01 10:42:12 -07001706 // check for and load blacklist with initial buses.
1707 loadBlacklist(blacklistPath);
1708
Vijay Khemka065f6d92018-12-18 10:37:47 -08001709 systemBus->request_name("xyz.openbmc_project.FruDevice");
James Feist3cb5fec2018-01-23 14:41:51 -08001710
James Feist6ebf9de2018-05-15 15:01:17 -07001711 // this is a map with keys of pair(bus number, address) and values of
1712 // the object on dbus
James Feist3cb5fec2018-01-23 14:41:51 -08001713 boost::container::flat_map<std::pair<size_t, size_t>,
James Feist9eb0b582018-04-27 12:15:46 -07001714 std::shared_ptr<sdbusplus::asio::dbus_interface>>
1715 dbusInterfaceMap;
James Feist3cb5fec2018-01-23 14:41:51 -08001716
James Feist9eb0b582018-04-27 12:15:46 -07001717 std::shared_ptr<sdbusplus::asio::dbus_interface> iface =
1718 objServer.add_interface("/xyz/openbmc_project/FruDevice",
1719 "xyz.openbmc_project.FruDeviceManager");
James Feist3cb5fec2018-01-23 14:41:51 -08001720
James Feist5cb06082019-10-24 17:11:13 -07001721 iface->register_method("ReScan",
1722 [&]() { rescanBusses(busMap, dbusInterfaceMap); });
James Feist2a9d6db2018-04-27 15:48:28 -07001723
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001724 iface->register_method("ReScanBus", [&](uint8_t bus) {
James Feist5d7f4692020-06-17 18:22:33 -07001725 rescanOneBus(busMap, bus, dbusInterfaceMap, true);
Cheng C Yangd5b87fb2020-01-23 10:10:45 +08001726 });
1727
Nikhil Potaded8884f12019-03-27 13:27:13 -07001728 iface->register_method("GetRawFru", getFruInfo);
James Feistb49ffc32018-05-02 11:10:43 -07001729
1730 iface->register_method("WriteFru", [&](const uint8_t bus,
1731 const uint8_t address,
James Feista465ccc2019-02-08 12:51:01 -08001732 const std::vector<uint8_t>& data) {
James Feistb49ffc32018-05-02 11:10:43 -07001733 if (!writeFru(bus, address, data))
1734 {
James Feistddb78302018-09-06 11:45:42 -07001735 throw std::invalid_argument("Invalid Arguments.");
James Feistb49ffc32018-05-02 11:10:43 -07001736 return;
1737 }
1738 // schedule rescan on success
James Feist5cb06082019-10-24 17:11:13 -07001739 rescanBusses(busMap, dbusInterfaceMap);
James Feistb49ffc32018-05-02 11:10:43 -07001740 });
James Feist9eb0b582018-04-27 12:15:46 -07001741 iface->initialize();
James Feist3cb5fec2018-01-23 14:41:51 -08001742
James Feist9eb0b582018-04-27 12:15:46 -07001743 std::function<void(sdbusplus::message::message & message)> eventHandler =
James Feista465ccc2019-02-08 12:51:01 -08001744 [&](sdbusplus::message::message& message) {
James Feist918e18c2018-02-13 15:51:07 -08001745 std::string objectName;
James Feist9eb0b582018-04-27 12:15:46 -07001746 boost::container::flat_map<
James Feista465ccc2019-02-08 12:51:01 -08001747 std::string,
1748 std::variant<std::string, bool, int64_t, uint64_t, double>>
James Feist9eb0b582018-04-27 12:15:46 -07001749 values;
1750 message.read(objectName, values);
James Feist0eeb79c2019-10-09 13:35:29 -07001751 auto findState = values.find("CurrentHostState");
James Feist0eeb79c2019-10-09 13:35:29 -07001752 if (findState != values.end())
James Feist918e18c2018-02-13 15:51:07 -08001753 {
James Feistcb5661d2020-06-12 15:05:01 -07001754 powerIsOn = boost::ends_with(
1755 std::get<std::string>(findState->second), "Running");
James Feist0eeb79c2019-10-09 13:35:29 -07001756 }
James Feist6ebf9de2018-05-15 15:01:17 -07001757
James Feistcb5661d2020-06-12 15:05:01 -07001758 if (powerIsOn)
James Feist0eeb79c2019-10-09 13:35:29 -07001759 {
James Feist5cb06082019-10-24 17:11:13 -07001760 rescanBusses(busMap, dbusInterfaceMap);
James Feist918e18c2018-02-13 15:51:07 -08001761 }
James Feist918e18c2018-02-13 15:51:07 -08001762 };
James Feist9eb0b582018-04-27 12:15:46 -07001763
1764 sdbusplus::bus::match::match powerMatch = sdbusplus::bus::match::match(
James Feista465ccc2019-02-08 12:51:01 -08001765 static_cast<sdbusplus::bus::bus&>(*systemBus),
James Feist7bcd3f22019-03-18 16:04:04 -07001766 "type='signal',interface='org.freedesktop.DBus.Properties',path='/xyz/"
James Feist0eeb79c2019-10-09 13:35:29 -07001767 "openbmc_project/state/"
1768 "host0',arg0='xyz.openbmc_project.State.Host'",
James Feist9eb0b582018-04-27 12:15:46 -07001769 eventHandler);
1770
James Feist4131aea2018-03-09 09:47:30 -08001771 int fd = inotify_init();
James Feist0eb40352019-04-09 14:44:04 -07001772 inotify_add_watch(fd, I2C_DEV_LOCATION,
1773 IN_CREATE | IN_MOVED_TO | IN_DELETE);
James Feist4131aea2018-03-09 09:47:30 -08001774 std::array<char, 4096> readBuffer;
1775 std::string pendingBuffer;
1776 // monitor for new i2c devices
1777 boost::asio::posix::stream_descriptor dirWatch(io, fd);
1778 std::function<void(const boost::system::error_code, std::size_t)>
James Feista465ccc2019-02-08 12:51:01 -08001779 watchI2cBusses = [&](const boost::system::error_code& ec,
James Feist4131aea2018-03-09 09:47:30 -08001780 std::size_t bytes_transferred) {
1781 if (ec)
1782 {
1783 std::cout << "Callback Error " << ec << "\n";
1784 return;
1785 }
1786 pendingBuffer += std::string(readBuffer.data(), bytes_transferred);
James Feist4131aea2018-03-09 09:47:30 -08001787 while (pendingBuffer.size() > sizeof(inotify_event))
1788 {
James Feista465ccc2019-02-08 12:51:01 -08001789 const inotify_event* iEvent =
1790 reinterpret_cast<const inotify_event*>(
James Feist4131aea2018-03-09 09:47:30 -08001791 pendingBuffer.data());
1792 switch (iEvent->mask)
1793 {
James Feist9eb0b582018-04-27 12:15:46 -07001794 case IN_CREATE:
1795 case IN_MOVED_TO:
1796 case IN_DELETE:
James Feist5d7f4692020-06-17 18:22:33 -07001797 std::string name(iEvent->name);
1798 if (boost::starts_with(name, "i2c"))
James Feist9eb0b582018-04-27 12:15:46 -07001799 {
James Feist5d7f4692020-06-17 18:22:33 -07001800 int bus = busStrToInt(name);
1801 if (bus < 0)
1802 {
1803 std::cerr << "Could not parse bus " << name
1804 << "\n";
1805 continue;
1806 }
1807 rescanOneBus(busMap, static_cast<uint8_t>(bus),
1808 dbusInterfaceMap, false);
James Feist9eb0b582018-04-27 12:15:46 -07001809 }
James Feist4131aea2018-03-09 09:47:30 -08001810 }
1811
1812 pendingBuffer.erase(0, sizeof(inotify_event) + iEvent->len);
1813 }
James Feist6ebf9de2018-05-15 15:01:17 -07001814
James Feist4131aea2018-03-09 09:47:30 -08001815 dirWatch.async_read_some(boost::asio::buffer(readBuffer),
1816 watchI2cBusses);
1817 };
1818
1819 dirWatch.async_read_some(boost::asio::buffer(readBuffer), watchI2cBusses);
Gunnar Millsb3e42fe2018-06-13 15:48:27 -05001820 // run the initial scan
James Feist5cb06082019-10-24 17:11:13 -07001821 rescanBusses(busMap, dbusInterfaceMap);
James Feist918e18c2018-02-13 15:51:07 -08001822
James Feist3cb5fec2018-01-23 14:41:51 -08001823 io.run();
1824 return 0;
1825}