feat(esp_eth): a new folder structure of the driver and other improvements
Fixed memory leak in emac_esp_new_dma function. Polished ESP EMAC cache management. Added emac_periph definitions based on SoC features and improved(generalized) ESP EMAC GPIO initialization. Added ESP EMAC GPIO reservation. Added check for frame error condition indicated by EMAC DMA and created a target test.
This commit is contained in:
Ondrej Kosta
@@ -15,20 +15,144 @@ extern "C" {
|
||||
* @brief Indicate to ::emac_esp_dma_receive_frame that receive frame buffer was allocated by ::emac_esp_dma_alloc_recv_buf
|
||||
*
|
||||
*/
|
||||
#define EMAC_HAL_BUF_SIZE_AUTO 0
|
||||
#define EMAC_DMA_BUF_SIZE_AUTO 0
|
||||
|
||||
/**
|
||||
* @brief EMAC DMA handle
|
||||
*
|
||||
*/
|
||||
typedef struct emac_esp_dma_t *emac_esp_dma_handle_t;
|
||||
|
||||
typedef void *emac_esp_dma_config_t;
|
||||
|
||||
void emac_esp_dma_reset_desc_chain(emac_esp_dma_handle_t emac_esp_dma);
|
||||
/**
|
||||
* @brief EMAC DMA configuration
|
||||
* @note Currently just a placeholder
|
||||
*
|
||||
*/
|
||||
typedef struct emac_esp_dma_config_t emac_esp_dma_config_t;
|
||||
|
||||
/**
|
||||
* @brief Reset DMA
|
||||
* @note This function should be called prior each EMAC start
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
*/
|
||||
void emac_esp_dma_reset(emac_esp_dma_handle_t emac_esp_dma);
|
||||
|
||||
/**
|
||||
* @brief Transmit data from buffer over EMAC
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in] buf buffer to be transmitted
|
||||
* @param[in] length length of the buffer
|
||||
* @return number of transmitted bytes on success
|
||||
* zero on fail
|
||||
*/
|
||||
uint32_t emac_esp_dma_transmit_frame(emac_esp_dma_handle_t emac_esp_dma, uint8_t *buf, uint32_t length);
|
||||
uint32_t emac_esp_dma_transmit_multiple_buf_frame(emac_esp_dma_handle_t emac_esp_dma, uint8_t **buffs, uint32_t *lengths, uint32_t buffs_cnt);
|
||||
uint8_t *emac_esp_dma_alloc_recv_buf(emac_esp_dma_handle_t emac_esp_dma, uint32_t *size);
|
||||
uint32_t emac_esp_dma_receive_frame(emac_esp_dma_handle_t emac_esp_dma, uint8_t *buf, uint32_t size, uint32_t *frames_remain, uint32_t *free_desc);
|
||||
void emac_esp_dma_flush_recv_frame(emac_esp_dma_handle_t emac_esp_dma, uint32_t *frames_remain, uint32_t *free_desc);
|
||||
|
||||
/**
|
||||
* @brief Transmit data from multiple buffers over EMAC in single Ethernet frame. Data will be joint into
|
||||
* single frame in order in which the buffers are stored in input array.
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in] buffs array of pointers to buffers to be transmitted
|
||||
* @param[in] lengths array of lengths of the buffers
|
||||
* @param[in] inbuffs_cnt number of buffers (i.e. input arrays size)
|
||||
* @return number of transmitted bytes on success
|
||||
* zero on fail
|
||||
*
|
||||
* @pre @p lengths array must have the same size as @p buffs array and their elements need to be stored in the same
|
||||
* order, i.e. lengths[1] is a length associated with data buffer referenced at buffs[1] position.
|
||||
*/
|
||||
uint32_t emac_esp_dma_transmit_multiple_buf_frame(emac_esp_dma_handle_t emac_esp_dma, uint8_t **buffs, uint32_t *lengths, uint32_t buffs_cnt);
|
||||
|
||||
/**
|
||||
* @brief Allocate buffer with size equal to actually received Ethernet frame size.
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in, out] size as an input defines maximum size of buffer to be allocated. As an output, indicates actual size of received
|
||||
* Ethernet frame which is waiting to be processed. Returned size may be 0 when there is no waiting valid frame.
|
||||
*
|
||||
* @note If maximum allowed size of buffer to be allocated is less than actual size of received Ethernet frame, the buffer
|
||||
* is allocated with that limit and the frame will be truncated by emac_hal_receive_frame.
|
||||
*
|
||||
* @return Pointer to allocated buffer
|
||||
* NULL when allocation fails (returned @p size is non-zero)
|
||||
* NULL when there is no waiting Ethernet frame (returned @p size is zero)
|
||||
*/
|
||||
uint8_t *emac_esp_dma_alloc_recv_buf(emac_esp_dma_handle_t emac_esp_dma, uint32_t *size);
|
||||
|
||||
/**
|
||||
* @brief Copy received Ethernet frame from EMAC DMA memory space to application.
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in] buf buffer into which the Ethernet frame is to be copied
|
||||
* @param[in] size buffer size. When buffer was allocated by ::emac_esp_dma_alloc_recv_buf, this parameter needs to be set
|
||||
* to @c EMAC_DMA_BUF_SIZE_AUTO
|
||||
*
|
||||
* @return - number of copied bytes when success
|
||||
* - number of bytes of received Ethernet frame when maximum allowed buffer @p size is less than actual size of
|
||||
* received Ethernet frame and @p size is NOT set to @c EMAC_DMA_BUF_SIZE_AUTO
|
||||
* - 0 when there is no waiting Ethernet frame or on frame error when @p size is NOT set to @c EMAC_DMA_BUF_SIZE_AUTO
|
||||
*
|
||||
* @note When this function is called with @c EMAC_DMA_BUF_SIZE_AUTO size option (preferred), buffer needs to be
|
||||
* successfully allocated by ::emac_esp_dma_alloc_recv_buf function at first.
|
||||
* @note When this function is NOT called with @c EMAC_DMA_BUF_SIZE_AUTO size option and maximum allowed buffer @p size
|
||||
* is less than actual size of received Ethernet frame, the frame will be truncated.
|
||||
* @note FCS field is never copied
|
||||
*/
|
||||
uint32_t emac_esp_dma_receive_frame(emac_esp_dma_handle_t emac_esp_dma, uint8_t *buf, uint32_t size);
|
||||
|
||||
/**
|
||||
* @brief Flush frame stored in Rx DMA
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
*/
|
||||
void emac_esp_dma_flush_recv_frame(emac_esp_dma_handle_t emac_esp_dma);
|
||||
|
||||
/**
|
||||
* @brief Get number of frames remaining in Rx DMA
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[out] frames_remain number of frames remaining to be processed
|
||||
* @param[out] free_desc number of free DMA Rx descriptors
|
||||
*/
|
||||
void emac_esp_dma_get_remain_frames(emac_esp_dma_handle_t emac_esp_dma, uint32_t *remain_frames, uint32_t *used_descs);
|
||||
|
||||
/**
|
||||
* @brief Set the Transmit Descriptor Word 0 (TDES0) control bits
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in] bit_mask mask of control bits to be set
|
||||
*/
|
||||
void emac_esp_dma_set_tdes0_ctrl_bits(emac_esp_dma_handle_t emac_esp_dma, uint32_t bit_mask);
|
||||
|
||||
/**
|
||||
* @brief Clear the Transmit Descriptor Word 0 (TDES0) control bits
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @param[in] bit_mask mask of control bits to be cleared
|
||||
*/
|
||||
void emac_esp_dma_clear_tdes0_ctrl_bits(emac_esp_dma_handle_t emac_esp_dma, uint32_t bit_mask);
|
||||
|
||||
/**
|
||||
* @brief Creates a new instance of the ESP EMAC DMA
|
||||
*
|
||||
* @param config ESP EMAC DMA configuration
|
||||
* @param[out] ret_handle EMAC DMA handle
|
||||
* @return esp_err_t
|
||||
* ESP_OK on success
|
||||
* ESP_ERR_NO_MEM when there is not enough memory to allocate instance
|
||||
*/
|
||||
esp_err_t emac_esp_new_dma(const emac_esp_dma_config_t* config, emac_esp_dma_handle_t *ret_handle);
|
||||
|
||||
/**
|
||||
* @brief Deletes the ESP EMAC DMA instance
|
||||
*
|
||||
* @param[in] emac_esp_dma EMAC DMA handle
|
||||
* @return esp_err_t
|
||||
* ESP_OK on success
|
||||
*/
|
||||
esp_err_t emac_esp_del_dma(emac_esp_dma_handle_t emac_esp_dma);
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
@@ -10,53 +10,23 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
#include "esp_err.h"
|
||||
#include "esp_eth_mac.h"
|
||||
#include "esp_eth_mac_esp.h"
|
||||
|
||||
/**
|
||||
* @brief EMAC SMI GPIO configuration
|
||||
*/
|
||||
typedef struct {
|
||||
int mdc_num;
|
||||
int mdio_num;
|
||||
} emac_esp_smi_gpio_config_t;
|
||||
#if CONFIG_ETH_USE_ESP32_EMAC
|
||||
|
||||
/**
|
||||
* @brief EMAC MII data interface GPIO configuration
|
||||
*/
|
||||
typedef struct {
|
||||
uint8_t tx_clk_num;
|
||||
uint8_t tx_en_num;
|
||||
uint8_t txd0_num;
|
||||
uint8_t txd1_num;
|
||||
uint8_t txd2_num;
|
||||
uint8_t txd3_num;
|
||||
uint8_t rx_clk_num;
|
||||
uint8_t rx_dv_num;
|
||||
uint8_t rxd0_num;
|
||||
uint8_t rxd1_num;
|
||||
uint8_t rxd2_num;
|
||||
uint8_t rxd3_num;
|
||||
} emac_esp_mii_gpio_config_t;
|
||||
|
||||
/**
|
||||
* @brief EMAC RMII data interface GPIO configuration
|
||||
*/
|
||||
typedef struct {
|
||||
uint8_t tx_en_num;
|
||||
uint8_t txd0_num;
|
||||
uint8_t txd1_num;
|
||||
uint8_t crs_dv_num;
|
||||
uint8_t rxd0_num;
|
||||
uint8_t rxd1_num;
|
||||
} emac_esp_rmii_gpio_config_t;
|
||||
|
||||
esp_err_t emac_esp_iomux_init_mii(emac_esp_mii_gpio_config_t *mii_gpio);
|
||||
esp_err_t emac_esp_iomux_init_rmii(emac_esp_rmii_gpio_config_t *rmii_gpio);
|
||||
esp_err_t emac_esp_gpio_matrix_init_mii(const eth_mac_mii_gpio_config_t *mii_gpio);
|
||||
esp_err_t emac_esp_iomux_init_mii(const eth_mac_mii_gpio_config_t *mii_gpio);
|
||||
esp_err_t emac_esp_iomux_init_rmii(const eth_mac_rmii_gpio_config_t *rmii_gpio);
|
||||
esp_err_t emac_esp_iomux_rmii_clk_input(int num);
|
||||
esp_err_t emac_esp_iomux_rmii_clk_ouput(int num);
|
||||
esp_err_t emac_esp_iomux_init_tx_er(int num);
|
||||
esp_err_t emac_esp_iomux_init_rx_er(int num);
|
||||
void emac_esp32_gpio_init_smi(emac_esp_smi_gpio_config_t *smi_gpio);
|
||||
esp_err_t emac_esp_iomux_rmii_init_tx_er(int num);
|
||||
esp_err_t emac_esp_iomux_rmii_init_rx_er(int num);
|
||||
esp_err_t emac_esp_iomux_mii_init_tx_er(int num);
|
||||
esp_err_t emac_esp_iomux_mii_init_rx_er(int num);
|
||||
esp_err_t emac_esp_gpio_init_smi(const emac_esp_smi_gpio_config_t *smi_gpio);
|
||||
esp_err_t emac_esp_gpio_deinit_all(void);
|
||||
|
||||
#endif // CONFIG_ETH_USE_ESP32_EMAC
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user