drivers/net/wireless/rockchip_wlan/rtl8723ds/include/osdep_service.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2013 Realtek Corporation. All rights reserved.
   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  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  *
  19  ******************************************************************************/
  20 #ifndef __OSDEP_SERVICE_H_
  21 #define __OSDEP_SERVICE_H_
  22
  23
  24 #define _FAIL           0
  25 #define _SUCCESS        1
  26 #define RTW_RX_HANDLED 2
  27 /* #define RTW_STATUS_TIMEDOUT -110 */
  28
  29 #undef _TRUE
  30 #define _TRUE           1
  31
  32 #undef _FALSE
  33 #define _FALSE          0
  34
  35
  36 #ifdef PLATFORM_FREEBSD
  37         #include <osdep_service_bsd.h>
  38 #endif
  39
  40 #ifdef PLATFORM_LINUX
  41         #include <osdep_service_linux.h>
  42 #endif
  43
  44 #ifdef PLATFORM_OS_XP
  45         #include <osdep_service_xp.h>
  46 #endif
  47
  48 #ifdef PLATFORM_OS_CE
  49         #include <osdep_service_ce.h>
  50 #endif
  51
  52 #define RTW_TIMER_HDL_NAME(name) rtw_##name##_timer_hdl
  53 #define RTW_DECLARE_TIMER_HDL(name) void RTW_TIMER_HDL_NAME(name)(RTW_TIMER_HDL_ARGS)
  54
  55 /* #include <rtw_byteorder.h> */
  56
  57 #ifndef BIT
  58         #define BIT(x)  (1 << (x))
  59 #endif
  60
  61 #define BIT0    0x00000001
  62 #define BIT1    0x00000002
  63 #define BIT2    0x00000004
  64 #define BIT3    0x00000008
  65 #define BIT4    0x00000010
  66 #define BIT5    0x00000020
  67 #define BIT6    0x00000040
  68 #define BIT7    0x00000080
  69 #define BIT8    0x00000100
  70 #define BIT9    0x00000200
  71 #define BIT10   0x00000400
  72 #define BIT11   0x00000800
  73 #define BIT12   0x00001000
  74 #define BIT13   0x00002000
  75 #define BIT14   0x00004000
  76 #define BIT15   0x00008000
  77 #define BIT16   0x00010000
  78 #define BIT17   0x00020000
  79 #define BIT18   0x00040000
  80 #define BIT19   0x00080000
  81 #define BIT20   0x00100000
  82 #define BIT21   0x00200000
  83 #define BIT22   0x00400000
  84 #define BIT23   0x00800000
  85 #define BIT24   0x01000000
  86 #define BIT25   0x02000000
  87 #define BIT26   0x04000000
  88 #define BIT27   0x08000000
  89 #define BIT28   0x10000000
  90 #define BIT29   0x20000000
  91 #define BIT30   0x40000000
  92 #define BIT31   0x80000000
  93 #define BIT32   0x0100000000
  94 #define BIT33   0x0200000000
  95 #define BIT34   0x0400000000
  96 #define BIT35   0x0800000000
  97 #define BIT36   0x1000000000
  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 #ifdef DBG_MEM_ALLOC
 135 void rtw_mstat_update(const enum mstat_f flags, const MSTAT_STATUS status, u32 sz);
 136 void rtw_mstat_dump(void *sel);
 137 u8 *dbg_rtw_vmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
 138 u8 *dbg_rtw_zvmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
 139 void dbg_rtw_vmfree(u8 *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
 140 u8 *dbg_rtw_malloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
 141 u8 *dbg_rtw_zmalloc(u32 sz, const enum mstat_f flags, const char *func, const int line);
 142 void dbg_rtw_mfree(u8 *pbuf, const enum mstat_f flags, u32 sz, const char *func, const int line);
 143
 144 struct sk_buff *dbg_rtw_skb_alloc(unsigned int size, const enum mstat_f flags, const char *func, const int line);
 145 void dbg_rtw_skb_free(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
 146 struct sk_buff *dbg_rtw_skb_copy(const struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
 147 struct sk_buff *dbg_rtw_skb_clone(struct sk_buff *skb, const enum mstat_f flags, const char *func, const int line);
 148 int dbg_rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
 149 #ifdef CONFIG_RTW_NAPI
 150 int dbg_rtw_netif_receive_skb(_nic_hdl ndev, struct sk_buff *skb, const enum mstat_f flags, const char *func, int line);
 151 #ifdef CONFIG_RTW_GRO
 152 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);
 153 #endif
 154 #endif /* CONFIG_RTW_NAPI */
 155 void dbg_rtw_skb_queue_purge(struct sk_buff_head *list, enum mstat_f flags, const char *func, int line);
 156 #ifdef CONFIG_USB_HCI
 157 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);
 158 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);
 159 #endif /* CONFIG_USB_HCI */
 160
 161 #ifdef CONFIG_USE_VMALLOC
 162 #define rtw_vmalloc(sz)                 dbg_rtw_vmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 163 #define rtw_zvmalloc(sz)                        dbg_rtw_zvmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 164 #define rtw_vmfree(pbuf, sz)            dbg_rtw_vmfree((pbuf), (sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 165 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_vmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 166 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zvmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 167 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_vmfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 168 #else /* CONFIG_USE_VMALLOC */
 169 #define rtw_vmalloc(sz)                 dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 170 #define rtw_zvmalloc(sz)                        dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 171 #define rtw_vmfree(pbuf, sz)            dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 172 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_malloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 173 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 174 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_mfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 175 #endif /* CONFIG_USE_VMALLOC */
 176 #define rtw_malloc(sz)                  dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 177 #define rtw_zmalloc(sz)                 dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 178 #define rtw_mfree(pbuf, sz)             dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 179 #define rtw_malloc_f(sz, mstat_f)                       dbg_rtw_malloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 180 #define rtw_zmalloc_f(sz, mstat_f)                      dbg_rtw_zmalloc((sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 181 #define rtw_mfree_f(pbuf, sz, mstat_f)          dbg_rtw_mfree((pbuf), (sz), ((mstat_f) & 0xff00) | MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 182
 183 #define rtw_skb_alloc(size)     dbg_rtw_skb_alloc((size), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 184 #define rtw_skb_free(skb)       dbg_rtw_skb_free((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 185 #define rtw_skb_alloc_f(size, mstat_f)  dbg_rtw_skb_alloc((size), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 186 #define rtw_skb_free_f(skb, mstat_f)    dbg_rtw_skb_free((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 187 #define rtw_skb_copy(skb)       dbg_rtw_skb_copy((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 188 #define rtw_skb_clone(skb)      dbg_rtw_skb_clone((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 189 #define rtw_skb_copy_f(skb, mstat_f)    dbg_rtw_skb_copy((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 190 #define rtw_skb_clone_f(skb, mstat_f)   dbg_rtw_skb_clone((skb), ((mstat_f) & 0xff00) | MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 191 #define rtw_netif_rx(ndev, skb) dbg_rtw_netif_rx(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 192 #ifdef CONFIG_RTW_NAPI
 193 #define rtw_netif_receive_skb(ndev, skb) dbg_rtw_netif_receive_skb(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 194 #ifdef CONFIG_RTW_GRO
 195 #define rtw_napi_gro_receive(napi, skb) dbg_rtw_napi_gro_receive(napi, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 196 #endif
 197 #endif /* CONFIG_RTW_NAPI */
 198 #define rtw_skb_queue_purge(sk_buff_head) dbg_rtw_skb_queue_purge(sk_buff_head, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 199 #ifdef CONFIG_USB_HCI
 200 #define rtw_usb_buffer_alloc(dev, size, dma)            dbg_rtw_usb_buffer_alloc((dev), (size), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
 201 #define rtw_usb_buffer_free(dev, size, addr, dma)       dbg_rtw_usb_buffer_free((dev), (size), (addr), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
 202 #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__)
 203 #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__)
 204 #endif /* CONFIG_USB_HCI */
 205
 206 #else /* DBG_MEM_ALLOC */
 207 #define rtw_mstat_update(flag, status, sz) do {} while (0)
 208 #define rtw_mstat_dump(sel) do {} while (0)
 209 u8 *_rtw_vmalloc(u32 sz);
 210 u8 *_rtw_zvmalloc(u32 sz);
 211 void    _rtw_vmfree(u8 *pbuf, u32 sz);
 212 u8 *_rtw_zmalloc(u32 sz);
 213 u8 *_rtw_malloc(u32 sz);
 214 void    _rtw_mfree(u8 *pbuf, u32 sz);
 215
 216 struct sk_buff *_rtw_skb_alloc(u32 sz);
 217 void _rtw_skb_free(struct sk_buff *skb);
 218 struct sk_buff *_rtw_skb_copy(const struct sk_buff *skb);
 219 struct sk_buff *_rtw_skb_clone(struct sk_buff *skb);
 220 int _rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb);
 221 #ifdef CONFIG_RTW_NAPI
 222 int _rtw_netif_receive_skb(_nic_hdl ndev, struct sk_buff *skb);
 223 #ifdef CONFIG_RTW_GRO
 224 gro_result_t _rtw_napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
 225 #endif
 226 #endif /* CONFIG_RTW_NAPI */
 227 void _rtw_skb_queue_purge(struct sk_buff_head *list);
 228
 229 #ifdef CONFIG_USB_HCI
 230 void *_rtw_usb_buffer_alloc(struct usb_device *dev, size_t size, dma_addr_t *dma);
 231 void _rtw_usb_buffer_free(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma);
 232 #endif /* CONFIG_USB_HCI */
 233
 234 #ifdef CONFIG_USE_VMALLOC
 235 #define rtw_vmalloc(sz)                 _rtw_vmalloc((sz))
 236 #define rtw_zvmalloc(sz)                        _rtw_zvmalloc((sz))
 237 #define rtw_vmfree(pbuf, sz)            _rtw_vmfree((pbuf), (sz))
 238 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_vmalloc((sz))
 239 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zvmalloc((sz))
 240 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_vmfree((pbuf), (sz))
 241 #else /* CONFIG_USE_VMALLOC */
 242 #define rtw_vmalloc(sz)                 _rtw_malloc((sz))
 243 #define rtw_zvmalloc(sz)                        _rtw_zmalloc((sz))
 244 #define rtw_vmfree(pbuf, sz)            _rtw_mfree((pbuf), (sz))
 245 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_malloc((sz))
 246 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zmalloc((sz))
 247 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_mfree((pbuf), (sz))
 248 #endif /* CONFIG_USE_VMALLOC */
 249 #define rtw_malloc(sz)                  _rtw_malloc((sz))
 250 #define rtw_zmalloc(sz)                 _rtw_zmalloc((sz))
 251 #define rtw_mfree(pbuf, sz)             _rtw_mfree((pbuf), (sz))
 252 #define rtw_malloc_f(sz, mstat_f)                       _rtw_malloc((sz))
 253 #define rtw_zmalloc_f(sz, mstat_f)                      _rtw_zmalloc((sz))
 254 #define rtw_mfree_f(pbuf, sz, mstat_f)          _rtw_mfree((pbuf), (sz))
 255
 256 #define rtw_skb_alloc(size) _rtw_skb_alloc((size))
 257 #define rtw_skb_free(skb) _rtw_skb_free((skb))
 258 #define rtw_skb_alloc_f(size, mstat_f)  _rtw_skb_alloc((size))
 259 #define rtw_skb_free_f(skb, mstat_f)    _rtw_skb_free((skb))
 260 #define rtw_skb_copy(skb)       _rtw_skb_copy((skb))
 261 #define rtw_skb_clone(skb)      _rtw_skb_clone((skb))
 262 #define rtw_skb_copy_f(skb, mstat_f)    _rtw_skb_copy((skb))
 263 #define rtw_skb_clone_f(skb, mstat_f)   _rtw_skb_clone((skb))
 264 #define rtw_netif_rx(ndev, skb) _rtw_netif_rx(ndev, skb)
 265 #ifdef CONFIG_RTW_NAPI
 266 #define rtw_netif_receive_skb(ndev, skb) _rtw_netif_receive_skb(ndev, skb)
 267 #ifdef CONFIG_RTW_GRO
 268 #define rtw_napi_gro_receive(napi, skb) _rtw_napi_gro_receive(napi, skb)
 269 #endif
 270 #endif /* CONFIG_RTW_NAPI */
 271 #define rtw_skb_queue_purge(sk_buff_head) _rtw_skb_queue_purge(sk_buff_head)
 272 #ifdef CONFIG_USB_HCI
 273 #define rtw_usb_buffer_alloc(dev, size, dma) _rtw_usb_buffer_alloc((dev), (size), (dma))
 274 #define rtw_usb_buffer_free(dev, size, addr, dma) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
 275 #define rtw_usb_buffer_alloc_f(dev, size, dma, mstat_f) _rtw_usb_buffer_alloc((dev), (size), (dma))
 276 #define rtw_usb_buffer_free_f(dev, size, addr, dma, mstat_f) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
 277 #endif /* CONFIG_USB_HCI */
 278 #endif /* DBG_MEM_ALLOC */
 279
 280 extern void     *rtw_malloc2d(int h, int w, size_t size);
 281 extern void     rtw_mfree2d(void *pbuf, int h, int w, int size);
 282
 283 extern void     _rtw_memcpy(void *dec, const void *sour, u32 sz);
 284 extern void _rtw_memmove(void *dst, const void *src, u32 sz);
 285 extern int      _rtw_memcmp(const void *dst, const void *src, u32 sz);
 286 extern void     _rtw_memset(void *pbuf, int c, u32 sz);
 287
 288 extern void     _rtw_init_listhead(_list *list);
 289 extern u32      rtw_is_list_empty(_list *phead);
 290 extern void     rtw_list_insert_head(_list *plist, _list *phead);
 291 extern void     rtw_list_insert_tail(_list *plist, _list *phead);
 292 #ifndef PLATFORM_FREEBSD
 293 extern void     rtw_list_delete(_list *plist);
 294 #endif /* PLATFORM_FREEBSD */
 295
 296 extern void     _rtw_init_sema(_sema *sema, int init_val);
 297 extern void     _rtw_free_sema(_sema    *sema);
 298 extern void     _rtw_up_sema(_sema      *sema);
 299 extern u32      _rtw_down_sema(_sema *sema);
 300 extern void     _rtw_mutex_init(_mutex *pmutex);
 301 extern void     _rtw_mutex_free(_mutex *pmutex);
 302 #ifndef PLATFORM_FREEBSD
 303 extern void     _rtw_spinlock_init(_lock *plock);
 304 #endif /* PLATFORM_FREEBSD */
 305 extern void     _rtw_spinlock_free(_lock *plock);
 306 extern void     _rtw_spinlock(_lock     *plock);
 307 extern void     _rtw_spinunlock(_lock   *plock);
 308 extern void     _rtw_spinlock_ex(_lock  *plock);
 309 extern void     _rtw_spinunlock_ex(_lock        *plock);
 310
 311 extern void     _rtw_init_queue(_queue *pqueue);
 312 extern void _rtw_deinit_queue(_queue *pqueue);
 313 extern u32      _rtw_queue_empty(_queue *pqueue);
 314 extern u32      rtw_end_of_queue_search(_list *queue, _list *pelement);
 315
 316 extern u32      rtw_get_current_time(void);
 317 extern u32      rtw_systime_to_ms(u32 systime);
 318 extern u32      rtw_ms_to_systime(u32 ms);
 319 extern s32      rtw_get_passing_time_ms(u32 start);
 320 extern s32      rtw_get_time_interval_ms(u32 start, u32 end);
 321
 322 extern void     rtw_sleep_schedulable(int ms);
 323
 324 extern void     rtw_msleep_os(int ms);
 325 extern void     rtw_usleep_os(int us);
 326
 327 extern u32      rtw_atoi(u8 *s);
 328
 329 #ifdef DBG_DELAY_OS
 330 #define rtw_mdelay_os(ms) _rtw_mdelay_os((ms), __FUNCTION__, __LINE__)
 331 #define rtw_udelay_os(ms) _rtw_udelay_os((ms), __FUNCTION__, __LINE__)
 332 extern void _rtw_mdelay_os(int ms, const char *func, const int line);
 333 extern void _rtw_udelay_os(int us, const char *func, const int line);
 334 #else
 335 extern void     rtw_mdelay_os(int ms);
 336 extern void     rtw_udelay_os(int us);
 337 #endif
 338
 339 extern void rtw_yield_os(void);
 340
 341
 342 extern void rtw_init_timer(_timer *ptimer, void *padapter, void *pfunc);
 343
 344
 345 __inline static unsigned char _cancel_timer_ex(_timer *ptimer)
 346 {
 347 #ifdef PLATFORM_LINUX
 348         return del_timer_sync(ptimer);
 349 #endif
 350 #ifdef PLATFORM_FREEBSD
 351         _cancel_timer(ptimer, 0);
 352         return 0;
 353 #endif
 354 #ifdef PLATFORM_WINDOWS
 355         u8 bcancelled;
 356
 357         _cancel_timer(ptimer, &bcancelled);
 358
 359         return bcancelled;
 360 #endif
 361 }
 362
 363 static __inline void thread_enter(char *name)
 364 {
 365 #ifdef PLATFORM_LINUX
 366 #if (LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0))
 367         daemonize("%s", name);
 368 #endif
 369         allow_signal(SIGTERM);
 370 #endif
 371 #ifdef PLATFORM_FREEBSD
 372         printf("%s", "RTKTHREAD_enter");
 373 #endif
 374 }
 375
 376 __inline static void flush_signals_thread(void)
 377 {
 378 #ifdef PLATFORM_LINUX
 379         if (signal_pending(current))
 380                 flush_signals(current);
 381 #endif
 382 }
 383
 384 __inline static _OS_STATUS res_to_status(sint res)
 385 {
 386
 387 #if defined(PLATFORM_LINUX) || defined (PLATFORM_MPIXEL) || defined (PLATFORM_FREEBSD)
 388         return res;
 389 #endif
 390
 391 #ifdef PLATFORM_WINDOWS
 392
 393         if (res == _SUCCESS)
 394                 return NDIS_STATUS_SUCCESS;
 395         else
 396                 return NDIS_STATUS_FAILURE;
 397
 398 #endif
 399
 400 }
 401
 402 __inline static void rtw_dump_stack(void)
 403 {
 404 #ifdef PLATFORM_LINUX
 405         dump_stack();
 406 #endif
 407 }
 408
 409 #ifdef PLATFORM_LINUX
 410 #define rtw_warn_on(condition) WARN_ON(condition)
 411 #else
 412 #define rtw_warn_on(condition) do {} while (0)
 413 #endif
 414
 415 __inline static int rtw_bug_check(void *parg1, void *parg2, void *parg3, void *parg4)
 416 {
 417         int ret = _TRUE;
 418
 419 #ifdef PLATFORM_WINDOWS
 420         if (((uint)parg1) <= 0x7fffffff ||
 421             ((uint)parg2) <= 0x7fffffff ||
 422             ((uint)parg3) <= 0x7fffffff ||
 423             ((uint)parg4) <= 0x7fffffff) {
 424                 ret = _FALSE;
 425                 KeBugCheckEx(0x87110000, (ULONG_PTR)parg1, (ULONG_PTR)parg2, (ULONG_PTR)parg3, (ULONG_PTR)parg4);
 426         }
 427 #endif
 428
 429         return ret;
 430
 431 }
 432
 433 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
 434 #define RND4(x) (((x >> 2) + (((x & 3) == 0) ? 0 : 1)) << 2)
 435
 436 __inline static u32 _RND4(u32 sz)
 437 {
 438
 439         u32     val;
 440
 441         val = ((sz >> 2) + ((sz & 3) ? 1 : 0)) << 2;
 442
 443         return val;
 444
 445 }
 446
 447 __inline static u32 _RND8(u32 sz)
 448 {
 449
 450         u32     val;
 451
 452         val = ((sz >> 3) + ((sz & 7) ? 1 : 0)) << 3;
 453
 454         return val;
 455
 456 }
 457
 458 __inline static u32 _RND128(u32 sz)
 459 {
 460
 461         u32     val;
 462
 463         val = ((sz >> 7) + ((sz & 127) ? 1 : 0)) << 7;
 464
 465         return val;
 466
 467 }
 468
 469 __inline static u32 _RND256(u32 sz)
 470 {
 471
 472         u32     val;
 473
 474         val = ((sz >> 8) + ((sz & 255) ? 1 : 0)) << 8;
 475
 476         return val;
 477
 478 }
 479
 480 __inline static u32 _RND512(u32 sz)
 481 {
 482
 483         u32     val;
 484
 485         val = ((sz >> 9) + ((sz & 511) ? 1 : 0)) << 9;
 486
 487         return val;
 488
 489 }
 490
 491 __inline static u32 bitshift(u32 bitmask)
 492 {
 493         u32 i;
 494
 495         for (i = 0; i <= 31; i++)
 496                 if (((bitmask >> i) &  0x1) == 1)
 497                         break;
 498
 499         return i;
 500 }
 501
 502 static inline int largest_bit(u32 bitmask)
 503 {
 504         int i;
 505
 506         for (i = 31; i >= 0; i--)
 507                 if (bitmask & BIT(i))
 508                         break;
 509
 510         return i;
 511 }
 512
 513 #define rtw_min(a, b) ((a > b) ? b : a)
 514 #define rtw_is_range_a_in_b(hi_a, lo_a, hi_b, lo_b) (((hi_a) <= (hi_b)) && ((lo_a) >= (lo_b)))
 515 #define rtw_is_range_overlap(hi_a, lo_a, hi_b, lo_b) (((hi_a) > (lo_b)) && ((lo_a) < (hi_b)))
 516
 517 #ifndef MAC_FMT
 518 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
 519 #endif
 520 #ifndef MAC_ARG
 521 #define MAC_ARG(x) ((u8 *)(x))[0], ((u8 *)(x))[1], ((u8 *)(x))[2], ((u8 *)(x))[3], ((u8 *)(x))[4], ((u8 *)(x))[5]
 522 #endif
 523
 524
 525 extern void rtw_suspend_lock_init(void);
 526 extern void rtw_suspend_lock_uninit(void);
 527 extern void rtw_lock_suspend(void);
 528 extern void rtw_unlock_suspend(void);
 529 extern void rtw_lock_suspend_timeout(u32 timeout_ms);
 530 extern void rtw_lock_ext_suspend_timeout(u32 timeout_ms);
 531 extern void rtw_lock_rx_suspend_timeout(u32 timeout_ms);
 532 extern void rtw_lock_traffic_suspend_timeout(u32 timeout_ms);
 533 extern void rtw_lock_resume_scan_timeout(u32 timeout_ms);
 534 extern void rtw_resume_lock_suspend(void);
 535 extern void rtw_resume_unlock_suspend(void);
 536 #ifdef CONFIG_AP_WOWLAN
 537 extern void rtw_softap_lock_suspend(void);
 538 extern void rtw_softap_unlock_suspend(void);
 539 #endif
 540
 541 extern void ATOMIC_SET(ATOMIC_T *v, int i);
 542 extern int ATOMIC_READ(ATOMIC_T *v);
 543 extern void ATOMIC_ADD(ATOMIC_T *v, int i);
 544 extern void ATOMIC_SUB(ATOMIC_T *v, int i);
 545 extern void ATOMIC_INC(ATOMIC_T *v);
 546 extern void ATOMIC_DEC(ATOMIC_T *v);
 547 extern int ATOMIC_ADD_RETURN(ATOMIC_T *v, int i);
 548 extern int ATOMIC_SUB_RETURN(ATOMIC_T *v, int i);
 549 extern int ATOMIC_INC_RETURN(ATOMIC_T *v);
 550 extern int ATOMIC_DEC_RETURN(ATOMIC_T *v);
 551
 552 /* File operation APIs, just for linux now */
 553 extern int rtw_is_file_readable(const char *path);
 554 extern int rtw_is_file_readable_with_size(const char *path, u32 *sz);
 555 extern int rtw_retrieve_from_file(const char *path, u8 *buf, u32 sz);
 556 extern int rtw_store_to_file(const char *path, u8 *buf, u32 sz);
 557
 558
 559 #ifndef PLATFORM_FREEBSD
 560 extern void rtw_free_netdev(struct net_device *netdev);
 561 #endif /* PLATFORM_FREEBSD */
 562
 563
 564 extern u64 rtw_modular64(u64 x, u64 y);
 565 extern u64 rtw_division64(u64 x, u64 y);
 566 extern u32 rtw_random32(void);
 567
 568 /* Macros for handling unaligned memory accesses */
 569
 570 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
 571 #define RTW_PUT_BE16(a, val)                    \
 572         do {                                    \
 573                 (a)[0] = ((u16) (val)) >> 8;    \
 574                 (a)[1] = ((u16) (val)) & 0xff;  \
 575         } while (0)
 576
 577 #define RTW_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0]))
 578 #define RTW_PUT_LE16(a, val)                    \
 579         do {                                    \
 580                 (a)[1] = ((u16) (val)) >> 8;    \
 581                 (a)[0] = ((u16) (val)) & 0xff;  \
 582         } while (0)
 583
 584 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
 585                          ((u32) (a)[2]))
 586 #define RTW_PUT_BE24(a, val)                                    \
 587         do {                                                    \
 588                 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 589                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 590                 (a)[2] = (u8) (((u32) (val)) & 0xff);           \
 591         } while (0)
 592
 593 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
 594                          (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
 595 #define RTW_PUT_BE32(a, val)                                    \
 596         do {                                                    \
 597                 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
 598                 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 599                 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 600                 (a)[3] = (u8) (((u32) (val)) & 0xff);           \
 601         } while (0)
 602
 603 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
 604                          (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
 605 #define RTW_PUT_LE32(a, val)                                    \
 606         do {                                                    \
 607                 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
 608                 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 609                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 610                 (a)[0] = (u8) (((u32) (val)) & 0xff);           \
 611         } while (0)
 612
 613 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
 614                          (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
 615                          (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
 616                          (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
 617 #define RTW_PUT_BE64(a, val)                            \
 618         do {                                            \
 619                 (a)[0] = (u8) (((u64) (val)) >> 56);    \
 620                 (a)[1] = (u8) (((u64) (val)) >> 48);    \
 621                 (a)[2] = (u8) (((u64) (val)) >> 40);    \
 622                 (a)[3] = (u8) (((u64) (val)) >> 32);    \
 623                 (a)[4] = (u8) (((u64) (val)) >> 24);    \
 624                 (a)[5] = (u8) (((u64) (val)) >> 16);    \
 625                 (a)[6] = (u8) (((u64) (val)) >> 8);     \
 626                 (a)[7] = (u8) (((u64) (val)) & 0xff);   \
 627         } while (0)
 628
 629 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
 630                          (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
 631                          (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
 632                          (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
 633
 634 void rtw_buf_free(u8 **buf, u32 *buf_len);
 635 void rtw_buf_update(u8 **buf, u32 *buf_len, u8 *src, u32 src_len);
 636
 637 struct rtw_cbuf {
 638         u32 write;
 639         u32 read;
 640         u32 size;
 641         void *bufs[0];
 642 };
 643
 644 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
 645 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
 646 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
 647 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
 648 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
 649 void rtw_cbuf_free(struct rtw_cbuf *cbuf);
 650
 651 struct map_seg_t {
 652         u16 sa;
 653         u16 len;
 654         u8 *c;
 655 };
 656
 657 struct map_t {
 658         u16 len;
 659         u16 seg_num;
 660         u8 init_value;
 661         struct map_seg_t *segs;
 662 };
 663
 664 #define MAPSEG_ARRAY_ENT(_sa, _len, _c, arg...) \
 665         { .sa = _sa, .len = _len, .c = (u8[_len]){ _c, ##arg}, }
 666
 667 #define MAPSEG_PTR_ENT(_sa, _len, _p) \
 668         { .sa = _sa, .len = _len, .c = _p, }
 669
 670 #define MAP_ENT(_len, _seg_num, _init_v, _seg, arg...) \
 671         { .len = _len, .seg_num = _seg_num, .init_value = _init_v, .segs = (struct map_seg_t[_seg_num]){ _seg, ##arg}, }
 672
 673 int map_readN(const struct map_t *map, u16 offset, u16 len, u8 *buf);
 674 u8 map_read8(const struct map_t *map, u16 offset);
 675
 676 /* String handler */
 677
 678 BOOLEAN is_null(char c);
 679 BOOLEAN is_eol(char c);
 680 BOOLEAN is_space(char c);
 681 BOOLEAN IsHexDigit(char chTmp);
 682 BOOLEAN is_alpha(char chTmp);
 683 char alpha_to_upper(char c);
 684
 685 /*
 686  * Write formatted output to sized buffer
 687  */
 688 #ifdef PLATFORM_LINUX
 689 #define rtw_sprintf(buf, size, format, arg...)  snprintf(buf, size, format, ##arg)
 690 #else /* !PLATFORM_LINUX */
 691 #error "NOT DEFINE \"rtw_sprintf\"!!"
 692 #endif /* !PLATFORM_LINUX */
 693
 694 #endif