xref: /utopia/UTPA2-700.0.x/modules/msos/msos/linux/mdrv_semutex_io.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 // PUT THIS FILE under INLCUDE path
96 
97 ///////////////////////////////////////////////////////////////////////////////////////////////////
98 ///
99 /// @file   mdrv_temp_io.h
100 /// @brief  TEMP Driver Interface.
101 /// @author MStar Semiconductor Inc.
102 ///
103 ///////////////////////////////////////////////////////////////////////////////////////////////////
104 
105 #ifndef _MDRV_SEMUTEX_IO_H_
106 #define _MDRV_SEMUTEX_IO_H_
107 
108 //-------------------------------------------------------------------------------------------------
109 //  Driver Capability
110 //-------------------------------------------------------------------------------------------------
111 
112 //-------------------------------------------------------------------------------------------------
113 //  Macro and Define
114 //-------------------------------------------------------------------------------------------------
115 
116 #define SEMUTEX_IOC_MAGIC               'S'
117 #define MUTEX_INDEX_BEGIN               0xFF
118 #ifdef CONFIG_KERN_3_10_40
119 #define SEMAPHORE_INDEX_BEGIN           0x3FF
120 #else
121 #define SEMAPHORE_INDEX_BEGIN           0x55660000
122 #endif
123 
124 /* IOCTL functions. */
125 /* int ioctl(int fd,
126              int request == MDRV_SEMUTEX_LOCK);
127 */
128 #define MDRV_SEMUTEX_LOCK                (int)_IO(SEMUTEX_IOC_MAGIC, 0U)
129 
130 /* int ioctl(int fd,
131              int request == MDRV_SC_DETACH_INTERRUPT);
132 */
133 #define MDRV_SEMUTEX_UNLOCK                (int)_IO(SEMUTEX_IOC_MAGIC, 1U)
134 
135 /* int ioctl(int fd,
136              int request == MDRV_SC_RESET_FIFO);
137 */
138 #define MDRV_SEMUTEX_CREATE_SHAREMEMORY                      (int)_IO(SEMUTEX_IOC_MAGIC, 2U)
139 
140 /* int ioctl(int fd,
141              int request == MDRV_SC_GET_EVENTS,
142              int *events);
143 */
144 #define MDRV_SEMUTEX_MAP_SHAREMEMORY                      (int)_IOR(SEMUTEX_IOC_MAGIC, 3U, int)
145 
146 #define MDRV_SEMUTEX_UNMAP_SHAREMEMORY                      (int)_IOR(SEMUTEX_IOC_MAGIC, 4U, int)
147 
148 #define MDRV_SEMUTEX_CREATE_MUTEX                      (int)_IOR(SEMUTEX_IOC_MAGIC, 5U, int)
149 
150 #define MDRV_SEMUTEX_DEL_MUTEX                      (int)_IOR(SEMUTEX_IOC_MAGIC, 6U, int)
151 
152 #define MDRV_SEMUTEX_TRY_LOCK                       (int)_IOR(SEMUTEX_IOC_MAGIC, 7U, int)
153 
154 #define MDRV_SEMUTEX_QUERY_ISFIRST_SHAREMEMORY                      (int)_IO(SEMUTEX_IOC_MAGIC, 8U)
155 
156 #define MDRV_SEMUTEX_LOCK_WITHTIMEOUT                      (int)_IOR(SEMUTEX_IOC_MAGIC, 9U, int)
157 
158 #define MDRV_SEMUTEX_EXPAND_SHAREMEMORY                      (int)_IOR(SEMUTEX_IOC_MAGIC, 10U, int)
159 
160 #define MDRV_SEMUTEX_GET_SHMSIZE		            (int)_IOR(SEMUTEX_IOC_MAGIC, 11U, unsigned int)
161 
162 #define MDRV_SEMUTEX_CREATE_SEMAPHORE               (int)_IOR(SEMUTEX_IOC_MAGIC, 12U, int)
163 
164 #define MDRV_SEMUTEX_SEMA_LOCK                      (int)_IOR(SEMUTEX_IOC_MAGIC, 13U, int)
165 
166 #define MDRV_SEMUTEX_SEMA_TRY_LOCK                  (int)_IOR(SEMUTEX_IOC_MAGIC, 14U, int)
167 
168 #define MDRV_SEMUTEX_SEMA_UNLOCK                    (int)_IOR(SEMUTEX_IOC_MAGIC, 15U, int)
169 
170 #define MDRV_SEMUTEX_SEMA_RESET                     (int)_IOR(SEMUTEX_IOC_MAGIC, 16U, int)
171 
172 #define MDRV_SEMUTEX_SET_CROSS_THREAD_UNLOCK        (int)_IOR(SEMUTEX_IOC_MAGIC, 17U, CROSS_THREAD_UNLOCK_INFO)
173 
174 #define SEMA_NAME_LEN   64
175 
176 typedef struct{
177 int index;
178 int time;
179 }LOCKARG;
180 
181 typedef struct{
182     unsigned int    semanum;
183     char            semaname[SEMA_NAME_LEN];
184 }CREATE_SEMA_ARG;
185 
186 typedef enum
187 {
188     E_CROSS_THREAD_UNLOCK_ENABLE = 0,
189     E_CROSS_THREAD_UNLOCK_DISABLE,
190 }CROSS_THREAD_UNLOCK_FLAG;
191 
192 typedef struct{
193     int index;
194     CROSS_THREAD_UNLOCK_FLAG flag;
195 }CROSS_THREAD_UNLOCK_INFO;
196 
197 //-------------------------------------------------------------------------------------------------
198 //  Type and Structure
199 //-------------------------------------------------------------------------------------------------
200 
201 //-------------------------------------------------------------------------------------------------
202 //  Function and Variable
203 //-------------------------------------------------------------------------------------------------
204 
205 //MS_S32 MsOS_CreateNamedSemaphore(char *ps8SemaName, MS_U32 u32SemaNum);
206 
207 MS_BOOL MsOS_ResetNamedSemaphore(MS_S32 u32Index);
208 
209 //MS_BOOL MsOS_ObtainNamedSemaphore(MS_S32 u32Index, MS_S32 flag);
210 
211 //MS_BOOL MsOS_ReleaseNamedSemaphore(MS_S32 u32Index, MS_S32 flag);
212 
213 #endif // SEMUTEX
214 
215