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