embeddedsw/XilinxProcessorIPLib/drivers/osd/doc/html/index.html

59 lines
2.9 KiB
HTML
Raw Normal View History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
osd v3_0
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<h1>osd v3_0</h1>
<p>
This is main header file of the Xilinx MVI On-Screen-Display (OSD) device driver.<p>
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.<p>
Xilinx MVI OSD has the following main features:<p>
<ul>
<li>Read Video Data one of three sources<ul>
<li>VFBC/Frame Buffer</li><li>VideoBus</li><li>Graphics Controller</li></ul>
</li><li>Alpha Compositing and Alpha Blending of up to 8 layers</li><li>Up to 8 priorities, one for each of the layers</li><li>Real-Time Graphics Controller</li><li>Write Composited Video Data to either<ul>
<li>VFBC/Frame Buffer, or</li><li>VideoBus</li></ul>
</li></ul>
<p>
For a full description of OSD features, please see the hardware spec.<p>
<b>Interrupt Service </b><p>
Four interrupt types are supported:<p>
<ul>
<li>Vertical Blank Interval Start Interrupt</li><li>Vertical Blank Interval End Interrupt</li><li>Frame Done Interrupt</li><li>Error Interrupt</li></ul>
<p>
<b>Software Initialization </b><p>
Please follow the example provided with this driver for the steps to use this driver.<p>
<b>Cache Coherency</b><p>
<b>Alignment</b><p>
<b>Limitations</b><p>
<b>BUS Interface</b><p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> 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 <a class="el" href="xosd_8c.html#418c2aee59e346663d5c67b000abb291">XOSD_GetLayerAlpha()</a>, <a class="el" href="xosd_8c.html#e46a6c3c128211c916a2be00c24b047d">XOSD_SetLayerAlpha()</a>,
<a class="el" href="xosd_8c.html#9645592b9797b8e4272c9c4f05ec36a9">XOSD_SetBackgroundColor()</a> and <a class="el" href="xosd_8c.html#104eb9a1d064275f031a6a4dde38228a">XOSD_GetBackgroundColor()</a>
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</pre><p>
<pre> </pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.