cresample: Cresample_v4_1

| cresample Xilinx SDK Drivers API Documentation

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

Data Structures | Macros | Typedefs | Functions
Cresample_v4_1

## Data Structures
struct | XCresample_Config
| This typedef contains configuration information for a Video device. More...
struct | XCresample
| The XCresample driver instance data structure. More...
struct | XHorizontal_Coeffs
| The XCoeffs is a structure contains predefined fixed coefficient values for Horizontal filter of two phases (phase 0 and phase 1). More...
struct | XVertical_Coeffs
| The XCoeffs is a structure contains predefined fixed coefficient values for Vertical filter of two phases (phase 0 and phase 1). More...

## Macros
#define | XCRESAMPLE_H_
| Prevent circular inclusions by using protection macros. More...
#define | XCresample_Enable(InstancePtr)
| This macro enables the Chroma Resampler core. More...
#define | XCresample_Disable(InstancePtr)
| This macro disables the Chroma Resampler core. More...
#define | XCresample_Start XCresample_Enable
| This macro enables/starts the Chroma Resampler core. More...
#define | XCresample_Stop XCresample_Disable
| This macro disables/stops the Chroma Resampler core. More...
#define | XCresample_RegUpdateEnable(InstancePtr)
| This macro commits all the register value changes made so far by the software to the Chroma Resampler core. More...
#define | XCresample_RegUpdateDisable(InstancePtr)
| This macro prevents the Chroma Resampler core from committing recent changes made so far by the software. More...
#define | XCresample_SyncReset(InstancePtr)
| This macro resets a Chroma Resampler core instance, but differs from XCresample_Reset() in that it automatically synchronizes to the SOF input of the core to prevent tearing. More...
#define | XCresample_Reset(InstancePtr)
| This macro resets the Chroma Resampler core. More...
#define | XCresample_IntrEnable(InstancePtr, IntrType)
| This macro enables individual interrupts of the Cresample core by updating the IRQ_ENABLE register. More...
#define | XCresample_IntrDisable(InstancePtr, IntrType)
| This macro disables individual interrupts of the Cresample core by updating the IRQ_ENABLE register. More...
#define | XCresample_StatusGetPending(InstancePtr)
| This macro returns the pending interrupt status of the Cresample core read from the Status register. More...
#define | XCresample_IntrGetPending(InstancePtr)
| This macro returns the pending interrupts of the Cresample core for the interrupts that have been enabled. More...
#define | XCresample_IntrClear(InstancePtr, IntrType)
| This macro clears/acknowledges pending interrupts of the Cresample core in the Status register. More...
#define | XCRESAMPLE_HW_H_
| Prevent circular inclusions by using protection macros. More...
#define | XCRE_ACTIVE_SIZE_OFFSET 0x0020
| Horizontal and vertical active frame size. More...
#define | XCRE_ENCODING_OFFSET 0x0028
| Frame encoding. More...
#define | XCRE_COEF00_HPHASE0_OFFSET 0x0100
| Coefficient 00 of horizontal phase 0 filter. More...
#define | XCRE_COEF01_HPHASE0_OFFSET 0x0104
| Coefficient 01 of horizontal phase 0 filter. More...
#define | XCRE_COEF02_HPHASE0_OFFSET 0x0108
| Coefficient 02 of horizontal phase 0 filter. More...
#define | XCRE_COEF03_HPHASE0_OFFSET 0x010C
| Coefficient 03 of horizontal phase 0 filter. More...
#define | XCRE_COEF04_HPHASE0_OFFSET 0x0110
| Coefficient 04 of horizontal phase 0 filter. More...
#define | XCRE_COEF05_HPHASE0_OFFSET 0x0114
| Coefficient 05 of horizontal phase 0 filter. More...
#define | XCRE_COEF06_HPHASE0_OFFSET 0x0118
| Coefficient 06 of horizontal phase 0 filter. More...
#define | XCRE_COEF07_HPHASE0_OFFSET 0x011C
| Coefficient 07 of horizontal phase 0 filter. More...
#define | XCRE_COEF08_HPHASE0_OFFSET 0x0120
| Coefficient 08 of horizontal phase 0 filter. More...
#define | XCRE_COEF09_HPHASE0_OFFSET 0x0124
| Coefficient 09 of horizontal phase 0 filter. More...
#define | XCRE_COEF10_HPHASE0_OFFSET 0x0128
| Coefficient 10 of horizontal phase 0 filter. More...
#define | XCRE_COEF11_HPHASE0_OFFSET 0x012C
| Coefficient 11 of horizontal phase 0 filter. More...
#define | XCRE_COEF12_HPHASE0_OFFSET 0x0130
| Coefficient 12 of horizontal phase 0 filter. More...
#define | XCRE_COEF13_HPHASE0_OFFSET 0x0134
| Coefficient 13 of horizontal phase 0 filter. More...
#define | XCRE_COEF14_HPHASE0_OFFSET 0x0138
| Coefficient 14 of horizontal phase 0 filter. More...
#define | XCRE_COEF15_HPHASE0_OFFSET 0x013C
| Coefficient 15 of horizontal phase 0 filter. More...
#define | XCRE_COEF16_HPHASE0_OFFSET 0x0140
| Coefficient 16 of horizontal phase 0 filter. More...
#define | XCRE_COEF17_HPHASE0_OFFSET 0x0144
| Coefficient 17 of horizontal phase 0 filter. More...
#define | XCRE_COEF18_HPHASE0_OFFSET 0x0148
| Coefficient 18 of horizontal phase 0 filter. More...
#define | XCRE_COEF19_HPHASE0_OFFSET 0x014C
| Coefficient 19 of horizontal phase 0 filter. More...
#define | XCRE_COEF20_HPHASE0_OFFSET 0x0150
| Coefficient 20 of horizontal phase 0 filter. More...
#define | XCRE_COEF21_HPHASE0_OFFSET 0x0154
| Coefficient 21 of horizontal phase 0 filter. More...
#define | XCRE_COEF22_HPHASE0_OFFSET 0x0158
| Coefficient 22 of horizontal phase 0 filter. More...
#define | XCRE_COEF23_HPHASE0_OFFSET 0x015C
| Coefficient 23 of horizontal phase 0 filter. More...
#define | XCRE_COEF00_HPHASE1_OFFSET 0x0160
| Coefficient 00 of horizontal phase 1 filter. More...
#define | XCRE_COEF01_HPHASE1_OFFSET 0x0164
| Coefficient 01 of horizontal phase 1 filter. More...
#define | XCRE_COEF02_HPHASE1_OFFSET 0x0168
| Coefficient 02 of horizontal phase 1 filter. More...
#define | XCRE_COEF03_HPHASE1_OFFSET 0x016C
| Coefficient 03 of horizontal phase 1 filter. More...
#define | XCRE_COEF04_HPHASE1_OFFSET 0x0170
| Coefficient 04 of horizontal phase 1 filter. More...
#define | XCRE_COEF05_HPHASE1_OFFSET 0x0174
| Coefficient 05 of horizontal phase 1 filter. More...
#define | XCRE_COEF06_HPHASE1_OFFSET 0x0178
| Coefficient 06 of horizontal phase 1 filter. More...
#define | XCRE_COEF07_HPHASE1_OFFSET 0x017C
| Coefficient 07 of horizontal phase 1 filter. More...
#define | XCRE_COEF08_HPHASE1_OFFSET 0x0180
| Coefficient 08 of horizontal phase 1 filter. More...
#define | XCRE_COEF09_HPHASE1_OFFSET 0x0184
| Coefficient 09 of horizontal phase 1 filter. More...
#define | XCRE_COEF10_HPHASE1_OFFSET 0x0188
| Coefficient 10 of horizontal phase 1 filter. More...
#define | XCRE_COEF11_HPHASE1_OFFSET 0x018C
| Coefficient 11 of horizontal phase 1 filter. More...
#define | XCRE_COEF12_HPHASE1_OFFSET 0x0190
| Coefficient 12 of horizontal phase 1 filter. More...
#define | XCRE_COEF13_HPHASE1_OFFSET 0x0194
| Coefficient 13 of horizontal phase 1 filter. More...
#define | XCRE_COEF14_HPHASE1_OFFSET 0x0198
| Coefficient 14 of horizontal phase 1 filter. More...
#define | XCRE_COEF15_HPHASE1_OFFSET 0x019C
| Coefficient 15 of horizontal phase 1 filter. More...
#define | XCRE_COEF16_HPHASE1_OFFSET 0x01A0
| Coefficient 16 of horizontal phase 1 filter. More...
#define | XCRE_COEF17_HPHASE1_OFFSET 0x01A4
| Coefficient 17 of horizontal phase 1 filter. More...
#define | XCRE_COEF18_HPHASE1_OFFSET 0x01A8
| Coefficient 18 of horizontal phase 1 filter. More...
#define | XCRE_COEF19_HPHASE1_OFFSET 0x01AC
| Coefficient 19 of horizontal phase 1 filter. More...
#define | XCRE_COEF20_HPHASE1_OFFSET 0x01B0
| Coefficient 20 of horizontal phase 1 filter. More...
#define | XCRE_COEF21_HPHASE1_OFFSET 0x01B4
| Coefficient 21 of horizontal phase 1 filter. More...
#define | XCRE_COEF22_HPHASE1_OFFSET 0x01B8
| Coefficient 22 of horizontal phase 1 filter. More...
#define | XCRE_COEF23_HPHASE1_OFFSET 0x01BC
| Coefficient 23 of horizontal phase 1 filter. More...
#define | XCRE_COEF00_VPHASE0_OFFSET 0x01C0
| Coefficient 00 of vertical phase 0 filter. More...
#define | XCRE_COEF01_VPHASE0_OFFSET 0x01C4
| Coefficient 01 of vertical phase 0 filter. More...
#define | XCRE_COEF02_VPHASE0_OFFSET 0x01C8
| Coefficient 02 of vertical phase 0 filter. More...
#define | XCRE_COEF03_VPHASE0_OFFSET 0x01CC
| Coefficient 03 of vertical phase 0 filter. More...
#define | XCRE_COEF04_VPHASE0_OFFSET 0x01D0
| Coefficient 04 of vertical phase 0 filter. More...
#define | XCRE_COEF05_VPHASE0_OFFSET 0x01D4
| Coefficient 05 of vertical phase 0 filter. More...
#define | XCRE_COEF06_VPHASE0_OFFSET 0x01D8
| Coefficient 06 of vertical phase 0 filter. More...
#define | XCRE_COEF07_VPHASE0_OFFSET 0x01DC
| Coefficient 07 of vertical phase 0 filter. More...
#define | XCRE_COEF00_VPHASE1_OFFSET 0x01E0
| Coefficient 00 of vertical phase 1 filter. More...
#define | XCRE_COEF01_VPHASE1_OFFSET 0x01E4
| Coefficient 01 of vertical phase 1 filter. More...
#define | XCRE_COEF02_VPHASE1_OFFSET 0x01E8
| Coefficient 02 of vertical phase 1 filter. More...
#define | XCRE_COEF03_VPHASE1_OFFSET 0x01EC
| Coefficient 03 of vertical phase 1 filter. More...
#define | XCRE_COEF04_VPHASE1_OFFSET 0x01F0
| Coefficient 04 of vertical phase 1 filter. More...
#define | XCRE_COEF05_VPHASE1_OFFSET 0x01F4
| Coefficient 05 of vertical phase 1 filter. More...
#define | XCRE_COEF06_VPHASE1_OFFSET 0x01F8
| Coefficient 06 of vertical phase 1 filter. More...
#define | XCRE_COEF07_VPHASE1_OFFSET 0x01FC
| Coefficient 07 of vertical phase 1 filter. More...

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

## Functions
int | XCresample_CfgInitialize (XCresample *InstancePtr, XCresample_Config *CfgPtr, u32 EffectiveAddr)
| This function initializes the Cresample core. More...
void | XCresample_EnableDbgByPass (XCresample *InstancePtr)
| This function enables the bypass mode by setting bypass bit of the Control register to switch the core to bypass mode if debug feature is enabled in the core. More...
int | XCresample_IsDbgByPassEnabled (XCresample *InstancePtr)
| This function returns the current bypass mode settings from Control register of the Chroma Resampler core. More...
void | XCresample_DisableDbgBypass (XCresample *InstancePtr)
| This function disables bypass mode of the Chroma Resampler core. More...
void | XCresample_EnableDbgTestPattern (XCresample *InstancePtr)
| This function enables the test-pattern mode if debug feature is enabled by setting test-pattern bit of the Control register of the Chroma Resampler core. More...
int | XCresample_IsDbgTestPatternEnabled (XCresample *InstancePtr)
| This function returns the test-pattern mode (enabled or not) from Control register of the Chroma Resampler core. More...
void | XCresample_DisableDbgTestPattern (XCresample *InstancePtr)
| This function disables debug test pattern mode in Control register of the Chroma Resampler core, if Debug feature is enabled. More...
u32 | XCresample_GetVersion (XCresample *InstancePtr)
| This function returns the version of the Chroma Resampler core. More...
u32 | XCresample_GetDbgFrameCount (XCresample *InstancePtr)
| This function returns the number of frames processed since power-up or last time the core is reset. More...
u32 | XCresample_GetDbgLineCount (XCresample *InstancePtr)
| This function returns the number of lines processed since power-up or last time the core is reset. More...
u32 | XCresample_GetDbgPixelCount (XCresample *InstancePtr)
| This function returns the number of pixels processed since power-up or last time the core is reset. More...
void | XCresample_SetActiveSize (XCresample *InstancePtr, u16 HSize, u16 VSize)
| This function sets the active H/V sizes in the Active Size register. More...
void | XCresample_GetActiveSize (XCresample *InstancePtr, u16 *HSize, u16 *VSize)
| This function gets the number of Active Pixels per Scan line and number of Active Lines per Frame from the Active Size register. More...
void | XCresample_SetFieldParity (XCresample *InstancePtr, u8 FieldParity)
| This functions sets the field parity value of the Chroma Resampler core in the Encoding register. More...
u8 | XCresample_GetFieldParity (XCresample *InstancePtr)
| This function returns the field parity value of the Chroma Resampler core from Encoding register. More...
void | XCresample_SetChromaParity (XCresample *InstancePtr, u8 ChromaParity)
| This functions sets the Chroma parity value of the Chroma Resampler core in the Encoding register. More...
u8 | XCresample_GetChromaParity (XCresample *InstancePtr)
| This function returns the value of chroma parity of the Chroma Resampler core from Encoding register. More...
void | XCresample_SetHCoefs (XCresample *InstancePtr, XHorizontal_Coeffs *Coeff, u32 Phases)
| This function sets the horizontal coefficient values of the Chroma Resampler core for phase 0 or phase 1 or both phases. More...
void | XCresample_GetHCoefs (XCresample *InstancePtr, XHorizontal_Coeffs *Coeff)
| This function gets the coefficient values from all the Horizontal Coefficient registers of phase0 and phase1 of the Chroma Resampler core. More...
void | XCresample_SetVCoefs (XCresample *InstancePtr, XVertical_Coeffs *Coeff, u32 Phases)
| This function sets the vertical coefficient values of the Chroma Resampler for phase 0 or for phase 1 or for both phases. More...
void | XCresample_GetVCoefs (XCresample *InstancePtr, XVertical_Coeffs *Coeff)
| This function gets the vertical coefficient values of the Chroma Resampler core from all Vertical Coefficient registers of phase0 and phase1. More...
void | XCresample_Clear_HCoef_Values (XCresample *InstancePtr)
| This function clears all horizontal coefficients of the Chroma Resampler core which are previously set. More...
void | XCresample_Clear_VCoef_Values (XCresample *InstancePtr)
| This function clears all vertical coefficients of a the Chroma Resampler which are previously set. More...
XCresample_Config * | XCresample_LookupConfig (u16 DeviceId)
| This function returns a reference to an XCresample_Config structure based on the unique device id, DeviceId. More...
int | XCresample_SelfTest (XCresample *InstancePtr)
| This function reads version register of Chroma Resampler core and compares with zero as part of self test. More...
int | XCresample_SetCallBack (XCresample *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)
| This routine installs an asynchronous callback function for the given HandlerType: More...
void | XCresample_IntrHandler (void *InstancePtr)
| This function is the interrupt handler for the Chroma Resampler driver. More...

## Interrupt types for setting up callbacks
enum | { XCRE_HANDLER_PROCSTART = 1, XCRE_HANDLER_FRAMEDONE, XCRE_HANDLER_ERROR }
| These constants specify different types of handler and used to differentiate interrupt requests from core. More...

## Active size ranges
#define | XCRE_ACT_SIZE_FIRST 32
| Active Size starting value. More...
#define | XCRE_ACT_SIZE_LAST 7680
| Active Size ending value. More...

## Parity valid values
#define | XCRE_PARITY_ODD 1
| For odd (or top) field it is 1. More...
#define | XCRE_PARITY_EVEN 0
| For even (or bottom) field it is 0. More...

## Coefficient ranges
#define | XCRE_COEF_FIRST -2.0
| Coefficient start value. More...
#define | XCRE_COEF_LAST 2.0
| Coefficient end value. More...
#define | XCRE_OFFSET_DIFF 4
| Coefficient offset difference. More...

## Number of phases
#define | XCRE_NUM_OF_PHASES 2
| Number of phases. More...

## Number of coefficients
#define | XCRE_NUM_HCOEFS 24
| Number of horizontal coefficients. More...
#define | XCRE_NUM_VCOEFS 8
| Number of vertical coefficients. More...

## register offsets
#define | XCRE_CONTROL_OFFSET 0x0000
| Control. More...
#define | XCRE_STATUS_OFFSET 0x0004
| Status. More...
#define | XCRE_ERROR_OFFSET 0x0008
| Error. More...
#define | XCRE_IRQ_EN_OFFSET 0x000C
| IRQ enable. More...
#define | XCRE_VERSION_OFFSET 0x0010
| Version. More...
#define | XCRE_SYSDEBUG0_OFFSET 0x0014
| System debug 0. More...
#define | XCRE_SYSDEBUG1_OFFSET 0x0018
| System debug 1. More...
#define | XCRE_SYSDEBUG2_OFFSET 0x001C
| System debug 2. More...

## Macro Definition Documentation

#define XCRE_ACT_SIZE_FIRST 32

Active Size starting value.

Referenced by XCresample_SetActiveSize().

#define XCRE_ACT_SIZE_LAST 7680

Active Size ending value.

Referenced by XCresample_SetActiveSize().

#define XCRE_ACTIVE_SIZE_OFFSET 0x0020

Horizontal and vertical active frame size.

Referenced by XCresample_GetActiveSize(), and XCresample_SetActiveSize().

#define XCRE_COEF00_HPHASE0_OFFSET 0x0100

Coefficient 00 of horizontal phase 0 filter.

Referenced by XCresample_Clear_HCoef_Values(), XCresample_GetHCoefs(), and XCresample_SetHCoefs().

#define XCRE_COEF00_HPHASE1_OFFSET 0x0160

Coefficient 00 of horizontal phase 1 filter.

Referenced by XCresample_SetHCoefs().

#define XCRE_COEF00_VPHASE0_OFFSET 0x01C0

Coefficient 00 of vertical phase 0 filter.

Referenced by XCresample_Clear_VCoef_Values(), XCresample_GetVCoefs(), and XCresample_SetVCoefs().

#define XCRE_COEF00_VPHASE1_OFFSET 0x01E0

Coefficient 00 of vertical phase 1 filter.

Referenced by XCresample_SetVCoefs().

#define XCRE_COEF01_HPHASE0_OFFSET 0x0104

Coefficient 01 of horizontal phase 0 filter.

#define XCRE_COEF01_HPHASE1_OFFSET 0x0164

Coefficient 01 of horizontal phase 1 filter.

#define XCRE_COEF01_VPHASE0_OFFSET 0x01C4

Coefficient 01 of vertical phase 0 filter.

#define XCRE_COEF01_VPHASE1_OFFSET 0x01E4

Coefficient 01 of vertical phase 1 filter.

#define XCRE_COEF02_HPHASE0_OFFSET 0x0108

Coefficient 02 of horizontal phase 0 filter.

#define XCRE_COEF02_HPHASE1_OFFSET 0x0168

Coefficient 02 of horizontal phase 1 filter.

#define XCRE_COEF02_VPHASE0_OFFSET 0x01C8

Coefficient 02 of vertical phase 0 filter.

#define XCRE_COEF02_VPHASE1_OFFSET 0x01E8

