summaryrefslogtreecommitdiffstats
path: root/src/usr
diff options
context:
space:
mode:
authorRoland Veloz <rveloz@us.ibm.com>2017-11-21 15:02:53 -0600
committerDaniel M. Crowell <dcrowell@us.ibm.com>2017-12-20 17:47:12 -0500
commit8e6bd68539af8394a3f96dab15464edc151794bb (patch)
tree03e3f07d0599bc0e60b54e4e3aa4d4c38b333f37 /src/usr
parent5cd50322982059a6b71d5957e22f6f85da17404e (diff)
downloadblackbird-hostboot-8e6bd68539af8394a3f96dab15464edc151794bb.tar.gz
blackbird-hostboot-8e6bd68539af8394a3f96dab15464edc151794bb.zip
Updated the GenericFspMboxMessage_t struct
The GenericFspMboxMessage_t struct has been expanded to provide a lot more data than before. The highlights are that it now carries the data size, an error only flag, a sequence number and a magic number to identify the message. An initialize method has been provided to set some of these to default values. In addition the message types are consolidated into one enum. All enums have a prefix of GFMM to avoid name collisions. The sequence number is an auto incrementing number so we can keep track if the messages are received out of order. Change-Id: Ic0f1c2546ff1ce14f163d1da55646ed089216d19 RTC: 182267 Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/49960 Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com> Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Diffstat (limited to 'src/usr')
-rw-r--r--src/usr/isteps/pm/runtime/test/firmwareRequestTest.H136
-rw-r--r--src/usr/testcore/rtloader/loader.H129
-rw-r--r--src/usr/util/runtime/makefile1
-rw-r--r--src/usr/util/runtime/rt_fwnotify.C354
-rw-r--r--src/usr/vpd/runtime/rt_vpd.C44
5 files changed, 590 insertions, 74 deletions
diff --git a/src/usr/isteps/pm/runtime/test/firmwareRequestTest.H b/src/usr/isteps/pm/runtime/test/firmwareRequestTest.H
index 231197ec3..22d5bfc31 100644
--- a/src/usr/isteps/pm/runtime/test/firmwareRequestTest.H
+++ b/src/usr/isteps/pm/runtime/test/firmwareRequestTest.H
@@ -25,6 +25,8 @@
#include <cxxtest/TestSuite.H>
#include <runtime/interface.h>
+#include <errl/hberrltypes.H>
+#include <string.h>
extern trace_desc_t* g_trac_pnor;
@@ -61,7 +63,7 @@ class FirmwareRequestTest : public CxxTest::TestSuite
hostInterfaces::hbrt_fw_msg l_resp_fw_msg;
- uint64_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
+ size_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
size_t rc = g_hostInterfaces->firmware_request(
sizeof(l_req_fw_msg), &l_req_fw_msg,
&l_resp_fw_msg_size, &l_resp_fw_msg);
@@ -125,7 +127,7 @@ class FirmwareRequestTest : public CxxTest::TestSuite
l_req_fw_msg.error_log.i_data = 0xAA;
hostInterfaces::hbrt_fw_msg l_resp_fw_msg;
- uint64_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
+ size_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
size_t rc = g_hostInterfaces->firmware_request(
sizeof(l_req_fw_msg), &l_req_fw_msg,
&l_resp_fw_msg_size, &l_resp_fw_msg);
@@ -183,36 +185,94 @@ class FirmwareRequestTest : public CxxTest::TestSuite
// Test HBRT to FSP
// populate the firmware_request structure with arbitrary data
hostInterfaces::hbrt_fw_msg l_req_fw_msg;
- l_req_fw_msg.io_type = hostInterfaces::HBRT_FW_MSG_HBRT_FSP;
- l_req_fw_msg.generic_message.msgq = 0x300;
- l_req_fw_msg.generic_message.msgType = 0x400;
- l_req_fw_msg.generic_message.data = 0xDEADBEEF;
+ l_req_fw_msg.generic_msg.initialize();
+
+ if (l_req_fw_msg.generic_msg.magic != GFMM_MAGIC_NUMBER)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "magic was not properly initialized");
+ }
+
+ if (l_req_fw_msg.generic_msg.dataSize !=
+ sizeof(l_req_fw_msg.generic_msg))
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "dataSize was not properly initialized");
+ }
+
+ if (l_req_fw_msg.generic_msg.structVer != GFMM_VERSION)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "structVer was not properly initialized");
+ }
+
+ if (l_req_fw_msg.generic_msg.seqnum != SeqId_t::getCurrentSeqId())
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "seqnum was not properly initialized");
+ }
+
+ l_req_fw_msg.io_type = hostInterfaces::HBRT_FW_MSG_HBRT_FSP_REQ;
+ l_req_fw_msg.generic_msg.magic = 0x100;
+ l_req_fw_msg.generic_msg.dataSize =
+ sizeof(l_req_fw_msg.generic_msg);
+ l_req_fw_msg.generic_msg.structVer = 0x20;
+ l_req_fw_msg.generic_msg.seqnum = 0x300;
+ l_req_fw_msg.generic_msg.msgq = 0x400;
+ l_req_fw_msg.generic_msg.msgType = 0x500;
+ l_req_fw_msg.generic_msg.__req = GFMM_REQUEST;
+ l_req_fw_msg.generic_msg.__onlyError = GFMM_ERROR_ONLY;
+ uint32_t l_plid = 0x600;
+ uint32_t l_huid = 0x700;
+ l_req_fw_msg.generic_msg.data =
+ TWO_UINT32_TO_UINT64(l_plid, l_huid);
TRACFCOMP(g_trac_pnor,
"FirmwareRequestTest::testFirmwareRequestHbrtToFsp req: "
- "type:%d, msgq:0x%.8X, msgType:0x%.8X, data:0x%.8X",
+ "type:%d, magic:0x%.8X, dataSize:%d, structVer:0x%.8X, "
+ "seqnum:%.8X, msgq:0x%.8X, msgType:0x%.8X, __req:%d, "
+ "__onlyError:%d, data:0x%.8X, plid:0x%.8X, huid:0x%.8X",
l_req_fw_msg.io_type,
- l_req_fw_msg.generic_message.msgq,
- l_req_fw_msg.generic_message.msgType,
- l_req_fw_msg.generic_message.data);
+ l_req_fw_msg.generic_msg.magic,
+ l_req_fw_msg.generic_msg.dataSize,
+ l_req_fw_msg.generic_msg.structVer,
+ l_req_fw_msg.generic_msg.seqnum,
+ l_req_fw_msg.generic_msg.msgq,
+ l_req_fw_msg.generic_msg.msgType,
+ l_req_fw_msg.generic_msg.__req,
+ l_req_fw_msg.generic_msg.__onlyError,
+ l_req_fw_msg.generic_msg.data,
+ l_req_fw_msg.generic_msg.data >> 32,
+ 0x0000FFFF & l_req_fw_msg.generic_msg.data);
hostInterfaces::hbrt_fw_msg l_resp_fw_msg;
- uint64_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
+ size_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
+ memset(&l_resp_fw_msg, 0, l_resp_fw_msg_size);
size_t rc = g_hostInterfaces->firmware_request(
sizeof(l_req_fw_msg), &l_req_fw_msg,
&l_resp_fw_msg_size, &l_resp_fw_msg);
TRACFCOMP(g_trac_pnor,
"FirmwareRequestTest::testFirmwareRequestHbrtToFsp resp: "
- "type:0x%.8X, msgq:0x%.8X, msgType:0x%.8X,"
- " errPlid:0x%X, rc=%d",
+ "type:%d, magic:0x%.8X, dataSize:%d, structVer:0x%.8X, "
+ "seqnum:%.8X, msgq:0x%.8X, msgType:0x%.8X, __req:%d, "
+ "__onlyError:%d, data:0x%.8X, plid:0x%.8X, huid:0x%.8X, "
+ "rc=%d",
l_resp_fw_msg.io_type,
- l_resp_fw_msg.generic_message_resp.msgq,
- l_resp_fw_msg.generic_message_resp.msgType,
- l_resp_fw_msg.generic_message_resp.errPlid,
+ l_resp_fw_msg.generic_msg.magic,
+ l_resp_fw_msg.generic_msg.dataSize,
+ l_resp_fw_msg.generic_msg.structVer,
+ l_resp_fw_msg.generic_msg.seqnum,
+ l_resp_fw_msg.generic_msg.msgq,
+ l_resp_fw_msg.generic_msg.msgType,
+ l_resp_fw_msg.generic_msg.__req,
+ l_resp_fw_msg.generic_msg.__onlyError,
+ l_resp_fw_msg.generic_msg.data,
+ l_resp_fw_msg.generic_msg.data >> 32,
+ 0x0000FFFF & l_resp_fw_msg.generic_msg.data,
rc);
- if (rc != 0)
+ if (rc != 5)
{
TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
"firmware_request - HBRT to FSP failed - "
@@ -227,26 +287,62 @@ class FirmwareRequestTest : public CxxTest::TestSuite
"received incorrect msg_type");
}
- if (l_resp_fw_msg.generic_message_resp.msgq != 0x800)
+ if (l_resp_fw_msg.generic_msg.magic != 0x10)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "firmware_request - HBRT to FSP failed - "
+ "received incorrect magic");
+ }
+
+ if (l_resp_fw_msg.generic_msg.dataSize != 32)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "firmware_request - HBRT to FSP failed - "
+ "received incorrect datSize");
+ }
+
+
+ if (l_resp_fw_msg.generic_msg.structVer != 0x02)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "firmware_request - HBRT to FSP failed - "
+ "received incorrect structVer");
+ }
+
+ if (l_resp_fw_msg.generic_msg.seqnum != 0x30)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "firmware_request - HBRT to FSP failed - "
+ "received incorrect seqnum");
+ }
+
+ if (l_resp_fw_msg.generic_msg.msgq != 0x40)
{
TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
"firware_request - HBRT to FSP failed - "
"received incorrect msgq");
}
- if (l_resp_fw_msg.generic_message_resp.msgType != 0x900)
+ if (l_resp_fw_msg.generic_msg.msgType != 0x50)
{
TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
"firware_request - HBRT to FSP failed - "
"received incorrect msgType");
}
- if (l_resp_fw_msg.generic_message_resp.errPlid != 0xA00)
+ if (l_resp_fw_msg.generic_msg.data >> 32 != 0x60)
{
TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
"firware_request - HBRT to FSP failed - "
"received incorrect errPlid");
}
+
+ if ((0x0000FFFF & l_resp_fw_msg.generic_msg.data) != 0x70)
+ {
+ TS_FAIL("FirmwareRequestTest::testFirmwareRequestHbrtToFsp: "
+ "firware_request - HBRT to FSP failed - "
+ "received incorrect huid");
+ }
}
TRACFCOMP(g_trac_pnor, EXIT_MRK
"FirmwareRequestTest::testFirmwareRequestHbrtToFsp");
diff --git a/src/usr/testcore/rtloader/loader.H b/src/usr/testcore/rtloader/loader.H
index 62e251370..973afd158 100644
--- a/src/usr/testcore/rtloader/loader.H
+++ b/src/usr/testcore/rtloader/loader.H
@@ -194,7 +194,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
if (cv_hb_data_addr != 0)
{
// unmap virtual memory
- TRACFCOMP( g_trac_hbrt, "tearDown(): unmap hb_data virt addr %p",
+ TRACFCOMP(g_trac_hbrt,
+ "tearDown(): unmap hb_data virt addr %p",
reinterpret_cast<void*>(cv_hb_data_addr));
int l_rc = mm_block_unmap(
@@ -212,7 +213,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
}
else
{
- TRACFCOMP( g_trac_hbrt, "tearDown(): skipping unmap hb_data virt addr");
+ TRACFCOMP( g_trac_hbrt,
+ "tearDown(): skipping unmap hb_data virt addr");
}
}
@@ -399,7 +401,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
static uint64_t rt_get_hb_data(uint32_t i_instance)
{
- TRACFCOMP( g_trac_hbrt, ENTER_MRK"rt_get_hb_data> i_instance=%d", i_instance );
+ TRACFCOMP( g_trac_hbrt,
+ ENTER_MRK"rt_get_hb_data> i_instance=%d", i_instance );
uint64_t l_totalSize = 0;
uint64_t l_vAddr = 0;
@@ -510,7 +513,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
l_err = PNOR::getSectionInfo(l_id, l_info);
if (l_err)
{
- TRACFCOMP(g_trac_hbrt, "rt_pnor_read: getSectionInfo errored");
+ TRACFCOMP(g_trac_hbrt,
+ "rt_pnor_read: getSectionInfo errored");
break;
}
@@ -532,7 +536,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
" deviceRead: offset:0x%X, flashAddr:0x%X, size:0x%X",
i_offset, l_flashAddr, l_bytes_to_read);
- l_err = DeviceFW::deviceRead (pnor_target, o_data, l_bytes_to_read,
+ l_err = DeviceFW::deviceRead (pnor_target, o_data,
+ l_bytes_to_read,
DEVICE_PNOR_ADDRESS(i_proc, l_flashAddr));
if (l_err)
{
@@ -582,7 +587,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
l_err = PNOR::getSectionInfo(l_id, l_info);
if (l_err)
{
- TRACFCOMP(g_trac_hbrt, "rt_pnor_write: getSectionInfo errored");
+ TRACFCOMP(g_trac_hbrt,
+ "rt_pnor_write: getSectionInfo errored");
break;
}
@@ -601,7 +607,8 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
DEVICE_PNOR_ADDRESS(i_proc, l_flashAddr));
if (l_err)
{
- TRACFCOMP(g_trac_hbrt, "rt_pnor_write: deviceWrite errored");
+ TRACFCOMP(g_trac_hbrt,
+ "rt_pnor_write: deviceWrite errored");
break;
}
} while (0);
@@ -716,7 +723,7 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
static int rt_firmware_request(uint64_t i_reqLen, void *i_req,
uint64_t* o_respLen, void *o_resp )
{
- int retVal = 0;
+ size_t retVal = 0;
do
{
if (i_req == nullptr ||
@@ -732,13 +739,6 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
hostInterfaces::hbrt_fw_msg* l_resp_fw_msg =
(hostInterfaces::hbrt_fw_msg*) o_resp;
- if (*o_respLen < (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
- sizeof(l_resp_fw_msg->resp_generic)))
- {
- retVal = -EINVAL;
- break;
- }
-
if (hostInterfaces::HBRT_FW_MSG_TYPE_REQ_HCODE_UPDATE
== l_req_fw_msg->io_type)
{
@@ -749,6 +749,13 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
break;
}
+ if (*o_respLen < (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
+ sizeof(l_resp_fw_msg->resp_generic)))
+ {
+ retVal = -EINVAL;
+ break;
+ }
+
TRACFCOMP(g_trac_hbrt,
"rt_firmware_request for HCODE SCOM update: "
"type:%d, chipId:0x%X, section:%d, "
@@ -786,6 +793,12 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
break;
}
+ if (*o_respLen < (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
+ sizeof(l_resp_fw_msg->resp_generic)))
+ {
+ retVal = -EINVAL;
+ break;
+ }
TRACFCOMP(g_trac_hbrt,
"rt_firmware_request for error log: "
@@ -803,41 +816,86 @@ class RuntimeLoaderTest : public CxxTest::TestSuite
retVal = 0; // just return 0 for testing
}
- else if (hostInterfaces::HBRT_FW_MSG_HBRT_FSP
+ else if (hostInterfaces::HBRT_FW_MSG_HBRT_FSP_REQ
== l_req_fw_msg->io_type)
{
if (i_reqLen < (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
- sizeof(l_req_fw_msg->generic_message)))
+ sizeof(l_req_fw_msg->generic_msg)))
{
retVal = -EINVAL;
break;
}
+ if (*o_respLen < (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
+ sizeof(l_resp_fw_msg->generic_msg)))
+ {
+ retVal = -EINVAL;
+ break;
+ }
+
+ uint32_t* l_data =
+ (uint32_t*) &(l_req_fw_msg->generic_msg.data);
TRACFCOMP(g_trac_hbrt,
- "rt_firmware_request for VPD Write Msg: "
- "type:0x%.8X, msgq:0x%.8X, VPD type:0x%.8X, data:0x%X",
+ "rt_firmware_request for VPD Write Msg request: "
+ "type:%d, magic:0x%.8X, dataSize:%d, structVer:0x%.8X, "
+ "seqnum:%d, msgq:0x%.8X, msgType:0x%.8X, __req:%d, "
+ "__onlyError:%d, data:0x%.8X, plid:0x%.8X, huid:0x%.8X",
l_req_fw_msg->io_type,
- l_req_fw_msg->generic_message.msgq,
- l_req_fw_msg->generic_message.msgType,
- l_req_fw_msg->generic_message.data);
-
- l_resp_fw_msg->io_type =
- hostInterfaces::HBRT_FW_MSG_HBRT_FSP_RESP;
+ l_req_fw_msg->generic_msg.magic,
+ l_req_fw_msg->generic_msg.dataSize,
+ l_req_fw_msg->generic_msg.structVer,
+ l_req_fw_msg->generic_msg.seqnum,
+ l_req_fw_msg->generic_msg.msgq,
+ l_req_fw_msg->generic_msg.msgType,
+ l_req_fw_msg->generic_msg.__req,
+ l_req_fw_msg->generic_msg.__onlyError,
+ l_req_fw_msg->generic_msg.data,
+ l_data[0],
+ l_data[1]);
// random testing data
- l_resp_fw_msg->generic_message_resp.msgq = 0x800;
- l_resp_fw_msg->generic_message_resp.msgType = 0x900;
- l_resp_fw_msg->generic_message_resp.errPlid = 0xA00;
- retVal = 0;
+ struct
+ {
+ uint32_t plid;
+ uint32_t huid;
+ } l_resp_data;
+ l_resp_fw_msg->io_type =
+ hostInterfaces::HBRT_FW_MSG_HBRT_FSP_RESP;
+ l_resp_fw_msg->generic_msg.magic = 0x10;
+ l_resp_fw_msg->generic_msg.dataSize =
+ sizeof(l_resp_fw_msg->generic_msg);
+ l_resp_fw_msg->generic_msg.structVer = 0x2;
+ l_resp_fw_msg->generic_msg.seqnum = 0x30;
+ l_resp_fw_msg->generic_msg.msgq = 0x40;
+ l_resp_fw_msg->generic_msg.msgType = 0x50;
+ l_resp_fw_msg->generic_msg.__req = GFMM_RESPONSE;
+ l_resp_fw_msg->generic_msg.__onlyError =
+ GFMM_NOT_ERROR_ONLY;
+ l_resp_data.plid = 0x60;
+ l_resp_data.huid = 0x70;
+ memcpy(&(l_resp_fw_msg->generic_msg.data),
+ &(l_resp_data),
+ sizeof(l_resp_fw_msg->generic_msg.data));
+ retVal = 5;
TRACFCOMP(g_trac_hbrt,
"rt_firmware_request for VPD Write Msg response: "
- "type:0x%.8X, msgq:0x%.8X, msgType:0x%.8X,"
- " errPlid:0x%X, retVal=%d",
+ "type:%d, magic:0x%.8X, dataSize:%d, structVer:0x%.8X, "
+ "seqnum:%d, msgq:0x%.8X, msgType:0x%.8X, __req:%d, "
+ "__onlyError:%d, data:0x%.8X, plid:0x%.8X, huid:0x%.8X, "
+ "retVal=%d",
l_resp_fw_msg->io_type,
- l_resp_fw_msg->generic_message_resp.msgq,
- l_resp_fw_msg->generic_message_resp.msgType,
- l_resp_fw_msg->generic_message_resp.errPlid,
+ l_resp_fw_msg->generic_msg.magic,
+ l_resp_fw_msg->generic_msg.dataSize,
+ l_resp_fw_msg->generic_msg.structVer,
+ l_resp_fw_msg->generic_msg.seqnum,
+ l_resp_fw_msg->generic_msg.msgq,
+ l_resp_fw_msg->generic_msg.msgType,
+ l_resp_fw_msg->generic_msg.__req,
+ l_resp_fw_msg->generic_msg.__onlyError,
+ l_resp_fw_msg->generic_msg.data,
+ l_resp_fw_msg->generic_msg.data >> 32,
+ 0x0000FFFF & l_resp_fw_msg->generic_msg.data,
retVal);
}
else
@@ -864,7 +922,4 @@ uint64_t RuntimeLoaderTest::cv_hb_data_addr = 0;
uint64_t RuntimeLoaderTest::cv_comm_addr = 0;
uint64_t RuntimeLoaderTest::cv_comm_phys_addr = 0;
-
-
-
#endif
diff --git a/src/usr/util/runtime/makefile b/src/usr/util/runtime/makefile
index 1ad51cf82..089ca750e 100644
--- a/src/usr/util/runtime/makefile
+++ b/src/usr/util/runtime/makefile
@@ -44,6 +44,7 @@ OBJS += util_rt.o
OBJS += utilrsvdmem.o
OBJS += utilxipimage.o
OBJS += utilcommonattr.o
+OBJS += rt_fwnotify.o
SUBDIRS += test.d
diff --git a/src/usr/util/runtime/rt_fwnotify.C b/src/usr/util/runtime/rt_fwnotify.C
new file mode 100644
index 000000000..939270c3c
--- /dev/null
+++ b/src/usr/util/runtime/rt_fwnotify.C
@@ -0,0 +1,354 @@
+/* IBM_PROLOG_BEGIN_TAG */
+/* This is an automatically generated prolog. */
+/* */
+/* $Source: src/usr/util/runtime/rt_fwnotify.C $ */
+/* */
+/* OpenPOWER HostBoot Project */
+/* */
+/* Contributors Listed Below - COPYRIGHT 2016,2017 */
+/* [+] International Business Machines Corp. */
+/* */
+/* */
+/* Licensed under the Apache License, Version 2.0 (the "License"); */
+/* you may not use this file except in compliance with the License. */
+/* You may obtain a copy of the License at */
+/* */
+/* http://www.apache.org/licenses/LICENSE-2.0 */
+/* */
+/* Unless required by applicable law or agreed to in writing, software */
+/* distributed under the License is distributed on an "AS IS" BASIS, */
+/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
+/* implied. See the License for the specific language governing */
+/* permissions and limitations under the License. */
+/* */
+/* IBM_PROLOG_END_TAG */
+
+//#include <sbeio/sbe_retry_handler.H> // SbeRetryHandler
+#include <runtime/interface.h> // firmware_notify
+#include <runtime/runtime_reasoncodes.H> // MOD_RT_FIRMWARE_NOTIFY, etc
+#include <errl/errlentry.H> // ErrlEntry
+#include <errl/errlmanager.H> // errlCommit
+#include <targeting/common/target.H> // TargetHandle_t, getTargetFromHuid
+
+using namespace TARGETING;
+using namespace RUNTIME;
+using namespace ERRORLOG;
+using namespace MBOX;
+//using namespace SBEIO;
+
+trace_desc_t* g_trac_hwsv = nullptr;
+TRAC_INIT(&g_trac_hwsv, "HWSV_TRACE", 4*KILOBYTE);
+
+/**
+ * @brief The lower and upper bounds for the sequence ID.
+ **/
+const uint16_t GFMM_SEQ_ID_MIN = 0x0000;
+const uint16_t GFMM_SEQ_ID_MAX = 0x7FFF;
+
+/**
+ * @brief Set the sequence ID to the minimum value
+ **/
+uint16_t SeqId_t::GFMM_SEQ_ID = GFMM_SEQ_ID_MIN;
+
+/**
+ * @brief Gets the next sequence ID.
+ * @return The next sequence ID value within it's lower and upper bound
+ **/
+uint16_t SeqId_t::getNextSeqId()
+{
+ if (SeqId_t::GFMM_SEQ_ID < GFMM_SEQ_ID_MAX)
+ {
+ ++SeqId_t::GFMM_SEQ_ID;
+ }
+ else
+ {
+ SeqId_t::GFMM_SEQ_ID = GFMM_SEQ_ID_MIN;
+ }
+
+ return SeqId_t::GFMM_SEQ_ID;
+}
+
+/**
+ * @brief Gets the current value of the sequence ID.
+ * @return The current value of the sequence ID.
+ **/
+uint16_t SeqId_t::getCurrentSeqId()
+{
+ return SeqId_t::GFMM_SEQ_ID;
+}
+
+/**
+ * @brief Attempt an SBE recovery after an SBE error
+ * @param[in] uint64_t i_data Contains and plid (in the first 4 bytes)
+ * and a HUID (in the last 4 bytes)
+ * @platform FSP, OpenPOWER
+ **/
+void sbeAttemptRecovery(uint64_t i_data)
+{
+ errlHndl_t l_err = nullptr;
+
+ do
+ {
+ // Create a useful structure to get to the data
+ // The data is expected to be a plid (in the first 4 bytes)
+ // followed by a HUID (in the last 4 bytes).
+ struct sbeErrorData_t
+ {
+ uint32_t plid;
+ uint32_t huid;
+ } PACKED ;
+
+ sbeErrorData_t *l_sbeErrorDataReq = (sbeErrorData_t*)(&i_data);
+ TargetHandle_t l_target =
+ Target::getTargetFromHuid(l_sbeErrorDataReq->huid);
+ if (nullptr == l_target)
+ {
+ TRACFCOMP( g_trac_hwsv, "firmware_notify: No target assoicated "
+ "with HUID:0x%.8X", l_sbeErrorDataReq->huid);
+ /*@
+ * @errortype ERRL_SEV_PREDICTIVE
+ * @moduleid RUNTIME::MOD_RT_FIRMWARE_NOTIFY
+ * @reasoncode RUNTIME::RC_SBE_RT_INVALID_HUID
+ * @userdata1 HUID of target
+ * @userdata2 HWSV error log id (plid)
+ * @devdesc SBE error recovery attempt failed
+ */
+ l_err = new ErrlEntry( ERRL_SEV_PREDICTIVE,
+ MOD_RT_FIRMWARE_NOTIFY,
+ RC_SBE_RT_INVALID_HUID,
+ l_sbeErrorDataReq->huid,
+ l_sbeErrorDataReq->plid,
+ true);
+ break;
+ }
+
+ // Make the call to SbeExtractDD to attempt SBE recovery
+ // Get the SBE Retry Handler
+ //SbeRetryHandler l_SBEobj = SbeRetryHandler();
+
+ // Need to set the Plid from SbeRetryHandler (still being debated)
+ // to l_sbeErrorDataReq->plid;
+
+ // Retry the recovery of the SBE
+ //l_SBEobj.main_sbe_handler(l_target, false);
+
+ // Get the recovery results
+ // NOTE: This method is not in place yet
+ //bool l_recoverySuccessful = l_SBEobj.isSbeRestarted();
+
+ // Set to TRUE for now
+ bool l_recoverySuccessful = true;
+
+ if (nullptr == g_hostInterfaces ||
+ nullptr == g_hostInterfaces->firmware_request)
+ {
+ TRACFCOMP( g_trac_hwsv, "firmware_notify: Hypervisor "
+ "firmware_request interface not linked");
+
+ /*@
+ * @errortype ERRL_SEV_PREDICTIVE
+ * @moduleid RUNTIME::MOD_RT_FIRMWARE_NOTIFY
+ * @reasoncode RUNTIME::RC_FW_REQUEST_RT_NULL_PTR
+ * @userdata1 HUID of target
+ * @userdata2 HWSV error log id (plid)
+ * @devdesc SBE error recovery attempt failed
+ */
+ l_err = new ErrlEntry( ERRL_SEV_PREDICTIVE,
+ MOD_RT_FIRMWARE_NOTIFY,
+ RC_FW_REQUEST_RT_NULL_PTR,
+ l_sbeErrorDataReq->huid,
+ l_sbeErrorDataReq->plid,
+ true);
+
+
+ break;
+ }
+
+ // Create the firmware_request request structure to send data
+ hostInterfaces::hbrt_fw_msg l_req_fw_msg;
+ memset(&l_req_fw_msg, 0, sizeof(l_req_fw_msg));
+
+ // Set the data for the request
+ l_req_fw_msg.io_type = hostInterfaces::HBRT_FW_MSG_HBRT_FSP_REQ;
+ l_req_fw_msg.generic_msg.initialize();
+ l_req_fw_msg.generic_msg.msgq = GFMM_MSG_SBE_ERROR;
+ l_req_fw_msg.generic_msg.__req = GFMM_REQUEST;
+ l_req_fw_msg.generic_msg.__onlyError = GFMM_NOT_ERROR_ONLY;
+ l_req_fw_msg.generic_msg.data = i_data;
+
+ if (l_recoverySuccessful)
+ {
+ l_req_fw_msg.generic_msg.msgType= GFMM_MSG_SBE_RECOVERY_SUCCESS;
+ }
+ else
+ {
+ l_req_fw_msg.generic_msg.msgType = GFMM_MSG_SBE_RECOVERY_FAILED;
+ }
+
+ // Create the firmware_request response structure to receive data
+ hostInterfaces::hbrt_fw_msg l_resp_fw_msg;
+ size_t l_resp_fw_msg_size = sizeof(l_resp_fw_msg);
+ memset(&l_resp_fw_msg, 0, l_resp_fw_msg_size);
+
+ size_t rc = g_hostInterfaces->firmware_request(sizeof(l_req_fw_msg),
+ &l_req_fw_msg,
+ &l_resp_fw_msg_size,
+ &l_resp_fw_msg);
+
+ // Error log id
+ uint32_t l_errPlid(0);
+
+ sbeErrorData_t *l_sbeErrorDataResp =
+ (sbeErrorData_t*)&(l_resp_fw_msg.generic_msg.data);
+
+ // Capture the error log ID if any
+ // The return code (rc) may return OK, but there still may be an issue
+ // with the HWSV code on the FSP.
+ if ((hostInterfaces::HBRT_FW_MSG_HBRT_FSP_RESP
+ == l_resp_fw_msg.io_type) &&
+ (0 != l_sbeErrorDataResp->plid) )
+ {
+ l_errPlid = l_sbeErrorDataResp->plid;
+ }
+
+ // Gather up the error data and create an error log out of it
+ if (rc || l_errPlid)
+ {
+ /*@
+ * @errortype ERRL_SEV_PREDICTIVE
+ * @moduleid RUNTIME::MOD_RT_FIRMWARE_NOTIFY
+ * @reasoncode RUNTIME::RC_SBE_RT_RECOVERY_ERR
+ * @userdata1[0:31] Firmware Request return code
+ * @userdata1[32:63] HWSV error log id (plid)
+ * @userdata2[0:31] MBOX message type
+ * @userdata2[32:63] Message Tyepe
+ * @devdesc SBE error recovery attempt failed
+ */
+ l_err = new ERRORLOG::ErrlEntry(
+ ERRL_SEV_PREDICTIVE,
+ MOD_RT_FIRMWARE_NOTIFY,
+ RC_SBE_RT_RECOVERY_ERR,
+ TWO_UINT32_TO_UINT64(rc, l_errPlid),
+ TWO_UINT32_TO_UINT64(
+ l_resp_fw_msg.generic_msg.msgq,
+ l_resp_fw_msg.generic_msg.msgType),
+ true);
+
+ l_err->addFFDC( RUNTIME_COMP_ID,
+ &l_resp_fw_msg,
+ l_resp_fw_msg_size,
+ 0, 0, false );
+
+ if (sizeof(l_req_fw_msg) > 0)
+ {
+ l_err->addFFDC( RUNTIME_COMP_ID,
+ &l_req_fw_msg,
+ sizeof(l_req_fw_msg),
+ 0, 0, false );
+ }
+
+ l_err->collectTrace( "SBE", 256);
+
+ if (l_errPlid)
+ {
+ l_err->plid(l_errPlid);
+ }
+
+ break;
+ }
+ } while(0);
+
+ if (l_err)
+ {
+ //Commit the error if it exists
+ errlCommit(l_err, RUNTIME_COMP_ID);
+ }
+}
+
+/**
+ * @brief Receive an async notification from firmware
+ * @param[in] i_len length of notification data
+ * @param[in] i_data notification data
+ * @platform FSP, OpenPOWER
+ */
+void firmware_notify( uint64_t i_len, void *i_data )
+{
+ errlHndl_t l_err = nullptr;
+
+ do
+ {
+ // make sure the length of the data is not less than the
+ // structure we are expecting to receive
+ if (i_len < sizeof(GenericFspMboxMessage_t))
+ {
+ TRACFCOMP( g_trac_hwsv,
+ "firmware_notify: Received a non GenericFspMboxMessage "
+ "data stream" );
+
+ /*@
+ * @errortype
+ * @moduleid RUNTIME::MOD_RT_FIRMWARE_NOTIFY
+ * @reasoncode RUNTIME::RC_FW_NOTIFY_RT_INVALID_MSG
+ * @userdata1 Unused
+ * @userdata2 Unused
+ * @devdesc Error with Firmware Notify request
+ */
+ l_err = new ErrlEntry( ERRL_SEV_PREDICTIVE,
+ MOD_RT_FIRMWARE_NOTIFY,
+ RC_FW_NOTIFY_RT_INVALID_MSG,
+ 0, 0, true);
+ break;
+ }
+
+ // Cast the data to the structure we wish to parse
+ GenericFspMboxMessage_t* genericMsg =
+ static_cast<GenericFspMboxMessage_t*>(i_data);
+
+ // Do function based on message type (msgType)
+ switch(genericMsg->msgType)
+ {
+ case GFMM_MSG_SBE_ERROR: sbeAttemptRecovery(genericMsg->data);
+ break;
+
+ default:
+ {
+ TRACFCOMP( g_trac_hwsv, "firmware_notify: Unknown "
+ "message type:0x%.8X, message queue id:0x%.8X ",
+ genericMsg->msgq, genericMsg->msgType);
+
+ /*@
+ * @errortype
+ * @moduleid RUNTIME::MOD_RT_FIRMWARE_NOTIFY
+ * @reasoncode RUNTIME::RC_FW_NOTIFY_RT_INVALID_MSG_TYPE
+ * @userdata1 Message Queue ID
+ * @userdata2 Message Type
+ * @devdesc Error with Firmware Notify request
+ */
+ l_err = new ErrlEntry( ERRL_SEV_PREDICTIVE,
+ MOD_RT_FIRMWARE_NOTIFY,
+ RC_FW_NOTIFY_RT_INVALID_MSG_TYPE,
+ genericMsg->msgq,
+ genericMsg->msgType,
+ true);
+ }
+ break;
+ };
+
+ } while(0);
+
+ if (l_err)
+ {
+ //Commit the error if it exists
+ errlCommit(l_err, RUNTIME_COMP_ID);
+ }
+};
+
+struct registerFwNotify
+{
+ registerFwNotify()
+ {
+ getRuntimeInterfaces()->firmware_notify = &firmware_notify;
+ }
+};
+
+registerFwNotify g_registerFwNotify;
diff --git a/src/usr/vpd/runtime/rt_vpd.C b/src/usr/vpd/runtime/rt_vpd.C
index d23fc969d..d85440e56 100644
--- a/src/usr/vpd/runtime/rt_vpd.C
+++ b/src/usr/vpd/runtime/rt_vpd.C
@@ -419,9 +419,12 @@ errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
}
// Get an accurate size of memory actually needed to transport the data
+ size_t l_generic_msg_size =
+ sizeof(hostInterfaces::hbrt_fw_msg::generic_msg) +
+ i_numBytes -
+ sizeof(hostInterfaces::hbrt_fw_msg::generic_msg.data);
size_t l_req_fw_msg_size = hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
- sizeof(hostInterfaces::hbrt_fw_msg::generic_message) +
- i_numBytes;
+ l_generic_msg_size;
//create the firmware_request structure to carry the vpd write msg data
l_req_fw_msg =
@@ -429,10 +432,14 @@ errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
memset(l_req_fw_msg, 0, l_req_fw_msg_size);
// populate the firmware_request structure with given data
- l_req_fw_msg->io_type = hostInterfaces::HBRT_FW_MSG_HBRT_FSP;
- l_req_fw_msg->generic_message.msgq = MBOX::FSP_VPD_MSGQ;
- l_req_fw_msg->generic_message.msgType = i_type;
- memcpy(&l_req_fw_msg->generic_message.data, i_data, i_numBytes);
+ l_req_fw_msg->io_type = hostInterfaces::HBRT_FW_MSG_HBRT_FSP_REQ;
+ l_req_fw_msg->generic_msg.initialize();
+ l_req_fw_msg->generic_msg.dataSize = l_generic_msg_size;
+ l_req_fw_msg->generic_msg.msgq = MBOX::FSP_VPD_MSGQ;
+ l_req_fw_msg->generic_msg.msgType = i_type;
+ l_req_fw_msg->generic_msg.__req = GFMM_REQUEST;
+ l_req_fw_msg->generic_msg.__onlyError = GFMM_NOT_ERROR_ONLY;
+ memcpy(&l_req_fw_msg->generic_msg.data, i_data, i_numBytes);
// set up the response struct, note that for messages to the FSP
// the response size must match the request size
@@ -447,7 +454,7 @@ errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
TRACFBIN( g_trac_vpd, INFO_MRK"Sending firmware_request",
l_req_fw_msg,
hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
- sizeof(hostInterfaces::hbrt_fw_msg::generic_message) );
+ sizeof(hostInterfaces::hbrt_fw_msg::generic_msg) );
size_t rc = g_hostInterfaces->firmware_request(l_req_fw_msg_size,
l_req_fw_msg,
&l_resp_fw_msg_size,
@@ -457,13 +464,15 @@ errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
// Capture the err log id if any
// The return code (rc) may return OK, but there still may be an issue
// with the HWSV code on the FSP.
- if ((l_resp_fw_msg_size >= (hostInterfaces::HBRT_FW_MSG_BASE_SIZE +
- sizeof(l_resp_fw_msg->generic_message_resp))) &&
- (hostInterfaces::HBRT_FW_MSG_HBRT_FSP_RESP
- == l_resp_fw_msg->io_type) &&
- (0 != l_resp_fw_msg->generic_message_resp.errPlid) )
+ // Only checking for a PLID regardless of what the flag __onlyError is
+ // set to. I am not expecting any extra data and not sure what to do
+ // with it if I get it.
+ if ( (hostInterfaces::HBRT_FW_MSG_HBRT_FSP_RESP ==
+ l_resp_fw_msg->io_type) &&
+ (0 != l_resp_fw_msg->generic_msg.data >> 32) )
{
- l_userData2 = l_resp_fw_msg->generic_message_resp.errPlid;
+ // extract the plid from the first 32 bits
+ l_userData2 = l_resp_fw_msg->generic_msg.data >> 32;
}
// gather up the error data and create an err log out of it
@@ -471,10 +480,11 @@ errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
{
TRACFCOMP(g_trac_vpd,
ERR_MRK"firmware request: "
- "firmware request for FSP VPD write message rc 0x%X, "
- "target 0x%llX, VPD type %.8X, record %d, offset 0x%X",
- rc, get_huid(i_target), i_type, i_record.rec_num,
- i_record.offset );
+ "firmware request for FSP VPD write message rc: 0x%X, "
+ "HUID:0x%llX, plid:%.8X, VPD type:%.8X, "
+ "record:%d, offset:0x%X, ",
+ rc, get_huid(i_target), l_userData2,
+ i_type, i_record.rec_num, i_record.offset );
/*@
* @errortype
OpenPOWER on IntegriCloud