xref: /utopia/UTPA2-700.0.x/mxlib/hal/maxim/halCHIP.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_CHIP_H_
#define _HAL_CHIP_H_



#ifdef __cplusplus
extern "C"
{
#endif

//-------------------------------------------------------------------------------------------------
//  Macro and Define
//-------------------------------------------------------------------------------------------------

typedef enum
{
  E_CHIP_MIU_0 = 0,
  E_CHIP_MIU_1,
  E_CHIP_MIU_2,
  E_CHIP_MIU_3,
  E_CHIP_MIU_NUM,
} CHIP_MIU_ID;

#define ARM_CLOCK_FREQ             1008000000
#define MIPS_CLOCK_FREQ            900000000
#define AEON_CLOCK_FREQ            240000000
#define XTAL_CLOCK_FREQ            12000000

#define HAL_MIU0_BASE               0x00000000UL
#if defined(__AEONR2__)
#define HAL_MIU1_BASE               0x40000000UL // 1512MB
#define HAL_MIU2_BASE               0xC0000000UL //
#else
#define HAL_MIU1_BASE               0x80000000UL // 1512MB
#define HAL_MIU2_BASE               0xC0000000UL //
#endif


#define HAL_MIU0_BUS_BASE           0x20000000UL  // MIU0 Low 256MB
#define HAL_MIU1_BUS_BASE           0xA0000000UL  // MIU1 Low 256MB MUJI: 0xA0000000UL
#define HAL_MIU2_BUS_BASE           0x300000000UL // 64 bit mapping

#define _phy_to_miu_offset(MiuSel, Offset, PhysAddr) if (PhysAddr < HAL_MIU1_BASE) \
                                                        {MiuSel = E_CHIP_MIU_0; Offset = PhysAddr;} \
                                                     else if ((PhysAddr >= HAL_MIU1_BASE) && (PhysAddr < HAL_MIU2_BASE)) \
                                                         {MiuSel = E_CHIP_MIU_1; Offset = PhysAddr - HAL_MIU1_BASE;} \
                                                     else \
                                                         {MiuSel = E_CHIP_MIU_2; Offset = PhysAddr - HAL_MIU2_BASE;}

#define _miu_offset_to_phy(MiuSel, Offset, PhysAddr) if (MiuSel == E_CHIP_MIU_0) \
                                                        {PhysAddr = Offset;} \
                                                     else if (MiuSel == E_CHIP_MIU_1) \
                                                         {PhysAddr = Offset + HAL_MIU1_BASE;} \
                                                     else \
                                                         {PhysAddr = Offset + HAL_MIU2_BASE;}

#define SUPPORT TRUE
#define NONSUPPORT FALSE

#define CHIP_IP_MFE SUPPORT
#define CHIP_IP_VE SUPPORT
#define CHIP_IP_AVD SUPPORT
#define CHIP_IP_DEMOD SUPPORT
#define CHIP_IP_VBI SUPPORT
#define CHIP_IP_VIF SUPPORT
#define CHIP_IP_DMX SUPPORT
#define CHIP_IP_CEC SUPPORT
#define CHIP_IP_MBX SUPPORT
#define CHIP_IP_SWI2C SUPPORT
#define CHIP_IP_BDMA SUPPORT
#define CHIP_IP_CPU SUPPORT
#define CHIP_IP_GPIO SUPPORT
#define CHIP_IP_HWI2C SUPPORT
#define CHIP_IP_IR SUPPORT
#define CHIP_IP_MIU SUPPORT
#define CHIP_IP_MPIF NONSUPPORT
#define CHIP_IP_MSPI SUPPORT
#define CHIP_IP_PM SUPPORT
#define CHIP_IP_PWM SUPPORT
#define CHIP_IP_PWS SUPPORT
#define CHIP_IP_RTC SUPPORT
#define CHIP_IP_SAR SUPPORT
#define CHIP_IP_URDMA SUPPORT
#define CHIP_IP_WDT SUPPORT
#define CHIP_IP_AESDMA SUPPORT
#define CHIP_IP_CA NONSUPPORT
#define CHIP_IP_PCMCIA SUPPORT
#define CHIP_IP_SC SUPPORT
#define CHIP_IP_GPD SUPPORT
#define CHIP_IP_JPEG SUPPORT
#define CHIP_IP_VDEC SUPPORT
#define CHIP_IP_ACE SUPPORT
#define CHIP_IP_DAC NONSUPPORT
#define CHIP_IP_DDC2BI SUPPORT
#define CHIP_IP_DIP SUPPORT
#define CHIP_IP_DLC SUPPORT
#define CHIP_IP_GOP SUPPORT
#define CHIP_IP_HDMITX NONSUPPORT
#define CHIP_IP_MHL SUPPORT
#define CHIP_IP_MVOP SUPPORT
#define CHIP_IP_PNL SUPPORT
#define CHIP_IP_XC SUPPORT
#define CHIP_IP_GFX SUPPORT
#define CHIP_IP_AUDIO SUPPORT
#define CHIP_IP_SERFLASH SUPPORT

//-------------------------------------------------------------------------------------------------
//  Type and Structure
//-------------------------------------------------------------------------------------------------


//-------------------------------------------------------------------------------------------------
//  Function and Variable
//-------------------------------------------------------------------------------------------------
void    CHIP_InitISR(void);
MS_BOOL CHIP_InISRContext(void);
MS_BOOL CHIP_AttachISR(InterruptNum eIntNum, InterruptCb pIntCb);
MS_BOOL CHIP_DetachISR(InterruptNum eIntNum);
MS_BOOL CHIP_EnableIRQ(InterruptNum eIntNum);
MS_BOOL CHIP_DisableIRQ(InterruptNum eIntNum);
MS_BOOL CHIP_EnableAllInterrupt(void);
MS_BOOL CHIP_DisableAllInterrupt(void);
MS_BOOL CHIP_DebugIRQ(InterruptNum eIntNum, IrqDebugOpt eIrqDebugOpt);
MS_BOOL CHIP_CompleteIRQ(InterruptNum eIntNum);


#ifdef __cplusplus
}
#endif

#endif // _HAL_CHIP_H_