tree 5a7555744f28d95c2eafb674b7ecdb126ff0d5be
parent d114cd94ac175eb9ad6f2d2ce75af14069bccc47
author Shawn McCarney <shawnmm@us.ibm.com> 1582998588 -0600
committer Shawn McCarney <shawnmm@us.ibm.com> 1582998588 -0600

Document byte order of I2CInterface read/write

Update the doxygen comments for the following two I2CInterface methods:
* void read(uint8_t addr, uint16_t& data);
* void write(uint8_t addr, uint16_t data);

Document that the two bytes are transmitted with the low order byte
first.

The I2CInterface methods call the following two i2c-dev functions:
* i2c_smbus_read_word_data()
* i2c_smbus_write_word_data()

The SMBus Read Word and Write Word protocols require the low order byte
to be sent first.

Testing:
  * Tested on Witherspoon using i2cget and i2cset.  These command line
    tools call the same two i2c-dev functions.  Verified that the low
    order byte is read/written first.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I83ba69f8cde08ee719d34802afed691a61fe3e84