1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /* Copyright(c) 2007 - 2011 Realtek Corporation. */
4 #ifndef __OSDEP_SERVICE_H_
5 #define __OSDEP_SERVICE_H_
7 #include <linux/sched/signal.h>
8 #include <basic_types.h>
12 #define RTW_RX_HANDLED 2
14 #include <linux/spinlock.h>
15 #include <linux/compiler.h>
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/init.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21 #include <linux/kref.h>
22 #include <linux/netdevice.h>
23 #include <linux/skbuff.h>
24 #include <linux/circ_buf.h>
25 #include <linux/uaccess.h>
26 #include <asm/byteorder.h>
27 #include <asm/atomic.h>
29 #include <linux/semaphore.h>
30 #include <linux/sem.h>
31 #include <linux/sched.h>
32 #include <linux/etherdevice.h>
33 #include <linux/wireless.h>
34 #include <net/iw_handler.h>
35 #include <linux/if_arp.h>
36 #include <linux/rtnetlink.h>
37 #include <linux/delay.h>
38 #include <linux/proc_fs.h> /* Necessary because we use the proc fs */
39 #include <linux/interrupt.h> /* for struct tasklet_struct */
41 #include <linux/kthread.h>
43 #include <linux/usb.h>
44 #include <linux/usb/ch9.h>
47 struct list_head queue;
51 #define thread_exit() complete_and_exit(NULL, 0)
53 static inline struct list_head *get_list_head(struct __queue *queue)
55 return (&(queue->queue));
58 static inline int _enter_critical_mutex(struct mutex *pmutex, unsigned long *pirqL)
62 ret = mutex_lock_interruptible(pmutex);
66 static inline void _exit_critical_mutex(struct mutex *pmutex, unsigned long *pirqL)
71 static inline void rtw_list_delete(struct list_head *plist)
76 static inline void _set_timer(struct timer_list *ptimer,u32 delay_time)
78 mod_timer(ptimer , (jiffies+(delay_time*HZ/1000)));
81 static inline void _cancel_timer(struct timer_list *ptimer,u8 *bcancelled)
83 del_timer_sync(ptimer);
84 *bcancelled= true;/* true ==1; false==0 */
87 #define RTW_TIMER_HDL_ARGS void *FunctionContext
88 #define RTW_TIMER_HDL_NAME(name) rtw_##name##_timer_hdl
89 #define RTW_DECLARE_TIMER_HDL(name) void RTW_TIMER_HDL_NAME(name)(RTW_TIMER_HDL_ARGS)
91 static inline void _init_workitem(struct work_struct *pwork, void *pfunc, void * cntx)
93 INIT_WORK(pwork, pfunc);
96 static inline void _set_workitem(struct work_struct *pwork)
101 static inline void _cancel_workitem_sync(struct work_struct *pwork)
103 cancel_work_sync(pwork);
106 /* Global Mutex: can only be used at PASSIVE level. */
109 #define ACQUIRE_GLOBAL_MUTEX(_MutexCounter) \
111 while (atomic_inc_return((atomic_t *)&(_MutexCounter)) != 1)\
113 atomic_dec((atomic_t *)&(_MutexCounter)); \
118 #define RELEASE_GLOBAL_MUTEX(_MutexCounter) \
120 atomic_dec((atomic_t *)&(_MutexCounter)); \
123 static inline int rtw_netif_queue_stopped(struct net_device *pnetdev)
125 return netif_tx_queue_stopped(netdev_get_tx_queue(pnetdev, 0)) &&
126 netif_tx_queue_stopped(netdev_get_tx_queue(pnetdev, 1)) &&
127 netif_tx_queue_stopped(netdev_get_tx_queue(pnetdev, 2)) &&
128 netif_tx_queue_stopped(netdev_get_tx_queue(pnetdev, 3));
131 static inline void rtw_netif_wake_queue(struct net_device *pnetdev)
133 netif_tx_wake_all_queues(pnetdev);
136 static inline void rtw_netif_start_queue(struct net_device *pnetdev)
138 netif_tx_start_all_queues(pnetdev);
141 static inline void rtw_netif_stop_queue(struct net_device *pnetdev)
143 netif_tx_stop_all_queues(pnetdev);
147 #define BIT(x) ( 1 << (x))
150 #define BIT0 0x00000001
151 #define BIT1 0x00000002
152 #define BIT2 0x00000004
153 #define BIT3 0x00000008
154 #define BIT4 0x00000010
155 #define BIT5 0x00000020
156 #define BIT6 0x00000040
157 #define BIT7 0x00000080
158 #define BIT8 0x00000100
159 #define BIT9 0x00000200
160 #define BIT10 0x00000400
161 #define BIT11 0x00000800
162 #define BIT12 0x00001000
163 #define BIT13 0x00002000
164 #define BIT14 0x00004000
165 #define BIT15 0x00008000
166 #define BIT16 0x00010000
167 #define BIT17 0x00020000
168 #define BIT18 0x00040000
169 #define BIT19 0x00080000
170 #define BIT20 0x00100000
171 #define BIT21 0x00200000
172 #define BIT22 0x00400000
173 #define BIT23 0x00800000
174 #define BIT24 0x01000000
175 #define BIT25 0x02000000
176 #define BIT26 0x04000000
177 #define BIT27 0x08000000
178 #define BIT28 0x10000000
179 #define BIT29 0x20000000
180 #define BIT30 0x40000000
181 #define BIT31 0x80000000
182 #define BIT32 0x0100000000
183 #define BIT33 0x0200000000
184 #define BIT34 0x0400000000
185 #define BIT35 0x0800000000
186 #define BIT36 0x1000000000
188 extern int RTW_STATUS_CODE(int error_code);
190 /* flags used for rtw_update_mem_stat() */
192 MEM_STAT_VIR_ALLOC_SUCCESS,
193 MEM_STAT_VIR_ALLOC_FAIL,
195 MEM_STAT_PHY_ALLOC_SUCCESS,
196 MEM_STAT_PHY_ALLOC_FAIL,
198 MEM_STAT_TX, /* used to distinguish TX/RX, asigned from caller */
199 MEM_STAT_TX_ALLOC_SUCCESS,
200 MEM_STAT_TX_ALLOC_FAIL,
202 MEM_STAT_RX, /* used to distinguish TX/RX, asigned from caller */
203 MEM_STAT_RX_ALLOC_SUCCESS,
204 MEM_STAT_RX_ALLOC_FAIL,
208 extern unsigned char MCS_rate_2R[16];
209 extern unsigned char MCS_rate_1R[16];
210 extern unsigned char RTW_WPA_OUI[];
211 extern unsigned char WPA_TKIP_CIPHER[4];
212 extern unsigned char RSN_TKIP_CIPHER[4];
214 #define rtw_update_mem_stat(flag, sz) do {} while (0)
215 u8 *_rtw_vmalloc(u32 sz);
216 u8 *_rtw_zvmalloc(u32 sz);
217 void _rtw_vmfree(u8 *pbuf, u32 sz);
218 u8 *_rtw_zmalloc(u32 sz);
219 u8 *_rtw_malloc(u32 sz);
220 void _rtw_mfree(u8 *pbuf, u32 sz);
221 #define rtw_vmalloc(sz) _rtw_vmalloc((sz))
222 #define rtw_zvmalloc(sz) _rtw_zvmalloc((sz))
223 #define rtw_vmfree(pbuf, sz) _rtw_vmfree((pbuf), (sz))
224 #define rtw_malloc(sz) _rtw_malloc((sz))
225 #define rtw_zmalloc(sz) _rtw_zmalloc((sz))
226 #define rtw_mfree(pbuf, sz) _rtw_mfree((pbuf), (sz))
228 void *rtw_malloc2d(int h, int w, int size);
230 u32 _rtw_down_sema(struct semaphore *sema);
231 void _rtw_mutex_init(struct mutex *pmutex);
232 void _rtw_mutex_free(struct mutex *pmutex);
233 void _rtw_spinlock_free(spinlock_t *plock);
235 void _rtw_init_queue(struct __queue *pqueue);
237 u32 rtw_systime_to_ms(u32 systime);
238 u32 rtw_ms_to_systime(u32 ms);
239 s32 rtw_get_passing_time_ms(u32 start);
240 s32 rtw_get_time_interval_ms(u32 start, u32 end);
242 void rtw_sleep_schedulable(int ms);
244 void rtw_msleep_os(int ms);
245 void rtw_usleep_os(int us);
249 void rtw_mdelay_os(int ms);
250 void rtw_udelay_os(int us);
252 void rtw_yield_os(void);
254 static inline unsigned char _cancel_timer_ex(struct timer_list *ptimer)
256 return del_timer_sync(ptimer);
259 static __inline void thread_enter(char *name)
262 daemonize("%s", name);
264 allow_signal(SIGTERM);
267 static inline void flush_signals_thread(void)
269 if (signal_pending (current))
270 flush_signals(current);
273 static inline int res_to_status(int res)
278 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
279 #define RND4(x) (((x >> 2) + (((x & 3) == 0) ? 0: 1)) << 2)
281 static inline u32 _RND4(u32 sz)
285 val = ((sz >> 2) + ((sz & 3) ? 1: 0)) << 2;
289 static inline u32 _RND8(u32 sz)
293 val = ((sz >> 3) + ((sz & 7) ? 1: 0)) << 3;
297 static inline u32 _RND128(u32 sz)
301 val = ((sz >> 7) + ((sz & 127) ? 1: 0)) << 7;
305 static inline u32 _RND256(u32 sz)
309 val = ((sz >> 8) + ((sz & 255) ? 1: 0)) << 8;
313 static inline u32 _RND512(u32 sz)
317 val = ((sz >> 9) + ((sz & 511) ? 1: 0)) << 9;
321 static inline u32 bitshift(u32 bitmask)
325 for (i = 0; i <= 31; i++)
326 if (((bitmask>>i) & 0x1) == 1) break;
330 /* limitation of path length */
331 #define PATH_LENGTH_MAX PATH_MAX
333 void rtw_suspend_lock_init(void);
334 void rtw_suspend_lock_uninit(void);
335 void rtw_lock_suspend(void);
336 void rtw_unlock_suspend(void);
338 /* Atomic integer operations */
339 #define ATOMIC_T atomic_t
341 void ATOMIC_SET(ATOMIC_T *v, int i);
342 int ATOMIC_READ(ATOMIC_T *v);
343 void ATOMIC_ADD(ATOMIC_T *v, int i);
344 void ATOMIC_SUB(ATOMIC_T *v, int i);
345 void ATOMIC_INC(ATOMIC_T *v);
346 void ATOMIC_DEC(ATOMIC_T *v);
347 int ATOMIC_ADD_RETURN(ATOMIC_T *v, int i);
348 int ATOMIC_SUB_RETURN(ATOMIC_T *v, int i);
349 int ATOMIC_INC_RETURN(ATOMIC_T *v);
350 int ATOMIC_DEC_RETURN(ATOMIC_T *v);
352 struct rtw_netdev_priv_indicator {
356 struct net_device *rtw_alloc_etherdev_with_old_priv(int sizeof_priv,
358 struct net_device *rtw_alloc_etherdev(int sizeof_priv);
360 #define rtw_netdev_priv(netdev) \
361 (((struct rtw_netdev_priv_indicator *)netdev_priv(netdev))->priv)
362 void rtw_free_netdev(struct net_device *netdev);
364 #define NDEV_FMT "%s"
365 #define NDEV_ARG(ndev) ndev->name
366 #define ADPT_FMT "%s"
367 #define ADPT_ARG(adapter) adapter->pnetdev->name
368 #define FUNC_NDEV_FMT "%s(%s)"
369 #define FUNC_NDEV_ARG(ndev) __func__, ndev->name
370 #define FUNC_ADPT_FMT "%s(%s)"
371 #define FUNC_ADPT_ARG(adapter) __func__, adapter->pnetdev->name
373 #define rtw_signal_process(pid, sig) kill_pid(find_vpid((pid)),(sig), 1)
375 u64 rtw_modular64(u64 x, u64 y);
376 u64 rtw_division64(u64 x, u64 y);
378 /* Macros for handling unaligned memory accesses */
380 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
381 #define RTW_PUT_BE16(a, val) \
383 (a)[0] = ((u16) (val)) >> 8; \
384 (a)[1] = ((u16) (val)) & 0xff; \
387 #define RTW_PUT_LE16(a, val) \
389 (a)[1] = ((u16) (val)) >> 8; \
390 (a)[0] = ((u16) (val)) & 0xff; \
393 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
395 #define RTW_PUT_BE24(a, val) \
397 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff); \
398 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \
399 (a)[2] = (u8) (((u32) (val)) & 0xff); \
402 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
403 (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
404 #define RTW_PUT_BE32(a, val) \
406 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff); \
407 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff); \
408 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff); \
409 (a)[3] = (u8) (((u32) (val)) & 0xff); \
412 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
413 (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
414 #define RTW_PUT_LE32(a, val) \
416 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff); \
417 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff); \
418 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff); \
419 (a)[0] = (u8) (((u32) (val)) & 0xff); \
422 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
423 (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
424 (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
425 (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
426 #define RTW_PUT_BE64(a, val) \
428 (a)[0] = (u8) (((u64) (val)) >> 56); \
429 (a)[1] = (u8) (((u64) (val)) >> 48); \
430 (a)[2] = (u8) (((u64) (val)) >> 40); \
431 (a)[3] = (u8) (((u64) (val)) >> 32); \
432 (a)[4] = (u8) (((u64) (val)) >> 24); \
433 (a)[5] = (u8) (((u64) (val)) >> 16); \
434 (a)[6] = (u8) (((u64) (val)) >> 8); \
435 (a)[7] = (u8) (((u64) (val)) & 0xff); \
438 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
439 (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
440 (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
441 (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
443 void rtw_buf_update(u8 **buf, u32 *buf_len, u8 *src, u32 src_len);
452 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
453 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
454 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
455 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
456 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
457 int wifirate2_ratetbl_inx(unsigned char rate);