cfa: xcfa.h File Reference

| cfa Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Data Structures | Macros | Typedefs | Functions
xcfa.h File Reference

## Data Structures
struct | XCfa_Config
| This typedef contains configuration information for the CFA core. More...
struct | XCfa
| The XCfa instance data structure. More...

## Macros
#define | XCFA_H_
| Prevent circular inclusions by using protection macros. More...
#define | XCfa_Enable(InstancePtr)
| This function macro enables the CFA core. More...
#define | XCfa_Disable(InstancePtr)
| This function macro disables the CFA core. More...
#define | XCfa_Start XCfa_Enable
| This function macro enables/starts the CFA core. More...
#define | XCfa_Stop XCfa_Disable
| This function macro disables/stops the CFA core. More...
#define | XCfa_RegUpdateEnable(InstancePtr)
| This function macro commits all the register value changes made so far by the software to the CFA core. More...
#define | XCfa_RegUpdateDisable(InstancePtr)
| This function macro prevents the CFA core from committing recent changes made so far by the software. More...
#define | XCfa_SyncReset(InstancePtr)
| This function macro resets a CFA core at the end of the frame being processed. More...
#define | XCfa_Reset(InstancePtr)
| This macro resets CFA core instance. More...
#define | XCfa_StatusGetPending(InstancePtr)
| This function macro returns the pending status of a CFA core. More...
#define | XCfa_IntrClear(InstancePtr, IntrType)
| This function macro clears/acknowledges pending interrupts of the CFA core. More...
#define | XCfa_IntrEnable(InstancePtr, IntrType)
| This function macro enables the given individual interrupt(s) on the CFA core. More...
#define | XCfa_IntrDisable(InstancePtr, IntrType)
| This function macro disables the given individual interrupt(s) on the CFA core by updating Irq_Enable register. More...
#define | XCfa_IntrGetPending(InstancePtr)
| This function macro returns the pending interrupts of the CFA core. More...
Active size range macros
#define | XCFA_VSIZE_FIRST 32
| Vertical Size starting value. More...
#define | XCFA_VSIZE_LAST 7680
| Vertical Size ending value. More...
#define | XCFA_HSIZE_FIRST 32
| Horizontal Size starting value. More...
#define | XCFA_HSIZE_LAST 7680
| Horizontal Size ending value. More...

## Typedefs
typedef void(* | XCfa_CallBack )(void *CallBackRef)
| Callback type for all interrupts except error interrupt. More...
typedef void(* | XCfa_ErrorCallBack )(void *CallBackRef, u32 ErrorMask)
| Callback type for error interrupt. More...

## Enumerations
Handler Types
enum | { XCFA_HANDLER_PROCSTART = 1, XCFA_HANDLER_FRAMEDONE, XCFA_HANDLER_ERROR }
| These constants specify different types of handlers and used to differentiate interrupt requests from core. More...
Bayer phase
enum | XCfa_BayerPhaseCombination { XCFA_RGRG_COMBINATION, XCFA_GRGR_COMBINATION, XCFA_GBGB_COMBINATION, XCFA_BGBG_COMBINATION }
| These constants specify Bayer phase combinations of the core. More...

## Functions
XCfa_Config * | XCfa_LookupConfig (u16 DeviceId)
| This function returns a reference to an XCfa_Config structure based on the unique device id, DeviceId. More...
int | XCfa_CfgInitialize (XCfa *InstancePtr, XCfa_Config *CfgPtr, u32 EffectiveAddr)
| This function initializes the CFA core. More...
void | XCfa_Setup (XCfa *InstancePtr)
| This function sets the input/output frame size in Active Size register and enables the register update. More...
void | XCfa_EnableDbgByPass (XCfa *InstancePtr)
| This sets the bypass bit of the control register to switch the core to bypass mode if debug is enabled in the CFA core. More...
int | XCfa_IsDbgByPassEnabled (XCfa *InstancePtr)
| This function gets the current status of the bypass setting of the CFA core. More...
void | XCfa_DisableDbgBypass (XCfa *InstancePtr)
| This function disables bypass mode of the CFA core. More...
void | XCfa_EnableDbgTestPattern (XCfa *InstancePtr)
| This function sets the test-pattern mode of the CFA core if debug features is enabled. More...
int | XCfa_IsDbgTestPatternEnabled (XCfa *InstancePtr)
| This function gets the test-pattern mode if debug feature is enabled. More...
void | XCfa_DisableDbgTestPattern (XCfa *InstancePtr)
| This function disables the test pattern mode of the CFA core. More...
u32 | XCfa_GetVersion (XCfa *InstancePtr)
| This function gets the Version of the CFA core. More...
u32 | XCfa_GetDbgFrameCount (XCfa *InstancePtr)
| This function gets number of frames processed since power-up or last time the core is reset. More...
u32 | XCfa_GetDbgLineCount (XCfa *InstancePtr)
| This function gets the number of lines processed since power-up or last time the core is reset. More...
u32 | XCfa_GetDbgPixelCount (XCfa *InstancePtr)
| This function gets the number of pixels processed since power-up or last time the core is reset. More...
void | XCfa_SetActiveSize (XCfa *InstancePtr, u16 HSize, u16 VSize)
| This function sets the active H/V sizes in the Active Size register. More...
void | XCfa_GetActiveSize (XCfa *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 | XCfa_SetBayerPhase (XCfa *InstancePtr, enum XCfa_BayerPhaseCombination BayerPhase)
| This function specify whether the starting position pixel(0,0) of the Bayer sampling grid is on a red-green or blue-green line and whether the first pixel is green or not. More...
u32 | XCfa_GetBayerPhase (XCfa *InstancePtr)
| This function gets the Bayer phase value combination from Bayer phase register. More...
int | XCfa_SelfTest (XCfa *InstancePtr)
| This function reads complete Version register of CFA core and compares with zero values as part of self test. More...
void | XCfa_IntrHandler (void *InstancePtr)
| This function is the interrupt handler for the CFA core. More...
int | XCfa_SetCallBack (XCfa *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)
| This routine installs an asynchronous callback function for the given HandlerType: More...