tools/i2c/i2c_interface.hpp

19                           uint8_t addr, int errorCode = 0) :  in I2CException()  argument
20         bus(bus), addr(addr), errorCode(errorCode)  in I2CException()
23         ss << "I2CException: " << info << ": bus " << bus << ", addr 0x"  in I2CException()
24            << std::hex << static_cast<int>(addr);  in I2CException()
39     uint8_t addr;  member in i2c::I2CException
60     /** @brief The block transaction mode */
61     enum class Mode  enum in i2c::I2CInterface
83      * The interface can later be re-opened by calling open().
96      * @param[out] data - The data read from the i2c device
104      * @param[in] addr - The register address of the i2c device
105      * @param[out] data - The data read from the i2c device
109     virtual void read(uint8_t addr, uint8_t& data) = 0;
114      * the first byte read is the low-order byte.
116      * @param[in] addr - The register address of the i2c device
117      * @param[out] data - The data read from the i2c device
121     virtual void read(uint8_t addr, uint16_t& data) = 0;
125      * @param[in] addr - The register address of the i2c device
126      * @param[in,out] size - The out parameter to indicate the size of data read
127      *                       from i2c device; when mode is I2C, it is also the
129      * @param[out] data - The pointer to buffer to read from the i2c device,
133      * @param[in] mode - The block read mode, either SMBus or I2C.
140     virtual void read(uint8_t addr, uint8_t& size, uint8_t* data,
141                       Mode mode = Mode::SMBUS) = 0;
145      * @param[in] data - The data to write to the i2c device
153      * @param[in] addr - The register address of the i2c device
154      * @param[in] data - The data to write to the i2c device
158     virtual void write(uint8_t addr, uint8_t data) = 0;
163      * the first byte written is the low-order byte.
165      * @param[in] addr - The register address of the i2c device
166      * @param[in] data - The data to write to the i2c device
170     virtual void write(uint8_t addr, uint16_t data) = 0;
174      * @param[in] addr - The register address of the i2c device
175      * @param[in] size - The size of data to write, SMBus allows at most 32
177      * @param[in] data - The data to write to the i2c device
178      * @param[in] mode - The block write mode, either SMBus or I2C.
185     virtual void write(uint8_t addr, uint8_t size, const uint8_t* data,
186                        Mode mode = Mode::SMBUS) = 0;
190      * @param[in] addr - The register address of the i2c device
191      * @param[in] writeData - The data to write to the i2c device
192      * @param[out] readData - The data read from the i2c device
196     virtual void processCall(uint8_t addr, uint16_t writeData,
199     /** @brief SMBus Block Write-Block Read Process Call protocol
208      * I2C-level commands, the maximum write size is 255 bytes. The read size +
211      * @param[in] addr - The register address of the i2c device
212      * @param[in] writeSize - The size of data to write
213      * @param[in] writeData - The data to write to the i2c device
214      * @param[out] readSize - The size of data read from i2c device. Max read
216      * @param[out] readData - Pointer to buffer to hold the data read from the
222     virtual void processCall(uint8_t addr, uint8_t writeSize,
231  * @param[in] busId - The i2c bus ID
232  * @param[in] devAddr - The device address of the i2c
233  * @param[in] initialState - Initial state of the I2CInterface object
234  * @param[in] maxRetries - Maximum number of times to retry an I2C operation