scaler

This is the main header file of the Xilinx MVI Video Scaler device driver. The Scaler device converts a specified rectangular area of an input digital video image from one original sampling grid to a desired target sampling grid.

Video Scaler Device v3.00a features are as follows:

Target Clock Frequencies:
- S3ADSP(-4), S6(-2) Families: 150MHz
- V5(-1), V6(-1) Families: 225MHz
8, 10 or 12-bit video data supported
YC (4:2:2), YC (4:2:0), RGB (4:4:4) chroma formats supported
1080P/60 supported for 4:2:2 and 4:4:4 (RGB formats (not 4:2:0)
Serial or parallel options (single or multiple filter engines) available to suit high or low bandwidth requirements
Supports spatial resolutions up to 4096x4096
2-12 taps per dimension
Up to 16 user-loadable sets of 16-bit coefficients
Up to 64 phases per coefficient set
16-bit intermediate bitwidth
Programmable (dynamic) scaling factor in both H and V dimensions
- Max 12x resolution change either up or down ~V allows for conversion between QCIF and 1080p
- 24-bit input fixed point scaling factors: 4 bits integer, 20-bit fraction
Independent H and V scaling factors
Optional coefficient sharing between Y and C filter operations (where appropriate)
Optional coefficient sharing between H and V filter operations (where appropriate)
Programmable (dynamic) start phase (independent H, V start-phase values), range -0.99 to +0.99
Programmable (dynamic) subject area size
Programmable (dynamic) target area size
Coefficient set selectable during operation (eg on V-sync)
Coefficient range -2.0 to +1.99
3 Control interface options
- pCore, with drivers
- General Purpose Processor GPP
- Constant
Coefficient preload (via .coe file) functionality for all above modes.
Full EDK GUI for scaler customization under XPS
2 Video interface options
- Live video source
- Memory source
Interrupts

For a full description of Scaler features, please see the hardware spec.

An example is shipped with the driver to demonstrate how to use the APIs this driver provides to access and control the Video Scaler device.

Limitation

Function XScaler_CalcCoeffs() only calculates coefficient values if this driver is *NOT* used on Linux platform. In Linux case, the math library is not available in the kernel and this function only clears the coefficient buffer passed in.

 MODIFICATION HISTORY:

 Ver   Who    Date     Changes
 ----- ------ -------- -------------------------------------------------------
 1.00a xd     05/14/09 First release
 2.00a xd     12/14/09 Updated Doxygen document tags
 3.00a xd     07/29/10 Added core version & sharable coefficient bank
                       support
 6.0   adk    12/19/13 Updated as per the New Tcl API's
 7.0   adk    08/22/14 Removed XSCL_HANDLER_ERROR and XSCL_HANDLER_EVENT macros.
                       Removed ErrorCallBack and its ref ErrorRef from XScaler
                       structure.
                       Modified EventCallBack as CallBack and
                       EventRef as CallBackRef.
                       Modified XSCL_STSDONE to XSCL_STATUS_OFFSET,
                       XSCL_STS to XSCL_STATUS_OFFSET, XSCL_STSERR to
                       XSCL_ERROR_OFFSET.
                       Removed the following functional macros
                       XScaler_IntrGetPending,
                       XScaler_IntrEnableGlobal and XScaler_IntrDisableGlobal.
                       uncommented interrupt related macros.
                       Modified prototypes of the following functions by removing IntrType
                       parameter as there was only one interrupt :XScaler_IntrEnable,
                       XScaler_IntrDisable and XScaler_IntrClear.

                       Modifications from xscalar_hw.h file are:
                       Appended register offset macros with _OFFSET and
                       Bit definition with _MASK.
                       Provided backward compatibility for changed macros.
                       Defined the following macros XSCL_CTL_MEMRD_EN_MASK.
                       Modified XSCL_CTL_ENABLE to XSCL_CTL_SW_EN_MASK,
                       XSCL_RESET_RESET_MASK to XSCL_CTL_RESET_MASK,
                       XSCL_CTL_REGUPDATE to XSCL_CTL_RUE_MASK,
                       XSCL_STSDONE_DONE and XSCL_STS_COEF_W_RDY_MASK to
                       XSCL_IXR_COEF_W_RDY_MASK.
                       Added XSCL_ERR_*_MASK s.
                       Removed XSCL_GIER_GIE_MASK.
                       Removed following macros as they were not defined in
                       latest product guide(v 8.1):
                       XSCL_STSERR_CODE*_MASK, XSCL_IXR_OUTPUT_FRAME_DONE_MASK,
                       XSCL_IXR_COEF_FIFO_READY_MASK, XSCL_IXR_INPUT_ERROR_MASK
                       XSCL_IXR_COEF_WR_ERROR_MASK,
                       XSCL_IXR_REG_UPDATE_DONE_MASK,
                       XSCL_IXR_OUTPUT_ERROR_MASK, XSCL_IXR_EVENT_MASK,
                       XSCL_IXR_ERROR_MASK, XSCL_IXR_ALLINTR_MASK,
                       XSCL_HSF_INT_MASK, XSCL_VSF_INT_MASK,
                       XSCL_COEFFVALUE_BASE_SHIFT and XSCL_COEFVALUE_BASE_MASK.
                       Modified bits of the following macros:
                       XSCL_HSF_FRAC_MASK and XSCL_VSF_FRAC_MASK.

                       Modifications from xscalar.c file are:
                       Modified prototype of XScaler_GetVersion API.
                       and functionality of StubCallBack. Modified assert
                       conditions in functions XScaler_CfgInitialize,
                       XScaler_SetPhaseNum, XScaler_LoadCoeffBank.
                       Removed error callback from XScaler_CfgInitialize
                       function.
                       Uncommented XScaler_Reset in XScaler_CfgInitialize
                       function.

                       Modifications from file xscalar_coefs.c file are
                       Removed typedef unsigned short s16 as it was already
                       defined in xil_types.h.
                       Modified coefs_struct to Coefs_Struct.
                       Updated doxygen document tags.
                       XScaler_coef_table is made as a global variable.
                       Memory allocated was freed after usage.

                       Modifications from xscalar_intr.c file are
                       XScaler_IntrHandler and XScaler_SetCallBack APIs were
                       modified

                       Added XScaler_LookupConfig in xscalar_sinit.c file and