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
|
/* IBM_PROLOG_BEGIN_TAG
* This is an automatically generated prolog.
*
* $Source: src/include/usr/spd/spdif.H $
*
* IBM CONFIDENTIAL
*
* COPYRIGHT International Business Machines Corp. 2012
*
* 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 other-
* wise divested of its trade secrets, irrespective of what has
* been deposited with the U.S. Copyright Office.
*
* Origin: 30
*
* IBM_PROLOG_END_TAG
*/
/**
* @file spdif.H
*
* @brief External SPD interfaces
*
*/
#ifndef __SPDIF_H
#define __SPDIF_H
// -----------------------------------------------
// Includes
// -----------------------------------------------
#include <pnor/pnorif.H>
namespace SPD
{
/**
* @brief This structure is used to transfer common information needed
* for reading the address from the PNOR RP.
*/
struct pnorInformation
{
uint64_t segmentSize;
uint64_t maxSegments;
PNOR::SectionId pnorSection;
PNOR::SideSelect pnorSide;
};
/**
* @brief This Function is used to query the PNOR RP and get the address of
* the data section. It is also used to then read from that address the
* number of bytes requested.
* NOTE: This function is defined here because it is used by both the SPD
* and MVPD code.
*
* @param[in] i_byteAddr - The offset into the section of the data to be read.
*
* @param[in] i_numBytes - The number of bytes to read.
*
* @param[out] o_data - The data buffer.
*
* @param[in] i_target - The target to read the data for.
*
* @param[in] i_pnorInfo - Data required to query for the PNOR data address.
*
* @param[in/out] io_cachedAddr - This is the address that is, or will be read
* from the PNOR RP and saved for future use.
*
* @param[in] i_mutex - Mutex from calling code to be used for setting
* io_isAddrCached and io_cachedAddr.
*
* @return errHndl_t - NULL if successful, otherwise a pointer to the error
* log.
*/
errlHndl_t readPNOR ( uint64_t i_byteAddr,
size_t i_numBytes,
void * o_data,
TARGETING::Target * i_target,
pnorInformation & i_pnorInfo,
uint64_t &io_cachedAddr,
mutex_t * i_mutex );
/**
* @brief This function will write the PNOR at the correct offset and number
* of bytes for the keyword requested.
*
* @param[in] i_byteAddr - The offset to access in the PNOR.
*
* @param[in] i_numBytes - The number of bytes to write.
*
* @param[in] i_data - The data buffer of the data to be written.
*
* @param[in] i_target - The chip target to access the data for.
*
* @param[in] i_pnorInfo - Information about the PNOR section and side that we
* need to know to make the request.
*
* @param[in/out] io_cachedAddr - The address offset to the data chunk in
* PNOR.
*
* @param[in] i_mutex - The mutex to lock/unlock while setting io_isAddrCached
* and io_cachedAddr. It is assumed that those parameters are global
* variables in the code where they reside.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the error
* log.
*/
errlHndl_t writePNOR ( uint64_t i_byteAddr,
size_t i_numBytes,
void * i_data,
TARGETING::Target * i_target,
pnorInformation & i_pnorInfo,
uint64_t &io_cachedAddr,
mutex_t * i_mutex );
}; // end SPD
#endif
|
