enhance
Xilinx SDK Drivers API Documentation
xenhance.h File Reference

Data Structures

struct  XEnhance_Config
 This typedef contains configuration information for a Video Enhance core. More...
 
struct  XEnhance
 The Enhance driver instance data structure. More...
 

Macros

#define XENHANCE_H_
 Prevent circular inclusions by using protection macros. More...
 
#define XEnhance_Enable(InstancePtr)
 This function macro enables the Image Enhancement core instance. More...
 
#define XEnhance_Disable(InstancePtr)
 This function macro disables the Image Enhancement core instance. More...
 
#define XEnhance_Start   XEnhance_Enable
 This function macro starts the Image Enhancement core instance. More...
 
#define XEnhance_Stop   XEnhance_Disable
 This function macro stops the Image Enhancement core instance. More...
 
#define XEnhance_RegUpdateEnable(InstancePtr)
 This function macro commits all the register value changes made so far by the software to the Image Enhancement core instance. More...
 
#define XEnhance_RegUpdateDisable(InstancePtr)
 This function macro prevents the Image Enhancement core instance from committing recent changes made so far by the software. More...
 
#define XEnhance_SyncReset(InstancePtr)
 This function macro resets a Image Enhancement core instance, but differs from XEnhance_Reset() in that it automatically synchronizes to the SOF input of the core to prevent tearing. More...
 
#define XEnhance_Reset(InstancePtr)
 This function macro resets a Image Enhancement core instance. More...
 
#define XEnhance_StatusGetPending(InstancePtr)
 This function macro returns the pending status of a Enhance core. More...
 
#define XEnhance_IntrClear(InstancePtr, IntrType)
 This function macro clears/acknowledges pending interrupts of a Enhance core. More...
 
#define XEnhance_IntrEnable(InstancePtr, IntrType)
 This function macro enables the given individual interrupt(s) on the Enhance core. More...
 
#define XEnhance_IntrDisable(InstancePtr, IntrType)
 This function macro disables the given individual interrupt(s) on the Enhance core by updating Irq_Enable register. More...
 
#define XEnhance_IntrGetPending(InstancePtr)
 This function macro returns the pending interrupts of a Enhance core. More...
 
Active size range macros
#define XENH_VSIZE_FIRST   32
 Vertical Size starting value. More...
 
#define XENH_VSIZE_LAST   7680
 Vertical Size ending value. More...
 
#define XENH_HSIZE_FIRST   32
 Horizontal Size starting value. More...
 
#define XENH_HSIZE_LAST   7680
 Horizontal Size ending value. More...
 
Noise threshold range macros
#define XENH_NOISETHRES_MIN   0
 Noise threshold starting value. More...
 
#define XENH_NOISETHRES_MAX   255
 Noise threshold ending value. More...
 
Strength range macros
#define XENH_ENHSTRENGTH_MIN   0
 Strength starting value. More...
 
#define XENH_ENHSTRENGTH_MAX   32768
 Strength ending value. More...
 
Halo Suppress range macros
#define XENH_HALOSUPPRESS_MIN   0
 Halo Suppress starting value. More...
 
#define XENH_HALOSUPPRESS_MAX   32768
 Halo Suppress ending value. More...
 

Typedefs

typedef void(* XEnhance_CallBack )(void *CallBackRef)
 Callback type for all interrupts except error interrupt. More...
 
typedef void(* XEnhance_ErrorCallBack )(void *CallBackRef, u32 ErrorMask)
 Callback type for Error interrupt. More...
 

Enumerations

Handler Types
enum  { XENH_HANDLER_PROCSTART = 1, XENH_HANDLER_FRAMEDONE, XENH_HANDLER_ERROR }
 These constants specify different types of handlers and used to differentiate interrupt requests from core. More...
 

Functions

int XEnhance_CfgInitialize (XEnhance *InstancePtr, XEnhance_Config *CfgPtr, u32 EffectiveAddr)
 This function initializes a Enhance core. More...
 
void XEnhance_Setup (XEnhance *InstancePtr)
 This function sets the input/output frame size in Active Size register and enables the register update. More...
 
void XEnhance_EnableDbgByPass (XEnhance *InstancePtr)
 This sets the bypass bit of the control register to switch the core to bypass mode if debug is enabled in the Enhance core. More...
 
int XEnhance_IsDbgByPassEnabled (XEnhance *InstancePtr)
 This function gets the current status of the bypass setting of the Enhance core. More...
 
void XEnhance_DisableDbgBypass (XEnhance *InstancePtr)
 This function disables Bypass mode of the Enhance core. More...
 
void XEnhance_EnableDbgTestPattern (XEnhance *InstancePtr)
 This function sets the test-pattern mode of the Enhance core if debug features is enabled. More...
 
int XEnhance_IsDbgTestPatternEnabled (XEnhance *InstancePtr)
 This function gets the test-pattern mode if debug feature is enabled. More...
 
void XEnhance_DisableDbgTestPattern (XEnhance *InstancePtr)
 This function disables the test Pattern mode of the Enhance core. More...
 
u32 XEnhance_GetVersion (XEnhance *InstancePtr)
 This function returns the contents of Version register. More...
 
u32 XEnhance_GetDbgFrameCount (XEnhance *InstancePtr)
 This function gets number of frames processed since power-up or last time the core is reset. More...
 
u32 XEnhance_GetDbgLineCount (XEnhance *InstancePtr)
 This function gets the number of lines processed since power-up or last time the core is reset. More...
 
u32 XEnhance_GetDbgPixelCount (XEnhance *InstancePtr)
 This function gets the number of pixels processed since power-up or last time the core is reset. More...
 
void XEnhance_SetActiveSize (XEnhance *InstancePtr, u16 HSize, u16 VSize)
 This function sets active H/V sizes in the Active size register. More...
 
void XEnhance_GetActiveSize (XEnhance *InstancePtr, u16 *HSize, u16 *VSize)
 This function gets the number of Active Pixel per Scan line and number of Active Lines per Frame from the Active Frame Size register. More...
 
void XEnhance_SetNoiseThreshold (XEnhance *InstancePtr, u32 Threshold)
 This function sets the Noise Threshold value for the Enhance core The amount of noise reduction can be controlled through Noise Threshold parameter. More...
 
u32 XEnhance_GetNoiseThreshold (XEnhance *InstancePtr)
 This function gets the Noise Threshold value for the Enhance core. More...
 
void XEnhance_SetEdgeStrength (XEnhance *InstancePtr, u32 Strength)
 This function sets the Edge Strength value for the Enhance core. More...
 
u32 XEnhance_GetEdgeStrength (XEnhance *InstancePtr)
 This function gets the Edge Strength value for the Enhance core. More...
 
void XEnhance_SetHaloSuppress (XEnhance *InstancePtr, u32 Suppress)
 This function sets the Halo Suppress value for the Enhance core. More...
 
u32 XEnhance_GetHaloSuppress (XEnhance *InstancePtr)
 This function gets the Halo Suppress value for the Enhance core. More...
 
XEnhance_ConfigXEnhance_LookupConfig (u16 DeviceId)
 This function returns a reference to an XEnhance_Config structure based on the unique device id, DeviceId. More...
 
int XEnhance_SelfTest (XEnhance *InstancePtr)
 This function reads complete Version register of Enhance core and compares with zero values as part of self test. More...
 
void XEnhance_IntrHandler (void *InstancePtr)
 This function is the interrupt handler for the Enhance driver. More...
 
int XEnhance_SetCallBack (XEnhance *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)
 This routine installs an asynchronous callback function for the given HandlerType: More...