dominic/Tactility
1
0
Fork 0
mirror of https://github.com/ByteWelder/Tactility.git synced 2026-02-18 10:53:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document I2C controller functions

Browse Source
This commit is contained in:
Ken Van Hoeylandt 2026-02-15 16:17:34 +01:00
parent c3961fdde7
commit 8c9d86eb36
1 changed files with 44 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
TactilityKernel/include/tactility/drivers/i2c_controller.h
View File

@ -143,14 +143,6 @@ error_t i2c_controller_read_register(struct Device* device, uint8_t address, uin
*/ */
error_t i2c_controller_write_register(struct Device* device, uint8_t address, uint8_t reg, const uint8_t* data, uint16_t dataSize, TickType_t timeout); error_t i2c_controller_write_register(struct Device* device, uint8_t address, uint8_t reg, const uint8_t* data, uint16_t dataSize, TickType_t timeout);
error_t i2c_controller_register8_set(struct Device* device, uint8_t address, uint8_t reg, uint8_t value, TickType_t timeout);
error_t i2c_controller_register8_get(struct Device* device, uint8_t address, uint8_t reg, uint8_t* value, TickType_t timeout);
error_t i2c_controller_register8_set_bits(struct Device* device, uint8_t address, uint8_t reg, uint8_t bits_to_set, TickType_t timeout);
error_t i2c_controller_register8_reset_bits(struct Device* device, uint8_t address, uint8_t reg, uint8_t bits_to_reset, TickType_t timeout);
/** /**
* @brief Writes an array of register-value pairs to an I2C device. * @brief Writes an array of register-value pairs to an I2C device.
* @param[in] device the I2C controller device * @param[in] device the I2C controller device
@ -171,6 +163,50 @@ error_t i2c_controller_write_register_array(struct Device* device, uint8_t addre
*/ */
error_t i2c_controller_has_device_at_address(struct Device* device, uint8_t address, TickType_t timeout); error_t i2c_controller_has_device_at_address(struct Device* device, uint8_t address, TickType_t timeout);
/**
* @brief Sets the value of an 8-bit register of an I2C device.
* @param[in] device the I2C controller device
* @param[in] address the 7-bit I2C address of the slave device
* @param[in] reg the register address to set
* @param[in] value the value to set the register to
* @param[in] timeout the maximum time to wait for the operation to complete
* @retval ERROR_NONE when the write operation was successful
*/
error_t i2c_controller_register8_set(struct Device* device, uint8_t address, uint8_t reg, uint8_t value, TickType_t timeout);
/**
* @brief Gets the value of an 8-bit register of an I2C device.
* @param[in] device the I2C controller device
* @param[in] address the 7-bit I2C address of the slave device
* @param[in] reg the register address to get
* @param[out] value a pointer to the variable to store the register value
* @param[in] timeout the maximum time to wait for the operation to complete
* @retval ERROR_NONE when the read operation was successful
*/
error_t i2c_controller_register8_get(struct Device* device, uint8_t address, uint8_t reg, uint8_t* value, TickType_t timeout);
/**
* @brief Sets specific bits in an 8-bit register of an I2C device.
* @param[in] device the I2C controller device
* @param[in] address the 7-bit I2C address of the slave device
* @param[in] reg the register address
* @param[in] bits_to_set a bitmask of bits to set (set to 1)
* @param[in] timeout the maximum time to wait for the operation to complete
* @retval ERROR_NONE when the operation was successful
*/
error_t i2c_controller_register8_set_bits(struct Device* device, uint8_t address, uint8_t reg, uint8_t bits_to_set, TickType_t timeout);
/**
* @brief Resets specific bits in an 8-bit register of an I2C device.
* @param[in] device the I2C controller device
* @param[in] address the 7-bit I2C address of the slave device
* @param[in] reg the register address
* @param[in] bits_to_reset a bitmask of bits to reset (set to 0)
* @param[in] timeout the maximum time to wait for the operation to complete
* @retval ERROR_NONE when the operation was successful
*/
error_t i2c_controller_register8_reset_bits(struct Device* device, uint8_t address, uint8_t reg, uint8_t bits_to_reset, TickType_t timeout);
extern const struct DeviceType I2C_CONTROLLER_TYPE; extern const struct DeviceType I2C_CONTROLLER_TYPE;
#ifdef __cplusplus #ifdef __cplusplus