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 #ifndef _LINUX_TIMER_H_
81 #define _LINUX_TIMER_H_
82
83 #include <MsTypes.h>
84 #include "drvPorts.h"
85 #include "drvOSAPI.h"
86 #include "drvList.h"
87
88 struct timer_list {
89 struct list_head entry;
90 int expires;
91 int base_jiffies;
92
93 spinlock_t lock;
94 U32 magic;
95
96 void (*function)(U32);
97 U32 data;
98 int tmout_value;
99 int tmout_step;
100 U32 data_ex;
101 };
102
103 #define TIMER_MAGIC 0x4b87ad6e
104
105 /*
106 #define TIMER_INITIALIZER(_function, _expires, _data) { \
107 .function = (_function), \
108 .expires = (_expires), \
109 .data = (_data), \
110 .base = NULL, \
111 .magic = TIMER_MAGIC, \
112 .lock = SPIN_LOCK_UNLOCKED, \
113 }
114 */
115
116 #define TIMER_INITIALIZER(var, _function, _expires, _data) { \
117 var.function = (_function), \
118 var.expires = (_expires), \
119 var.data = (_data), \
120 var.base = NULL, \
121 var.magic = TIMER_MAGIC, \
122 var.lock = SPIN_LOCK_UNLOCKED, \
123 }
124
125 /***
126 * init_timer - initialize a timer.
127 * @timer: the timer to be initialized
128 *
129 * init_timer() must be done to a timer prior calling *any* of the
130 * other timer functions.
131 */
132
init_timer(struct timer_list * timer)133 static __inline__ void init_timer(struct timer_list * timer)
134 {
135 timer->magic = TIMER_MAGIC;
136 timer->tmout_step = 0;
137 timer->tmout_value = 0;
138 INIT_LIST_HEAD(&timer->entry);
139 spin_lock_init(&timer->lock);
140 }
141
142 /***
143 * timer_pending - is a timer pending?
144 * @timer: the timer in question
145 *
146 * timer_pending will tell whether a given timer is currently pending,
147 * or not. Callers must ensure serialization wrt. other operations done
148 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
149 *
150 * return value: 1 if the timer is pending, 0 if not.
151 */
152
153 #define timer_pending(x) ((x)->expires>0)
154 /*
155 * These inlines deal with timer wrapping correctly. You are
156 * strongly encouraged to use them
157 * 1. Because people otherwise forget
158 * 2. Because if the timer wrap changes in future you won't have to
159 * alter your driver code.
160 *
161 * time_after(a,b) returns true if the time a is after time b.
162 *
163 * Do this with "<0" and ">=0" to only test the sign of the result. A
164 * good compiler would generate better code (and a really good compiler
165 * wouldn't care). Gcc is currently neither.
166 */
167 #define time_after(a,b) ( ((int)(b) - (int)(a)) < 0 )
168 #define time_before(a,b) time_after(b,a)
169
170 #define time_after_eq(a,b) ( ((int)(a) - (int)(b)) >= 0 )
171 #define time_before_eq(a,b) time_after_eq(b,a)
172
173
174 extern U32 volatile jiffies;
175
176 extern void add_timer(struct timer_list * timer);
177 extern int del_timer(struct timer_list * timer);
178 extern int del_timer_sync(struct timer_list * timer);
179 extern int mod_timer(struct timer_list *timer, U32 expires, U32 steps);
180 extern void init_timers(void);
181 extern void remove_timers(void);
182
183 #endif
184
185