![]() |
osd
Xilinx SDK Drivers API Documentation
|
Data Structures | |
struct | XOsd_Config |
OSD core configuration structure. More... | |
struct | XOsd_Layer |
The OSD core layer info structure. More... | |
struct | XOsd |
The XOsd instance data. More... | |
Macros | |
#define | XOSD_H_ |
Prevent circular inclusions by using protection macros. More... | |
#define | XOsd_Enable(InstancePtr) |
This function macro enables an OSD core. More... | |
#define | XOsd_Disable(InstancePtr) |
This function macro disables an OSD core. More... | |
#define | XOsd_RegUpdateEnable(InstancePtr) |
This function macro commits all the register value changes made so far by the software to the OSD core instance. More... | |
#define | XOsd_RegUpdateDisable(InstancePtr) |
This function macro prevents the OSD core from committing recent changes made so far by the software. More... | |
#define | XOsd_Reset(InstancePtr) |
This function macro resets an OSD core This effects the core immediately, and may cause image tearing. More... | |
#define | XOsd_IntrEnable(InstancePtr, IntrType) |
This function macro enables the given individual interrupt(s) on the OSD core. More... | |
#define | XOsd_IntrDisable(InstancePtr, IntrType) |
This function macro disables the given individual interrupt(s) on the OSD core. More... | |
#define | XOsd_IntrGetPending(InstancePtr) |
This function macro returns the pending interrupts of the OSD core. More... | |
#define | XOsd_IntrClear(InstancePtr, IntrType) |
This function macro clears/acknowledges pending interrupts of the OSD core. More... | |
#define | XOsd_StatusGetPending(InstancePtr) |
This function macro returns the pending status of the OSD core. More... | |
#define | XOsd_SyncReset(InstancePtr) |
This function macro resets a OSD core at the end of the frame being processed. More... | |
#define | XOsd_FSyncReset XOsd_SyncReset |
This macro resets the OSD core at the end of the frame being processed. More... | |
#define | XOsd_Start XOsd_Enable |
This function macro stops an OSD core. More... | |
#define | XOsd_Stop XOsd_Disable |
This function macro stops an OSD core. More... | |
Compatibility Macros | |
#define | XOSD_Config XOsd_Config |
#define | XOSD_Layer XOsd_Layer |
#define | XOSD_CallBack XOsd_CallBack |
#define | XOSD_ErrorCallBack XOsd_ErrorCallBack |
#define | XOSD XOsd |
#define | XOSD_Instruction XOsd_Instruction |
#define | XOSD_Enable XOsd_Enable |
#define | XOSD_Disable XOsd_Disable |
#define | XOSD_RegUpdateEnable XOsd_RegUpdateEnable |
#define | XOSD_RegUpdateDisable XOsd_RegUpdateDisable |
#define | XOSD_Reset XOsd_Reset |
#define | XOSD_IntrEnable XOsd_IntrEnable |
#define | XOSD_IntrDisable XOsd_IntrDisable |
#define | XOSD_IntrGetPending XOsd_IntrGetPending |
#define | XOSD_IntrClear XOsd_IntrClear |
#define | XOSD_CfgInitialize XOsd_CfgInitialize |
#define | XOSD_SetScreenSize XOsd_SetActiveSize |
#define | XOSD_GetScreenSize XOsd_GetActiveSize |
#define | XOSD_SetBackgroundColor XOsd_SetBackgroundColor |
#define | XOSD_GetBackgroundColor XOsd_GetBackgroundColor |
#define | XOSD_SetLayerDimension XOsd_SetLayerDimension |
#define | XOSD_GetLayerDimension XOsd_GetLayerDimension |
#define | XOSD_SetLayerAlpha XOsd_SetLayerAlpha |
#define | XOSD_GetLayerAlpha XOsd_GetLayerAlpha |
#define | XOSD_SetLayerPriority XOsd_SetLayerPriority |
#define | XOSD_GetLayerPriority XOsd_GetLayerPriority |
#define | XOSD_EnableLayer XOsd_EnableLayer |
#define | XOSD_DisableLayer XOsd_DisableLayer |
#define | XOSD_LoadColorLUTBank XOsd_LoadColorLUTBank |
#define | XOSD_LoadCharacterSetBank XOsd_LoadCharacterSetBank |
#define | XOSD_LoadTextBank XOsd_LoadTextBank |
#define | XOSD_SetActiveBank XOsd_SetActiveBank |
#define | XOSD_CreateInstruction XOsd_CreateInstruction |
#define | XOSD_GetVersion XOsd_GetVersion |
#define | XOSD_LoadInstructionList XOsd_LoadInstructionList |
#define | XOSD_LookupConfig XOsd_LookupConfig |
#define | XOSD_IntrHandler XOsd_IntrHandler |
#define | XOSD_SetCallBack XOsd_SetCallBack |
Typedefs | |
typedef void(* | XOsd_CallBack) (void *CallBackRef) |
This function callback type for all interrupts except error interrupt. More... | |
typedef void(* | XOsd_ErrorCallBack) (void *CallBackRef, u32 ErrorMask) |
This function callback type for error interrupt. More... | |
typedef u32 | XOsd_Instruction[XOSD_INS_SIZE] |
The XOsd_Instruction data structure for holding one GC instruction. More... | |
Enumerations | |
Interrupt types for setting up callbacks | |
enum | { XOSD_HANDLER_PROCSTART = 1, XOSD_HANDLER_FRAMEDONE, XOSD_HANDLER_ERROR } |
Functions | |
int | XOsd_CfgInitialize (XOsd *InstancePtr, XOsd_Config *CfgPtr, u32 EffectiveAddr) |
This function initializes an OSD core. More... | |
void | XOsd_SetActiveSize (XOsd *InstancePtr, u32 Width, u32 Height) |
This function sets the screen size of the OSD Output. More... | |
void | XOsd_GetActiveSize (XOsd *InstancePtr, u32 *WidthPtr, u32 *HeightPtr) |
This function gets the screen size of the OSD Output. More... | |
void | XOsd_SetBackgroundColor (XOsd *InstancePtr, u16 Red, u16 Blue, u16 Green) |
This function sets the background color used by the OSD output. More... | |
void | XOsd_GetBackgroundColor (XOsd *InstancePtr, u16 *RedPtr, u16 *BluePtr, u16 *GreenPtr) |
This function gets the background color used by the OSD output. More... | |
void | XOsd_SetLayerDimension (XOsd *InstancePtr, u8 LayerIndex, u16 XStart, u16 YStart, u16 XSize, u16 YSize) |
This function sets the start position and size of an OSD layer. More... | |
void | XOsd_GetLayerDimension (XOsd *InstancePtr, u8 LayerIndex, u16 *XStartPtr, u16 *YStartPtr, u16 *XSizePtr, u16 *YSizePtr) |
This function gets the start position and size of an OSD layer. More... | |
void | XOsd_SetLayerAlpha (XOsd *InstancePtr, u8 LayerIndex, u16 GlobalAlphaEnable, u16 GlobalAlphaValue) |
This function sets the alpha value and mode of an OSD layer. More... | |
void | XOsd_GetLayerAlpha (XOsd *InstancePtr, u8 LayerIndex, u16 *GlobalAlphaEnablePtr, u16 *GlobalAlphaValuePtr) |
This function gets the alpha value and mode of an OSD layer. More... | |
void | XOsd_SetLayerPriority (XOsd *InstancePtr, u8 LayerIndex, u8 Priority) |
This function sets the priority of an OSD layer. More... | |
void | XOsd_GetLayerPriority (XOsd *InstancePtr, u8 LayerIndex, u8 *PriorityPtr) |
This function gets the priority of an OSD layer. More... | |
void | XOsd_EnableLayer (XOsd *InstancePtr, u8 LayerIndex) |
This function enables an OSD layer. More... | |
void | XOsd_DisableLayer (XOsd *InstancePtr, u8 LayerIndex) |
This function disables an OSD layer. More... | |
void | XOsd_LoadColorLUTBank (XOsd *InstancePtr, u8 GcIndex, u8 BankIndex, u32 ColorData[]) |
This function loads color look up table data into an OSD Graphics Controller bank. More... | |
void | XOsd_LoadCharacterSetBank (XOsd *InstancePtr, u8 GcIndex, u8 BankIndex, u32 CharSetData[]) |
This function loads character set data (font) into an OSD Graphics Controller bank. More... | |
void | XOsd_LoadTextBank (XOsd *InstancePtr, u8 GcIndex, u8 BankIndex, u32 TextData[]) |
This function loads text data into an OSD Graphics Controller bank. More... | |
void | XOsd_SetActiveBank (XOsd *InstancePtr, u8 GcIndex, u8 ColorBankIndex, u8 CharBankIndex, u8 TextBankIndex, u8 InstructionBankIndex) |
This function chooses active banks for a GC in the OSD core. More... | |
void | XOsd_CreateInstruction (XOsd *InstancePtr, u32 InstructionPtr[], u8 GcIndex, u16 ObjType, u8 ObjSize, u16 XStart, u16 YStart, u16 XEnd, u16 YEnd, u8 TextIndex, u8 ColorIndex) |
This function creates an instruction for the OSD core. More... | |
void | XOsd_LoadInstructionList (XOsd *InstancePtr, u8 GcIndex, u8 BankIndex, u32 InstSetPtr[], u32 InstNum) |
This function load an instruction list to be used by an Graphic Controller in the OSD core. More... | |
u32 | XOsd_GetVersion (XOsd *InstancePtr) |
This function returns the Version of the OSD core. More... | |
XOsd_Config * | XOsd_LookupConfig (u16 DeviceId) |
This function gets a reference to an XOsd_Config structure based on the unique device id, DeviceId. More... | |
void | XOsd_IntrHandler (void *InstancePtr) |
This function is the interrupt handler for the On-Screen-Display driver. More... | |
int | XOsd_SetCallBack (XOsd *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef) |
This routine installs an asynchronous callback function for the given HandlerType: More... | |
int | XOsd_SelfTest (XOsd *InstancePtr) |
This function reads Version register of OSD core and compares with zero as part of self test. More... | |