![]() |
dphy
Xilinx SDK Drivers API Documentation
|
Data Structures | |
| struct | XDphy_Config |
| The configuration structure for DPHY. More... | |
| struct | XDphy |
| The XDphy Controller driver instance data. More... | |
Macros | |
| #define | XDPHY_H_ |
| Prevent circular inclusions by using protection macros. More... | |
Functions | |
| u32 | XDphy_CfgInitialize (XDphy *InstancePtr, XDphy_Config *CfgPtr, UINTPTR EffectiveAddr) |
| Initialize the XDphy instance provided by the caller based on the given Config structure. More... | |
| u32 | XDphy_Configure (XDphy *InstancePtr, u8 Handle, u32 Value) |
| Configure the registers of the Dphy instance. More... | |
| u8 | XDphy_GetRegIntfcPresent (XDphy *InstancePtr) |
| Get if register interface is present from the config structure for specified DPHY instance. More... | |
| u32 | XDphy_GetInfo (XDphy *InstancePtr, u8 Handle) |
| Get information stored in the DPhy instance based on the handle passed. More... | |
| void | XDphy_Reset (XDphy *InstancePtr) |
| This is used to do a soft reset of the DPhy IP instance. More... | |
| void | XDphy_ClearDataLane (XDphy *InstancePtr, u8 DataLane, u32 Mask) |
| This is used to clear the Abort Error (Escape or High Speed) bits in the Data Lane 0 through 3. More... | |
| u32 | XDphy_GetClkLaneStatus (XDphy *InstancePtr) |
| This is used to get information about Clock Lane status. More... | |
| u32 | XDphy_GetClkLaneMode (XDphy *InstancePtr) |
| This is used to get specific Lane mode information about Clock Lane. More... | |
| u32 | XDphy_GetDataLaneStatus (XDphy *InstancePtr, u8 DataLane) |
| This is used to get information about a Data Lane status. More... | |
| u32 | XDphy_GetDataLaneMode (XDphy *InstancePtr, u8 DataLane) |
| This is used to get specfic Lane mode information about a Data Lane. More... | |
| u16 | XDphy_GetPacketCount (XDphy *InstancePtr, u8 DataLane) |
| This is used to get count of packets received on each lane. More... | |
| void | XDphy_Activate (XDphy *InstancePtr, u8 Flag) |
| This function is used to enable or disable the DPhy core. More... | |
| XDphy_Config * | XDphy_LookupConfig (u32 DeviceId) |
| Look up the hardware configuration for a device instance. More... | |
| u32 | XDphy_SelfTest (XDphy *InstancePtr) |
| Runs a self-test on the driver/device. More... | |
DPHY Modes | |
| #define | XDPHY_MODE_MIN 0 |
| Lower limit for Mode. More... | |
| #define | XDPHY_LOW_POWER_MODE 0 |
| Lane in Low Power Mode. More... | |
| #define | XDPHY_HIGH_POWER_MODE 1 |
| Lane in High Power Mode. More... | |
| #define | XDPHY_ESCAPE_MODE 2 |
| Lane in Escape Mode. More... | |
| #define | XDPHY_MODE_MAX 2 |
| Upper Limit for mode. More... | |
DPHY Info Handles | |
| #define | XDPHY_HANDLE_MIN 0 |
| Lower Bound for XDPHY_HANDLE. More... | |
| #define | XDPHY_HANDLE_IDELAY 0 |
| Handle for IDELAY Reg. More... | |
| #define | XDPHY_HANDLE_INIT_TIMER 1 |
| Handle for Initialization Timer. More... | |
| #define | XDPHY_HANDLE_WAKEUP 2 |
| Handle for Wakeup timer. More... | |
| #define | XDPHY_HANDLE_HSTIMEOUT 3 |
| Handle for HS Timeout. More... | |
| #define | XDPHY_HANDLE_ESCTIMEOUT 4 |
| Handle for Escape Timeout. More... | |
| #define | XDPHY_HANDLE_CLKLANE 5 |
| Handle for Clock Lane. More... | |
| #define | XDPHY_HANDLE_DLANE0 6 |
| Handle for Data Lane 0. More... | |
| #define | XDPHY_HANDLE_DLANE1 7 |
| Handle for Data Lane 1. More... | |
| #define | XDPHY_HANDLE_DLANE2 8 |
| Handle for Data Lane 2. More... | |
| #define | XDPHY_HANDLE_DLANE3 9 |
| Handle for Data Lane 3. More... | |
| #define | XDPHY_HANDLE_HSSETTLE 10 |
| Handle for HS SETTLE. More... | |
| #define | XDPHY_HANDLE_MAX 10 |
| Upper Bound for XDPHY_HANDLE. More... | |
DPHY HSTIMEOUT range | |
| #define | XDPHY_HS_TIMEOUT_MIN_VALUE 10000UL |
| #define | XDPHY_HS_TIMEOUT_MAX_VALUE 65541UL |
DPHY HSSETTLE range | |
| #define | XDPHY_HS_SETTLE_MAX_VALUE 0x1FF |
DPHY Flags to Enable or Disable core | |
| #define | XDPHY_ENABLE_FLAG 1 |
| #define | XDPHY_DISABLE_FLAG 0 |
| #define XDPHY_ESCAPE_MODE 2 |
#include <xdphy.h>
Lane in Escape Mode.
| #define XDPHY_H_ |
#include <xdphy.h>
Prevent circular inclusions by using protection macros.
| #define XDPHY_HANDLE_CLKLANE 5 |
#include <xdphy.h>
Handle for Clock Lane.
| #define XDPHY_HANDLE_DLANE0 6 |
#include <xdphy.h>
Handle for Data Lane 0.
| #define XDPHY_HANDLE_DLANE1 7 |
#include <xdphy.h>
Handle for Data Lane 1.
| #define XDPHY_HANDLE_DLANE2 8 |
#include <xdphy.h>
Handle for Data Lane 2.
| #define XDPHY_HANDLE_DLANE3 9 |
#include <xdphy.h>
Handle for Data Lane 3.
| #define XDPHY_HANDLE_ESCTIMEOUT 4 |
#include <xdphy.h>
Handle for Escape Timeout.
| #define XDPHY_HANDLE_HSSETTLE 10 |
#include <xdphy.h>
Handle for HS SETTLE.
| #define XDPHY_HANDLE_HSTIMEOUT 3 |
| #define XDPHY_HANDLE_IDELAY 0 |
| #define XDPHY_HANDLE_INIT_TIMER 1 |
#include <xdphy.h>
Handle for Initialization Timer.
| #define XDPHY_HANDLE_MAX 10 |
#include <xdphy.h>
Upper Bound for XDPHY_HANDLE.
Referenced by XDphy_Configure(), and XDphy_GetInfo().
| #define XDPHY_HANDLE_MIN 0 |
#include <xdphy.h>
Lower Bound for XDPHY_HANDLE.
| #define XDPHY_HANDLE_WAKEUP 2 |
#include <xdphy.h>
Handle for Wakeup timer.
| #define XDPHY_HIGH_POWER_MODE 1 |
#include <xdphy.h>
Lane in High Power Mode.
| #define XDPHY_LOW_POWER_MODE 0 |
#include <xdphy.h>
Lane in Low Power Mode.
| #define XDPHY_MODE_MAX 2 |
#include <xdphy.h>
Upper Limit for mode.
| #define XDPHY_MODE_MIN 0 |
#include <xdphy.h>
Lower limit for Mode.
| void XDphy_Activate | ( | XDphy * | InstancePtr, |
| u8 | Flag | ||
| ) |
| u32 XDphy_CfgInitialize | ( | XDphy * | InstancePtr, |
| XDphy_Config * | CfgPtr, | ||
| UINTPTR | EffectiveAddr | ||
| ) |
#include <xdphy.c>
Initialize the XDphy instance provided by the caller based on the given Config structure.
| InstancePtr | is the XDphy instance to operate on. |
| CfgPtr | is the device configuration structure containing information about a specific DPhy instance. |
| EffectiveAddr | is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used. |
References XDphy_Config::BaseAddr, XDphy::Config, and XDphy::IsReady.
Referenced by DphySelfTestExample().
| void XDphy_ClearDataLane | ( | XDphy * | InstancePtr, |
| u8 | DataLane, | ||
| u32 | Mask | ||
| ) |
| u32 XDphy_Configure | ( | XDphy * | InstancePtr, |
| u8 | Handle, | ||
| u32 | Value | ||
| ) |
#include <xdphy.c>
Configure the registers of the Dphy instance.
| InstancePtr | is the XDphy instance to operate on. |
| Handle | to one of the registers to be configured |
| Value | to be set for the particular Handle of the DPHY instance |
References XDphy::Config, XDphy_Config::IsRegisterPresent, XDPHY_HANDLE_IDELAY, XDPHY_HANDLE_MAX, XDPHY_HSEXIT_IDELAY_REG_READY_MASK, and XDPHY_HSEXIT_IDELAY_REG_TAP_MASK.
| u32 XDphy_GetClkLaneMode | ( | XDphy * | InstancePtr | ) |
| u32 XDphy_GetClkLaneStatus | ( | XDphy * | InstancePtr | ) |
| u32 XDphy_GetDataLaneMode | ( | XDphy * | InstancePtr, |
| u8 | DataLane | ||
| ) |
| u32 XDphy_GetDataLaneStatus | ( | XDphy * | InstancePtr, |
| u8 | DataLane | ||
| ) |
| u32 XDphy_GetInfo | ( | XDphy * | InstancePtr, |
| u8 | Handle | ||
| ) |
#include <xdphy.c>
Get information stored in the DPhy instance based on the handle passed.
| InstancePtr | is the XDphy instance to operate on. |
| Handle | to one of the registers to be configured |
References XDphy::Config, XDphy_Config::IsRegisterPresent, XDPHY_HANDLE_IDELAY, and XDPHY_HANDLE_MAX.
Referenced by XDphy_SelfTest().
| u16 XDphy_GetPacketCount | ( | XDphy * | InstancePtr, |
| u8 | DataLane | ||
| ) |
| u8 XDphy_GetRegIntfcPresent | ( | XDphy * | InstancePtr | ) |
#include <xdphy.c>
Get if register interface is present from the config structure for specified DPHY instance.
| InstancePtr | is the XDphy instance to operate on. |
References XDphy::Config, and XDphy_Config::IsRegisterPresent.
Referenced by DphySelfTestExample().
| XDphy_Config * XDphy_LookupConfig | ( | u32 | DeviceId | ) |
#include <xdphy.h>
Look up the hardware configuration for a device instance.
| DeviceId | is the unique device ID of the device to lookup for |
Referenced by DphySelfTestExample().
| void XDphy_Reset | ( | XDphy * | InstancePtr | ) |
| u32 XDphy_SelfTest | ( | XDphy * | InstancePtr | ) |
#include <xdphy.h>
Runs a self-test on the driver/device.
This test checks if HS Timeout value present in register matches the one from the generated file.
| InstancePtr | is a pointer to the XDphy instance. |
References XDphy::Config, XDphy_Config::HSTimeOut, XDphy_GetInfo(), and XDPHY_HANDLE_HSTIMEOUT.
Referenced by DphySelfTestExample().