Struct esp_idf_sys::esp_eth_config_t

source ·
#[repr(C)]
pub struct esp_eth_config_t { pub mac: *mut esp_eth_mac_t, pub phy: *mut esp_eth_phy_t, pub check_link_period_ms: u32, pub stack_input: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t, buffer: *mut u8, length: u32, priv_: *mut c_void) -> esp_err_t>, pub on_lowlevel_init_done: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t) -> esp_err_t>, pub on_lowlevel_deinit_done: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t) -> esp_err_t>, pub read_phy_reg: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t, phy_addr: u32, phy_reg: u32, reg_value: *mut u32) -> esp_err_t>, pub write_phy_reg: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t, phy_addr: u32, phy_reg: u32, reg_value: u32) -> esp_err_t>, }
Expand description

@brief Configuration of Ethernet driver

Fields§

§mac: *mut esp_eth_mac_t

@brief Ethernet MAC object

§phy: *mut esp_eth_phy_t

@brief Ethernet PHY object

§check_link_period_ms: u32

@brief Period time of checking Ethernet link status

§stack_input: Option<unsafe extern "C" fn(eth_handle: esp_eth_handle_t, buffer: *mut u8, length: u32, priv_: *mut c_void) -> esp_err_t>

@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(eth_handle: esp_eth_handle_t) -> esp_err_t>

@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(eth_handle: esp_eth_handle_t) -> esp_err_t>

@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(eth_handle: esp_eth_handle_t, phy_addr: u32, phy_reg: u32, reg_value: *mut u32) -> esp_err_t>

@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(eth_handle: esp_eth_handle_t, phy_addr: u32, phy_reg: u32, reg_value: u32) -> esp_err_t>

@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§

source§

impl Clone for esp_eth_config_t

source§

fn clone(&self) -> esp_eth_config_t

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for esp_eth_config_t

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for esp_eth_config_t

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Copy for esp_eth_config_t

Auto Trait Implementations§

§

impl Freeze for esp_eth_config_t

§

impl RefUnwindSafe for esp_eth_config_t

§

impl !Send for esp_eth_config_t

§

impl !Sync for esp_eth_config_t

§

impl Unpin for esp_eth_config_t

§

impl UnwindSafe for esp_eth_config_t

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.