From 50b5db12e357e70989a6bf7af4b386b6ad8587e2 Mon Sep 17 00:00:00 2001 From: Zhang Shuxian Date: Fri, 21 Mar 2025 17:26:29 +0800 Subject: [PATCH] docs: Add a note about TWAI multiple instances install --- docs/en/api-reference/peripherals/twai.rst | 2 ++ docs/zh_CN/api-reference/peripherals/twai.rst | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/en/api-reference/peripherals/twai.rst b/docs/en/api-reference/peripherals/twai.rst index 310f9126c5..4ec710d44b 100644 --- a/docs/en/api-reference/peripherals/twai.rst +++ b/docs/en/api-reference/peripherals/twai.rst @@ -404,6 +404,8 @@ The usage of macro initializers is not mandatory and each of the configuration s Install Multiple TWAI Instances ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +**Note:** You can create {IDF_TARGET_CONFIG_SOC_TWAI_CONTROLLER_NUM} functional TWAI instance(s) because the {IDF_TARGET_NAME} has {IDF_TARGET_CONFIG_SOC_TWAI_CONTROLLER_NUM} physical TWAI controller(s). + The following code snippet demonstrates how to install multiple TWAI instances via the use of the :cpp:func:`twai_driver_install_v2` function. .. code-block:: c diff --git a/docs/zh_CN/api-reference/peripherals/twai.rst b/docs/zh_CN/api-reference/peripherals/twai.rst index 4bd78d2fe1..cac89ff02b 100644 --- a/docs/zh_CN/api-reference/peripherals/twai.rst +++ b/docs/zh_CN/api-reference/peripherals/twai.rst @@ -404,6 +404,8 @@ TWAI 驱动程序通过 :cpp:type:`twai_message_t` 结构体的不同位字段 安装多个 TWAI 实例 ^^^^^^^^^^^^^^^^^^ +**注意：** {IDF_TARGET_NAME} 包含 {IDF_TARGET_CONFIG_SOC_TWAI_CONTROLLER_NUM} 个 TWAI 控制器，因此可创建 {IDF_TARGET_CONFIG_SOC_TWAI_CONTROLLER_NUM} 个 TWAI 实例。 + 以下代码片段演示了如何使用 :cpp:func:`twai_driver_install_v2` 函数来安装多个 TWAI 实例。 .. code-block:: c