CMSIS-Driver  
Peripheral Interface for Middleware and Application Code
 
Loading...
Searching...
No Matches
Ethernet Interface

Ethernet common definitions (Driver_ETH.h) More...

Content

 Media Interface Types
 Ethernet Media Interface type.
 
 Ethernet MAC Interface
 Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h)
 
 Ethernet PHY Interface
 Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h)
 

Data Structures

struct  ARM_ETH_MAC_ADDR
 Ethernet MAC Address. More...
 

Enumerations

enum  ARM_ETH_LINK_STATE {
  ARM_ETH_LINK_DOWN ,
  ARM_ETH_LINK_UP
}
 Ethernet link state. More...
 

Description

Ethernet common definitions (Driver_ETH.h)

Ethernet is a networking technology for exchanging data packages between computer systems. Several microcontrollers integrate an Ethernet MAC (Media Access Control) data-link layer that interfaces to an Ethernet PHY (Physical Interface Transceiver).

Wikipedia offers more information about the Ethernet.

Block Diagram

The Ethernet PHY connects typically to the Ethernet MAC using an MII (Media Independent Interface) or RMII (Reduced Media Independent Interface).


Block Diagram of a typical Ethernet Interface

Ethernet API

The following header files define the Application Programming Interface (API) for the Ethernet interface:

The driver implementation of the Ethernet MAC is a typical part of a Device Family Pack (DFP) that supports the peripherals of the microcontroller family. The driver implementation of the Ethernet PHY is a typical part of a Network Software Pack, since PHY is typically not integrated into the microcontroller.

Note
For parameters, the value marked with (default) is the setting after the driver initialization.

Driver Functions

The driver functions are published in the access struct as explained in Common Driver Functions

Both drivers are used in combination and usually the Ethernet MAC provides a media interface to the Ethernet PHY. A typical setup sequence for the drivers is shown below:

Example Code

The following example code shows the usage of the Ethernet interface.

