tmdlhdmitx_types.h

HDMI NXP9983 chipset controller driver

    UInt8   *pEdidBuffer;       /**< Pointer to raw EDID data */
    UInt32  edidBufferSize;     /**< Size of buffer for raw EDID data */
} tmdlHdmiTxInstanceSetupInfo_t;

/**
 * \brief Enum listing all IA/CEA 861-D video formats
 */
typedef enum
{
    TMDL_HDMITX_VFMT_NULL               = 0,    /**< Not a valid format...        */
    TMDL_HDMITX_VFMT_NO_CHANGE          = 0,    /**< ...or no change required     */
    TMDL_HDMITX_VFMT_MIN                = 1,    /**< Lowest valid format          */
    TMDL_HDMITX_VFMT_TV_MIN             = 1,    /**< Lowest valid TV format       */
    TMDL_HDMITX_VFMT_01_640x480p_60Hz   = 1,    /**< Format 01 640  x 480p  60Hz  */
    TMDL_HDMITX_VFMT_02_720x480p_60Hz   = 2,    /**< Format 02 720  x 480p  60Hz  */
    TMDL_HDMITX_VFMT_03_720x480p_60Hz   = 3,    /**< Format 03 720  x 480p  60Hz  */
    TMDL_HDMITX_VFMT_04_1280x720p_60Hz  = 4,    /**< Format 04 1280 x 720p  60Hz  */
    TMDL_HDMITX_VFMT_05_1920x1080i_60Hz = 5,    /**< Format 05 1920 x 1080i 60Hz  */
    TMDL_HDMITX_VFMT_06_720x480i_60Hz   = 6,    /**< Format 06 720  x 480i  60Hz  */
    TMDL_HDMITX_VFMT_07_720x480i_60Hz   = 7,    /**< Format 07 720  x 480i  60Hz  */
    TMDL_HDMITX_VFMT_08_720x240p_60Hz   = 8,    /**< Format 08 720  x 240p  60Hz  */
    TMDL_HDMITX_VFMT_09_720x240p_60Hz   = 9,    /**< Format 09 720  x 240p  60Hz  */
    TMDL_HDMITX_VFMT_10_720x480i_60Hz   = 10,   /**< Format 10 720  x 480i  60Hz  */
    TMDL_HDMITX_VFMT_11_720x480i_60Hz   = 11,   /**< Format 11 720  x 480i  60Hz  */
    TMDL_HDMITX_VFMT_12_720x240p_60Hz   = 12,   /**< Format 12 720  x 240p  60Hz  */
    TMDL_HDMITX_VFMT_13_720x240p_60Hz   = 13,   /**< Format 13 720  x 240p  60Hz  */
    TMDL_HDMITX_VFMT_14_1440x480p_60Hz  = 14,   /**< Format 14 1440 x 480p  60Hz  */
    TMDL_HDMITX_VFMT_15_1440x480p_60Hz  = 15,   /**< Format 15 1440 x 480p  60Hz  */
    TMDL_HDMITX_VFMT_16_1920x1080p_60Hz = 16,   /**< Format 16 1920 x 1080p 60Hz  */
    TMDL_HDMITX_VFMT_17_720x576p_50Hz   = 17,   /**< Format 17 720  x 576p  50Hz  */
    TMDL_HDMITX_VFMT_18_720x576p_50Hz   = 18,   /**< Format 18 720  x 576p  50Hz  */
    TMDL_HDMITX_VFMT_19_1280x720p_50Hz  = 19,   /**< Format 19 1280 x 720p  50Hz  */
    TMDL_HDMITX_VFMT_20_1920x1080i_50Hz = 20,   /**< Format 20 1920 x 1080i 50Hz  */
    TMDL_HDMITX_VFMT_21_720x576i_50Hz   = 21,   /**< Format 21 720  x 576i  50Hz  */
    TMDL_HDMITX_VFMT_22_720x576i_50Hz   = 22,   /**< Format 22 720  x 576i  50Hz  */
    TMDL_HDMITX_VFMT_23_720x288p_50Hz   = 23,   /**< Format 23 720  x 288p  50Hz  */
    TMDL_HDMITX_VFMT_24_720x288p_50Hz   = 24,   /**< Format 24 720  x 288p  50Hz  */
    TMDL_HDMITX_VFMT_25_720x576i_50Hz   = 25,   /**< Format 25 720  x 576i  50Hz  */
    TMDL_HDMITX_VFMT_26_720x576i_50Hz   = 26,   /**< Format 26 720  x 576i  50Hz  */
    TMDL_HDMITX_VFMT_27_720x288p_50Hz   = 27,   /**< Format 27 720  x 288p  50Hz  */
    TMDL_HDMITX_VFMT_28_720x288p_50Hz   = 28,   /**< Format 28 720  x 288p  50Hz  */
    TMDL_HDMITX_VFMT_29_1440x576p_50Hz  = 29,   /**< Format 29 1440 x 576p  50Hz  */
    TMDL_HDMITX_VFMT_30_1440x576p_50Hz  = 30,   /**< Format 30 1440 x 576p  50Hz  */
    TMDL_HDMITX_VFMT_31_1920x1080p_50Hz = 31,   /**< Format 31 1920 x 1080p 50Hz  */
    TMDL_HDMITX_VFMT_32_1920x1080p_24Hz = 32,   /**< Format 32 1920 x 1080p 24Hz  */
    TMDL_HDMITX_VFMT_33_1920x1080p_25Hz = 33,   /**< Format 33 1920 x 1080p 25Hz  */
    TMDL_HDMITX_VFMT_34_1920x1080p_30Hz = 34,   /**< Format 34 1920 x 1080p 30Hz  */
    TMDL_HDMITX_VFMT_TV_MAX             = 34,   /**< Highest valid TV format      */
    TMDL_HDMITX_VFMT_TV_NO_REG_MIN      = 32,   /**< Lowest TV format without prefetched table */
    TMDL_HDMITX_VFMT_TV_NUM             = 35,   /**< Number of TV formats & null  */
    TMDL_HDMITX_VFMT_PC_MIN             = 128,  /**< Lowest valid PC format       */
    TMDL_HDMITX_VFMT_PC_640x480p_60Hz   = 128,  /**< PC format 128                */
    TMDL_HDMITX_VFMT_PC_800x600p_60Hz   = 129,  /**< PC format 129                */
    TMDL_HDMITX_VFMT_PC_1152x960p_60Hz  = 130,  /**< PC format 130                */
    TMDL_HDMITX_VFMT_PC_1024x768p_60Hz  = 131,  /**< PC format 131                */
    TMDL_HDMITX_VFMT_PC_1280x768p_60Hz  = 132,  /**< PC format 132                */
    TMDL_HDMITX_VFMT_PC_1280x1024p_60Hz = 133,  /**< PC format 133                */
    TMDL_HDMITX_VFMT_PC_1360x768p_60Hz  = 134,  /**< PC format 134                */
    TMDL_HDMITX_VFMT_PC_1400x1050p_60Hz = 135,  /**< PC format 135                */
    TMDL_HDMITX_VFMT_PC_1600x1200p_60Hz = 136,  /**< PC format 136                */
    TMDL_HDMITX_VFMT_PC_1024x768p_70Hz  = 137,  /**< PC format 137                */
    TMDL_HDMITX_VFMT_PC_640x480p_72Hz   = 138,  /**< PC format 138                */
    TMDL_HDMITX_VFMT_PC_800x600p_72Hz   = 139,  /**< PC format 139                */
    TMDL_HDMITX_VFMT_PC_640x480p_75Hz   = 140,  /**< PC format 140                */
    TMDL_HDMITX_VFMT_PC_1024x768p_75Hz  = 141,  /**< PC format 141                */
    TMDL_HDMITX_VFMT_PC_800x600p_75Hz   = 142,  /**< PC format 142                */
    TMDL_HDMITX_VFMT_PC_1024x864p_75Hz  = 143,  /**< PC format 143                */
    TMDL_HDMITX_VFMT_PC_1280x1024p_75Hz = 144,  /**< PC format 144                */
    TMDL_HDMITX_VFMT_PC_640x350p_85Hz   = 145,  /**< PC format 145                */
    TMDL_HDMITX_VFMT_PC_640x400p_85Hz   = 146,  /**< PC format 146                */
    TMDL_HDMITX_VFMT_PC_720x400p_85Hz   = 147,  /**< PC format 147                */
    TMDL_HDMITX_VFMT_PC_640x480p_85Hz   = 148,  /**< PC format 148                */
    TMDL_HDMITX_VFMT_PC_800x600p_85Hz   = 149,  /**< PC format 149                */
    TMDL_HDMITX_VFMT_PC_1024x768p_85Hz  = 150,  /**< PC format 150                */
    TMDL_HDMITX_VFMT_PC_1152x864p_85Hz  = 151,  /**< PC format 151                */
    TMDL_HDMITX_VFMT_PC_1280x960p_85Hz  = 152,  /**< PC format 152                */
    TMDL_HDMITX_VFMT_PC_1280x1024p_85Hz = 153,  /**< PC format 153                */
    TMDL_HDMITX_VFMT_PC_1024x768i_87Hz  = 154,  /**< PC format 154                */
    TMDL_HDMITX_VFMT_PC_MAX             = 154,  /**< Highest valid PC format      */
    TMDL_HDMITX_VFMT_PC_NUM             = (1+154-128)   /**< Number of PC formats         */
} tmdlHdmiTxVidFmt_t;

