alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-07 20:00:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(spi_slave): add api for pm lock control

Browse Source
This commit is contained in:
wanlei
2024-05-10 11:55:27 +08:00
committed by wanckl
parent 4f2105d03e
commit 923255d7a7
17 changed files with 197 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/peripherals/spi_slave.rst
View File

@@ -95,6 +95,8 @@ Driver Usage
- Before initiating transactions, fill one or more :cpp:type:`spi_slave_transaction_t` structs with the transaction parameters required. Either queue all transactions by calling the function :cpp:func:`spi_slave_queue_trans` and, at a later time, query the result by using the function :cpp:func:`spi_slave_get_trans_result`, or handle all requests individually by feeding them into :cpp:func:`spi_slave_transmit`. The latter two functions will be blocked until the Host has initiated and finished a transaction, causing the queued data to be sent and received.
- (Optional) Enable/Disable driver functions: Slave driver supports disabling / enabling driver after it is initialized by calling to :cpp:func:`spi_slave_disable` / :cpp:func:`spi_slave_enable`, to be able to change clock or power config or sleep to save power. By default, the driver state is `enabled` after initialized.
- (Optional) To unload the SPI slave driver, call :cpp:func:`spi_slave_free`.

5
docs/en/api-reference/peripherals/spi_slave_hd.rst
View File

@@ -48,6 +48,11 @@ Call :cpp:func:`spi_slave_hd_init` to initialize the SPI bus as well as the peri
The :cpp:type:`spi_bus_config_t` specifies how the bus should be initialized, while :cpp:type:`spi_slave_hd_slot_config_t` specifies how the SPI Slave driver should work.
Enable/Disable Driver (Optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Slave driver supports disabling / enabling driver after it is initialized by calling to :cpp:func:`spi_slave_hd_disable` / :cpp:func:`spi_slave_hd_enable`, to be able to change clock or power config or sleep to save power. By default, the driver state is `enabled` after initialized.
Deinitialization (Optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^