xref: /utopia/UTPA2-700.0.x/modules/uart/hal/mooney/uart/halUART.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) 2008-2009 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 #ifndef _HAL_TEMP_H_
96 #define _HAL_TEMP_H_
97 
98 
99 //-------------------------------------------------------------------------------------------------
100 //  Macro and Define
101 //-------------------------------------------------------------------------------------------------
102 #define UART_DEVICE(_dev_)  ((struct uart_dev_struct *)(_dev_))
103 
104 #define UNUSED( var )       (void)((var) = (var))
105 
106 #define UART_DEV_MAX        20
107 
108 #define TX_FLAG_DISABLED    0x0001
109 #define TX_FLAG_DIRECT      0x0002
110 
111 #define RX_FLAG_DISABLED    0x0001
112 #define RX_FLAG_OVERFLOW    0x0002
113 
114 #define IOCTL_SET_BAUDRATE          0
115 #define IOCTL_SET_RXCALLBACK        1
116 #define IOCTL_SET_RXCALLBACK_HALREG 2
117 
118 #define UART_BASE       (u->regbase)
119 
120 #define AEON_REG8(_x_)  ((MS_U8 volatile *)(UART_BASE))[(_x_)]
121 #define UART_REG8(_x_)  ((MS_U8 volatile *)(_gMIO_MapBase+UART_BASE))[((_x_) * 4) - ((_x_) & 1)]
122 
123 
124 
125 //-------------------------------------------------------------------------------------------------
126 //  Type and Structure
127 //-------------------------------------------------------------------------------------------------
128 struct uart_dev_struct;
129 
130 typedef struct uart_dev_struct * ms_uart_dev_t;
131 
132 struct uart_dev_struct
133 {
134     struct device          device;
135     void                   (*rx_callback)(int c);
136     void                   (*rx_callback_halreg)(int c, MS_U32 pHalReg);
137     MS_U32                 regbase;
138     MS_U8                  *tx_buf;
139     MS_U16                 tx_buf_in;
140     volatile MS_U16        tx_buf_out;     // updated by ISR
141     MS_U16                 tx_buf_len;
142     MS_U16                 tx_flags;
143     MS_U8                  *rx_buf;
144     volatile MS_U16        rx_buf_in;      // updated by ISR
145     MS_U16                 rx_buf_out;
146     MS_U16                 rx_buf_len;
147     MS_U16                 rx_flags;
148     MS_U8                  uarttype ;
149 };
150 
151 extern struct uart_dev_struct _uart_dev[UART_DEV_MAX] ;
152 
153 //-------------------------------------------------------------------------------------------------
154 //  Function and Variable
155 //-------------------------------------------------------------------------------------------------
156 void HAL_UART_SetIOMapBase(MS_VIRT u32Base, MS_VIRT u32PMBase);
157 MS_VIRT HAL_UART_GetIOMapBase(void);
158 MS_BOOL HAL_UART_SetPMRxEnable(MS_BOOL bEnable);
159 UART_DEVICE_TYPE HAL_UART_Get_Connection(UART_PORT_TYPE uart_port);
160 MS_U16 HAL_UART_Connect(UART_PORT_TYPE uart_port, UART_DEVICE_TYPE uart_dev);
161 MS_BOOL HAL_UART_SetPadMux(UART_PAD_TYPE uart_pad);
162 MS_U16 HAL_UART_Invert(UART_PORT_TYPE uart_port, MS_BOOL bInv);
163 int HAL_UART_Aeon_Close(device_t dev);
164 int HAL_UART_Aeon_Write(device_t dev, const char *buf, MS_U32 len, int off);
165 int HAL_UART_Aeon_Read(device_t dev, char *buf, MS_U32 len, int off);
166 int HAL_UART_Aeon_Poll(device_t dev, int types);
167 void HAL_UART_Aeon_Isr(MHAL_SavedRegisters *pHalReg, MS_U32 u32Data);
168 int HAL_UART_Aeon_Ioctl(device_t dev, int request, unsigned long arg);
169 int HAL_UART_Aeon_Open(device_t dev, int mode);
170 
171 
172 int HAL_UART_PIU_Close(device_t dev);
173 int HAL_UART_PIU_Write(device_t dev, const char *buf, MS_U32 len, int off);
174 int HAL_UART_PIU_Read(device_t dev, char *buf, MS_U32 len, int off);
175 int HAL_UART_PIU_Poll(device_t dev, int types);
176 void HAL_FUART_PIU_Isr(MS_U32 *pHalReg, MS_U32 u32Data);
177 void HAL_UART0_PIU_Isr(MS_U32 *pHalReg, MS_U32 u32Data);
178 void HAL_UART1_PIU_Isr(MS_U32 *pHalReg, MS_U32 u32Data);
179 int HAL_UART_PIU_Ioctl(device_t dev, int request, unsigned long arg);
180 int HAL_UART_PIU_Open(device_t dev, int mode);
181 
182 
183 
184 
185 
186 #endif // _HAL_TEMP_H_
187 
188