vprocss
Xilinx SDK Drivers API Documentation
Vprocss_v2_4

Macros

#define XVPROCSS_LOG_H
 < prevent circular inclusions by using protection macros More...
 
#define XVPROCSS_EVT_BUFFSIZE   256
 Data structure for the event logging mechanism for debug. More...
 
#define XVPROCSS_EDAT_SUCCESS   0x00
 Event Log status codes. More...
 

Enumerations

enum  XVprocSs_LogEvent {
  XVPROCSS_EVT_NONE = 1, XVPROCSS_EVT_INIT, XVPROCSS_EVT_INIT_RESAXIS, XVPROCSS_EVT_INIT_RESAXIM,
  XVPROCSS_EVT_INIT_ROUTER, XVPROCSS_EVT_INIT_LBOX, XVPROCSS_EVT_INIT_VDMA, XVPROCSS_EVT_CFGERR_VDMA,
  XVPROCSS_EVT_OPERR_VDMA, XVPROCSS_EVT_CFG_HSCALER, XVPROCSS_EVT_CFG_VSCALER, XVPROCSS_EVT_CFG_CSC,
  XVPROCSS_EVT_CFG_DEINT, XVPROCSS_EVT_CFG_VCRI, XVPROCSS_EVT_CFG_VCRO, XVPROCSS_EVT_CFG_HCR,
  XVPROCSS_EVT_CFG_MAX, XVPROCSS_EVT_CFG_VPSS, XVPROCSS_EVT_CHK_TOPO, XVPROCSS_EVT_CHK_BASEADDR,
  XVPROCSS_EVT_SET_PIPMODE, XVPROCSS_EVT_SET_ZOOMMODE, XVPROCSS_EVT_SET_PIPWIN, XVPROCSS_EVT_SET_ZOOMWIN,
  XVPROCSS_EVT_GET_ZPWIN, XVPROCSS_EVT_UPDATE_ZPWIN, XVPROCSS_EVT_RESET_VPSS, XVPROCSS_EVT_START_VPSS,
  XVPROCSS_EVT_STOP_VPSS, XVPROCSS_EVT_LAST_ENUM
}
 This typedef contains the Event Log identifiers. More...
 

Functions

