CMSIS Driver  Version 1.10 - Preliminary
Middleware Driver API for microcontroller peripherals
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Ethernet PHY Interface

Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) More...

Data Structures

struct  ARM_DRIVER_ETH_PHY
 Access structure of the Ethernet PHY Driver. More...
 

Typedefs

typedef ARM_ETH_STATUS(* ARM_ETH_PHY_Read_t )(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)
 Pointer to ARM_ETH_MAC_PHY_Read : Read Ethernet PHY Register.
 
typedef ARM_ETH_STATUS(* ARM_ETH_PHY_Write_t )(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)
 Pointer to ARM_ETH_MAC_PHY_Write : Write Ethernet PHY Register.
 

Functions

ARM_DRV_VERSION ARM_ETH_PHY_GetVersion (void)
 Get driver version.
 
ARM_ETH_STATUS ARM_ETH_PHY_Initialize (ARM_ETH_PHY_Read_t fn_read, ARM_ETH_PHY_Write_t fn_write)
 Initialize Ethernet PHY Device.
 
ARM_ETH_STATUS ARM_ETH_PHY_Uninitialize (void)
 De-initialize Ethernet PHY Device.
 
ARM_ETH_STATUS ARM_ETH_PHY_PowerControl (ARM_POWER_STATE state)
 Control Ethernet PHY Device Power.
 
ARM_ETH_STATUS ARM_ETH_PHY_SetInterface (ARM_ETH_INTERFACE interface)
 Set Ethernet Media Interface.
 
ARM_ETH_STATUS ARM_ETH_PHY_SetMode (ARM_ETH_MODE mode)
 Set Ethernet PHY Device Operation mode.
 
ARM_ETH_LINK_STATE ARM_ETH_PHY_GetLinkState (void)
 Get Ethernet PHY Device Link state.
 
ARM_ETH_LINK_INFO ARM_ETH_PHY_GetLinkInfo (void)
 Get Ethernet PHY Device Link information.
 

Description

Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h)

The following section describes the Ethernet PHY Interface as defined in the Driver_ETH_PHY.h header file.


Data Structure Documentation

struct ARM_DRIVER_ETH_PHY

Access structure of the Ethernet PHY Driver.

The functions of the Ethernet PHY are accessed by function pointers exposed by this structure. Refer to Driver Functions for overview information.

Each instance of an Ethernet PHY provides such an access struct. The instance is identified by a postfix number in the symbol name of the access struct, for example:

  • ARM_Driver_ETH_PHY0 is the name of the access struct of the first instance (no. 0).
  • ARM_Driver_ETH_PHY1 is the name of the access struct of the second instance (no. 1).

A configuration setting in the middleware allows connecting the middleware to a specific driver instance ARM_Driver_ETH_PHYn. The default is 0, which connects a middleware to the first instance of a driver.

Data Fields

ARM_DRV_VERSION(* GetVersion )(void)
 Pointer to ARM_ETH_PHY_GetVersion : Get driver version.
 
ARM_ETH_STATUS(* Initialize )(ARM_ETH_PHY_Read_t fn_read, ARM_ETH_PHY_Write_t fn_write)
 Pointer to ARM_ETH_PHY_Initialize : Initialize PHY Device.
 
ARM_ETH_STATUS(* Uninitialize )(void)
 Pointer to ARM_ETH_PHY_Uninitialize : De-initialize PHY Device.
 
ARM_ETH_STATUS(* PowerControl )(ARM_POWER_STATE state)
 Pointer to ARM_ETH_PHY_PowerControl : Control PHY Device Power.
 
ARM_ETH_STATUS(* SetInterface )(ARM_ETH_INTERFACE interface)
 Pointer to ARM_ETH_PHY_SetInterface : Set Ethernet Media Interface.
 
ARM_ETH_STATUS(* SetMode )(ARM_ETH_MODE mode)
 Pointer to ARM_ETH_PHY_SetMode : Set Ethernet PHY Device Operation mode.
 
ARM_ETH_LINK_STATE(* GetLinkState )(void)
 Pointer to ARM_ETH_PHY_GetLinkState : Get Ethernet PHY Device Link state.
 
ARM_ETH_LINK_INFO(* GetLinkInfo )(void)
 Pointer to ARM_ETH_PHY_GetLinkInfo : Get Ethernet PHY Device Link information.
 

Field Documentation

ARM_ETH_LINK_INFO(* GetLinkInfo)(void)

Pointer to ARM_ETH_PHY_GetLinkInfo : Get Ethernet PHY Device Link information.

ARM_ETH_LINK_STATE(* GetLinkState)(void)

Pointer to ARM_ETH_PHY_GetLinkState : Get Ethernet PHY Device Link state.

ARM_DRV_VERSION(* GetVersion)(void)

Pointer to ARM_ETH_PHY_GetVersion : Get driver version.

ARM_ETH_STATUS(* Initialize)(ARM_ETH_PHY_Read_t fn_read, ARM_ETH_PHY_Write_t fn_write)

Pointer to ARM_ETH_PHY_Initialize : Initialize PHY Device.

ARM_ETH_STATUS(* PowerControl)(ARM_POWER_STATE state)

