xref: /OK3568_Linux_fs/external/rkwifibt/drivers/rtl8852be/include/osdep_service.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2019 Realtek Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12  * more details.
13  *
14  *****************************************************************************/
15 #ifndef __OSDEP_SERVICE_H_
16 #define __OSDEP_SERVICE_H_
17 
18 #define RTW_RX_HANDLED			2
19 #define RTW_RFRAME_UNAVAIL		3
20 #define RTW_RFRAME_PKT_UNAVAIL		4
21 #define RTW_RBUF_UNAVAIL		5
22 #define RTW_RBUF_PKT_UNAVAIL		6
23 #define RTW_SDIO_RECV_FAIL	7
24 #define RTW_ALREADY			8
25 #define RTW_RA_RESOLVING		9
26 #define RTW_ORI_NO_NEED			10
27 
28 /* #define RTW_STATUS_TIMEDOUT -110 */
29 
30 
31 
32 #ifdef PLATFORM_FREEBSD
33 	#include <osdep_service_bsd.h>
34 #endif
35 
36 #ifdef PLATFORM_LINUX
37 	#include <linux/version.h>
38 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0))
39 	#include <linux/sched/signal.h>
40 	#include <linux/sched/types.h>
41 #endif
42 	#include <osdep_service_linux.h>
43 #endif
44 
45 /* #include <rtw_byteorder.h> */
46 
47 #ifndef BIT
48 	#define BIT(x)	(1 << (x))
49 #endif
50 #ifndef BIT_ULL
51 #define BIT_ULL(x)	(1ULL << (x))
52 #endif
53 
54 #define CHECK_BIT(a, b) (!!((a) & (b)))
55 
56 #define BIT0	0x00000001
57 #define BIT1	0x00000002
58 #define BIT2	0x00000004
59 #define BIT3	0x00000008
60 #define BIT4	0x00000010
61 #define BIT5	0x00000020
62 #define BIT6	0x00000040
63 #define BIT7	0x00000080
64 #define BIT8	0x00000100
65 #define BIT9	0x00000200
66 #define BIT10	0x00000400
67 #define BIT11	0x00000800
68 #define BIT12	0x00001000
69 #define BIT13	0x00002000
70 #define BIT14	0x00004000
71 #define BIT15	0x00008000
72 #define BIT16	0x00010000
73 #define BIT17	0x00020000
74 #define BIT18	0x00040000
75 #define BIT19	0x00080000
76 #define BIT20	0x00100000
77 #define BIT21	0x00200000
78 #define BIT22	0x00400000
79 #define BIT23	0x00800000
80 #define BIT24	0x01000000
81 #define BIT25	0x02000000
82 #define BIT26	0x04000000
83 #define BIT27	0x08000000
84 #define BIT28	0x10000000
85 #define BIT29	0x20000000
86 #define BIT30	0x40000000
87 #define BIT31	0x80000000
88 #define BIT32	0x0100000000
89 #define BIT33	0x0200000000
90 #define BIT34	0x0400000000
91 #define BIT35	0x0800000000
92 #define BIT36	0x1000000000
93 
94 #ifndef GENMASK
95 #define GENMASK(h, l) \
96 	(((~0UL) - (1UL << (l)) + 1) & (~0UL >> (BITS_PER_LONG - 1 - (h))))
97 #endif
98 
99 extern int RTW_STATUS_CODE(int error_code);
100 
101 #ifndef RTK_DMP_PLATFORM
102 	#define CONFIG_USE_VMALLOC
103 #endif
104 
105 /* flags used for rtw_mstat_update() */
106 enum mstat_f {
107 	/* type: 0x00ff */
108 	MSTAT_TYPE_VIR = 0x00,
109 	MSTAT_TYPE_PHY = 0x01,
110 	MSTAT_TYPE_SKB = 0x02,
111 	MSTAT_TYPE_USB = 0x03,
112 	MSTAT_TYPE_MAX = 0x04,
113 
114 	/* func: 0xff00 */
115 	MSTAT_FUNC_UNSPECIFIED = 0x00 << 8,
116 	MSTAT_FUNC_IO = 0x01 << 8,
117 	MSTAT_FUNC_TX_IO = 0x02 << 8,
118 	MSTAT_FUNC_RX_IO = 0x03 << 8,
119 	MSTAT_FUNC_TX = 0x04 << 8,
120 	MSTAT_FUNC_RX = 0x05 << 8,
121 	MSTAT_FUNC_CFG_VENDOR = 0x06 << 8,
122 	MSTAT_FUNC_MAX = 0x07 << 8,
123 };
124 
125 #define mstat_tf_idx(flags) ((flags) & 0xff)
126 #define mstat_ff_idx(flags) (((flags) & 0xff00) >> 8)
127 
128 typedef enum mstat_status {
129 	MSTAT_ALLOC_SUCCESS = 0,
130 	MSTAT_ALLOC_FAIL,
131 	MSTAT_FREE
132 } MSTAT_STATUS;
133 
134 
135 #ifdef DBG_MEM_ALLOC
136 void rtw_mstat_update(const enum mstat_f flags, const MSTAT_STATUS status, u32 sz);
137 void rtw_mstat_dump(void *sel);
138 bool match_mstat_sniff_rules(const enum mstat_f flags, const size_t size);
139 void *dbg_rtw_vmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
140 void *dbg_rtw_zvmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
141 void dbg_rtw_vmfree(void *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
142 void *dbg_rtw_malloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
143 void *dbg_rtw_zmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
144 void dbg_rtw_mfree(void *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
145 
146 struct sk_buff *dbg_rtw_skb_alloc(unsigned int size, const enum mstat_f flags, const char *func, const int line);
147 void dbg_rtw_skb_free(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
148 struct sk_buff *dbg_rtw_skb_copy(const struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
149 struct sk_buff *dbg_rtw_skb_clone(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
150 int dbg_rtw_skb_linearize(struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
151 int dbg_rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
152 #ifdef CONFIG_RTW_NAPI
153 int dbg_rtw_netif_receive_skb(_nic_hdl ndev, struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
154 #ifdef CONFIG_RTW_GRO
155 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);
156 #endif
157 #endif /* CONFIG_RTW_NAPI */
158 void dbg_rtw_skb_queue_purge(struct sk_buff_head *list, enum mstat_f flags, const char *func, int line);
159 #ifdef CONFIG_USB_HCI
160 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);
161 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);
162 #endif /* CONFIG_USB_HCI */
163 
164 #ifdef CONFIG_USE_VMALLOC
165 #define rtw_vmalloc(sz)			dbg_rtw_vmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
166 #define rtw_zvmalloc(sz)			dbg_rtw_zvmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
167 #define rtw_vmfree(pbuf, sz)			dbg_rtw_vmfree((pbuf), (sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
168 #define rtw_vmalloc_f(sz, mstat_f)		dbg_rtw_vmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
169 #define rtw_zvmalloc_f(sz, mstat_f)		dbg_rtw_zvmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
170 #define rtw_vmfree_f(pbuf, sz, mstat_f)	dbg_rtw_vmfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
171 #else /* CONFIG_USE_VMALLOC */
172 #define rtw_vmalloc(sz)			dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
173 #define rtw_zvmalloc(sz)			dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
174 #define rtw_vmfree(pbuf, sz)			dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
175 #define rtw_vmalloc_f(sz, mstat_f)		dbg_rtw_malloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
176 #define rtw_zvmalloc_f(sz, mstat_f)		dbg_rtw_zmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
177 #define rtw_vmfree_f(pbuf, sz, mstat_f)	dbg_rtw_mfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
178 #endif /* CONFIG_USE_VMALLOC */
179 #define rtw_malloc(sz)				dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
180 #define rtw_zmalloc(sz)			dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
181 #define rtw_mfree(pbuf, sz)			dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
182 #define rtw_malloc_f(sz, mstat_f)		dbg_rtw_malloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
183 #define rtw_zmalloc_f(sz, mstat_f)		dbg_rtw_zmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
184 #define rtw_mfree_f(pbuf, sz, mstat_f)	dbg_rtw_mfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
185 
186 #define rtw_skb_alloc(size)			dbg_rtw_skb_alloc((size), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
187 #define rtw_skb_free(skb)			dbg_rtw_skb_free((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
188 #define rtw_skb_alloc_f(size, mstat_f)	dbg_rtw_skb_alloc((size), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
189 #define rtw_skb_free_f(skb, mstat_f)		dbg_rtw_skb_free((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
190 #define rtw_skb_copy(skb)			dbg_rtw_skb_copy((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
191 #define rtw_skb_clone(skb)			dbg_rtw_skb_clone((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
192 #define rtw_skb_copy_f(skb, mstat_f)		dbg_rtw_skb_copy((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
193 #define rtw_skb_clone_f(skb, mstat_f)		dbg_rtw_skb_clone((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
194 #define rtw_skb_linearize(skb)			dbg_rtw_skb_linearize((skb), MSTAT_TYPE_SKB, __func__, __LINE__)
195 #define rtw_netif_rx(ndev, skb)		dbg_rtw_netif_rx(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
196 #ifdef CONFIG_RTW_NAPI
197 #define rtw_netif_receive_skb(ndev, skb)	dbg_rtw_netif_receive_skb(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
198 #ifdef CONFIG_RTW_GRO
199 #define rtw_napi_gro_receive(napi, skb)	dbg_rtw_napi_gro_receive(napi, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
200 #endif
201 #endif /* CONFIG_RTW_NAPI */
202 #define rtw_skb_queue_purge(sk_buff_head)	dbg_rtw_skb_queue_purge(sk_buff_head, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
203 #ifdef CONFIG_USB_HCI
204 #define rtw_usb_buffer_alloc(dev, size, dma)		dbg_rtw_usb_buffer_alloc((dev), (size), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
205 #define rtw_usb_buffer_free(dev, size, addr, dma)	dbg_rtw_usb_buffer_free((dev), (size), (addr), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
206 #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__)
207 #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__)
208 #endif /* CONFIG_USB_HCI */
209 
210 #else /* DBG_MEM_ALLOC */
211 #define rtw_mstat_update(flag, status, sz) do {} while (0)
212 #define rtw_mstat_dump(sel) do {} while (0)
213 #define match_mstat_sniff_rules(flags, size) _FALSE
214 void *_rtw_vmalloc(u32 sz);
215 void *_rtw_zvmalloc(u32 sz);
216 void _rtw_vmfree(void *pbuf, u32 sz);
217 void *_rtw_zmalloc(u32 sz);
218 void *_rtw_malloc(u32 sz);
219 void _rtw_mfree(void *pbuf, u32 sz);
220 
221 struct sk_buff *_rtw_skb_alloc(u32 sz);
222 void _rtw_skb_free(struct sk_buff *skb);
223 #ifdef CONFIG_RTW_NAPI
224 int _rtw_netif_receive_skb(_nic_hdl ndev, struct sk_buff *skb);
225 #ifdef CONFIG_RTW_GRO
226 gro_result_t _rtw_napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
227 #endif
228 #endif /* CONFIG_RTW_NAPI */
229 void _rtw_skb_queue_purge(struct sk_buff_head *list);
230 
231 #ifdef CONFIG_USE_VMALLOC
232 #define rtw_vmalloc(sz)			_rtw_vmalloc((sz))
233 #define rtw_zvmalloc(sz)			_rtw_zvmalloc((sz))
234 #define rtw_vmfree(pbuf, sz)			_rtw_vmfree((pbuf), (sz))
235 #define rtw_vmalloc_f(sz, mstat_f)		_rtw_vmalloc((sz))
236 #define rtw_zvmalloc_f(sz, mstat_f)		_rtw_zvmalloc((sz))
237 #define rtw_vmfree_f(pbuf, sz, mstat_f)	_rtw_vmfree((pbuf), (sz))
238 #else /* CONFIG_USE_VMALLOC */
239 #define rtw_vmalloc(sz)			_rtw_malloc((sz))
240 #define rtw_zvmalloc(sz)			_rtw_zmalloc((sz))
241 #define rtw_vmfree(pbuf, sz)			_rtw_mfree((pbuf), (sz))
242 #define rtw_vmalloc_f(sz, mstat_f)		_rtw_malloc((sz))
243 #define rtw_zvmalloc_f(sz, mstat_f)		_rtw_zmalloc((sz))
244 #define rtw_vmfree_f(pbuf, sz, mstat_f)	_rtw_mfree((pbuf), (sz))
245 #endif /* CONFIG_USE_VMALLOC */
246 #define rtw_malloc(sz)				_rtw_malloc((sz))
247 #define rtw_zmalloc(sz)			_rtw_zmalloc((sz))
248 #define rtw_mfree(pbuf, sz)			_rtw_mfree((pbuf), (sz))
249 #define rtw_malloc_f(sz, mstat_f)		_rtw_malloc((sz))
250 #define rtw_zmalloc_f(sz, mstat_f)		_rtw_zmalloc((sz))
251 #define rtw_mfree_f(pbuf, sz, mstat_f)	_rtw_mfree((pbuf), (sz))
252 
253 #define rtw_skb_alloc(size) 			_rtw_skb_alloc((size))
254 #define rtw_skb_free(skb) 			_rtw_skb_free((skb))
255 #define rtw_skb_alloc_f(size, mstat_f)	_rtw_skb_alloc((size))
256 #define rtw_skb_free_f(skb, mstat_f)		_rtw_skb_free((skb))
257 #define rtw_skb_copy(skb)			_rtw_skb_copy((skb))
258 #define rtw_skb_clone(skb)			_rtw_skb_clone((skb))
259 #define rtw_skb_copy_f(skb, mstat_f)		_rtw_skb_copy((skb))
260 #define rtw_skb_clone_f(skb, mstat_f)		_rtw_skb_clone((skb))
261 #define rtw_skb_linearize(skb)			_rtw_skb_linearize(skb)
262 #define rtw_netif_rx(ndev, skb)		_rtw_netif_rx(ndev, skb)
263 #ifdef CONFIG_RTW_NAPI
264 #define rtw_netif_receive_skb(ndev, skb) _rtw_netif_receive_skb(ndev, skb)
265 #ifdef CONFIG_RTW_GRO
266 #define rtw_napi_gro_receive(napi, skb) _rtw_napi_gro_receive(napi, skb)
267 #endif
268 #endif /* CONFIG_RTW_NAPI */
269 #define rtw_skb_queue_purge(sk_buff_head) _rtw_skb_queue_purge(sk_buff_head)
270 #ifdef CONFIG_USB_HCI
271 #define rtw_usb_buffer_alloc(dev, size, dma) _rtw_usb_buffer_alloc((dev), (size), (dma))
272 #define rtw_usb_buffer_free(dev, size, addr, dma) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
273 #define rtw_usb_buffer_alloc_f(dev, size, dma, mstat_f) _rtw_usb_buffer_alloc((dev), (size), (dma))
274 #define rtw_usb_buffer_free_f(dev, size, addr, dma, mstat_f) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
275 #endif /* CONFIG_USB_HCI */
276 #endif /* DBG_MEM_ALLOC */
277 
278 
279 void *rtw_malloc2d(int h, int w, size_t size);
280 void rtw_mfree2d(void *pbuf, int h, int w, int size);
281 void _rtw_memcpy(void *dec, const void *sour, u32 sz);
282 void _rtw_memmove(void *dst, const void *src, u32 sz);
283 int _rtw_memcmp(const void *dst, const void *src, u32 sz);
284 int _rtw_memcmp2(const void *dst, const void *src, u32 sz);
285 void _rtw_memset(void *pbuf, int c, u32 sz);
286 
287 void _rtw_init_listhead(_list *list);
288 u32 rtw_is_list_empty(_list *phead);
289 void rtw_list_insert_head(_list *plist, _list *phead);
290 void rtw_list_insert_tail(_list *plist, _list *phead);
291 void rtw_list_splice(_list *list, _list *head);
292 void rtw_list_splice_init(_list *list, _list *head);
293 void rtw_list_splice_tail(_list *list, _list *head);
294 
295 void rtw_list_delete(_list *plist);
296 
297 void rtw_hlist_head_init(rtw_hlist_head *h);
298 void rtw_hlist_add_head(rtw_hlist_node *n, rtw_hlist_head *h);
299 void rtw_hlist_del(rtw_hlist_node *n);
300 void rtw_hlist_add_head_rcu(rtw_hlist_node *n, rtw_hlist_head *h);
301 void rtw_hlist_del_rcu(rtw_hlist_node *n);
302 
303 void _rtw_init_queue(_queue *pqueue);
304 void _rtw_deinit_queue(_queue *pqueue);
305 u32 _rtw_queue_empty(_queue	*pqueue);
306 u32 rtw_end_of_queue_search(_list *queue, _list *pelement);
307 
308 systime _rtw_get_current_time(void);
309 u32 _rtw_systime_to_us(systime stime);
310 u32 _rtw_systime_to_ms(systime stime);
311 systime _rtw_ms_to_systime(u32 ms);
312 systime _rtw_us_to_systime(u32 us);
313 s32 _rtw_get_passing_time_ms(systime start);
314 s32 _rtw_get_remaining_time_ms(systime end);
315 s32 _rtw_get_time_interval_ms(systime start, systime end);
316 bool _rtw_time_after(systime a, systime b);
317 
318 #ifdef DBG_SYSTIME
319 #define rtw_get_current_time() ({systime __stime = _rtw_get_current_time(); __stime;})
320 #define rtw_systime_to_us(stime) ({u32 __us = _rtw_systime_to_us(stime); typecheck(systime, stime); __us;})
321 #define rtw_systime_to_ms(stime) ({u32 __ms = _rtw_systime_to_ms(stime); typecheck(systime, stime); __ms;})
322 #define rtw_ms_to_systime(ms) ({systime __stime = _rtw_ms_to_systime(ms); __stime;})
323 #define rtw_us_to_systime(us) ({systime __stime = _rtw_us_to_systime(us); __stime;})
324 #define rtw_get_passing_time_ms(start) ({u32 __ms = _rtw_get_passing_time_ms(start); typecheck(systime, start); __ms;})
325 #define rtw_get_remaining_time_ms(end) ({u32 __ms = _rtw_get_remaining_time_ms(end); typecheck(systime, end); __ms;})
326 #define rtw_get_time_interval_ms(start, end) ({u32 __ms = _rtw_get_time_interval_ms(start, end); typecheck(systime, start); typecheck(systime, end); __ms;})
327 #define rtw_time_after(a,b) ({bool __r = _rtw_time_after(a,b); typecheck(systime, a); typecheck(systime, b); __r;})
328 #define rtw_time_before(a,b) ({bool __r = _rtw_time_after(b, a); typecheck(systime, a); typecheck(systime, b); __r;})
329 #else
330 #define rtw_get_current_time() _rtw_get_current_time()
331 #define rtw_systime_to_us(stime) _rtw_systime_to_us(stime)
332 #define rtw_systime_to_ms(stime) _rtw_systime_to_ms(stime)
333 #define rtw_ms_to_systime(ms) _rtw_ms_to_systime(ms)
334 #define rtw_us_to_systime(us) _rtw_us_to_systime(us)
335 #define rtw_get_passing_time_ms(start) _rtw_get_passing_time_ms(start)
336 #define rtw_get_remaining_time_ms(end) _rtw_get_remaining_time_ms(end)
337 #define rtw_get_time_interval_ms(start, end) _rtw_get_time_interval_ms(start, end)
338 #define rtw_time_after(a,b) _rtw_time_after(a,b)
339 #define rtw_time_before(a,b) _rtw_time_after(b,a)
340 #endif
341 
342 void rtw_sleep_schedulable(int ms);
343 
344 void rtw_msleep_os(int ms);
345 void rtw_usleep_os(int us);
346 
347 u32 rtw_atoi(u8 *s);
348 
349 #ifdef DBG_DELAY_OS
350 #define rtw_mdelay_os(ms) _rtw_mdelay_os((ms), __FUNCTION__, __LINE__)
351 #define rtw_udelay_os(ms) _rtw_udelay_os((ms), __FUNCTION__, __LINE__)
352 void _rtw_mdelay_os(int ms, const char *func, const int line);
353 void _rtw_udelay_os(int us, const char *func, const int line);
354 #else
355 void rtw_mdelay_os(int ms);
356 void rtw_udelay_os(int us);
357 #endif
358 
359 void rtw_yield_os(void);
360 
361 void rtw_init_timer(_timer *ptimer, void *pfunc, void *ctx);
_cancel_timer_ex(_timer * ptimer)362 __inline static unsigned char _cancel_timer_ex(_timer *ptimer)
363 {
364 	u8 bcancelled;
365 
366 	_cancel_timer(ptimer, &bcancelled);
367 
368 	return bcancelled;
369 }
370 
_cancel_timer_nowait(_timer * ptimer)371 __inline static void _cancel_timer_nowait(_timer *ptimer)
372 {
373 	_cancel_timer_async(ptimer);
374 }
375 
376 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
377 #define RND4(x)	(((x >> 2) + (((x & 3) == 0) ? 0 : 1)) << 2)
378 
_RND4(u32 sz)379 __inline static u32 _RND4(u32 sz)
380 {
381 
382 	u32	val;
383 
384 	val = ((sz >> 2) + ((sz & 3) ? 1 : 0)) << 2;
385 
386 	return val;
387 
388 }
389 
_RND8(u32 sz)390 __inline static u32 _RND8(u32 sz)
391 {
392 
393 	u32	val;
394 
395 	val = ((sz >> 3) + ((sz & 7) ? 1 : 0)) << 3;
396 
397 	return val;
398 
399 }
400 
_RND128(u32 sz)401 __inline static u32 _RND128(u32 sz)
402 {
403 
404 	u32	val;
405 
406 	val = ((sz >> 7) + ((sz & 127) ? 1 : 0)) << 7;
407 
408 	return val;
409 
410 }
411 
_RND256(u32 sz)412 __inline static u32 _RND256(u32 sz)
413 {
414 
415 	u32	val;
416 
417 	val = ((sz >> 8) + ((sz & 255) ? 1 : 0)) << 8;
418 
419 	return val;
420 
421 }
422 
_RND512(u32 sz)423 __inline static u32 _RND512(u32 sz)
424 {
425 
426 	u32	val;
427 
428 	val = ((sz >> 9) + ((sz & 511) ? 1 : 0)) << 9;
429 
430 	return val;
431 
432 }
433 
bitshift(u32 bitmask)434 __inline static u32 bitshift(u32 bitmask)
435 {
436 	u32 i;
437 
438 	for (i = 0; i <= 31; i++)
439 		if (((bitmask >> i) &  0x1) == 1)
440 			break;
441 
442 	return i;
443 }
444 
largest_bit(u32 bitmask)445 static inline int largest_bit(u32 bitmask)
446 {
447 	int i;
448 
449 	for (i = 31; i >= 0; i--)
450 		if (bitmask & BIT(i))
451 			break;
452 
453 	return i;
454 }
455 
largest_bit_64(u64 bitmask)456 static inline int largest_bit_64(u64 bitmask)
457 {
458 	int i;
459 
460 	for (i = 63; i >= 0; i--)
461 		if (bitmask & BIT_ULL(i))
462 			break;
463 
464 	return i;
465 }
466 
467 #define rtw_abs(a) ((a) < 0 ? -(a) : (a))
468 #define rtw_min(a, b) (((a) > (b)) ? (b) : (a))
469 #define rtw_max(a, b) (((a) > (b)) ? (a) : (b))
470 #define rtw_is_range_a_in_b(hi_a, lo_a, hi_b, lo_b) (((hi_a) <= (hi_b)) && ((lo_a) >= (lo_b)))
471 #define rtw_is_range_overlap(hi_a, lo_a, hi_b, lo_b) (((hi_a) > (lo_b)) && ((lo_a) < (hi_b)))
472 
473 #ifndef MAC_FMT
474 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
475 #endif
476 #ifndef MAC_ARG
477 #define MAC_ARG(x) ((u8 *)(x))[0], ((u8 *)(x))[1], ((u8 *)(x))[2], ((u8 *)(x))[3], ((u8 *)(x))[4], ((u8 *)(x))[5]
478 #endif
479 
480 bool rtw_macaddr_is_larger(const u8 *a, const u8 *b);
481 
482 void rtw_suspend_lock_init(void);
483 void rtw_suspend_lock_uninit(void);
484 void rtw_lock_suspend(void);
485 void rtw_unlock_suspend(void);
486 void rtw_lock_suspend_timeout(u32 timeout_ms);
487 void rtw_lock_traffic_suspend_timeout(u32 timeout_ms);
488 void rtw_resume_lock_suspend(void);
489 void rtw_resume_unlock_suspend(void);
490 #ifdef CONFIG_AP_WOWLAN
491 void rtw_softap_lock_suspend(void);
492 void rtw_softap_unlock_suspend(void);
493 #endif
494 
495 void rtw_set_bit(int nr, unsigned long *addr);
496 void rtw_clear_bit(int nr, unsigned long *addr);
497 int rtw_test_and_clear_bit(int nr, unsigned long *addr);
498 int rtw_test_and_set_bit(int nr, unsigned long *addr);
499 
500 /* File operation APIs, just for linux now */
501 #ifndef CONFIG_RTW_ANDROID
502 int rtw_is_dir_readable(const char *path);
503 int rtw_store_to_file(const char *path, u8 *buf, u32 sz);
504 #endif /* CONFIG_RTW_ANDROID */
505 int rtw_is_file_readable(const char *path);
506 int rtw_is_file_readable_with_size(const char *path, u32 *sz);
507 int rtw_readable_file_sz_chk(const char *path, u32 sz);
508 int rtw_retrieve_from_file(const char *path, u8 *buf, u32 sz);
509 void rtw_free_netdev(struct net_device *netdev);
510 
511 u64 rtw_modular64(u64 x, u64 y);
512 u64 rtw_division64(u64 x, u64 y);
513  u32 rtw_random32(void);
514 
515 /* Macros for handling unaligned memory accesses */
516 
517 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
518 #define RTW_PUT_BE16(a, val)			\
519 	do {					\
520 		(a)[0] = ((u16) (val)) >> 8;	\
521 		(a)[1] = ((u16) (val)) & 0xff;	\
522 	} while (0)
523 
524 #define RTW_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0]))
525 #define RTW_PUT_LE16(a, val)			\
526 	do {					\
527 		(a)[1] = ((u16) (val)) >> 8;	\
528 		(a)[0] = ((u16) (val)) & 0xff;	\
529 	} while (0)
530 
531 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
532 			 ((u32) (a)[2]))
533 #define RTW_PUT_BE24(a, val)					\
534 	do {							\
535 		(a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff);	\
536 		(a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);	\
537 		(a)[2] = (u8) (((u32) (val)) & 0xff);		\
538 	} while (0)
539 
540 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
541 			 (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
542 #define RTW_PUT_BE32(a, val)					\
543 	do {							\
544 		(a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);	\
545 		(a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);	\
546 		(a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);	\
547 		(a)[3] = (u8) (((u32) (val)) & 0xff);		\
548 	} while (0)
549 
550 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
551 			 (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
552 #define RTW_PUT_LE32(a, val)					\
553 	do {							\
554 		(a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff);	\
555 		(a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff);	\
556 		(a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);	\
557 		(a)[0] = (u8) (((u32) (val)) & 0xff);		\
558 	} while (0)
559 
560 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
561 			 (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
562 			 (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
563 			 (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
564 #define RTW_PUT_BE64(a, val)				\
565 	do {						\
566 		(a)[0] = (u8) (((u64) (val)) >> 56);	\
567 		(a)[1] = (u8) (((u64) (val)) >> 48);	\
568 		(a)[2] = (u8) (((u64) (val)) >> 40);	\
569 		(a)[3] = (u8) (((u64) (val)) >> 32);	\
570 		(a)[4] = (u8) (((u64) (val)) >> 24);	\
571 		(a)[5] = (u8) (((u64) (val)) >> 16);	\
572 		(a)[6] = (u8) (((u64) (val)) >> 8);	\
573 		(a)[7] = (u8) (((u64) (val)) & 0xff);	\
574 	} while (0)
575 
576 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
577 			 (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
578 			 (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
579 			 (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
580 #define RTW_PUT_LE64(a, val)					\
581 	do {							\
582 		(a)[7] = (u8) ((((u64) (val)) >> 56) & 0xff);	\
583 		(a)[6] = (u8) ((((u64) (val)) >> 48) & 0xff);	\
584 		(a)[5] = (u8) ((((u64) (val)) >> 40) & 0xff);	\
585 		(a)[4] = (u8) ((((u64) (val)) >> 32) & 0xff);	\
586 		(a)[3] = (u8) ((((u64) (val)) >> 24) & 0xff);	\
587 		(a)[2] = (u8) ((((u64) (val)) >> 16) & 0xff);	\
588 		(a)[1] = (u8) ((((u64) (val)) >> 8) & 0xff);	\
589 		(a)[0] = (u8) (((u64) (val)) & 0xff);		\
590 	} while (0)
591 
592 void rtw_buf_free(u8 **buf, u32 *buf_len);
593 void rtw_buf_update(u8 **buf, u32 *buf_len, const u8 *src, u32 src_len);
594 
595 struct rtw_cbuf {
596 	u32 write;
597 	u32 read;
598 	u32 size;
599 	void *bufs[0];
600 };
601 
602 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
603 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
604 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
605 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
606 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
607 void rtw_cbuf_free(struct rtw_cbuf *cbuf);
608 
609 struct map_seg_t {
610 	u16 sa;
611 	u16 len;
612 	u8 *c;
613 };
614 
615 struct map_t {
616 	u16 len;
617 	u16 seg_num;
618 	u8 init_value;
619 	struct map_seg_t *segs;
620 };
621 
622 #define MAPSEG_ARRAY_ENT(_sa, _len, _c, arg...) \
623 	{ .sa = _sa, .len = _len, .c = (u8[_len]){ _c, ##arg}, }
624 
625 #define MAPSEG_PTR_ENT(_sa, _len, _p) \
626 	{ .sa = _sa, .len = _len, .c = _p, }
627 
628 #define MAP_ENT(_len, _seg_num, _init_v, _seg, arg...) \
629 	{ .len = _len, .seg_num = _seg_num, .init_value = _init_v, .segs = (struct map_seg_t[_seg_num]){ _seg, ##arg}, }
630 
631 int map_readN(const struct map_t *map, u16 offset, u16 len, u8 *buf);
632 u8 map_read8(const struct map_t *map, u16 offset);
633 
634 struct blacklist_ent {
635 	_list list;
636 	u8 addr[ETH_ALEN];
637 	systime exp_time;
638 };
639 
640 int rtw_blacklist_add(_queue *blist, const u8 *addr, u32 timeout_ms);
641 int rtw_blacklist_del(_queue *blist, const u8 *addr);
642 int rtw_blacklist_search(_queue *blist, const u8 *addr);
643 void rtw_blacklist_flush(_queue *blist);
644 void dump_blacklist(void *sel, _queue *blist, const char *title);
645 
646 /* String handler */
647 
648 BOOLEAN is_null(char c);
649 BOOLEAN is_all_null(char *c, int len);
650 BOOLEAN is_eol(char c);
651 BOOLEAN is_space(char c);
652 BOOLEAN is_decimal(char chTmp);
653 BOOLEAN IsHexDigit(char chTmp);
654 BOOLEAN is_alpha(char chTmp);
655 char alpha_to_upper(char c);
656 
657 int hex2num_i(char c);
658 int hex2byte_i(const char *hex);
659 int hexstr2bin(const char *hex, u8 *buf, size_t len);
660 
661 /*
662  * Write formatted output to sized buffer
663  */
664 
665 #endif
666