v_voip_decap
Xilinx SDK Drivers API Documentation
xdecap_intr.c File Reference

Overview

This file contains interrupt related functions for Xilinx VoIP Decapsulator core.

Please see xdecap.h for more details of the driver.

MODIFICATION HISTORY:
Ver   Who    Date     Changes

1.00 mmo 02/12/16 Initial release.
 

Typedefs

typedef struct ChArray XDecapChIntr
 This typedef contains Current Interrupt Information. More...
 

Functions

XDecapChIntr XDecap_ChIntr (XDecap *InstancePtr)
 This function scans through the Interrupt General Register to detect & store the information of the interrupted channel. More...
 
void XDecap_IntrHandler (void *InstancePtr)
 This function is the interrupt handler for the VoIP Decapsulator driver. More...
 
int XDecap_SetCallback (XDecap *InstancePtr, XDecap_HandlerType HandlerType, void *CallbackFunc, void *CallbackRef)
 This function installs an asynchronous callback function for the given HandlerType: More...
 

Typedef Documentation

◆ XDecapChIntr

typedef struct ChArray XDecapChIntr

This typedef contains Current Interrupt Information.

Function Documentation

◆ XDecap_ChIntr()

XDecapChIntr XDecap_ChIntr ( XDecap InstancePtr)

This function scans through the Interrupt General Register to detect & store the information of the interrupted channel.

Parameters
InstancePtris a pointer to the XDecap core instance.
Returns
None.
Note
None.

◆ XDecap_IntrHandler()

void XDecap_IntrHandler ( void *  InstancePtr)

This function is the interrupt handler for the VoIP Decapsulator driver.

This handler reads the pending interrupt from VoIP Decapsulator, determines the source of the interrupts, clears the interrupts and calls callbacks accordingly.

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 XDecap_SetCallback() during initialization phase. An example delivered with this driver demonstrates how this could be done.

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

References XDecap::IsReady.

◆ XDecap_SetCallback()

int XDecap_SetCallback ( XDecap InstancePtr,
XDecap_HandlerType  HandlerType,
void *  CallbackFunc,
void *  CallbackRef 
)

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

HandlerType                 Callback Function Type
-------------------------   -----------------------------------------------
Parameters
InstancePtris a pointer to the VoIP Decapsulator core instance.
HandlerTypespecifies the type of handler.
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
  • XST_SUCCESS if callback function installed successfully.
  • 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.