dual_splitter: xdualsplitter.h File Reference

| dual_splitter Xilinx SDK Drivers API Documentation

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

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

## Data Structures
struct | XDualSplitter_Config
| This typedef contains configuration information for the Dual Splitter core. More...
struct | XDualSplitter
| The XDualSplitter driver instance data. More...

## Macros
#define | XDUALSPLITTER_H_
| Prevent circular inclusions by using protection macros. More...
#define | XDUSP_MAX_INPUT_SAMPLES 4
| Maximum input samples per clock. More...
#define | XDUSP_MAX_OUTPUT_SAMPLES 4
| Maximum output samples per clock. More...
#define | XDUSP_MAX_SEGMENTS 4
| Maximum number of segments in an image. More...
#define | XDUSP_MAX_IMG_WIDTH 3840
| Maximum image width. More...
#define | XDUSP_MAX_IMG_HEIGHT 2160
| Maximum image height. More...
#define | XDualSplitter_RegUpdateEnable(InstancePtr)
| This macro commits all the register value changes made so far by the software to the Dual Splitter core. More...
#define | XDualSplitter_RegUpdateDisable(InstancePtr)
| This macro prevents the Dual Splitter core from committing recent changes made so far by the software. More...
#define | XDualSplitter_Enable(InstancePtr)
| This macro enables the Dual Splitter core. More...
#define | XDualSplitter_Disable(InstancePtr)
| This macro disables the Dual Splitter core. More...
#define | XDualSplitter_IntrEnable(InstancePtr, IntrType)
| This macro enables the given individual interrupt(s) on the Dual Splitter core. More...
#define | XDualSplitter_IntrDisable(InstancePtr, IntrType)
| This macro disables the given individual interrupt(s) on the Dual Splitter core. More...
#define | XDualSplitter_IntrGetPending(InstancePtr)
| This macro returns the pending interrupts of the Dual Splitter core. More...
#define | XDualSplitter_IntrClear(InstancePtr, IntrType)
| This macro clears/acknowledges pending interrupts of the Dual Splitter core. More...

## Typedefs
typedef void(* | XDualSplitter_ErrCallback )(void *CallbackRef, u32 ErrorMask)
| Callback type for error interrupt. More...

## Functions
XDualSplitter_Config * | XDualSplitter_LookupConfig (u16 DeviceId)
| This function returns a reference to the XDualSplitter_Config structure based on the core id, DeviceId. More...
s32 | XDualSplitter_CfgInitialize (XDualSplitter *InstancePtr, XDualSplitter_Config *CfgPtr, u32 EffectiveAddr)
| This function initializes the Dual Splitter core. More...
void | XDualSplitter_Reset (XDualSplitter *InstancePtr)
| This function resets the Dual Splitter core instance. More...
void | XDualSplitter_SetImageSize (XDualSplitter *InstancePtr, u16 Height, u16 Width)
| This function sets the image size (width x height) of the Dual Splitter core. More...
void | XDualSplitter_GetImageSize (XDualSplitter *InstancePtr, u16 *Height, u16 *Width)
| This function gets the image size (width x height) of the Dual Splitter core. More...
void | XDualSplitter_SetImgParam (XDualSplitter *InstancePtr, u8 InputSamples, u8 OutputSamples, u8 ImageSegments, u8 Overlap)
| This function sets the image parameters to split into multiple segments. More...
void | XDualSplitter_GetImgParam (XDualSplitter *InstancePtr, u8 *InputSamples, u8 *OutputSamples, u8 *ImageSegments, u8 *Overlap)
| This function gets the image parameters of the Dual Splitter core. More...
s32 | XDualSplitter_SelfTest (XDualSplitter *InstancePtr)
| This function performs self test on DualSplitter core registers. More...
void | XDualSplitter_IntrHandler (void *InstancePtr)
| This function is the interrupt handler for the Dual Splitter core. More...
void | XDualSplitter_SetCallback (XDualSplitter *InstancePtr, void *CallbackFunc, void *CallbackRef)
| This function installs an asynchronous callback function. More...