tmdlhdmitx_local.h

HDMI NXP9983 chipset controller driver

/**
 * Copyright (C) 2006 NXP N.V., All Rights Reserved.
 * This source code and any compilation or derivative thereof is the proprietary
 * information of NXP 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 NXP N.V.
 *
 * \file          tmdlHdmiTx_local.h
 *
 * \version       $Revision: 1 $
 *
 * \date          $Date: 02/08/07 08:32 $
 *
 * \brief         devlib driver component API for the TDA998x HDMI Transmitters
 *
 * \section refs  Reference Documents
 * HDMI Tx Driver - FRS.doc,
 *
 * \section info  Change Information
 *
 * \verbatim

   $History: tmdlHdmiTx_local.h $
 *
  * *****************  Version 13  *****************
 * User: J. Lamotte Date: 02/08/07   Time: 08:32
 * Updated in $/Source/tmdlHdmiTx/inc
 * initial version
 *

   \endverbatim
 *
*/

#ifndef TMDLHDMITX_LOCAL_H
#define TMDLHDMITX_LOCAL_H

#include "tmdlHdmiTx_IW.h"
#include "tmNxTypes.h"
#include "tmdlHdmiTx_Types.h"

#ifdef __cplusplus
extern "C" {
#endif

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

/* Version of the SW driver */
#define VERSION_COMPATIBILITY 0
#define VERSION_MAJOR         4
#define VERSION_MINOR         12

/* Invalid HDCP seed */
#define HDCP_SEED_NULL      0

/* A default seed value may be defined here, or set to HDCP_SEED_NULL.
 * If HDCP_SEED_NULL, a table of seeds may instead be programmed separately
 * into flash at the location of kSeedTable, below */
#define HDCP_SEED_DEFAULT   HDCP_SEED_NULL

/* Default SHA-1 test handling */
#define HDCP_OPT_DEFAULT    ( TMDL_HDMITX_HDCP_OPTION_FORCE_PJ_IGNORED \
                                | TMDL_HDMITX_HDCP_OPTION_FORCE_VSLOW_DDC \
                                | TMDL_HDMITX_HDCP_OPTION_FORCE_NO_1_1 )

/**
 * 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 
 * TMDL_ERR_DLHDMITX_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 TMDL_ERR_DLHDMITX_BAD_PARAMETER;}
#endif

/**
 * A macro to check a condition and if true, release the semaphore describe by handle and return a result
 */
#define RETIF_SEM(handle, cond, rslt)       if ((cond)){tmdlHdmiTxIWSemaphoreV(handle); return (rslt);}

/* Instance number */
#define INSTANCE_0  0
#define INSTANCE_1  1

/* Number of event */
#define EVENT_NB    9

/* Size of a KSV is five bytes */
#define KSV_SIZE  5

/* Arbitrary short TV format values */
#define TV_INVALID      0
#define TV_VGA_60Hz     1
#define TV_240p_60Hz    2
#define TV_480p_60Hz    3
#define TV_480i_60Hz    4
#define TV_720p_60Hz    5
#define TV_1080p_60Hz   6
#define TV_1080i_60Hz   7
#define TV_288p_50Hz    8
#define TV_576p_50Hz    9
#define TV_576i_50Hz    10
#define TV_720p_50Hz    11
#define TV_1080p_50Hz   12
#define TV_1080i_50Hz   13

/* Shorthands for vinMode values in tmbslTDA9984.h */
#define iINVALID TMDL_HDMITX_VINMODE_INVALID
#define iCCIR656 TMDL_HDMITX_VINMODE_CCIR656
#define iRGB444  TMDL_HDMITX_VINMODE_RGB444 
#define iYUV444  TMDL_HDMITX_VINMODE_YUV444 
#define iYUV422  TMDL_HDMITX_VINMODE_YUV422 

/* Shorthands for input sync */
#define EMB      1
#define EXT      0

/* Shorthands for single/double pixel rate in tmbslTDA9984.h */
#define SINGLE   TMDL_HDMITX_PIXRATE_SINGLE
#define DOUBLE   TMDL_HDMITX_PIXRATE_DOUBLE

/* Shorthands for sampling frequency in tmdlHdmiTxSetAudioInput API */
#define AIF_SF_REFER_TO_STREAM_HEADER   0
#define AIF_SF_32K                      1
#define AIF_SF_44K                      2
#define AIF_SF_48K                      3
#define AIF_SF_88K                      4
#define AIF_SF_96K                      5
#define AIF_SF_176K                     6
#define AIF_SF_192K                     7

