tmbslhdmitx.h

HDMI NXP9983 chipset controller driver

/**
 * Copyright (C) 2006 Koninklijke Philips Electronics N.V., All Rights Reserved.
 * This source code and any compilation or derivative thereof is the proprietary
 * information of Koninklijke Philips Electronics N.V. and is confidential in
 * nature. Under no circumstances is this software to be  exposed to or placed
 * under an Open Source License of any type without the expressed written
 * permission of Koninklijke Philips Electronics N.V.
 *
 * \file          tmbslHdmiTx.h
 *
 * \version       $Revision: 41 $
 *
 * \date          $Date: 17/10/07 14:11 $
 *
 * \brief         BSL driver component API for the TDA998x HDMI Transmitter
 *
 * \section refs  Reference Documents
 * HDMI Driver - Outline Architecture.doc,
 * HDMI Driver - tmbslHdmiTx - SCS.doc
 *
 * \section info  Change Information
 *
 * \verbatim

   $History: tmbslHdmiTx.h $
 *
 * *****************  Version 41  ****************
 * User: B.Vereecke     Date: 17/10/07   Time: 14:11
 * Updated in $/Source/tmbslHdmiTx/src
 * PR872 : add new formats, 1080p24/25/30
 *
 * *****************  Version 40  *****************
 * User: B.Vereecke      Date: 17/07/07   Time: 10:30
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR217 - Add a new Pattern type in tmbslHdmiTxTestPattern_t
 *			it is used for set the bluescreen
 *
 * *****************  Version 39  *****************
 * User: J. Lamotte      Date: 13/06/07   Time: 12:00
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR397 - Merge with PR322
 *       add 9981 API definitions for 9983 
 *       (return NOT_SUPPORTED)
 *
 * *****************  Version 38  *****************
 * User: G. BURNOUF      Date: 08/06/07   Time: 10:40
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR347 - Add new formatPC
 *
 * *****************  Version 37  *****************
 * User: J/ Lamotte         Date: 24/04/07   Time: 10:40
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR50 - Change comment for tmbslHdmiTxSetAudioPortConfig
 *        and tmbslHdmiTxSetVideoPortConfig functions (TDA9981)
 *
 * *****************  Version 36  *****************
 * User: Burnouf         Date: 16/04/07   Time: 11:30
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR50 - add new API tmbslHdmiTxRxSenseGetStatus for TDA9981
 *      - add new API only for debug tmbslHdmiTxFlagSwInt for TDA9981
 *      - add new index for the new callback interrupt of TDA9981
 *
 * *****************  Version 35  *****************
 * User: J. Lamotte      Date: 16/04/07   Time: 11:30
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR50 - add video and audio port configuration for TDA9981 
 *        tmbslHdmiTxSetAudioPortConfig and 
 *        tmbslHdmiTxSetVideoPortConfig
 *      - define HDMITX_UNITS_MAX (in tmbslHdmiTx_local.h before)
 *
 * *****************  Version 34  *****************
 * User: J. Lamotte    Date: 25/04/07   Time: 14:40
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR273 - add PLL configuration before soft reset
 *         in function tmbslHdmiTxInit (2 more parameters)
 * 
 * *****************  Version 33  *****************
 * User: C. Logiou      Date: 08/03/07   Time: 16:52
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR214 - add new input format repeated 480i/576i
 * 
 * *****************  Version 32  *****************
 * User: burnouf      Date: 06/02/07   Time: 16:52
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR49 - add PC Formats
 * 
 * *****************  Version 31  *****************
 * User: burnouf      Date: 08/01/07   Time: 15:33
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PR72 - add function tmbslHdmiTxHwGetCapabilities
 * 
 * *****************  Version 30  *****************
 * User: Djw          Date: 17/11/06   Time: 18:48
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF72 - Corrections to doxygen info for
 * tmbslHdmiTxAudioOutSetChanStatus
 * 
 * *****************  Version 28  *****************
 * User: Mayhew       Date: 10/11/06   Time: 10:35
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF68 Add note to tmbslHdmiTxHdcpConfigure for disabling authentication
 * checking
 * 
 * *****************  Version 27  *****************
 * User: Mayhew       Date: 10/11/06   Time: 10:03
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF68 HdcpCheck params thisCheck and maxChecks replaced by
 * uTimeSinceLastCallMs, and Check_t values reordered
 * PNF68 Params uCheckIntervalMs and uChecksToDo added to
 * tmbslHdmiTxHdcpConfigure
 * PNF68 tmbslHdmiTxHwHandleTimer prototype removed
 * 
 * *****************  Version 26  *****************
 * User: Djw          Date: 9/11/06    Time: 18:05
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF69 Add tmbslHdmiTxAudioOutSetChanStatus and
 * tmbslHdmiTxAudioOutSetChanStatusMapping
 * 
 * *****************  Version 25  *****************
 * User: Mayhew       Date: 6/11/06    Time: 17:46
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF68 Add tmbslHdmiTxHwHandleTimer
 * 
 * *****************  Version 23  *****************
 * User: Djw          Date: 25/10/06   Time: 13:41
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF58 Added vinMode parameter to tmbslHdmiTxVideoInSetSyncAuto
 * 
 * *****************  Version 21  *****************
 * User: Mayhew       Date: 13/10/06   Time: 11:01
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF37 Move arguments from tmbslHdmiTxVideoInSetConfig,
 * tmbslHdmiTxVideoOutSetSync and tmbslHdmiTxVideoOutSetFine (deleted)
 * to new APIs tmbslHdmiTxVideoInSetSyncAuto/Manual
 * 
 * *****************  Version 19  *****************
 * User: Mayhew       Date: 15/09/06   Time: 15:54
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF22 Add HdcpCheck API
 * PNF23 Add GetOtp API
 * 
 * *****************  Version 17  *****************
 * User: Mayhew       Date: 4/09/06    Time: 10:03
 * Updated in $/Source/tmbslHdmiTx/Inc
 * PNF20: Add HDMITX_HDCP_OPTION_FORCE_VSLOW_DDC
 * 
 * *****************  Version 15  *****************
 * User: Djw          Date: 23/08/06   Time: 18:18
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Updated comments for tmbslHdmiTxctsRef_t enum.
 * 
 * *****************  Version 14  *****************
 * User: Djw          Date: 21/08/06   Time: 14:02
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Correction to tmbslHdmiTxTmdsOut_t enum.
 * 
 * *****************  Version 13  *****************
 * User: Mayhew       Date: 10/07/06   Time: 12:31
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Fix Doxygen comment warnings
 * 
 * *****************  Version 11  *****************
 * User: Mayhew       Date: 30/06/06   Time: 12:40
 * Updated in $/Source/tmbslHdmiTx/Inc
 * HDMITX_EDID_SINK_ type replaced with HDMITX_SINK_ type for clarity
 * 
 * *****************  Version 9  *****************
 * User: Djw          Date: 16/06/06   Time: 12:05
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Added flag to Init to support use of alternate i2c address for EDID.
 * 
 * *****************  Version 7  *****************
 * User: Mayhew       Date: 5/06/06    Time: 14:28
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Add tmbslHdmiTxHdcpGetT0FailState, tmbslHdmiTxSysTimerWait. Move error
 * codes from _local.h.
 * 
 * *****************  Version 5  *****************
 * User: Djw          Date: 24/05/06   Time: 11:15
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Added Infoframe packet APIs
 * 
 * *****************  Version 4  *****************
 * User: Mayhew       Date: 15/05/06   Time: 15:56
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Correct the order of values in tmbslHdmiTxVoutDbits_t. Add mask to
 * tmbslHdmiTxHdcpOptions_t.
 * 
 * *****************  Version 3  *****************
 * User: Mayhew       Date: 10/05/06   Time: 16:58
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Added HDCP APIs, ScalerGetMode and HwStartup
 * 
 * *****************  Version 2  *****************
 * User: Mayhew       Date: 11/04/06   Time: 14:20
 * Updated in $/Source/tmbslHdmiTx/Inc
 * Add HDMITX_UPSAMPLE_AUTO
 * 
 * *****************  Version 1  *****************
 * User: Mayhew       Date: 4/04/06    Time: 16:27
 * Created in $/Source/tmbslHdmiTx/Inc
 * Driver API phase 2
 
   \endverbatim
 *
*/