Coefficient 02 of vertical phase 1 filter.

#define XCRE_COEF03_HPHASE0_OFFSET 0x010C

Coefficient 03 of horizontal phase 0 filter.

#define XCRE_COEF03_HPHASE1_OFFSET 0x016C

Coefficient 03 of horizontal phase 1 filter.

#define XCRE_COEF03_VPHASE0_OFFSET 0x01CC

Coefficient 03 of vertical phase 0 filter.

#define XCRE_COEF03_VPHASE1_OFFSET 0x01EC

Coefficient 03 of vertical phase 1 filter.

#define XCRE_COEF04_HPHASE0_OFFSET 0x0110

Coefficient 04 of horizontal phase 0 filter.

#define XCRE_COEF04_HPHASE1_OFFSET 0x0170

Coefficient 04 of horizontal phase 1 filter.

#define XCRE_COEF04_VPHASE0_OFFSET 0x01D0

Coefficient 04 of vertical phase 0 filter.

#define XCRE_COEF04_VPHASE1_OFFSET 0x01F0

Coefficient 04 of vertical phase 1 filter.

#define XCRE_COEF05_HPHASE0_OFFSET 0x0114

Coefficient 05 of horizontal phase 0 filter.

#define XCRE_COEF05_HPHASE1_OFFSET 0x0174

Coefficient 05 of horizontal phase 1 filter.

#define XCRE_COEF05_VPHASE0_OFFSET 0x01D4

Coefficient 05 of vertical phase 0 filter.

#define XCRE_COEF05_VPHASE1_OFFSET 0x01F4

Coefficient 05 of vertical phase 1 filter.

#define XCRE_COEF06_HPHASE0_OFFSET 0x0118

Coefficient 06 of horizontal phase 0 filter.

#define XCRE_COEF06_HPHASE1_OFFSET 0x0178

Coefficient 06 of horizontal phase 1 filter.

#define XCRE_COEF06_VPHASE0_OFFSET 0x01D8

Coefficient 06 of vertical phase 0 filter.

#define XCRE_COEF06_VPHASE1_OFFSET 0x01F8

Coefficient 06 of vertical phase 1 filter.

#define XCRE_COEF07_HPHASE0_OFFSET 0x011C

Coefficient 07 of horizontal phase 0 filter.

#define XCRE_COEF07_HPHASE1_OFFSET 0x017C

Coefficient 07 of horizontal phase 1 filter.

#define XCRE_COEF07_VPHASE0_OFFSET 0x01DC

Coefficient 07 of vertical phase 0 filter.

#define XCRE_COEF07_VPHASE1_OFFSET 0x01FC

Coefficient 07 of vertical phase 1 filter.

#define XCRE_COEF08_HPHASE0_OFFSET 0x0120

Coefficient 08 of horizontal phase 0 filter.

#define XCRE_COEF08_HPHASE1_OFFSET 0x0180

Coefficient 08 of horizontal phase 1 filter.

#define XCRE_COEF09_HPHASE0_OFFSET 0x0124

Coefficient 09 of horizontal phase 0 filter.

#define XCRE_COEF09_HPHASE1_OFFSET 0x0184

Coefficient 09 of horizontal phase 1 filter.

#define XCRE_COEF10_HPHASE0_OFFSET 0x0128

Coefficient 10 of horizontal phase 0 filter.

#define XCRE_COEF10_HPHASE1_OFFSET 0x0188

Coefficient 10 of horizontal phase 1 filter.

#define XCRE_COEF11_HPHASE0_OFFSET 0x012C

Coefficient 11 of horizontal phase 0 filter.

#define XCRE_COEF11_HPHASE1_OFFSET 0x018C

Coefficient 11 of horizontal phase 1 filter.

#define XCRE_COEF12_HPHASE0_OFFSET 0x0130

Coefficient 12 of horizontal phase 0 filter.

#define XCRE_COEF12_HPHASE1_OFFSET 0x0190

Coefficient 12 of horizontal phase 1 filter.

#define XCRE_COEF13_HPHASE0_OFFSET 0x0134

Coefficient 13 of horizontal phase 0 filter.

#define XCRE_COEF13_HPHASE1_OFFSET 0x0194

Coefficient 13 of horizontal phase 1 filter.

#define XCRE_COEF14_HPHASE0_OFFSET 0x0138

Coefficient 14 of horizontal phase 0 filter.

#define XCRE_COEF14_HPHASE1_OFFSET 0x0198

Coefficient 14 of horizontal phase 1 filter.

#define XCRE_COEF15_HPHASE0_OFFSET 0x013C

Coefficient 15 of horizontal phase 0 filter.

#define XCRE_COEF15_HPHASE1_OFFSET 0x019C

Coefficient 15 of horizontal phase 1 filter.

#define XCRE_COEF16_HPHASE0_OFFSET 0x0140

Coefficient 16 of horizontal phase 0 filter.

#define XCRE_COEF16_HPHASE1_OFFSET 0x01A0

Coefficient 16 of horizontal phase 1 filter.

#define XCRE_COEF17_HPHASE0_OFFSET 0x0144

Coefficient 17 of horizontal phase 0 filter.

#define XCRE_COEF17_HPHASE1_OFFSET 0x01A4

Coefficient 17 of horizontal phase 1 filter.

#define XCRE_COEF18_HPHASE0_OFFSET 0x0148

Coefficient 18 of horizontal phase 0 filter.

#define XCRE_COEF18_HPHASE1_OFFSET 0x01A8

Coefficient 18 of horizontal phase 1 filter.

#define XCRE_COEF19_HPHASE0_OFFSET 0x014C

Coefficient 19 of horizontal phase 0 filter.

#define XCRE_COEF19_HPHASE1_OFFSET 0x01AC

Coefficient 19 of horizontal phase 1 filter.

#define XCRE_COEF20_HPHASE0_OFFSET 0x0150

Coefficient 20 of horizontal phase 0 filter.

#define XCRE_COEF20_HPHASE1_OFFSET 0x01B0

Coefficient 20 of horizontal phase 1 filter.

#define XCRE_COEF21_HPHASE0_OFFSET 0x0154

Coefficient 21 of horizontal phase 0 filter.

#define XCRE_COEF21_HPHASE1_OFFSET 0x01B4

Coefficient 21 of horizontal phase 1 filter.

#define XCRE_COEF22_HPHASE0_OFFSET 0x0158

Coefficient 22 of horizontal phase 0 filter.

#define XCRE_COEF22_HPHASE1_OFFSET 0x01B8

Coefficient 22 of horizontal phase 1 filter.

#define XCRE_COEF23_HPHASE0_OFFSET 0x015C

Coefficient 23 of horizontal phase 0 filter.

#define XCRE_COEF23_HPHASE1_OFFSET 0x01BC

Coefficient 23 of horizontal phase 1 filter.

#define XCRE_COEF_FIRST -2.0

Coefficient start value.

#define XCRE_COEF_LAST 2.0

