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