v_multi_scaler
Xilinx SDK Drivers API Documentation
V_multi_scaler_v1_0

Functions

void XVMultiScaler_SetCallback (XV_multi_scaler *InstancePtr, void *CallbackFunc, void *CallbackRef)
 This function installs an asynchronous callback function: More...
 
void * XV_MultiScalerIntrHandler (void *InstancePtr)
 This function is the interrupt handler for the MultiScaler core driver. More...
 
void XV_MultiScalerStart (XV_multi_scaler *InstancePtr)
 This function starts the multi scaler core. More...
 
void XV_MultiScalerStop (XV_multi_scaler *InstancePtr)
 This function stops the multi scaler core. More...
 
u32 XV_MultiScalerGetNumOutputs (XV_multi_scaler *InstancePtr)
 This function returns the number of outputs. More...
 
void XV_MultiScalerSetNumOutputs (XV_multi_scaler *InstancePtr, u32 NumOuts)
 This function sets the number of outputs. More...
 
void XV_MultiScalerGetChannelConfig (XV_multi_scaler *InstancePtr, XV_multi_scaler_Video_Config *MS_cfg)
 This function reads the channel configuration. More...
 
void XV_MultiScalerSetChannelConfig (XV_multi_scaler *InstancePtr, XV_multi_scaler_Video_Config *MS_cfg)
 This function configures the scaler core registers with the specified configuration parameters. More...
 

Function Documentation

◆ XV_MultiScalerGetChannelConfig()

void XV_MultiScalerGetChannelConfig ( XV_multi_scaler *  InstancePtr,
XV_multi_scaler_Video_Config *  MS_cfg 
)

#include <xv_multi_scaler_l2.c>

This function reads the channel configuration.

The ChannelId of the channel for which the configuration info is needed has to be filled by the application in the MS_cfg structure.

Parameters
InstancePtris a pointer to the core instance to be worked on.
MS_cfgis a pointer to the multi scaler config structure.
Returns
None

◆ XV_MultiScalerGetNumOutputs()

u32 XV_MultiScalerGetNumOutputs ( XV_multi_scaler *  InstancePtr)

#include <xv_multi_scaler_l2.c>

This function returns the number of outputs.

Parameters
InstancePtris a pointer to the core instance to be worked on.
Returns
number of outputs

◆ XV_MultiScalerIntrHandler()

void* XV_MultiScalerIntrHandler ( void *  InstancePtr)

#include <xv_multi_scaler_intr.c>

This function is the interrupt handler for the MultiScaler core driver.

This handler clears the pending interrupt and determines if the source is frame done signal. If yes, calls the registered callback function.

The application is responsible for connecting this function to the interrupt system.

Parameters
InstancePtris a pointer to the core instance that just interrupted.
Returns
None.
Note
None.

◆ XV_MultiScalerSetChannelConfig()

void XV_MultiScalerSetChannelConfig ( XV_multi_scaler *  InstancePtr,
XV_multi_scaler_Video_Config *  MS_cfg 
)

#include <xv_multi_scaler_l2.c>

This function configures the scaler core registers with the specified configuration parameters.

Parameters
InstancePtris a pointer to the core instance to be worked on.
MS_cfgis a pointer to the multi scaler config structure.
Returns
None

◆ XV_MultiScalerSetNumOutputs()

void XV_MultiScalerSetNumOutputs ( XV_multi_scaler *  InstancePtr,
u32  NumOuts 
)

#include <xv_multi_scaler_l2.c>

This function sets the number of outputs.

Parameters
InstancePtris a pointer to the core instance to be worked on.
NumOutsis the number of output channels.
Returns
None

◆ XV_MultiScalerStart()

void XV_MultiScalerStart ( XV_multi_scaler *  InstancePtr)

#include <xv_multi_scaler_l2.c>

This function starts the multi scaler core.

Parameters
InstancePtris a pointer to the core instance to be worked on.
Returns
None

◆ XV_MultiScalerStop()

void XV_MultiScalerStop ( XV_multi_scaler *  InstancePtr)

#include <xv_multi_scaler_l2.c>

This function stops the multi scaler core.

Parameters
InstancePtris a pointer to the core instance to be worked on.
Returns
None

◆ XVMultiScaler_SetCallback()

void XVMultiScaler_SetCallback ( XV_multi_scaler *  InstancePtr,
void *  CallbackFunc,
void *  CallbackRef 
)

#include <xv_multi_scaler_intr.c>

This function installs an asynchronous callback function:

Parameters
InstancePtris a pointer to the MultiScaler IP instance.
CallbackFuncis the address of the callback function.
CallbackRefis a user data item that will be passed to the callback function when it is invoked.
Returns
None.
Note
Invoking this function for a handler that already has been installed replaces it with the new handler.