mirror of
https://github.com/espressif/esp-idf.git
synced 2026-05-03 19:41:55 +02:00
Merge branch 'refactor/pack_driver_source_files' into 'master'
components/driver: pack peripherals See merge request espressif/esp-idf!22173
This commit is contained in:
@@ -137,5 +137,5 @@ API Reference
|
||||
.. include-build-file:: inc/dac_oneshot.inc
|
||||
.. include-build-file:: inc/dac_cosine.inc
|
||||
.. include-build-file:: inc/dac_continuous.inc
|
||||
.. include-build-file:: inc/components/driver/include/driver/dac_types.inc
|
||||
.. include-build-file:: inc/components/driver/dac/include/driver/dac_types.inc
|
||||
.. include-build-file:: inc/components/hal/include/hal/dac_types.inc
|
||||
|
||||
@@ -366,7 +366,7 @@ All these parameters can be changed to user-defined values by calling dedicated
|
||||
|
||||
Each of the above functions has a *_get_* counterpart to check the currently set value. For example, to check the I2C timeout value, call :cpp:func:`i2c_get_timeout`.
|
||||
|
||||
To check the default parameter values which are set during the driver configuration process, please refer to the file :component_file:`driver/i2c.c` and look for defines with the suffix ``_DEFAULT``.
|
||||
To check the default parameter values which are set during the driver configuration process, please refer to the file :component_file:`driver/i2c/i2c.c` and look for defines with the suffix ``_DEFAULT``.
|
||||
|
||||
You can also select different pins for SDA and SCL signals and alter the configuration of pull-ups with the function :cpp:func:`i2c_set_pin`. If you want to modify already entered values, use the function :cpp:func:`i2c_param_config`.
|
||||
|
||||
@@ -380,7 +380,7 @@ You can also select different pins for SDA and SCL signals and alter the configu
|
||||
Error Handling
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
The majority of I2C driver functions either return ``ESP_OK`` on successful completion or a specific error code on failure. It is a good practice to always check the returned values and implement error handling. The driver also prints out log messages that contain error details, e.g., when checking the validity of entered configuration. For details please refer to the file :component_file:`driver/i2c.c` and look for defines with the suffix ``_ERR_STR``.
|
||||
The majority of I2C driver functions either return ``ESP_OK`` on successful completion or a specific error code on failure. It is a good practice to always check the returned values and implement error handling. The driver also prints out log messages that contain error details, e.g., when checking the validity of entered configuration. For details please refer to the file :component_file:`driver/i2c/i2c.c` and look for defines with the suffix ``_ERR_STR``.
|
||||
|
||||
Use dedicated interrupts to capture communication failures. For instance, if a slave stretches the clock for too long while preparing the data to send back to master, the interrupt ``I2C_TIME_OUT_INT`` will be triggered. For detailed information, see :ref:`i2c-api-interrupt-handling`.
|
||||
|
||||
|
||||
@@ -291,7 +291,7 @@ The clock config helper macro is:
|
||||
- :c:macro:`I2S_STD_CLK_DEFAULT_CONFIG`
|
||||
|
||||
Please refer to :ref:`i2s-api-reference-i2s_std` for STD API information.
|
||||
And for more details, please refer to :component_file:`driver/include/driver/i2s_std.h`.
|
||||
And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_std.h`.
|
||||
|
||||
STD TX Mode
|
||||
~~~~~~~~~~~
|
||||
@@ -548,7 +548,7 @@ Here is the table of the data that received in the buffer with different :cpp:me
|
||||
- :c:macro:`I2S_PDM_TX_CLK_DEFAULT_CONFIG`
|
||||
|
||||
Please refer to :ref:`i2s-api-reference-i2s_pdm` for PDM TX API information.
|
||||
And for more details, please refer to :component_file:`driver/include/driver/i2s_pdm.h`.
|
||||
And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_pdm.h`.
|
||||
|
||||
The PDM data width is fixed to 16-bit, when the data in a ``int16_t`` writing buffer are:
|
||||
|
||||
@@ -645,7 +645,7 @@ Here is the table of the data that received in the buffer with different :cpp:me
|
||||
- :c:macro:`I2S_PDM_RX_CLK_DEFAULT_CONFIG`
|
||||
|
||||
Please refer to :ref:`i2s-api-reference-i2s_pdm` for PDM RX API information.
|
||||
And for more details, please refer to :component_file:`driver/include/driver/i2s_pdm.h`.
|
||||
And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_pdm.h`.
|
||||
|
||||
The PDM data width is fixed to 16-bit, when the data on the line (The PDM format on the line is transferred to PCM format for easier comprehension) are:
|
||||
|
||||
@@ -732,7 +732,7 @@ Here is the table of the data that received in the buffer with different :cpp:me
|
||||
- :c:macro:`I2S_TDM_CLK_DEFAULT_CONFIG`
|
||||
|
||||
Please refer to :ref:`i2s-api-reference-i2s_tdm` for TDM API information.
|
||||
And for more details, please refer to :component_file:`driver/include/driver/i2s_tdm.h`.
|
||||
And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_tdm.h`.
|
||||
|
||||
.. note::
|
||||
|
||||
@@ -1069,5 +1069,5 @@ I2S Driver
|
||||
I2S Types
|
||||
^^^^^^^^^
|
||||
|
||||
.. include-build-file:: inc/components/driver/include/driver/i2s_types.inc
|
||||
.. include-build-file:: inc/components/driver/i2s/include/driver/i2s_types.inc
|
||||
.. include-build-file:: inc/components/hal/include/hal/i2s_types.inc
|
||||
|
||||
@@ -881,7 +881,7 @@ API Reference
|
||||
.. include-build-file:: inc/mcpwm_fault.inc
|
||||
.. include-build-file:: inc/mcpwm_sync.inc
|
||||
.. include-build-file:: inc/mcpwm_cap.inc
|
||||
.. include-build-file:: inc/components/driver/include/driver/mcpwm_types.inc
|
||||
.. include-build-file:: inc/components/driver/mcpwm/include/driver/mcpwm_types.inc
|
||||
.. include-build-file:: inc/components/hal/include/hal/mcpwm_types.inc
|
||||
|
||||
|
||||
|
||||
@@ -527,7 +527,7 @@ API Reference
|
||||
.. include-build-file:: inc/rmt_rx.inc
|
||||
.. include-build-file:: inc/rmt_common.inc
|
||||
.. include-build-file:: inc/rmt_encoder.inc
|
||||
.. include-build-file:: inc/components/driver/include/driver/rmt_types.inc
|
||||
.. include-build-file:: inc/components/driver/rmt/include/driver/rmt_types.inc
|
||||
.. include-build-file:: inc/components/hal/include/hal/rmt_types.inc
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user