1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/runtime/runtime.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,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 */
#ifndef __RUNTIME_H
#define __RUNTIME_H
#include <stdint.h>
#include <builtins.h>
#include <errl/errlentry.H>
namespace RUNTIME
{
/**
* @brief Populate attributes in mainstore for HostServices
*
* @return errlHndl_t NULL on success
*/
errlHndl_t populate_attributes( void );
/**
* @brief Populate node attributes in mainstore for HostServices
*
* @return errlHndl_t NULL on Success
*/
errlHndl_t populate_node_attributes( uint64_t i_nodeNum );
/**
* @brief Add the host data mainstore location to VMM
*
* @description If running with the standard PHYP payload this function
* will map all supported HDAT sections into the VMM to allow access
* from user space. When running in standalone (no payload) mode,
* some reserved memory will be mapped in for testcases. If AVPs are
* enabled, no memory will be mapped and the PAYLOAD_KIND attribute
* will be set appropriately.
*
* @return errlHndl_t NULL on success
*/
errlHndl_t load_host_data( void );
/**
* @brief Populate HB runtime data in mainstore
*
* @return errlHndl_t NULL on Success
*/
errlHndl_t populate_hbRuntimeData( void );
/**
* @brief Populate HB secureboot data in mainstore
*
* @description Populates the System Parameters section of HDAT with
* values acquired via the secureboot module from a verified source, and
* so, henceforth are available to the host at runtime.
*
* @return errlHndl_t NULL on Success
*/
errlHndl_t populate_hbSecurebootData( void );
/**
* @brief Fills in HBRT for given NODE
*
* @param[in] iNodeId : Node number from 0 to 7 ..etc...
*
* @return errlHndl_t NULL on Success
*/
errlHndl_t populate_RtDataByNode(uint64_t iNodeId);
// How many pointers/sections there are in HB runtime data
#define HBRT_NUM_PTRS 2
// Sections defined by above literal
#define HBRT_VPD_SECTION 0
#define HBRT_ATTRIB_SECTION 1
// How many pointers/sections there are in HB reserved memory data
// HOMER*8/OCC_Common/VPD/ATTR/HBRT_Image/Res/Res/Res
#define HB_RSV_MEM_NUM_PTRS 15
// Range types for HB reserved memory
#define RANGE_TYPE_PRIMARY 0
#define RANGE_TYPE_HBRT 1
#define RANGE_TYPE_VERIFIED_LIDS 2
#define RANGE_TYPE_TPM_LOG 3
#define RANGE_TYPE_HOMER_OCC 4
//Note this means the Reserved Mem sub-section is the 6th
//(0 based) of the MDT section (See HDAT spec)
#define MDT_RESERVED_HB_MEM_SECTION 5
/**
* HDAT Sections
*/
enum SectionId
{
FIRST_SECTION, //< Placeholder for arrays
HSVC_NODE_DATA = FIRST_SECTION, //< HostServices Node Attributes
HSVC_SYSTEM_DATA, //< HostServices System Attributes
IPLPARMS_SYSTEM, //< IPL Parms
MS_DUMP_SRC_TBL, //< MDST: Memory Dump Source Table
MS_DUMP_DST_TBL, //< MDDT: Memory Dump Destination Table
MS_DUMP_RESULTS_TBL, //< MDRT: Memory Dump Results Table
SPIRA_S, //< SPIRA-S
SPIRA_H, //< SPIRA-H
SPIRA_L, //< Legacy SPIRA
NACA, //< NACA
HBRT, //< Hostboot Runtime
HBRT_DATA, //< Hostboot Runtime Data
RESERVED_MEM, //< Hostboot's Reserved Mainstore Memory
LAST_SECTION = RESERVED_MEM //< Placeholder for arrays
};
/**
* @brief Get a pointer to the beginning of a particular section of
* the host data memory.
*
* @description The returned pointer will not include any header hdat header
* information.
*
* @param[in] i_section Chunk of data to find
* @param[in] i_instance Instance of section when there are multiple entries
* @param[out] o_dataAddr Physical memory address of data
* @param[out] o_dataSize Size of data in bytes, 0 on error, DATA_SIZE_UNKNOWN if unknown
*
* @return errlHndl_t NULL on success
*/
errlHndl_t get_host_data_section( SectionId i_section,
uint64_t i_instance,
uint64_t& o_dataAddr,
size_t& o_dataSize );
const size_t DATA_SIZE_UNKNOWN = 0xFFFFFFFFFFFFFFFF;
/**
* @brief Store the actual count of a section in local memory.
*
* @param[in] i_section Chunk of data to update
* @param[in] i_count Actual number of entries
*
*/
void saveActualCount( RUNTIME::SectionId i_id,
uint16_t i_count );
/**
* @brief Write the stored actual count to SPIRA
*
* @param[in] i_section Chunk of data to update
*
* @return errlHndl_t NULL on success
*/
errlHndl_t writeActualCount( RUNTIME::SectionId i_id );
/**
* @brief Retrieve and log FFDC data relevant to a given section of
* host data memory
*
* @param[in] i_section Relevant section
* @param[inout] io_errlog Log to append FFDC to
*
* @return errlHndl_t NULL on success
*/
void add_host_data_ffdc( SectionId i_section,
errlHndl_t& io_errlog );
/**
* @brief Set the PAYLOAD_BASE attribute
* @param[in] i_payloadAddress in MEGABYTES
*/
void setPayloadBaseAddress(uint64_t i_payloadAddress);
/**
* @brief Clear out any cached data and rediscover the location
* of the HDAT memory
*/
void rediscover_hdat( void );
}
#endif
|
