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