diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/annotated.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/annotated.html index 4ab2a166..17f93cac 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/annotated.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/annotated.html @@ -9,7 +9,7 @@ Software Drivers
- +

Class List

Here are the classes, structs, unions and interfaces with brief descriptions: + diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/files.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/files.html index 50d0f8f2..f7939d07 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/files.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/files.html @@ -9,7 +9,7 @@ Software Drivers
- +
-

File List

Here is a list of all documented files with brief descriptions:
coefs_struct
XScaler
XScaler_Config
XScalerAperture
+

File List

Here is a list of all files with brief descriptions:
+ diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions.html index df4d9567..0ddc6475 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions.html @@ -9,7 +9,7 @@ Software Drivers
- +
-
- -
- +Here is a list of all class members with links to the classes they belong to:

-Here is a list of all documented class members with links to the class documentation for each member: -

-

- b -

Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions_vars.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions_vars.html index b211297c..904c8f91 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions_vars.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/functions_vars.html @@ -9,7 +9,7 @@ Software Drivers
- +
-
- -
- -

 

-

- b -

Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals.html index 6ee71f41..b6fcb3e4 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals.html @@ -9,7 +9,7 @@ Software Drivers
- +

-Here is a list of all documented file members with links to the documentation: +Here is a list of all file members with links to the files they belong to:

-

- i -

- p -

+: xscaler_coefs.c

- r -

+: xscaler.c +

- s -

- x -

