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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/vpd/vpd_if.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2013,2015 */
/* [+] 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 */
#if !defined(__VPD_IF_H)
#define __VPD_IF_H
namespace VPD
{
/**
* @brief typdef for vpdRecord values
*/
typedef uint32_t vpdRecord;
/**
* @brief typdef for vpdKeyword values
*/
typedef uint32_t vpdKeyword;
/**
* @brief typdef for vpdCmdTarget values
*/
enum vpdCmdTarget
{
AUTOSELECT,
PNOR,
SEEPROM,
INVALID_LOCATION = 0xFFFF,
};
/**
* @brief Load the runtime VPD image into memory
* @param[out] The physical address of the VPD image
* @return error handle if there was an error
*/
errlHndl_t vpd_load_rt_image(uint64_t & o_vpd_addr);
/**
* @brief This function checks to see if the given mvpd target
* is present
* @param[in] i_target - Target device to search for mvpd
* @return bool - true if mvpd is present, false if it is not.
*/
bool mvpdPresent ( TARGETING::Target * i_target );
/**
* @brief This function checks to see if the given cvpd target
* is present
* @param[in] i_target - Target device to search for cvpd
* @return bool - true if cvpd is present, false if it is not.
*/
bool cvpdPresent ( TARGETING::Target * i_target );
/**
* @brief This function sets the part and serial number attributes for
* a given target
* @param[in] i_target - the target to set the attributes for
*
*/
void setPartAndSerialNumberAttributes( TARGETING::Target * i_target );
/**
* @brief This function checks to see if the given pvpd target
* is present
* @param[in] i_target - Target device to search for pvpd
* @return bool - true if pvpd is present, false if it is not.
*/
bool pvpdPresent ( TARGETING::Target * i_target );
/**
* @brief This function checks if the PNOR cache for this target is in
* sync with the SEEPROM, if not it loads the PNOR cache from SEEPROM.
* @param[in] i_target - Target device
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t ensureCacheIsInSync ( TARGETING::Target * i_target );
/**
* @brief This function invalidates the VPD data in the PNOR cache.
* @param[in] i_target - Target device
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t invalidatePnorCache ( TARGETING::Target * i_target );
/**
* @brief This function invalidates all of the VPD data in the PNOR cache.
* @param[in] i_setHwOnly - Also set vars to not access VPD cache
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t invalidateAllPnorCaches ( bool i_setHwOnly );
}; //end vpd namespace
#endif
|