Coefficient end value.

#define XCRE_CONTROL_OFFSET 0x0000

Control.

Referenced by XCresample_DisableDbgBypass(), XCresample_DisableDbgTestPattern(), XCresample_EnableDbgByPass(), XCresample_EnableDbgTestPattern(), XCresample_IsDbgByPassEnabled(), and XCresample_IsDbgTestPatternEnabled().

#define XCRE_ENCODING_OFFSET 0x0028

Frame encoding.

Referenced by XCresample_GetChromaParity(), XCresample_GetFieldParity(), XCresample_SetChromaParity(), and XCresample_SetFieldParity().

#define XCRE_ERROR_OFFSET 0x0008

Error.

#define XCRE_IRQ_EN_OFFSET 0x000C

IRQ enable.

#define XCRE_NUM_HCOEFS 24

Number of horizontal coefficients.

Referenced by XCresample_Clear_HCoef_Values(), and XCresample_GetHCoefs().

#define XCRE_NUM_OF_PHASES 2

Number of phases.

Referenced by XCresample_Clear_HCoef_Values(), XCresample_Clear_VCoef_Values(), XCresample_GetHCoefs(), XCresample_GetVCoefs(), XCresample_SetHCoefs(), and XCresample_SetVCoefs().

#define XCRE_NUM_VCOEFS 8

Number of vertical coefficients.

Referenced by XCresample_Clear_VCoef_Values(), and XCresample_GetVCoefs().

#define XCRE_OFFSET_DIFF 4

Coefficient offset difference.

Referenced by XCresample_Clear_HCoef_Values(), XCresample_Clear_VCoef_Values(), XCresample_GetHCoefs(), XCresample_GetVCoefs(), XCresample_SetHCoefs(), and XCresample_SetVCoefs().

#define XCRE_PARITY_EVEN 0

For even (or bottom) field it is 0.

Referenced by XCresample_SetChromaParity(), and XCresample_SetFieldParity().

#define XCRE_PARITY_ODD 1

For odd (or top) field it is 1.

Referenced by XCresample_SetChromaParity(), and XCresample_SetFieldParity().

#define XCRE_STATUS_OFFSET 0x0004

Status.

#define XCRE_SYSDEBUG0_OFFSET 0x0014

System debug 0.

Referenced by XCresample_GetDbgFrameCount().

#define XCRE_SYSDEBUG1_OFFSET 0x0018

System debug 1.

Referenced by XCresample_GetDbgLineCount().

#define XCRE_SYSDEBUG2_OFFSET 0x001C

System debug 2.

Referenced by XCresample_GetDbgPixelCount().

#define XCRE_VERSION_OFFSET 0x0010

Version.

Referenced by XCresample_GetVersion(), and XCresample_SelfTest().

#define XCresample_Disable | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET))) & (~(XCRE_CTL_SW_EN_MASK))))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_SW_EN_MASK
#define XCRE_CTL_SW_EN_MASK
Enable mask.
Definition: xcresample_hw.h:414

This macro disables the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_Disable(XCresample *InstancePtr)

#define XCresample_Enable | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET))) | (XCRE_CTL_SW_EN_MASK)))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_SW_EN_MASK
#define XCRE_CTL_SW_EN_MASK
Enable mask.
Definition: xcresample_hw.h:414

This macro enables the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_Enable(XCresample *InstancePtr)

#define XCRESAMPLE_H_

Prevent circular inclusions by using protection macros.

#define XCRESAMPLE_HW_H_

Prevent circular inclusions by using protection macros.

#define XCresample_IntrClear | ( |  | InstancePtr,
|  |  | IntrType
| ) |  |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_STATUS_OFFSET), \
((IntrType) & ((u32)(XCRE_IXR_ALLINTR_MASK))))
XCRE_STATUS_OFFSET
#define XCRE_STATUS_OFFSET
Status.
Definition: xcresample_hw.h:69
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_IXR_ALLINTR_MASK
#define XCRE_IXR_ALLINTR_MASK
OR of all mask.
Definition: xcresample_hw.h:435

This macro clears/acknowledges pending interrupts of the Cresample core in the Status register.

Bit positions of 1 will be cleared.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.
  IntrType | is the pending interrupts to clear/acknowledge. Use OR'ing of XCRE_IXR_*_MASK constants defined in xcresample_hw.h to create this parameter value.

Returns
  None

Note
  C-style signature: void XCresample_IntrClear(XCresample *InstancePtr, u32 IntrType)

Referenced by XCresample_IntrHandler().

#define XCresample_IntrDisable | ( |  | InstancePtr,
|  |  | IntrType
| ) |  |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_IRQ_EN_OFFSET), \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_IRQ_EN_OFFSET))) \
& ((~(IntrType)) & (XCRE_IXR_ALLINTR_MASK))))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_IXR_ALLINTR_MASK
#define XCRE_IXR_ALLINTR_MASK
OR of all mask.
Definition: xcresample_hw.h:435
XCRE_IRQ_EN_OFFSET
#define XCRE_IRQ_EN_OFFSET
IRQ enable.
Definition: xcresample_hw.h:71

This macro disables individual interrupts of the Cresample core by updating the IRQ_ENABLE register.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.
  IntrType | is the type of the interrupts to disable. Use OR'ing of XCRE_IXR_*_MASK constants defined in xcresample_hw.h to create this parameter value.

Returns
  None

Note
  Any other interrupt not covered by parameter IntrType, if enabled before this macro is called, will remain enabled. C-style signature: void XCresample_IntrDisable(XCresample *InstancePtr, u32 IntrType)

#define XCresample_IntrEnable | ( |  | InstancePtr,
|  |  | IntrType
| ) |  |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_IRQ_EN_OFFSET), \
(((IntrType) & (XCRE_IXR_ALLINTR_MASK)) | \
(XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_IRQ_EN_OFFSET)))))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_IXR_ALLINTR_MASK
#define XCRE_IXR_ALLINTR_MASK
OR of all mask.
Definition: xcresample_hw.h:435
XCRE_IRQ_EN_OFFSET
#define XCRE_IRQ_EN_OFFSET
IRQ enable.
Definition: xcresample_hw.h:71

This macro enables individual interrupts of the Cresample core by updating the IRQ_ENABLE register.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.
  IntrType | is the type of the interrupts to enable. Use OR'ing of XCRE_IXR_*_MASK constants defined in xcresample_hw.h to create this parameter value.

Returns
  None

Note
  The existing enabled interrupt(s) will remain enabled. C-style signature: void XCresample_IntrEnable(XCresample *InstancePtr, u32 IntrType)

#define XCresample_IntrGetPending | ( |  | InstancePtr | ) |

