rtl8821ce/include/osdep_service.h

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