xosd_hw.h File Reference

This header file contains identifiers and register-level driver functions (or macros) that can be used to access the Xilinx MVI Video On-Screen-Display (OSD) device. More...

#include "xio.h"

Go to the source code of this file.

Defines

Register Offsets
Memory footprint of layers
Graphics Controller Bank related constants
OSD Control Register bit definition
OSD Screen Size Register bit definition
OSD Background Color Channel 0
OSD Background Color Channel 1
OSD Background Color Channel 2
Maximum number of the layers
OSD Layer Control (Layer 0 through (XOSD_MAX_NUM_OF_LAYERS - 1))
OSD Layer Position (Layer 0 through (XOSD_MAX_NUM_OF_LAYERS - 1))
OSD Layer Size (Layer 0 through (XOSD_MAX_NUM_OF_LAYERS - 1))
OSD Graphics Controller Write Bank Address
OSD Graphics Controller Active Bank Address
Version Register bit definition
OSD Software Reset
Global Interrupt Enable Register bit definition
Interrupt Status/Enable Register bit definition
Layer Types
Supported Instruction numbers given an instruction memory size
GC Instruction word offset definition
GC Instruction word 0 definition
GC Instruction word 1 definition
GC Instruction word 2 definition
GC Instruction word 3 definition
GC Instruction Operation Code definition (used in Instruction word 0)
GC color size
GC font unit size
Layer priority
Device register I/O APIs

Detailed Description

This header file contains identifiers and register-level driver functions (or macros) that can be used to access the Xilinx MVI Video On-Screen-Display (OSD) device.

For more information about the operation of this device, see the hardware specification and documentation in the higher level driver xosd.h source code file.

 MODIFICATION HISTORY:

 Ver	Who	 Date	  Changes
 ----- ---- -------- -------------------------------------------------------
 1.00a xd	 08/01/08 First release
 

Definition in file xosd_hw.h.


Define Documentation

#define XOSD_GCWBA_BANK_MASK   0x00000007

Controls which bank to write GPU instructions and Color LUT data into.

Definition at line 236 of file xosd_hw.h.

#define XOSD_IXR_ALLIERR_MASK

Value:

Mask for all error interrupts.

Definition at line 305 of file xosd_hw.h.

#define XOSD_IXR_ALLINTR_MASK

Value:

Mask for all interrupts.

Definition at line 312 of file xosd_hw.h.

#define XOSD_ReadReg ( BaseAddress,
RegOffset   )     XOSD_In32((BaseAddress) + (RegOffset))

Read the given register.

Parameters:
BaseAddress is the base address of the device
RegOffset is the register offset to be read
Returns:
The 32-bit value of the register
Note:
C-style signature: u32 XOSD_ReadReg(u32 BaseAddress, u32 RegOffset)

Definition at line 452 of file xosd_hw.h.

#define XOSD_WriteReg ( BaseAddress,
RegOffset,
Data   )     XOSD_Out32((BaseAddress) + (RegOffset), (Data))

Write the given register.

Parameters:
BaseAddress is the base address of the device
RegOffset is the register offset to be written
Data is the 32-bit value to write to the register
Returns:
None.
Note:
C-style signature: void XOSD_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Definition at line 471 of file xosd_hw.h.


Copyright © 1995-2010 Xilinx, Inc. All rights reserved.