extern ARM_DRIVER_ETH_MAC Driver_ETH_MAC0;
extern ARM_DRIVER_ETH_PHY Driver_ETH_PHY0;
static ARM_DRIVER_ETH_MAC *mac;
static ARM_DRIVER_ETH_PHY *phy;
static ARM_ETH_MAC_ADDR own_mac_address;
static ARM_ETH_MAC_CAPABILITIES capabilities;
void ethernet_mac_notify (uint32_t event) {
switch (event) {
:
}
}
void initialize_ethernet_interface (void) {
mac = &Driver_ETH_MAC0;
phy = &Driver_ETH_PHY0;
// Initialize Media Access Controller
capabilities = mac->GetCapabilities ();
mac->Initialize (ethernet_mac_notify);
if (capabilities.mac_address == 0) {
// populate own_mac_address with the address to use
mac->SetMacAddress(&own_mac_address);
}
else {
mac->GetMacAddress(&own_mac_address);
}
// Initialize Physical Media Interface
if (phy->Initialize (mac->PHY_Read, mac->PHY_Write) == ARM_DRIVER_OK) {
phy->SetInterface (capabilities.media_interface);
}
:
:
}
static ARM_ETH_LINK_STATE ethernet_link; // current link status
void ethernet_check_link_status (void) {
link = phy->GetLinkState ();
if (link == ethernet_link) {
return; // link state unchanged
}
// link state changed
ethernet_link = link;
if (link == ARM_ETH_LINK_UP) { // start transfer
}
else { // stop transfer
}
}
@ ARM_POWER_FULL
Power on: full operation at maximum performance.
Definition: Driver_Common.h:66
@ ARM_ETH_LINK_UP
Link is up.
Definition: Driver_ETH.h:68
#define ARM_ETH_MAC_DUPLEX_Pos
Definition: Driver_ETH_MAC.h:86
#define ARM_ETH_MAC_SPEED_Pos
Definition: Driver_ETH_MAC.h:81
uint32_t speed
Link speed: 0= 10 MBit, 1= 100 MBit, 2= 1 GBit.
Definition: Driver_ETH.h:75
uint32_t duplex
Duplex mode: 0= Half, 1= Full.
Definition: Driver_ETH.h:76
ARM_ETH_LINK_STATE
Ethernet link state.
Definition: Driver_ETH.h:66
Ethernet MAC Address.
Definition: Driver_ETH.h:83
#define ARM_ETH_MAC_ADDRESS_BROADCAST
Accept frames with Broadcast address.
#define ARM_ETH_MAC_CONTROL_TX
Transmitter; arg: 0=disabled (default), 1=enabled.
#define ARM_ETH_MAC_FLUSH
Flush buffer; arg = ARM_ETH_MAC_FLUSH_...
#define ARM_ETH_MAC_CONFIGURE
Configure MAC; arg = configuration.
#define ARM_ETH_MAC_CONTROL_RX
Receiver; arg: 0=disabled (default), 1=enabled.
#define ARM_ETH_MAC_FLUSH_TX
Flush Transmit buffer.
#define ARM_ETH_MAC_FLUSH_RX
Flush Receive buffer.
int32_t(* PowerControl)(ARM_POWER_STATE state)
Pointer to ARM_ETH_MAC_PowerControl : Control Ethernet MAC Device Power.
Definition: Driver_ETH_MAC.h:290
int32_t(* GetMacAddress)(ARM_ETH_MAC_ADDR *ptr_addr)
Pointer to ARM_ETH_MAC_GetMacAddress : Get Ethernet MAC Address.
Definition: Driver_ETH_MAC.h:291
uint32_t media_interface
Ethernet Media Interface type.
Definition: Driver_ETH_MAC.h:272
int32_t(* PHY_Write)(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)
Pointer to ARM_ETH_MAC_PHY_Write : Write Ethernet PHY Register through Management Interface.
Definition: Driver_ETH_MAC.h:302
int32_t(* Control)(uint32_t control, uint32_t arg)
Pointer to ARM_ETH_MAC_Control : Control Ethernet Interface.
Definition: Driver_ETH_MAC.h:300
ARM_ETH_MAC_CAPABILITIES(* GetCapabilities)(void)
Pointer to ARM_ETH_MAC_GetCapabilities : Get driver capabilities.
Definition: Driver_ETH_MAC.h:287
uint32_t mac_address
1 = driver provides initial valid MAC address
Definition: Driver_ETH_MAC.h:273
int32_t(* SetMacAddress)(const ARM_ETH_MAC_ADDR *ptr_addr)
Pointer to ARM_ETH_MAC_SetMacAddress : Set Ethernet MAC Address.
Definition: Driver_ETH_MAC.h:292
int32_t(* PHY_Read)(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)
Pointer to ARM_ETH_MAC_PHY_Read : Read Ethernet PHY Register through Management Interface.
Definition: Driver_ETH_MAC.h:301
int32_t(* Initialize)(ARM_ETH_MAC_SignalEvent_t cb_event)
Pointer to ARM_ETH_MAC_Initialize : Initialize Ethernet MAC Device.
Definition: Driver_ETH_MAC.h:288
Access structure of the Ethernet MAC Driver.
Definition: Driver_ETH_MAC.h:285
Ethernet MAC Capabilities.
Definition: Driver_ETH_MAC.h:261
int32_t(* Initialize)(ARM_ETH_PHY_Read_t fn_read, ARM_ETH_PHY_Write_t fn_write)
Pointer to ARM_ETH_PHY_Initialize : Initialize PHY Device.
Definition: Driver_ETH_PHY.h:129
int32_t(* SetMode)(uint32_t mode)
Pointer to ARM_ETH_PHY_SetMode : Set Ethernet PHY Device Operation mode.
Definition: Driver_ETH_PHY.h:134
int32_t(* PowerControl)(ARM_POWER_STATE state)
Pointer to ARM_ETH_PHY_PowerControl : Control PHY Device Power.
Definition: Driver_ETH_PHY.h:132
ARM_ETH_LINK_INFO(* GetLinkInfo)(void)
Pointer to ARM_ETH_PHY_GetLinkInfo : Get Ethernet PHY Device Link information.
Definition: Driver_ETH_PHY.h:136
int32_t(* SetInterface)(uint32_t interface)
Pointer to ARM_ETH_PHY_SetInterface : Set Ethernet Media Interface.
Definition: Driver_ETH_PHY.h:133
ARM_ETH_LINK_STATE(* GetLinkState)(void)
Pointer to ARM_ETH_PHY_GetLinkState : Get Ethernet PHY Device Link state.
Definition: Driver_ETH_PHY.h:135
Access structure of the Ethernet PHY Driver.
Definition: Driver_ETH_PHY.h:127
#define ARM_ETH_PHY_AUTO_NEGOTIATE
Auto Negotiation mode.
#define ARM_DRIVER_OK
Operation succeeded.

Data Structure Documentation

◆ ARM_ETH_LINK_INFO

struct ARM_ETH_LINK_INFO

Ethernet link information.

The Ethernet Link information provides parameters about the current established communication.

Returned by:

Data Fields
uint32_t speed: 2 Link speed: 0= 10 MBit, 1= 100 MBit, 2= 1 GBit.
uint32_t duplex: 1 Duplex mode: 0= Half, 1= Full.
uint32_t reserved: 29

◆ ARM_ETH_MAC_ADDR

struct ARM_ETH_MAC_ADDR

Ethernet MAC Address.

Stores the MAC Address of the Ethernet interface as defined by IEEE 802. Wikipedia offers more information about the MAC Address.

Parameter for:

Data Fields
uint8_t b[6] MAC Address (6 bytes), MSB first.

Enumeration Type Documentation

◆ ARM_ETH_LINK_STATE

Ethernet link state.

The Ethernet Link status shows if the communication is currently established (up) or interrupted (down).

Returned by:

Enumerator
ARM_ETH_LINK_DOWN 

Link is down.

ARM_ETH_LINK_UP 

Link is up.