/**
 * \brief Structure defining the EDID short video descriptor
 */
typedef struct
{
    tmdlHdmiTxVidFmt_t  videoFormat;            /**< Video format as defined by EIA/CEA 861-D */
    Bool                nativeVideoFormat;   /**< True if format is the preferred video format */
} tmdlHdmiTxShortVidDesc_t;

/**
 * \brief Enum listing all picture aspect ratio (H:V) (4:3, 16:9)
 */
typedef enum
{
    TMDL_HDMITX_P_ASPECT_RATIO_UNDEFINED    = 0,    /**< Undefined picture aspect ratio */
    TMDL_HDMITX_P_ASPECT_RATIO_6_5          = 1,    /**< 6:5 picture aspect ratio (PAR) */
    TMDL_HDMITX_P_ASPECT_RATIO_5_4          = 2,    /**< 5:4 PAR */
    TMDL_HDMITX_P_ASPECT_RATIO_4_3          = 3,    /**< 4:3 PAR */
    TMDL_HDMITX_P_ASPECT_RATIO_16_10        = 4,    /**< 16:10 PAR */
    TMDL_HDMITX_P_ASPECT_RATIO_5_3          = 5,    /**< 5:3 PAR */
    TMDL_HDMITX_P_ASPECT_RATIO_16_9         = 6,    /**< 16:9 PAR */
    TMDL_HDMITX_P_ASPECT_RATIO_9_5          = 7    /**< 9:5 PAR */
} tmdlHdmiTxPictAspectRatio_t;

