EMAC Class Reference

This interface should be used to abstract low level access to networking hardware All operations receive a void * hardware pointer which an EMAC device provides when it is registered with a stack. More...

#include <EMAC.h>

Inheritance diagram for EMAC:

Public Types
typedef mbed::Callback< void(emac_mem_buf_t *buf)>	emac_link_input_cb_t
	Callback to be register with EMAC interface and to be called for received packets.
typedef mbed::Callback< void(bool up)>	emac_link_state_change_cb_t
	Callback to be register with EMAC interface and to be called for link status changes.

Public Member Functions
virtual uint32_t	get_mtu_size () const =0
	Return maximum transmission unit.
virtual uint32_t	get_align_preference () const =0
	Gets memory buffer alignment preference.
virtual void	get_ifname (char *name, uint8_t size) const =0
	Return interface name.
virtual uint8_t	get_hwaddr_size () const =0
	Returns size of the underlying interface HW address size.
virtual bool	get_hwaddr (uint8_t *addr) const =0
	Return interface-supplied HW address.
virtual void	set_hwaddr (const uint8_t *addr)=0
	Set HW address for interface.
virtual bool	link_out (emac_mem_buf_t *buf)=0
	Sends the packet over the link.
virtual bool	power_up ()=0
	Initializes the HW.
virtual void	power_down ()=0
	Deinitializes the HW.
virtual void	set_link_input_cb (emac_link_input_cb_t input_cb)=0
	Sets a callback that needs to be called for packets received for this interface.
virtual void	set_link_state_cb (emac_link_state_change_cb_t state_cb)=0
	Sets a callback that needs to be called on link status changes for given interface.
virtual void	add_multicast_group (const uint8_t *address)=0
	Add device to a multicast group.
virtual void	remove_multicast_group (const uint8_t *address)=0
	Remove device from a multicast group.
virtual void	set_all_multicast (bool all)=0
	Request reception of all multicast packets.
virtual void	set_memory_manager (EMACMemoryManager &mem_mngr)=0
	Sets memory manager that is used to handle memory buffers.

Static Public Member Functions
static EMAC &	get_default_instance ()
	Return the default on-board EMAC.

Detailed Description

This interface should be used to abstract low level access to networking hardware All operations receive a void * hardware pointer which an EMAC device provides when it is registered with a stack.

Definition at line 33 of file EMAC.h.

Member Typedef Documentation

emac_link_input_cb_t

typedef mbed::Callback<void (emac_mem_buf_t *buf)> emac_link_input_cb_t

Callback to be register with EMAC interface and to be called for received packets.

buf : Received data

Definition at line 49 of file EMAC.h.

emac_link_state_change_cb_t

typedef mbed::Callback<void (bool up)> emac_link_state_change_cb_t

Callback to be register with EMAC interface and to be called for link status changes.

up : Link status

Definition at line 57 of file EMAC.h.

Member Function Documentation

get_default_instance()

static EMAC & get_default_instance ( )

static

Return the default on-board EMAC.

Returns the default on-board EMAC - this will be target-specific, and may not be available on all targets.

get_mtu_size()

virtual uint32_t get_mtu_size ( ) const

pure virtual

Return maximum transmission unit.

Returns

MTU in bytes

Implemented in EMW3080B_EMAC, and WICED_EMAC.

get_align_preference()

virtual uint32_t get_align_preference ( ) const

pure virtual

Gets memory buffer alignment preference.

Gets preferred memory buffer alignment of the EMAC device. IP stack may or may not align link out memory buffer chains using the alignment.

Returns

Memory alignment requirement in bytes

Implemented in EMW3080B_EMAC, and WICED_EMAC.

get_ifname()

virtual void get_ifname ( char *  name, uint8_t  size  ) const

pure virtual

Return interface name.

Parameters

name	Pointer to where the name should be written
size	Maximum number of character to copy

Implemented in EMW3080B_EMAC, and WICED_EMAC.

get_hwaddr_size()

virtual uint8_t get_hwaddr_size ( ) const

