From 07a506bb02a4dbdac7c0b3712f62108c2c3bd953 Mon Sep 17 00:00:00 2001 From: Sudeep Mohanty Date: Thu, 29 Dec 2022 09:42:30 +0100 Subject: [PATCH] ulp-riscv-i2c: Updated API documentation about sub register address usage The RTC I2C peripheral always expects a I2C slave sub register address to be programmed. If it is not programmed then a sub register address available in SENS_SAR_I2C_CTRL_REG[18:11] is used for I2C read/write. This commit updates the documentation of the API ulp_riscv_i2c_master_set_slave_reg_addr() to clarify the same. --- components/ulp/ulp_riscv/include/ulp_riscv_i2c.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/components/ulp/ulp_riscv/include/ulp_riscv_i2c.h b/components/ulp/ulp_riscv/include/ulp_riscv_i2c.h index d77d2c361b..36ef871667 100644 --- a/components/ulp/ulp_riscv/include/ulp_riscv_i2c.h +++ b/components/ulp/ulp_riscv/include/ulp_riscv_i2c.h @@ -61,6 +61,10 @@ void ulp_riscv_i2c_master_set_slave_addr(uint8_t slave_addr); /** * @brief Set the I2C slave device sub register address * + * @note The RTC I2C peripheral always expects a slave sub register address to be programmed. If it is not, the I2C + * peripheral uses the SENS_SAR_I2C_CTRL_REG[18:11] as the sub register address for the subsequent read or write + * operation. + * * @param slave_reg_addr I2C slave sub register address */ void ulp_riscv_i2c_master_set_slave_reg_addr(uint8_t slave_reg_addr);