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