espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-02 12:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

spi_slv_hd: add hal_trans_finish comments for clarifying risk

Browse Source
This commit is contained in:
Armando
2021-02-08 11:53:35 +08:00
parent 2c1845995b
commit 3e9cd49d32
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
components/hal/include/hal/spi_slave_hd_hal.h
View File

@@ -266,6 +266,10 @@ int spi_slave_hd_hal_get_last_addr(spi_slave_hd_hal_context_t *hal);
/** /**
* @brief Return the finished TX transaction * @brief Return the finished TX transaction
* *
* @note This API is based on this assumption: the hardware behaviour of current transaction completion is only modified by the its own caller layer.
* This means if some other code changed the hardware behaviour (e.g. clear intr raw bit), or the caller call this API without noticing the HW behaviour,
* this API will go wrong.
*
* @param hal Context of the HAL layer * @param hal Context of the HAL layer
* @param out_trans Pointer to the caller-defined transaction * @param out_trans Pointer to the caller-defined transaction
* @return 1: Transaction is finished; 0: Transaction is not finished * @return 1: Transaction is finished; 0: Transaction is not finished
@@ -275,6 +279,10 @@ bool spi_slave_hd_hal_get_tx_finished_trans(spi_slave_hd_hal_context_t *hal, voi
/** /**
* @brief Return the finished RX transaction * @brief Return the finished RX transaction
* *
* @note This API is based on this assumption: the hardware behaviour of current transaction completion is only modified by the its own caller layer.
* This means if some other code changed the hardware behaviour (e.g. clear intr raw bit), or the caller call this API without noticing the HW behaviour,
* this API will go wrong.
*
* @param hal Context of the HAL layer * @param hal Context of the HAL layer
* @param out_trans Pointer to the caller-defined transaction * @param out_trans Pointer to the caller-defined transaction
* @param out_len Actual number of bytes of received data * @param out_len Actual number of bytes of received data