xref: /utopia/UTPA2-700.0.x/modules/sc/hal/maldives/sc/halSC.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2006-2008 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // (��MStar Confidential Information��) by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 
96 #ifndef _HAL_SC_H_
97 #define _HAL_SC_H_
98 
99 
100 //-------------------------------------------------------------------------------------------------
101 //  Driver Capability
102 //-------------------------------------------------------------------------------------------------
103 #define SC_DEV_NUM                  1              // number of device Johnson
104 #define SC_IRQ                      E_INT_IRQ_SMART//E_INT_IRQ_UART1//E_IRQ_UART1
105 #define SC_IRQ2                     E_INT_IRQ_UART2//E_IRQ_UART2
106 
107 //-------------------------------------------------------------------------------------------------
108 //  Macro and Define
109 //-------------------------------------------------------------------------------------------------
110 #define SC_READ(id,addr)               ((!id)?UART1_READ(addr):UART2_READ(addr))
111 #define SC_WRITE(id,addr, val)         if((!id)){UART1_WRITE(addr, val);} else {UART2_WRITE(addr, val);}
112 #define SC_OR(id,addr, val)            if((!id)){UART1_OR(addr, val);}  else {UART2_OR(addr, val);}
113 #define SC_AND(id,addr, val)           if((!id)){UART1_AND(addr, val);} else {UART2_AND(addr, val);}
114 #define SC_XOR(id,addr, val)           if((!id)){UART1_XOR(addr, val);} else {UART2_XOR(addr, val);}
115 
116 #define SC_3M_UARTDIV(d)            (((d*9/5)>>1)+((d*9/5)&0x1))        // 3M/d=43.2M/(16*uart_div) => div=d*3/5
117 #define SC_4P5M_UARTDIV(d)          (((d*6/5)>>1)+((d*6/5)&0x1))        // 4.5M/d=43.2M/(16*uart_div) => div=d*3/5
118 #define SC_6M_UARTDIV(d)            (((d*9/10)>>1)+((d*9/10)&0x1))      // 6M/d=43.2M/(16*uart_div) => div=d*9/20
119 
120 
121 //-------------------------------------------------------------------------------------------------
122 //  Type and Structure
123 //-------------------------------------------------------------------------------------------------
124 
125 //-------------------------------------------------------------------------------------------------
126 //  Function and Variable
127 //-------------------------------------------------------------------------------------------------
128 extern MS_U32   _regSCBase[2]; // for DRV register access
129 
130 void    HAL_SC_SetClk(MS_U8 u8SCID,MS_U16 u16clk);
131 void    HAL_SC_Init(MS_U8 u8SCID);
132 void    HAL_SC_Exit(MS_U8 u8SCID);
133 void    HAL_SC_RegMap(MS_U32 u32RegBase);
134 void    HAL_SC_HW_RegMap(MS_U32 u32RegBase);
135 void    HAL_SC_PowerCtrl(MS_U8 u8SCID, MS_BOOL bEnable);
136 MS_BOOL HAL_SC_CardVoltage_Config(MS_U8 u8SCID, SC_VoltageCtrl eVoltage);
137 void    HAL_SC_CardInvert(MS_U8 u8SCID, SC_CardDetType eTpye);
138 
139 #endif // _HAL_SC_H_
140