VSF Documented
|
#include "hal/driver/driver.h"
Macros | |
#define | VSF_ETH_CFG_FUNCTION_RENAME DISABLED |
Functions | |
vsf_err_t | vsf_eth_init (vsf_eth_t *eth_ptr, vsf_eth_cfg_t *cfg_ptr) |
Initialize a ETH instance. | |
void | vsf_eth_fini (vsf_eth_t *eth_ptr) |
Finalize a ETH instance. | |
fsm_rt_t | vsf_eth_enable (vsf_eth_t *eth_ptr) |
Enable a ETH instance. | |
fsm_rt_t | vsf_eth_disable (vsf_eth_t *eth_ptr) |
Disable a ETH instance. | |
void | vsf_eth_irq_enable (vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask) |
void | vsf_eth_irq_disable (vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask) |
vsf_err_t | vsf_eth_send_request (vsf_eth_t *eth_ptr, vsf_eth_send_buf_desc_t *buf_ptr) |
Send a buffer over ETH instance. | |
vsf_err_t | vsf_eth_recv_request (vsf_eth_t *eth_ptr, vsf_eth_recv_buf_desc_t *buf_ptr) |
Receive a buffer from ETH instance. | |
vsf_err_t | vsf_eth_send_sg_request (vsf_eth_t *eth_ptr, vsf_eth_send_sg_buf_desc_t *buf_ptr, uint32_t sg_count) |
Send a scatter-gather buffer over ETH instance. | |
vsf_err_t | vsf_eth_recv_sg_request (vsf_eth_t *eth_ptr, vsf_eth_recv_sg_buf_desc_t *buf_ptr, uint32_t sg_count) |
Receive data using scatter-gather buffers from ETH instance. | |
vsf_err_t | vsf_eth_ctrl (vsf_eth_t *eth_ptr, vsf_eth_ctrl_t ctrl, void *param) |
Control ETH instance. | |
vsf_eth_status_t | vsf_eth_status (vsf_eth_t *eth_ptr) |
Get the status of ETH instance. | |
vsf_eth_capability_t | vsf_eth_capability (vsf_eth_t *eth_ptr) |
Get the capability of ETH instance. | |
#define VSF_ETH_CFG_FUNCTION_RENAME DISABLED |
vsf_err_t vsf_eth_init | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_cfg_t * | cfg_ptr | ||
) |
Initialize a ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[in] | cfg_ptr | a pointer to structure vsf_eth_cfg_t |
void vsf_eth_fini | ( | vsf_eth_t * | eth_ptr | ) |
Enable a ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
Disable a ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
void vsf_eth_irq_enable | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_irq_mask_t | irq_mask | ||
) |
void vsf_eth_irq_disable | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_irq_mask_t | irq_mask | ||
) |
vsf_err_t vsf_eth_send_request | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_send_buf_desc_t * | buf_ptr | ||
) |
Send a buffer over ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[in] | buf_ptr | pointer to the buffer to be sent, refer to vsf_eth_send_buf_desc_t |
vsf_err_t vsf_eth_recv_request | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_recv_buf_desc_t * | buf_ptr | ||
) |
Receive a buffer from ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[out] | buf_ptr | pointer to the buffer to store received data, refer to vsf_eth_recv_buf_desc_t |
vsf_err_t vsf_eth_send_sg_request | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_send_sg_buf_desc_t * | sg_ptr, | ||
uint32_t | sg_count | ||
) |
Send a scatter-gather buffer over ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[in] | sg_ptr | pointer to the scatter-gather buffer array to be sent |
[in] | sg_count | number of scatter-gather buffer elements in the array |
vsf_err_t vsf_eth_recv_sg_request | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_recv_sg_buf_desc_t * | sg_ptr, | ||
uint32_t | sg_count | ||
) |
Receive data using scatter-gather buffers from ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[out] | sg_ptr | pointer to the scatter-gather buffer array to store received data |
[in] | sg_count | number of scatter-gather buffer elements in the array |
vsf_err_t vsf_eth_ctrl | ( | vsf_eth_t * | eth_ptr, |
vsf_eth_ctrl_t | ctrl, | ||
void * | param | ||
) |
Control ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
[in] | ctrl_ptr | pointer to the control command, refer to vsf_eth_ctrl_t |
[in] | param | control command parameter, the specific type depends on the control command For example, VSF_ETH_CTRL_SET_MAC_ADDRESS requires a uint8_t* type parameter |
vsf_eth_status_t vsf_eth_status | ( | vsf_eth_t * | eth_ptr | ) |
Get the status of ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |
vsf_eth_capability_t vsf_eth_capability | ( | vsf_eth_t * | eth_ptr | ) |
Get the capability of ETH instance.
[in] | eth_ptr | a pointer to structure vsf_eth_t |