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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/i2c/eepromdd_hardware.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2019 */
/* [+] 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 __EEPROMDD_HARDWARE_H
#define __EEPROMDD_HARDWARE_H
/**
* @file eepromdd_hardware.H
*
* @brief Provides the interfaces for accessing EEPROMs within
* the system via the I2C device driver
*/
#include <i2c/eeprom_const.H>
#include <errl/errlentry.H>
namespace EEPROM
{
/**
*
* @brief Perform an EEPROM access operation on the actual hardware.
*
* @param[in] i_opType - Operation Type - See DeviceFW::OperationType in
* driververif.H
*
* @param[in] i_target - Target device associated w/ the EEPROM.
*
* @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/out] io_i2cInfo struct containing information needed to perform
* operation on the given i2c eeprom. NOTE It is expected that
* eepromRole and offset have been filled out in this struct
* prior to passing it into this function
*
* @pre It is expected that io_i2cInfo.eepromRole will have a valid role set
*
* @return errlHndl_t - nullptr if successful, otherwise a pointer to the
* error log.
*
*/
errlHndl_t eepromPerformOpHW(DeviceFW::OperationType i_opType,
TARGETING::Target * i_target,
void * io_buffer,
size_t & io_buflen,
eeprom_addr_t & io_i2cInfo) ;
/**
*
* @brief Perform operations to lock and unlock the page mutex
*
* @param[in] i_target - the target to lock the page for
* @param[in] i_switchPage - bool to tell the function whether we are
* trying to switch pages/locking vs unlocking the page
* @param[in] i_lockMutex - bool to inform call chain whether we want
* to actually lock the page mutex or not. When false,
* the function assumes the appropriate mutex has already
* been locked and skips the call to mutex_lock
* @param[in/out] i_pageLocked - bool to tell the caller if the page
* was successfully locked.
* @param[in] i_desiredPage - The page we want to switch to
* @param[in] i_i2cInfo - 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 eepromPageOp( TARGETING::Target * i_target,
bool i_switchPage,
bool i_lockMutex,
bool & io_pageLocked,
uint8_t i_desiredPage,
const eeprom_addr_t & i_i2cInfo );
/**
* @brief This utility function determines if a read/write straddles
* the boundary between EEPROM pages and if so, returns the
* parameters to perform 2 operations, one for each page.
*
* @param[in] i_originalOffset - The requested read/write offset into
* the EEPROM.
* @param[in] i_originalLen - The requested length of the data.
* @param[in/out] io_newLen - The length of the data to retrieve
* @param[out] o_pageTwoBuflen - The length of data requested that
* crossed over into the second EEPROM page.
* @param[in] i_i2cInfo - Structure of I2C parameters needed to determine
* if we run the body of this function.
* @return bool - True if the requested data straddles the EEPROM page
* boundary, False otherwise. If False, io_newLen == i_originalLen.
*/
bool crossesEepromPageBoundary( uint64_t i_originalOffset,
size_t i_originalLen,
size_t & io_newLen,
size_t & o_pageTwoBuflen,
const eeprom_addr_t & i_i2cInfo );
/**
* @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 actually performs the i2c operations to read data from
* the EEPROM
*
* @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 read from the EEPROM device
*
* @param[in] i_byteAddress - the offset into the EEPROM device
*
* @param[in] i_byteAddressSize - the size of the byte address (1 or 2 bytes)
*
* @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 eepromReadData( TARGETING::Target * i_target,
void * o_buffer,
size_t i_buflen,
void * i_byteAddress,
size_t i_byteAddressSize,
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 actually writes data into the devices EEPROM
*
* @param[in] i_target - Target device.
* @param[in] i_dataToWrite - The data to be written into the device.
* @param[in] i_dataLen - The length of the data to be written.
* @param[in] i_byteAddress - the offset into the devices EEPROM.
* @param[in] i_byteAddressSize - the size of byte address varable.
* @param[in] i_i2cInfo - Structure of I2C parameters needed to execute
* the command to the I2C device driver.
*/
errlHndl_t eepromWriteData( TARGETING::Target * i_target,
void * i_dataToWrite,
size_t i_dataLen,
void * i_byteAddress,
size_t i_byteAddressSize,
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] i_target - the target to prepare the addressing for.
*
* @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[out] o_desiredPage - The page we want to switch to.
*
* @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 ( TARGETING::Target * i_target,
void * io_buffer,
size_t & o_bufSize,
uint8_t & o_desiredPage,
const eeprom_addr_t & i_i2cInfo);
}
#endif
|
