tools/i2c/i2c.hpp

19      * @param[in] busId - The i2c bus ID
20      * @param[in] devAddr - The device address of the I2C device
21      * @param[in] initialState - Initial state of the I2CDevice object
22      * @param[in] maxRetries - Maximum number of times to retry an I2C operation
28         busStr("/dev/i2c-" + std::to_string(busId))  in I2CDevice()
37     static constexpr int INVALID_FD = -1;
90     /** @brief Check i2c adapter read functionality
95      * @param[in] type - The SMBus transaction type defined in linux/i2c.h
101     /** @brief Check i2c adapter write functionality
106      * @param[in] type - The SMBus transaction type defined in linux/i2c.h
112     /** @brief SMBus Block Write-Block Read Process Call using SMBus function
114      * In SMBus 2.0 the maximum write size + read size is <= 32 bytes.
115      * In SMBus 3.0 the maximum write size + read size is <= 255 bytes.
118      * @param[in] addr - The register address of the i2c device
119      * @param[in] writeSize - The size of data to write. Write size + read size
121      * @param[in] writeData - The data to write to the i2c device
122      * @param[out] readSize - The size of data read from i2c device. Write size
123      *                        + read size must be <= 32 bytes.
124      * @param[out] readData - Pointer to buffer to hold the data read from the
134     /** @brief SMBus Block Write-Block Read Process Call using I2C messages
138      * protocol but do support I2C-level commands.
142      * up to 255 bytes.  The write size + read size must be <= 255 bytes.
144      * @param[in] addr - The register address of the i2c device
145      * @param[in] writeSize - The size of data to write. Write size + read size
147      * @param[in] writeData - The data to write to the i2c device
148      * @param[out] readSize - The size of data read from i2c device. Max read
149      *                        size is 32 bytes, and write size + read size must
151      * @param[out] readData - Pointer to buffer to hold the data read from the
184     /** @copydoc I2CInterface::read(uint8_t&) */
185     void read(uint8_t& data) override;
187     /** @copydoc I2CInterface::read(uint8_t,uint8_t&) */
188     void read(uint8_t addr, uint8_t& data) override;
190     /** @copydoc I2CInterface::read(uint8_t,uint16_t&) */
191     void read(uint8_t addr, uint16_t& data) override;
193     /** @copydoc I2CInterface::read(uint8_t,uint8_t&,uint8_t*,Mode) */
194     void read(uint8_t addr, uint8_t& size, uint8_t* data,
197     /** @copydoc I2CInterface::write(uint8_t) */
198     void write(uint8_t data) override;
200     /** @copydoc I2CInterface::write(uint8_t,uint8_t) */
201     void write(uint8_t addr, uint8_t data) override;
203     /** @copydoc I2CInterface::write(uint8_t,uint16_t) */
204     void write(uint8_t addr, uint16_t data) override;
206     /** @copydoc I2CInterface::write(uint8_t,uint8_t,const uint8_t*,Mode) */
207     void write(uint8_t addr, uint8_t size, const uint8_t* data,
223      * @param[in] busId - The i2c bus ID
224      * @param[in] devAddr - The device address of the i2c
225      * @param[in] initialState - Initial state of the I2CInterface object
226      * @param[in] maxRetries - Maximum number of times to retry an I2C operation