Pointer to ARM_ETH_PHY_PowerControl : Control PHY Device Power.

ARM_ETH_STATUS(* SetInterface)(ARM_ETH_INTERFACE interface)

Pointer to ARM_ETH_PHY_SetInterface : Set Ethernet Media Interface.

ARM_ETH_STATUS(* SetMode)(ARM_ETH_MODE mode)

Pointer to ARM_ETH_PHY_SetMode : Set Ethernet PHY Device Operation mode.

ARM_ETH_STATUS(* Uninitialize)(void)

Pointer to ARM_ETH_PHY_Uninitialize : De-initialize PHY Device.

Typedef Documentation

ARM_ETH_PHY_Read_t

Pointer to ARM_ETH_MAC_PHY_Read : Read Ethernet PHY Register.

Provides the typedef for the register read function ARM_ETH_MAC_PHY_Read.

Parameter for:

ARM_ETH_PHY_Write_t

Pointer to ARM_ETH_MAC_PHY_Write : Write Ethernet PHY Register.

Provides the typedef for the register write function ARM_ETH_MAC_PHY_Write.

Parameter for:

Function Documentation

ARM_ETH_LINK_INFO ARM_ETH_PHY_GetLinkInfo ( void  )

Get Ethernet PHY Device Link information.

Returns
current link parameters ARM_ETH_LINK_INFO

The function ARM_ETH_PHY_GetLinkInfo retrieves information about the current established communication mode (half/full duplex) and communication speed.

Example:

ARM_ETH_LINK_STATE ARM_ETH_PHY_GetLinkState ( void  )

Get Ethernet PHY Device Link state.

Returns
current link status ARM_ETH_LINK_STATE

The function ARM_ETH_PHY_GetLinkState retrieves the connection status of the physical Ethernet link.

Example:

ARM_DRV_VERSION ARM_ETH_PHY_GetVersion ( void  )

Get driver version.

Returns
ARM_DRV_VERSION

Returns version information of the driver implementation in ARM_DRV_VERSION

  • API version is the version of the CMSIS-Driver specification used to implement this driver.
  • Driver version is source code version of the actual driver implementation.

Example:

extern ARM_DRIVER_ETH_PHY ARM_Driver_ETH_PHY0;
void setup_ethernet_phy (void) {
ARM_DRV_VERSION version;
drv_info = &ARM_Driver_ETH_PHY0;
version = drv_info->GetVersion ();
if (version.api < 0x10A) { // requires at minimum API version 1.10 or higher
// error handling
return;
}
}
ARM_ETH_STATUS ARM_ETH_PHY_Initialize ( ARM_ETH_PHY_Read_t  fn_read,
ARM_ETH_PHY_Write_t  fn_write 
)

Initialize Ethernet PHY Device.

Parameters
[in]fn_readPointer to ARM_ETH_MAC_PHY_Read
[in]fn_writePointer to ARM_ETH_MAC_PHY_Write
Returns
execution status ARM_ETH_STATUS

The function ARM_ETH_PHY_Initialize starts the Ethernet PHY interface. It is called when the middleware component starts operation.

The ARM_ETH_PHY_Initialize function performs the following operations:

Example:

ARM_ETH_STATUS ARM_ETH_PHY_PowerControl ( ARM_POWER_STATE  state)

Control Ethernet PHY Device Power.

Parameters
[in]statePower state
Returns
execution status ARM_ETH_STATUS

Allows to control the power modes of the Ethernet PHY interface.

state can be:

  • ARM_POWER_OFF: Ethernet PHY peripheral is turned off.
  • ARM_POWER_FULL: Ethernet PHY peripheral is turned on and fully operational.
  • ARM_POWER_LOW: not available on an Ethernet PHY interface.

If state specifies an unsupported mode, the function returns ARM_ETH_ERROR_UNSUPPORTED.

Example:

ARM_ETH_STATUS ARM_ETH_PHY_SetInterface ( ARM_ETH_INTERFACE  interface)

Set Ethernet Media Interface.

Parameters
[in]interfaceARM_ETH_INTERFACE
Returns
execution status ARM_ETH_STATUS

The function ARM_ETH_PHY_SetInterface specifies the Media Independent Interface type that is used by the interface between Ethernet MAC and Ethernet PHY. The Media Independent Interface type is obtained by the function ARM_ETH_MAC_GetCapabilities.

Example:

ARM_ETH_STATUS ARM_ETH_PHY_SetMode ( ARM_ETH_MODE  mode)

Set Ethernet PHY Device Operation mode.

Parameters
[in]modeARM_ETH_MODE
Returns
execution status ARM_ETH_STATUS

The function ARM_ETH_PHY_SetMode defines the operation mode of the Ethernet PHY.

Example:

ARM_ETH_STATUS ARM_ETH_PHY_Uninitialize ( void  )

De-initialize Ethernet PHY Device.

Returns
execution status ARM_ETH_STATUS

The function ARM_ETH_PHY_Uninitialize de-initializes the resources of Ethernet PHY interface and sets the peripheral to ARM_POWER_OFF power mode.

It is called when the middleware component stops operation and releases the software resources used by the interface.