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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/i2c/eepromdd.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 __EEPROM_H
#define __EEPROM_H
/**
* @file eepromdd.H
*
* @brief Provides the interfaces for accessing EEPROMs within
* the system via the I2C device driver.
*/
// ----------------------------------------------
// Includes
// ----------------------------------------------
#include <i2c/eepromif.H>
#include <errl/errlentry.H>
namespace EEPROM
{
/**
* @brief Enumerations to describe the type of devices to be accessed.
*/
typedef enum
{
ZERO_BYTE_ADDR = 0,
ONE_BYTE_ADDR = 1,
TWO_BYTE_ADDR = 2,
LAST_DEVICE_TYPE
} eeprom_addr_size_t;
/**
* @brief Structure of common parameters needed by different parts of
* the code.
*/
typedef struct
{
uint64_t port;
uint64_t engine;
uint64_t devAddr;
int64_t chip;
uint64_t offset;
eeprom_addr_size_t addrSize;
TARGETING::EntityPath i2cMasterPath;
uint64_t writePageSize; // in bytes
uint64_t devSize_KB; // in kilobytes
uint64_t writeCycleTime; // in milliseconds
} eeprom_addr_t;
/**
*
* @brief Perform an EEPROM access operation.
*
* @param[in] i_opType - Operation Type - See DeviceFW::OperationType in
* driververif.H
*
* @param[in] i_target - Target device.
*
* @param[in/out] io_buffer
* INPUT: Pointer to the data that will be written to the target
* device.
* OUTPUT: Pointer to the data that was read from the target device.
*
* @param[in/out] io_buflen
* INPUT: Length of the buffer to be written to target device.
* OUTPUT: Length of buffer that was written, or length of buffer
* to be read from target device.
*
* @param [in] i_accessType - Access Type - See DeviceFW::AccessType in
* usrif.H
*
* @param [in] i_args - This is an argument list for the device driver
* framework. This argument list consists of the chip number of
* the EEPROM to access from the given I2C Master target and the
* internal offset to use on the slave I2C device.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*
*/
errlHndl_t eepromPerformOp( DeviceFW::OperationType i_opType,
TARGETING::Target * i_target,
void * io_buffer,
size_t & io_buflen,
int64_t i_accessType,
va_list i_args );
/**
* @brief This function peforms the sequencing to do a read of the
* EEPROM that is identified.
*
* @param[in] i_target - Target device.
*
* @param[out] o_buffer - The buffer that will return the data read
* from the EEPROM device.
*
* @param[in] i_buflen - Number of bytes to read from the EEPROM device.
*
* @param[in] i_i2cInfo - Structure of I2C parameters needed to execute
* the command to the I2C device driver.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t eepromRead ( TARGETING::Target * i_target,
void * o_buffer,
size_t i_buflen,
eeprom_addr_t i_i2cInfo );
/**
* @brief This function peforms the sequencing to do a write of the
* EEPROM that is identified.
*
* @param[in] i_target - Target device.
*
* @param[in] io_buffer - The buffer that contains the data to be written
* to the EEPROM device.
*
* @param[in/out] io_buflen
* INPUT: Length of the buffer to be written to target device.
* OUTPUT: Length of buffer that was written, or length of buffer
* to be read from target device.
*
* @param[in] i_i2cInfo - Structure of I2C parameters needed to execute
* the command to the I2C device driver.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t eepromWrite ( TARGETING::Target * i_target,
void * io_buffer,
size_t io_buflen,
eeprom_addr_t i_i2cInfo );
/**
* @brief This function prepares the I2C byte address for adding to the
* existing buffer (for Writes), or as a separate write operation
* (for Reads).
*
* @param[in/out] io_buffer - The buffer to be written as a byte address to
* the EEPROM device. Must be pre-allocated to MAX_BYTE_ADDR size.
*
* @param[out] o_bufSize - The size of the buffer to be written.
*
* @param[in] i_i2cInfo - Structure of I2C parameters needed to execute
* the command to the I2C device driver.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t eepromPrepareAddress ( void * io_buffer,
size_t & o_bufSize,
eeprom_addr_t i_i2cInfo );
/**
* @brief this function will read all of the associated attributes needed
* to access the intended EEPROM. These attributes will be used to
* determine the type of I2C device as well as how to address it via
* the I2C device driver.
*
* @param[in] i_target - Target device.
*
* @param[out] o_i2cInfo - The structure that will contain the attribute data
* read from the target device.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t eepromReadAttributes ( TARGETING::Target * i_target,
eeprom_addr_t & o_i2cInfo );
/**
* @brief This function decides whether or not the target passed into the
* EEPROM device driver actually contains the I2C Master engines. If
* not, it will then read the attribute of the target to get the path
* of the target which does contain the I2C Master engine.
*
* @param[in] i_target - The current Target.
*
* @param[in] i_i2cInfo - Structure of I2C parameters needed to execute
* the command to the I2C device driver.
*
* @param[out] o_target - The "new" target that will be used for all operations
* from this point on. It may be == to i_target, or a completely different
* target. BUT, this target will contain the I2C Master engine that will
* allow operations to the target EEPROM.
*
* @return errlHndl_t - NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t eepromGetI2CMasterTarget ( TARGETING::Target * i_target,
eeprom_addr_t i_i2cInfo,
TARGETING::Target * &o_target );
}; // end EEPROM namespace
#endif // __EEPROM_H
|
