Struct esp_idf_svc::sys::esp_eth_config_t

#[repr(C)]
pub struct esp_eth_config_t {
    pub mac: *mut esp_eth_mac_s,
    pub phy: *mut esp_eth_phy_s,
    pub check_link_period_ms: u32,
    pub stack_input: Option<unsafe extern "C" fn(_: *mut c_void, _: *mut u8, _: u32, _: *mut c_void) -> i32>,
    pub on_lowlevel_init_done: Option<unsafe extern "C" fn(_: *mut c_void) -> i32>,
    pub on_lowlevel_deinit_done: Option<unsafe extern "C" fn(_: *mut c_void) -> i32>,
    pub read_phy_reg: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32, _: *mut u32) -> i32>,
    pub write_phy_reg: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32, _: u32) -> i32>,
}

@brief Configuration of Ethernet driver

Fields

mac: *mut esp_eth_mac_s

@brief Ethernet MAC object

phy: *mut esp_eth_phy_s

@brief Ethernet PHY object

check_link_period_ms: u32

@brief Period time of checking Ethernet link status

stack_input: Option<unsafe extern "C" fn(_: *mut c_void, _: *mut u8, _: u32, _: *mut c_void) -> i32>

@brief Input frame buffer to user’s stack

@param[in] eth_handle: handle of Ethernet driver @param[in] buffer: frame buffer that will get input to upper stack @param[in] length: length of the frame buffer

@return - ESP_OK: input frame buffer to upper stack successfully - ESP_FAIL: error occurred when inputting buffer to upper stack

on_lowlevel_init_done: Option<unsafe extern "C" fn(_: *mut c_void) -> i32>

@brief Callback function invoked when lowlevel initialization is finished

@param[in] eth_handle: handle of Ethernet driver

@return - ESP_OK: process extra lowlevel initialization successfully - ESP_FAIL: error occurred when processing extra lowlevel initialization

on_lowlevel_deinit_done: Option<unsafe extern "C" fn(_: *mut c_void) -> i32>

@brief Callback function invoked when lowlevel deinitialization is finished

@param[in] eth_handle: handle of Ethernet driver

@return - ESP_OK: process extra lowlevel deinitialization successfully - ESP_FAIL: error occurred when processing extra lowlevel deinitialization

read_phy_reg: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32, _: *mut u32) -> i32>

@brief Read PHY register

@note Usually the PHY register read/write function is provided by MAC (SMI interface), but if the PHY device is managed by other interface (e.g. I2C), then user needs to implement the corresponding read/write. Setting this to NULL means your PHY device is managed by MAC’s SMI interface.

@param[in] eth_handle: handle of Ethernet driver @param[in] phy_addr: PHY chip address (0~31) @param[in] phy_reg: PHY register index code @param[out] reg_value: PHY register value

@return - ESP_OK: read PHY register successfully - ESP_ERR_INVALID_ARG: read PHY register failed because of invalid argument - ESP_ERR_TIMEOUT: read PHY register failed because of timeout - ESP_FAIL: read PHY register failed because some other error occurred

write_phy_reg: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32, _: u32) -> i32>

@brief Write PHY register

@note Usually the PHY register read/write function is provided by MAC (SMI interface), but if the PHY device is managed by other interface (e.g. I2C), then user needs to implement the corresponding read/write. Setting this to NULL means your PHY device is managed by MAC’s SMI interface.

@param[in] eth_handle: handle of Ethernet driver @param[in] phy_addr: PHY chip address (0~31) @param[in] phy_reg: PHY register index code @param[in] reg_value: PHY register value

@return - ESP_OK: write PHY register successfully - ESP_ERR_INVALID_ARG: read PHY register failed because of invalid argument - ESP_ERR_TIMEOUT: write PHY register failed because of timeout - ESP_FAIL: write PHY register failed because some other error occurred

Trait Implementations

impl Clone for esp_eth_config_t

fn clone(&self) -> esp_eth_config_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for esp_eth_config_t

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for esp_eth_config_t

fn default() -> esp_eth_config_t

Returns the “default value” for a type.

impl Copy for esp_eth_config_t