//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all 
// or part of MStar Software is expressly prohibited, unless prior written 
// permission has been granted by MStar. 
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.  
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software. 
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s 
//    confidential information in strictest confidence and not disclose to any
//    third party.  
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.  
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or 
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.  
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2008-2009 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// ("MStar Confidential Information") by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
////////////////////////////////////////////////////////////////////////////////

#ifndef _DFB_INFO_H_
#define _DFB_INFO_H_

#include "dfbinfo_types.h"


#if(REFINE_PARTITION==0)
#define SYS_INI_PATH_FILENAME          "/Customer/sys.ini"
#define DFBRC_INI_PATH_FILENAME        "/Customer/dfbrc.ini"
#define MMAP_PATH                      "/Customer/mmap.ini"
#else
#define SYS_INI_PATH_FILENAME          "/config/sys.ini"
#define DFBRC_INI_PATH_FILENAME        "/config/dfbrc.ini"
#define MMAP_PATH                      "/config/mmap.ini"
#endif




#ifdef __cplusplus
extern "C"
{
#endif

/// Return SetExtDFBJpegBufCfg's error code
typedef enum
{
    /// No error
    EN_NO_ERR,
    /// DirectFBSetOption error
    EN_ERR_DFB_SET_OPTON,
    /// Wrong JPEG read buffer address or length
    EN_ERR_JPD_READ_BUF,
    /// Wrong JPEG internal buffer address or length
    EN_ERR_JPD_INTER_BUF,
    /// Wrong JPEG write buffer address or length
    EN_ERR_JPD_WRITE_BUF,

} EN_SET_DFB_EXT_RESULT;

///////////////////////////////////////////////////////////////////////////////
// Keypad SAR Info.
///////////////////////////////////////////////////////////////////////////////
/// define SAR Kpd Bounds
typedef struct
{
    ///upper bound
    unsigned char u8UpBnd;
    ///low bound
    unsigned char u8LoBnd;
} SARKpdBndCfg;

/// define SAR Kpd Configuration
typedef struct
{
    bool bEnable;
    unsigned char u8SARChID;
    SARKpdBndCfg tSARChBnd;
    unsigned char u8KeyLevelNum;  // 0-8 levels
    unsigned char u8KeyThreshold[8];  // each threshold match to one keycode
    unsigned char u8KeyCode[8];
} SARKpdRegCfg;

/// define Gop Info
typedef struct
{
    unsigned short u16Dfbrc_mst_gop_counts;
    unsigned short u16Dfbrc_mst_gop_available_0;
    unsigned short u16Dfbrc_mst_gop_available_1;
    unsigned short u16Dfbrc_mst_gop_available_2;
    unsigned short u16Dfbrc_mst_gop_available_3;
    unsigned short u16Dfbrc_mst_gop_dstplane_0;
    unsigned short u16Dfbrc_mst_gop_dstplane_1;
    unsigned short u16Dfbrc_mst_gop_dstplane_2;
    unsigned short u16Dfbrc_mst_gop_dstplane_3;
} ST_DFBLAYERINFO;

BOOL Init(void);
BOOL Finalize(void);
BOOL SetExtDFBRcCfg(void);

//-------------------------------------------------------------------------------------------------
/// Set Ext DFB JPEG Buffer
/// @param  jpeg_hwdecode_enable                         \b IN: enable or disable
/// @return                                         \b OUT: EN_SET_DFB_EXT_RESULT
//-------------------------------------------------------------------------------------------------
EN_SET_DFB_EXT_RESULT SetExtDFBJpegBufCfg(BOOL jpeg_hwdecode_enable);

//--------reserve for backward compatible----------------------------------------------------------
/// Set Ext DFB JPEG Buffer
/// @param  jpeg_hwdecode_enable                         \b IN: enable or disable
/// @return None
//-------------------------------------------------------------------------------------------------
void SetExtDFBJpegHwDecodeEnableFlag(BOOL jpeg_hwdecode_enable);

//-------------------------------------------------------------------------------------------------
/// Set AP Keypad Config
/// @return                                             \b OUT:  False or True
//-------------------------------------------------------------------------------------------------
BOOL SetKEYPADCfg(void);

//-------------------------------------------------------------------------------------------------
/// Set the index of KeycodeMappingTable
/// @param  index                         \b IN: index of KeycodeMappingTable
/// @return None
//-------------------------------------------------------------------------------------------------
void SetKeycodeMappingTableIndex(U8 index);

//-------------------------------------------------------------------------------------------------
/// Load Keypad information from ini file. . It is called by SetKEYPADCfg.
/// @param  pKeypadInfo     Keypad configuration table
/// @param  pDict   INI parser pointer
/// @param iExtNum  Select external keypad no. (1~4)
/// @return                 \b OUT: true or false
//-------------------------------------------------------------------------------------------------
BOOL LoadKEYPADInfo(SARKpdRegCfg *pKeypadInfo, void *pDict, int iExtNum);

//-------------------------------------------------------------------------------------------------
/// Get Model name from sys.ini
/// @param  pSysteminiUpdateData : the ini parser pointer of sys.ini file
/// @param  pModelName : return model name
/// @return                 \b OUT: true or false
//-------------------------------------------------------------------------------------------------
BOOL GetModelName(char * pRetModelName, const unsigned short u16ModelNameLen);

//-------------------------------------------------------------------------------------------------
/// Get Dfb Layer Info
/// @param  pstDfbLayerInfo : DfbLayer Info
/// @return                 \b OUT: true or false
//-------------------------------------------------------------------------------------------------
BOOL GetDfbLayerInfo(ST_DFBLAYERINFO *pstDfbLayerInfo);

#ifdef __cplusplus
}
#endif

#endif // _DFB_INFO_H_

