_csl_osd_aux.h

TI达芬奇dm644x各硬件模块测试代码

/** @mainpage OSD CSL 3.x
 *
 * @section Introduction
 *
 * @subsection xxx Purpose and Scope
 * The purpose of this document is to identify a set of common CSL APIs for
 * the  OSD module across various devices. The CSL developer is expected to
 * refer to this document while designing APIs for these modules. Some of the
 * listed APIs may not be applicable to a given OSD module. While other cases
 * this list of APIs may not be sufficient to cover all the features of a
 * particular OSD Module. The CSL developer should use his discretion designing
 * new APIs or extending the existing ones to cover these.
 *
 * @subsection aaa Terms and Abbreviations
 *   -# CSL:  Chip Support Library
 *   -# API:  Application Programmer Interface
 *
 * @subsection References
 *    -# CSL-001-DES, CSL 3.x Design Specification DocumentVersion 1.02
 *
 */

/** @file _csl_osd_aux.h
 *
 * @brief    Header file for private functions of CSL functional layer 
 *
 * Description
 *    - The different private function declarations
 *
 * Modification 1
 *    - modified on: 10/26/2004
 *    - reason: Created the sources
 *
 *
 * @date 26th Oct, 2004
 * @author Sandeep Tiwari
 *
 */
#ifndef __CSL_OSD_AUX_H_
#define __CSL_OSD_AUX_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <cslr.h>
#include <csl_error.h>
#include <csl_sysData.h>
#include <csl_types.h>
#include <cslr_osd.h>
#include <csl_osd.h>

/****** ********************************************************************\
*		OSD private function declarations
\**************************************************************************/

/** Get OSD window data address (relative to the SDRAM base address) */

CSL_Status _CSL_osdGetWinAddr (
        /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
        CSL_OsdHandle hOsd,

        /** Pointer to structure containing elements to 
         *  get the window data address
         */
        CSL_GetWinAddr * response
);

/** Set OSD bitmap window mode parameters
 *  This routine set parameters which will affect both OSD bitmap windows
 */

CSL_Status   _CSL_osdSetBitmapMode(
         /** Pointer to the object that holds reference to the
           *  instance of OSD requested after the call 
	    */
         CSL_OsdHandle hOsd,

         /** Pointer to structure containing data to set the OSD bitmap mode 
           *  registers 
           */   
         CSL_OsdBitmapModeData *arg 
);

 
/** Set OSD 1,2,4-bit bitmap color pallette */

CSL_Status    _CSL_osdSetBmpColor(
         /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
         CSL_OsdHandle hOsd,

        /** Pointer to structure containing elements to 
         *  set the OSD 1,2,4-bit bitmap color palette
         */
        CSL_OsdBmpColor *arg
);

/** Set OSD bitmap window configuration */

CSL_Status    _CSL_osdSetBmpWinConfig(
       /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
       CSL_OsdHandle hOsd,

       /** Pointer to structure containing elements to 
         *  configure the Bitmap windows
         */
	CSL_OsdBmpWinConfig * arg
);

/** Set OSD cursor configuration */

CSL_Status   _CSL_osdSetCursorConfig(
       /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
       CSL_OsdHandle hOsd,

       /** Pointer to structure containing elements to 
         *  set the cursor specific parameters
         */
     CSL_OsdCursorConfig * arg
);

/** Set all OSD window parameters
 *  This routine sets parameters which will affect all OSD window  
 */

CSL_Status _CSL_osdSetMode(
      /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */

       CSL_OsdHandle hOsd,
      /** Pointer to structure containing data to set the OSD mode 
         *  registers 
        */   
       CSL_OsdModeData  *arg
);

/** Set OSD video window ,ping pong buffer address */

CSL_Status   _CSL_osdSetPingpongBufferAddr(
        /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
       CSL_OsdHandle hOsd,
        /** Pointer to structure containing elements to 
         *  set the ping pong buffer address
         */
       CSL_OsdPingAddr *arg
); 
 
/** Setup OSD LUT in RAM */

CSL_Status   _CSL_osdSetRamLut(
	/** Pointer to the object that holds reference to the
	  *  instance of OSD requested after the call 
	  */
	CSL_OsdHandle hOsd,
	
	/** Pointer to structure containing data to set the OSD window
          *  data address 
          */   
       CSL_OsdRamLut *arg
);

/** Set OSD video window mode parameters
 * This routine sets parameters which will affect both OSD video windows
 */

CSL_Status   _CSL_osdSetVideoMode(
         /** Pointer to the object that holds reference to the
           *  instance of OSD requested after the call 
	    */
       CSL_OsdHandle hOsd,

       /** Pointer to structure containing data to set the OSD video mode 
         *  registers 
        */   
        CSL_OsdVideoModeData  *arg
);

/** Set OSD window data address */

CSL_Status   _CSL_osdSetWinAddr(
	/** Pointer to the object that holds reference to the
	  *  instance of OSD requested after the call 
	  */
	CSL_OsdHandle hOsd,
	
	/** Pointer to structure containing data to set the OSD window
          *  data address 
          */   
       CSL_OsdWinAddr * arg
);

/** Set OSD window configuration */

CSL_Status    _CSL_osdSetWinConfig(
        /** Pointer to the object that holds reference to the
          *   instance of OSD requested after the call 
	   */
         CSL_OsdHandle hOsd,
         
        /** Pointer to structure containing data to set the OSD video mode 
          *  registers 
          */   
        CSL_OsdWinConfig * arg
);

/** Set OSD window horizontal, vertical Size */

CSL_Status    _CSL_osdSetWinSize(
       /** Pointer to the object that holds reference to the
         *  instance of OSD requested after the call 
	  */
       CSL_OsdHandle hOsd,

       /** Pointer to structure containing elements to 
         *  set the window size
         */
       CSL_OsdSize  *arg      
);

/** Set OSD window start position */

CSL_Status  _CSL_osdSetWinStartPos(
	/** Pointer to the object that holds reference to the
	*  instance of OSD requested after the call 
	*/
	CSL_OsdHandle hOsd,
	
       /** Pointer to structure containing elements to 
         *  set the window starting position
         */
       CSL_OsdStart  *arg
);

/** Switch OSD video window 0 address */

CSL_Status    _CSL_osdSwitchToPingpongBuff(
       /** Pointer to the object that holds reference to the
	*  instance of OSD requested after the call 
	*/
	CSL_OsdHandle hOsd,
       /** Pointer to structure containing elements to 
        *  switch the Ping Pong buffer
        */
       CSL_OsdPingBuff *arg 
); 
  
/** Enable/ disable OSD window */

CSL_Status  _CSL_osdWinEnable(
       /** Pointer to the object that holds reference to the
        *  instance of OSD requested after the call 
	*/
        CSL_OsdHandle hOsd,
        /** Pointer to structure containing elements to enable/disable the window 
         */
       CSL_OsdWinEnable *arg
);
 


 
   
 








#ifdef __cplusplus
}
#endif


#endif