/* **************************************************** */
/*!
   @file	MN_DMD_common.h
   @brief	Panasonic Demodulator Driver
			(private common functions & declarations)
   @author	R.Mori
   @date	2011/6/30
   @param
		(c)	Panasonic
   */
/* **************************************************** */


#ifndef MN_DMD_COMMON_H
#define MN_DMD_COMMON_H

#include "MN_DMD_driver.h"

#ifdef __cplusplus
extern "C" {
#endif


/* **************************************************** */
/* DMD Defines */
/* **************************************************** */
#define DMD_NOT_SUPPORT		0
#define DMD_SYSTEM_MAX		15
#define DMD_TCB_DATA_MAX	256
#define DMD_REGISTER_MAX	2048
#define DMD_INFORMATION_MAX	512

/* **************************************************** */
/* Welcome !
Pls. add I2C api to control tuner and DMD
*/
/* **************************************************** */
//#define already_add_BE_API
//#ifndef already_add_BE_API
//#error "pls. search define <pls_add_your_ap> and add your own api , after you add api, pls. open define <already_add_BE_API  >"
//#endif
//#define PC_CONTROL_FE //it's for PC to communicate with FE.
// 1-1 SoC communicate with Tuner directly(SDA&SCL) or by Demod(MSDA&MSCL)
//#define TUNER_I2C_MODE TUNER_CONTROL_BY_SOC//TUNER_CONTROL_BY_DEMOD //TUNER_CONTROL_BY_SOC

// 1-2 Tuner I2C control method by Demod
//#if(TUNER_I2C_MODE == TUNER_CONTROL_BY_DEMOD)
// #define DEMOD_CONTROL_TUNER_I2C_MODE TCB_I2C_FORMAT_REPEAT_MODE //MN88472 only support repeator mode
//#endif



#define TUNER_TYPE NXP18273

#ifndef TUNER_TYPE
#error "Error : pls. define Tuner type !!"
#endif


/* **************************************************** */
/* OPEN ALL debug to do debugging : OPEN IT to know WHY you cannot lock signal*/
/* **************************************************** */
#define COMMON_DEBUG_ON
#ifdef COMMON_DEBUG_ON
//#define DMD_DEBUG
#endif

/* **************************************************** */
/* for Debug */
/* **************************************************** */
#ifdef DMD_DEBUG
#include "os_task.h"
#define DMD_DBG_TRACE(str)	do{printf(str);}while(0)
#define DMD_CHECK_ERROR( var, msg )	\
	if( var == DMD_E_ERROR ){ \
	fprintf( stderr , "ERROR:%s" , msg ) ;}
#else
#define DMD_DBG_TRACE(str)
#define DMD_CHECK_ERROR( var ,msg );
#endif

/* **************************************************** */
/* Structure & types */
/* **************************************************** */

/*! DMD Text List */
typedef struct
{
	DMD_u32_t		size;
	const DMD_text_t		list[32];
} DMD_textlist_t;

/*! ARRAY FLAG */
typedef enum {
	DMD_E_END_OF_ARRAY = 0,
	DMD_E_ARRAY
} DMD_ARRAY_FLAG_t;

/*! I2C Register Structure */
typedef struct {
	DMD_u8_t	slvadr;
	DMD_u8_t	adr;
	DMD_u8_t	data;
	DMD_ARRAY_FLAG_t	flag;
} DMD_I2C_Register_t;

/* **************************************************** */
/* I2C useful function */
/* **************************************************** */

extern DMD_u32_t	DMD_I2C_MaskWrite(DMD_u8_t	slvadr , DMD_u8_t adr , DMD_u8_t mask , DMD_u8_t  data );

/* **************************************************** */
/*  Functions for Local (not exported) */
/* **************************************************** */
extern DMD_u32_t DMD_trans_reg( DMD_I2C_Register_t* t);
extern DMD_u32_t log10_easy( DMD_u32_t cnr );

extern DMD_text_t	DMD_value_decimal( DMD_u32_t val );
extern DMD_text_t	DMD_value_hex( DMD_u32_t val );
extern DMD_text_t	DMD_value_textlist( DMD_textlist_t* list ,DMD_u32_t val );
extern DMD_u32_t	DMD_get_freq_kHz( DMD_PARAMETER* param );
extern DMD_u32_t	DMD_ber_int( DMD_u32_t	err , DMD_u32_t sum );

extern DMD_u32_t	DMD_calc_SQI( DMD_PARAMETER* param);

extern DMD_u32_t DMD_send_registers( DMD_u8_t	*slaveset , DMD_u8_t* regset );
extern DMD_u32_t DMD_read_registers( void );//Troy.wang added, for dumpping register.

extern DMD_u32_t	DMD_ber_int( DMD_u32_t	err , DMD_u32_t sum );
/* **************************************************** */
/*  Text List */
/* **************************************************** */
extern DMD_text_t DMD_info_value_common( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_dvbt( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_dvbt2( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_isdbt( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_isdbs( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_vq( DMD_u32_t id , DMD_u32_t val );
extern DMD_text_t DMD_info_value_dvbc( DMD_u32_t id , DMD_u32_t val );


extern DMD_text_t DMD_INFO_TITLE_COMMON[];
extern DMD_text_t DMD_INFO_TITLE_DVBT[];
extern DMD_text_t DMD_INFO_TITLE_DVBT2[];
extern DMD_text_t DMD_INFO_TITLE_DVBC[];
extern DMD_text_t DMD_INFO_TITLE_ISDBT[];
extern DMD_text_t DMD_INFO_TITLE_ISDBS[];
extern DMD_text_t DMD_INFO_TITLE_ATSC[];
extern DMD_text_t DMD_INFO_TITLE_QAM[];

extern	DMD_textlist_t	DMD_TEXTLIST_SYSTEM	;
extern	DMD_textlist_t	DMD_TEXTLIST_BW	;
extern	DMD_textlist_t	DMD_TEXTLIST_YESNO	;

extern	DMD_textlist_t	DMD_TEXTLIST_LOCK	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_STATUS	;
extern	DMD_textlist_t	DMD_TEXTLIST_ERRORFREE	;
extern	DMD_textlist_t	DMD_TEXTLIST_HIERARCHY_SEL	;
extern	DMD_textlist_t	DMD_TEXTLIST_TPS_ALL	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_MODE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_GI	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_CONST	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_HIERARCHY	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT_CR	;

extern	DMD_textlist_t	DMD_TEXTLIST_DVBC_STATUS;

extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_STATUS;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_MODE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_GI	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_TYPE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PAPR	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_L1_MOD	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_COD	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_FEC_TYPE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PILOT_PATTERN	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PLP_MODE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PLP_TYPE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PAYLOAD_TYPE	;
extern	DMD_textlist_t	DMD_TEXTLIST_DVBT2_PLP_MOD	;

extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_MODE	;
extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_GI	;
extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_SYSTEM	;
extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_MAP	;
extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_CR	;
extern	DMD_textlist_t	DMD_TEXTLIST_ISDBT_INT	;

extern	DMD_textlist_t	DMD_TEXTLIST_ISDBS_MOD	;
#ifdef __cplusplus
}
#endif

#endif