Просмотр исходного кода

Merge branch 'docs/ulp_riscv_i2c_sub_reg_addr' into 'master'

ulp-riscv-i2c: Updated API documentation about sub register address usage

Closes IDFGH-9023

See merge request espressif/esp-idf!21838
Sudeep Mohanty 3 лет назад
Родитель
Сommit
2df00a4b17
1 измененных файлов с 4 добавлено и 0 удалено
  1. 4 0
      components/ulp/ulp_riscv/include/ulp_riscv_i2c.h

+ 4 - 0
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
  * @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
  * @param slave_reg_addr    I2C slave sub register address
  */
  */
 void ulp_riscv_i2c_master_set_slave_reg_addr(uint8_t slave_reg_addr);
 void ulp_riscv_i2c_master_set_slave_reg_addr(uint8_t slave_reg_addr);