1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3 *
4 * Copyright(c) 2007 - 2017 Realtek Corporation.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 *****************************************************************************/
16 #ifndef __OSDEP_SERVICE_H_
17 #define __OSDEP_SERVICE_H_
18
19
20 #define _FAIL 0
21 #define _SUCCESS 1
22 #define RTW_RX_HANDLED 2
23 #define RTW_RFRAME_UNAVAIL 3
24 #define RTW_RFRAME_PKT_UNAVAIL 4
25 #define RTW_RBUF_UNAVAIL 5
26 #define RTW_RBUF_PKT_UNAVAIL 6
27 #define RTW_SDIO_READ_PORT_FAIL 7
28 #define RTW_ALREADY 8
29 #define RTW_RA_RESOLVING 9
30 #define RTW_BMC_NO_NEED 10
31 #define RTW_XBUF_UNAVAIL 11
32 #define RTW_TX_BALANCE 12
33 #define RTW_TX_WAIT_MORE_FRAME 13
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 extern void rtw_sleep_schedulable(int ms);
389
390 extern void rtw_msleep_os(int ms);
391 extern void rtw_usleep_os(int us);
392
393 extern u32 rtw_atoi(u8 *s);
394
395 #ifdef DBG_DELAY_OS
396 #define rtw_mdelay_os(ms) _rtw_mdelay_os((ms), __FUNCTION__, __LINE__)
397 #define rtw_udelay_os(ms) _rtw_udelay_os((ms), __FUNCTION__, __LINE__)
398 extern void _rtw_mdelay_os(int ms, const char *func, const int line);
399 extern void _rtw_udelay_os(int us, const char *func, const int line);
400 #else
401 extern void rtw_mdelay_os(int ms);
402 extern void rtw_udelay_os(int us);
403 #endif
404
405 extern void rtw_yield_os(void);
406
407
408 extern void rtw_init_timer(_timer *ptimer, void *padapter, void *pfunc, void *ctx);
409
410
_cancel_timer_ex(_timer * ptimer)411 __inline static unsigned char _cancel_timer_ex(_timer *ptimer)
412 {
413 u8 bcancelled;
414
415 _cancel_timer(ptimer, &bcancelled);
416
417 return bcancelled;
418 }
419
thread_enter(char * name)420 static __inline void thread_enter(char *name)
421 {
422 #ifdef PLATFORM_LINUX
423 allow_signal(SIGTERM);
424 #endif
425 #ifdef PLATFORM_FREEBSD
426 printf("%s", "RTKTHREAD_enter");
427 #endif
428 }
429 void thread_exit(_completion *comp);
430 void _rtw_init_completion(_completion *comp);
431 void _rtw_wait_for_comp_timeout(_completion *comp);
432 void _rtw_wait_for_comp(_completion *comp);
433
rtw_thread_stop(_thread_hdl_ th)434 static inline bool rtw_thread_stop(_thread_hdl_ th)
435 {
436 #ifdef PLATFORM_LINUX
437 return kthread_stop(th);
438 #endif
439 }
rtw_thread_wait_stop(void)440 static inline void rtw_thread_wait_stop(void)
441 {
442 #ifdef PLATFORM_LINUX
443 #if 0
444 while (!kthread_should_stop())
445 rtw_msleep_os(10);
446 #else
447 set_current_state(TASK_INTERRUPTIBLE);
448 while (!kthread_should_stop()) {
449 schedule();
450 set_current_state(TASK_INTERRUPTIBLE);
451 }
452 __set_current_state(TASK_RUNNING);
453 #endif
454 #endif
455 }
456
flush_signals_thread(void)457 __inline static void flush_signals_thread(void)
458 {
459 #ifdef PLATFORM_LINUX
460 if (signal_pending(current))
461 flush_signals(current);
462 #endif
463 }
464
res_to_status(sint res)465 __inline static _OS_STATUS res_to_status(sint res)
466 {
467
468 #if defined(PLATFORM_LINUX) || defined (PLATFORM_MPIXEL) || defined (PLATFORM_FREEBSD)
469 return res;
470 #endif
471
472 #ifdef PLATFORM_WINDOWS
473
474 if (res == _SUCCESS)
475 return NDIS_STATUS_SUCCESS;
476 else
477 return NDIS_STATUS_FAILURE;
478
479 #endif
480
481 }
482
rtw_dump_stack(void)483 __inline static void rtw_dump_stack(void)
484 {
485 #ifdef PLATFORM_LINUX
486 dump_stack();
487 #endif
488 }
489
490 #ifdef PLATFORM_LINUX
491 #define rtw_warn_on(condition) WARN_ON(condition)
492 #else
493 #define rtw_warn_on(condition) do {} while (0)
494 #endif
495
rtw_bug_check(void * parg1,void * parg2,void * parg3,void * parg4)496 __inline static int rtw_bug_check(void *parg1, void *parg2, void *parg3, void *parg4)
497 {
498 int ret = _TRUE;
499
500 #ifdef PLATFORM_WINDOWS
501 if (((uint)parg1) <= 0x7fffffff ||
502 ((uint)parg2) <= 0x7fffffff ||
503 ((uint)parg3) <= 0x7fffffff ||
504 ((uint)parg4) <= 0x7fffffff) {
505 ret = _FALSE;
506 KeBugCheckEx(0x87110000, (ULONG_PTR)parg1, (ULONG_PTR)parg2, (ULONG_PTR)parg3, (ULONG_PTR)parg4);
507 }
508 #endif
509
510 return ret;
511
512 }
513 #ifdef PLATFORM_LINUX
514 #define RTW_DIV_ROUND_UP(n, d) DIV_ROUND_UP(n, d)
515 #else /* !PLATFORM_LINUX */
516 #define RTW_DIV_ROUND_UP(n, d) (((n) + (d - 1)) / d)
517 #endif /* !PLATFORM_LINUX */
518
519 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
520 #define RND4(x) (((x >> 2) + (((x & 3) == 0) ? 0 : 1)) << 2)
521
_RND4(u32 sz)522 __inline static u32 _RND4(u32 sz)
523 {
524
525 u32 val;
526
527 val = ((sz >> 2) + ((sz & 3) ? 1 : 0)) << 2;
528
529 return val;
530
531 }
532
_RND8(u32 sz)533 __inline static u32 _RND8(u32 sz)
534 {
535
536 u32 val;
537
538 val = ((sz >> 3) + ((sz & 7) ? 1 : 0)) << 3;
539
540 return val;
541
542 }
543
_RND128(u32 sz)544 __inline static u32 _RND128(u32 sz)
545 {
546
547 u32 val;
548
549 val = ((sz >> 7) + ((sz & 127) ? 1 : 0)) << 7;
550
551 return val;
552
553 }
554
_RND256(u32 sz)555 __inline static u32 _RND256(u32 sz)
556 {
557
558 u32 val;
559
560 val = ((sz >> 8) + ((sz & 255) ? 1 : 0)) << 8;
561
562 return val;
563
564 }
565
_RND512(u32 sz)566 __inline static u32 _RND512(u32 sz)
567 {
568
569 u32 val;
570
571 val = ((sz >> 9) + ((sz & 511) ? 1 : 0)) << 9;
572
573 return val;
574
575 }
576
bitshift(u32 bitmask)577 __inline static u32 bitshift(u32 bitmask)
578 {
579 u32 i;
580
581 for (i = 0; i <= 31; i++)
582 if (((bitmask >> i) & 0x1) == 1)
583 break;
584
585 return i;
586 }
587
largest_bit(u32 bitmask)588 static inline int largest_bit(u32 bitmask)
589 {
590 int i;
591
592 for (i = 31; i >= 0; i--)
593 if (bitmask & BIT(i))
594 break;
595
596 return i;
597 }
598
largest_bit_64(u64 bitmask)599 static inline int largest_bit_64(u64 bitmask)
600 {
601 int i;
602
603 for (i = 63; i >= 0; i--)
604 if (bitmask & BIT_ULL(i))
605 break;
606
607 return i;
608 }
609
610 #define rtw_abs(a) (a < 0 ? -a : a)
611 #define rtw_min(a, b) ((a > b) ? b : a)
612 #define rtw_max(a, b) ((a > b) ? a : b)
613 #define rtw_is_range_a_in_b(hi_a, lo_a, hi_b, lo_b) (((hi_a) <= (hi_b)) && ((lo_a) >= (lo_b)))
614 #define rtw_is_range_overlap(hi_a, lo_a, hi_b, lo_b) (((hi_a) > (lo_b)) && ((lo_a) < (hi_b)))
615
616 #ifndef MAC_FMT
617 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
618 #endif
619 #ifndef MAC_ARG
620 #define MAC_ARG(x) ((u8 *)(x))[0], ((u8 *)(x))[1], ((u8 *)(x))[2], ((u8 *)(x))[3], ((u8 *)(x))[4], ((u8 *)(x))[5]
621 #endif
622
623 bool rtw_macaddr_is_larger(const u8 *a, const u8 *b);
624
625 extern void rtw_suspend_lock_init(void);
626 extern void rtw_suspend_lock_uninit(void);
627 extern void rtw_lock_suspend(void);
628 extern void rtw_unlock_suspend(void);
629 extern void rtw_lock_suspend_timeout(u32 timeout_ms);
630 extern void rtw_lock_traffic_suspend_timeout(u32 timeout_ms);
631 extern void rtw_resume_lock_suspend(void);
632 extern void rtw_resume_unlock_suspend(void);
633 #ifdef CONFIG_AP_WOWLAN
634 extern void rtw_softap_lock_suspend(void);
635 extern void rtw_softap_unlock_suspend(void);
636 #endif
637
638 extern void rtw_set_bit(int nr, unsigned long *addr);
639 extern void rtw_clear_bit(int nr, unsigned long *addr);
640 extern int rtw_test_and_clear_bit(int nr, unsigned long *addr);
641
642 extern void ATOMIC_SET(ATOMIC_T *v, int i);
643 extern int ATOMIC_READ(ATOMIC_T *v);
644 extern void ATOMIC_ADD(ATOMIC_T *v, int i);
645 extern void ATOMIC_SUB(ATOMIC_T *v, int i);
646 extern void ATOMIC_INC(ATOMIC_T *v);
647 extern void ATOMIC_DEC(ATOMIC_T *v);
648 extern int ATOMIC_ADD_RETURN(ATOMIC_T *v, int i);
649 extern int ATOMIC_SUB_RETURN(ATOMIC_T *v, int i);
650 extern int ATOMIC_INC_RETURN(ATOMIC_T *v);
651 extern int ATOMIC_DEC_RETURN(ATOMIC_T *v);
652 extern bool ATOMIC_INC_UNLESS(ATOMIC_T *v, int u);
653
654 /* File operation APIs, just for linux now */
655 extern int rtw_is_dir_readable(const char *path);
656 extern int rtw_is_file_readable(const char *path);
657 extern int rtw_is_file_readable_with_size(const char *path, u32 *sz);
658 extern int rtw_readable_file_sz_chk(const char *path, u32 sz);
659 extern int rtw_retrieve_from_file(const char *path, u8 *buf, u32 sz);
660 extern int rtw_store_to_file(const char *path, u8 *buf, u32 sz);
661
662
663 #ifndef PLATFORM_FREEBSD
664 extern void rtw_free_netdev(struct net_device *netdev);
665 #endif /* PLATFORM_FREEBSD */
666
667
668 extern u64 rtw_modular64(u64 x, u64 y);
669 extern u64 rtw_division64(u64 x, u64 y);
670 extern u32 rtw_random32(void);
671
672 /* Macros for handling unaligned memory accesses */
673
674 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
675 #define RTW_PUT_BE16(a, val) \
676 do { \
677 (a)[0] = ((u16) (val)) >> 8; \
678 (a)[1] = ((u16) (val)) & 0xff; \
679 } while (0)
680
681 #define RTW_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0]))
682 #define RTW_PUT_LE16(a, val) \
683 do { \
684 (a)[1] = ((u16) (val)) >> 8; \
685 (a)[0] = ((u16) (val)) & 0xff; \
686 } while (0)
687
688 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
689 ((u32) (a)[2]))
690 #define RTW_PUT_BE24(a, val) \
691 do { \
692 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff); \
693 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \
694 (a)[2] = (u8) (((u32) (val)) & 0xff); \
695 } while (0)
696
697 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
698 (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
699 #define RTW_PUT_BE32(a, val) \
700 do { \
701 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff); \
702 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff); \
703 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff); \
704 (a)[3] = (u8) (((u32) (val)) & 0xff); \
705 } while (0)
706
707 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
708 (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
709 #define RTW_PUT_LE32(a, val) \
710 do { \
711 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff); \
712 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff); \
713 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \
714 (a)[0] = (u8) (((u32) (val)) & 0xff); \
715 } while (0)
716
717 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
718 (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
719 (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
720 (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
721 #define RTW_PUT_BE64(a, val) \
722 do { \
723 (a)[0] = (u8) (((u64) (val)) >> 56); \
724 (a)[1] = (u8) (((u64) (val)) >> 48); \
725 (a)[2] = (u8) (((u64) (val)) >> 40); \
726 (a)[3] = (u8) (((u64) (val)) >> 32); \
727 (a)[4] = (u8) (((u64) (val)) >> 24); \
728 (a)[5] = (u8) (((u64) (val)) >> 16); \
729 (a)[6] = (u8) (((u64) (val)) >> 8); \
730 (a)[7] = (u8) (((u64) (val)) & 0xff); \
731 } while (0)
732
733 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
734 (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
735 (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
736 (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
737 #define RTW_PUT_LE64(a, val) \
738 do { \
739 (a)[7] = (u8) ((((u64) (val)) >> 56) & 0xff); \
740 (a)[6] = (u8) ((((u64) (val)) >> 48) & 0xff); \
741 (a)[5] = (u8) ((((u64) (val)) >> 40) & 0xff); \
742 (a)[4] = (u8) ((((u64) (val)) >> 32) & 0xff); \
743 (a)[3] = (u8) ((((u64) (val)) >> 24) & 0xff); \
744 (a)[2] = (u8) ((((u64) (val)) >> 16) & 0xff); \
745 (a)[1] = (u8) ((((u64) (val)) >> 8) & 0xff); \
746 (a)[0] = (u8) (((u64) (val)) & 0xff); \
747 } while (0)
748
749 void rtw_buf_free(u8 **buf, u32 *buf_len);
750 void rtw_buf_update(u8 **buf, u32 *buf_len, u8 *src, u32 src_len);
751
752 struct rtw_cbuf {
753 u32 write;
754 u32 read;
755 u32 size;
756 void *bufs[0];
757 };
758
759 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
760 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
761 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
762 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
763 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
764 void rtw_cbuf_free(struct rtw_cbuf *cbuf);
765
766 struct map_seg_t {
767 u16 sa;
768 u16 len;
769 u8 *c;
770 };
771
772 struct map_t {
773 u16 len;
774 u16 seg_num;
775 u8 init_value;
776 struct map_seg_t *segs;
777 };
778
779 #define MAPSEG_ARRAY_ENT(_sa, _len, _c, arg...) \
780 { .sa = _sa, .len = _len, .c = (u8[_len]){ _c, ##arg}, }
781
782 #define MAPSEG_PTR_ENT(_sa, _len, _p) \
783 { .sa = _sa, .len = _len, .c = _p, }
784
785 #define MAP_ENT(_len, _seg_num, _init_v, _seg, arg...) \
786 { .len = _len, .seg_num = _seg_num, .init_value = _init_v, .segs = (struct map_seg_t[_seg_num]){ _seg, ##arg}, }
787
788 int map_readN(const struct map_t *map, u16 offset, u16 len, u8 *buf);
789 u8 map_read8(const struct map_t *map, u16 offset);
790
791 struct blacklist_ent {
792 _list list;
793 u8 addr[ETH_ALEN];
794 systime exp_time;
795 };
796
797 int rtw_blacklist_add(_queue *blist, const u8 *addr, u32 timeout_ms);
798 int rtw_blacklist_del(_queue *blist, const u8 *addr);
799 int rtw_blacklist_search(_queue *blist, const u8 *addr);
800 void rtw_blacklist_flush(_queue *blist);
801 void dump_blacklist(void *sel, _queue *blist, const char *title);
802
803 /* String handler */
804
805 BOOLEAN is_null(char c);
806 BOOLEAN is_all_null(char *c, int len);
807 BOOLEAN is_eol(char c);
808 BOOLEAN is_space(char c);
809 BOOLEAN IsHexDigit(char chTmp);
810 BOOLEAN is_alpha(char chTmp);
811 char alpha_to_upper(char c);
812
813 int hex2num_i(char c);
814 int hex2byte_i(const char *hex);
815 int hexstr2bin(const char *hex, u8 *buf, size_t len);
816
817 /*
818 * Write formatted output to sized buffer
819 */
820 #ifdef PLATFORM_LINUX
821 #define rtw_sprintf(buf, size, format, arg...) snprintf(buf, size, format, ##arg)
822 #else /* !PLATFORM_LINUX */
823 #error "NOT DEFINE \"rtw_sprintf\"!!"
824 #endif /* !PLATFORM_LINUX */
825
826 #endif
827