Skip to content

Commit

Permalink
Fix i2c doxy and update i2c_access.H doxy to match fapi2_access_i2c.H
Browse files Browse the repository at this point in the history
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/64215
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Sachin Gupta <sgupta2m@in.ibm.com>
  • Loading branch information
aamarin authored and sgupta2m committed Dec 18, 2018
1 parent de6a45d commit 224f435
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/import/hwpf/fapi2/include/fapi2_i2c_access.H
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 224f435

Please sign in to comment.