alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: remove link to i2c specs

Browse Source
This commit is contained in:
Marius Vikhammer 2022-10-28 11:36:59 +08:00
parent f5bffc284c
commit 418efe09f6
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -340,7 +340,7 @@ During driver installation, an interrupt handler is installed by default.
Customized Configuration Customized Configuration
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
As mentioned at the end of Section :ref:`i2c-api-configure-driver`, when the function :cpp:func:`i2c_param_config` initializes the driver configuration for an I2C port, it also sets several I2C communication parameters to default values defined in the `I2C specification <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_. Some other related parameters are pre-configured in registers of the I2C controller. As mentioned at the end of Section :ref:`i2c-api-configure-driver`, when the function :cpp:func:`i2c_param_config` initializes the driver configuration for an I2C port, it also sets several I2C communication parameters to default values defined in the I2C specification. Some other related parameters are pre-configured in registers of the I2C controller.
All these parameters can be changed to user-defined values by calling dedicated functions given in the table below. Please note that the timing values are defined in APB clock cycles. The frequency of APB is specified in :c:macro:`I2C_APB_CLK_FREQ`. All these parameters can be changed to user-defined values by calling dedicated functions given in the table below. Please note that the timing values are defined in APB clock cycles. The frequency of APB is specified in :c:macro:`I2C_APB_CLK_FREQ`.
@ -372,7 +372,7 @@ You can also select different pins for SDA and SCL signals and alter the configu
.. note:: .. note::
{IDF_TARGET_NAME}'s internal pull-ups are in the range of tens of kOhm, which is, in most cases, insufficient for use as I2C pull-ups. Users are advised to use external pull-ups with values described in the `I2C specification <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_. {IDF_TARGET_NAME}'s internal pull-ups are in the range of tens of kOhm, which is, in most cases, insufficient for use as I2C pull-ups. Users are advised to use external pull-ups with values described in the I2C specification. For help with calculating the resistor values see `TI Application Note <https://www.ti.com/lit/an/slva689/slva689.pdf>`_
.. _i2c-api-error-handling: .. _i2c-api-error-handling:

8
docs/zh_CN/api-reference/peripherals/i2c.rst
View File

@ -24,7 +24,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信，该驱动程序具备
.. only:: SOC_I2C_SUPPORT_SLAVE .. only:: SOC_I2C_SUPPORT_SLAVE
- 支持从机模式 - 支持从机模式
- 读取并写入寄存器，然后由主机读取/写入 - 读取并写入寄存器，然后由主机读取/写入
@ -329,7 +329,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信，该驱动程序具备
.. only:: not SOC_I2C_SUPPORT_SLAVE .. only:: not SOC_I2C_SUPPORT_SLAVE
.. _i2c-api-interrupt-handling: .. _i2c-api-interrupt-handling:
中断处理 中断处理
^^^^^^^^^^^ ^^^^^^^^^^^
@ -340,7 +340,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信，该驱动程序具备
用户自定义配置 用户自定义配置
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
如本节末尾所述 :ref:`i2c-api-configure-driver`，函数 :cpp:func:`i2c_param_config` 在初始化 I2C 端口的驱动程序配置时，也会将几个 I2C 通信参数设置为 `I2C 总线协议规范 <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_ 规定的默认值。 其他一些相关参数已在 I2C 控制器的寄存器中预先配置。 如本节末尾所述 :ref:`i2c-api-configure-driver`，函数 :cpp:func:`i2c_param_config` 在初始化 I2C 端口的驱动程序配置时，也会将几个 I2C 通信参数设置为 I2C 总线协议规范规定的默认值。其他一些相关参数已在 I2C 控制器的寄存器中预先配置。
通过调用下表中提供的专用函数，可以将所有这些参数更改为用户自定义值。请注意，时序值是在 APB 时钟周期中定义。APB 的频率在 :c:macro:`I2C_APB_CLK_FREQ` 中指定。 通过调用下表中提供的专用函数，可以将所有这些参数更改为用户自定义值。请注意，时序值是在 APB 时钟周期中定义。APB 的频率在 :c:macro:`I2C_APB_CLK_FREQ` 中指定。
@ -372,7 +372,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信，该驱动程序具备
.. 注解 :: .. 注解 ::
{IDF_TARGET_NAME} 的内部上拉电阻范围为几万欧姆，因此在大多数情况下，它们本身不足以用作 I2C 上拉电阻。建议用户使用阻值在 `I2C 总线协议规范 <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_ 规定范围内的上拉电阻。 {IDF_TARGET_NAME} 的内部上拉电阻范围为几万欧姆，因此在大多数情况下，它们本身不足以用作 I2C 上拉电阻。建议用户使用阻值在 I2C 总线协议规范规定范围内的上拉电阻。计算阻值的具体方法，可参考 `TI 应用说明 <https://www.ti.com/lit/an/slva689/slva689.pdf>`_
.. _i2c-api-error-handling: .. _i2c-api-error-handling: