tmbslhdmitx_local.h

HDMI NXP9983 chipset controller driver

 * NO_HDCP modifications
 * 
 * *****************  Version 16  *****************
 * User: Mayhew       Date: 10/07/06   Time: 13:18
 * Updated in $/Source/tmbslHdmiTx/Src
 * Minor version now 2. Add #define BCAPS_REPEATER.
 * Add N5 registers and feature flag. Fix Doxygen warnings.
 * 
 * *****************  Version 14  *****************
 * User: Mayhew       Date: 30/06/06   Time: 12:55
 * Updated in $/Source/tmbslHdmiTx/Src
 * Minor version now 1. BKSV_SECURE event renamed to BKSV_REPEAT.
 * HDCP_BCAPS register is now shadowed and has new _repeater bit.
 * Add N4 CH_STAT registers. EdidSinkType replaced by SinkType.
 * Add DIS.HdcpAksv.
 * 
 * *****************  Version 12  *****************
 * User: Djw          Date: 16/06/06   Time: 12:04
 * Updated in $/Source/tmbslHdmiTx/Src
 * Added flag to DIS to support use of alternate i2c address for EDID.
 * 
 * *****************  Version 10  *****************
 * User: Mayhew       Date: 6/06/06    Time: 13:41
 * Updated in $/Source/tmbslHdmiTx/Src
 * Add checkUnitSetDis. Remove erroneous NOT_SUPPORTED definition.
 * 
 * *****************  Version 9  *****************
 * User: Mayhew       Date: 5/06/06    Time: 15:06
 * Updated in $/Source/tmbslHdmiTx/Src
 * Move error code definitions to tmbslHdmiTx.h, replace with #if checks
 * Add DIS.HdcpT0FailState.
 * 
 * *****************  Version 7  *****************
 * User: Djw          Date: 24/05/06   Time: 11:23
 * Updated in $/Source/tmbslHdmiTx/Src
 * Added new registers for N4 (page 10h Infoframes).  Added 2nd Ghost
 * register.  Reset names for ISRC1 and ACP packet registers for N4
 * compatibility.
 * 
 * *****************  Version 5  *****************
 * User: Mayhew       Date: 22/05/06   Time: 15:58
 * Updated in $/Source/tmbslHdmiTx/Src
 * Add DIS.uDeviceFeatures. Add N4 to version list. Add version register
 * masks for N4.
 * 
 * *****************  Version 4  *****************
 * User: Mayhew       Date: 10/05/06   Time: 17:10
 * Updated in $/Source/tmbslHdmiTx/Src
 * Add HDCP state handling and DIS members, move EDID status enum to .h
 * 
 * *****************  Version 3  *****************
 * User: Djw          Date: 20/04/06   Time: 17:31
 * Updated in $/Source/tmbslHdmiTx/Src
 * Minor comment correction for EDID DTD in DIS.
 * 
 * *****************  Version 2  *****************
 * User: Mayhew       Date: 11/04/06   Time: 14:19
 * Updated in $/Source/tmbslHdmiTx/Src
 * Add upsampleMode to Device Instance Structure
 * 
 * *****************  Version 1  *****************
 * User: Mayhew       Date: 4/04/06    Time: 16:30
 * Created in $/Source/tmbslHdmiTx/Src
 * Driver local API phase 2

   \endverbatim
 *
*/

#ifndef TMBSLHDMITX_LOCAL_H
#define TMBSLHDMITX_LOCAL_H

/*============================================================================*/
/*                       INCLUDE FILES                                        */
/*============================================================================*/

#ifdef __cplusplus
extern "C" {
#endif

/*============================================================================*/
/*                       MACRO DEFINITIONS                                    */
/*============================================================================*/
/* for remove warning */
#define DUMMY_ACCESS(x) x

/* Defining this symbol here enables the BCAPS Repeater mod for N4 onwards */
#ifndef BCAPS_REPEATER
#define BCAPS_REPEATER
#endif

/** \name Versions
 *  A group of macros to set the software component number and version
 */
/*@{*/
/** Compatibility number */
#define HDMITX_BSL_COMP_NUM             1

/** Major software version 1 to 255 */
#define HDMITX_BSL_MAJOR_VER            4

/** Minor software version 0 to 9 */
#define HDMITX_BSL_MINOR_VER            12
/*@}*/

/** \name ErrorChecks
 *  A group of checks ensuring that public error codes match DVP standard errors
 */
/*@{*/
/** SW interface compatibility error */
#if TMBSL_ERR_HDMI_COMPATIBILITY != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_COMPATIBILITY)
#error
#endif

/** SW major version error */
#if TMBSL_ERR_HDMI_MAJOR_VERSION != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_MAJOR_VERSION)
#error
#endif

/** SW component version error */
#if TMBSL_ERR_HDMI_COMP_VERSION != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_COMP_VERSION)
#error
#endif

/** Invalid device unit number */
#if TMBSL_ERR_HDMI_BAD_UNIT_NUMBER != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_BAD_UNIT_NUMBER)
#error
#endif

/** Invalid input parameter other than unit number */
#if TMBSL_ERR_HDMI_BAD_PARAMETER != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_BAD_PARAMETER)
#error
#endif

/** Inconsistent input parameters */
#if TMBSL_ERR_HDMI_INCONSISTENT_PARAMS != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_INCONSISTENT_PARAMS)
#error
#endif

/** Component is not initialized */
#if TMBSL_ERR_HDMI_NOT_INITIALIZED != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_NOT_INITIALIZED)
#error
#endif

/** Command not supported for current device */
#if TMBSL_ERR_HDMI_NOT_SUPPORTED != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_NOT_SUPPORTED)
#error
#endif

/** Initialization failed */
#if TMBSL_ERR_HDMI_INIT_FAILED != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_INIT_FAILED)
#error
#endif

/** Component is busy and cannot do a new operation */
#if TMBSL_ERR_HDMI_BUSY != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_BUSY)
#error
#endif

/** I2C read error */
#if TMBSL_ERR_HDMI_I2C_READ != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_READ)
#error
#endif

/** I2C write error */
#if TMBSL_ERR_HDMI_I2C_WRITE != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_WRITE)
#error
#endif

/** Assertion failure */
#if TMBSL_ERR_HDMI_ASSERTION != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_ASSERTION)
#error
#endif

/** Bad EDID block checksum */
#if TMBSL_ERR_HDMI_INVALID_CHECKSUM != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_INVALID_STATE)
#error
#endif

/** No connection to HPD pin */
#if TMBSL_ERR_HDMI_NULL_CONNECTION != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_NULL_CONNECTION)
#error
#endif

/** Not allowed in DVI mode */
#if TMBSL_ERR_HDMI_OPERATION_NOT_PERMITTED != \
(TMBSL_ERR_HDMI_BASE + TM_ERR_OPERATION_NOT_PERMITTED)
#error
#endif
/*@}*/

/**
 * A macro to check a condition and if true return a result
 */
#define RETIF(cond, rslt)       if ((cond)){return (rslt);}

/**
 * A macro to check a condition and if true return 
 * TMBSL_ERR_HDMI_BAD_PARAMETER.
 * To save code space, it can be compiled out by defining NO_RETIF_BADPARAM on
 * the compiler command line.
 */
#ifdef NO_RETIF_BADPARAM
#define RETIF_BADPARAM(cond)
#else
#define RETIF_BADPARAM(cond)  if ((cond)){return TMBSL_ERR_HDMI_BAD_PARAMETER;}
#endif

/**
 * A macro to check the result of a register API and if not TM_OK to return it.
 * To save code space, it can be compiled out by defining NO_RETIF_REG_FAIL on
 * the compiler command line.
 */
#ifdef NO_RETIF_REG_FAIL
#define RETIF_REG_FAIL(result)
#else
#define RETIF_REG_FAIL(result)  if ((result) != TM_OK){return (result);}
#endif

/*============================================================================*/
/*                       ENUM OR TYPE DEFINITIONS                             */
/*============================================================================*/

/**
 * Driver events and states used for diagnosis
 */
typedef enum _tmbslHdmiTxEvent