#ifndef TMBSLHDMITX_H
#define TMBSLHDMITX_H
#define FUNC_PTR 
#define RAM_DAT
#define CONST_DAT

/*============================================================================*/
/*                       COMPILER COMMAND LINE BUILD OPTIONS                  */
/*                                                                            */
/* #define          PC Build            8051 Build                            */
/* CONST_DAT        const               code                                  */
/* RAM_DAT          (blank)             xdata                                 */
/* FUNC_PTR         (blank)             code                                  */
/*============================================================================*/


/*============================================================================*/
/*                       INCLUDE FILES                                        */
/*============================================================================*/
#include "tmNxCompId.h"

#ifdef __cplusplus
extern "C" {
#endif

/*============================================================================*/
/*                       MACRO DEFINITIONS                                    */
/*============================================================================*/

/**
 * The maximum number of supported HDMI Transmitter units
 */
#define HDMITX_UNITS_MAX       2
	
/** \name Errors
 *  The group of error codes returned by all API and internal functions
 */
/*@{*/
/** The base offset for all error codes.
 *  This needs defining as non-zero if this component is integrated with others
 *  and all component error ranges are to be kept separate.
 */
#define TMBSL_ERR_HDMI_BASE	0x00

/** Define the OK code if not defined already */
#ifndef TM_OK
#define TM_OK   0
#endif

/** SW interface compatibility error */
#define TMBSL_ERR_HDMI_COMPATIBILITY            (TMBSL_ERR_HDMI_BASE + 0x001U)

/** SW major version error */
#define TMBSL_ERR_HDMI_MAJOR_VERSION            (TMBSL_ERR_HDMI_BASE + 0x002U)

/** SW component version error */
#define TMBSL_ERR_HDMI_COMP_VERSION             (TMBSL_ERR_HDMI_BASE + 0x003U)

/** Invalid device unit number */
#define TMBSL_ERR_HDMI_BAD_UNIT_NUMBER          (TMBSL_ERR_HDMI_BASE + 0x005U)

/** Invalid input parameter other than unit number */
#define TMBSL_ERR_HDMI_BAD_PARAMETER            (TMBSL_ERR_HDMI_BASE + 0x009U)

/** Inconsistent input parameters */
#define TMBSL_ERR_HDMI_INCONSISTENT_PARAMS      (TMBSL_ERR_HDMI_BASE + 0x010U)

/** Component is not initialized */
#define TMBSL_ERR_HDMI_NOT_INITIALIZED          (TMBSL_ERR_HDMI_BASE + 0x011U)

/** Command not supported for current device */
#define TMBSL_ERR_HDMI_NOT_SUPPORTED            (TMBSL_ERR_HDMI_BASE + 0x013U)

/** Initialization failed */
#define TMBSL_ERR_HDMI_INIT_FAILED              (TMBSL_ERR_HDMI_BASE + 0x014U)

/** Component is busy and cannot do a new operation */
#define TMBSL_ERR_HDMI_BUSY                     (TMBSL_ERR_HDMI_BASE + 0x015U)

/** I2C read error */
#define TMBSL_ERR_HDMI_I2C_READ                 (TMBSL_ERR_HDMI_BASE + 0x017U)

/** I2C write error */
#define TMBSL_ERR_HDMI_I2C_WRITE                (TMBSL_ERR_HDMI_BASE + 0x018U)

/** Assertion failure */
#define TMBSL_ERR_HDMI_ASSERTION                (TMBSL_ERR_HDMI_BASE + 0x049U)

/** Bad EDID block checksum */
#define TMBSL_ERR_HDMI_INVALID_STATE            (TMBSL_ERR_HDMI_BASE + 0x066U)
#define TMBSL_ERR_HDMI_INVALID_CHECKSUM         TMBSL_ERR_HDMI_INVALID_STATE

/** No connection to HPD pin */
#define TMBSL_ERR_HDMI_NULL_CONNECTION          (TMBSL_ERR_HDMI_BASE + 0x067U)

/** Not allowed in DVI mode */
#define TMBSL_ERR_HDMI_OPERATION_NOT_PERMITTED  (TMBSL_ERR_HDMI_BASE + 0x068U)

/* Maximum error code defined */
#define TMBSL_ERR_HDMI_MAX              TMBSL_ERR_HDMI_OPERATION_NOT_PERMITTED

/*@}*/