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