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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/sbe/sbeif.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2013,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 _SBEIF_H
#define _SBEIF_H
#include <errl/errlentry.H>
#include <pnor/pnorif.H>
namespace SBE
{
// Each SBE Image stored in PNOR has a 64-byte version associated with it
// (like a SHA hash of the image)
const size_t SBE_IMAGE_VERSION_SIZE = 64; // 64 bytes
typedef uint8_t sbe_image_version_t[SBE_IMAGE_VERSION_SIZE];
/**
* @brief Gets a pointer to the proper SBE image in PNOR
*
* @param[in] i_target Target used to find right SBE Image in PNOR
*
* @param[out] o_imgPtr Pointer to SBE Image mapped in PNOR
* Note: Pointer moved past any header(s)
*
* @param[out] o_imgSize Size of the SBE Image in PNOR
* Note: Size does not include any header(s)
*
* @param[out] o_version Pointer to SBE Image Version Struct
* If Pointer is NULL, version not returned;
* Else sbe_image_version_t is filled in
*
* @return errlHndl_t Error log handle on failure.
*/
errlHndl_t findSBEInPnor(TARGETING::Target* i_target,
void*& o_imgPtr,
size_t& o_imgSize,
sbe_image_version_t* o_version = NULL);
/**
* @brief Iterates through all the functional processors and updates
* the SBE Image in a SEEPROM, if necessary.
*
* @return errlHndl_t Error log handle on failure.
*/
errlHndl_t updateProcessorSbeSeeproms();
/**
* @brief Determines whether we are on the Golden side or not
*
* @param[out] o_isGolden boolean, True if we are on Golden side, False
* otherwise.
*
* @return errlHndl_t Error log handle on failure.
*
* NOTE: -Golden Side means we booted from the Golden Seeprom pointing
* at the Golden side of PNOR.
* -Using master processor to make this determination.
*/
errlHndl_t isGoldenSide( bool & o_isGolden );
/**
* @brief Determines if we booted in synchronous memory mode or not
*
* @param[out] o_mcSyncMode - The MC sync mode the system last booted with.
*
* @return errlHndl_t Error log handle on error.
*/
errlHndl_t getBootMcSyncMode( uint8_t& o_mcSyncMode );
/**
* @brief Sets the target processor to boot SBE from the side that is
* indicated by the SBE MVPD
*
* @param[in] i_target Target processor to update
*
* @return errlHndl_t Error log handle on failure.
*/
errlHndl_t updateSbeBootSeeprom(TARGETING::Target* i_target);
} //end namespace SBE
#endif /* _SBEIF_H */
|