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