+
  • XScaler_AllocCoefsBuff() +: xscaler_coefs.c
  • XScaler_CallBack +: xscaler.h
  • XScaler_CfgInitialize() +: xscaler.h, xscaler.c
  • XScaler_CheckDone +: xscaler.h
  • XScaler_coef_table +: xscaler_coefs.c
  • XScaler_CoefficientBinScalingFactors +: xscaler_coefs.c, xscaler.c
  • XScaler_CoeffLoadReady +: xscaler.h
  • XScaler_CoefPhaseOffset +: xscaler.h
  • XScaler_CoefTapOffset +: xscaler.h
  • XScaler_CoefValueLookup() +: xscaler.h, xscaler.c
  • XScaler_ConfigTable +: xscaler_g.c
  • XScaler_Disable +: xscaler.h
  • XScaler_DisableRegUpdate +: xscaler.h
  • XScaler_Enable +: xscaler.h
  • XScaler_EnableRegUpdate +: xscaler.h
  • XScaler_GenCoefTable() +: xscaler_coefs.c, xscaler.c
  • XScaler_GetActiveCoeffSet() +: xscaler.h, xscaler.c
  • XScaler_GetAperture() +: xscaler.h, xscaler.c
  • XScaler_GetCoeffBankSharingInfo() +: xscaler.h, xscaler.c
  • XScaler_GetError +: xscaler.h
  • XScaler_GetLanczosCoeffs() +: xscaler_coefs.c
  • XScaler_GetPhaseNum() +: xscaler.h, xscaler.c
  • XScaler_GetStartFraction() +: xscaler.h, xscaler.c
  • XScaler_GetVersion() +: xscaler.h, xscaler.c
  • XSCALER_H +: xscaler.h
  • XSCALER_HW_H +: xscaler_hw.h
  • XScaler_In32 +: xscaler_hw.h
  • XScaler_IntrClear +: xscaler.h
  • XScaler_IntrDisable +: xscaler.h
  • XScaler_IntrEnable +: xscaler.h
  • XScaler_IntrHandler() +: xscaler_intr.c, xscaler.h
  • XScaler_IsEnabled +: xscaler.h
  • XScaler_IsResetDone +: xscaler.h
  • XScaler_Lanczos() +: xscaler_coefs.c
  • XScaler_LoadCoeffBank() +: xscaler.h, xscaler.c
  • XScaler_LookupConfig() +: xscaler_sinit.c, xscaler.h
  • XScaler_Out32 +: xscaler_hw.h
  • XScaler_ReadReg +: xscaler_hw.h
  • XScaler_Reset +: xscaler.h
  • XScaler_SetActiveCoeffSet() +: xscaler.h, xscaler.c
  • XScaler_SetAperture() +: xscaler.h, xscaler.c
  • XScaler_SetCallBack() +: xscaler_intr.c, xscaler.h
  • XScaler_SetPhaseNum() +: xscaler.h, xscaler.c
  • XScaler_SetStartFraction() +: xscaler.h, xscaler.c
  • XScaler_Sine() +: xscaler_coefs.c
  • XScaler_TriangularNumber +: xscaler.h
  • XScaler_WriteReg +: xscaler_hw.h
  • XSCL_APTHORI +: xscaler_hw.h
  • XSCL_APTHORI_FIRSTPXL_MASK +: xscaler_hw.h
  • XSCL_APTHORI_LASTPXL_MASK +: xscaler_hw.h
  • XSCL_APTHORI_LASTPXL_SHIFT +: xscaler_hw.h
  • XSCL_APTHORI_OFFSET +: xscaler_hw.h
  • XSCL_APTVERT +: xscaler_hw.h
  • XSCL_APTVERT_FIRSTLINE_MASK +: xscaler_hw.h
  • XSCL_APTVERT_LASTLINE_MASK +: xscaler_hw.h
  • XSCL_APTVERT_LASTLINE_SHIFT +: xscaler_hw.h
  • XSCL_APTVERT_OFFSET +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_420 +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_422 +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_444 +: xscaler_hw.h
  • XSCL_COEF_BIN_SIZE +: xscaler.h
  • XSCL_COEFF_MEM +: xscaler_hw.h
  • XSCL_COEFF_MEM_OFFSET +: xscaler_hw.h
  • XSCL_COEFF_PRECISION +: xscaler.h
  • XSCL_COEFF_SELECT_BANK_MASK +: xscaler_hw.h
  • XSCL_COEFF_SELECT_SET_MASK +: xscaler_hw.h
  • XSCL_COEFF_SET_BANK +: xscaler_hw.h
  • XSCL_COEFF_SET_BANK_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETADDR +: xscaler_hw.h
  • XSCL_COEFFSETADDR_ADDR_MASK +: xscaler_hw.h
  • XSCL_COEFFSETADDR_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETS +: xscaler_hw.h
  • XSCL_COEFFSETS_HORI_MASK +: xscaler_hw.h
  • XSCL_COEFFSETS_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETS_VERT_MASK +: xscaler_hw.h
  • XSCL_COEFFSETS_VERT_SHIFT +: xscaler_hw.h
  • XSCL_COEFFVALUE +: xscaler_hw.h
  • XSCL_COEFFVALUE_N_MASK +: xscaler_hw.h
  • XSCL_COEFFVALUE_NPLUS1_MASK +: xscaler_hw.h
  • XSCL_COEFFVALUE_OFFSET +: xscaler_hw.h
  • XSCL_CTL +: xscaler_hw.h
  • XSCL_CTL_ENABLE +: xscaler_hw.h
  • XSCL_CTL_MEMRD_EN_MASK +: xscaler_hw.h
  • XSCL_CTL_OFFSET +: xscaler_hw.h
  • XSCL_CTL_REGUPDATE +: xscaler_hw.h
  • XSCL_CTL_RESET_MASK +: xscaler_hw.h
  • XSCL_CTL_RUE_MASK +: xscaler_hw.h
  • XSCL_CTL_SW_EN_MASK +: xscaler_hw.h
  • XSCL_ERR_COEFF_WR_MASK +: xscaler_hw.h
  • XSCL_ERR_EOL_MASK +: xscaler_hw.h
  • XSCL_ERR_SOF_MASK +: xscaler_hw.h
  • XSCL_ERROR +: xscaler_hw.h
  • XSCL_ERROR_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT_OFFSET +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTLUMATOP +: xscaler_hw.h
  • XSCL_FRCTLUMATOP_OFFSET +: xscaler_hw.h
  • XSCL_FRCTLUMATOP_VALUE_MASK +: xscaler_hw.h
  • XSCL_HSF +: xscaler_hw.h
  • XSCL_HSF_FRAC_MASK +: xscaler_hw.h
  • XSCL_HSF_OFFSET +: xscaler_hw.h
  • XSCL_IER +: xscaler_hw.h
  • XSCL_IRQ_EN_OFFSET +: xscaler_hw.h
  • XSCL_IXR_COEF_W_RDY_MASK +: xscaler_hw.h
  • XSCL_MAX_COEFF_SET_NUM +: xscaler.h
  • XSCL_MAX_PHASE_NUM +: xscaler.h
  • XSCL_MAX_TAP_NUM +: xscaler.h
  • XSCL_MIN_PHASE_NUM +: xscaler.h
  • XSCL_MIN_TAP_NUM +: xscaler.h
  • XSCL_NUM_COEF_BINS +: xscaler.h
  • XSCL_NUMPHASE +: xscaler_hw.h
  • XSCL_NUMPHASE_HORI_MASK +: xscaler_hw.h
  • XSCL_NUMPHASE_OFFSET +: xscaler_hw.h
  • XSCL_NUMPHASE_VERT_MASK +: xscaler_hw.h
  • XSCL_NUMPHASE_VERT_SHIFT +: xscaler_hw.h
  • XSCL_OUTSIZE +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMLINE_MASK +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMLINE_SHIFT +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMPXL_MASK +: xscaler_hw.h
  • XSCL_OUTSIZE_OFFSET +: xscaler_hw.h
  • XSCL_RESET_RESET_MASK +: xscaler_hw.h
  • XSCL_SHRINK_FACTOR +: xscaler.h
  • XSCL_SRCSIZE +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMLINE_MASK +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMLINE_SHIFT +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMPXL_MASK +: xscaler_hw.h
  • XSCL_SRCSIZE_OFFSET +: xscaler_hw.h
  • XSCL_STATUS +: xscaler_hw.h
  • XSCL_STATUS_OFFSET +: xscaler_hw.h
  • XSCL_STS_COEF_W_RDY_MASK +: xscaler_hw.h
  • XSCL_STSDONE_DONE +: xscaler_hw.h
  • XSCL_VER +: xscaler_hw.h
  • XSCL_VER_OFFSET +: xscaler_hw.h
  • XSCL_VSF +: xscaler_hw.h
  • XSCL_VSF_FRAC_MASK +: xscaler_hw.h
  • XSCL_VSF_OFFSET +: xscaler_hw.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_defs.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_defs.html index e88f3414..ea614397 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_defs.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_defs.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    - r -

    +: xscaler.c

    - x -

    +
  • XScaler_CheckDone +: xscaler.h
  • XScaler_CoeffLoadReady +: xscaler.h
  • XScaler_CoefPhaseOffset +: xscaler.h
  • XScaler_CoefTapOffset +: xscaler.h
  • XScaler_Disable +: xscaler.h
  • XScaler_DisableRegUpdate +: xscaler.h
  • XScaler_Enable +: xscaler.h
  • XScaler_EnableRegUpdate +: xscaler.h
  • XScaler_GetError +: xscaler.h
  • XSCALER_H +: xscaler.h
  • XSCALER_HW_H +: xscaler_hw.h
  • XScaler_In32 +: xscaler_hw.h
  • XScaler_IntrClear +: xscaler.h
  • XScaler_IntrDisable +: xscaler.h
  • XScaler_IntrEnable +: xscaler.h
  • XScaler_IsEnabled +: xscaler.h
  • XScaler_IsResetDone +: xscaler.h
  • XScaler_Out32 +: xscaler_hw.h
  • XScaler_ReadReg +: xscaler_hw.h
  • XScaler_Reset +: xscaler.h
  • XScaler_TriangularNumber +: xscaler.h
  • XScaler_WriteReg +: xscaler_hw.h
  • XSCL_APTHORI +: xscaler_hw.h
  • XSCL_APTHORI_FIRSTPXL_MASK +: xscaler_hw.h
  • XSCL_APTHORI_LASTPXL_MASK +: xscaler_hw.h
  • XSCL_APTHORI_LASTPXL_SHIFT +: xscaler_hw.h
  • XSCL_APTHORI_OFFSET +: xscaler_hw.h
  • XSCL_APTVERT +: xscaler_hw.h
  • XSCL_APTVERT_FIRSTLINE_MASK +: xscaler_hw.h
  • XSCL_APTVERT_LASTLINE_MASK +: xscaler_hw.h
  • XSCL_APTVERT_LASTLINE_SHIFT +: xscaler_hw.h
  • XSCL_APTVERT_OFFSET +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_420 +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_422 +: xscaler_hw.h
  • XSCL_CHROMA_FORMAT_444 +: xscaler_hw.h
  • XSCL_COEF_BIN_SIZE +: xscaler.h
  • XSCL_COEFF_MEM +: xscaler_hw.h
  • XSCL_COEFF_MEM_OFFSET +: xscaler_hw.h
  • XSCL_COEFF_PRECISION +: xscaler.h
  • XSCL_COEFF_SELECT_BANK_MASK +: xscaler_hw.h
  • XSCL_COEFF_SELECT_SET_MASK +: xscaler_hw.h
  • XSCL_COEFF_SET_BANK +: xscaler_hw.h
  • XSCL_COEFF_SET_BANK_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETADDR +: xscaler_hw.h
  • XSCL_COEFFSETADDR_ADDR_MASK +: xscaler_hw.h
  • XSCL_COEFFSETADDR_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETS +: xscaler_hw.h
  • XSCL_COEFFSETS_HORI_MASK +: xscaler_hw.h
  • XSCL_COEFFSETS_OFFSET +: xscaler_hw.h
  • XSCL_COEFFSETS_VERT_MASK +: xscaler_hw.h
  • XSCL_COEFFSETS_VERT_SHIFT +: xscaler_hw.h
  • XSCL_COEFFVALUE +: xscaler_hw.h
  • XSCL_COEFFVALUE_N_MASK +: xscaler_hw.h
  • XSCL_COEFFVALUE_NPLUS1_MASK +: xscaler_hw.h
  • XSCL_COEFFVALUE_OFFSET +: xscaler_hw.h
  • XSCL_CTL +: xscaler_hw.h
  • XSCL_CTL_ENABLE +: xscaler_hw.h
  • XSCL_CTL_MEMRD_EN_MASK +: xscaler_hw.h
  • XSCL_CTL_OFFSET +: xscaler_hw.h
  • XSCL_CTL_REGUPDATE +: xscaler_hw.h
  • XSCL_CTL_RESET_MASK +: xscaler_hw.h
  • XSCL_CTL_RUE_MASK +: xscaler_hw.h
  • XSCL_CTL_SW_EN_MASK +: xscaler_hw.h
  • XSCL_ERR_COEFF_WR_MASK +: xscaler_hw.h
  • XSCL_ERR_EOL_MASK +: xscaler_hw.h
  • XSCL_ERR_SOF_MASK +: xscaler_hw.h
  • XSCL_ERROR +: xscaler_hw.h
  • XSCL_ERROR_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMALEFT_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP_OFFSET +: xscaler_hw.h
  • XSCL_FRCTCHROMATOP_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT_OFFSET +: xscaler_hw.h
  • XSCL_FRCTLUMALEFT_VALUE_MASK +: xscaler_hw.h
  • XSCL_FRCTLUMATOP +: xscaler_hw.h
  • XSCL_FRCTLUMATOP_OFFSET +: xscaler_hw.h
  • XSCL_FRCTLUMATOP_VALUE_MASK +: xscaler_hw.h
  • XSCL_HSF +: xscaler_hw.h
  • XSCL_HSF_FRAC_MASK +: xscaler_hw.h
  • XSCL_HSF_OFFSET +: xscaler_hw.h
  • XSCL_IER +: xscaler_hw.h
  • XSCL_IRQ_EN_OFFSET +: xscaler_hw.h
  • XSCL_IXR_COEF_W_RDY_MASK +: xscaler_hw.h
  • XSCL_MAX_COEFF_SET_NUM +: xscaler.h
  • XSCL_MAX_PHASE_NUM +: xscaler.h
  • XSCL_MAX_TAP_NUM +: xscaler.h
  • XSCL_MIN_PHASE_NUM +: xscaler.h
  • XSCL_MIN_TAP_NUM +: xscaler.h
  • XSCL_NUM_COEF_BINS +: xscaler.h
  • XSCL_NUMPHASE +: xscaler_hw.h
  • XSCL_NUMPHASE_HORI_MASK +: xscaler_hw.h
  • XSCL_NUMPHASE_OFFSET +: xscaler_hw.h
  • XSCL_NUMPHASE_VERT_MASK +: xscaler_hw.h
  • XSCL_NUMPHASE_VERT_SHIFT +: xscaler_hw.h
  • XSCL_OUTSIZE +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMLINE_MASK +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMLINE_SHIFT +: xscaler_hw.h
  • XSCL_OUTSIZE_NUMPXL_MASK +: xscaler_hw.h
  • XSCL_OUTSIZE_OFFSET +: xscaler_hw.h
  • XSCL_RESET_RESET_MASK +: xscaler_hw.h
  • XSCL_SHRINK_FACTOR +: xscaler.h
  • XSCL_SRCSIZE +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMLINE_MASK +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMLINE_SHIFT +: xscaler_hw.h
  • XSCL_SRCSIZE_NUMPXL_MASK +: xscaler_hw.h
  • XSCL_SRCSIZE_OFFSET +: xscaler_hw.h
  • XSCL_STATUS +: xscaler_hw.h
  • XSCL_STATUS_OFFSET +: xscaler_hw.h
  • XSCL_STS_COEF_W_RDY_MASK +: xscaler_hw.h
  • XSCL_STSDONE_DONE +: xscaler_hw.h
  • XSCL_VER +: xscaler_hw.h
  • XSCL_VER_OFFSET +: xscaler_hw.h
  • XSCL_VSF +: xscaler_hw.h
  • XSCL_VSF_FRAC_MASK +: xscaler_hw.h
  • XSCL_VSF_OFFSET +: xscaler_hw.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_func.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_func.html index fcc5a17e..63f2bf5b 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_func.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_func.html @@ -9,7 +9,7 @@ Software Drivers
    - +
     

    +
  • XScaler_AllocCoefsBuff() +: xscaler_coefs.c
  • XScaler_CfgInitialize() +: xscaler.h, xscaler.c
  • XScaler_CoefValueLookup() +: xscaler.h, xscaler.c
  • XScaler_GenCoefTable() +: xscaler_coefs.c, xscaler.c
  • XScaler_GetActiveCoeffSet() +: xscaler.h, xscaler.c
  • XScaler_GetAperture() +: xscaler.h, xscaler.c
  • XScaler_GetCoeffBankSharingInfo() +: xscaler.h, xscaler.c
  • XScaler_GetLanczosCoeffs() +: xscaler_coefs.c
  • XScaler_GetPhaseNum() +: xscaler.h, xscaler.c
  • XScaler_GetStartFraction() +: xscaler.h, xscaler.c
  • XScaler_GetVersion() +: xscaler.h, xscaler.c
  • XScaler_IntrHandler() +: xscaler_intr.c, xscaler.h
  • XScaler_Lanczos() +: xscaler_coefs.c
  • XScaler_LoadCoeffBank() +: xscaler.h, xscaler.c
  • XScaler_LookupConfig() +: xscaler_sinit.c, xscaler.h
  • XScaler_SetActiveCoeffSet() +: xscaler.h, xscaler.c
  • XScaler_SetAperture() +: xscaler.h, xscaler.c
  • XScaler_SetCallBack() +: xscaler_intr.c, xscaler.h
  • XScaler_SetPhaseNum() +: xscaler.h, xscaler.c
  • XScaler_SetStartFraction() +: xscaler.h, xscaler.c
  • XScaler_Sine() +: xscaler_coefs.c Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_type.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_type.html new file mode 100644 index 00000000..1271e557 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_type.html @@ -0,0 +1,38 @@ + + + + + Class Members + + + + +Software Drivers +
    + +
    +
    +
    +
    +
    + +
    +  +

    +

    +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_vars.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_vars.html index 2512a909..f4bbe6c1 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_vars.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/globals_vars.html @@ -9,7 +9,7 @@ Software Drivers
    - +
     

    +
  • SingleFrameCoefs +: xscaler_coefs.c
  • XScaler_coef_table +: xscaler_coefs.c
  • XScaler_CoefficientBinScalingFactors +: xscaler_coefs.c, xscaler.c
  • XScaler_ConfigTable +: xscaler_g.c Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/index.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/index.html index 5db0fa5e..f2f3b060 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/index.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/index.html @@ -2,21 +2,21 @@ - scaler v6_0 + scaler Software Drivers
    - +
    -

    scaler v6_0

    +

    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:

    @@ -39,10 +39,70 @@ An example is shipped with the driver to demonstrate how to use the APIs this dr

      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 device version & sharable coefficient bank support
    - 6.0   adk  19/12/13 Updated as per the New Tcl API's
    - 
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +
     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

    +

     
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct-members.html new file mode 100755 index 00000000..c9ab0571 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct-members.html @@ -0,0 +1,26 @@ + + + + + Member List + + + + +Software Drivers +
    + +
    +
    +
    +
    +

    Coefs_Struct Member List

    This is the complete list of members for Coefs_Struct, including all inherited members.

  • xscaler.c
    xscaler.h
    xscaler_coefs.c
    xscaler_g.c
    xscaler_hw.h
    + +
    coefficientsCoefs_Struct
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct.html new file mode 100755 index 00000000..2cafeb7b --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_coefs___struct.html @@ -0,0 +1,51 @@ + + + + + Coefs_Struct Struct Reference + + + + +Software Drivers +
    + +
    +
    +
    +
    +

    Coefs_Struct Struct Reference

    List of all members.

    Detailed Description

    +This structure contains a pointer to double dimensional array which will be filled by coefficients. +

    + + + + + +

    Public Attributes

    s16 ** coefficients
    +


    Member Data Documentation

    + +
    +
    + + + + +
    s16** Coefs_Struct::coefficients
    +
    +
    + +

    +Coefficients table +

    +

    +


    The documentation for this struct was generated from the following file: +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler-members.html index a2ae3985..70a79767 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler-members.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler-members.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    XScaler Member List

    This is the complete list of members for XScaler, including all inherited members.

    - - - - - - + + + +
    ConfigXScaler
    ErrorCallBackXScaler
    ErrorRefXScaler
    EventCallBackXScaler
    EventRefXScaler
    IsReadyXScaler
    CallBackXScaler
    CallBackRefXScaler
    ConfigXScaler
    IsReadyXScaler
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler.html index b910674d..6940db8c 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +


    The documentation for this struct was generated from the following file: +
  • xscaler.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config-members.html index a5f75fb1..e1fe57c3 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config-members.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config-members.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    XScaler_Config Member List

    This is the complete list of members for XScaler_Config, including all inherited members.

    - - - - - - - - - + + + + + + + + +
    BaseAddressXScaler_Config
    ChromaFormatXScaler_Config
    CoeffSetNumXScaler_Config
    DeviceIdXScaler_Config
    HoriTapNumXScaler_Config
    MaxPhaseNumXScaler_Config
    SeparateHvCoefXScaler_Config
    SeparateYcCoefXScaler_Config
    VertTapNumXScaler_Config
    BaseAddressXScaler_Config
    ChromaFormatXScaler_Config
    CoeffSetNumXScaler_Config
    DeviceIdXScaler_Config
    HoriTapNumXScaler_Config
    MaxPhaseNumXScaler_Config
    SeparateHvCoefXScaler_Config
    SeparateYcCoefXScaler_Config
    VertTapNumXScaler_Config
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config.html index e52a86ee..bf058589 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler___config.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +


    The documentation for this struct was generated from the following file: +
  • xscaler.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture-members.html index 6c90e2f9..8d04ff76 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture-members.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture-members.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    XScalerAperture Member List

    This is the complete list of members for XScalerAperture, including all inherited members.

    - - - - - - - - + + + + + + + +
    InFirstLineXScalerAperture
    InFirstPixelXScalerAperture
    InLastLineXScalerAperture
    InLastPixelXScalerAperture
    OutHoriSizeXScalerAperture
    OutVertSizeXScalerAperture
    SrcHoriSizeXScalerAperture
    SrcVertSizeXScalerAperture
    InFirstLineXScalerAperture
    InFirstPixelXScalerAperture
    InLastLineXScalerAperture
    InLastPixelXScalerAperture
    OutHoriSizeXScalerAperture
    OutVertSizeXScalerAperture
    SrcHoriSizeXScalerAperture
    SrcVertSizeXScalerAperture
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture.html index baa97c2f..ecd7c36f 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_aperture.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +


    The documentation for this struct was generated from the following file: +
  • xscaler.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank-members.html index 7bd926b0..645a43c6 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank-members.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank-members.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    XScalerCoeffBank Member List

    This is the complete list of members for XScalerCoeffBank, including all inherited members.

    - - - - + + + +
    CoeffValueBufXScalerCoeffBank
    PhaseNumXScalerCoeffBank
    SetIndexXScalerCoeffBank
    TapNumXScalerCoeffBank
    CoeffValueBufXScalerCoeffBank
    PhaseNumXScalerCoeffBank
    SetIndexXScalerCoeffBank
    TapNumXScalerCoeffBank
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank.html index 5f39f94f..d743e88e 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_coeff_bank.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +


    The documentation for this struct was generated from the following file: +
  • xscaler.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction-members.html index f0e06274..9c397483 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction-members.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction-members.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    XScalerStartFraction Member List

    This is the complete list of members for XScalerStartFraction, including all inherited members.

    - - - - + + + +
    ChromaLeftHoriXScalerStartFraction
    ChromaTopVertXScalerStartFraction
    LumaLeftHoriXScalerStartFraction
    LumaTopVertXScalerStartFraction
    ChromaLeftHoriXScalerStartFraction
    ChromaTopVertXScalerStartFraction
    LumaLeftHoriXScalerStartFraction
    LumaTopVertXScalerStartFraction
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction.html index ad4530b5..d6ac42f5 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/struct_x_scaler_start_fraction.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +


    The documentation for this struct was generated from the following file: +
  • xscaler.h Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct-members.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct-members.html new file mode 100644 index 00000000..0d2b94f2 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct-members.html @@ -0,0 +1,26 @@ + + + + + Member List + + + + +Software Drivers +
    + +
    +
    +
    +
    +

    coefs_struct Member List

    This is the complete list of members for coefs_struct, including all inherited members.

    + +
    coefficientscoefs_struct
    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct.html new file mode 100644 index 00000000..294fa1c6 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/structcoefs__struct.html @@ -0,0 +1,51 @@ + + + + + coefs_struct Struct Reference + + + +

    +Software Drivers +
    + +
    +
    +
    +
    +

    coefs_struct Struct Reference

    List of all members.

    Detailed Description

    +This structure contains a pointer to double dimensional array which will be filled by coefficients. +

    + + + + + +

    Public Attributes

    short int ** coefficients
    +


    Member Data Documentation

    + +
    +
    + + + + +
    short int** coefs_struct::coefficients
    +
    +
    + +

    + +

    +

    +


    The documentation for this struct was generated from the following file: +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8c.html index e11c9f20..a1d6a259 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8c.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8c.html @@ -9,7 +9,7 @@ Software Drivers
    - +

    xscaler.c File Reference


    Detailed Description

    -This is main code of 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. Please see xscaler.h for more details of the driver.

    +This is main code of 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. Please see xscaler.h for more details of the driver.

      MODIFICATION HISTORY:

    -

     Ver	Who	 Date	  Changes
    - ----- ---- -------- -------------------------------------------------------
    - 1.00a xd   02/10/09 First release
    - 2.00a xd   12/14/09 Updated doxygen document tags
    - 4.01a cw   06/27/12 Updated tcl file with new parameter names (num_x_taps)
    -                      Updated mdd file with updated supported_peripherals field.
    - 4.02a mpv  03/11/13 Updated the Driver to select the correct coeff bin.
    -                     Changed RegValue variable to a volatile type
    -                     Removed 10.x patch in the Tcl file
    - 4.03a mpv  05/28/13 Fixed version limit in MDD file
    -                     Updated the Driver input, output and aperture size mask
    - 5.00a mpv  12/13/13 Updated to dynamic coeff generation to reduce driver size
    +
     Ver   Who     Date     Changes
    + ----- ----    -------- -------------------------------------------------------
    + 1.00a xd      02/10/09 First release
    + 2.00a xd      12/14/09 Updated Doxygen document tags
    + 4.01a cw      06/27/12 Updated tcl file with new parameter names (num_x_taps)
    +                        Updated mdd file with updated supported_peripherals
    +                        field.
    + 4.02a mpv     03/11/13 Updated the Driver to select the correct coeff bin.
    +                        Changed RegValue variable to a volatile type
    +                        Removed 10.x patch in the Tcl file
    + 4.03a mpv     05/28/13 Fixed version limit in MDD file
    +                        Updated the Driver input, output and aperture size
    +                        mask
    + 5.00a mpv     12/13/13 Updated to dynamic coeff generation to reduce driver
    +                        size
    + 7.0   adk     08/22/14 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.
    +                        Removed ErrorMask parameter in StubCallBack as there
    +                        was only one interrupt.
      

    -#include "xscaler.h"
    +#include "xscaler.h"
    #include "xenv.h"
    #include "xil_io.h"
    #include "xil_assert.h"
    - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + - +

    Utility Macros

    #define round(x)   ((x) >= 0 ? (s32)((x) + 0.5) : (s32)((x) - 0.5))
    #define round(x)   ((x) >= 0 ? (s32)((x) + 0.5) : (s32)((x) - 0.5))

    Functions

    s16 * XScaler_GenCoefTable (u32 Tap, u32 Phase)
    s16 * XScaler_GenCoefTable (u32 Tap, u32 Phase)
    int XScaler_CfgInitialize (XScaler *InstancePtr, XScaler_Config *CfgPtr, u32 EffectiveAddr)
    int XScaler_CfgInitialize (XScaler *InstancePtr, XScaler_Config *CfgPtr, u32 EffectiveAddr)
    int XScaler_SetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    int XScaler_SetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    void XScaler_GetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    void XScaler_GetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    void XScaler_SetPhaseNum (XScaler *InstancePtr, u16 VertPhaseNum, u16 HoriPhaseNum)
    void XScaler_SetPhaseNum (XScaler *InstancePtr, u16 VertPhaseNum, u16 HoriPhaseNum)
    void XScaler_GetPhaseNum (XScaler *InstancePtr, u16 *VertPhaseNumPtr, u16 *HoriPhaseNumPtr)
    void XScaler_GetPhaseNum (XScaler *InstancePtr, u16 *VertPhaseNumPtr, u16 *HoriPhaseNumPtr)
    void XScaler_SetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    void XScaler_SetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    void XScaler_GetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    void XScaler_GetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    void XScaler_GetCoeffBankSharingInfo (XScaler *InstancePtr, u8 *ChromaFormat, u8 *ChromaLumaShareCoeff, u8 *HoriVertShareCoeff)
    void XScaler_GetCoeffBankSharingInfo (XScaler *InstancePtr, u8 *ChromaFormat, u8 *ChromaLumaShareCoeff, u8 *HoriVertShareCoeff)
    s16 * XScaler_CoefValueLookup (u32 InSize, u32 OutSize, u32 Tap, u32 Phase)
    s16 * XScaler_CoefValueLookup (u32 InSize, u32 OutSize, u32 Tap, u32 Phase)
    void XScaler_LoadCoeffBank (XScaler *InstancePtr, XScalerCoeffBank *CoeffBankPtr)
    void XScaler_LoadCoeffBank (XScaler *InstancePtr, XScalerCoeffBank *CoeffBankPtr)
    void XScaler_SetActiveCoeffSet (XScaler *InstancePtr, u8 VertSetIndex, u8 HoriSetIndex)
    void XScaler_SetActiveCoeffSet (XScaler *InstancePtr, u8 VertSetIndex, u8 HoriSetIndex)
    void XScaler_GetActiveCoeffSet (XScaler *InstancePtr, u8 *VertSetIndexPtr, u8 *HoriSetIndexPtr)
    void XScaler_GetActiveCoeffSet (XScaler *InstancePtr, u8 *VertSetIndexPtr, u8 *HoriSetIndexPtr)
    u32 XScaler_GetVersion (XScaler *InstancePtr)

    Variables

    u16 XScaler_CoefficientBinScalingFactors [XSCL_NUM_COEF_BINS]
    u16 XScaler_CoefficientBinScalingFactors [XSCL_NUM_COEF_BINS]


    Define Documentation

    -

    - - - - -
    - + +
    +
    +
    - - - - - - + + + + + +
    #define round  )    ((x) >= 0 ? (s32)((x) + 0.5) : (s32)((x) - 0.5))#define round (  )    ((x) >= 0 ? (s32)((x) + 0.5) : (s32)((x) - 0.5))
    -
    - - - -
    -   - + +

    This macro calculates the integral value nearest to x rounding half-way cases away from zero, regardless of the current rounding direction.

    @@ -111,50 +118,42 @@ This macro calculates the integral value nearest to x rounding half-way cases aw

    x has a float type value
    -

    Returns:
    the integral value nearest to x rounding half-way cases away from zero, regardless of the current rounding direction.
    -
    Note:
    C-style signature: s32 round(float x);
    - - - +
    Returns:
    The integral value nearest to x rounding half-way cases away from zero, regardless of the current rounding direction.
    +
    Note:
    C-style signature: s32 round(float x);
    + + +


    Function Documentation

    -

    - - - - -
    - + +
    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    int XScaler_CfgInitialize XScaler InstancePtr, int XScaler_CfgInitialize (XScaler InstancePtr,
    XScaler_Config CfgPtr, XScaler_Config CfgPtr,
    u32  EffectiveAddru32  EffectiveAddr 
    )
    -
    - - - - - -
    -   - + +

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

    @@ -162,57 +161,50 @@ This function initializes a Scaler device. This function must be called prior to - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    CfgPtr points to the configuration structure associated with the Scaler device.
    EffectiveAddr is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.
    EffectiveAddr is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.
    -

    Returns:
    XST_SUCCESS
    -
    -

    - - - - -
    - +
    Returns:
    XST_SUCCESS
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    s16* XScaler_CoefValueLookup u32  InSize, s16* XScaler_CoefValueLookup (u32  InSize,
    u32  OutSize, u32  OutSize,
    u32  Tap, u32  Tap,
    u32  Phaseu32  Phase 
    )
    -
    - - - - - +
    -   - + +

    This function returns the pointer to the coefficients for a scaling operation given input/output sizes and the Tap and Phase numbers.

    @@ -221,194 +213,172 @@ This function returns the pointer to the coefficients for a scaling operation gi

    InSize indicates the size (width or height) of the input video.
    OutSize indicates the size (width or height) of the output video.
    Tap indicates the Tap number.
    Phase indicates the Phase number.
    Phase indicates the Phase number.
    -

    Returns:
    The points to the coefficients ready for the scaling operation.
    +
    Returns:
    The points to the coefficients ready for the scaling operation.
    Note:
    None.
    - - - -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - + + +
    s16* XScaler_GenCoefTable u32  Tap, s16* XScaler_GenCoefTable (u32  Tap,
    u32  Phaseu32  Phase 
    )
    -
    - - - - - -
    -   - + +

    -XScaler_GenCoefTable generates XScaler_coef_table containing the coefficient values for scaling operations

    -

    - - - - -
    - +This function generates a table that contains the coefficient values for scaling operations

    +

    Parameters:
    +
    + + +
    Tap indicates the number of taps configured to the Scaler device.
    Phase indicates the number of phase configured to the Scaler device.
    + +
    Returns:
    The pointer to XScaler_Coef_Table.
    +
    Note:
    None.
    + + +

    + +

    +
    + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_GetActiveCoeffSet XScaler InstancePtr, void XScaler_GetActiveCoeffSet (XScaler InstancePtr,
    u8 *  VertSetIndexPtr, u8 *  VertSetIndexPtr,
    u8 *  HoriSetIndexPtru8 *  HoriSetIndexPtr 
    )
    -
    - - - - - -
    -   - + +

    This function fetches the indexes of active vertical and horizontal coefficient sets being used by a Scaler device.

    Each coefficient set contains 4 banks: Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. The horizontal part is independent from the vertical part and the Scaler device supports using the horizontal part of one coefficient set w/ the vertical part of a different coefficient set.

    Parameters:
    - - + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertSetIndexPtr points to the index of the active coefficient set in which the vertical part is being used by the Scaler device after this function returns.
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertSetIndexPtr points to the index of the active coefficient set in which the vertical part is being used by the Scaler device after this function returns.
    HoriSetIndexPtr points to the index of the active coefficient set in which the horizontal part is being used by the Scaler device after this function returns.
    Returns:
    None.
    Note:
    None.
    -
    -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_GetAperture XScaler InstancePtr, void XScaler_GetAperture (XScaler InstancePtr,
    XScalerAperture AperturePtrXScalerAperture AperturePtr 
    )
    -
    - - - - - -
    -   - + +

    This function gets aperture of a Scaler device. The aperture setting consists of input video aperture and output video size.

    Parameters:
    - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    AperturePtr points to the aperture structure to store the current Scaler device setting after this function returns.
    AperturePtr points to the aperture structure to store the current Scaler device setting after this function returns.
    -
    Returns:
    None
    -
    -

    - - - - -
    - +
    Returns:
    None.
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_GetCoeffBankSharingInfo XScaler InstancePtr, void XScaler_GetCoeffBankSharingInfo (XScaler InstancePtr,
    u8 *  ChromaFormat, u8 *  ChromaFormat,
    u8 *  ChromaLumaShareCoeff, u8 *  ChromaLumaShareCoeff,
    u8 *  HoriVertShareCoeffu8 *  HoriVertShareCoeff 
    )
    -
    - - - - - +
    -   - + +

    This function fetches the color space format and coefficient bank sharing decisions made on a Scaler device at build-time.

    @@ -417,10 +387,10 @@ This function fetches the color space format and coefficient bank sharing decisi

    InstancePtr is a pointer to the Scaler device instance to be worked on.
    ChromaFormat points to an 8-bit variable that will be assigned with the Chroma format chosen for the Scaler device at the build time after this function returns. Please use XSCL_CHROMA_FORMAT_* defined in xscaler_hw.h to interpret the variable value.
    ChromaLumaShareCoeff points to an 8-bit variable that will be assigned by this function with the decision value on coefficient bank sharing between Chroma and Luma filter operations. The decision is made for the Scaler device at build time and can NOT be changed at run-time. Value 0 indicates that each of Chroma and Luma filter operations has its own coefficient bank. Value 1 indicates that Chroma and Luma filter operations share one common coefficient bank.
    HoriVertShareCoeff points to an 8-bit variable that will be assigned by this function with the decision value on coefficient bank sharing between Horizontal and Vertical filter operations. The decision is made for the Scaler device at build time and can NOT be changed at run-time. Value 0 indicates that each of Horizontal and Vertical filter operations has its own coefficient bank. Value 1 indicates that Horizontal and Vertical filter operations share one common coefficient bank.
    HoriVertShareCoeff points to an 8-bit variable that will be assigned by this function with the decision value on coefficient bank sharing between Horizontal and Vertical filter operations. The decision is made for the Scaler device at build time and can NOT be changed at run-time. Value 0 indicates that each of Horizontal and Vertical filter operations has its own coefficient bank. Value 1 indicates that Horizontal and Vertical filter operations share one common coefficient bank.
    -

    Returns:
    None.
    +
    Returns:
    None.
    Note:
    !!!IMPORTANT!!!

    The application of this function is responsible for loading the correct number of coefficient banks in the proper sequence order. The number of coefficient banks to load and the proper loading sequence totally depends on the values of the output parameters of this function. Please use the table below as reference.

    @@ -462,47 +432,39 @@ The application of this function is responsible for loading the correct number o YUV444 Always 1 0 2 1.Hori bank 2.Vert bank ------------ -------------------- ------------------ -------- ------------- -

    - - -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_GetPhaseNum XScaler InstancePtr, void XScaler_GetPhaseNum (XScaler InstancePtr,
    u16 *  VertPhaseNumPtr, u16 *  VertPhaseNumPtr,
    u16 *  HoriPhaseNumPtru16 *  HoriPhaseNumPtr 
    )
    -
    - - - - - -
    -   - + +

    This function gets the numbers of vertical and horizontal phases currently used by a Scaler device.

    @@ -510,93 +472,107 @@ This function gets the numbers of vertical and horizontal phases currently used - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertPhaseNumPtr will point to the number of vertical phases used after this function returns.
    HoriPhaseNumPtr will point to the number of horizontal phases used after this function returns.
    HoriPhaseNumPtr will point to the number of horizontal phases used after this function returns.
    -

    Returns:
    None
    -
    -

    - - - - -
    - +
    Returns:
    None.
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_GetStartFraction XScaler InstancePtr, void XScaler_GetStartFraction (XScaler InstancePtr,
    XScalerStartFraction StartFractionPtrXScalerStartFraction StartFractionPtr 
    )
    -
    - - - - - -
    -   - + +

    This function gets Luma and Chroma start fractional values currently used by a Scaler device.

    Parameters:
    - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    StartFractionPtr is a pointer to a start fractional value structure to be populated with the fractional values after this function returns.
    StartFractionPtr is a pointer to a start fractional value structure to be populated with the fractional values after this function returns.
    -
    Returns:
    None
    -
    -

    - - - - -
    - +
    Returns:
    None.
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - - - - - - - - - - - - + + + + + +
    void XScaler_LoadCoeffBank XScaler InstancePtr,
    XScalerCoeffBank CoeffBankPtr
    u32 XScaler_GetVersion (XScaler InstancePtr  ) 
    -
    - - - - - -
    -   - + +

    -This function loads a coefficient bank to the Scaler core. A complete coefficient set contains 4 banks (if Luma, Chroma, Horizontal and Vertical filter operations do not share common banks. For more details see XScaler_GetCoeffBankSharingInfo()): Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. all 4 banks must be loaded back to back in the order listed here. The caller is responsible for ensuring the sequence and this function does not check it.

    +This function returns the contents of version register of the Scaler core.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler core instance to be worked on.
    +
    +
    Returns:
    Contents of the version register.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void XScaler_LoadCoeffBank (XScaler InstancePtr,
    XScalerCoeffBank CoeffBankPtr 
    )
    +
    +
    + +

    +This function loads a coefficient bank to the Scaler core. A complete coefficient set contains 4 banks (if Luma, Chroma, Horizontal and Vertical filter operations do not share common banks. For more details see XScaler_GetCoeffBankSharingInfo()): Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. all 4 banks must be loaded back to back in the order listed here. The caller is responsible for ensuring the sequence and this function does not check it.

    An example sequence to load an whole coefficient set is like:

     	   XScaler_LoadCoeffBank(&Scaler, &HoriLumaCoeffBank);
     	   XScaler_LoadCoeffBank(&Scaler, &HoriChromaCoeffBank);
    @@ -606,150 +582,127 @@ An example sequence to load an whole coefficient set is like: 
     
    Parameters:
    - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    CoeffBankPtr is a pointer to a coefficient bank that is to be loaded
    CoeffBankPtr is a pointer to a coefficient bank that is to be loaded.
    -
    Returns:
    None
    -
    -

    - - - - -
    - +
    Returns:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_SetActiveCoeffSet XScaler InstancePtr, void XScaler_SetActiveCoeffSet (XScaler InstancePtr,
    u8  VertSetIndex, u8  VertSetIndex,
    u8  HoriSetIndexu8  HoriSetIndex 
    )
    -
    - - - - - -
    -   - + +

    This function chooses the active vertical and horizontal coefficient sets to be used by a Scaler device.

    Each coefficient set contains 4 banks: Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. The horizontal part is independent from the vertical part and the Scaler device supports using the horizontal part of one coefficient set w/ the vertical part of a different coefficient set.

    Parameters:
    - - - + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on
    VertSetIndex indicates the index of the coefficient set in which the vertical part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1)
    HoriSetIndex indicates the index of the coefficient set in which the horizontal part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1)
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertSetIndex indicates the index of the coefficient set in which the vertical part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1).
    HoriSetIndex indicates the index of the coefficient set in which the horizontal part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1).
    Returns:
    None.
    Note:
    None.
    -
    -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - + + +
    int XScaler_SetAperture XScaler InstancePtr, int XScaler_SetAperture (XScaler InstancePtr,
    XScalerAperture AperturePtrXScalerAperture AperturePtr 
    )
    -
    - - - - - -
    -   - + +

    This function sets up aperture of a Scaler device. The aperture setting consists of input video aperture and output video size. This function calculates the scale factor accordingly based on the aperture setting and sets up the Scaler appropriately.

    Parameters:
    - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    AperturePtr points to the aperture setting structure to set up the Scaler device.
    AperturePtr points to the aperture setting structure to set up the Scaler device.
    -
    Returns:
    XST_SUCCESS
    -
    -

    - - - - -
    - +
    Returns:
    XST_SUCCESS.
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_SetPhaseNum XScaler InstancePtr, void XScaler_SetPhaseNum (XScaler InstancePtr,
    u16  VertPhaseNum, u16  VertPhaseNum,
    u16  HoriPhaseNumu16  HoriPhaseNum 
    )
    -
    - - - - - -
    -   - + +

    This function sets the numbers of vertical and horizontal phases to be used by a Scaler device.

    @@ -757,80 +710,66 @@ This function sets the numbers of vertical and horizontal phases to be used by a - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertPhaseNum is the number of vertical phase to set to
    HoriPhaseNum is the number of horizontal phase to set to
    HoriPhaseNum is the number of horizontal phase to set to
    -

    Returns:
    None
    -
    -

    - - - - -
    - +
    Returns:
    None.
    +
    Note:
    None.
    + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - + + +
    void XScaler_SetStartFraction XScaler InstancePtr, void XScaler_SetStartFraction (XScaler InstancePtr,
    XScalerStartFraction StartFractionPtrXScalerStartFraction StartFractionPtr 
    )
    -
    - - - - - -
    -   - + +

    This function sets up Luma and Chroma start fractional values used by a Scaler device.

    Parameters:
    - +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    StartFractionPtr is a pointer to a start fractional value set to be used.
    StartFractionPtr is a pointer to a start fractional value set to be used.
    -
    Returns:
    None
    -
    +

    Returns:
    None.
    +
    Note:
    None.
    + + +


    Variable Documentation

    -

    - - - - -
    - + +
    +
    +
    - +
    u16 XScaler_CoefficientBinScalingFactors[XSCL_NUM_COEF_BINS] u16 XScaler_CoefficientBinScalingFactors[XSCL_NUM_COEF_BINS]
    -
    - - - - - -
    -   - + +

    -XScaler_CoefficientsBinScalingFactors contains scaling factors calculated using (Output_Size * 10000 / Input_Size). This table could help find the index of coefficient Bin given an input size and a output size.

    +XScaler_CoefficientsBinScalingFactors contains scaling factors calculated using (Output_Size * 10000 / Input_Size). This table could help find the index of coefficient Bin given an input size and a output size. + +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8h.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8h.html new file mode 100644 index 00000000..e8c12700 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler_8h.html @@ -0,0 +1,1517 @@ + + + + + xscaler.h File Reference + + + +

    +Software Drivers +
    + +
    +
    +
    +
    +

    xscaler.h File Reference

    +

    +#include "stdio.h"
    +#include "math.h"
    +#include "stdlib.h"
    +#include "xil_assert.h"
    +#include "xscaler_hw.h"
    +#include "xil_types.h"
    +#include "xstatus.h"
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Classes

    struct  XScaler_Config
    struct  XScaler
    struct  XScalerAperture
    struct  XScalerCoeffBank
    struct  XScalerStartFraction

    Minimum and Maximum Tap Numbers

    #define XSCL_MIN_TAP_NUM   2
    #define XSCL_MAX_TAP_NUM   12

    Minimum and Maximum Phase Numbers

    #define XSCL_MIN_PHASE_NUM   2
    #define XSCL_MAX_PHASE_NUM   64

    Coefficient Precision

    #define XSCL_COEFF_PRECISION   16

    Maximum Coefficient Set Number

    #define XSCL_MAX_COEFF_SET_NUM   16

    The number of coefficient Bins

    #define XSCL_NUM_COEF_BINS   19

    The size of a coefficient Bin in 16-bit integers.

    #define XSCL_COEF_BIN_SIZE   XScaler_CoefTapOffset(XSCL_MAX_TAP_NUM + 1)

    Shrink factor constants

    #define XSCL_SHRINK_FACTOR   0x100000

    Macros for operating a Scaler device

    #define XScaler_Enable(InstancePtr)
    #define XScaler_Disable(InstancePtr)
    #define XScaler_IsEnabled(InstancePtr)
    #define XScaler_CheckDone(InstancePtr)
    #define XScaler_EnableRegUpdate(InstancePtr)
    #define XScaler_DisableRegUpdate(InstancePtr)
    #define XScaler_CoeffLoadReady(InstancePtr)
    #define XScaler_GetError(InstancePtr)   XScaler_ReadReg((InstancePtr)->Config.BaseAddress, (XSCL_ERROR_OFFSET))
    #define XScaler_Reset(InstancePtr)
    #define XScaler_IsResetDone(InstancePtr)
    #define XScaler_TriangularNumber(N)   ((N) * ((N) + 1) / 2)
    #define XScaler_CoefTapOffset(Tap)
    #define XScaler_CoefPhaseOffset(Tap, Phase)
    #define XScaler_IntrEnable(InstancePtr)
    #define XScaler_IntrDisable(InstancePtr)
    #define XScaler_IntrClear(InstancePtr)

    Defines

    #define XSCALER_H

    Typedefs

    typedef void(*) XScaler_CallBack (void *CallBackRef)

    Functions

    int XScaler_CfgInitialize (XScaler *InstancePtr, XScaler_Config *CfgPtr, u32 EffectiveAddr)
    int XScaler_SetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    void XScaler_GetAperture (XScaler *InstancePtr, XScalerAperture *AperturePtr)
    void XScaler_SetPhaseNum (XScaler *InstancePtr, u16 VertPhaseNum, u16 HoriPhaseNum)
    void XScaler_GetPhaseNum (XScaler *InstancePtr, u16 *VertPhaseNumPtr, u16 *HoriPhaseNumPtr)
    void XScaler_SetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    void XScaler_GetStartFraction (XScaler *InstancePtr, XScalerStartFraction *StartFractionPtr)
    s16 * XScaler_CoefValueLookup (u32 InSize, u32 OutSize, u32 Tap, u32 Phase)
    void XScaler_LoadCoeffBank (XScaler *InstancePtr, XScalerCoeffBank *CoeffBankPtr)
    void XScaler_SetActiveCoeffSet (XScaler *InstancePtr, u8 VertSetIndex, u8 HoriSetIndex)
    void XScaler_GetActiveCoeffSet (XScaler *InstancePtr, u8 *VertSetIndexPtr, u8 *HoriSetIndexPtr)
    void XScaler_GetCoeffBankSharingInfo (XScaler *InstancePtr, u8 *ChromaFormat, u8 *ChromaLumaShareCoeff, u8 *HoriVertShareCoeff)
    u32 XScaler_GetVersion (XScaler *InstancePtr)
    XScaler_ConfigXScaler_LookupConfig (u16 DeviceId)
    void XScaler_IntrHandler (void *InstancePtr)
    void XScaler_SetCallBack (XScaler *InstancePtr, void *CallBackFunc, void *CallBackRef)
    +


    Define Documentation

    + +
    +
    + + + + + + + + + +
    #define XScaler_CheckDone (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                                        (XSCL_STATUS_OFFSET)) & \
    +                (XSCL_STS_COEF_W_RDY_MASK) ? TRUE : FALSE
    +
    This macro checks if a Scaler operation is finished

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
      +
    • TRUE if the Scaler operation is finished.
    • FALSE otherwise.
    +
    +
    Note:
    C-style signature: boolean XScaler_CheckDone(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_CoeffLoadReady (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                                        (XSCL_STATUS_OFFSET)) & \
    +                (XSCL_STS_COEF_W_RDY_MASK) ? TRUE : FALSE
    +
    This macro checks if a Scaler device is ready to accept the coefficients the software is going to load.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
      +
    • TRUE if the Scaler device is ready for the coefficient load.
    • FALSE otherwise.
    +
    +
    Note:
    C-style signature: boolean XScaler_CoeffLoadReady(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + + + + +
    #define XScaler_CoefPhaseOffset (Tap,
    Phase   ) 
    +
    +
    + +

    +Value:

    (((Phase) < 32) ? \
    +                (Tap) * (XScaler_TriangularNumber((Phase) - 1) - 1) : \
    +                ((Phase) == 32) ? \
    +                        (Tap) * (XScaler_TriangularNumber(16) - 1) : \
    +                        (Tap) * (XScaler_TriangularNumber(16) - 1 + 32))
    +
    This macro calculates the offset of the first coefficient Phase from the beginning of a coefficient Tap given the currently used Phase and Tap numbers for scaling operation.

    +

    Parameters:
    + + + +
    Tap indicates the number of Taps used for the scaling operation.
    Phase indicates the number of Phases used for the scaling operation.
    +
    +
    Returns:
    The offset of the first coefficient Phase from the beginning of a coefficient Tap.
    +
    Note:
    C-style signature: u32 XScaler_CoefPhaseOffset(u32 Tap, u32 Phase);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_CoefTapOffset (Tap   ) 
    +
    +
    + +

    +Value:

    ((XScaler_TriangularNumber((Tap) - 1) - 1) * \
    +                (XScaler_TriangularNumber(16) - 1 + 32 + 64))
    +
    This macro calculates the offset of a coefficient Tap from the beginning of a coefficient Bin.

    +

    Parameters:
    + + +
    Tap indicates the index of the coefficient tap in the coefficient Bin.
    +
    +
    Returns:
    The offset of the coefficient TAP from the beginning of a coefficient Bin.
    +
    Note:
    C-style signature: u32 XScaler_CoefTapOffset(u32 Tap);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_Disable (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET), \
    +                        ((XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                        (XSCL_CTL_OFFSET)) & (~(XSCL_CTL_SW_EN_MASK)))))
    +
    This macro disables a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_Disable(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_DisableRegUpdate (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET), \
    +                        ((XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                        (XSCL_CTL_OFFSET))) & (~(XSCL_CTL_RUE_MASK))))
    +
    This macro tells a Scaler device not to pick up the register value changes until XScaler_EnableRegUpdate() is invoked again. This is very useful when multiple registers need to be updated. All register updates could be made with no tight time constraints with the help of this macro.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_DisableRegUpdate(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_Enable (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET), \
    +                        ((XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                                (XSCL_CTL_OFFSET))) | (XSCL_CTL_SW_EN_MASK)))
    +
    This macro enables a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_Enable(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_EnableRegUpdate (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET), \
    +                        ((XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                        (XSCL_CTL_OFFSET))) | (XSCL_CTL_RUE_MASK)))
    +
    This macro tells a Scaler device to pick up the register value changes made so far.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_EnableRegUpdate(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_GetError (InstancePtr   )    XScaler_ReadReg((InstancePtr)->Config.BaseAddress, (XSCL_ERROR_OFFSET))
    +
    +
    + +

    +This macro checks the error status of a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    The error type, if any. Use XSCL_STSERR_* defined in xscaler_hw.h to interpret the value.
    +
    Note:
    C-style signature: u32 XScaler_GetError(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + +
    #define XSCALER_H
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_IntrClear (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_STATUS_OFFSET), (XSCL_IXR_COEF_W_RDY_MASK))
    +
    This macro clears/acknowledges Coef_FIFO_Ready interrupt of a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None
    +
    Note:
    C-style signature: void XScaler_IntrClear(XScaler *InstancePtr)
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_IntrDisable (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_IRQ_EN_OFFSET), 0)
    +
    This macro disables the Coef_FIFO_Ready interrupt on a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_IntrDisable(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_IntrEnable (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_IRQ_EN_OFFSET),(XSCL_IXR_COEF_W_RDY_MASK)) \
    +
    This macro enables the Coef_FIFO_Ready interrupt on a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_IntrEnable(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_IsEnabled (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET)) & (XSCL_CTL_SW_EN_MASK) ? TRUE : FALSE
    +
    This macro checks if a Scaler device is enabled.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    - TRUE if the Scaler device is enabled.
      +
    • FALSE otherwise.
    +
    +
    Note:
    C-style signature: boolean XScaler_IsEnabled(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_IsResetDone (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_ReadReg((InstancePtr)->Config.BaseAddress, \
    +                                        (XSCL_CTL_OFFSET)) & \
    +                                        (XSCL_CTL_RESET_MASK) ? FALSE : TRUE
    +
    This macro checks if the reset on a Scaler device is done.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
      +
    • TRUE if the reset is done;
    • FALSE otherwise.
    +
    +
    Note:
    C-style signature: boolean XScaler_IsResetDone(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_Reset (InstancePtr   ) 
    +
    +
    + +

    +Value:

    XScaler_WriteReg((InstancePtr)->Config.BaseAddress, \
    +                (XSCL_CTL_OFFSET), (XSCL_CTL_RESET_MASK))
    +
    This macro resets a Scaler device.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    +
    +
    Returns:
    None.
    +
    Note:
    C-style signature: void XScaler_Reset(XScaler *InstancePtr);
    + +
    +

    + +

    +
    + + + + + + + + + +
    #define XScaler_TriangularNumber (  )    ((N) * ((N) + 1) / 2)
    +
    +
    + +

    +This macro calculates the N-th Triangular number: 1 + 2 + ... + N

    +

    Parameters:
    + + +
    N indicates the positive integer number to calculate the N-th Triangular number.
    +
    +
    Returns:
    The N-th triangular number.
    +
    Note:
    C-style signature: u32 XScaler_TriangularNumber(u32 N);
    + +
    +

    + +

    +
    + + + + +
    #define XSCL_COEF_BIN_SIZE   XScaler_CoefTapOffset(XSCL_MAX_TAP_NUM + 1)
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_PRECISION   16
    +
    +
    + +

    +Coefficient Precision +

    +

    + +

    +
    + + + + +
    #define XSCL_MAX_COEFF_SET_NUM   16
    +
    +
    + +

    +Maximum Coefficient Set Number +

    +

    + +

    +
    + + + + +
    #define XSCL_MAX_PHASE_NUM   64
    +
    +
    + +

    +Maximum Phase Number +

    +

    + +

    +
    + + + + +
    #define XSCL_MAX_TAP_NUM   12
    +
    +
    + +

    +Maximum Tap Number +

    +

    + +

    +
    + + + + +
    #define XSCL_MIN_PHASE_NUM   2
    +
    +
    + +

    +Minimum Phase Number +

    +

    + +

    +
    + + + + +
    #define XSCL_MIN_TAP_NUM   2
    +
    +
    + +

    +Minimum Tap Number +

    +

    + +

    +
    + + + + +
    #define XSCL_NUM_COEF_BINS   19
    +
    +
    + +

    +The number of coefficient Bins +

    +

    + +

    +
    + + + + +
    #define XSCL_SHRINK_FACTOR   0x100000
    +
    +
    + +

    +For calculating HSF/VSF values +

    +

    +


    Typedef Documentation

    + +
    +
    + + + + +
    typedef void(*) XScaler_CallBack(void *CallBackRef)
    +
    +
    + +

    +Callback type for interrupts

    +

    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.
    EventMask indicates which events are happening. They could be either normal events or errors. The value is created by "OR'ing" XSCL_IXR_* constants defined in xscaler_hw.h
    +
    + +
    +

    +


    Function Documentation

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    int XScaler_CfgInitialize (XScaler InstancePtr,
    XScaler_Config CfgPtr,
    u32  EffectiveAddr 
    )
    +
    +
    + +

    +This function initializes a Scaler device. This function must be called prior to using a Scaler device. Initialization of a Scaler includes setting up the instance data, and ensuring the hardware is in a quiescent state.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    CfgPtr points to the configuration structure associated with the Scaler device.
    EffectiveAddr is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.
    +
    +
    Returns:
    XST_SUCCESS
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    s16* XScaler_CoefValueLookup (u32  InSize,
    u32  OutSize,
    u32  Tap,
    u32  Phase 
    )
    +
    +
    + +

    +This function returns the pointer to the coefficients for a scaling operation given input/output sizes and the Tap and Phase numbers.

    +

    Parameters:
    + + + + + +
    InSize indicates the size (width or height) of the input video.
    OutSize indicates the size (width or height) of the output video.
    Tap indicates the Tap number.
    Phase indicates the Phase number.
    +
    +
    Returns:
    The points to the coefficients ready for the scaling operation.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_GetActiveCoeffSet (XScaler InstancePtr,
    u8 *  VertSetIndexPtr,
    u8 *  HoriSetIndexPtr 
    )
    +
    +
    + +

    +This function fetches the indexes of active vertical and horizontal coefficient sets being used by a Scaler device.

    +Each coefficient set contains 4 banks: Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. The horizontal part is independent from the vertical part and the Scaler device supports using the horizontal part of one coefficient set w/ the vertical part of a different coefficient set.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertSetIndexPtr points to the index of the active coefficient set in which the vertical part is being used by the Scaler device after this function returns.
    HoriSetIndexPtr points to the index of the active coefficient set in which the horizontal part is being used by the Scaler device after this function returns.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void XScaler_GetAperture (XScaler InstancePtr,
    XScalerAperture AperturePtr 
    )
    +
    +
    + +

    +This function gets aperture of a Scaler device. The aperture setting consists of input video aperture and output video size.

    +

    Parameters:
    + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    AperturePtr points to the aperture structure to store the current Scaler device setting after this function returns.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_GetCoeffBankSharingInfo (XScaler InstancePtr,
    u8 *  ChromaFormat,
    u8 *  ChromaLumaShareCoeff,
    u8 *  HoriVertShareCoeff 
    )
    +
    +
    + +

    +This function fetches the color space format and coefficient bank sharing decisions made on a Scaler device at build-time.

    +

    Parameters:
    + + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    ChromaFormat points to an 8-bit variable that will be assigned with the Chroma format chosen for the Scaler device at the build time after this function returns. Please use XSCL_CHROMA_FORMAT_* defined in xscaler_hw.h to interpret the variable value.
    ChromaLumaShareCoeff points to an 8-bit variable that will be assigned by this function with the decision value on coefficient bank sharing between Chroma and Luma filter operations. The decision is made for the Scaler device at build time and can NOT be changed at run-time. Value 0 indicates that each of Chroma and Luma filter operations has its own coefficient bank. Value 1 indicates that Chroma and Luma filter operations share one common coefficient bank.
    HoriVertShareCoeff points to an 8-bit variable that will be assigned by this function with the decision value on coefficient bank sharing between Horizontal and Vertical filter operations. The decision is made for the Scaler device at build time and can NOT be changed at run-time. Value 0 indicates that each of Horizontal and Vertical filter operations has its own coefficient bank. Value 1 indicates that Horizontal and Vertical filter operations share one common coefficient bank.
    +
    +
    Returns:
    None.
    +
    Note:
    +!!!IMPORTANT!!!

    +The application of this function is responsible for loading the correct number of coefficient banks in the proper sequence order. The number of coefficient banks to load and the proper loading sequence totally depends on the values of the output parameters of this function. Please use the table below as reference.

    +

    + ChromaFormat ChromaLumaShareCoeff HoriVertShareCoeff # of      sequence
    +                                                      coeff     of
    +                                                      banks     loading
    +                                                      to load   coeff
    +                                                                banks
    + ------------ -------------------- ------------------ --------  -------------
    + YUV420       1                    1                  1         1.Single bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV420       1                    0                  2         1.Hori bank
    +                                                                2.Vert bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV420       0                    1                  2         1.Luma bank
    +                                                                2.Chroma bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV420       0                    0                  4         1.Hori Luma
    +                                                                2.Hori Chroma
    +                                                                3.Vert Luma
    +                                                                4.Vert Chroma
    + ------------ -------------------- ------------------ --------  -------------
    + YUV422       1                    1                  1         1.Single bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV422       1                    0                  2         1.Hori bank
    +                                                                2.Vert bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV422       0                    1                  2         1.Luma bank
    +                                                                2.Chroma bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV422       0                    0                  4         1.Hori Luma
    +                                                                2.Hori Chroma
    +                                                                3.Vert Luma
    +                                                                4.Vert Chroma
    + ------------ -------------------- ------------------ --------  -------------
    + YUV444       Always 1             1                  1         1.Single bank
    + ------------ -------------------- ------------------ --------  -------------
    + YUV444       Always 1             0                  2         1.Hori bank
    +                                                                2.Vert bank
    + ------------ -------------------- ------------------ --------  -------------
    + 
    +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_GetPhaseNum (XScaler InstancePtr,
    u16 *  VertPhaseNumPtr,
    u16 *  HoriPhaseNumPtr 
    )
    +
    +
    + +

    +This function gets the numbers of vertical and horizontal phases currently used by a Scaler device.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertPhaseNumPtr will point to the number of vertical phases used after this function returns.
    HoriPhaseNumPtr will point to the number of horizontal phases used after this function returns.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void XScaler_GetStartFraction (XScaler InstancePtr,
    XScalerStartFraction StartFractionPtr 
    )
    +
    +
    + +

    +This function gets Luma and Chroma start fractional values currently used by a Scaler device.

    +

    Parameters:
    + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    StartFractionPtr is a pointer to a start fractional value structure to be populated with the fractional values after this function returns.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + +
    u32 XScaler_GetVersion (XScaler InstancePtr  ) 
    +
    +
    + +

    +This function returns the contents of version register of the Scaler core.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the Scaler core instance to be worked on.
    +
    +
    Returns:
    Contents of the version register.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + +
    void XScaler_IntrHandler (void *  InstancePtr  ) 
    +
    +
    + +

    +This function is the interrupt handler for the Scaler driver.

    +This handler calls callback, 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 XScaler_SetCallBack() during initialization phase.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the XScaler instance that just interrupted.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void XScaler_LoadCoeffBank (XScaler InstancePtr,
    XScalerCoeffBank CoeffBankPtr 
    )
    +
    +
    + +

    +This function loads a coefficient bank to the Scaler core. A complete coefficient set contains 4 banks (if Luma, Chroma, Horizontal and Vertical filter operations do not share common banks. For more details see XScaler_GetCoeffBankSharingInfo()): Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. all 4 banks must be loaded back to back in the order listed here. The caller is responsible for ensuring the sequence and this function does not check it.

    +An example sequence to load an whole coefficient set is like:

    +	   XScaler_LoadCoeffBank(&Scaler, &HoriLumaCoeffBank);
    +	   XScaler_LoadCoeffBank(&Scaler, &HoriChromaCoeffBank);
    +	   XScaler_LoadCoeffBank(&Scaler, &VertLumaCoeffBank);
    +	   XScaler_LoadCoeffBank(&Scaler, &VertChromaCoeffBank);
    + 

    +

    Parameters:
    + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    CoeffBankPtr is a pointer to a coefficient bank that is to be loaded.
    +
    +
    Returns:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + +
    XScaler_Config* XScaler_LookupConfig (u16  DeviceId  ) 
    +
    +
    + +

    +XScaler_LookupConfig returns a reference to an XScaler_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 xscaler_g.c file.

    +

    Parameters:
    + + +
    DeviceId is the unique device ID of the device for the lookup operation.
    +
    +
    Returns:
    XScaler_LookupConfig returns a reference to a config record in the configuration table (in xscaler_g.c) corresponding to DeviceId, or NULL if no match is found.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_SetActiveCoeffSet (XScaler InstancePtr,
    u8  VertSetIndex,
    u8  HoriSetIndex 
    )
    +
    +
    + +

    +This function chooses the active vertical and horizontal coefficient sets to be used by a Scaler device.

    +Each coefficient set contains 4 banks: Horizontal Luma, Horizontal Chroma, Vertical Luma and Vertical Chroma. The horizontal part is independent from the vertical part and the Scaler device supports using the horizontal part of one coefficient set w/ the vertical part of a different coefficient set.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertSetIndex indicates the index of the coefficient set in which the vertical part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1).
    HoriSetIndex indicates the index of the coefficient set in which the horizontal part will be used by the Scaler device. Valid value is from 0 to (the number of the coefficient sets implemented by the Scaler device - 1).
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    int XScaler_SetAperture (XScaler InstancePtr,
    XScalerAperture AperturePtr 
    )
    +
    +
    + +

    +This function sets up aperture of a Scaler device. The aperture setting consists of input video aperture and output video size. This function calculates the scale factor accordingly based on the aperture setting and sets up the Scaler appropriately.

    +

    Parameters:
    + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    AperturePtr points to the aperture setting structure to set up the Scaler device.
    +
    +
    Returns:
    XST_SUCCESS.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_SetCallBack (XScaler InstancePtr,
    void *  CallBackFunc,
    void *  CallBackRef 
    )
    +
    +
    + +

    +This routine installs an asynchronous callback function.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the XScaler instance to be worked on.
    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:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    void XScaler_SetPhaseNum (XScaler InstancePtr,
    u16  VertPhaseNum,
    u16  HoriPhaseNum 
    )
    +
    +
    + +

    +This function sets the numbers of vertical and horizontal phases to be used by a Scaler device.

    +

    Parameters:
    + + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    VertPhaseNum is the number of vertical phase to set to
    HoriPhaseNum is the number of horizontal phase to set to
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void XScaler_SetStartFraction (XScaler InstancePtr,
    XScalerStartFraction StartFractionPtr 
    )
    +
    +
    + +

    +This function sets up Luma and Chroma start fractional values used by a Scaler device.

    +

    Parameters:
    + + + +
    InstancePtr is a pointer to the Scaler device instance to be worked on.
    StartFractionPtr is a pointer to a start fractional value set to be used.
    +
    +
    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__coefs_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__coefs_8c.html index 23e56b5c..ea8c824f 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__coefs_8c.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__coefs_8c.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    +

    + +

    +
    + + + + + + + + + +
    float XScaler_Sine (float  x  ) 
    +
    +
    + +

    +This Sine generation algorithm implements Taylor series decomposition of the Sine function.

    +

    Parameters:
    + + +
    x is a float variable which needs to be set.
    +
    +
    Returns:
    Returns Taylor series.
    +
    Note:
    It works according to http://en.wikipedia.org/wiki/Taylor_series#Approximation_and_convergence
    + +
    +


    Variable Documentation

    -

    - - - - -
    - + +
    +
    +
    - +
    u16 XScaler_CoefficientBinScalingFactors[XSCL_NUM_COEF_BINS] struct coefs_struct SingleFrameCoefs
    -
    - - - - - -
    -   - + +
    + +

    +This structure contains a pointer to double dimensional array which will be filled by coefficients. +

    +

    + +

    +
    + + + + +
    s16* XScaler_coef_table = NULL
    +
    +
    + +

    +Coefficients table +

    +

    + +

    +
    + + + + +
    u16 XScaler_CoefficientBinScalingFactors[XSCL_NUM_COEF_BINS]
    +
    +

    Initial value:

     {
    @@ -233,7 +342,7 @@ Sine generation This Sine generation algorithm implements Taylor series decompos
             10000,
             6666
     }
    -
    XScaler_CoefficientsBinScalingFactors contains scaling factors calculated using (Output_Size * 10000 / Input_Size). This table could help find the index of coefficient Bin given an input size and a output size.
    +XScaler_CoefficientsBinScalingFactors contains scaling factors calculated using (Output_Size * 10000 / Input_Size). This table could help find the index of coefficient Bin given an input size and a output size. + +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__g_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__g_8c.html index 8e2303e1..a24febcd 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__g_8c.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__g_8c.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    -

    xscaler_g.c File Reference


    Detailed Description

    -This file contains a template for configuration table of Xilinx MVI Video Scaler devices.

    -

    - MODIFICATION HISTORY:

    -

     Ver	Who	Date	 Changes
    - -----	----	-------- -------------------------------------------------------
    - 1.00a	xd	05/14/09 First release
    - 2.00a	xd	12/14/09 Updated doxygen document tags
    - 
    +

    xscaler_g.c File Reference

    #include "xparameters.h"
    -#include "xscaler.h"
    +#include "xscaler.h"
    - +

    Variables

    XScaler_Config XScaler_ConfigTable []
    XScaler_Config XScaler_ConfigTable []


    Variable Documentation

    -

    - - - - -
    - + +
    +
    +
    - +
    XScaler_Config XScaler_ConfigTable[] XScaler_Config XScaler_ConfigTable[]
    -
    - - - - - -
    -   - + +

    -Initial value:

     {
    +Initial value:
    +{
             {
    -                XPAR_SCALER_0_DEVICE_ID,
    -                XPAR_SCALER_0_BASEADDR,
    -                XPAR_SCALER_0_VERT_TAP_NUM,
    -                XPAR_SCALER_0_HORI_TAP_NUM,
    -                XPAR_SCALER_0_MAX_PHASE_NUM,
    -                XPAR_SCALER_0_MAX_COEF_SETS,
    -                XPAR_SCALER_0_CHROMA_FORMAT,
    -                XPAR_SCALER_0_SEPARATE_YC_COEFS,
    -                XPAR_SCALER_0_SEPARATE_HV_COEFS
    +                XPAR_V_SCALER_1_DEVICE_ID,
    +                XPAR_V_SCALER_1_BASEADDR,
    +                XPAR_V_SCALER_1_NUM_V_TAPS,
    +                XPAR_V_SCALER_1_NUM_H_TAPS,
    +                XPAR_V_SCALER_1_MAX_PHASES,
    +                XPAR_V_SCALER_1_MAX_COEF_SETS,
    +                XPAR_V_SCALER_1_CHROMA_FORMAT,
    +                XPAR_V_SCALER_1_SEPARATE_YC_COEFS,
    +                XPAR_V_SCALER_1_SEPARATE_HV_COEFS
             }
     }
    -
    The configuration table for Scaler devices
    + + +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__hw_8h.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__hw_8h.html index f1d7f922..2af37d36 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__hw_8h.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__hw_8h.html @@ -9,7 +9,7 @@

    Software Drivers
    - +

    xscaler_hw.h File Reference


    Detailed Description

    This header file contains identifiers and register-level driver functions (or macros) that can be used to access the Xilinx MVI Video Scaler device.

    -For more information about the operation of this device, see the hardware specification and documentation in the higher level driver xscaler.h source code file.

    +For more information about the operation of this device, see the hardware specification and documentation in the higher level driver xscaler.h source code file.

      MODIFICATION HISTORY:

     Ver   Who  Date     Changes
    @@ -31,234 +31,306 @@ For more information about the operation of this device, see the hardware specif
      1.00a xd   05/14/09 First release
      2.00a xd   12/14/09 Updated doxygen document tags
      4.03a mpv  05/28/13 Updated the Driver input, output and aperture size mask
    + 7.0   adk  08/22/14 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.
      

    #include "xil_io.h"
    - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + - + - + - + - - - - - - + - - - + - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - - - - - - - - - - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + + + + +

    Device Register Offsets

    #define XSCL_CTL   0x000
    #define XSCL_CTL_OFFSET   0x000
    #define XSCL_STATUS   0x004
    #define XSCL_STATUS_OFFSET   0x004
    #define XSCL_ERROR   0x008
    #define XSCL_ERROR_OFFSET   0x008
    #define IRQ_ENABLE   0x00C
    #define XSCL_IRQ_EN_OFFSET   0x00C
    #define XSCL_VER   0x010
    #define XSCL_VER_OFFSET   0x010
    #define XSCL_HSF   0x100
    #define XSCL_HSF_OFFSET   0x100
    #define XSCL_VSF   0x104
    #define XSCL_VSF_OFFSET   0x104
    #define XSCL_SRCSIZE   0x108
    #define XSCL_SRCSIZE_OFFSET   0x108
    #define XSCL_APTHORI   0x10C
    #define XSCL_APTHORI_OFFSET   0x10C
    #define XSCL_APTVERT   0x110
    #define XSCL_APTVERT_OFFSET   0x110
    #define XSCL_OUTSIZE   0x114
    #define XSCL_OUTSIZE_OFFSET   0x114
    #define XSCL_NUMPHASE   0x118
    #define XSCL_NUMPHASE_OFFSET   0x118
    #define XSCL_COEFFSETS   0x11C
    #define XSCL_COEFFSETS_OFFSET   0x11C
    #define XSCL_FRCTLUMALEFT   0x120
    #define XSCL_FRCTLUMALEFT_OFFSET   0x120
    #define XSCL_FRCTCHROMALEFT   0x124
    #define XSCL_FRCTCHROMALEFT_OFFSET   0x124
    #define XSCL_FRCTLUMATOP   0x128
    #define XSCL_FRCTLUMATOP_OFFSET   0x128
    #define XSCL_FRCTCHROMATOP   0x12C
    #define XSCL_FRCTCHROMATOP_OFFSET   0x12C
    #define XSCL_COEFFSETADDR   0x130
    #define XSCL_COEFFSETADDR_OFFSET   0x130
    #define XSCL_COEFFVALUE   0x134
    #define XSCL_COEFFVALUE_OFFSET   0x134
    #define XSCL_COEFF_SET_BANK   0x138
    #define XSCL_COEFF_SET_BANK_OFFSET   0x138
    #define XSCL_COEFF_MEM   0x13C
    #define XSCL_COEFF_MEM_OFFSET   0x13C

    Control Register bit definition

    #define XSCL_CTL_REGUPDATE   0x00000002
    #define XSCL_CTL_SW_EN_MASK   0x00000001
    #define XSCL_CTL_ENABLE   0x00000001
    #define XSCL_CTL_RUE_MASK   0x00000002
    #define XSCL_CTL_MEMRD_EN_MASK   0x00000008
    #define XSCL_CTL_RESET_MASK   0x80000000

    Status Register bit definition

    #define XSCL_STS_COEF_W_RDY_MASK   0x00000001
    #define XSCL_IXR_COEF_W_RDY_MASK   0x00000001

    Error Status Register bit definition (to be defined)

    #define XSCL_STSERR_CODE3_MASK   0xFF000000
    #define XSCL_ERR_EOL_MASK   0x00000001
    #define XSCL_STSERR_CODE2_MASK   0x00FF0000
    #define XSCL_ERR_SOF_MASK   0x00000004
    #define XSCL_STSERR_CODE1_MASK   0x0000FF00
    #define XSCL_STSERR_CODE0_MASK   0x000000FF

    Done Status Register bit definition

    #define XSCL_STSDONE_DONE   0x00000001
    #define XSCL_ERR_COEFF_WR_MASK   0x00000010

    Horizontal Shrink Factor Register bit definition

    #define XSCL_HSF_INT_MASK   0x00F00000
    #define XSCL_HSF_FRAC_MASK   0x000FFFFF
    #define XSCL_HSF_FRAC_MASK   0x00FFFFFF

    Vertical Shrink Factor Register bit definition

    #define XSCL_VSF_INT_MASK   0x00F00000
    #define XSCL_VSF_FRAC_MASK   0x000FFFFF
    #define XSCL_VSF_FRAC_MASK   0x00FFFFFF

    Aperture Horizontal Register bit definition

    #define XSCL_APTHORI_LASTPXL_MASK   0x1FFF0000
    #define XSCL_APTHORI_LASTPXL_MASK   0x1FFF0000
    #define XSCL_APTHORI_LASTPXL_SHIFT   16
    #define XSCL_APTHORI_LASTPXL_SHIFT   16
    #define XSCL_APTHORI_FIRSTPXL_MASK   0x00001FFF
    #define XSCL_APTHORI_FIRSTPXL_MASK   0x00001FFF

    Aperture Vertical Register bit definition

    #define XSCL_APTVERT_LASTLINE_MASK   0x1FFF0000
    #define XSCL_APTVERT_LASTLINE_MASK   0x1FFF0000
    #define XSCL_APTVERT_LASTLINE_SHIFT   16
    #define XSCL_APTVERT_LASTLINE_SHIFT   16
    #define XSCL_APTVERT_FIRSTLINE_MASK   0x00001FFF
    #define XSCL_APTVERT_FIRSTLINE_MASK   0x00001FFF

    Output Size Register bit definition

    #define XSCL_OUTSIZE_NUMLINE_MASK   0x1FFF0000
    #define XSCL_OUTSIZE_NUMLINE_MASK   0x1FFF0000
    #define XSCL_OUTSIZE_NUMLINE_SHIFT   16
    #define XSCL_OUTSIZE_NUMLINE_SHIFT   16
    #define XSCL_OUTSIZE_NUMPXL_MASK   0x00001FFF
    #define XSCL_OUTSIZE_NUMPXL_MASK   0x00001FFF

    Source Size Register bit definition

    #define XSCL_SRCSIZE_NUMLINE_MASK   0x1FFF0000
    #define XSCL_SRCSIZE_NUMLINE_MASK   0x1FFF0000
    #define XSCL_SRCSIZE_NUMLINE_SHIFT   16
    #define XSCL_SRCSIZE_NUMLINE_SHIFT   16
    #define XSCL_SRCSIZE_NUMPXL_MASK   0x00001FFF
    #define XSCL_SRCSIZE_NUMPXL_MASK   0x00001FFF

    Number of Phases Register bit definition

    #define XSCL_NUMPHASE_VERT_MASK   0x00007F00
    #define XSCL_NUMPHASE_VERT_MASK   0x00007F00
    #define XSCL_NUMPHASE_VERT_SHIFT   8
    #define XSCL_NUMPHASE_VERT_SHIFT   8
    #define XSCL_NUMPHASE_HORI_MASK   0x0000007F
    #define XSCL_NUMPHASE_HORI_MASK   0x0000007F

    Active Coefficient Set Register bit definition

    #define XSCL_COEFFSETS_VERT_MASK   0x000000F0
    #define XSCL_COEFFSETS_VERT_MASK   0x000000F0
    #define XSCL_COEFFSETS_VERT_SHIFT   4
    #define XSCL_COEFFSETS_VERT_SHIFT   4
    #define XSCL_COEFFSETS_HORI_MASK   0x0000000F
    #define XSCL_COEFFSETS_HORI_MASK   0x0000000F

    Luma left edge horizontal accumulator fractional value register

    #define XSCL_FRCTLUMALEFT_VALUE_MASK   0x001FFFFF
    #define XSCL_FRCTLUMALEFT_VALUE_MASK   0x001FFFFF

    Chroma left edge horizontal accumulator fractional value register

    #define XSCL_FRCTCHROMALEFT_VALUE_MASK   0x001FFFFF
    #define XSCL_FRCTCHROMALEFT_VALUE_MASK   0x001FFFFF

    Luma top edge vertical accumulator fractional value register

    #define XSCL_FRCTLUMATOP_VALUE_MASK   0x001FFFFF
    #define XSCL_FRCTLUMATOP_VALUE_MASK   0x001FFFFF

    Chroma top edge vertical accumulator fractional value register

    #define XSCL_FRCTCHROMATOP_VALUE_MASK   0x001FFFFF
    #define XSCL_FRCTCHROMATOP_VALUE_MASK   0x001FFFFF

    Coefficient band address register bit definition

    #define XSCL_COEFFSETADDR_ADDR_MASK   0x0000000F
    #define XSCL_COEFFSETADDR_ADDR_MASK   0x0000000F

    Coefficient Value Register bit definition

    #define XSCL_COEFFVALUE_NPLUS1_MASK   0xFFFF0000
    #define XSCL_COEFFVALUE_NPLUS1_MASK   0xFFFF0000
    #define XSCL_COEFFVALUE_N_MASK   0x0000FFFF
    #define XSCL_COEFFVALUE_N_MASK   0x0000FFFF

    Reset Register bit definition

    #define XSCL_RESET_RESET_MASK   0x80000000

    Coefficient Set Bank Read bit definition

    #define XSCL_COEFF_SELECT_BANK_MASK   0x00000003

    Global Interrupt Enable Register bit definition

    #define XSCL_GIER_GIE_MASK   0x80000000

    Interrupt Status/Enable Register bit definition

    #define XSCL_IXR_REG_UPDATE_DONE_MASK   0x00000020
    #define XSCL_IXR_COEF_WR_ERROR_MASK   0x00000010
    #define XSCL_IXR_OUTPUT_ERROR_MASK   0x00000008
    #define XSCL_IXR_INPUT_ERROR_MASK   0x00000004
    #define XSCL_IXR_COEF_FIFO_READY_MASK   0x00000002
    #define XSCL_IXR_OUTPUT_FRAME_DONE_MASK   0x00000001
    #define XSCL_IXR_EVENT_MASK
    #define XSCL_IXR_ERROR_MASK
    #define XSCL_IXR_ALLINTR_MASK
    #define XSCL_COEFF_SELECT_SET_MASK   0x00000F00

    Chroma Format Type Definition

    #define XSCL_CHROMA_FORMAT_420   1
    #define XSCL_CHROMA_FORMAT_420   1
    #define XSCL_CHROMA_FORMAT_422   2
    #define XSCL_CHROMA_FORMAT_422   2
    #define XSCL_CHROMA_FORMAT_444   3
    #define XSCL_CHROMA_FORMAT_444   3

    Backward compatibility macros

    #define XSCL_CTL   XSCL_CTL_OFFSET
    #define XSCL_STATUS   XSCL_STATUS_OFFSET
    #define XSCL_ERROR   XSCL_ERROR_OFFSET
    #define XSCL_IER   XSCL_IRQ_EN_OFFSET
    #define XSCL_VER   XSCL_VER_OFFSET
    #define XSCL_HSF   XSCL_HSF_OFFSET
    #define XSCL_VSF   XSCL_VSF_OFFSET
    #define XSCL_SRCSIZE   XSCL_SRCSIZE_OFFSET
    #define XSCL_APTHORI   XSCL_APTHORI_OFFSET
    #define XSCL_APTVERT   XSCL_APTVERT_OFFSET
    #define XSCL_OUTSIZE   XSCL_OUTSIZE_OFFSET
    #define XSCL_NUMPHASE   XSCL_NUMPHASE_OFFSET
    #define XSCL_COEFFSETS   XSCL_COEFFSETS_OFFSET
    #define XSCL_FRCTLUMALEFT   XSCL_FRCTLUMALEFT_OFFSET
    #define XSCL_FRCTCHROMALEFT   XSCL_FRCTCHROMALEFT_OFFSET
    #define XSCL_FRCTLUMATOP   XSCL_FRCTLUMATOP_OFFSET
    #define XSCL_FRCTCHROMATOP   XSCL_FRCTCHROMATOP_OFFSET
    #define XSCL_COEFFSETADDR   XSCL_COEFFSETADDR_OFFSET
    #define XSCL_COEFFVALUE   XSCL_COEFFVALUE_OFFSET
    #define XSCL_COEFF_SET_BANK   XSCL_COEFF_SET_BANK_OFFSET
    #define XSCL_COEFF_MEM   XSCL_COEFF_MEM_OFFSET
    #define XSCL_CTL_REGUPDATE   XSCL_CTL_RUE_MASK
    #define XSCL_CTL_ENABLE   XSCL_CTL_SW_EN_MASK
    #define XSCL_RESET_RESET_MASK   XSCL_CTL_RESET_MASK
    #define XSCL_STSDONE_DONE   XSCL_IXR_COEF_W_RDY_MASK
    #define XSCL_STS_COEF_W_RDY_MASK   XSCL_IXR_COEF_W_RDY_MASK

    Scaler Register Access Macro Definition

    #define XScaler_ReadReg(BaseAddress, RegOffset)   XScaler_In32((BaseAddress) + (RegOffset))
    #define XScaler_In32   Xil_In32
    #define XScaler_WriteReg(BaseAddress, RegOffset, Data)   XScaler_Out32((BaseAddress) + (RegOffset), (Data))
    #define XScaler_Out32   Xil_Out32
    #define XScaler_ReadReg(BaseAddress, RegOffset)   XScaler_In32((BaseAddress) + (RegOffset))
    #define XScaler_WriteReg(BaseAddress, RegOffset, Data)   XScaler_Out32((BaseAddress) + (RegOffset), (Data))

    Defines

    #define XSCALER_HW_H


    Define Documentation

    -

    - - - - -
    - + +
    +
    +
    - +
    #define IRQ_ENABLE   0x00C #define XSCALER_HW_H
    -
    - - - - - -
    -   - + +

    -For detecting operation status

    -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - - - - - - +
    #define XScaler_ReadReg BaseAddress,
    RegOffset   )    XScaler_In32((BaseAddress) + (RegOffset))#define XScaler_In32   Xil_In32
    -
    - - - -
    -   - + +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XScaler_Out32   Xil_Out32
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + + + + + + + + + +
    #define XScaler_ReadReg (BaseAddress,
    RegOffset   )    XScaler_In32((BaseAddress) + (RegOffset))
    +
    +

    Read the given register.

    @@ -269,39 +341,31 @@ Read the given register.

    Returns:
    The 32-bit value of the register
    -
    Note:
    C-style signature: u32 XScaler_ReadReg(u32 BaseAddress, u32 RegOffset)
    - - - -

    - - - - -
    - +
    Note:
    C-style signature: u32 XScaler_ReadReg(u32 BaseAddress, u32 RegOffset)
    + + +

    + +

    +
    +
    - - - - - - - - - - - - + + + + + + + + + + + +
    #define XScaler_WriteReg BaseAddress,
    RegOffset,
    Data   )    XScaler_Out32((BaseAddress) + (RegOffset), (Data))#define XScaler_WriteReg (BaseAddress,
    RegOffset,
    Data   )    XScaler_Out32((BaseAddress) + (RegOffset), (Data))
    -
    - - - -
    -   - + +

    Write the given register.

    @@ -313,1649 +377,1313 @@ Write the given register.

    Returns:
    None.
    -
    Note:
    C-style signature: void XScaler_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)
    - - - -

    - - - - -
    - - - - -
    #define XSCL_APTHORI   0x10C
    -
    - - - - - -
    -   - - -

    -First and last subject pixels in input line

    -

    - - - - -
    - - - - -
    #define XSCL_APTHORI_FIRSTPXL_MASK   0x00001FFF
    -
    - - - - - -
    -   - - -

    -Location of first pixel in line

    -

    - - - - -
    - - - - -
    #define XSCL_APTHORI_LASTPXL_MASK   0x1FFF0000
    -
    - - - - - -
    -   - - -

    -Location of last pixel in line

    -

    - - - - -
    - - - - -
    #define XSCL_APTHORI_LASTPXL_SHIFT   16
    -
    - - - - - -
    -   - - -

    -Shift for location of last pixel

    -

    - - - - -
    - - - - -
    #define XSCL_APTVERT   0x110
    -
    - - - - - -
    -   - - -

    -First and last subject lines in input image

    -

    - - - - -
    - - - - -
    #define XSCL_APTVERT_FIRSTLINE_MASK   0x00001FFF
    -
    - - - - - -
    -   - - -

    -Location of first line in active video

    -

    - - - - -
    - - - - -
    #define XSCL_APTVERT_LASTLINE_MASK   0x1FFF0000
    -
    - - - - - -
    -   - - -

    -Location of last line in active video

    -

    - - - - -
    - - - - -
    #define XSCL_APTVERT_LASTLINE_SHIFT   16
    -
    - - - - - -
    -   - - -

    -Shift for location of last line

    -

    - - - - -
    - - - - -
    #define XSCL_CHROMA_FORMAT_420   1
    -
    - - - - - -
    -   - - -

    -YUV4:2:0

    -

    - - - - -
    - - - - -
    #define XSCL_CHROMA_FORMAT_422   2
    -
    - - - - - -
    -   - - -

    -YUV4:2:2

    -

    - - - - -
    - - - - -
    #define XSCL_CHROMA_FORMAT_444   3
    -
    - - - - - -
    -   - - -

    -YUV4:4:4

    -

    - - - - -
    - - - - -
    #define XSCL_COEFF_MEM   0x13C
    -
    - - - - - -
    -   - - -

    -Coefficient mem read address

    -

    - - - - -
    - - - - -
    #define XSCL_COEFF_SET_BANK   0x138
    -
    - - - - - -
    -   - - -

    -Coefficient set/bank read address

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETADDR   0x130
    -
    - - - - - -
    -   - - -

    -Address of Coefficient set to write

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETADDR_ADDR_MASK   0x0000000F
    -
    - - - - - -
    -   - - -

    -Address of the Coefficient bank to write next

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETS   0x11C
    -
    - - - - - -
    -   - - -

    -Active horizontal and vertical coefficient sets to use

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETS_HORI_MASK   0x0000000F
    -
    - - - - - -
    -   - - -

    -Active horizontal coefficient set

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETS_VERT_MASK   0x000000F0
    -
    - - - - - -
    -   - - -

    -Active vertical coefficient set

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFSETS_VERT_SHIFT   4
    -
    - - - - - -
    -   - - -

    -Active vertical coefficient set shift

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFVALUE   0x134
    -
    - - - - - -
    -   - - -

    -Coefficient values to write

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFVALUE_N_MASK   0x0000FFFF
    -
    - - - - - -
    -   - - -

    -First value in the pair

    -

    - - - - -
    - - - - -
    #define XSCL_COEFFVALUE_NPLUS1_MASK   0xFFFF0000
    -
    - - - - - -
    -   - - -

    -Second value in the pair

    -

    - - - - -
    - - - - -
    #define XSCL_CTL   0x000
    -
    - - - - - -
    -   - - -

    -Control

    -

    - - - - -
    - - - - -
    #define XSCL_CTL_ENABLE   0x00000001
    -
    - - - - - -
    -   - - -

    -Enable the scaler on the next video frame

    -

    - - - - -
    - - - - -
    #define XSCL_CTL_REGUPDATE   0x00000002
    -
    - - - - - -
    -   - - -

    -Register Update Enable for register HSF thru FRCTCHROMATOP

    -

    - - - - -
    - - - - -
    #define XSCL_ERROR   0x008
    -
    - - - - - -
    -   - - -

    -Error status

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTCHROMALEFT   0x124
    -
    - - - - - -
    -   - - -

    -Fractional value used to initialize horizontal accumulator at rectangle left edge for chroma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTCHROMALEFT_VALUE_MASK   0x001FFFFF
    -
    - - - - - -
    -   - - -

    -Fractional value to initialize horizontal accumulator for chroma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTCHROMATOP   0x12C
    -
    - - - - - -
    -   - - -

    -Fractional value used to initialize horizontal accumulator at rectangle top edge for chroma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTCHROMATOP_VALUE_MASK   0x001FFFFF
    -
    - - - - - -
    -   - - -

    -Fractional value to initialize vertical accumulator for chroma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTLUMALEFT   0x120
    -
    - - - - - -
    -   - - -

    -Fractional value used to initialize horizontal accumulator at rectangle left edge for luma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTLUMALEFT_VALUE_MASK   0x001FFFFF
    -
    - - - - - -
    -   - - -

    -Fractional value to initialize horizontal accumulator for luma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTLUMATOP   0x128
    -
    - - - - - -
    -   - - -

    -Fractional value used to initialize horizontal accumulator at rectangle top edge for luma

    -

    - - - - -
    - - - - -
    #define XSCL_FRCTLUMATOP_VALUE_MASK   0x001FFFFF
    -
    - - - - - -
    -   - - -

    -Fractional value to initialize vertical accumulator for luma

    -

    - - - - -
    - - - - -
    #define XSCL_GIER_GIE_MASK   0x80000000
    -
    - - - - - -
    -   - - -

    -Global interrupt enable

    -

    - - - - -
    - - - - -
    #define XSCL_HSF   0x100
    -
    - - - - - -
    -   - - -

    -Horizontal Shrink Factor

    -

    - - - - -
    - - - - -
    #define XSCL_HSF_FRAC_MASK   0x000FFFFF
    -
    - - - - - -
    -   - - -

    -Horizontal Shrink Factor fractional

    -

    - - - - -
    - - - - -
    #define XSCL_HSF_INT_MASK   0x00F00000
    -
    - - - - - -
    -   - - -

    -Horizontal Shrink Factor integer

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_ALLINTR_MASK
    -
    - - - - - -
    -   - - -

    -Value:

    Mask for all interrupts
    -

    - - - - -
    - - - - -
    #define XSCL_IXR_COEF_FIFO_READY_MASK   0x00000002
    -
    - - - - - -
    -   - - -

    -Coefficient FIFO Ready Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_COEF_WR_ERROR_MASK   0x00000010
    -
    - - - - - -
    -   - - -

    -Coefficient FIFO Write Error Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_ERROR_MASK
    -
    - - - - - -
    -   - - -

    -Value:

    Mask for all error interrupts
    -

    - - - - -
    - - - - -
    #define XSCL_IXR_EVENT_MASK
    -
    - - - - - -
    -   - - -

    -Value:

    Mask for all normal event interrupts
    -

    - - - - -
    - - - - -
    #define XSCL_IXR_INPUT_ERROR_MASK   0x00000004
    -
    - - - - - -
    -   - - -

    -Input Error Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_OUTPUT_ERROR_MASK   0x00000008
    -
    - - - - - -
    -   - - -

    -Output Error Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_OUTPUT_FRAME_DONE_MASK   0x00000001
    -
    - - - - - -
    -   - - -

    -Video Frame Done Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_IXR_REG_UPDATE_DONE_MASK   0x00000020
    -
    - - - - - -
    -   - - -

    -Shadow Register Update Interrupt

    -

    - - - - -
    - - - - -
    #define XSCL_NUMPHASE   0x118
    -
    - - - - - -
    -   - - -

    -The numbers of phases in current filter

    -

    - - - - -
    - - - - -
    #define XSCL_NUMPHASE_HORI_MASK   0x0000007F
    -
    - - - - - -
    -   - - -

    -The number of horizontal phases

    -

    - - - - -
    - - - - -
    #define XSCL_NUMPHASE_VERT_MASK   0x00007F00
    -
    - - - - - -
    -   - - -

    -The number of vertical phases

    -

    - - - - -
    - - - - -
    #define XSCL_NUMPHASE_VERT_SHIFT   8
    -
    - - - - - -
    -   - - -

    -Shift for the number of vertical phases

    -

    - - - - -
    - - - - -
    #define XSCL_OUTSIZE   0x114
    -
    - - - - - -
    -   - - -

    -Output image size:width and height

    -

    - - - - -
    - - - - -
    #define XSCL_OUTSIZE_NUMLINE_MASK   0x1FFF0000
    -
    - - - - - -
    -   - - -

    -The number of lines in output rectangle

    -

    - - - - -
    - - - - -
    #define XSCL_OUTSIZE_NUMLINE_SHIFT   16
    -
    - - - - - -
    -   - - -

    -Shift for the number of lines

    -

    - - - - -
    - - - - -
    #define XSCL_OUTSIZE_NUMPXL_MASK   0x00001FFF
    -
    - - - - - -
    -   - - -

    -The number of pixels in output rectangle

    -

    - - - - -
    - - - - -
    #define XSCL_RESET_RESET_MASK   0x80000000
    -
    - - - - - -
    -   - - -

    -Software reset bit

    -

    - - - - -
    - - - - -
    #define XSCL_SRCSIZE   0x108
    -
    - - - - - -
    -   - - -

    -Source-video resolution

    -

    - - - - -
    - - - - -
    #define XSCL_SRCSIZE_NUMLINE_MASK   0x1FFF0000
    -
    - - - - - -
    -   - - -

    -The number of lines in source image

    -

    - - - - -
    - - - - -
    #define XSCL_SRCSIZE_NUMLINE_SHIFT   16
    -
    - - - - - -
    -   - - -

    -Shift for the number of lines

    -

    - - - - -
    - - - - -
    #define XSCL_SRCSIZE_NUMPXL_MASK   0x00001FFF
    -
    - - - - - -
    -   - - -

    -The number of pixels in source image

    -

    - - - - -
    - - - - -
    #define XSCL_STATUS   0x004
    -
    - - - - - -
    -   - - -

    -Status

    -

    - - - - -
    - - - - -
    #define XSCL_STS_COEF_W_RDY_MASK   0x00000001
    -
    - - - - - -
    -   - - -

    -If 1, Coefficient values can be written into the core

    -

    - - - - -
    - - - - -
    #define XSCL_STSDONE_DONE   0x00000001
    -
    - - - - - -
    -   - - -

    -indicator of end of scaler operation

    -

    - - - - -
    - - - - -
    #define XSCL_STSERR_CODE0_MASK   0x000000FF
    -
    - - - - - -
    -   - - -

    -code 0

    -

    - - - - -
    - - - - -
    #define XSCL_STSERR_CODE1_MASK   0x0000FF00
    -
    - - - - - -
    -   - - -

    -code 1

    -

    - - - - -
    - - - - -
    #define XSCL_STSERR_CODE2_MASK   0x00FF0000
    -
    - - - - - -
    -   - - -

    -code 2

    -

    - - - - -
    - - - - -
    #define XSCL_STSERR_CODE3_MASK   0xFF000000
    -
    - - - - - -
    -   - - -

    -code 3

    -

    - - - - -
    - - - - -
    #define XSCL_VER   0x010
    -
    - - - - - -
    -   - - -

    -Version Register

    -

    - - - - -
    - - - - -
    #define XSCL_VSF   0x104
    -
    - - - - - -
    -   - - -

    -Vertical Shrink Factor

    -

    - - - - -
    - - - - -
    #define XSCL_VSF_FRAC_MASK   0x000FFFFF
    -
    - - - - - -
    -   - - -

    -Vertical Shrink Factor fractional

    -

    - - - - -
    - - - - -
    #define XSCL_VSF_INT_MASK   0x00F00000
    -
    - - - - - -
    -   - - -

    -Vertical Shrink Factor integer

    +

    Note:
    C-style signature: void XScaler_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)
    + + +

    + +

    +
    + + + + +
    #define XSCL_APTHORI   XSCL_APTHORI_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_APTHORI_FIRSTPXL_MASK   0x00001FFF
    +
    +
    + +

    +Location of first pixel in line +

    +

    + +

    +
    + + + + +
    #define XSCL_APTHORI_LASTPXL_MASK   0x1FFF0000
    +
    +
    + +

    +Location of last pixel in line +

    +

    + +

    +
    + + + + +
    #define XSCL_APTHORI_LASTPXL_SHIFT   16
    +
    +
    + +

    +Shift for location of last pixel +

    +

    + +

    +
    + + + + +
    #define XSCL_APTHORI_OFFSET   0x10C
    +
    +
    + +

    +First and last subject pixels in input line Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_APTVERT   XSCL_APTVERT_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_APTVERT_FIRSTLINE_MASK   0x00001FFF
    +
    +
    + +

    +Location of first line in active video +

    +

    + +

    +
    + + + + +
    #define XSCL_APTVERT_LASTLINE_MASK   0x1FFF0000
    +
    +
    + +

    +Location of last line in active video +

    +

    + +

    +
    + + + + +
    #define XSCL_APTVERT_LASTLINE_SHIFT   16
    +
    +
    + +

    +Shift for location of last line +

    +

    + +

    +
    + + + + +
    #define XSCL_APTVERT_OFFSET   0x110
    +
    +
    + +

    +First and last subject lines in input image Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_CHROMA_FORMAT_420   1
    +
    +
    + +

    +YUV4:2:0 +

    +

    + +

    +
    + + + + +
    #define XSCL_CHROMA_FORMAT_422   2
    +
    +
    + +

    +YUV4:2:2 +

    +

    + +

    +
    + + + + +
    #define XSCL_CHROMA_FORMAT_444   3
    +
    +
    + +

    +YUV4:4:4 +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_MEM   XSCL_COEFF_MEM_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_MEM_OFFSET   0x13C
    +
    +
    + +

    +Coefficient mem read address Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_SELECT_BANK_MASK   0x00000003
    +
    +
    + +

    +Select require bank Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_SELECT_SET_MASK   0x00000F00
    +
    +
    + +

    +Select require Set Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_SET_BANK   XSCL_COEFF_SET_BANK_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFF_SET_BANK_OFFSET   0x138
    +
    +
    + +

    +Coefficient set/bank read address Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETADDR   XSCL_COEFFSETADDR_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETADDR_ADDR_MASK   0x0000000F
    +
    +
    + +

    +Address of the Coefficient bank to write next +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETADDR_OFFSET   0x130
    +
    +
    + +

    +Address of Coefficient set to write Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETS   XSCL_COEFFSETS_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETS_HORI_MASK   0x0000000F
    +
    +
    + +

    +Active horizontal coefficient set +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETS_OFFSET   0x11C
    +
    +
    + +

    +Active horizontal and vertical coefficient sets to use Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETS_VERT_MASK   0x000000F0
    +
    +
    + +

    +Active vertical coefficient set +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFSETS_VERT_SHIFT   4
    +
    +
    + +

    +Active vertical coefficient set shift +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFVALUE   XSCL_COEFFVALUE_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFVALUE_N_MASK   0x0000FFFF
    +
    +
    + +

    +First value in the pair +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFVALUE_NPLUS1_MASK   0xFFFF0000
    +
    +
    + +

    +Second value in the pair +

    +

    + +

    +
    + + + + +
    #define XSCL_COEFFVALUE_OFFSET   0x134
    +
    +
    + +

    +Coefficient values to write Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL   XSCL_CTL_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_ENABLE   XSCL_CTL_SW_EN_MASK
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_MEMRD_EN_MASK   0x00000008
    +
    +
    + +

    +Coefficient Memory Read Enable Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_OFFSET   0x000
    +
    +
    + +

    +Control Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_REGUPDATE   XSCL_CTL_RUE_MASK
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_RESET_MASK   0x80000000
    +
    +
    + +

    +Software reset bit Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_RUE_MASK   0x00000002
    +
    +
    + +

    +Register Update Enable Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_CTL_SW_EN_MASK   0x00000001
    +
    +
    + +

    +Enable the Scaler on the next video frame Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_ERR_COEFF_WR_MASK   0x00000010
    +
    +
    + +

    +Error while Writing a Coefficient into core +

    +

    + +

    +
    + + + + +
    #define XSCL_ERR_EOL_MASK   0x00000001
    +
    +
    + +

    +End of line Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_ERR_SOF_MASK   0x00000004
    +
    +
    + +

    +Error in starting a frame Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_ERROR   XSCL_ERROR_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_ERROR_OFFSET   0x008
    +
    +
    + +

    +Error Status Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMALEFT   XSCL_FRCTCHROMALEFT_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMALEFT_OFFSET   0x124
    +
    +
    + +

    +Fractional value used to initialize horizontal accumulator at rectangle left edge for chroma Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMALEFT_VALUE_MASK   0x001FFFFF
    +
    +
    + +

    +Fractional value to initialize horizontal accumulator for chroma +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMATOP   XSCL_FRCTCHROMATOP_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMATOP_OFFSET   0x12C
    +
    +
    + +

    +Fractional value used to initialize horizontal accumulator at rectangle top edge for chroma Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTCHROMATOP_VALUE_MASK   0x001FFFFF
    +
    +
    + +

    +Fractional value to initialize vertical accumulator for chroma +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMALEFT   XSCL_FRCTLUMALEFT_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMALEFT_OFFSET   0x120
    +
    +
    + +

    +Fractional value used to initialize horizontal accumulator at rectangle left edge for luma Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMALEFT_VALUE_MASK   0x001FFFFF
    +
    +
    + +

    +Fractional value to initialize horizontal .....*..accumulator for luma +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMATOP   XSCL_FRCTLUMATOP_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMATOP_OFFSET   0x128
    +
    +
    + +

    +Fractional value used to initialize horizontal accumulator at rectangle top edge for luma Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_FRCTLUMATOP_VALUE_MASK   0x001FFFFF
    +
    +
    + +

    +Fractional value to initialize vertical accumulator for luma +

    +

    + +

    +
    + + + + +
    #define XSCL_HSF   XSCL_HSF_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_HSF_FRAC_MASK   0x00FFFFFF
    +
    +
    + +

    +Horizontal Shrink Factor fractional Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_HSF_OFFSET   0x100
    +
    +
    + +

    +Horizontal Shrink Factor Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_IER   XSCL_IRQ_EN_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_IRQ_EN_OFFSET   0x00C
    +
    +
    + +

    +For detecting operation status Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_IXR_COEF_W_RDY_MASK   0x00000001
    +
    +
    + +

    +If 1, Coefficient values can be written into the core Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_NUMPHASE   XSCL_NUMPHASE_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_NUMPHASE_HORI_MASK   0x0000007F
    +
    +
    + +

    +The number of horizontal phases +

    +

    + +

    +
    + + + + +
    #define XSCL_NUMPHASE_OFFSET   0x118
    +
    +
    + +

    +The numbers of phases in current filter Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_NUMPHASE_VERT_MASK   0x00007F00
    +
    +
    + +

    +The number of vertical phases +

    +

    + +

    +
    + + + + +
    #define XSCL_NUMPHASE_VERT_SHIFT   8
    +
    +
    + +

    +Shift for the number of vertical phases +

    +

    + +

    +
    + + + + +
    #define XSCL_OUTSIZE   XSCL_OUTSIZE_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_OUTSIZE_NUMLINE_MASK   0x1FFF0000
    +
    +
    + +

    +The number of lines in output rectangle +

    +

    + +

    +
    + + + + +
    #define XSCL_OUTSIZE_NUMLINE_SHIFT   16
    +
    +
    + +

    +Shift for the number of lines +

    +

    + +

    +
    + + + + +
    #define XSCL_OUTSIZE_NUMPXL_MASK   0x00001FFF
    +
    +
    + +

    +The number of pixels in output rectangle +

    +

    + +

    +
    + + + + +
    #define XSCL_OUTSIZE_OFFSET   0x114
    +
    +
    + +

    +Output image size: width and height Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_RESET_RESET_MASK   XSCL_CTL_RESET_MASK
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_SRCSIZE   XSCL_SRCSIZE_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_SRCSIZE_NUMLINE_MASK   0x1FFF0000
    +
    +
    + +

    +The number of lines in source image +

    +

    + +

    +
    + + + + +
    #define XSCL_SRCSIZE_NUMLINE_SHIFT   16
    +
    +
    + +

    +Shift for the number of lines +

    +

    + +

    +
    + + + + +
    #define XSCL_SRCSIZE_NUMPXL_MASK   0x00001FFF
    +
    +
    + +

    +The number of pixels in source image +

    +

    + +

    +
    + + + + +
    #define XSCL_SRCSIZE_OFFSET   0x108
    +
    +
    + +

    +Source-video resolution Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_STATUS   XSCL_STATUS_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_STATUS_OFFSET   0x004
    +
    +
    + +

    +Status Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_STS_COEF_W_RDY_MASK   XSCL_IXR_COEF_W_RDY_MASK
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_STSDONE_DONE   XSCL_IXR_COEF_W_RDY_MASK
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_VER   XSCL_VER_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_VER_OFFSET   0x010
    +
    +
    + +

    +Version Register Offset +

    +

    + +

    +
    + + + + +
    #define XSCL_VSF   XSCL_VSF_OFFSET
    +
    +
    + +

    + +

    +

    + +

    +
    + + + + +
    #define XSCL_VSF_FRAC_MASK   0x00FFFFFF
    +
    +
    + +

    +Vertical Shrink Factor fractional Mask +

    +

    + +

    +
    + + + + +
    #define XSCL_VSF_OFFSET   0x104
    +
    +
    + +

    +Vertical Shrink Factor Offset +

    +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__intr_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__intr_8c.html index 55ef7a39..577fa143 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__intr_8c.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__intr_8c.html @@ -9,7 +9,7 @@

    Software Drivers
    - +

    xscaler_intr.c File Reference


    Detailed Description

    -This code contains interrupt related functions of 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. Please see xscaler.h for more details of the driver.

    +This code contains interrupt related functions of 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. Please see xscaler.h for more details of the driver.

      MODIFICATION HISTORY:

    -

     Ver	Who  Date     Changes
    - ----- ---- -------- -------------------------------------------------------
    - 1.00a xd   02/10/09 First release
    - 2.00a xd   12/14/09 Updated doxygen document tags
    +
     Ver   Who    Date     Changes
    + ----- ------ -------- ------------------------------------------------------
    + 1.00a xd     02/10/09 First release.
    + 2.00a xd     12/14/09 Updated Doxygen document tags.
    + 7.0   adk    08/22/14 XScaler_IntrHandler and XScaler_SetCallBack APIs were
    +                       modified
      

    -#include "xscaler.h"
    +#include "xscaler.h"
    - + - +

    Functions

    void XScaler_IntrHandler (void *InstancePtr)
    void XScaler_IntrHandler (void *InstancePtr)
    int XScaler_SetCallBack (XScaler *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)
    void XScaler_SetCallBack (XScaler *InstancePtr, void *CallBackFunc, void *CallBackRef)


    Function Documentation

    -

    - - - - -
    - + +
    +
    +
    - - - - - - + + + + + +
    void XScaler_IntrHandler void *  InstancePtr  ) void XScaler_IntrHandler (void *  InstancePtr  ) 
    -
    - - - -
    -   - + +

    This function is the interrupt handler for the Scaler driver.

    -This handler reads the pending interrupt from the IER/ISR, determines the source of the interrupts, calls according callbacks, 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 XScaler_SetCallBack() during initialization phase. An example delivered with this driver demonstrates how this could be done.

    +This handler calls callback, 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 XScaler_SetCallBack() during initialization phase.

    Parameters:
    @@ -76,81 +70,52 @@ The application is responsible for connecting this function to the interrupt sys
    Returns:
    None.
    Note:
    None.
    - - -
    InstancePtr is a pointer to the XScaler instance that just interrupted.
    -

    - - - - -
    - + + +

    + +

    +
    +
    - - - - + + + + - - - - + + + + - - - - + + + + - - - - - - - - - + + +
    int XScaler_SetCallBack XScaler InstancePtr, void XScaler_SetCallBack (XScaler InstancePtr,
    u32  HandlerType, void *  CallBackFunc,
    void *  CallBackFunc, void *  CallBackRef 
    void *  CallBackRef
    )
    -
    - - - - - -
    -   - + +

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

    -

    - HandlerType		   Callback Function Type
    - -----------------------  ---------------------------
    - XSCL_HANDLER_EVENT	   XScaler_CallBack
    - XSCL_HANDLER_ERROR	   XScaler_CallBack

    -

     HandlerType		   Invoked by this driver when:
    - -----------------------  --------------------------------------------------
    - XSCL_HANDLER_EVENT	   A normal event just happened. Normal events include
    -			   frame done, Coefficient FIFO Ready and Shadow
    -			   Register updated.

    -

     XSCL_HANDLER_ERROR	   An error just happened.

    -

     

    +This routine installs an asynchronous callback function.

    Parameters:
    -
    InstancePtr is a pointer to the XScaler 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.
    -
    +

    Returns:
    None.
    +
    Note:
    None.
    + +
    +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__selftest_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__selftest_8c.html new file mode 100755 index 00000000..7bbbaab4 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__selftest_8c.html @@ -0,0 +1,72 @@ + + + + + xscaler_selftest.c File Reference + + + +

    +Software Drivers +
    + + + +

    xscaler_selftest.c File Reference


    Detailed Description

    +This file contains the self-test function for the Scaler core.

    +

    + MODIFICATION HISTORY:

    +

     Ver   Who    Date      Changes
    + ----- ------ --------  ----------------------------------------------
    + 7.00  adk    21/03/14  First Release.
    + 
    +

    +#include "xscaler.h"
    +#include "xstatus.h"
    + + + + + +

    Functions

    int XScaler_SelfTest (XScaler *InstancePtr)
    +


    Function Documentation

    + +
    +
    + + + + + + + + + +
    int XScaler_SelfTest (XScaler InstancePtr  ) 
    +
    +
    + +

    +This function reads version register of Scaler core and compares with zero value as part of self test.

    +

    Parameters:
    + + +
    InstancePtr is a pointer to the XScaler instance.
    +
    +
    Returns:
      +
    • XST_SUCCESS if the XScaler_SelfTest was successful.
    • XST_FAILURE if the XScaler_SelfTest failed.
    +
    +
    Note:
    None.
    + +
    +

    +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__sinit_8c.html b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__sinit_8c.html index b150f5f2..6139b73f 100755 --- a/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__sinit_8c.html +++ b/XilinxProcessorIPLib/drivers/scaler/doc/html/api/xscaler__sinit_8c.html @@ -9,7 +9,7 @@

    Software Drivers
    - +
    • Main Page
    • @@ -25,44 +25,36 @@ This file contains static initialization methods for Xilinx MVI Video Scaler device driver.

        MODIFICATION HISTORY:

      -

       Ver	Who	Date	 Changes
      - -----	----	-------- -------------------------------------------------------
      - 1.00a	xd	05/14/09 First release
      - 2.00a	xd	12/14/09 Updated doxygen document tags
      +
       Ver    Who  Date     Changes
      + ----- ----  -------- -------- -------------------------------------------------------
      + 1.00a  xd   05/14/09 First release
      + 2.00a  xd   12/14/09 Updated doxygen document tags
        

      -#include "xscaler.h"
      +#include "xscaler.h"
      #include "xparameters.h"
      - +

      Functions

      XScaler_ConfigXScaler_LookupConfig (u16 DeviceId)
      XScaler_ConfigXScaler_LookupConfig (u16 DeviceId)


      Function Documentation

      -

      - - - - -
      - + +
      +
      +
      - - - - - - + + + + + +
      XScaler_Config* XScaler_LookupConfig u16  DeviceId  ) XScaler_Config* XScaler_LookupConfig (u16  DeviceId  ) 
      -
      - - - - - -
      -   - + +

      XScaler_LookupConfig returns a reference to an XScaler_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 xscaler_g.c file.

      @@ -72,7 +64,7 @@ XScaler_LookupConfig returns a reference to an xscaler_g.c) corresponding to DeviceId, or NULL if no match is found. -

      + +

    +

    Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.