OSDN Git Service

2dd767e7b1a0067816d4207554c58a56e73cc338
[android-x86/external-kernel-drivers.git] / rtl8723bu / include / osdep_service.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2013 Realtek Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  *
19  ******************************************************************************/
20 #ifndef __OSDEP_SERVICE_H_
21 #define __OSDEP_SERVICE_H_
22
23 #include <linux/signal.h>
24 #include <linux/sched/signal.h>
25
26 #define _FAIL           0
27 #define _SUCCESS        1
28 #define RTW_RX_HANDLED 2
29 //#define RTW_STATUS_TIMEDOUT -110
30
31 #undef _TRUE
32 #define _TRUE           1
33
34 #undef _FALSE
35 #define _FALSE          0
36
37 #include <linux/signal.h>
38 #include <linux/sched/signal.h>
39
40 #ifdef PLATFORM_FREEBSD
41 #include <osdep_service_bsd.h>
42 #endif
43
44 #ifdef PLATFORM_LINUX
45 #include <osdep_service_linux.h>
46 #endif
47
48 #ifdef PLATFORM_OS_XP
49 #include <osdep_service_xp.h>
50 #endif
51
52 #ifdef PLATFORM_OS_CE
53 #include <osdep_service_ce.h>
54 #endif
55
56 #define RTW_TIMER_HDL_NAME(name) rtw_##name##_timer_hdl
57 #define RTW_DECLARE_TIMER_HDL(name) void RTW_TIMER_HDL_NAME(name)(RTW_TIMER_HDL_ARGS)
58
59 //#include <rtw_byteorder.h>
60
61 #ifndef BIT
62         #define BIT(x)  ( 1 << (x))
63 #endif
64
65 #define BIT0    0x00000001
66 #define BIT1    0x00000002
67 #define BIT2    0x00000004
68 #define BIT3    0x00000008
69 #define BIT4    0x00000010
70 #define BIT5    0x00000020
71 #define BIT6    0x00000040
72 #define BIT7    0x00000080
73 #define BIT8    0x00000100
74 #define BIT9    0x00000200
75 #define BIT10   0x00000400
76 #define BIT11   0x00000800
77 #define BIT12   0x00001000
78 #define BIT13   0x00002000
79 #define BIT14   0x00004000
80 #define BIT15   0x00008000
81 #define BIT16   0x00010000
82 #define BIT17   0x00020000
83 #define BIT18   0x00040000
84 #define BIT19   0x00080000
85 #define BIT20   0x00100000
86 #define BIT21   0x00200000
87 #define BIT22   0x00400000
88 #define BIT23   0x00800000
89 #define BIT24   0x01000000
90 #define BIT25   0x02000000
91 #define BIT26   0x04000000
92 #define BIT27   0x08000000
93 #define BIT28   0x10000000
94 #define BIT29   0x20000000
95 #define BIT30   0x40000000
96 #define BIT31   0x80000000
97 #define BIT32   0x0100000000
98 #define BIT33   0x0200000000
99 #define BIT34   0x0400000000
100 #define BIT35   0x0800000000
101 #define BIT36   0x1000000000
102
103 extern int RTW_STATUS_CODE(int error_code);
104
105 #ifndef RTK_DMP_PLATFORM
106 #define CONFIG_USE_VMALLOC
107 #endif
108
109 /* flags used for rtw_mstat_update() */
110 enum mstat_f {
111         /* type: 0x00ff */
112         MSTAT_TYPE_VIR = 0x00,
113         MSTAT_TYPE_PHY= 0x01,
114         MSTAT_TYPE_SKB = 0x02,
115         MSTAT_TYPE_USB = 0x03,
116         MSTAT_TYPE_MAX = 0x04,
117
118         /* func: 0xff00 */
119         MSTAT_FUNC_UNSPECIFIED = 0x00<<8,
120         MSTAT_FUNC_IO = 0x01<<8,
121         MSTAT_FUNC_TX_IO = 0x02<<8,
122         MSTAT_FUNC_RX_IO = 0x03<<8,
123         MSTAT_FUNC_TX = 0x04<<8,
124         MSTAT_FUNC_RX = 0x05<<8,
125         MSTAT_FUNC_CFG_VENDOR = 0x06<<8,
126         MSTAT_FUNC_MAX = 0x07<<8,
127 };
128
129 #define mstat_tf_idx(flags) ((flags)&0xff)
130 #define mstat_ff_idx(flags) (((flags)&0xff00) >> 8)
131
132 typedef enum mstat_status{
133         MSTAT_ALLOC_SUCCESS = 0,
134         MSTAT_ALLOC_FAIL,
135         MSTAT_FREE
136 } MSTAT_STATUS;
137
138 #ifdef DBG_MEM_ALLOC
139 void rtw_mstat_update(const enum mstat_f flags, const MSTAT_STATUS status, u32 sz);
140 void rtw_mstat_dump (void *sel);
141 u8* dbg_rtw_vmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
142 u8* dbg_rtw_zvmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
143 void dbg_rtw_vmfree(u8 *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
144 u8* dbg_rtw_malloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
145 u8* dbg_rtw_zmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
146 void dbg_rtw_mfree(u8 *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
147
148 struct sk_buff * dbg_rtw_skb_alloc(unsigned int size, const enum mstat_f flags, const char *func, const int line);
149 void dbg_rtw_skb_free(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
150 struct sk_buff *dbg_rtw_skb_copy(const struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
151 struct sk_buff *dbg_rtw_skb_clone(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
152 int dbg_rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
153 void dbg_rtw_skb_queue_purge(struct sk_buff_head *list, enum mstat_f flags, const char *func, int line);
154 #ifdef CONFIG_USB_HCI
155 void *dbg_rtw_usb_buffer_alloc(struct usb_device *dev, size_t size, dma_addr_t *dma, const enum mstat_f flags, const char *func, const int line);
156 void dbg_rtw_usb_buffer_free(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma, const enum mstat_f flags, const char *func, const int line);
157 #endif /* CONFIG_USB_HCI */
158
159 #ifdef CONFIG_USE_VMALLOC
160 #define rtw_vmalloc(sz)                 dbg_rtw_vmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
161 #define rtw_zvmalloc(sz)                        dbg_rtw_zvmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
162 #define rtw_vmfree(pbuf, sz)            dbg_rtw_vmfree((pbuf), (sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
163 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_vmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
164 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zvmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
165 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_vmfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
166 #else /* CONFIG_USE_VMALLOC */
167 #define rtw_vmalloc(sz)                 dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
168 #define rtw_zvmalloc(sz)                        dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
169 #define rtw_vmfree(pbuf, sz)            dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
170 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_malloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
171 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
172 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_mfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
173 #endif /* CONFIG_USE_VMALLOC */
174 #define rtw_malloc(sz)                  dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
175 #define rtw_zmalloc(sz)                 dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
176 #define rtw_mfree(pbuf, sz)             dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
177 #define rtw_malloc_f(sz, mstat_f)                       dbg_rtw_malloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
178 #define rtw_zmalloc_f(sz, mstat_f)                      dbg_rtw_zmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
179 #define rtw_mfree_f(pbuf, sz, mstat_f)          dbg_rtw_mfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
180
181 #define rtw_skb_alloc(size)     dbg_rtw_skb_alloc((size), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
182 #define rtw_skb_free(skb)       dbg_rtw_skb_free((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
183 #define rtw_skb_alloc_f(size, mstat_f)  dbg_rtw_skb_alloc((size), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
184 #define rtw_skb_free_f(skb, mstat_f)    dbg_rtw_skb_free((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
185 #define rtw_skb_copy(skb)       dbg_rtw_skb_copy((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
186 #define rtw_skb_clone(skb)      dbg_rtw_skb_clone((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
187 #define rtw_skb_copy_f(skb, mstat_f)    dbg_rtw_skb_copy((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
188 #define rtw_skb_clone_f(skb, mstat_f)   dbg_rtw_skb_clone((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
189 #define rtw_netif_rx(ndev, skb) dbg_rtw_netif_rx(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
190 #define rtw_skb_queue_purge(sk_buff_head) dbg_rtw_skb_queue_purge(sk_buff_head, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
191 #ifdef CONFIG_USB_HCI
192 #define rtw_usb_buffer_alloc(dev, size, dma)            dbg_rtw_usb_buffer_alloc((dev), (size), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
193 #define rtw_usb_buffer_free(dev, size, addr, dma)       dbg_rtw_usb_buffer_free((dev), (size), (addr), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
194 #define rtw_usb_buffer_alloc_f(dev, size, dma, mstat_f)                 dbg_rtw_usb_buffer_alloc((dev), (size), (dma), ((mstat_f)&0xff00)|MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
195 #define rtw_usb_buffer_free_f(dev, size, addr, dma, mstat_f)    dbg_rtw_usb_buffer_free((dev), (size), (addr), (dma), ((mstat_f)&0xff00)|MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
196 #endif /* CONFIG_USB_HCI */
197
198 #else /* DBG_MEM_ALLOC */
199 #define rtw_mstat_update(flag, status, sz) do {} while(0)
200 #define rtw_mstat_dump(sel) do {} while(0)
201 u8*     _rtw_vmalloc(u32 sz);
202 u8*     _rtw_zvmalloc(u32 sz);
203 void    _rtw_vmfree(u8 *pbuf, u32 sz);
204 u8*     _rtw_zmalloc(u32 sz);
205 u8*     _rtw_malloc(u32 sz);
206 void    _rtw_mfree(u8 *pbuf, u32 sz);
207
208 struct sk_buff *_rtw_skb_alloc(u32 sz);
209 void _rtw_skb_free(struct sk_buff *skb);
210 struct sk_buff *_rtw_skb_copy(const struct sk_buff *skb);
211 struct sk_buff *_rtw_skb_clone(struct sk_buff *skb);
212 int _rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb);
213 void _rtw_skb_queue_purge(struct sk_buff_head *list);
214
215 #ifdef CONFIG_USB_HCI
216 void *_rtw_usb_buffer_alloc(struct usb_device *dev, size_t size, dma_addr_t *dma);
217 void _rtw_usb_buffer_free(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma);
218 #endif /* CONFIG_USB_HCI */
219
220 #ifdef CONFIG_USE_VMALLOC
221 #define rtw_vmalloc(sz)                 _rtw_vmalloc((sz))
222 #define rtw_zvmalloc(sz)                        _rtw_zvmalloc((sz))
223 #define rtw_vmfree(pbuf, sz)            _rtw_vmfree((pbuf), (sz))
224 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_vmalloc((sz))
225 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zvmalloc((sz))
226 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_vmfree((pbuf), (sz))
227 #else /* CONFIG_USE_VMALLOC */
228 #define rtw_vmalloc(sz)                 _rtw_malloc((sz))
229 #define rtw_zvmalloc(sz)                        _rtw_zmalloc((sz))
230 #define rtw_vmfree(pbuf, sz)            _rtw_mfree((pbuf), (sz))
231 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_malloc((sz))
232 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zmalloc((sz))
233 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_mfree((pbuf), (sz))
234 #endif /* CONFIG_USE_VMALLOC */
235 #define rtw_malloc(sz)                  _rtw_malloc((sz))
236 #define rtw_zmalloc(sz)                 _rtw_zmalloc((sz))
237 #define rtw_mfree(pbuf, sz)             _rtw_mfree((pbuf), (sz))
238 #define rtw_malloc_f(sz, mstat_f)                       _rtw_malloc((sz))
239 #define rtw_zmalloc_f(sz, mstat_f)                      _rtw_zmalloc((sz))
240 #define rtw_mfree_f(pbuf, sz, mstat_f)          _rtw_mfree((pbuf), (sz))
241
242 #define rtw_skb_alloc(size) _rtw_skb_alloc((size))
243 #define rtw_skb_free(skb) _rtw_skb_free((skb))
244 #define rtw_skb_alloc_f(size, mstat_f)  _rtw_skb_alloc((size))
245 #define rtw_skb_free_f(skb, mstat_f)    _rtw_skb_free((skb))
246 #define rtw_skb_copy(skb)       _rtw_skb_copy((skb))
247 #define rtw_skb_clone(skb)      _rtw_skb_clone((skb))
248 #define rtw_skb_copy_f(skb, mstat_f)    _rtw_skb_copy((skb))
249 #define rtw_skb_clone_f(skb, mstat_f)   _rtw_skb_clone((skb))
250 #define rtw_netif_rx(ndev, skb) _rtw_netif_rx(ndev, skb)
251 #define rtw_skb_queue_purge(sk_buff_head) _rtw_skb_queue_purge(sk_buff_head)
252 #ifdef CONFIG_USB_HCI
253 #define rtw_usb_buffer_alloc(dev, size, dma) _rtw_usb_buffer_alloc((dev), (size), (dma))
254 #define rtw_usb_buffer_free(dev, size, addr, dma) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
255 #define rtw_usb_buffer_alloc_f(dev, size, dma, mstat_f) _rtw_usb_buffer_alloc((dev), (size), (dma))
256 #define rtw_usb_buffer_free_f(dev, size, addr, dma, mstat_f) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
257 #endif /* CONFIG_USB_HCI */
258 #endif /* DBG_MEM_ALLOC */
259
260 extern void*    rtw_malloc2d(int h, int w, size_t size);
261 extern void     rtw_mfree2d(void *pbuf, int h, int w, int size);
262
263 extern void     _rtw_memcpy(void *dec, const void *sour, u32 sz);
264 extern void _rtw_memmove(void *dst, const void *src, u32 sz);
265 extern int      _rtw_memcmp(void *dst, const void *src, u32 sz);
266 extern void     _rtw_memset(void *pbuf, int c, u32 sz);
267
268 extern void     _rtw_init_listhead(_list *list);
269 extern u32      rtw_is_list_empty(_list *phead);
270 extern void     rtw_list_insert_head(_list *plist, _list *phead);
271 extern void     rtw_list_insert_tail(_list *plist, _list *phead);
272 #ifndef PLATFORM_FREEBSD
273 extern void     rtw_list_delete(_list *plist);
274 #endif //PLATFORM_FREEBSD
275
276 extern void     _rtw_init_sema(_sema *sema, int init_val);
277 extern void     _rtw_free_sema(_sema    *sema);
278 extern void     _rtw_up_sema(_sema      *sema);
279 extern u32      _rtw_down_sema(_sema *sema);
280 extern void     _rtw_mutex_init(_mutex *pmutex);
281 extern void     _rtw_mutex_free(_mutex *pmutex);
282 #ifndef PLATFORM_FREEBSD
283 extern void     _rtw_spinlock_init(_lock *plock);
284 #endif //PLATFORM_FREEBSD
285 extern void     _rtw_spinlock_free(_lock *plock);
286 extern void     _rtw_spinlock(_lock     *plock);
287 extern void     _rtw_spinunlock(_lock   *plock);
288 extern void     _rtw_spinlock_ex(_lock  *plock);
289 extern void     _rtw_spinunlock_ex(_lock        *plock);
290
291 extern void     _rtw_init_queue(_queue *pqueue);
292 extern void _rtw_deinit_queue(_queue *pqueue);
293 extern u32      _rtw_queue_empty(_queue *pqueue);
294 extern u32      rtw_end_of_queue_search(_list *queue, _list *pelement);
295
296 extern u32      rtw_get_current_time(void);
297 extern u32      rtw_systime_to_ms(u32 systime);
298 extern u32      rtw_ms_to_systime(u32 ms);
299 extern s32      rtw_get_passing_time_ms(u32 start);
300 extern s32      rtw_get_time_interval_ms(u32 start, u32 end);
301
302 extern void     rtw_sleep_schedulable(int ms);
303
304 extern void     rtw_msleep_os(int ms);
305 extern void     rtw_usleep_os(int us);
306
307 extern u32      rtw_atoi(u8* s);
308
309 #ifdef DBG_DELAY_OS
310 #define rtw_mdelay_os(ms) _rtw_mdelay_os((ms), __FUNCTION__, __LINE__)
311 #define rtw_udelay_os(ms) _rtw_udelay_os((ms), __FUNCTION__, __LINE__)
312 extern void _rtw_mdelay_os(int ms, const char *func, const int line);
313 extern void _rtw_udelay_os(int us, const char *func, const int line);
314 #else
315 extern void     rtw_mdelay_os(int ms);
316 extern void     rtw_udelay_os(int us);
317 #endif
318
319 extern void rtw_yield_os(void);
320
321
322 extern void rtw_init_timer(_timer *ptimer, void *padapter, void *pfunc);
323
324
325 __inline static unsigned char _cancel_timer_ex(_timer *ptimer)
326 {
327 #ifdef PLATFORM_LINUX
328 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 15, 0))
329         return del_timer_sync(&ptimer->t);
330 #else
331         return del_timer_sync(ptimer);
332 #endif
333 #endif
334 #ifdef PLATFORM_FREEBSD
335         _cancel_timer(ptimer,0);
336         return 0;
337 #endif
338 #ifdef PLATFORM_WINDOWS
339         u8 bcancelled;
340
341         _cancel_timer(ptimer, &bcancelled);
342
343         return bcancelled;
344 #endif
345 }
346
347 static __inline void thread_enter(char *name)
348 {
349 #ifdef PLATFORM_LINUX
350         #if (LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0))
351         daemonize("%s", name);
352         #endif
353         allow_signal(SIGTERM);
354 #endif
355 #ifdef PLATFORM_FREEBSD
356         printf("%s", "RTKTHREAD_enter");
357 #endif
358 }
359
360 __inline static void flush_signals_thread(void)
361 {
362 #ifdef PLATFORM_LINUX
363         if (signal_pending (current))
364         {
365                 flush_signals(current);
366         }
367 #endif
368 }
369
370 __inline static _OS_STATUS res_to_status(sint res)
371 {
372
373 #if defined (PLATFORM_LINUX) || defined (PLATFORM_MPIXEL) || defined (PLATFORM_FREEBSD)
374         return res;
375 #endif
376
377 #ifdef PLATFORM_WINDOWS
378
379         if (res == _SUCCESS)
380                 return NDIS_STATUS_SUCCESS;
381         else
382                 return NDIS_STATUS_FAILURE;
383
384 #endif
385
386 }
387
388 __inline static void rtw_dump_stack(void)
389 {
390 #ifdef PLATFORM_LINUX
391         dump_stack();
392 #endif
393 }
394
395 #ifdef PLATFORM_LINUX
396 #define rtw_warn_on(condition) WARN_ON(condition)
397 #else
398 #define rtw_warn_on(condition) do {} while (0)
399 #endif
400
401 __inline static int rtw_bug_check(void *parg1, void *parg2, void *parg3, void *parg4)
402 {
403         int ret = _TRUE;
404
405 #ifdef PLATFORM_WINDOWS
406         if ( ((uint)parg1) <= 0x7fffffff ||
407                 ((uint)parg2) <= 0x7fffffff ||
408                 ((uint)parg3) <= 0x7fffffff ||
409                 ((uint)parg4) <= 0x7fffffff)
410         {
411                 ret = _FALSE;
412                 KeBugCheckEx(0x87110000, (ULONG_PTR)parg1, (ULONG_PTR)parg2, (ULONG_PTR)parg3, (ULONG_PTR)parg4);
413         }
414 #endif
415
416         return ret;
417
418 }
419
420 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
421 #define RND4(x) (((x >> 2) + (((x & 3) == 0) ?  0: 1)) << 2)
422
423 __inline static u32 _RND4(u32 sz)
424 {
425
426         u32     val;
427
428         val = ((sz >> 2) + ((sz & 3) ? 1: 0)) << 2;
429
430         return val;
431
432 }
433
434 __inline static u32 _RND8(u32 sz)
435 {
436
437         u32     val;
438
439         val = ((sz >> 3) + ((sz & 7) ? 1: 0)) << 3;
440
441         return val;
442
443 }
444
445 __inline static u32 _RND128(u32 sz)
446 {
447
448         u32     val;
449
450         val = ((sz >> 7) + ((sz & 127) ? 1: 0)) << 7;
451
452         return val;
453
454 }
455
456 __inline static u32 _RND256(u32 sz)
457 {
458
459         u32     val;
460
461         val = ((sz >> 8) + ((sz & 255) ? 1: 0)) << 8;
462
463         return val;
464
465 }
466
467 __inline static u32 _RND512(u32 sz)
468 {
469
470         u32     val;
471
472         val = ((sz >> 9) + ((sz & 511) ? 1: 0)) << 9;
473
474         return val;
475
476 }
477
478 __inline static u32 bitshift(u32 bitmask)
479 {
480         u32 i;
481
482         for (i = 0; i <= 31; i++)
483                 if (((bitmask>>i) &  0x1) == 1) break;
484
485         return i;
486 }
487
488 #define rtw_min(a, b) ((a>b)?b:a)
489 #define rtw_is_range_a_in_b(hi_a, lo_a, hi_b, lo_b) (((hi_a) <= (hi_b)) && ((lo_a) >= (lo_b)))
490 #define rtw_is_range_overlap(hi_a, lo_a, hi_b, lo_b) (((hi_a) > (lo_b)) && ((lo_a) < (hi_b)))
491
492 #ifndef MAC_FMT
493 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
494 #endif
495 #ifndef MAC_ARG
496 #define MAC_ARG(x) ((u8*)(x))[0],((u8*)(x))[1],((u8*)(x))[2],((u8*)(x))[3],((u8*)(x))[4],((u8*)(x))[5]
497 #endif
498
499
500 extern void rtw_suspend_lock_init(void);
501 extern void rtw_suspend_lock_uninit(void);
502 extern void rtw_lock_suspend(void);
503 extern void rtw_unlock_suspend(void);
504 extern void rtw_lock_suspend_timeout(u32 timeout_ms);
505 extern void rtw_lock_ext_suspend_timeout(u32 timeout_ms);
506 extern void rtw_lock_rx_suspend_timeout(u32 timeout_ms);
507 extern void rtw_lock_traffic_suspend_timeout(u32 timeout_ms);
508 extern void rtw_lock_resume_scan_timeout(u32 timeout_ms);
509 extern void rtw_resume_lock_suspend(void);
510 extern void rtw_resume_unlock_suspend(void);
511 #ifdef CONFIG_AP_WOWLAN
512 extern void rtw_softap_lock_suspend(void);
513 extern void rtw_softap_unlock_suspend(void);
514 #endif
515
516 extern void ATOMIC_SET(ATOMIC_T *v, int i);
517 extern int ATOMIC_READ(ATOMIC_T *v);
518 extern void ATOMIC_ADD(ATOMIC_T *v, int i);
519 extern void ATOMIC_SUB(ATOMIC_T *v, int i);
520 extern void ATOMIC_INC(ATOMIC_T *v);
521 extern void ATOMIC_DEC(ATOMIC_T *v);
522 extern int ATOMIC_ADD_RETURN(ATOMIC_T *v, int i);
523 extern int ATOMIC_SUB_RETURN(ATOMIC_T *v, int i);
524 extern int ATOMIC_INC_RETURN(ATOMIC_T *v);
525 extern int ATOMIC_DEC_RETURN(ATOMIC_T *v);
526
527 #ifndef PLATFORM_FREEBSD
528 extern void rtw_free_netdev(struct net_device * netdev);
529 #endif //PLATFORM_FREEBSD
530
531
532 extern u64 rtw_modular64(u64 x, u64 y);
533 extern u64 rtw_division64(u64 x, u64 y);
534 extern u32 rtw_random32(void);
535
536 /* Macros for handling unaligned memory accesses */
537
538 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
539 #define RTW_PUT_BE16(a, val)                    \
540         do {                                    \
541                 (a)[0] = ((u16) (val)) >> 8;    \
542                 (a)[1] = ((u16) (val)) & 0xff;  \
543         } while (0)
544
545 #define RTW_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0]))
546 #define RTW_PUT_LE16(a, val)                    \
547         do {                                    \
548                 (a)[1] = ((u16) (val)) >> 8;    \
549                 (a)[0] = ((u16) (val)) & 0xff;  \
550         } while (0)
551
552 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
553                          ((u32) (a)[2]))
554 #define RTW_PUT_BE24(a, val)                                    \
555         do {                                                    \
556                 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
557                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
558                 (a)[2] = (u8) (((u32) (val)) & 0xff);           \
559         } while (0)
560
561 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
562                          (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
563 #define RTW_PUT_BE32(a, val)                                    \
564         do {                                                    \
565                 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
566                 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
567                 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
568                 (a)[3] = (u8) (((u32) (val)) & 0xff);           \
569         } while (0)
570
571 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
572                          (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
573 #define RTW_PUT_LE32(a, val)                                    \
574         do {                                                    \
575                 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
576                 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
577                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
578                 (a)[0] = (u8) (((u32) (val)) & 0xff);           \
579         } while (0)
580
581 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
582                          (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
583                          (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
584                          (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
585 #define RTW_PUT_BE64(a, val)                            \
586         do {                                            \
587                 (a)[0] = (u8) (((u64) (val)) >> 56);    \
588                 (a)[1] = (u8) (((u64) (val)) >> 48);    \
589                 (a)[2] = (u8) (((u64) (val)) >> 40);    \
590                 (a)[3] = (u8) (((u64) (val)) >> 32);    \
591                 (a)[4] = (u8) (((u64) (val)) >> 24);    \
592                 (a)[5] = (u8) (((u64) (val)) >> 16);    \
593                 (a)[6] = (u8) (((u64) (val)) >> 8);     \
594                 (a)[7] = (u8) (((u64) (val)) & 0xff);   \
595         } while (0)
596
597 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
598                          (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
599                          (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
600                          (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
601
602 void rtw_buf_free(u8 **buf, u32 *buf_len);
603 void rtw_buf_update(u8 **buf, u32 *buf_len, u8 *src, u32 src_len);
604
605 struct rtw_cbuf {
606         u32 write;
607         u32 read;
608         u32 size;
609         void *bufs[0];
610 };
611
612 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
613 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
614 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
615 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
616 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
617 void rtw_cbuf_free(struct rtw_cbuf *cbuf);
618
619 // String handler
620
621 BOOLEAN IsHexDigit(char chTmp);
622 BOOLEAN is_alpha(char chTmp);
623 char alpha_to_upper(char c);
624
625 /*
626  * Write formatted output to sized buffer
627  */
628 #ifdef PLATFORM_LINUX
629 #define rtw_sprintf(buf, size, format, arg...)  snprintf(buf, size, format, ##arg)
630 #else // !PLATFORM_LINUX
631 #error "NOT DEFINE \"rtw_sprintf\"!!"
632 #endif // !PLATFORM_LINUX
633
634 #endif