/**
 * \brief Enum listing all vertical frequency
 */
typedef enum
{
    TMDL_HDMITX_VFREQ_24Hz      = 0,    /**< 24Hz          */
    TMDL_HDMITX_VFREQ_25Hz      = 1,    /**< 25Hz          */
    TMDL_HDMITX_VFREQ_30Hz      = 2,    /**< 30Hz          */
    TMDL_HDMITX_VFREQ_50Hz      = 3,    /**< 50Hz          */
    TMDL_HDMITX_VFREQ_59Hz      = 4,    /**< 59.94Hz       */
    TMDL_HDMITX_VFREQ_60Hz      = 5,    /**< 60Hz          */
#ifndef FORMAT_PC
    TMDL_HDMITX_VFREQ_INVALID   = 6,    /**< Invalid       */
    TMDL_HDMITX_VFREQ_NUM       = 6     /**< No. of values */
#else /* FORMAT_PC */
    TMDL_HDMITX_VFREQ_70Hz      = 6,    /**< 70Hz          */
    TMDL_HDMITX_VFREQ_72Hz      = 7,    /**< 72Hz          */
    TMDL_HDMITX_VFREQ_75Hz      = 8,    /**< 75Hz          */
    TMDL_HDMITX_VFREQ_85Hz      = 9,    /**< 85Hz          */
    TMDL_HDMITX_VFREQ_87Hz      = 10,   /**< 87Hz          */
    TMDL_HDMITX_VFREQ_INVALID   = 11,   /**< Invalid       */
    TMDL_HDMITX_VFREQ_NUM       = 11    /**< No. of values */
#endif /* FORMAT_PC */
} tmdlHdmiTxVfreq_t;

/**
 * \brief Structure storing specifications of a video resolution
 */
typedef struct
{
    UInt16                      width;         /**< Width of the frame in pixels */
    UInt16                      height;        /**< Height of the frame in pixels */
    Bool                        interlaced;    /**< Interlaced mode (True/False) */
    tmdlHdmiTxVfreq_t           vfrequency;    /**< Vertical frequency in Hz */
    tmdlHdmiTxPictAspectRatio_t aspectRatio;   /**< Picture aspect ratio (H:V) */
} tmdlHdmiTxVidFmtSpecs_t;

/**
 * \brief Enum listing all video input modes (CCIR, RGB, etc.)
 */
typedef enum
{
    TMDL_HDMITX_VINMODE_CCIR656     = 0,    /**< CCIR656 */
    TMDL_HDMITX_VINMODE_RGB444      = 1,    /**< RGB444  */
    TMDL_HDMITX_VINMODE_YUV444      = 2,    /**< YUV444  */
    TMDL_HDMITX_VINMODE_YUV422      = 3,    /**< YUV422  */
    TMDL_HDMITX_VINMODE_NO_CHANGE   = 4,    /**< No change */
    TMDL_HDMITX_VINMODE_INVALID     = 5     /**< Invalid */
} tmdlHdmiTxVinMode_t;

