drivers/net/wireless/rockchip_wlan/rtl8723bs/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 void dbg_rtw_skb_queue_purge(struct sk_buff_head *list, enum mstat_f flags, const char *func, int line);
 150 #ifdef CONFIG_USB_HCI
 151 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);
 152 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);
 153 #endif /* CONFIG_USB_HCI */
 154
 155 #ifdef CONFIG_USE_VMALLOC
 156 #define rtw_vmalloc(sz)                 dbg_rtw_vmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 157 #define rtw_zvmalloc(sz)                        dbg_rtw_zvmalloc((sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 158 #define rtw_vmfree(pbuf, sz)            dbg_rtw_vmfree((pbuf), (sz), MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 159 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_vmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 160 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zvmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 161 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_vmfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_VIR, __FUNCTION__, __LINE__)
 162 #else /* CONFIG_USE_VMALLOC */
 163 #define rtw_vmalloc(sz)                 dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 164 #define rtw_zvmalloc(sz)                        dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 165 #define rtw_vmfree(pbuf, sz)            dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 166 #define rtw_vmalloc_f(sz, mstat_f)                      dbg_rtw_malloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 167 #define rtw_zvmalloc_f(sz, mstat_f)             dbg_rtw_zmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 168 #define rtw_vmfree_f(pbuf, sz, mstat_f) dbg_rtw_mfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 169 #endif /* CONFIG_USE_VMALLOC */
 170 #define rtw_malloc(sz)                  dbg_rtw_malloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 171 #define rtw_zmalloc(sz)                 dbg_rtw_zmalloc((sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 172 #define rtw_mfree(pbuf, sz)             dbg_rtw_mfree((pbuf), (sz), MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 173 #define rtw_malloc_f(sz, mstat_f)                       dbg_rtw_malloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 174 #define rtw_zmalloc_f(sz, mstat_f)                      dbg_rtw_zmalloc((sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 175 #define rtw_mfree_f(pbuf, sz, mstat_f)          dbg_rtw_mfree((pbuf), (sz), ((mstat_f)&0xff00)|MSTAT_TYPE_PHY, __FUNCTION__, __LINE__)
 176
 177 #define rtw_skb_alloc(size)     dbg_rtw_skb_alloc((size), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 178 #define rtw_skb_free(skb)       dbg_rtw_skb_free((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 179 #define rtw_skb_alloc_f(size, mstat_f)  dbg_rtw_skb_alloc((size), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 180 #define rtw_skb_free_f(skb, mstat_f)    dbg_rtw_skb_free((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 181 #define rtw_skb_copy(skb)       dbg_rtw_skb_copy((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 182 #define rtw_skb_clone(skb)      dbg_rtw_skb_clone((skb), MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 183 #define rtw_skb_copy_f(skb, mstat_f)    dbg_rtw_skb_copy((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 184 #define rtw_skb_clone_f(skb, mstat_f)   dbg_rtw_skb_clone((skb), ((mstat_f)&0xff00)|MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 185 #define rtw_netif_rx(ndev, skb) dbg_rtw_netif_rx(ndev, skb, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 186 #define rtw_skb_queue_purge(sk_buff_head) dbg_rtw_skb_queue_purge(sk_buff_head, MSTAT_TYPE_SKB, __FUNCTION__, __LINE__)
 187 #ifdef CONFIG_USB_HCI
 188 #define rtw_usb_buffer_alloc(dev, size, dma)            dbg_rtw_usb_buffer_alloc((dev), (size), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
 189 #define rtw_usb_buffer_free(dev, size, addr, dma)       dbg_rtw_usb_buffer_free((dev), (size), (addr), (dma), MSTAT_TYPE_USB, __FUNCTION__, __LINE__)
 190 #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__)
 191 #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__)
 192 #endif /* CONFIG_USB_HCI */
 193
 194 #else /* DBG_MEM_ALLOC */
 195 #define rtw_mstat_update(flag, status, sz) do {} while(0)
 196 #define rtw_mstat_dump(sel) do {} while(0)
 197 u8*     _rtw_vmalloc(u32 sz);
 198 u8*     _rtw_zvmalloc(u32 sz);
 199 void    _rtw_vmfree(u8 *pbuf, u32 sz);
 200 u8*     _rtw_zmalloc(u32 sz);
 201 u8*     _rtw_malloc(u32 sz);
 202 void    _rtw_mfree(u8 *pbuf, u32 sz);
 203
 204 struct sk_buff *_rtw_skb_alloc(u32 sz);
 205 void _rtw_skb_free(struct sk_buff *skb);
 206 struct sk_buff *_rtw_skb_copy(const struct sk_buff *skb);
 207 struct sk_buff *_rtw_skb_clone(struct sk_buff *skb);
 208 int _rtw_netif_rx(_nic_hdl ndev, struct sk_buff *skb);
 209 void _rtw_skb_queue_purge(struct sk_buff_head *list);
 210
 211 #ifdef CONFIG_USB_HCI
 212 void *_rtw_usb_buffer_alloc(struct usb_device *dev, size_t size, dma_addr_t *dma);
 213 void _rtw_usb_buffer_free(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma);
 214 #endif /* CONFIG_USB_HCI */
 215
 216 #ifdef CONFIG_USE_VMALLOC
 217 #define rtw_vmalloc(sz)                 _rtw_vmalloc((sz))
 218 #define rtw_zvmalloc(sz)                        _rtw_zvmalloc((sz))
 219 #define rtw_vmfree(pbuf, sz)            _rtw_vmfree((pbuf), (sz))
 220 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_vmalloc((sz))
 221 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zvmalloc((sz))
 222 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_vmfree((pbuf), (sz))
 223 #else /* CONFIG_USE_VMALLOC */
 224 #define rtw_vmalloc(sz)                 _rtw_malloc((sz))
 225 #define rtw_zvmalloc(sz)                        _rtw_zmalloc((sz))
 226 #define rtw_vmfree(pbuf, sz)            _rtw_mfree((pbuf), (sz))
 227 #define rtw_vmalloc_f(sz, mstat_f)                      _rtw_malloc((sz))
 228 #define rtw_zvmalloc_f(sz, mstat_f)             _rtw_zmalloc((sz))
 229 #define rtw_vmfree_f(pbuf, sz, mstat_f) _rtw_mfree((pbuf), (sz))
 230 #endif /* CONFIG_USE_VMALLOC */
 231 #define rtw_malloc(sz)                  _rtw_malloc((sz))
 232 #define rtw_zmalloc(sz)                 _rtw_zmalloc((sz))
 233 #define rtw_mfree(pbuf, sz)             _rtw_mfree((pbuf), (sz))
 234 #define rtw_malloc_f(sz, mstat_f)                       _rtw_malloc((sz))
 235 #define rtw_zmalloc_f(sz, mstat_f)                      _rtw_zmalloc((sz))
 236 #define rtw_mfree_f(pbuf, sz, mstat_f)          _rtw_mfree((pbuf), (sz))
 237
 238 #define rtw_skb_alloc(size) _rtw_skb_alloc((size))
 239 #define rtw_skb_free(skb) _rtw_skb_free((skb))
 240 #define rtw_skb_alloc_f(size, mstat_f)  _rtw_skb_alloc((size))
 241 #define rtw_skb_free_f(skb, mstat_f)    _rtw_skb_free((skb))
 242 #define rtw_skb_copy(skb)       _rtw_skb_copy((skb))
 243 #define rtw_skb_clone(skb)      _rtw_skb_clone((skb))
 244 #define rtw_skb_copy_f(skb, mstat_f)    _rtw_skb_copy((skb))
 245 #define rtw_skb_clone_f(skb, mstat_f)   _rtw_skb_clone((skb))
 246 #define rtw_netif_rx(ndev, skb) _rtw_netif_rx(ndev, skb)
 247 #define rtw_skb_queue_purge(sk_buff_head) _rtw_skb_queue_purge(sk_buff_head)
 248 #ifdef CONFIG_USB_HCI
 249 #define rtw_usb_buffer_alloc(dev, size, dma) _rtw_usb_buffer_alloc((dev), (size), (dma))
 250 #define rtw_usb_buffer_free(dev, size, addr, dma) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
 251 #define rtw_usb_buffer_alloc_f(dev, size, dma, mstat_f) _rtw_usb_buffer_alloc((dev), (size), (dma))
 252 #define rtw_usb_buffer_free_f(dev, size, addr, dma, mstat_f) _rtw_usb_buffer_free((dev), (size), (addr), (dma))
 253 #endif /* CONFIG_USB_HCI */
 254 #endif /* DBG_MEM_ALLOC */
 255
 256 extern void*    rtw_malloc2d(int h, int w, size_t size);
 257 extern void     rtw_mfree2d(void *pbuf, int h, int w, int size);
 258
 259 extern void     _rtw_memcpy(void* dec, void* sour, u32 sz);
 260 extern int      _rtw_memcmp(void *dst, void *src, u32 sz);
 261 extern void     _rtw_memset(void *pbuf, int c, u32 sz);
 262
 263 extern void     _rtw_init_listhead(_list *list);
 264 extern u32      rtw_is_list_empty(_list *phead);
 265 extern void     rtw_list_insert_head(_list *plist, _list *phead);
 266 extern void     rtw_list_insert_tail(_list *plist, _list *phead);
 267 #ifndef PLATFORM_FREEBSD
 268 extern void     rtw_list_delete(_list *plist);
 269 #endif //PLATFORM_FREEBSD
 270
 271 extern void     _rtw_init_sema(_sema *sema, int init_val);
 272 extern void     _rtw_free_sema(_sema    *sema);
 273 extern void     _rtw_up_sema(_sema      *sema);
 274 extern u32      _rtw_down_sema(_sema *sema);
 275 extern void     _rtw_mutex_init(_mutex *pmutex);
 276 extern void     _rtw_mutex_free(_mutex *pmutex);
 277 #ifndef PLATFORM_FREEBSD
 278 extern void     _rtw_spinlock_init(_lock *plock);
 279 #endif //PLATFORM_FREEBSD
 280 extern void     _rtw_spinlock_free(_lock *plock);
 281 extern void     _rtw_spinlock(_lock     *plock);
 282 extern void     _rtw_spinunlock(_lock   *plock);
 283 extern void     _rtw_spinlock_ex(_lock  *plock);
 284 extern void     _rtw_spinunlock_ex(_lock        *plock);
 285
 286 extern void     _rtw_init_queue(_queue  *pqueue);
 287 extern u32      _rtw_queue_empty(_queue *pqueue);
 288 extern u32      rtw_end_of_queue_search(_list *queue, _list *pelement);
 289
 290 extern u32      rtw_get_current_time(void);
 291 extern u32      rtw_systime_to_ms(u32 systime);
 292 extern u32      rtw_ms_to_systime(u32 ms);
 293 extern s32      rtw_get_passing_time_ms(u32 start);
 294 extern s32      rtw_get_time_interval_ms(u32 start, u32 end);
 295
 296 extern void     rtw_sleep_schedulable(int ms);
 297
 298 extern void     rtw_msleep_os(int ms);
 299 extern void     rtw_usleep_os(int us);
 300
 301 extern u32      rtw_atoi(u8* s);
 302
 303 #ifdef DBG_DELAY_OS
 304 #define rtw_mdelay_os(ms) _rtw_mdelay_os((ms), __FUNCTION__, __LINE__)
 305 #define rtw_udelay_os(ms) _rtw_udelay_os((ms), __FUNCTION__, __LINE__)
 306 extern void _rtw_mdelay_os(int ms, const char *func, const int line);
 307 extern void _rtw_udelay_os(int us, const char *func, const int line);
 308 #else
 309 extern void     rtw_mdelay_os(int ms);
 310 extern void     rtw_udelay_os(int us);
 311 #endif
 312
 313 extern void rtw_yield_os(void);
 314
 315
 316 extern void rtw_init_timer(_timer *ptimer, void *padapter, void *pfunc);
 317
 318
 319 __inline static unsigned char _cancel_timer_ex(_timer *ptimer)
 320 {
 321 #ifdef PLATFORM_LINUX
 322         return del_timer_sync(ptimer);
 323 #endif
 324 #ifdef PLATFORM_FREEBSD
 325         _cancel_timer(ptimer,0);
 326         return 0;
 327 #endif
 328 #ifdef PLATFORM_WINDOWS
 329         u8 bcancelled;
 330
 331         _cancel_timer(ptimer, &bcancelled);
 332
 333         return bcancelled;
 334 #endif
 335 }
 336
 337 static __inline void thread_enter(char *name)
 338 {
 339 #ifdef PLATFORM_LINUX
 340         #if (LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0))
 341         daemonize("%s", name);
 342         #endif
 343         allow_signal(SIGTERM);
 344 #endif
 345 #ifdef PLATFORM_FREEBSD
 346         printf("%s", "RTKTHREAD_enter");
 347 #endif
 348 }
 349
 350 __inline static void flush_signals_thread(void)
 351 {
 352 #ifdef PLATFORM_LINUX
 353         if (signal_pending (current))
 354         {
 355                 flush_signals(current);
 356         }
 357 #endif
 358 }
 359
 360 __inline static _OS_STATUS res_to_status(sint res)
 361 {
 362
 363 #if defined (PLATFORM_LINUX) || defined (PLATFORM_MPIXEL) || defined (PLATFORM_FREEBSD)
 364         return res;
 365 #endif
 366
 367 #ifdef PLATFORM_WINDOWS
 368
 369         if (res == _SUCCESS)
 370                 return NDIS_STATUS_SUCCESS;
 371         else
 372                 return NDIS_STATUS_FAILURE;
 373
 374 #endif
 375
 376 }
 377
 378 __inline static void rtw_dump_stack(void)
 379 {
 380 #ifdef PLATFORM_LINUX
 381         dump_stack();
 382 #endif
 383 }
 384
 385 #ifdef PLATFORM_LINUX
 386 #define rtw_warn_on(condition) WARN_ON(condition)
 387 #else
 388 #define rtw_warn_on(condition) do {} while (0)
 389 #endif
 390
 391 __inline static int rtw_bug_check(void *parg1, void *parg2, void *parg3, void *parg4)
 392 {
 393         int ret = _TRUE;
 394
 395 #ifdef PLATFORM_WINDOWS
 396         if ( ((uint)parg1) <= 0x7fffffff ||
 397                 ((uint)parg2) <= 0x7fffffff ||
 398                 ((uint)parg3) <= 0x7fffffff ||
 399                 ((uint)parg4) <= 0x7fffffff)
 400         {
 401                 ret = _FALSE;
 402                 KeBugCheckEx(0x87110000, (ULONG_PTR)parg1, (ULONG_PTR)parg2, (ULONG_PTR)parg3, (ULONG_PTR)parg4);
 403         }
 404 #endif
 405
 406         return ret;
 407
 408 }
 409
 410 #define _RND(sz, r) ((((sz)+((r)-1))/(r))*(r))
 411 #define RND4(x) (((x >> 2) + (((x & 3) == 0) ?  0: 1)) << 2)
 412
 413 __inline static u32 _RND4(u32 sz)
 414 {
 415
 416         u32     val;
 417
 418         val = ((sz >> 2) + ((sz & 3) ? 1: 0)) << 2;
 419
 420         return val;
 421
 422 }
 423
 424 __inline static u32 _RND8(u32 sz)
 425 {
 426
 427         u32     val;
 428
 429         val = ((sz >> 3) + ((sz & 7) ? 1: 0)) << 3;
 430
 431         return val;
 432
 433 }
 434
 435 __inline static u32 _RND128(u32 sz)
 436 {
 437
 438         u32     val;
 439
 440         val = ((sz >> 7) + ((sz & 127) ? 1: 0)) << 7;
 441
 442         return val;
 443
 444 }
 445
 446 __inline static u32 _RND256(u32 sz)
 447 {
 448
 449         u32     val;
 450
 451         val = ((sz >> 8) + ((sz & 255) ? 1: 0)) << 8;
 452
 453         return val;
 454
 455 }
 456
 457 __inline static u32 _RND512(u32 sz)
 458 {
 459
 460         u32     val;
 461
 462         val = ((sz >> 9) + ((sz & 511) ? 1: 0)) << 9;
 463
 464         return val;
 465
 466 }
 467
 468 __inline static u32 bitshift(u32 bitmask)
 469 {
 470         u32 i;
 471
 472         for (i = 0; i <= 31; i++)
 473                 if (((bitmask>>i) &  0x1) == 1) break;
 474
 475         return i;
 476 }
 477
 478 #define rtw_min(a, b) ((a>b)?b:a)
 479
 480 #ifndef MAC_FMT
 481 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
 482 #endif
 483 #ifndef MAC_ARG
 484 #define MAC_ARG(x) ((u8*)(x))[0],((u8*)(x))[1],((u8*)(x))[2],((u8*)(x))[3],((u8*)(x))[4],((u8*)(x))[5]
 485 #endif
 486
 487
 488 extern void rtw_suspend_lock_init(void);
 489 extern void rtw_suspend_lock_uninit(void);
 490 extern void rtw_lock_suspend(void);
 491 extern void rtw_unlock_suspend(void);
 492 extern void rtw_lock_suspend_timeout(u32 timeout_ms);
 493 extern void rtw_lock_ext_suspend_timeout(u32 timeout_ms);
 494 extern void rtw_lock_rx_suspend_timeout(u32 timeout_ms);
 495 extern void rtw_lock_traffic_suspend_timeout(u32 timeout_ms);
 496 extern void rtw_lock_resume_scan_timeout(u32 timeout_ms);
 497 extern void rtw_resume_lock_suspend(void);
 498 extern void rtw_resume_unlock_suspend(void);
 499 #ifdef CONFIG_AP_WOWLAN
 500 extern void rtw_softap_lock_suspend(void);
 501 extern void rtw_softap_unlock_suspend(void);
 502 #endif
 503
 504 extern void ATOMIC_SET(ATOMIC_T *v, int i);
 505 extern int ATOMIC_READ(ATOMIC_T *v);
 506 extern void ATOMIC_ADD(ATOMIC_T *v, int i);
 507 extern void ATOMIC_SUB(ATOMIC_T *v, int i);
 508 extern void ATOMIC_INC(ATOMIC_T *v);
 509 extern void ATOMIC_DEC(ATOMIC_T *v);
 510 extern int ATOMIC_ADD_RETURN(ATOMIC_T *v, int i);
 511 extern int ATOMIC_SUB_RETURN(ATOMIC_T *v, int i);
 512 extern int ATOMIC_INC_RETURN(ATOMIC_T *v);
 513 extern int ATOMIC_DEC_RETURN(ATOMIC_T *v);
 514
 515 //File operation APIs, just for linux now
 516 extern int rtw_is_file_readable(char *path);
 517 extern int rtw_retrive_from_file(char *path, u8* buf, u32 sz);
 518 extern int rtw_store_to_file(char *path, u8* buf, u32 sz);
 519
 520
 521 #ifndef PLATFORM_FREEBSD
 522 extern void rtw_free_netdev(struct net_device * netdev);
 523 #endif //PLATFORM_FREEBSD
 524
 525
 526 extern u64 rtw_modular64(u64 x, u64 y);
 527 extern u64 rtw_division64(u64 x, u64 y);
 528 extern u32 rtw_random32(void);
 529
 530 /* Macros for handling unaligned memory accesses */
 531
 532 #define RTW_GET_BE16(a) ((u16) (((a)[0] << 8) | (a)[1]))
 533 #define RTW_PUT_BE16(a, val)                    \
 534         do {                                    \
 535                 (a)[0] = ((u16) (val)) >> 8;    \
 536                 (a)[1] = ((u16) (val)) & 0xff;  \
 537         } while (0)
 538
 539 #define RTW_GET_LE16(a) ((u16) (((a)[1] << 8) | (a)[0]))
 540 #define RTW_PUT_LE16(a, val)                    \
 541         do {                                    \
 542                 (a)[1] = ((u16) (val)) >> 8;    \
 543                 (a)[0] = ((u16) (val)) & 0xff;  \
 544         } while (0)
 545
 546 #define RTW_GET_BE24(a) ((((u32) (a)[0]) << 16) | (((u32) (a)[1]) << 8) | \
 547                          ((u32) (a)[2]))
 548 #define RTW_PUT_BE24(a, val)                                    \
 549         do {                                                    \
 550                 (a)[0] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 551                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 552                 (a)[2] = (u8) (((u32) (val)) & 0xff);           \
 553         } while (0)
 554
 555 #define RTW_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
 556                          (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
 557 #define RTW_PUT_BE32(a, val)                                    \
 558         do {                                                    \
 559                 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
 560                 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 561                 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 562                 (a)[3] = (u8) (((u32) (val)) & 0xff);           \
 563         } while (0)
 564
 565 #define RTW_GET_LE32(a) ((((u32) (a)[3]) << 24) | (((u32) (a)[2]) << 16) | \
 566                          (((u32) (a)[1]) << 8) | ((u32) (a)[0]))
 567 #define RTW_PUT_LE32(a, val)                                    \
 568         do {                                                    \
 569                 (a)[3] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
 570                 (a)[2] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 571                 (a)[1] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 572                 (a)[0] = (u8) (((u32) (val)) & 0xff);           \
 573         } while (0)
 574
 575 #define RTW_GET_BE64(a) ((((u64) (a)[0]) << 56) | (((u64) (a)[1]) << 48) | \
 576                          (((u64) (a)[2]) << 40) | (((u64) (a)[3]) << 32) | \
 577                          (((u64) (a)[4]) << 24) | (((u64) (a)[5]) << 16) | \
 578                          (((u64) (a)[6]) << 8) | ((u64) (a)[7]))
 579 #define RTW_PUT_BE64(a, val)                            \
 580         do {                                            \
 581                 (a)[0] = (u8) (((u64) (val)) >> 56);    \
 582                 (a)[1] = (u8) (((u64) (val)) >> 48);    \
 583                 (a)[2] = (u8) (((u64) (val)) >> 40);    \
 584                 (a)[3] = (u8) (((u64) (val)) >> 32);    \
 585                 (a)[4] = (u8) (((u64) (val)) >> 24);    \
 586                 (a)[5] = (u8) (((u64) (val)) >> 16);    \
 587                 (a)[6] = (u8) (((u64) (val)) >> 8);     \
 588                 (a)[7] = (u8) (((u64) (val)) & 0xff);   \
 589         } while (0)
 590
 591 #define RTW_GET_LE64(a) ((((u64) (a)[7]) << 56) | (((u64) (a)[6]) << 48) | \
 592                          (((u64) (a)[5]) << 40) | (((u64) (a)[4]) << 32) | \
 593                          (((u64) (a)[3]) << 24) | (((u64) (a)[2]) << 16) | \
 594                          (((u64) (a)[1]) << 8) | ((u64) (a)[0]))
 595
 596 void rtw_buf_free(u8 **buf, u32 *buf_len);
 597 void rtw_buf_update(u8 **buf, u32 *buf_len, u8 *src, u32 src_len);
 598
 599 struct rtw_cbuf {
 600         u32 write;
 601         u32 read;
 602         u32 size;
 603         void *bufs[0];
 604 };
 605
 606 bool rtw_cbuf_full(struct rtw_cbuf *cbuf);
 607 bool rtw_cbuf_empty(struct rtw_cbuf *cbuf);
 608 bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf);
 609 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf);
 610 struct rtw_cbuf *rtw_cbuf_alloc(u32 size);
 611 void rtw_cbuf_free(struct rtw_cbuf *cbuf);
 612
 613 // String handler
 614 /*
 615  * Write formatted output to sized buffer
 616  */
 617 #ifdef PLATFORM_LINUX
 618 #define rtw_sprintf(buf, size, format, arg...)  snprintf(buf, size, format, ##arg)
 619 #else // !PLATFORM_LINUX
 620 #error "NOT DEFINE \"rtw_sprintf\"!!"
 621 #endif // !PLATFORM_LINUX
 622
 623 #endif
 624
 625