xref: /utopia/UTPA2-700.0.x/modules/pcmcia/drv/pcmcia/pcmcia_private.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 
81 ///////////////////////////////////////////////////////////////////////////////
82 ///
83 /// file    pcmcia_private.h
84 /// @brief  PCMCIA Driver Utopia2.0 private
85 /// @author MStar Semiconductor Inc.
86 ///////////////////////////////////////////////////////////////////////////////
87 
88 #ifndef __PCMCIA_PRIVATE__
89 #define __PCMCIA_PRIVATE__
90 #include "drvPCMCIA.h"
91 
92 #define MAGIC_NUM 0x87654321
93 
94 enum {
95     E_PCMCIA_RESOURCE,
96 } ePcmResourceId;
97 
98 typedef struct _PCMCIA_RESOURCE_PRIVATE
99 {
100 //    MS_BOOL         bPCMCIA_Irq[E_PCMCIA_MODULE_MAX];
101 //    MS_BOOL         bPCMCIA_IrqStatus[E_PCMCIA_MODULE_MAX];
102 //    MS_U8           u8PCMCIA_Command[E_PCMCIA_MODULE_MAX];
103 //    MS_U8           u8HW_ResetDuration;
104 
105 //    MS_BOOL         bHighActive;
106 //    MS_BOOL         bCardInside[E_PCMCIA_MODULE_MAX];
107 //    MS_BOOL         bPCMCIA_Detect_Enable;
108 //    MS_U32          u32PCMCIA_CD_To_HWRST_Timer[E_PCMCIA_MODULE_MAX];
109     MS_U8           u8PCMCIACurModule;
110 
111     // APP callback function
112 //    IsrCallback     fnIsrCallback[E_PCMCIA_MODULE_MAX];
113 
114     MS_BOOL         bInited_Drv;
115     MS_U32          u32Magic;
116     MS_BOOL         bCD_Reverse;
117 } PCMCIA_RESOURCE_PRIVATE;
118 
119 typedef struct _PCMCIA_INSTANT_PRIVATE
120 {
121 } PCMCIA_INSTANT_PRIVATE;
122 
123 
124 void        _MDrv_PCMCIA_InitSW( MS_BOOL bCD_Reverse );
125 void        _MDrv_PCMCIA_InitHW( MS_BOOL bResume );
126 MS_U32      _MDrv_PCMCIA_SetPowerState(EN_POWER_MODE u16PowerState);
127 MS_BOOL     _MDrv_PCMCIA_DetectV2( PCMCIA_MODULE eModule );
128 MS_BOOL     _MDrv_PCMCIA_PollingV2( PCMCIA_MODULE eModule );
129 void        _MDrv_PCMCIA_Set_HW_ResetDuration( MS_U8 u8HW_ResetDuration );
130 void        _MDrv_PCMCIA_ResetHW_V2( PCMCIA_MODULE eModule);
131 void        _MDrv_PCMCIA_WriteAttribMemV2( PCMCIA_MODULE eModule, MS_U16 u16Addr, MS_U8 u8Value);
132 void        _MDrv_PCMCIA_ReadAttribMemV2( PCMCIA_MODULE eModule, MS_U16 u16Addr, MS_U8 *pDest );
133 void        _MDrv_PCMCIA_WriteIOMemV2( PCMCIA_MODULE eModule, MS_U16 u16Addr, MS_U8 u8Value);
134 void        _MDrv_PCMCIA_WriteIOMemLongV2( PCMCIA_MODULE eModule, MS_U16 u16Addr, MS_U8 u8Value, MS_U16 u16DataLen, MS_U8* u8pWriteBuffer);
135 MS_U8       _MDrv_PCMCIA_ReadIOMemV2( PCMCIA_MODULE eModule, MS_U16 u16Addr );
136 MS_BOOL     _MDrv_PCMCIA_IsModuleStillPluggedV2( PCMCIA_MODULE eModule );
137 void        _MDrv_PCMCIA_Set_Detect_Trigger( MS_BOOL bHighActive );
138 void        _MDrv_PCMCIA_Set_Detect_Enable( MS_BOOL bEnable );
139 MS_U32      _MDrv_PCMCIA_Get_CD_IntervalV2( PCMCIA_MODULE eModule );
140 void        _MDrv_PCMCIA_ParseAttribMem( MS_U8 *pAttribMem, MS_U16 dwLen, PCMCIA_INFO *pInfo );
141 void        _MDrv_PCMCIA_SetCommandBitV2( PCMCIA_MODULE eModule, MS_U8 u8CommandBit, MS_BOOL bValue );
142 MS_BOOL     _MDrv_PCMCIA_ResetInterfaceV2( PCMCIA_MODULE eModule );
143 MS_BOOL     _MDrv_PCMCIA_IsDataAvailableV2( PCMCIA_MODULE eModule );
144 MS_U16      _MDrv_PCMCIA_ReadDataV2( PCMCIA_MODULE eModule, MS_U8* u8pReadBuffer, MS_U16 u16ReadBufferSize );
145 MS_BOOL     _MDrv_PCMCIA_WriteDataV2( PCMCIA_MODULE eModule, MS_U8* u8pWriteBuffer, MS_U16 u16DataLen );
146 MS_BOOL     _MDrv_PCMCIA_SwitchToIOmodeV2( PCMCIA_MODULE eModule, PCMCIA_INFO *pInfo );
147 MS_U16      _MDrv_PCMCIA_NegotiateBufferSizeV2( PCMCIA_MODULE eModule, PCMCIA_INFO *pInfo );
148 void        _MDrv_PCMCIA_WriteBufferSizeV2( PCMCIA_MODULE eModule, MS_U16 u16BufferSize );
149 MS_BOOL     _MDrv_PCMCIA_GetLibVer( const MSIF_Version **ppVersion );
150 void        _MDrv_PCMCIA_Enable_InterruptV2( PCMCIA_MODULE eModule, MS_BOOL bEnable );
151 void        _MDrv_PCMCIA_Set_InterruptStatusV2( PCMCIA_MODULE eModule, MS_BOOL Status );
152 MS_BOOL     _MDrv_PCMCIA_Get_InterruptStatusV2( PCMCIA_MODULE eModule );
153 void        _MDrv_PCMCIA_InstarllIsrCallbackV2( PCMCIA_MODULE eModule, IsrCallback fnIsrCallback );
154 MS_BOOL     _MDrv_PCMCIA_WaitForStatusBitV2( PCMCIA_MODULE eModule, MS_U8 u8StatusBit );
155 void        _MDrv_PCMCIA_Exit( MS_BOOL bSuspend );
156 #endif //__PCMCIA_PRIVATE__
157