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