Jump to main content

##

# 1.2.5.8.5 Library Interface

Name | Description
--- | ---
Macros |
DRV_ETHPHY_CLIENTS_NUMBER | Selects the maximum number of clients.
DRV_ETHPHY_INDEX | Ethernet PHY static index selection.
DRV_ETHPHY_INSTANCES_NUMBER | Selects the maximum number of hardware instances that can be supported by the dynamic driver.
DRV_ETHPHY_PERIPHERAL_ID | Defines an override of the peripheral ID.
DRV_ETHPHY_NEG_DONE_TMO | Value of the PHY negotiation complete time out as per IEEE 802.3 spec.
DRV_ETHPHY_NEG_INIT_TMO | Value of the PHY negotiation initiation time out as per IEEE 802.3 spec.
DRV_ETHPHY_RESET_CLR_TMO | Value of the PHY Reset self clear time out as per IEEE 802.3 spec.
System Level Functions |
DRV_ETHPHY_Initialize | Initializes the Ethernet PHY driver.
DRV_ETHPHY_Deinitialize | Deinitializes the specified instance of the Ethernet PHY driver module.
DRV_ETHPHY_Reinitialize | Reinitializes the driver and refreshes any associated hardware settings.
DRV_ETHPHY_Status | Provides the current status of the Ethernet PHY driver module.
DRV_ETHPHY_Tasks | Maintains the driver's state machine and implements its ISR.
DRV_ETHPHY_Setup | Initializes Ethernet PHY configuration and set up procedure.
Client Level Functions |
DRV_ETHPHY_Open | Opens the specified Ethernet PHY driver instance and returns a handle to it.
DRV_ETHPHY_Close | Closes an opened instance of the Ethernet PHY driver.
DRV_ETHPHY_ClientStatus | Gets the current client-specific status the Ethernet PHY driver.
DRV_ETHPHY_Reset | Immediately resets the Ethernet PHY.
DRV_ETHPHY_ClientOperationAbort | Aborts a current client operation initiated by the Ethernet PHY driver.
DRV_ETHPHY_ClientOperationResult | Gets the result of a client operation initiated by the Ethernet PHY driver.
Vendor Functions |
DRV_ETHPHY_VendorDataGet | Returns the current value of the vendor data.
DRV_ETHPHY_VendorDataSet | Returns the current value of the vendor data.
DRV_ETHPHY_VendorSMIReadResultGet | Reads the result of a previous vendor initiated SMI read transfer with DRV_ETHPHY_VendorSMIReadStart.
DRV_ETHPHY_VendorSMIReadStart | Starts a vendor SMI read transfer. Data will be available with DRV_ETHPHY_VendorSMIReadResultGet.
DRV_ETHPHY_VendorSMIWriteStart | Starts a vendor SMI write transfer.
Other Functions |
DRV_ETHPHY_LinkStatusGet | Returns the current link status.
DRV_ETHPHY_PhyAddressGet | Returns the PHY address.
DRV_ETHPHY_HWConfigFlagsGet | Returns the current Ethernet PHY hardware MII/RMII and ALTERNATE/DEFAULT configuration flags.
DRV_ETHPHY_RestartNegotiation | Restarts auto-negotiation of the Ethernet PHY link.
DRV_ETHPHY_NegotiationIsComplete | Returns the results of a previously initiated Ethernet PHY negotiation.
DRV_ETHPHY_NegotiationResultGet | Returns the result of a completed negotiation.
Data Types and Constants |
DRV_ETHPHY_CLIENT_STATUS | Identifies the client-specific status of the Ethernet PHY driver.
DRV_ETHPHY_INIT | Contains all the data necessary to initialize the Ethernet PHY device.
DRV_ETHPHY_INDEX_0 | Ethernet PHY driver index definitions.
DRV_ETHPHY_INDEX_1 | This is macro DRV_ETHPHY_INDEX_1.
DRV_ETHPHY_INDEX_COUNT | Number of valid Ethernet PHY driver indices.
DRV_ETHPHY_NEGOTIATION_RESULT | Contains all the data necessary to get the Ethernet PHY negotiation result
DRV_ETHPHY_SETUP | Contains all the data necessary to set up the Ethernet PHY device.
DRV_ETHPHY_VENDOR_MDIX_CONFIGURE | Pointer to function that configures the MDIX mode for the Ethernet PHY.
DRV_ETHPHY_VENDOR_MII_CONFIGURE | Pointer to function to configure the Ethernet PHY in one of the MII/RMII operation modes.
DRV_ETHPHY_VENDOR_SMI_CLOCK_GET | Pointer to a function to return the SMI/MIIM maximum clock speed in Hz of the Ethernet PHY.
DRV_ETHPHY_OBJECT_BASE_TYPE | Identifies the base interface of a Ethernet PHY driver.
DRV_ETHPHY_CONFIG_FLAGS | Defines configuration options for the Ethernet PHY.
DRV_ETHPHY_LINK_STATUS | Defines the possible status flags of PHY Ethernet link.
DRV_ETHPHY_OBJECT | Identifies the interface of a Ethernet PHY vendor driver.
DRV_ETHPHY_OBJECT_BASE | Identifies the base interface of a Ethernet PHY driver.
DRV_ETHPHY_VENDOR_WOL_CONFIGURE | Pointer to a function to configure the PHY WOL functionality
_DRV_ETHPHY_CONFIG_H | This is macro _DRV_ETHPHY_CONFIG_H.
_DRV_ETHPHY_H | This is macro _DRV_ETHPHY_H.
DRV_ETHPHY_RESET_FUNCTION | Pointer to a function to perform an additional PHY reset
DRV_ETHPHY_RESULT | Defines the possible results of Ethernet operations that can succeed or fail
DRV_ETHPHY_INTERFACE_INDEX | Defines the index type for a PHY interface.
DRV_ETHPHY_INTERFACE_TYPE | Defines the type of interface a PHY supports.