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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/errl/errlsrc.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* 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 ERRLSRC_H
#define ERRLSRC_H
/**
* @file errlsrc.H
*
* @brief Manage the data that make up the 'PS' section in an
* error log PEL. PS stands for Primary System Reference Code, or SRC.
* Part of that data management is the flattening of data into PEL.
*
*/
#include <errl/errlsctn.H>
#include <errl/errlsctnhdr.H>
namespace ERRORLOG
{
class ErrlSrc : public ErrlSctn
{
// ErrlEntry may access private elements of this class. Data items that
// you would expect to be part of ErrlEntry are actually instance data
// in this class.
friend class ErrlEntry;
friend class ErrlManager;
private:
enum constants
{
SLEN = 72, // section length w/o sizeof(ErrlSctnHdr)
SST = 1, // section type
VER = 1, // section version
SRCVER = 2, // SRC version (not section version)
WORDCOUNT = 9, // SRC word count
DECONFIG_BIT = 0x02000000, // deconfig bit (6) in word 5
GARD_BIT = 0x01000000, // gard bit (7) in word 5
ACK_BIT = 0x00200000, // ack bit (10) in word 5
};
/**
* @brief Constructor. Pass in items destined for the primary SRC
* section in the error log.
*
* @param[in] i_srcType SRC type
* @param[in] i_modId Module ID
* @param[in] i_reasonCode Reason code
* @param[in] i_user1 User data 1
* @param[in] i_user2 User data 2
*
*/
ErrlSrc( srcType_t i_srcType,
uint8_t i_modId,
uint16_t i_reasonCode,
uint64_t i_user1,
uint64_t i_user2 );
/** @brief Destructor. */
~ErrlSrc();
/**
* @brief Disable copy constructor and assignment operator.
*/
ErrlSrc(const ErrlSrc& i_right);
ErrlSrc& operator=(const ErrlSrc& i_right);
/**
* @brief Data export facility to flatten data to PEL.
* Exports the object into the 'PS' primary SRC PEL section.
*
* @param[out] o_pBuffer Pointer to buffer where flattened data will go.
* @param[in] i_cbBuffer Count of bytes in target buffer
*
*/
uint64_t flatten( void * o_pBuffer, const uint64_t i_cbBuffer );
/**
* @brief Data export size. Presently, Hostboot returns
* creates an 80-byte PS section: 72 bytes in the SRC
* and 8 bytes for the PEL section header. This is the
* amount of flat storage (in bytes) required to
* store the object.
*
* @return Size in bytes.
*
*/
uint64_t flatSize() const;
/**
* @brief Import data
* @param[in] i_buf, pointer to the flattened data
* @return number of bytes consumed
*/
uint64_t unflatten( const void * i_buf );
/**
* @brief return the failing subsystem id value
*
* @return Failing subsystem ID
*
*/
epubSubSystem_t getSubSys() const { return iv_ssid; };
/**
* @brief set the failing subsystem id value in the SRC object
*
*
*/
void setSubSys( epubSubSystem_t i_ssid ){ iv_ssid = i_ssid; };
/**
* Convert ascii hex digit to binary
* @param[in] c, the ascii hex digit
* @return the binary value 0-15
* @note return value is only valid if input is valid hex digit
* '0'-'9', 'A'-'F', 'a'='f'
*/
uint64_t aschex2bin(char c) const;
// Instance data
srcType_t iv_srcType : 8; // SRC type, the ?? in SRC ??xxxxxx
uint8_t iv_modId; // module ID
uint16_t iv_reasonCode; // reason code
epubSubSystem_t iv_ssid : 8 ; // subsystem type, the ?? in SRC xx??xxxx
uint64_t iv_user1; // user data 1
uint64_t iv_user2; // user data 2
bool iv_deconfig; // true if there is a deconfigure callout
bool iv_gard; // true if there is a gard callout
};
//**************************************************************************
// Hostboot PS SRC section generates minimal section with no additional
// words of data.
inline uint64_t ErrlSrc::flatSize() const
{
// 72 bytes in SRC structure + 8 byte section header.
CPPASSERT( 80 == sizeof( pelSRCSection_t ));
return sizeof( pelSRCSection_t );
}
} // namespace
#endif //ERRLSRC_H
|