int XVprocSs_SubcoreInitResetAxis (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitResetAximm (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitRouter (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitCsc (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitHScaler (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitVScaler (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitHCrsmplr (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitVCrsmpleIn (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitVCrsmpleOut (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitLetterbox (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitVdma (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_SubcoreInitDeinterlacer (XVprocSs *XVprocSsPtr)
 This function initializes the included sub-core to it's static configuration. More...
 
int XVprocSs_BuildRoutingTable (XVprocSs *XVprocSsPtr)
 This function examines the subsystem Input/Output Stream configuration and builds a routing table for the supported use-case. More...
 
void XVprocSs_ProgRouterMux (XVprocSs *XVprocSsPtr)
 This function traverses the computed routing table and sets up the AXIS switch registers, to route the stream through processing cores, in the order defined in the routing map. More...
 
void XVprocSs_SetupRouterDataFlow (XVprocSs *XVprocSsPtr)
 This function traverses the routing map built earlier and configures each sub-core in the processing path per its location in the chain. More...
 
XVprocSs_ConfigXVprocSs_LookupConfig (u32 DeviceId)
 This function looks for the device configuration based on the unique device ID. More...
 

Variables

u16 XVprocSs_Log::DataBuffer [XVPROCSS_EVT_BUFFSIZE]
 Log buffer with event data. More...
 
u8 XVprocSs_Log::HeadIndex
 Index of the head entry of the Event/DataBuffer. More...
 
u8 XVprocSs_Log::TailIndex
 Index of the tail entry of the Event/DataBuffer. More...
 

Macro Definition Documentation

◆ XVPROCSS_EDAT_SUCCESS

#define XVPROCSS_EDAT_SUCCESS   0x00

#include <xvprocss_log.h>

Event Log status codes.

These are the event data values.

0x00 - 0x0F : Successful events - applicable to VPSS and subcores 0xF0 - 0xFF : Error events - applicable to VPSS and subcores

0x10 ... : Successful events - applicable to particular subcores ... 0xEF : Error events - applicable to particular subcores

Referenced by XVprocSs_Stop(), and XVprocSs_UpdateZoomPipWindow().

◆ XVPROCSS_EVT_BUFFSIZE

#define XVPROCSS_EVT_BUFFSIZE   256

#include <xvprocss_log.h>

Data structure for the event logging mechanism for debug.

Referenced by XVprocSs_LogRead(), and XVprocSs_LogWrite().

◆ XVPROCSS_LOG_H

#define XVPROCSS_LOG_H

#include <xvprocss_log.h>

< prevent circular inclusions by using protection macros

Enumeration Type Documentation

◆ XVprocSs_LogEvent

#include <xvprocss_log.h>

This typedef contains the Event Log identifiers.

Enumerator
XVPROCSS_EVT_NONE 

Log event none.

XVPROCSS_EVT_INIT 

Log event init.

XVPROCSS_EVT_INIT_RESAXIS 

Log event init status of Reset Axis subcore.

XVPROCSS_EVT_INIT_RESAXIM 

Log event init status of Reset Aximm subcore.

XVPROCSS_EVT_INIT_ROUTER 

Log event init status of Router subcore.

XVPROCSS_EVT_INIT_LBOX 

Log event init status of Letterbox subcore.

XVPROCSS_EVT_INIT_VDMA 

Log event init status of VDMA subcore.

XVPROCSS_EVT_CFGERR_VDMA 

Log event VDMA configuration error.

XVPROCSS_EVT_OPERR_VDMA 

Log event VDMA operation error.

XVPROCSS_EVT_CFG_HSCALER 

Log event Scaler config status.

XVPROCSS_EVT_CFG_VSCALER 

Log event Scaler config status.

XVPROCSS_EVT_CFG_CSC 

Log event Csc config status.

XVPROCSS_EVT_CFG_DEINT 

Log event Deinterlacer config status.

XVPROCSS_EVT_CFG_VCRI 

Log event VCResampler config status.

XVPROCSS_EVT_CFG_VCRO 

Log event VCResampler config status.

XVPROCSS_EVT_CFG_HCR 

Log event HCResampler config status.

XVPROCSS_EVT_CFG_MAX 

Log event Full Fledged config status.

XVPROCSS_EVT_CFG_VPSS 

Log event VPSS config status.

XVPROCSS_EVT_CHK_TOPO 

Log event check Topology.

XVPROCSS_EVT_CHK_BASEADDR 

Log event check Frame buffer base address.

XVPROCSS_EVT_SET_PIPMODE 

Log event Set Pip Mode.

XVPROCSS_EVT_SET_ZOOMMODE 

Log event Set Zoom Mode.

XVPROCSS_EVT_SET_PIPWIN 

Log event Set Pip window.

XVPROCSS_EVT_SET_ZOOMWIN 

Log event Set Zoom window.

XVPROCSS_EVT_GET_ZPWIN 

Log event Get Zoom/Pip window.

XVPROCSS_EVT_UPDATE_ZPWIN 

Log event Update Zoom/Pip window status.

XVPROCSS_EVT_RESET_VPSS 

Log event Reset the VPSS.

XVPROCSS_EVT_START_VPSS 

Log event Start the VPSS.

XVPROCSS_EVT_STOP_VPSS 

Log event Stop the VPSS.

XVPROCSS_EVT_LAST_ENUM 

(dummy event: marks last enum)

Function Documentation

◆ XVprocSs_BuildRoutingTable()

int XVprocSs_BuildRoutingTable ( XVprocSs XVprocSsPtr)

#include <xvprocss_router.c>

This function examines the subsystem Input/Output Stream configuration and builds a routing table for the supported use-case.

The computed routing table is stored in the scratch pad memory

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS if routing table can be created else XST_FAILURE

References XVprocSs::CtxtData, XVprocSs_ContextData::RtngTable, XVprocSs_ContextData::ScaleMode, XVprocSs_ContextData::StrmCformat, XVprocSs::VidIn, XVprocSs_ContextData::VidInHeight, XVprocSs_ContextData::VidInWidth, and XVprocSs::VidOut.

◆ XVprocSs_LookupConfig()

XVprocSs_Config* XVprocSs_LookupConfig ( u32  DeviceId)

#include <xvprocss_sinit.c>

This function looks for the device configuration based on the unique device ID.

The table XVprocSs_ConfigTable[] contains the configuration information for each instance of the device in the system.

Parameters
DeviceIdis the unique device ID of the device being looked up
Returns
A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found

◆ XVprocSs_ProgRouterMux()

void XVprocSs_ProgRouterMux ( XVprocSs XVprocSsPtr)

#include <xvprocss_router.c>

This function traverses the computed routing table and sets up the AXIS switch registers, to route the stream through processing cores, in the order defined in the routing map.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
None

References XVprocSs::CtxtData, XVprocSs::RouterPtr, XVprocSs_ContextData::RtngTable, and XVprocSs_ContextData::RtrNumCores.

◆ XVprocSs_SetupRouterDataFlow()

void XVprocSs_SetupRouterDataFlow ( XVprocSs XVprocSsPtr)

#include <xvprocss_router.c>

This function traverses the routing map built earlier and configures each sub-core in the processing path per its location in the chain.

Each core in the processing path is marked and only marked cores are started All remaining cores stay disabled

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
None

References XVprocSs::CtxtData, XVprocSs_ContextData::RtngTable, XVprocSs_ContextData::ScaleMode, XVprocSs_ContextData::StartCore, XVprocSs::VdmaPtr, XVprocSs::VidIn, and XVprocSs_ContextData::VidInHeight.

◆ XVprocSs_SubcoreInitCsc()

int XVprocSs_SubcoreInitCsc ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XVprocSs_Config::Csc, XVprocSs::CscPtr, XSubCore::DeviceId, XVPROCSS_EVT_CFG_CSC, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitDeinterlacer()

int XVprocSs_SubcoreInitDeinterlacer ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XVprocSs_Config::Deint, XVprocSs::DeintPtr, XSubCore::DeviceId, XVPROCSS_EVT_CFG_DEINT, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitHCrsmplr()

int XVprocSs_SubcoreInitHCrsmplr ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::HCrsmplr, XVprocSs::HcrsmplrPtr, XVPROCSS_EVT_CFG_HCR, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitHScaler()

int XVprocSs_SubcoreInitHScaler ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::Hscale, XVprocSs::HscalerPtr, XVPROCSS_EVT_CFG_HSCALER, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitLetterbox()

int XVprocSs_SubcoreInitLetterbox ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::Lbox, XVprocSs::LboxPtr, XVPROCSS_EVT_INIT_LBOX, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitResetAximm()

int XVprocSs_SubcoreInitResetAximm ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::RstAximm, XVprocSs::RstAximmPtr, XVPROCSS_EVT_INIT_RESAXIM, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitResetAxis()

int XVprocSs_SubcoreInitResetAxis ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::RstAxis, XVprocSs::RstAxisPtr, XVPROCSS_EVT_INIT_RESAXIS, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitRouter()

int XVprocSs_SubcoreInitRouter ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::Router, XVprocSs::RouterPtr, XVPROCSS_EVT_INIT_ROUTER, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitVCrsmpleIn()

int XVprocSs_SubcoreInitVCrsmpleIn ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::VCrsmplrIn, XVprocSs::VcrsmplrInPtr, XVPROCSS_EVT_CFG_VCRI, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitVCrsmpleOut()

int XVprocSs_SubcoreInitVCrsmpleOut ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::VCrsmplrOut, XVprocSs::VcrsmplrOutPtr, XVPROCSS_EVT_CFG_VCRO, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitVdma()

int XVprocSs_SubcoreInitVdma ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::Vdma, XVprocSs::VdmaPtr, XVPROCSS_EVT_INIT_VDMA, and XVprocSs_LogWrite().

◆ XVprocSs_SubcoreInitVScaler()

int XVprocSs_SubcoreInitVScaler ( XVprocSs XVprocSsPtr)

#include <xvprocss_coreinit.c>

This function initializes the included sub-core to it's static configuration.

Parameters
XVprocSsPtris a pointer to the Subsystem instance to be worked on.
Returns
XST_SUCCESS/XST_FAILURE

References XVprocSs::Config, XSubCore::DeviceId, XVprocSs_Config::Vscale, XVprocSs::VscalerPtr, XVPROCSS_EVT_CFG_VSCALER, and XVprocSs_LogWrite().

Variable Documentation

◆ DataBuffer

u16 XVprocSs_Log::DataBuffer[XVPROCSS_EVT_BUFFSIZE]

Log buffer with event data.

◆ HeadIndex

u8 XVprocSs_Log::HeadIndex

Index of the head entry of the Event/DataBuffer.

◆ TailIndex

u8 XVprocSs_Log::TailIndex

Index of the tail entry of the Event/DataBuffer.