blob: e0bb80bf57c30c0c9039ff0fc278cbb5fa098724 (
plain)
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/targeting/common/util.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,2013 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __TARGETING_COMMON_UTIL_H
#define __TARGETING_COMMON_UTIL_H
/**
* @file targeting/common/util.H
*
* @brief Targeting utility functions
*/
#include <targeting/common/attributes.H>
namespace TARGETING
{
class Target;
/**
* @brief Macro which indicates whether to translate addresses or not
*
* @par Detailed Description:
* If PPC platform (FSP or Hostboot), if 8 byte pointers then it's
* Hostboot, so don't translate. If 4 byte pointers then it's FSP so
* translate. If !PPC (x86 32 or 64 bit), then always translate
*
* @note List of preprocessor macros defined can be determined by calling:
* ppc64-mcp6-gcc -dM -E - < /dev/null
*/
#ifdef __PPC__
#define TARG_ADDR_TRANSLATION_REQUIRED (sizeof(void*)==4)
#else
#define TARG_ADDR_TRANSLATION_REQUIRED (1)
#endif
/**
* @brief Checks to see if we are running in a hardware simulation
* environment, i.e. VPO/VBU (not Simics)
*
* @return true if in VPO/VBU
*/
bool is_vpo( void );
/**
* @brief Safely fetch the HUID of a Target
* @param[in] Pointer to a Target
* @return HUID of Target, Zero if NULL, 0xFFFFFFFF if Sentinel
*/
uint32_t get_huid( const Target* i_target );
/**
* @brief Set HWAS Changed Mask to subscription mask
* @param[in] Pointer to a Target
*/
void update_hwas_changed_mask(Target * i_target);
/**
* @brief Set HWAS Changed Mask to subscription mask
* @param[in] Pointer to a Target
* @param[in] bit to clear
*/
void clear_hwas_changed_bit(Target * i_target, const HWAS_CHANGED_BIT i_bit);
/**
* @brief Checks if we are loading a PHYP payload
* @description Looks at both ATTR_PAYLOAD_KIND and the MNFG flags
* to determine if we are really loading and starting PHYP
* @param[out] Current value of PAYLOAD_KIND
* @return True if PHYP will be loaded and started
*/
bool is_phyp_load( ATTR_PAYLOAD_KIND_type* o_type = NULL );
/**
* @brief Utility function to determine if Sapphire is the payload
*
* @description If the payload kind is Sapphire returns true. Does
* not matter if it is Sapphire with FSP or standalone
*
* @return bool True when loadding sapphire
*/
bool is_sapphire_load(void);
/**
* @brief Utility function to determine if an AVP is the payload
* Note the actual payload could be something else -- this
* is based solely on MFG flags
*
* @description If MFG AVP mode flags are set then returns true
* Does not matter what the actual payload is
*
* @return bool True when in AVP mode
*/
bool is_avp_load(void);
}
#endif // __TARGETING_COMMON_UTIL_H
|