Value:
XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_IRQ_EN_OFFSET)) & \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_STATUS_OFFSET))) & ((u32)(XCRE_IXR_ALLINTR_MASK)))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCRE_STATUS_OFFSET
#define XCRE_STATUS_OFFSET
Status.
Definition: xcresample_hw.h:69
XCRE_IXR_ALLINTR_MASK
#define XCRE_IXR_ALLINTR_MASK
OR of all mask.
Definition: xcresample_hw.h:435
XCRE_IRQ_EN_OFFSET
#define XCRE_IRQ_EN_OFFSET
IRQ enable.
Definition: xcresample_hw.h:71

This macro returns the pending interrupts of the Cresample core for the interrupts that have been enabled.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  The pending interrupts of the Chroma Resampler. Use XCRE_IXR_*_MASK constants defined in xcresample_hw.h to interpret this value.

Note
  C-style signature: u32 XCresample_IntrGetPending(XCresample *InstancePtr)

Referenced by XCresample_IntrHandler().

#define XCresample_RegUpdateDisable | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET))) & (u32)(~(XCRE_CTL_RUE_MASK))))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_RUE_MASK
#define XCRE_CTL_RUE_MASK
Register update mask.
Definition: xcresample_hw.h:415

This macro prevents the Chroma Resampler core from committing recent changes made so far by the software.

When disabled, changes to other configuration registers are stored, but do not effect the behavior of the core.

This macro only works when the Chroma Resampler core is enabled.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_RegUpdateDisable(XCresample *InstancePtr)

#define XCresample_RegUpdateEnable | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), \
((XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET))) | (XCRE_CTL_RUE_MASK)))
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_RUE_MASK
#define XCRE_CTL_RUE_MASK
Register update mask.
Definition: xcresample_hw.h:415

This macro commits all the register value changes made so far by the software to the Chroma Resampler core.

This macro only works when the Chroma Resampler core is enabled.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_RegUpdateEnable(XCresample *InstancePtr)

#define XCresample_Reset | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), (XCRE_CTL_RESET_MASK))
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_RESET_MASK
#define XCRE_CTL_RESET_MASK
Software reset - instantaneous mask.
Definition: xcresample_hw.h:423

This macro resets the Chroma Resampler core.

This reset effects the core immediately, and may cause image tearing.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_Reset(XCresample *InstancePtr)

Referenced by XCresample_CfgInitialize().

#define XCresample_Start XCresample_Enable

This macro enables/starts the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_Start(XCresample *InstancePtr)

#define XCresample_StatusGetPending | ( |  | InstancePtr | ) |

Value:
XCresample_ReadReg((InstancePtr)->Config.BaseAddress, \
(XCRE_STATUS_OFFSET)) & (XCRE_IXR_ALLINTR_MASK)
XCresample_ReadReg
#define XCresample_ReadReg(BaseAddress, RegOffset)
This macro reads the given register.
Definition: xcresample_hw.h:658
XCRE_STATUS_OFFSET
#define XCRE_STATUS_OFFSET
Status.
Definition: xcresample_hw.h:69
XCRE_IXR_ALLINTR_MASK
#define XCRE_IXR_ALLINTR_MASK
OR of all mask.
Definition: xcresample_hw.h:435

This macro returns the pending interrupt status of the Cresample core read from the Status register.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  The pending interrupts of the Chroma Resampler. Use XCRE_IXR_*_MASK constants defined in xcresample_hw.h to interpret this value.

Note
  C-style signature: u32 XCresample_StatusGePending(XCresample *InstancePtr)

#define XCresample_Stop XCresample_Disable

This macro disables/stops the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_Stop(XCresample *InstancePtr)

#define XCresample_SyncReset | ( |  | InstancePtr | ) |

Value:
XCresample_WriteReg((InstancePtr)->Config.BaseAddress, \
(XCRE_CONTROL_OFFSET), (XCRE_CTL_AUTORESET_MASK))
XCresample_WriteReg
#define XCresample_WriteReg(BaseAddress, RegOffset, Data)
This macro writes into the given register.
Definition: xcresample_hw.h:679
XCRE_CONTROL_OFFSET
#define XCRE_CONTROL_OFFSET
Control.
Definition: xcresample_hw.h:68
XCRE_CTL_AUTORESET_MASK
#define XCRE_CTL_AUTORESET_MASK
Software reset - Auto-synchronize to SOF mask.
Definition: xcresample_hw.h:418

This macro resets a Chroma Resampler core instance, but differs from XCresample_Reset() in that it automatically synchronizes to the SOF input of the core to prevent tearing.

On the next raising edge of SOF following a call to XCresample_SyncReset(), all of the core's configuration registers and outputs will be reset, then the reset flag will be immediately released, allowing the core to immediately resume default operation.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  C-style signature: void XCresample_SyncReset(XCresample *InstancePtr)

## Typedef Documentation

typedef void(* XCresample_CallBack)(void *CallBackRef)

Callback type for all interrupts except error interrupt.

Parameters

  CallBackRef | is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.

typedef void(* XCresample_ErrorCallBack)(void *CallBackRef, u32 ErrorMask)

Callback type for Error interrupt.

Parameters

  CallBackRef | is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.
  ErrorMask | is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XCRE_IXR_* values defined in xcresample_hw.h

## Enumeration Type Documentation

anonymous enum

These constants specify different types of handler and used to differentiate interrupt requests from core.

Enumerator
XCRE_HANDLER_PROCSTART | A processing start event interrupt type.
XCRE_HANDLER_FRAMEDONE | A frame done event interrupt type.
XCRE_HANDLER_ERROR | An error condition interrupt type.

## Function Documentation

int XCresample_CfgInitialize | ( | XCresample * | InstancePtr,
|  | XCresample_Config * | CfgPtr,
|  | u32 | EffectiveAddr
| ) |  |

This function initializes the Cresample core.

This function must be called prior to using the Cresample core. Initialization of the Cresample includes setting up the instance data and ensuring the hardware is in a quiescent state.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  CfgPtr | is a reference to a structure containing information about a specific Chroma Resampler driver.
  EffectiveAddr | is the device base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, pass in the physical address instead.

Returns
  - XST_SUCCESS if initialization was successful.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample::ErrCallBack, XCresample::FrameDoneCallBack, XCresample::IsReady, XCresample::ProcStartCallBack, and XCresample_Reset.

Referenced by CresampleTypeConversion(), and XCresampleSelfTestExample().

void XCresample_Clear_HCoef_Values | ( | XCresample * | InstancePtr | ) |

This function clears all horizontal coefficients of the Chroma Resampler core which are previously set.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  None.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_COEF00_HPHASE0_OFFSET, XCRE_NUM_HCOEFS, XCRE_NUM_OF_PHASES, XCRE_OFFSET_DIFF, and XCresample_WriteReg.

Referenced by CresampleTypeConversion(), and XCresample_SetHCoefs().

void XCresample_Clear_VCoef_Values | ( | XCresample * | InstancePtr | ) |

This function clears all vertical coefficients of a the Chroma Resampler which are previously set.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  None.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_COEF00_VPHASE0_OFFSET, XCRE_NUM_OF_PHASES, XCRE_NUM_VCOEFS, XCRE_OFFSET_DIFF, and XCresample_WriteReg.

