/****************************************************************************/
/*             TEXAS INSTRUMENTS PROPRIETARY INFORMATION                    */
/*                                                                          */
/*  (c) Copyright, Texas Instruments Incorporated, 2006.                    */
/*      All Rights Reserved.                                                */
/*                                                                          */
/*  Property of Texas Instruments Incorporated. Restricted Rights -         */
/*  Use, duplication, or disclosure is subject to restrictions set          */
/*  forth in TI's program license agreement and associated documentation.   */
/****************************************************************************/

/****************************************************************************/
/* ddcCI.h                                                                 */
/****************************************************************************/

#ifndef __DDCCI_H
#define __DDCCI_H

#include "common.h"
#include "i2c.h"



/****************************************************************************/
/* Definitions                                                              */
/****************************************************************************/

#define CI_ADDRESS  0x6e                        /* i2c slave device address */


                            /************************************************/
                            /* DDC/CI Function completion codes.            */
                            /************************************************/

typedef enum _ddcCompletion
{
    DDC_FAIL,                                           /* generalized fail */
    DDC_PASS,                                                       /* pass */
    DDC_I2CPORT,                                 /* invalid i2c port number */
    DDC_OPEN,                                       /* unable to open slave */
    DDC_TASK,                                /* unable to start DDC/CI task */
    DDC_HOSTVALUE,                          /* invalid host parameter value */
    DDC_NOINPUT,                                   /* no active video input */
    DDC_UNABLE,                            /* unable to set requested value */
    DDC_UNKNOWNVCP,                                     /* unknown VCP code */
    
    eatme
}
    DDC_COMP;
    
                            /************************************************/
                            /* DDC/CI Message structure.                    */
                            /************************************************/

typedef struct _ciMsgStruct
{
    uint08  dstAddr;                                 /* destination address */
    uint08  srcAddr;                                      /* source address */
    uint08  length;                         /* message length (code + text) */
    uint08  code;                                         /* operation code */
    uint08  text[36];                   /* message text + trailing checksum */
}
    CI_MESSAGE, *pCI_MESSAGE;
    

                            /************************************************/
                            /* Message handler function type definition.    */
                            /************************************************/

typedef DDC_COMP (*HAND_FUNC)( pCI_MESSAGE pMsg, pCI_MESSAGE pRsp );


                            /************************************************/
                            /* Message dispatch table structure.            */
                            /************************************************/

typedef  const struct _ciDispatchStruct
{
    uint08     code;                                        /* message code */
    int08      expLength;                        /* expected message length */
    uint16     reserved;                 /* reserved struct alignment bytes */
    HAND_FUNC pHandler;                 /* message handler function pointer */
}
    CI_DISPATCH, *pCI_DISPATCH;


                            /************************************************/
                            /* Functions.                                   */
                            /************************************************/

void     ddcciDbCallback( void(*callback)( char *msg ));
DDC_COMP ddcciInit( I2CPORT port, uint32 ssize, uint32 taskpri, uint08 tabSize, pCI_DISPATCH dTable );
void     ddcciRspAvailable( BOOL available );
uint32   ddcciInfo( char **pTName );


#endif