//<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) 2006-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.
//
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////////////////////////
///
/// @file   drvCMDQ_priv.h
/// @brief  CMDQ Driver Interface
/// @author MStar Semiconductor,Inc.
///
////////////////////////////////////////////////////////////////////////////////////////////////////



#ifndef _DRVCMDQ_PRIV_H_
#define _DRVCMDQ_PRIV_H_

#ifdef __cplusplus
extern "C"
{
#endif

// driver version
#define CMDQ_VERSION            0x00000001

#include "MsTypes.h"
enum {
    MDrv_CMD_CMDQ_GetLibVer,
    MDrv_CMD_CMDQ_Printf_Crash_Command,
    MDrv_CMD_CMDQ_Receive,
    MDrv_CMD_CMDQ_Set_timer_ratio,
    MDrv_CMD_CMDQ_SetDbgLevel,
} eCMDQIoctlOpt;

//ioctl function pointer type
typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_GETLIBVER)(const MSIF_Version **);
typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_PRINTFCRASHCOMMAND)(void);
typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_RECEIVE)(CH_Struct_Pointer);
typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_SETTIMERRATIO)(MS_U32, MS_U32);
typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_SETDBGLEVEL)(DrvCMDQ_DbgLevel);

// INSTANCE Private(ioctl function pointer)
typedef struct _CMDQ_INSTANT_PRIVATE
{
    IOCTL_CMDQ_GETLIBVER            fpCMDQGetLibVer;
    IOCTL_CMDQ_PRINTFCRASHCOMMAND   fpCMDQPrintf_Crash_Command;
    IOCTL_CMDQ_RECEIVE              fpCMDQReceive;
    IOCTL_CMDQ_SETTIMERRATIO        fpCMDQSet_Timer_Ratio;
    IOCTL_CMDQ_SETDBGLEVEL          fpCMDQSetDbgLevel;
}CMDQ_INSTANT_PRIVATE;

//////////////////////////////////////
// function parameter structure //////
//////////////////////////////////////
// for cmd MDrv_CMDQ_GetLibVer
typedef struct _CMDQ_GETLIBVER_PARAM
{
    const MSIF_Version **ppVersion;
}CMDQ_GETLIBVER_PARAM, *PCMDQ_GETLIBVER_PARAM;

// for cmd MDrv_CMDQ_Receive
typedef struct _CMDQ_RECEIVE_PARAM
{
    CH_Struct_Pointer New_IP_Head;
}CMDQ_RECEIVE_PARAM, *PCMDQ_RECEIVE_PARAM;

// for cmd MDrv_CMDQ_Set_timer_ratio
typedef struct _CMDQ_SETTIMERRATIO_PARAM
{
    MS_U32 time;
    MS_U32 ratio;
}CMDQ_SETTIMERRATIO_PARAM, *PCMDQ_SETTIMERRATIO_PARAM;

// for cmd MDrv_CMDQ_SetDbgLevel
typedef struct _CMDQ_SETDBGLEVEL_PARAM
{
    DrvCMDQ_DbgLevel DbgLevel;
}CMDQ_SETDBGLEVEL_PARAM, *PCMDQ_SETDBGLEVEL_PARAM;

//////////////////////////////////////
// function for utopia2.0 ////////////
//////////////////////////////////////
void CMDQRegisterToUtopia(FUtopiaOpen ModuleType);
MS_U32 CMDQOpen(void** pInstance, void* pAttribute);
MS_U32 CMDQClose(void* pInstance);
MS_U32 CMDQIoctl(void* pInstance, MS_U32 u32Cmd, void *pArgs);


// Resource_Private
typedef struct _CMDQ_RESOURCE_PRIVATE
{
    MS_U32 Dummy;
}CMDQ_RESOURCE_PRIVATE;

DRVCMDQ_RESULT MDrv_CMDQv2_Init(int hnd, MS_U32 miu);
DRVCMDQ_RESULT MDrv_CMDQv2_Start(int hnd, MS_BOOL bStart);
DRVCMDQ_RESULT MDrv_CMDQv2_Get_Memory_Size(int hnd, MS_PHY smalladdr, MS_PHY bigaddr, MS_U32 miu);
DRVCMDQ_RESULT MDrv_CMDQv2_Set_Buffer(int hnd, MS_PHY startaddr, MS_PHY endaddr);
DRVCMDQ_RESULT MDrv_CMDQv2_Reset(int hnd);
DRVCMDQ_RESULT MDrv_CMDQv2_Exit(int hnd);
DRVCMDQ_RESULT MDrv_CMDQv2_Stop(int hnd);
DRVCMDQ_RESULT MDrv_CMDQv2_Receive(int hnd, CH_Struct_Pointer iphead);
void           MDrv_CMDQv2_Insert_Redundant_Null(int hnd, MS_U32 n);
void           MDrv_CMDQv2_Transfer(int hnd, CAF_Struct_Pointer cmdarray, MS_SIZE size);
void           MDrv_CMDQv2_Set_dummy_Address(int hnd, MS_U32 value);
void           MDrv_CMDQv2_Set_MIU_SELECT(int hnd, MS_U32 miu);
DRVCMDQ_RESULT MDrv_CMDQv2_Set_timer_ratio(int hnd, MS_U32 time, MS_U32 ratio);
DRVCMDQ_RESULT MDrv_CMDQv2_Printf_Crash_Command(int hnd);
void           MDrv_CMDQv2_Gen_WaitTrigger_Bus_Command(int hnd, CAF_Struct_Pointer cmd, EN_CMDQTriggerBus_ID id, MS_BOOL falledge);
MS_U32         MDrv_CMDQv2_GetWritePoint(int hnd);
MS_U32         MDrv_CMDQv2_SetPowerState(int hnd, EN_POWER_MODE u16PowerState);
MS_U32         MDrv_CMDQv2_Get_FreeCmdLine_Size(int hnd);

void           MDrv_CMDQv2_Dbg_WriteDummy(int hnd, MS_U32 value);
MS_U32         MDrv_CMDQv2_Dbg_ReadDummy(int hnd);
void           MDrv_CMDQv2_Dbg_Pause(int hnd);
void           MDrv_CMDQv2_Dbg_Continue(int hnd);

void           MDrv_CMDQv2_DumpContext(void);
MS_U32 MDrv_CMDQv2_GetConfig(int hnd,MS_PHY *SmallAddr, MS_PHY *BigAddr, MS_U32 *miu_select);

#ifdef __cplusplus
}
#endif

#endif // _DRVCMDQ_PRIV_H_