feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'contrib/github_pr_7637' into 'master'

Browse Source 
update clk_flags requirement for i2c docs (GitHub PR)

Closes IDFGH-5949

See merge request espressif/esp-idf!16632
This commit is contained in:
morris
2022-07-27 12:32:40 +08:00
parent cdbc581f96 d5bfbfc095
commit a9878292ba
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/api-reference/peripherals/i2c.rst
View File

@@ -87,7 +87,7 @@ Configuration example (master):
.scl_io_num = I2C_MASTER_SCL_IO, // select GPIO specific to your project .scl_io_num = I2C_MASTER_SCL_IO, // select GPIO specific to your project
.scl_pullup_en = GPIO_PULLUP_ENABLE, .scl_pullup_en = GPIO_PULLUP_ENABLE,
.master.clk_speed = I2C_MASTER_FREQ_HZ, // select frequency specific to your project .master.clk_speed = I2C_MASTER_FREQ_HZ, // select frequency specific to your project
// .clk_flags = 0, /*!< Optional, you can use I2C_SCLK_SRC_FLAG_* flags to choose i2c source clock here. */ .clk_flags = 0, // you can use I2C_SCLK_SRC_FLAG_* flags to choose i2c source clock here
}; };
.. only:: SOC_I2C_SUPPORT_SLAVE .. only:: SOC_I2C_SUPPORT_SLAVE
@@ -105,6 +105,7 @@ Configuration example (master):
.mode = I2C_MODE_SLAVE, .mode = I2C_MODE_SLAVE,
.slave.addr_10bit_en = 0, .slave.addr_10bit_en = 0,
.slave.slave_addr = ESP_SLAVE_ADDR, // address of your project .slave.slave_addr = ESP_SLAVE_ADDR, // address of your project
.clk_flags = 0,
}; };
At this stage, :cpp:func:`i2c_param_config` also sets a few other I2C configuration parameters to default values that are defined by the I2C specification. For more details on the values and how to modify them, see :ref:`i2c-api-customized-configuration`. At this stage, :cpp:func:`i2c_param_config` also sets a few other I2C configuration parameters to default values that are defined by the I2C specification. For more details on the values and how to modify them, see :ref:`i2c-api-customized-configuration`.