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