Referenced by CresampleTypeConversion(), and XCresample_SetVCoefs().

void XCresample_DisableDbgBypass | ( | XCresample * | InstancePtr | ) |

This function disables bypass mode of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_BPE_MASK, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_DisableDbgTestPattern | ( | XCresample * | InstancePtr | ) |

This function disables debug test pattern mode in Control register of the Chroma Resampler core, if Debug feature is enabled.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_TPE_MASK, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_EnableDbgByPass | ( | XCresample * | InstancePtr | ) |

This function enables the bypass mode by setting bypass bit of the Control register to switch the core to bypass mode if debug feature is enabled in the core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_BPE_MASK, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_EnableDbgTestPattern | ( | XCresample * | InstancePtr | ) |

This function enables the test-pattern mode if debug feature is enabled by setting test-pattern bit of the Control register of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  None.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_TPE_MASK, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_GetActiveSize | ( | XCresample * | InstancePtr,
|  | u16 * | HSize,
|  | u16 * | VSize
| ) |  |

This function gets the number of Active Pixels per Scan line and number of Active Lines per Frame from the Active Size register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  HSize | is a pointer to 16-bit variable in which the number of Active Pixels per Scan Line is returned (Range is 32 to 7680).
  VSize | is a pointer to 16-bit variable in which the number of Active Lines per Frame is returned (Range is 32 to 7680).

Returns
  None.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_ACTIVE_SIZE_OFFSET, XCRE_ACTSIZE_NUM_LINE_MASK, XCRE_ACTSIZE_NUM_LINE_SHIFT, XCRE_ACTSIZE_NUM_PIXEL_MASK, and XCresample_ReadReg.

u8 XCresample_GetChromaParity | ( | XCresample * | InstancePtr | ) |

This function returns the value of chroma parity of the Chroma Resampler core from Encoding register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  Chroma parity value is returned.
  - 0 - Chroma information on Odd or First line.
  - 1 - Chroma information on Even lines.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_ENCODING_CHROMA_MASK, XCRE_ENCODING_CHROMA_SHIFT, XCRE_ENCODING_OFFSET, and XCresample_ReadReg.

u32 XCresample_GetDbgFrameCount | ( | XCresample * | InstancePtr | ) |

This function returns the number of frames processed since power-up or last time the core is reset.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  FrameCount is the number of frames processed since power-up.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_SYSDEBUG0_OFFSET, and XCresample_ReadReg.

u32 XCresample_GetDbgLineCount | ( | XCresample * | InstancePtr | ) |

This function returns the number of lines processed since power-up or last time the core is reset.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  LineCount is the number of lines processed since power-up.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_SYSDEBUG1_OFFSET, and XCresample_ReadReg.

u32 XCresample_GetDbgPixelCount | ( | XCresample * | InstancePtr | ) |

This function returns the number of pixels processed since power-up or last time the core is reset.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  PixelCount is the number of pixels processed since power-up.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_SYSDEBUG2_OFFSET, and XCresample_ReadReg.

u8 XCresample_GetFieldParity | ( | XCresample * | InstancePtr | ) |

This function returns the field parity value of the Chroma Resampler core from Encoding register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  Field parity value is returned. 0 - for even or bottom field. 1 - for odd or top field.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_ENCODING_FIELD_MASK, XCRE_ENCODING_FIELD_SHIFT, XCRE_ENCODING_OFFSET, and XCresample_ReadReg.

void XCresample_GetHCoefs | ( | XCresample * | InstancePtr,
|  | XHorizontal_Coeffs * | Coeff
| ) |  |

This function gets the coefficient values from all the Horizontal Coefficient registers of phase0 and phase1 of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  Coeff | is a pointer to the structure XHorizontal_Coeffs which has horizontal coefficients of both phases.(Phase 0 and Phase 1) in which coefficients are updated. Range of coefficient values is [-2, 2).

Returns
  None.

Note
  For pre defined fixed coefficients filter values, ConvertType should be set with 1.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::ConvertType, XHorizontal_Coeffs::HCoeff, XCRE_COEF00_HPHASE0_OFFSET, XCRE_NUM_HCOEFS, XCRE_NUM_OF_PHASES, XCRE_OFFSET_DIFF, and XCresample_ReadReg.

void XCresample_GetVCoefs | ( | XCresample * | InstancePtr,
|  | XVertical_Coeffs * | Coeff
| ) |  |

This function gets the vertical coefficient values of the Chroma Resampler core from all Vertical Coefficient registers of phase0 and phase1.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  Coeff | is a pointer to the structure XVertical_Coeffs which has vertical coefficients of both phases.(Phase 0 and Phase 1) in which coefficients are updated. Range of coefficient values is [-2, 2).

Returns
  None.

Note
  For pre defined fixed coefficients filter values, ConvertType should be set with 1.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::ConvertType, XVertical_Coeffs::VCoeff, XCRE_COEF00_VPHASE0_OFFSET, XCRE_NUM_OF_PHASES, XCRE_NUM_VCOEFS, XCRE_OFFSET_DIFF, and XCresample_ReadReg.

u32 XCresample_GetVersion | ( | XCresample * | InstancePtr | ) |

This function returns the version of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  Content of Version register is returned..

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_VERSION_OFFSET, and XCresample_ReadReg.

void XCresample_IntrHandler | ( | void * | InstancePtr | ) |

This function is the interrupt handler for the Chroma Resampler driver.

This handler reads the pending interrupt from the STATUS register, determines the source of the interrupts and calls the respective callbacks for the interrupts that are enabled in IRQ_ENABLE register, and finally clears the interrupts.

The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using Xcresample_SetCallBack() during initialization phase.

Parameters

  InstancePtr | is a pointer to the XCresample instance that just interrupted.

Returns
  None.

Note
  Interrupt interface should be enabled.

References XCresample::Config, XCresample::ErrCallBack, XCresample::ErrRef, XCresample::FrameDoneCallBack, XCresample::FrameDoneRef, XCresample_Config::HasIntcIf, XCresample::IsReady, XCresample::ProcStartCallBack, XCresample::ProcStartRef, XCRE_IXR_EOF_MASK, XCRE_IXR_PROCS_STARTED_MASK, XCRE_IXR_SE_MASK, XCresample_IntrClear, and XCresample_IntrGetPending.

int XCresample_IsDbgByPassEnabled | ( | XCresample * | InstancePtr | ) |

This function returns the current bypass mode settings from Control register of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  Core debug bypass mode.
  - TRUE = Bypass mode is enabled.
  - FALSE = Bypass mode is not enabled.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_BPE_MASK, and XCresample_ReadReg.

int XCresample_IsDbgTestPatternEnabled | ( | XCresample * | InstancePtr | ) |

This function returns the test-pattern mode (enabled or not) from Control register of the Chroma Resampler core.

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.

Returns
  Test-pattern generator mode.
  - TRUE = Test-pattern mode is enabled.
  - FALSE = Test-pattern mode is not enabled.

