mirror of
https://github.com/0xFEEDC0DE64/arduino-esp32.git
synced 2025-07-25 16:27:15 +02:00
IDF master 3e370c4296
* Fix build compilation due to changes in the HW_TIMER's structs * Fix compilation warnings and errors with USB * Update USBCDC.cpp * Update CMakeLists.txt * Update HWCDC.cpp
This commit is contained in:
Me No Dev
GitHub
@ -29,42 +29,48 @@ typedef struct essl_dev_t* essl_handle_t;
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
* @return ESP_OK if success, or other value returned from lower layer `init`.
|
||||
* @return
|
||||
* - ESP_OK: If success
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - Other value returned from lower layer `init`.
|
||||
*/
|
||||
esp_err_t essl_init(essl_handle_t handle, uint32_t wait_ms);
|
||||
|
||||
/** Wait for interrupt of an ESP slave device.
|
||||
/** Wait for interrupt of an ESSL slave device.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK if success
|
||||
* - ESP_OK: If success
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
*/
|
||||
esp_err_t essl_wait_for_ready(essl_handle_t handle, uint32_t wait_ms);
|
||||
|
||||
/** Get buffer num for the host to send data to the slave. The buffers are size of ``buffer_size``.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param out_tx_num Output of buffer num that host can send data to an ESP slave.
|
||||
* @param handle Handle of a ESSL device.
|
||||
* @param out_tx_num Output of buffer num that host can send data to ESSL slave.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode
|
||||
* - One of the error codes from SDMMC/SPI host controller
|
||||
*/
|
||||
esp_err_t essl_get_tx_buffer_num(essl_handle_t handle, uint32_t *out_tx_num, uint32_t wait_ms);
|
||||
|
||||
/** Get amount of data the ESP slave preparing to send to host.
|
||||
/** Get the size, in bytes, of the data that the ESSL slave is ready to send
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param out_rx_size Output of data size to read from slave.
|
||||
* @param out_rx_size Output of data size to read from slave, in bytes
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode
|
||||
* - One of the error codes from SDMMC/SPI host controller
|
||||
*/
|
||||
esp_err_t essl_get_rx_data_size(essl_handle_t handle, uint32_t *out_rx_size, uint32_t wait_ms);
|
||||
|
||||
@ -72,10 +78,15 @@ esp_err_t essl_get_rx_data_size(essl_handle_t handle, uint32_t *out_rx_size, uin
|
||||
/** Reset the counters of this component. Usually you don't need to do this unless you know the slave is reset.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode
|
||||
* - ESP_ERR_INVALID_ARG: Invalid argument, handle is not init.
|
||||
*/
|
||||
esp_err_t essl_reset_cnt(essl_handle_t handle);
|
||||
|
||||
/** Send a packet to the ESP slave. The slave receive the packet into buffers whose size is ``buffer_size`` (configured during initialization).
|
||||
/** Send a packet to the ESSL Slave. The Slave receives the packet into buffers whose size is ``buffer_size`` (configured during initialization).
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param start Start address of the packet to send
|
||||
@ -84,12 +95,15 @@ esp_err_t essl_reset_cnt(essl_handle_t handle);
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - ESP_ERR_TIMEOUT No buffer to use, or error ftrom SDMMC host controller
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_ERR_INVALID_ARG: Invalid argument, handle is not init or other argument is not valid.
|
||||
* - ESP_ERR_TIMEOUT: No buffer to use, or error ftrom SDMMC host controller.
|
||||
* - ESP_ERR_NOT_FOUND: Slave is not ready for receiving.
|
||||
* - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode
|
||||
* - One of the error codes from SDMMC/SPI host controller.
|
||||
*/
|
||||
esp_err_t essl_send_packet(essl_handle_t handle, const void *start, size_t length, uint32_t wait_ms);
|
||||
|
||||
/** Get a packet from an ESP slave.
|
||||
/** Get a packet from ESSL slave.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param[out] out_data Data output address
|
||||
@ -98,16 +112,19 @@ esp_err_t essl_send_packet(essl_handle_t handle, const void *start, size_t lengt
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success, all the data are read from the slave.
|
||||
* - ESP_ERR_NOT_FINISHED Read success, while there're data remaining.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK Success: All the data has been read from the slave.
|
||||
* - ESP_ERR_INVALID_ARG: Invalid argument, The handle is not initialized or the other arguments are invalid.
|
||||
* - ESP_ERR_NOT_FINISHED: Read was successful, but there is still data remaining.
|
||||
* - ESP_ERR_NOT_FOUND: Slave is not ready to send data.
|
||||
* - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode
|
||||
* - One of the error codes from SDMMC/SPI host controller.
|
||||
*/
|
||||
esp_err_t essl_get_packet(essl_handle_t handle, void *out_data, size_t size, size_t *out_length, uint32_t wait_ms);
|
||||
|
||||
/** Write general purpose R/W registers (8-bit) of an ESP slave.
|
||||
/** Write general purpose R/W registers (8-bit) of ESSL slave.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param addr Address of register to write. Valid address: 0-59.
|
||||
* @param addr Address of register to write. For SDIO, valid address: 0-59. For SPI, see ``essl_spi.h``
|
||||
* @param value Value to write to the register.
|
||||
* @param value_o Output of the returned written value.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
@ -116,22 +133,20 @@ esp_err_t essl_get_packet(essl_handle_t handle, void *out_data, size_t size, siz
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - ESP_ERR_INVALID_ARG Address not valid.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - One of the error codes from SDMMC/SPI host controller
|
||||
*/
|
||||
esp_err_t essl_write_reg(essl_handle_t handle, uint8_t addr, uint8_t value, uint8_t *value_o, uint32_t wait_ms);
|
||||
|
||||
/** Read general purpose R/W registers (8-bit) of an ESP slave.
|
||||
/** Read general purpose R/W registers (8-bit) of ESSL slave.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param add Address of register to read. Valid address: 0-27, 32-63 (28-31 reserved, return interrupt bits on read).
|
||||
* @param handle Handle of a ``essl`` device.
|
||||
* @param add Address of register to read. For SDIO, Valid address: 0-27, 32-63 (28-31 reserved, return interrupt bits on read). For SPI, see ``essl_spi.h``
|
||||
* @param value_o Output value read from the register.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - ESP_ERR_INVALID_ARG Address not valid.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - One of the error codes from SDMMC/SPI host controller
|
||||
*/
|
||||
esp_err_t essl_read_reg(essl_handle_t handle, uint8_t add, uint8_t *value_o, uint32_t wait_ms);
|
||||
|
||||
@ -141,25 +156,26 @@ esp_err_t essl_read_reg(essl_handle_t handle, uint8_t add, uint8_t *value_o, uin
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_ERR_NOT_SUPPORTED Currently our driver doesnot support SDIO with SPI interface.
|
||||
* - ESP_OK If interrupt triggered.
|
||||
* - ESP_ERR_TIMEOUT No interrupts before timeout.
|
||||
* - ESP_OK: If interrupt is triggered.
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - ESP_ERR_TIMEOUT: No interrupts before timeout.
|
||||
*/
|
||||
esp_err_t essl_wait_int(essl_handle_t handle, uint32_t wait_ms);
|
||||
|
||||
/** Clear interrupt bits of an ESP slave. All the bits set in the mask will be cleared, while other bits will stay the same.
|
||||
/** Clear interrupt bits of ESSL slave. All the bits set in the mask will be cleared, while other bits will stay the same.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param intr_mask Mask of interrupt bits to clear.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
*/
|
||||
esp_err_t essl_clear_intr(essl_handle_t handle, uint32_t intr_mask, uint32_t wait_ms);
|
||||
|
||||
/** Get interrupt bits of an ESP slave.
|
||||
/** Get interrupt bits of ESSL slave.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param intr_raw Output of the raw interrupt bits. Set to NULL if only masked bits are read.
|
||||
@ -167,25 +183,27 @@ esp_err_t essl_clear_intr(essl_handle_t handle, uint32_t intr_mask, uint32_t wai
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - ESP_INVALID_ARG if both ``intr_raw`` and ``intr_st`` are NULL.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_INVALID_ARG: If both ``intr_raw`` and ``intr_st`` are NULL.
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
*/
|
||||
esp_err_t essl_get_intr(essl_handle_t handle, uint32_t *intr_raw, uint32_t *intr_st, uint32_t wait_ms);
|
||||
|
||||
/** Set interrupt enable bits of an ESP slave. The slave only sends interrupt on the line when there is a bit both the raw status and the enable are set.
|
||||
/** Set interrupt enable bits of ESSL slave. The slave only sends interrupt on the line when there is a bit both the raw status and the enable are set.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param ena_mask Mask of the interrupt bits to enable.
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
*/
|
||||
esp_err_t essl_set_intr_ena(essl_handle_t handle, uint32_t ena_mask, uint32_t wait_ms);
|
||||
|
||||
/** Get interrupt enable bits of an ESP slave.
|
||||
/** Get interrupt enable bits of ESSL slave.
|
||||
*
|
||||
* @param handle Handle of an ESSL device.
|
||||
* @param ena_mask_o Output of interrupt bit enable mask.
|
||||
@ -204,7 +222,8 @@ esp_err_t essl_get_intr_ena(essl_handle_t handle, uint32_t *ena_mask_o, uint32_t
|
||||
* @param wait_ms Millisecond to wait before timeout, will not wait at all if set to 0-9.
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK Success
|
||||
* - One of the error codes from SDMMC host controller
|
||||
* - ESP_OK: Success
|
||||
* - ESP_ERR_NOT_SUPPORTED: Current device does not support this function.
|
||||
* - One of the error codes from SDMMC host controller
|
||||
*/
|
||||
esp_err_t essl_send_slave_intr(essl_handle_t handle, uint32_t intr_mask, uint32_t wait_ms);
|
||||
|
||||
@ -23,22 +23,141 @@ extern "C"
|
||||
{
|
||||
#endif
|
||||
|
||||
/// Configuration of ESSL SPI device
|
||||
typedef struct {
|
||||
spi_device_handle_t *spi; ///< Pointer to SPI device handle.
|
||||
uint32_t tx_buf_size; ///< The pre-negotiated Master TX buffer size used by both the host and the slave.
|
||||
uint8_t tx_sync_reg; ///< The pre-negotiated register ID for Master-TX-SLAVE-RX synchronization. 1 word (4 Bytes) will be reserved for the synchronization.
|
||||
uint8_t rx_sync_reg; ///< The pre-negotiated register ID for Master-RX-Slave-TX synchronization. 1 word (4 Bytes) will be reserved for the synchronization.
|
||||
} essl_spi_config_t;
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// APIs for DMA Append Mode
|
||||
// This mode has a better performance for continuous Half Duplex SPI transactions.
|
||||
//
|
||||
// * You can use the ``essl_spi_init_dev`` and ``essl_spi_deinit_dev`` together with APIs in ``essl.h`` to communicate
|
||||
// with ESP SPI Slaves in Half Duplex DMA Append Mode. See example for SPI SLAVE HALFDUPLEX APPEND MODE.
|
||||
// * You can also use the following APIs to create your own logic.
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/**
|
||||
* @brief Initialize the ESSL SPI device function list and get its handle
|
||||
*
|
||||
* @param[out] out_handle Output of the handle
|
||||
* @param init_config Configuration for the ESSL SPI device
|
||||
* @return
|
||||
* - ESP_OK: On success
|
||||
* - ESP_ERR_NO_MEM: Memory exhausted
|
||||
* - ESP_ERR_INVALID_STATE: SPI driver is not initialized
|
||||
* - ESP_ERR_INVALID_ARG: Wrong register ID
|
||||
*/
|
||||
esp_err_t essl_spi_init_dev(essl_handle_t *out_handle, const essl_spi_config_t *init_config);
|
||||
|
||||
/**
|
||||
* @brief Deinitialize the ESSL SPI device and free the memory used by the device
|
||||
*
|
||||
* @param handle Handle of the ESSL SPI device
|
||||
* @return
|
||||
* - ESP_OK: On success
|
||||
* - ESP_ERR_INVALID_STATE: ESSL SPI is not in use
|
||||
*/
|
||||
esp_err_t essl_spi_deinit_dev(essl_handle_t handle);
|
||||
|
||||
/**
|
||||
* @brief Read from the shared registers
|
||||
*
|
||||
* @note The registers for Master/Slave synchronization are reserved. Do not use them. (see `rx_sync_reg` in `essl_spi_config_t`)
|
||||
*
|
||||
* @param arg Context of the component. (Member ``arg`` from ``essl_handle_t``)
|
||||
* @param addr Address of the shared registers. (Valid: 0 ~ SOC_SPI_MAXIMUM_BUFFER_SIZE, registers for M/S sync are reserved, see note1).
|
||||
* @param[out] out_value Read buffer for the shared registers.
|
||||
* @param wait_ms Time to wait before timeout (reserved for future use, user should set this to 0).
|
||||
* @return
|
||||
* - ESP_OK: success
|
||||
* - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized.
|
||||
* - ESP_ERR_INVALID_ARG: The address argument is not valid. See note 1.
|
||||
* - or other return value from :cpp:func:`spi_device_transmit`.
|
||||
*/
|
||||
esp_err_t essl_spi_read_reg(void *arg, uint8_t addr, uint8_t *out_value, uint32_t wait_ms);
|
||||
|
||||
/**
|
||||
* @brief Get a packet from Slave
|
||||
*
|
||||
* @param arg Context of the component. (Member ``arg`` from ``essl_handle_t``)
|
||||
* @param[out] out_data Output data address
|
||||
* @param size The size of the output data.
|
||||
* @param wait_ms Time to wait before timeout (reserved for future use, user should set this to 0).
|
||||
* @return
|
||||
* - ESP_OK: On Success
|
||||
* - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized.
|
||||
* - ESP_ERR_INVALID_ARG: The output data address is neither DMA capable nor 4 byte-aligned
|
||||
* - ESP_ERR_INVALID_SIZE: Master requires ``size`` bytes of data but Slave did not load enough bytes.
|
||||
*/
|
||||
esp_err_t essl_spi_get_packet(void *arg, void *out_data, size_t size, uint32_t wait_ms);
|
||||
|
||||
/**
|
||||
* @brief Write to the shared registers
|
||||
*
|
||||
* @note The registers for Master/Slave synchronization are reserved. Do not use them. (see `tx_sync_reg` in `essl_spi_config_t`)
|
||||
* @note Feature of checking the actual written value (``out_value``) is not supported.
|
||||
*
|
||||
* @param arg Context of the component. (Member ``arg`` from ``essl_handle_t``)
|
||||
* @param addr Address of the shared registers. (Valid: 0 ~ SOC_SPI_MAXIMUM_BUFFER_SIZE, registers for M/S sync are reserved, see note1)
|
||||
* @param value Buffer for data to send, should be align to 4.
|
||||
* @param[out] out_value Not supported, should be set to NULL.
|
||||
* @param wait_ms Time to wait before timeout (reserved for future use, user should set this to 0).
|
||||
* @return
|
||||
* - ESP_OK: success
|
||||
* - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized.
|
||||
* - ESP_ERR_INVALID_ARG: The address argument is not valid. See note 1.
|
||||
* - ESP_ERR_NOT_SUPPORTED: Should set ``out_value`` to NULL. See note 2.
|
||||
* - or other return value from :cpp:func:`spi_device_transmit`.
|
||||
*
|
||||
*/
|
||||
esp_err_t essl_spi_write_reg(void *arg, uint8_t addr, uint8_t value, uint8_t *out_value, uint32_t wait_ms);
|
||||
|
||||
/**
|
||||
* @brief Send a packet to Slave
|
||||
*
|
||||
* @param arg Context of the component. (Member ``arg`` from ``essl_handle_t``)
|
||||
* @param data Address of the data to send
|
||||
* @param size Size of the data to send.
|
||||
* @param wait_ms Time to wait before timeout (reserved for future use, user should set this to 0).
|
||||
* @return
|
||||
* - ESP_OK: On success
|
||||
* - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized.
|
||||
* - ESP_ERR_INVALID_ARG: The data address is not DMA capable
|
||||
* - ESP_ERR_INVALID_SIZE: Master will send ``size`` bytes of data but Slave did not load enough RX buffer
|
||||
*/
|
||||
esp_err_t essl_spi_send_packet(void *arg, const void *data, size_t size, uint32_t wait_ms);
|
||||
|
||||
/**
|
||||
* @brief Reset the counter in Master context
|
||||
*
|
||||
* @note Shall only be called if the slave has reset its counter. Else, Slave and Master would be desynchronized
|
||||
*
|
||||
* @param arg Context of the component. (Member ``arg`` from ``essl_handle_t``)
|
||||
*/
|
||||
void essl_spi_reset_cnt(void *arg);
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// Basic commands to communicate with the SPI Slave HD on ESP32-S2
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* @brief Read the shared buffer from the slave in ISR way
|
||||
*
|
||||
* @note The slave's HW doesn't guarantee the data in one SPI transaction is consistent. It sends data in unit of byte.
|
||||
* In other words, if the slave SW attempts to update the shared register when a rdbuf SPI transaction is in-flight,
|
||||
* the data got by the master will be the combination of bytes of different writes of slave SW.
|
||||
*
|
||||
* @note ``out_data`` should be prepared in words and in the DRAM. The buffer may be written in words
|
||||
* by the DMA. When a byte is written, the remaining bytes in the same word will also be
|
||||
* overwritten, even the ``len`` is shorter than a word.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param out_data Buffer for read data, strongly suggested to be in the DRAM and align to 4
|
||||
* @param addr Address of the slave shared buffer
|
||||
* @param len Length to read
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param[out] out_data Buffer for read data, strongly suggested to be in the DRAM and aligned to 4
|
||||
* @param addr Address of the slave shared buffer
|
||||
* @param len Length to read
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @return
|
||||
* - ESP_OK: on success
|
||||
* - or other return value from :cpp:func:`spi_device_transmit`.
|
||||
@ -52,11 +171,11 @@ esp_err_t essl_spi_rdbuf(spi_device_handle_t spi, uint8_t *out_data, int addr, i
|
||||
* by the DMA. When a byte is written, the remaining bytes in the same word will also be
|
||||
* overwritten, even the ``len`` is shorter than a word.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param out_data Buffer for read data, strongly suggested to be in the DRAM and align to 4
|
||||
* @param addr Address of the slave shared buffer
|
||||
* @param len Length to read
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param[out] out_data Buffer for read data, strongly suggested to be in the DRAM and aligned to 4
|
||||
* @param addr Address of the slave shared buffer
|
||||
* @param len Length to read
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @return
|
||||
* - ESP_OK: on success
|
||||
* - or other return value from :cpp:func:`spi_device_transmit`.
|
||||
@ -71,7 +190,7 @@ esp_err_t essl_spi_rdbuf_polling(spi_device_handle_t spi, uint8_t *out_data, int
|
||||
* overwritten, even the ``len`` is shorter than a word.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM and align to 4
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM
|
||||
* @param addr Address of the slave shared buffer,
|
||||
* @param len Length to write
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
@ -89,7 +208,7 @@ esp_err_t essl_spi_wrbuf(spi_device_handle_t spi, const uint8_t *data, int addr,
|
||||
* overwritten, even the ``len`` is shorter than a word.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM and align to 4
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM
|
||||
* @param addr Address of the slave shared buffer,
|
||||
* @param len Length to write
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
@ -105,10 +224,10 @@ esp_err_t essl_spi_wrbuf_polling(spi_device_handle_t spi, const uint8_t *data, i
|
||||
* @note This function combines several :cpp:func:`essl_spi_rddma_seg` and one
|
||||
* :cpp:func:`essl_spi_rddma_done` at the end. Used when the slave is working in segment mode.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param out_data Buffer to hold the received data, strongly suggested to be in the DRAM and align to 4
|
||||
* @param len Total length of data to receive.
|
||||
* @param seg_len Length of each segment, which is not larger than the maximum transaction length
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param[out] out_data Buffer to hold the received data, strongly suggested to be in the DRAM and aligned to 4
|
||||
* @param len Total length of data to receive.
|
||||
* @param seg_len Length of each segment, which is not larger than the maximum transaction length
|
||||
* allowed for the spi device. Suggested to be multiples of 4. When set < 0, means send
|
||||
* all data in one segment (the ``rddma_done`` will still be sent.)
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
@ -123,10 +242,10 @@ esp_err_t essl_spi_rddma(spi_device_handle_t spi, uint8_t *out_data, int len, in
|
||||
*
|
||||
* @note To read long buffer, call :cpp:func:`essl_spi_rddma` instead.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param out_data Buffer to hold the received data, strongly suggested to be in the DRAM and align to 4
|
||||
* @param seg_len Length of this segment
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param[out] out_data Buffer to hold the received data. strongly suggested to be in the DRAM and aligned to 4
|
||||
* @param seg_len Length of this segment
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @return
|
||||
* - ESP_OK: success
|
||||
* - or other return value from :cpp:func:`spi_device_transmit`.
|
||||
@ -155,7 +274,7 @@ esp_err_t essl_spi_rddma_done(spi_device_handle_t spi, uint32_t flags);
|
||||
* :cpp:func:`essl_spi_wrdma_done` at the end. Used when the slave is working in segment mode.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM and align to 4
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM
|
||||
* @param len Total length of data to send.
|
||||
* @param seg_len Length of each segment, which is not larger than the maximum transaction length
|
||||
* allowed for the spi device. Suggested to be multiples of 4. When set < 0, means send
|
||||
@ -173,7 +292,7 @@ esp_err_t essl_spi_wrdma(spi_device_handle_t spi, const uint8_t *data, int len,
|
||||
* @note To send long buffer, call :cpp:func:`essl_spi_wrdma` instead.
|
||||
*
|
||||
* @param spi SPI device handle representing the slave
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM and align to 4
|
||||
* @param data Buffer for data to send, strongly suggested to be in the DRAM
|
||||
* @param seg_len Length of this segment
|
||||
* @param flags `SPI_TRANS_*` flags to control the transaction mode of the transaction to send.
|
||||
* @return
|
||||
|
||||
Reference in New Issue
Block a user