xref: /utopia/UTPA2-700.0.x/modules/dscmb/hal/kano/nsk2/halEMMflt.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<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 _HAL_EMMFLT_H_
#define _HAL_EMMFLT_H_

////////////////////////////////////////////////////////////////////////////////
/// @file halEMMflt.h
/// @author MStar Semiconductor Inc.
/// @brief
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
// Header Files
////////////////////////////////////////////////////////////////////////////////
#include "regEMMflt.h"
////////////////////////////////////////////////////////////////////////////////
// Define & data type
////////////////////////////////////////////////////////////////////////////////

#define EMMFLT_EMM_INT                     EMM_ONEPAKCET_INT
#define EMMFLT_EMM_OVERFLOW_INT            EMM_OVERFLOW_INT
#define EMMFLT_STATES_GROUP                (EMMFLT_EMM_INT  | \
                                            EMMFLT_EMM_OVERFLOW_INT  )

#define EMM_TIDMODE_BASIC_MASK             0x101

#define NDS_EMMFLT_BUF_SIZE         (256)
#define U01_NDS_EMMFLT_BUF_SIZE     (256)
#define NDS_EMM_BUF_NUM             (16)
#define MAX_EMMFLT_NUM               10

#define MAX_EMM_LIST_NUM             11  // N for N-1 slots

#define U01_MAX_EMMFLT_NUM           10
#define EMMENG_NUMBER                2
#define EMMFLT_HWBUF_NUM             10

#define EMM_COPY_PACKET_SIZE         188

#define EMMFLT_HWBUF_SIZE            NDS_EMMFLT_BUF_SIZE*MAX_EMMFLT_NUM //4096
#define EMMFLT_BUF_ALIGNMENT         0x100


#define HAL_EMMFLT_OK                   0
#define HAL_EMMFLT_FAIL                 2
#define HAL_EMMFLT_INVALID_REQUEST      3


typedef enum
{
    E_TIDMODE_INGORE = 0x0,
    E_TIDMODE_ACCEPT_ALL = 0x1,
    E_TIDMODE_ACCEPT_ADDRESS = 0x10000,
    E_TIDMODE_RESERVED = 0x10001,
} EMM_TIDMODE_e;


#define EMM_IRD_REG_MASK  0x3
typedef enum
{
    E_IRD_REG_DISABLE = 0,
    E_IRD_REG_COMPARE,
} EMM_IRD_STATUS_e;


typedef enum
{
    EMM_FROM_TS0 = 0,
    EMM_FROM_TS1,
    EMM_FROM_TS2,
    EMM_FROM_TS3,
    EMM_FROM_TS4,
    EMM_FROM_TS5,
    EMM_FROM_TS6,
    EMM_FROM_TSO,
} EMM_SRC_FROM_e;

#if 0
typedef struct _EMMFLT_Config_
{
    MS_U16  u16EMM_PID;
    MS_U8   u8EMM_TID;
    MS_U16  u16EMM_CTRL_ID;
    MS_U16  u16RingSize_TS0;
    MS_U32  u32GeneralCtrl;
} EMMFLT_Config_t;
#endif

////////////////////////////////////////////////////////////////////////////////
// Extern function
////////////////////////////////////////////////////////////////////////////////
void HAL_EMMFLT_SetBank(MS_U32 u32Base);
MS_U32 HAL_EMMFLT_Init(void);
MS_U32 HAL_EMMFLT_GetHwBufCnt(MS_U32 *pHwBufCnt);
MS_U32 HAL_EMMFLT_SWReset(MS_U32 connection);
MS_U32 HAL_EMMFLT_SetDbgLevel(MS_U32 u32Level);
MS_U32 HAL_EMMFLT_Enable_Int(void);
MS_U32 HAL_EMMFLT_GetIntNumber(void);
MS_BOOL HAL_EMMFLT_GetIntMode(void);
MS_U32 HAL_EMMFLT_SetTidMode(MS_U32 connection, MS_U8 u8TidValue, EMM_TIDMODE_e eTIDMODE);
MS_U32 HAL_EMMFLT_SetIRDMode(MS_U32 connection,MS_U8 u8IRDNum, MS_U8 u8CompareMode);
MS_U32 HAL_EMMFLT_SetEmmDataIDx(MS_U32 connection, MS_U8 u8IRDNum, MS_U8 *pu8Data);
MS_U32 HAL_EMMFLT_SetEmmMaskIDx(MS_U32 connection,MS_U8 u8IRDNum, MS_U8 *pu8Data);
MS_U32 HAL_EMMFLT_DisableEMM(MS_U32 connection);
MS_U32 HAL_EMMFLT_SetEmmPID(MS_U32 connection,MS_U16 u16EmmPID);
MS_U32 HAL_EMMFLT_SetEmmTID(MS_U32 connection,MS_U16 u16EmmTID);
MS_U32 HAL_EMMFLT_EnableEmmTID(MS_U32 connection, MS_BOOL bEnable);
MS_U32 HAL_EMMFLT_GetIntReg(MS_U16 *pu16Data);
MS_U32 HAL_EMMFLT_GetIntStatus(MS_U16 *pu16EMMInt, MS_U16 *pu16IntStat, MS_U8 *pu8conflag);
MS_U32 HAL_EMMFLT_ReqDstBufSize(MS_U32 *p32DstBufSize, MS_U32 *p32AlignBytes, MS_U8 *p8BufBum);
MS_U32 HAL_EMMFLT_SetDstBufInfo(MS_U32 connection, MS_U32 u32BufAddr, MS_U32 u32BufSize, MS_U32 *p32BufAddrs);
MS_U32 HAL_EMMFLT_IntCtrl(MS_U8 u8En);
MS_U32 HAL_EMMFLT_GeneralCtrl(MS_U32 connection);
MS_U32 HAL_EMMFLT_GetDebugStatus(MS_U32 *pRegValue);
MS_U32 HAL_EMMFLT_SetDebugMode(MS_U16 u16Mode);
MS_U32 HAL_EMMFLT_PacketAct(MS_U32 connection);
MS_U32 HAL_EMMFLT_GetCurrentBufIndex(MS_U32 connection);
MS_U32 HAL_EMMFLT_PacketCount(MS_U32 connection,MS_U8 *pCount);
MS_U32 HAL_EMMFLT_SrcSelect(MS_U32 connection, MS_U32 u32SrcFrom, MS_U32 u32SrcType);
MS_U32 HAL_EMMFLT_ConnectCheck(MS_U32 connection);
MS_U32 HAL_EMMFLT_SetOutputType(MS_U32 connection, MS_U32 u32Type);
MS_U32 HAL_EMMFLT_ResetInt(MS_U32 connection);
MS_U32 HAL_EMMFLT_SetExtendConfig(MS_U32 x_connection, MS_U16 type, MS_U16 extendbytes, MS_U16 syncbyte);
MS_U32 HAL_EMMFLT_Bypass(void);
MS_U32 HAL_EMMFLT_InputMode(MS_U32 x_connection, MS_BOOL bSerial);


#if 0  //removed
MS_U32 HAL_EMMFLT_SetRingConfig(MS_U16 u16RingSize, MS_U32 RingBufStart, MS_U8 u8RingIndex);
#endif

MS_U32 HAL_EMMFLT_HWSimulation(void);
void HAL_EMMFLT_IntStatusTest(void);

#endif  //_HAL_EMMFLT_H_