/* HDCP check interval in milliseconds */
#define HDCP_CHECK_INTERVAL_MS  2500

/* Number of HDCP checks to carry out after HDCP is started */
#define HDCP_NUM_CHECKS         5


#define TMDL_HDMITX_CHANNELALLOC_LUT_SIZE 32


static UInt8 kChanAllocChanNum[TMDL_HDMITX_CHANNELALLOC_LUT_SIZE] = \
{2,3,3,4,3,4,4,5,4,5,5,6,5,6,6,7,6,7,7,8,4,5,5,6,5,6,6,7,6,7,7,8 };


/**
 * Lookup table to convert from EIA/CEA TV video format to
 * aspect ratio used in video infoframe:
 * Aspect ratio 1=4:3, 2=16:9
 */
#ifndef FORMAT_PC
static UInt8 kVfmtToAspect_TV[TMDL_HDMITX_VFMT_TV_NUM] =
#else /* FORMAT_PC */
static UInt8 kVfmtToAspect_TV[TMDL_HDMITX_VFMT_TV_NUM + TMDL_HDMITX_VFMT_PC_NUM] =
#endif /* FORMAT_PC */
{
    0,  /* HDMITX_VFMT_NULL                */
    1,  /* HDMITX_VFMT_01_640x480p_60Hz    */
    1,  /* HDMITX_VFMT_02_720x480p_60Hz    */
    2,  /* HDMITX_VFMT_03_720x480p_60Hz    */
    2,  /* HDMITX_VFMT_04_1280x720p_60Hz   */
    2,  /* HDMITX_VFMT_05_1920x1080i_60Hz  */
    1,  /* HDMITX_VFMT_06_720x480i_60Hz    */
    2,  /* HDMITX_VFMT_07_720x480i_60Hz    */
    1,  /* HDMITX_VFMT_08_720x240p_60Hz    */
    2,  /* HDMITX_VFMT_09_720x240p_60Hz    */
    1,  /* HDMITX_VFMT_10_720x480i_60Hz    */
    2,  /* HDMITX_VFMT_11_720x480i_60Hz    */
    1,  /* HDMITX_VFMT_12_720x240p_60Hz    */
    2,  /* HDMITX_VFMT_13_720x240p_60Hz    */
    1,  /* HDMITX_VFMT_14_1440x480p_60Hz   */
    2,  /* HDMITX_VFMT_15_1440x480p_60Hz   */
    2,  /* HDMITX_VFMT_16_1920x1080p_60Hz  */
    1,  /* HDMITX_VFMT_17_720x576p_50Hz    */
    2,  /* HDMITX_VFMT_18_720x576p_50Hz    */
    2,  /* HDMITX_VFMT_19_1280x720p_50Hz   */
    2,  /* HDMITX_VFMT_20_1920x1080i_50Hz  */
    1,  /* HDMITX_VFMT_21_720x576i_50Hz    */
    2,  /* HDMITX_VFMT_22_720x576i_50Hz    */
    1,  /* HDMITX_VFMT_23_720x288p_50Hz    */
    2,  /* HDMITX_VFMT_24_720x288p_50Hz    */
    1,  /* HDMITX_VFMT_25_720x576i_50Hz    */
    2,  /* HDMITX_VFMT_26_720x576i_50Hz    */
    1,  /* HDMITX_VFMT_27_720x288p_50Hz    */
    2,  /* HDMITX_VFMT_28_720x288p_50Hz    */
    1,  /* HDMITX_VFMT_29_1440x576p_50Hz   */
    2,  /* HDMITX_VFMT_30_1440x576p_50Hz   */
    2,  /* HDMITX_VFMT_31_1920x1080p_50Hz  */
    2,  /* HDMITX_VFMT_32_1920x1080p_24Hz  */
    2,  /* HDMITX_VFMT_33_1920x1080p_25Hz  */
    2   /* HDMITX_VFMT_34_1920x1080p_30Hz  */
#ifdef FORMAT_PC
   ,1,  /* HDMITX_VFMT_PC_640x480p_60Hz    */
    1,  /* HDMITX_VFMT_PC_800x600p_60Hz    */
    1,  /* HDMITX_VFMT_PC_1152x960p_60Hz   */
    1,  /* HDMITX_VFMT_PC_1024x768p_60Hz   */