Note
  Debug functionality should be enabled.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::HasDebug, XCRE_CONTROL_OFFSET, XCRE_CTL_TPE_MASK, and XCresample_ReadReg.

XCresample_Config * XCresample_LookupConfig | ( | u16 | DeviceId | ) |

This function returns a reference to an XCresample_Config structure based on the unique device id, DeviceId.

The return value will refer to an entry in the device configuration table defined in the xcresample_g.c file.

Parameters

  DeviceId | is the unique device ID of the device for the lookup operation.

Returns
  XCresample_LookupConfig returns a reference to a config record in the configuration table (in xcresample_g.c) corresponding to DeviceId, or NULL if no match is found.

Note
  None.

Referenced by CresampleTypeConversion(), and XCresampleSelfTestExample().

int XCresample_SelfTest | ( | XCresample * | InstancePtr | ) |

This function reads version register of Chroma Resampler core and compares with zero as part of self test.

Parameters

  InstancePtr | is a pointer to the XCresample instance.

Returns
  - XST_SUCCESS if the test is successful.
  - XST_FAILURE if the test is failed.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_VERSION_OFFSET, and XCresample_ReadReg.

Referenced by XCresampleSelfTestExample().

void XCresample_SetActiveSize | ( | XCresample * | InstancePtr,
|  | u16 | HSize,
|  | u16 | VSize
| ) |  |

This function sets the active H/V sizes in the Active Size register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  HSize | specifies the number of Active Pixels per Scan Line that needs to be set (Range is 32 to 7680).
  VSize | specifies the number of Active Lines per Frame that needs to be set (Range is 32 to 7680).

Returns
  None.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_ACT_SIZE_FIRST, XCRE_ACT_SIZE_LAST, XCRE_ACTIVE_SIZE_OFFSET, XCRE_ACTSIZE_NUM_LINE_SHIFT, and XCresample_WriteReg.

int XCresample_SetCallBack | ( | XCresample * | InstancePtr,
|  | u32 | HandlerType,
|  | void * | CallBackFunc,
|  | void * | CallBackRef
| ) |  |

This routine installs an asynchronous callback function for the given HandlerType:

    HandlerType              Callback Function Type
    -----------------------  --------------------------------------------------
    XCRE_HANDLER_FRAMEDONE   FrameDoneCallBack
    XCRE_HANDLER_PROCSTART   ProcStartCallBack
    XCRE_HANDLER_ERROR       ErrCallBack

Parameters

  InstancePtr | is a pointer to the XCresample instance to be worked on.
  HandlerType | specifies which callback is to be attached.
  CallBackFunc | is the address of the callback function.
  CallBackRef | is a user data item that will be passed to the callback function when it is invoked.

Returns
  - XST_SUCCESS when handler is installed.
  - XST_INVALID_PARAM when HandlerType is invalid.

Note
  Invoking this function for a handler that already has been installed replaces it with the new handler.

References XCresample::ErrCallBack, XCresample::ErrRef, XCresample::FrameDoneCallBack, XCresample::FrameDoneRef, XCresample::IsReady, XCresample::ProcStartCallBack, XCresample::ProcStartRef, XCRE_HANDLER_ERROR, XCRE_HANDLER_FRAMEDONE, and XCRE_HANDLER_PROCSTART.

void XCresample_SetChromaParity | ( | XCresample * | InstancePtr,
|  | u8 | ChromaParity
| ) |  |

This functions sets the Chroma parity value of the Chroma Resampler core in the Encoding register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  ChromaParity | specifies the parity value which needs to be set.(0 or 1). 0 - Chroma information on Odd or First line. 1 - Chroma information on Even lines.

Returns
  None.

Note
  None.

References XCresample_Config::BaseAddress, XCresample::Config, XCRE_ENCODING_CHROMA_MASK, XCRE_ENCODING_OFFSET, XCRE_PARITY_EVEN, XCRE_PARITY_ODD, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_SetFieldParity | ( | XCresample * | InstancePtr,
|  | u8 | FieldParity
| ) |  |

This functions sets the field parity value of the Chroma Resampler core in the Encoding register.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  FieldParity | specifies the parity value which needs to be set.(0 or 1). 0 - for even or bottom field. 1 - for odd or top field.

Returns
  None.

Note
  To this feature need to use interlaced video.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::Interlaced, XCRE_ENCODING_FIELD_MASK, XCRE_ENCODING_OFFSET, XCRE_PARITY_EVEN, XCRE_PARITY_ODD, XCresample_ReadReg, and XCresample_WriteReg.

void XCresample_SetHCoefs | ( | XCresample * | InstancePtr,
|  | XHorizontal_Coeffs * | Coeff,
|  | u32 | Phases
| ) |  |

This function sets the horizontal coefficient values of the Chroma Resampler core for phase 0 or phase 1 or both phases.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  Coeff | is a pointer to the structure XHorizontal_Coeffs which has horizontal coefficients of both phases (Phase 0 and Phase 1) which needs to be set. Range of coefficient values is [-2, 2).
  Phases | specifies number of phases needs to be set. 0 - Phase 0. 1 - Phase 1. 2 - Phase 0 and Phase 1.

Returns
  None.

Note
  For pre defined fixed coefficients filter values, ConvertType should be set with 1.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::ConvertType, XHorizontal_Coeffs::HCoeff, XCresample_Config::NumHTaps, XCRE_COEF00_HPHASE0_OFFSET, XCRE_COEF00_HPHASE1_OFFSET, XCRE_COEFF_MASK, XCRE_NUM_OF_PHASES, XCRE_OFFSET_DIFF, XCresample_Clear_HCoef_Values(), and XCresample_WriteReg.

Referenced by CresampleTypeConversion().

void XCresample_SetVCoefs | ( | XCresample * | InstancePtr,
|  | XVertical_Coeffs * | Coeff,
|  | u32 | Phases
| ) |  |

This function sets the vertical coefficient values of the Chroma Resampler for phase 0 or for phase 1 or for both phases.

Parameters

  InstancePtr | is a pointer to the XCresample instance.
  Coeff | is a pointer to the structure XHorizontal_Coeffs which has vertical coefficients of both phases (Phase 0 and Phase 1) which needs to be set.
  Phases | specifies number of phases needs to be set. 0 - Phase 0. 1 - Phase 1. 2 - Phase 0 and Phase 1.

Returns
  None.

Note
  For pre defined fixed coefficients filter values, ConvertType should be set with 1.

References XCresample_Config::BaseAddress, XCresample::Config, XCresample_Config::ConvertType, XCresample_Config::NumVTaps, XVertical_Coeffs::VCoeff, XCRE_COEF00_VPHASE0_OFFSET, XCRE_COEF00_VPHASE1_OFFSET, XCRE_COEFF_MASK, XCRE_NUM_OF_PHASES, XCRE_OFFSET_DIFF, XCresample_Clear_VCoef_Values(), and XCresample_WriteReg.

Referenced by CresampleTypeConversion().