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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/ocmb/common/procedures/hwp/pmic/lib/i2c/i2c_pmic.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 */
///
/// @file pmic_i2c.H
/// @brief PMIC I2C utility function declarations
///
// *HWP HWP Owner: Mark Pizzutillo <Mark.Pizzutillo@ibm.com>
// *HWP HWP Backup: Andre A. Marin <aamarin@us.ibm.com>
// *HWP Team: Memory
// *HWP Level: 1
// *HWP Consumed by: HB:FSP
#ifndef _MSS_I2C_PMIC_H_
#define _MSS_I2C_PMIC_H_
#include <fapi2.H>
#include <i2c_access.H>
#include <vector>
#include <lib/utils/pmic_consts.H>
#include <generic/memory/lib/utils/pos.H>
#include <generic/memory/lib/utils/c_str.H>
namespace mss
{
namespace pmic
{
namespace i2c
{
///
/// @brief Perform a register write operation on the given PMIC chip
/// @param[in] i_target the PMIC target
/// @param[in] i_addr address to write to
/// @param[in] i_data_buffer buffer of data to write to the register
/// @return FAPI2_RC_SUCCESS iff okay
///
inline fapi2::ReturnCode reg_write(const fapi2::Target<fapi2::TARGET_TYPE_PMIC>& i_target,
const uint8_t i_addr,
const fapi2::buffer<uint8_t>& i_data_buffer)
{
std::vector<uint8_t> l_command;
l_command.push_back(i_addr);
l_command.push_back(uint8_t(i_data_buffer));
// Use fapi2 putI2c interface to execute command
FAPI_TRY(fapi2::putI2c(i_target, l_command),
"putI2C returned error for WRITE operation to 0x%.8X on PMIC %s",
i_addr, mss::c_str(i_target));
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Perform a register read operation on the given PMIC chip
/// @param[in] i_target the PMIC target
/// @param[in] i_addr address to read
/// @param[out] o_data_buffer buffer of data we will write the contents of the register to
/// @return FAPI2_RC_SUCCESS iff okay
///
inline fapi2::ReturnCode reg_read(const fapi2::Target<fapi2::TARGET_TYPE_PMIC>& i_target,
const uint8_t i_addr,
fapi2::buffer<uint8_t>& o_data_buffer)
{
std::vector<uint8_t> l_data;
std::vector<uint8_t> l_command;
l_command.push_back(i_addr);
FAPI_TRY(fapi2::getI2c(i_target, mss::pmic::i2c::sizes::DATA_LENGTH, l_command, l_data),
"i2C read failed on %s for address 0x%8x", mss::c_str(i_target), i_addr);
// Flush o_data_buffer to avoid stale data
o_data_buffer.flush<0>();
FAPI_ASSERT( (l_data.size() == mss::pmic::i2c::sizes::DATA_LENGTH),
fapi2::I2C_PMIC_INVALID_READ_SIZE()
.set_TARGET(i_target)
.set_ADDRESS(i_addr)
.set_SIZE_REQUESTED(mss::pmic::i2c::sizes::DATA_LENGTH)
.set_SIZE_RETURNED(l_data.size()),
"PMIC I2C read returned vector size of %u. Expected %u",
l_data.size(), mss::pmic::i2c::sizes::DATA_LENGTH,
mss::c_str(i_target) );
o_data_buffer = l_data[0];
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Perform a register write operation after flipping the data buffer
/// @param[in] i_target the PMIC target
/// @param[in] i_addr address to write to
/// @param[in] i_data_buffer buffer of data to flip & write to the register
/// @return FAPI2_RC_SUCCESS iff okay
/// @note flips buffer from fapi2-style [0:7] to PMIC-style [7:0]
///
inline fapi2::ReturnCode reg_write_reverse_buffer(const fapi2::Target<fapi2::TARGET_TYPE_PMIC>& i_target,
const uint8_t i_addr,
const fapi2::buffer<uint8_t>& i_data_buffer)
{
// Copy as to not modify original referenced buffer
auto l_reg_buffer_copy = i_data_buffer;
l_reg_buffer_copy.reverse();
FAPI_TRY(mss::pmic::i2c::reg_write(i_target, i_addr, l_reg_buffer_copy));
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Perform a register read operation on the given PMIC chip, then flip the data buffer
/// @param[in] i_target the PMIC target
/// @param[in] i_addr address to read
/// @param[out] o_data_buffer buffer of data we will write the contents of the register to
/// @return FAPI2_RC_SUCCESS iff okay
/// @note flips buffer from PMIC-style [7:0], to fapi2-style [0:7]
///
inline fapi2::ReturnCode reg_read_reverse_buffer(const fapi2::Target<fapi2::TARGET_TYPE_PMIC>& i_target,
const uint8_t i_addr,
fapi2::buffer<uint8_t>& o_data_buffer)
{
FAPI_TRY(mss::pmic::i2c::reg_read(i_target, i_addr, o_data_buffer));
o_data_buffer.reverse();
fapi_try_exit:
return fapi2::current_err;
}
} // i2c
} // pmic
} // mss
#endif
|
