osd v3_0

This is main header file of the Xilinx MVI On-Screen-Display (OSD) device driver.

An OSD is an image superimposed on a screen picture, commonly used by modern televisions, VCRs, and DVD players to display information such as volume, channel, and time.

Xilinx MVI OSD has the following main features:

Read Video Data one of three sources
- VFBC/Frame Buffer
- VideoBus
- Graphics Controller
Alpha Compositing and Alpha Blending of up to 8 layers
Up to 8 priorities, one for each of the layers
Real-Time Graphics Controller
Write Composited Video Data to either
- VFBC/Frame Buffer, or
- VideoBus

For a full description of OSD features, please see the hardware spec.

Interrupt Service

Four interrupt types are supported:

Vertical Blank Interval Start Interrupt
Vertical Blank Interval End Interrupt
Frame Done Interrupt
Error Interrupt

Software Initialization

Please follow the example provided with this driver for the steps to use this driver.

Cache Coherency

Alignment

Limitations

BUS Interface

 MODIFICATION HISTORY:

 Ver   Who  Date     Changes
 ----- ---- -------- -------------------------------------------------------
 1.00a xd   08/18/08 First release
 1.01a xd   07/30/10 Added device version support; Supported doxygen; Fixed
                     CR #534952
 1.02a xd   12/21/10 Removed endian conversion for text bank loading
 1.03a cm   09/07/11 Updated XOSD_GetLayerAlpha(), XOSD_SetLayerAlpha(), 
                     XOSD_SetBackgroundColor() and XOSD_GetBackgroundColor() 
                     to allow 10 and 12 bit alpha and background colors. 
 2.00a cjm  12/18/12 Converted from xio.h to xil_io.h, translating
                     basic types, MB cache functions, exceptions and
                     assertions to xil_io format. 
 3.0   adk  19/12/13 Updated as per the New Tcl API's