hwicap: xhwicap.h File Reference

| hwicap Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Data Structures | Macros | Typedefs | Functions
xhwicap.h File Reference

## Data Structures
struct | XHwIcap_Config
| This typedef contains configuration information for the device. More...
struct | XHwIcap
| The XHwIcap driver instance data. More...

## Macros
#define | PCAP_CR_OFFSET 0xFFCA3008
| PCAP CR Register. More...
#define | XHwIcap_FifoWrite(InstancePtr, Data)
| Write data to the Write FIFO. More...
#define | XHwIcap_FifoRead(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_RF_OFFSET))
| Read data from the Read FIFO. More...
#define | XHwIcap_SetSizeReg(InstancePtr, Data)
| Set the number of words to be read from the Icap in the Size register. More...
#define | XHwIcap_GetControlReg(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_CR_OFFSET))
| Get the contents of the Control register. More...
#define | XHwIcap_StartConfig(InstancePtr)
| Set the Control Register to initiate a configuration (write) to the device. More...
#define | XHwIcap_StartReadBack(InstancePtr)
| Set the Control Register to initiate a ReadBack from the device. More...
#define | XHwIcap_GetStatusReg(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_SR_OFFSET))
| Get the contents of the status register. More...
#define | XHwIcap_IsTransferDone(InstancePtr) ((InstancePtr->IsTransferInProgress) ? FALSE : TRUE)
| This macro checks if the last Read/Write of the data to the Read/Write FIFO of the HwIcap device is completed. More...
#define | XHwIcap_IsDeviceBusy(InstancePtr)
| This macro checks if the last Read/Write to the ICAP device in the FPGA is completed. More...
#define | XHwIcap_IntrGlobalEnable(InstancePtr)
| This macro enables the global interrupt in the Global Interrupt Enable Register (GIER) so that the interrupt output from the HwIcap device is enabled. More...
#define | XHwIcap_IntrGlobalDisable(InstancePtr)
| This macro disables the global interrupt in the Global Interrupt Enable Register (GIER) so that the interrupt output from the HwIcap device is disabled. More...
#define | XHwIcap_IntrGetStatus(InstancePtr)
| This macro returns the interrupt status read from Interrupt Status Register(IPISR). More...
#define | XHwIcap_IntrDisable(InstancePtr, IntrMask)
| This macro disables the specified interrupts in the Interrupt Enable Register. More...
#define | XHwIcap_IntrEnable(InstancePtr, IntrMask)
| This macro enables the specified interrupts in the Interrupt Enable Register. More...
#define | XHwIcap_IntrGetEnabled(InstancePtr)
| This macro returns the interrupt status read from Interrupt Enable Register(IIER). More...
#define | XHwIcap_IntrClear(InstancePtr, IntrMask)
| This macro clears the specified interrupts in the Interrupt Status Register (IPISR). More...
#define | XHwIcap_GetWrFifoVacancy(InstancePtr) XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_WFV_OFFSET)
| This macro returns the vacancy of the Write FIFO. More...
#define | XHwIcap_GetRdFifoOccupancy(InstancePtr) XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_RFO_OFFSET)
| This macro returns the occupancy of the Read FIFO. More...

## Typedefs
typedef void(* | XHwIcap_StatusHandler )(void *CallBackRef, u32 StatusEvent, u32 WordCount)
| The handler data type allows the user to define a callback function to handle the asynchronous processing of the HwIcap driver. More...

## Functions
int | XHwIcap_CfgInitialize (XHwIcap *InstancePtr, XHwIcap_Config *ConfigPtr, UINTPTR EffectiveAddr)
| This function initializes a specific XHwIcap instance. More...
int | XHwIcap_DeviceWrite (XHwIcap *InstancePtr, u32 *FrameBuffer, u32 NumWords)
| This function writes the given user data to the Write FIFO in both the polled mode and the interrupt mode and starts the transfer of the data to the ICAP device. More...
int | XHwIcap_DeviceRead (XHwIcap *InstancePtr, u32 *FrameBuffer, u32 NumWords)
| This function reads the specified number of words from the ICAP device in the polled mode. More...
void | XHwIcap_Reset (XHwIcap *InstancePtr)
| This function forces the software reset of the complete HWICAP device. More...
void | XHwIcap_FlushFifo (XHwIcap *InstancePtr)
| This function flushes the FIFOs in the device. More...
void | XHwIcap_Abort (XHwIcap *InstancePtr)
| This function initiates the Abort Sequence by setting the Abort bit in the control register. More...
XHwIcap_Config * | XHwIcap_LookupConfig (u16 DeviceId)
| Looks up the device configuration based on the unique device ID. More...
int | XHwIcap_CommandDesync (XHwIcap *InstancePtr)
| Sends a DESYNC command to the ICAP port. More...
int | XHwIcap_CommandCapture (XHwIcap *InstancePtr)
| Sends a CAPTURE command to the ICAP port. More...
u32 | XHwIcap_GetConfigReg (XHwIcap *InstancePtr, u32 ConfigReg, u32 *RegData)
| This function returns the value of the specified configuration register. More...
int | XHwIcap_SelfTest (XHwIcap *InstancePtr)
| Run a self-test on the driver/device. More...
void | XHwIcap_IntrHandler (void *InstancePtr)
| The interrupt handler for HwIcap interrupts. More...
void | XHwIcap_SetInterruptHandler (XHwIcap *InstancePtr, void *CallBackRef, XHwIcap_StatusHandler FuncPtr)
| Sets the status callback function, the status handler, which the driver calls when it encounters conditions that should be reported to the higher layer software. More...
int | XHwIcap_DeviceReadFrame (XHwIcap *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameBuffer)
| Reads one frame from the device and puts it in memory specified by the user. More...
int | XHwIcap_DeviceWriteFrame (XHwIcap *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameData)
| Writes one frame from the specified buffer and puts it in the device (ICAP). More...