summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAndre Marin <aamarin@us.ibm.com>2018-08-08 23:01:37 -0500
committerChristian R. Geddes <crgeddes@us.ibm.com>2018-09-04 10:45:00 -0500
commit84923368d03fcf5a7bd09f9a6aa1dc692d65db3e (patch)
tree04094216849da7dc44491891a1f6710aaade30e0 /src
parent9af02ab015acdf9abf73df357d50bee9703a2aad (diff)
downloadtalos-hostboot-84923368d03fcf5a7bd09f9a6aa1dc692d65db3e.tar.gz
talos-hostboot-84923368d03fcf5a7bd09f9a6aa1dc692d65db3e.zip
Fix i2c doxy and update i2c_access.H doxy to match fapi2_access_i2c.H
Change-Id: I9e6472737d21f125c688f2e4e805c7f474e072ae Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/64178 Tested-by: HWSV CI <hwsv-ci+hostboot@us.ibm.com> Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com> Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com> Reviewed-by: Louis Stermole <stermole@us.ibm.com> Reviewed-by: Matt K. Light <mklight@us.ibm.com> Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com> Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com> Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/64216 Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com> Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com> Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com> Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>
Diffstat (limited to 'src')
-rw-r--r--src/import/hwpf/fapi2/include/fapi2_i2c_access.H4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/import/hwpf/fapi2/include/fapi2_i2c_access.H b/src/import/hwpf/fapi2/include/fapi2_i2c_access.H
index b02b5a863..d6736cf01 100644
--- a/src/import/hwpf/fapi2/include/fapi2_i2c_access.H
+++ b/src/import/hwpf/fapi2/include/fapi2_i2c_access.H
@@ -76,11 +76,11 @@ inline ReturnCode getI2c(const Target<K, V>& i_target,
///
/// Example use (seeprom write 4 bytes of zeros w/ 2-byte address: 0x0208):
/// std::vector<uint8_t> addr_data = {0x02, 0x08, 0x00, 0x00, 0x00, 0x00};
-/// FAPI_TRY(getI2c(target, addr_data));
+/// FAPI_TRY(putI2c(target, addr_data));
///
/// Example use (smbus write 1 data length byte + 4 bytes of zeros w/ 1-byte command: 0x01):
/// std::vector<uint8_t> command_data = {0x01, 0x04, 0x00, 0x00, 0x00, 0x00};
-/// FAPI_TRY(getI2c(target, command_data));
+/// FAPI_TRY(putI2c(target, command_data));
///
/// @tparam K the type (Kind) of target, from i_target
/// @tparam V the type of the target's Value, from i_target
OpenPOWER on IntegriCloud