/**
 * \brief Enum listing all possible sync sources
 */
typedef enum
{
    TMDL_HDMITX_SYNCSRC_EMBEDDED = 0, /**< Embedded sync */
    TMDL_HDMITX_SYNCSRC_EXT_VREF = 1, /**< External sync Vref, Href, Fref */
    TMDL_HDMITX_SYNCSRC_EXT_VS   = 2 /**< External sync Vs, Hs */
} tmdlHdmiTxSyncSource_t;

/**
 * \brief Enum listing all output pixel rate (Single, Double, etc.)
 */
typedef enum
{
    TMDL_HDMITX_PIXRATE_DOUBLE          = 0,        /**< Double pixel rate */
    TMDL_HDMITX_PIXRATE_SINGLE          = 1,        /**< Single pixel rate */
    TMDL_HDMITX_PIXRATE_SINGLE_REPEATED = 2        /**< Single pixel repeated */
} tmdlHdmiTxPixRate_t;

/**
 * \brief Structure defining the video input configuration
 */
typedef struct
{
   tmdlHdmiTxVidFmt_t       format;     /**< Video format as defined by EIA/CEA 861-D */
   tmdlHdmiTxVinMode_t      mode;       /**< Video mode (CCIR, RGB, YUV, etc.) */
   tmdlHdmiTxSyncSource_t   syncSource; /**< Sync source type */
   tmdlHdmiTxPixRate_t      pixelRate;  /**< Pixel rate */
} tmdlHdmiTxVideoInConfig_t;

/**
 * \brief Enum listing all video output modes (YUV, RGB, etc.)
 */
typedef enum
{
    TMDL_HDMITX_VOUTMODE_RGB444     = 0,    /**< RGB444    */
    TMDL_HDMITX_VOUTMODE_YUV422     = 1,    /**< YUV422    */
    TMDL_HDMITX_VOUTMODE_YUV444     = 2    /**< YUV444    */
} tmdlHdmiTxVoutMode_t;

/**
 * \brief Structure defining the video output configuration
 */
typedef struct
{
   tmdlHdmiTxVidFmt_t       format;     /**< Video format as defined by EIA/CEA 861-D */
   tmdlHdmiTxVoutMode_t     mode;       /**< Video mode (CCIR, RGB, YUV, etc.) */
   tmdlHdmiTxColorDepth_t   colorDepth; /**< Color depth */
} tmdlHdmiTxVideoOutConfig_t;

/**
 * \brief Structure defining the audio input configuration
 */
typedef struct
{
   tmdlHdmiTxAudioFormat_t          format;         /**< Audio format (I2S, SPDIF, etc.) */
   tmdlHdmiTxAudioRate_t            rate;           /**< Audio sampling rate */
   tmdlHdmiTxPixRate_t              pixRate;        /**< Sync source type */
   tmdlHdmiTxAudioI2SFormat_t       i2sFormat;      /**< I2S format of the audio input */
   tmdlHdmiTxAudioI2SQualifier_t    i2sQualifier;   /**< I2S qualifier of the audio input (8,16,32 bits) */
   tmdlHdmiTxDstRate_t              dstRate;        /**< DST data transfer rate */
   UInt8                            channelAllocation;  /**< Ref to CEA-861D p85 */
} tmdlHdmiTxAudioInConfig_t;

/**
 * \brief Enum listing all the type of sunk
 */
typedef enum
{
    TMDL_HDMITX_SINK_DVI  = 0, /**< DVI  */
    TMDL_HDMITX_SINK_HDMI = 1, /**< HDMI */
    TMDL_HDMITX_SINK_EDID = 2 /**< As currently defined in EDID */
} tmdlHdmiTxSinkType_t;

/**
 * \brief Structure defining the content of a gamut packet
 */
typedef struct
{
    Bool   nextField;           /**< Gamut relevant for field following packet insertion */
    UInt8  GBD_Profile;         /**< Profile of the gamut packet : 0 = P0, 1 = P1 */
    UInt8  affectedGamutSeqNum; /**< Gamut sequence number of the field that have to be affected by this gamut packet */
    Bool   noCurrentGBD;        /**< Current field not using specific gamut */
    UInt8  currentGamutSeqNum;  /**< Gamut sequence number of the current field */
    UInt8  packetSequence;      /**< Sequence of the packet inside a multiple packet gamut */
    UInt8  payload[28];         /**< Payload of the gamut packet */
} tmdlHdmiTxGamutData_t;

/**
 * \brief Type defining the content of a generic packet
 */
typedef UInt8 tmdlHdmiTxGenericPacket[28];

/**
 * \brief Structure defining the content of an ACP packet