summaryrefslogtreecommitdiffstats
path: root/src/usr/runtime/hdatstructs.H
diff options
context:
space:
mode:
authorChristian Geddes <crgeddes@us.ibm.com>2017-12-13 19:49:24 -0600
committerWilliam G. Hoffa <wghoffa@us.ibm.com>2017-12-21 14:04:31 -0500
commitaedc6f0a892ea06344af32293d8d2f5d8b248369 (patch)
tree9649aac83287f4a4b9cee50ef632ab11cc723041 /src/usr/runtime/hdatstructs.H
parent779a1c3444a348e7eccbf587ded6041cc3bbd13d (diff)
downloadtalos-hostboot-aedc6f0a892ea06344af32293d8d2f5d8b248369.tar.gz
talos-hostboot-aedc6f0a892ea06344af32293d8d2f5d8b248369.zip
Add comments for hb/hypervisor communication struct and remove TODO
Add comments from a previous review and also removed TODOs now that hdat code is in backing build Change-Id: Ibf561fdfd7a61b66611a065d77a73fc81dd4e7e7 RTC: 180959 Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/50907 Reviewed-by: Martin Gloff <mgloff@us.ibm.com> Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com> Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com> Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com> Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com> Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com> Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>
Diffstat (limited to 'src/usr/runtime/hdatstructs.H')
-rw-r--r--src/usr/runtime/hdatstructs.H12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/usr/runtime/hdatstructs.H b/src/usr/runtime/hdatstructs.H
index 41cbd1b19..78c057fde 100644
--- a/src/usr/runtime/hdatstructs.H
+++ b/src/usr/runtime/hdatstructs.H
@@ -394,14 +394,24 @@ const uint64_t HYPECOMM_MAGIC_NUM = 0x48595045434f4d4d;
// (offset to start of data in hbHypCommArea_t struct)
const uint8_t HYPCOMM_STRUCT_HRMOR_OFFSET = 24;
+
+//Note when adding data to this make sure to add at the bottom
+//and keep this struct 8 byte aligned
+// We never want to change the format of the first 24 bytes of this struct
struct hbHypCommArea_t
{
uint64_t magicNum; // 8 bytes 0x48595045434f4d4d = HYPECOMM
size_t size; // 8 bytes
- uint32_t version; // 4 bytes
+ uint32_t version; // 4 bytes keep track of version so we can set the size correctly
uint8_t padding[4]; // 4 bytes put padding in so hrmor is 8 byte aligned
//Start Data // 0x18 or 24 byte offset to data
+ //
+ //The space allocated for HRMOR address can be written to by the hypervisor
+ //in the event that the hypervisor changes its hrmor. This will allow
+ //hostboot to know where to load the payload on MPIPL.
uint64_t hrmorAddress; // 8 bytes
+
+ //Total = 32 bytes
hbHypCommArea_t(): magicNum(HYPECOMM_MAGIC_NUM), size(HB_HYP_COMM_STRUCT_SIZES[STRUCT_VERSION_LATEST]),
version(STRUCT_VERSION_LATEST), padding{0,0,0,0}, hrmorAddress(0)
{
OpenPOWER on IntegriCloud