blob: 5282831155ad43c4c6f49cc5e22bd6e4bf64340a [file] [log] [blame]
Patrick Venture22e38752018-11-21 08:52:49 -08001/*
2 * Copyright 2018 Google Inc.
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 Venture148cd652018-11-06 10:59:47 -080017#include "config.h"
18
Patrick Venturea6b4abd2019-07-19 10:58:55 -070019#include "buildjson.hpp"
Patrick Venture64919ec2018-11-15 11:52:07 -080020#include "file_handler.hpp"
Patrick Venturec7ca2912018-11-02 11:38:33 -070021#include "firmware_handler.hpp"
Patrick Venture84778b82019-06-26 20:11:09 -070022#include "flags.hpp"
Patrick Venturecf066ac2019-08-06 09:03:47 -070023#include "general_systemd.hpp"
Patrick Venturea78e39f2018-11-06 18:37:06 -080024#include "image_handler.hpp"
Patrick Ventureefce8f92018-12-14 16:39:00 -080025#include "lpc_aspeed.hpp"
Patrick Venture1cde5f92018-11-07 08:26:47 -080026#include "lpc_handler.hpp"
Patrick Ventureefce8f92018-12-14 16:39:00 -080027#include "lpc_nuvoton.hpp"
Benjamin Fair545f5652019-10-09 14:18:54 -070028#include "net_handler.hpp"
Patrick Venture1cde5f92018-11-07 08:26:47 -080029#include "pci_handler.hpp"
Patrick Venture1d66fe62019-06-03 14:57:27 -070030#include "status.hpp"
Patrick Venture7dad86f2019-05-17 08:52:20 -070031#include "util.hpp"
Patrick Venturec7ca2912018-11-02 11:38:33 -070032
Patrick Venture4eb55952018-11-16 15:36:24 -080033#include <sdbusplus/bus.hpp>
Patrick Venture9b37b092020-05-28 20:58:57 -070034
35#include <cstdint>
36#include <memory>
Patrick Venturea6b4abd2019-07-19 10:58:55 -070037#include <string>
Patrick Venturefa06a5f2019-07-01 09:22:38 -070038#include <unordered_map>
Patrick Venturea6b4abd2019-07-19 10:58:55 -070039#include <vector>
Patrick Venturec7ca2912018-11-02 11:38:33 -070040
Patrick Venture1d5a31c2019-05-20 11:38:22 -070041namespace ipmi_flash
Patrick Venturec7ca2912018-11-02 11:38:33 -070042{
Patrick Venturea6b4abd2019-07-19 10:58:55 -070043
Patrick Venturea78e39f2018-11-06 18:37:06 -080044namespace
45{
Patrick Venture48e309c2019-06-29 07:51:19 -070046
Patrick Venturea6b4abd2019-07-19 10:58:55 -070047static constexpr const char* jsonConfigurationPath =
48 "/usr/share/phosphor-ipmi-flash/";
49
Patrick Venturef32a4532019-07-19 10:15:40 -070050/**
51 * Given a name and path, create a HandlerPack.
52 *
53 * @param[in] name - the blob id path for this
54 * @param[in] path - the file path to write the contents.
55 * @return the HandlerPack.
56 */
57HandlerPack CreateFileHandlerPack(const std::string& name,
58 const std::string& path)
59{
60 return HandlerPack(name, std::make_unique<FileHandler>(path));
61}
62
Patrick Venturef62ec6b2020-09-24 09:07:10 -070063/**
64 * Returns the corresponding memory region size given the compiled
65 * configuration.
66 *
67 * @return the size.
68 */
69std::size_t GetMemoryRegionSize()
70{
71#ifdef NUVOTON_P2A_MBOX
72 constexpr std::size_t memoryRegionSize = 16 * 1024UL;
73#elif defined NUVOTON_P2A_VGA
74 constexpr std::size_t memoryRegionSize = 4 * 1024 * 1024UL;
75#else
76 /* The maximum external buffer size we expect is 64KB. */
77 constexpr std::size_t memoryRegionSize = 64 * 1024UL;
78#endif
79
80 return memoryRegionSize;
81}
82
Patrick Venturea78e39f2018-11-06 18:37:06 -080083} // namespace
Patrick Venture1d5a31c2019-05-20 11:38:22 -070084} // namespace ipmi_flash
Patrick Venturec7ca2912018-11-02 11:38:33 -070085
Patrick Venture9b37b092020-05-28 20:58:57 -070086extern "C"
87{
88 std::unique_ptr<blobs::GenericBlobInterface> createHandler();
Patrick Venture5b451e62018-11-14 14:20:08 -080089}
Patrick Venture5b451e62018-11-14 14:20:08 -080090
91std::unique_ptr<blobs::GenericBlobInterface> createHandler()
Patrick Venturec7ca2912018-11-02 11:38:33 -070092{
Patrick Venturee7402692020-09-22 16:26:22 -070093 using namespace ipmi_flash;
Patrick Venture7c2a00e2019-07-01 17:33:03 -070094
Patrick Venture4934daa2020-09-22 16:37:44 -070095 std::vector<DataHandlerPack> supportedTransports;
96
97 supportedTransports.emplace_back(FirmwareFlags::UpdateFlags::ipmi, nullptr);
98
Patrick Venture12b76c92020-09-22 16:31:39 -070099#ifdef ENABLE_PCI_BRIDGE
Patrick Venture4934daa2020-09-22 16:37:44 -0700100 supportedTransports.emplace_back(
101 FirmwareFlags::UpdateFlags::p2a,
Patrick Venturef62ec6b2020-09-24 09:07:10 -0700102 std::make_unique<PciDataHandler>(MAPPED_ADDRESS,
103 GetMemoryRegionSize()));
Patrick Venture12b76c92020-09-22 16:31:39 -0700104#endif
Patrick Venture4934daa2020-09-22 16:37:44 -0700105
Patrick Venture12b76c92020-09-22 16:31:39 -0700106#ifdef ENABLE_LPC_BRIDGE
Patrick Venture4934daa2020-09-22 16:37:44 -0700107#if defined(ASPEED_LPC)
108 supportedTransports.emplace_back(
109 FirmwareFlags::UpdateFlags::lpc,
110 std::make_unique<LpcDataHandler>(LpcMapperAspeed::createAspeedMapper(
Patrick Venturef62ec6b2020-09-24 09:07:10 -0700111 MAPPED_ADDRESS, GetMemoryRegionSize())));
Patrick Venture4934daa2020-09-22 16:37:44 -0700112#elif defined(NUVOTON_LPC)
113 supportedTransports.emplace_back(
114 FirmwareFlags::UpdateFlags::lpc,
115 std::make_unique<LpcDataHandler>(LpcMapperNuvoton::createNuvotonMapper(
Patrick Venturef62ec6b2020-09-24 09:07:10 -0700116 MAPPED_ADDRESS, GetMemoryRegionSize())));
Patrick Venture4934daa2020-09-22 16:37:44 -0700117#else
118#error "You must specify a hardware implementation."
Patrick Venture12b76c92020-09-22 16:31:39 -0700119#endif
Patrick Venture4934daa2020-09-22 16:37:44 -0700120#endif
121
Patrick Venture12b76c92020-09-22 16:31:39 -0700122#ifdef ENABLE_NET_BRIDGE
Patrick Venture4934daa2020-09-22 16:37:44 -0700123 supportedTransports.emplace_back(FirmwareFlags::UpdateFlags::net,
124 std::make_unique<NetDataHandler>());
Patrick Venture12b76c92020-09-22 16:31:39 -0700125#endif
Patrick Venture12b76c92020-09-22 16:31:39 -0700126
Patrick Venturee7402692020-09-22 16:26:22 -0700127 ActionMap actionPacks = {};
Patrick Venture7c2a00e2019-07-01 17:33:03 -0700128
Patrick Venturee7402692020-09-22 16:26:22 -0700129 std::vector<HandlerConfig> configsFromJson =
130 BuildHandlerConfigs(jsonConfigurationPath);
Patrick Ventured4e20de2019-07-18 12:48:05 -0700131
Patrick Venturee7402692020-09-22 16:26:22 -0700132 std::vector<HandlerPack> supportedFirmware;
133
134 supportedFirmware.push_back(
135 std::move(CreateFileHandlerPack(hashBlobId, HASH_FILENAME)));
Patrick Ventured4e20de2019-07-18 12:48:05 -0700136
Patrick Venture1871fe92019-07-19 14:46:08 -0700137 for (auto& config : configsFromJson)
138 {
Patrick Venturee7402692020-09-22 16:26:22 -0700139 supportedFirmware.push_back(
140 std::move(HandlerPack(config.blobId, std::move(config.handler))));
Patrick Venture1871fe92019-07-19 14:46:08 -0700141 actionPacks[config.blobId] = std::move(config.actions);
142
143 std::fprintf(stderr, "config loaded: %s\n", config.blobId.c_str());
144 }
Patrick Ventured4e20de2019-07-18 12:48:05 -0700145
Patrick Venturee7402692020-09-22 16:26:22 -0700146 auto handler = FirmwareBlobHandler::CreateFirmwareBlobHandler(
147 std::move(supportedFirmware), std::move(supportedTransports),
148 std::move(actionPacks));
Patrick Venture52854622018-11-06 12:30:00 -0800149
150 if (!handler)
151 {
Patrick Venture1ab824a2020-05-26 19:29:57 -0700152 std::fprintf(stderr, "Firmware Handler has an invalid configuration");
Patrick Venture5b451e62018-11-14 14:20:08 -0800153 return nullptr;
Patrick Venture52854622018-11-06 12:30:00 -0800154 }
155
Patrick Venturee1118bc2019-06-19 07:32:48 -0700156 return handler;
Patrick Venturec7ca2912018-11-02 11:38:33 -0700157}