pure virtual

Returns size of the underlying interface HW address size.

Returns

HW address size in bytes

Implemented in EMW3080B_EMAC, and WICED_EMAC.

get_hwaddr()

virtual bool get_hwaddr ( uint8_t *  addr ) const

pure virtual

Return interface-supplied HW address.

Copies HW address to provided memory, addr has to be of correct size see get_hwaddr_size

HW address need not be provided if this interface does not have its own HW address configuration; stack will choose address from central system configuration if the function returns false and does not write to addr.

Parameters

addr	HW address for underlying interface

Returns

true if HW address is available

Implemented in EMW3080B_EMAC, and WICED_EMAC.

set_hwaddr()

virtual void set_hwaddr ( const uint8_t *  addr )

pure virtual

Set HW address for interface.

Provided address has to be of correct size, see get_hwaddr_size

Called to set the MAC address to actually use - if get_hwaddr is provided the stack would normally use that, but it could be overridden, for example for test purposes.

Parameters

addr	Address to be set

Implemented in EMW3080B_EMAC, and WICED_EMAC.

link_out()

virtual bool link_out ( emac_mem_buf_t *  buf )

pure virtual

Sends the packet over the link.

Will not be called from an interrupt context.

Parameters

buf	Packet to be sent. This packet is now owned by the MAC and must be freed in all cases.

Returns

True if the packet was sent successfully, False otherwise

Implemented in EMW3080B_EMAC, and WICED_EMAC.

power_up()

virtual bool power_up ( )

pure virtual

Initializes the HW.

Returns

True on success, False in case of an error.

Implemented in EMW3080B_EMAC, and WICED_EMAC.

power_down()

virtual void power_down ( )

pure virtual

Deinitializes the HW.

Implemented in EMW3080B_EMAC, and WICED_EMAC.

set_link_input_cb()

virtual void set_link_input_cb ( emac_link_input_cb_t  input_cb )

pure virtual

Sets a callback that needs to be called for packets received for this interface.

Note that the callback function will contain appropriate locking such that it may be called from any OS thread. However, it shall not be called from an interrupt.

Also note that the callback will take ownership of the passed packet and must free it in all cases.

Parameters

input_cb

Function to be registered as a callback

Implemented in EMW3080B_EMAC, and WICED_EMAC.

set_link_state_cb()

virtual void set_link_state_cb ( emac_link_state_change_cb_t  state_cb )

pure virtual

Sets a callback that needs to be called on link status changes for given interface.

Note that the callback function will contain appropriate locking such that it may be called from any OS thread. However, it shall not be called from an interrupt.

Parameters

state_cb

Function to be registered as a callback

Implemented in EMW3080B_EMAC, and WICED_EMAC.

add_multicast_group()

virtual void add_multicast_group ( const uint8_t *  address )

pure virtual

Add device to a multicast group.

Parameters

address

A multicast group hardware address

Note

The network stack will ensure that no two threads can call this function at the same time. It doesn't need locking at the MAC level.

Implemented in EMW3080B_EMAC, and WICED_EMAC.

remove_multicast_group()

virtual void remove_multicast_group ( const uint8_t *  address )

pure virtual

Remove device from a multicast group.

Parameters

address

A multicast group hardware address

Note

The network stack will ensure that no two threads can call this function at the same time. It doesn't need locking at the MAC level.

Implemented in EMW3080B_EMAC, and WICED_EMAC.

set_all_multicast()

virtual void set_all_multicast ( bool  all )

pure virtual

Request reception of all multicast packets.

Parameters

all	True to receive all multicasts False to receive only multicasts addressed to specified groups

Implemented in EMW3080B_EMAC, and WICED_EMAC.

set_memory_manager()

virtual void set_memory_manager ( EMACMemoryManager &  mem_mngr )

pure virtual

Sets memory manager that is used to handle memory buffers.

Parameters

mem_mngr

Pointer to memory manager

Implemented in EMW3080B_EMAC, and WICED_EMAC.