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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/bootloader/bl_pnorAccess.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2018 */
/* [+] 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 __BL_PNORACCESS_H
#define __BL_PNORACCESS_H
#include <pnor_const.H>
#include <pnor_utils.H>
#include <ffs.h>
/** @file bl_pnorAccess.H
* @brief Provides interface to the PNOR flash for bootloader
*/
/**
* @brief bootloader PNOR access class
* Provide interfaces for the bootloader to look through pnor and find toc
*/
class bl_pnorAccess
{
friend class pnorutilsTest;
public:
/**
* @brief Get the hostboot base image
*
* @param[in] i_lpcBar MMIO address to base LPC space
*
* @param[out] o_hbbSection Struct that holds information about the
* Hostboot Base Image Section
*
* @param[out] o_errCode Anything besides PNOR:NO_ERROR is an error
*
* @param[out] o_pnorStart The MMIO address of the start of PNOR
*
* @return void
*/
static void getHBBSection(uint64_t i_lpcBar,
PNOR::SectionData_t& o_hbbSection,
uint32_t& o_errCode,
uint64_t& o_pnorStart);
private:
/**
* @brief Read in the toc and get information about each section
*
* @param[in] i_tocBuffer Buffer containing a single TOC
*
* @param[out] o_errCode Anything besides PNOR:NO_ERROR is an error
*
* @param[out] o_TOC Array of section data describing contents of pnor
*
* @param[out] o_pnorStart The MMIO address of the start of PNOR
*
* @param[out] i_pnorEnd The MMIO address of the end of PNOR
*
* @return void
*/
static void readTOC(uint8_t i_tocBuffer[PNOR::TOC_SIZE], uint32_t & o_errCode,
PNOR::SectionData_t * o_TOC, uint64_t& o_pnorStart,
uint64_t i_pnorEnd);
/**
* @brief Find a valid TOC within specified side of pnor flash
side is determined by the base mmio address passed in
*
* @param[in] i_lpcBar MMIO address to base LPC space
*
* @param[out] o_TOC Array of section data describing contents of pnor
*
* @param[out] o_errCode Anything besides PNOR:NO_ERROR is an error
*
* @param[out] o_pnorStart The MMIO address of the start of PNOR
*
* @return void
*/
static void findTOC(uint64_t i_lpcBar, PNOR::SectionData_t * o_TOC,
uint32_t& o_errCode, uint64_t& o_pnorStart);
};
#endif
|
