linux/drivers/staging/rtl8188eu/include/rtw_xmit.h
<<
>>
Prefs
   1/******************************************************************************
   2 *
   3 * Copyright(c) 2007 - 2011 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 _RTW_XMIT_H_
  21#define _RTW_XMIT_H_
  22
  23#include <osdep_service.h>
  24#include <drv_types.h>
  25
  26#define MAX_XMITBUF_SZ  (20480) /*  20k */
  27#define NR_XMITBUFF             (4)
  28
  29#define XMITBUF_ALIGN_SZ        4
  30
  31/*  xmit extension buff defination */
  32#define MAX_XMIT_EXTBUF_SZ      (1536)
  33#define NR_XMIT_EXTBUFF         (32)
  34
  35#define MAX_NUMBLKS             (1)
  36
  37#define XMIT_VO_QUEUE           (0)
  38#define XMIT_VI_QUEUE           (1)
  39#define XMIT_BE_QUEUE           (2)
  40#define XMIT_BK_QUEUE           (3)
  41
  42#define VO_QUEUE_INX            0
  43#define VI_QUEUE_INX            1
  44#define BE_QUEUE_INX            2
  45#define BK_QUEUE_INX            3
  46#define BCN_QUEUE_INX           4
  47#define MGT_QUEUE_INX           5
  48#define HIGH_QUEUE_INX          6
  49#define TXCMD_QUEUE_INX         7
  50
  51#define HW_QUEUE_ENTRY          8
  52
  53#define WEP_IV(pattrib_iv, dot11txpn, keyidx)\
  54do {\
  55        pattrib_iv[0] = dot11txpn._byte_.TSC0;\
  56        pattrib_iv[1] = dot11txpn._byte_.TSC1;\
  57        pattrib_iv[2] = dot11txpn._byte_.TSC2;\
  58        pattrib_iv[3] = ((keyidx & 0x3)<<6);\
  59        dot11txpn.val = (dot11txpn.val == 0xffffff) ? 0 : (dot11txpn.val+1);\
  60} while (0)
  61
  62
  63#define TKIP_IV(pattrib_iv, dot11txpn, keyidx)\
  64do {\
  65        pattrib_iv[0] = dot11txpn._byte_.TSC1;\
  66        pattrib_iv[1] = (dot11txpn._byte_.TSC1 | 0x20) & 0x7f;\
  67        pattrib_iv[2] = dot11txpn._byte_.TSC0;\
  68        pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);\
  69        pattrib_iv[4] = dot11txpn._byte_.TSC2;\
  70        pattrib_iv[5] = dot11txpn._byte_.TSC3;\
  71        pattrib_iv[6] = dot11txpn._byte_.TSC4;\
  72        pattrib_iv[7] = dot11txpn._byte_.TSC5;\
  73        dot11txpn.val = dot11txpn.val == 0xffffffffffffULL ? 0 : (dot11txpn.val+1);\
  74} while (0)
  75
  76#define AES_IV(pattrib_iv, dot11txpn, keyidx)\
  77do {                                                    \
  78        pattrib_iv[0] = dot11txpn._byte_.TSC0;          \
  79        pattrib_iv[1] = dot11txpn._byte_.TSC1;          \
  80        pattrib_iv[2] = 0;                              \
  81        pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);   \
  82        pattrib_iv[4] = dot11txpn._byte_.TSC2;          \
  83        pattrib_iv[5] = dot11txpn._byte_.TSC3;          \
  84        pattrib_iv[6] = dot11txpn._byte_.TSC4;          \
  85        pattrib_iv[7] = dot11txpn._byte_.TSC5;          \
  86        dot11txpn.val = dot11txpn.val == 0xffffffffffffULL ? 0 : (dot11txpn.val+1);\
  87} while (0)
  88
  89#define HWXMIT_ENTRY    4
  90
  91#define TXDESC_SIZE 32
  92
  93#define PACKET_OFFSET_SZ (8)
  94#define TXDESC_OFFSET (TXDESC_SIZE + PACKET_OFFSET_SZ)
  95
  96struct tx_desc {
  97        /* DWORD 0 */
  98        __le32 txdw0;
  99        __le32 txdw1;
 100        __le32 txdw2;
 101        __le32 txdw3;
 102        __le32 txdw4;
 103        __le32 txdw5;
 104        __le32 txdw6;
 105        __le32 txdw7;
 106};
 107
 108union txdesc {
 109        struct tx_desc txdesc;
 110        unsigned int value[TXDESC_SIZE>>2];
 111};
 112
 113struct  hw_xmit {
 114        struct __queue *sta_queue;
 115        int     accnt;
 116};
 117
 118/* reduce size */
 119struct pkt_attrib {
 120        u8      type;
 121        u8      subtype;
 122        u8      bswenc;
 123        u8      dhcp_pkt;
 124        u16     ether_type;
 125        u16     seqnum;
 126        u16     pkt_hdrlen;     /* the original 802.3 pkt header len */
 127        u16     hdrlen;         /* the WLAN Header Len */
 128        u32     pktlen;         /* the original 802.3 pkt raw_data len (not include
 129                                 * ether_hdr data) */
 130        u32     last_txcmdsz;
 131        u8      nr_frags;
 132        u8      encrypt;        /* when 0 indicate no encrypt. when non-zero,
 133                                 * indicate the encrypt algorith */
 134        u8      iv_len;
 135        u8      icv_len;
 136        u8      iv[18];
 137        u8      icv[16];
 138        u8      priority;
 139        u8      ack_policy;
 140        u8      mac_id;
 141        u8      vcs_mode;       /* virtual carrier sense method */
 142        u8      dst[ETH_ALEN];
 143        u8      src[ETH_ALEN];
 144        u8      ta[ETH_ALEN];
 145        u8      ra[ETH_ALEN];
 146        u8      key_idx;
 147        u8      qos_en;
 148        u8      ht_en;
 149        u8      raid;/* rate adpative id */
 150        u8      bwmode;
 151        u8      ch_offset;/* PRIME_CHNL_OFFSET */
 152        u8      sgi;/* short GI */
 153        u8      ampdu_en;/* tx ampdu enable */
 154        u8      mdata;/* more data bit */
 155        u8      pctrl;/* per packet txdesc control enable */
 156        u8      triggered;/* for ap mode handling Power Saving sta */
 157        u8      qsel;
 158        u8      eosp;
 159        u8      rate;
 160        u8      intel_proxim;
 161        u8      retry_ctrl;
 162        struct sta_info *psta;
 163};
 164
 165#define WLANHDR_OFFSET  64
 166
 167#define NULL_FRAMETAG           (0x0)
 168#define DATA_FRAMETAG           0x01
 169#define L2_FRAMETAG             0x02
 170#define MGNT_FRAMETAG           0x03
 171#define AMSDU_FRAMETAG  0x04
 172
 173#define EII_FRAMETAG            0x05
 174#define IEEE8023_FRAMETAG  0x06
 175
 176#define MP_FRAMETAG             0x07
 177
 178#define TXAGG_FRAMETAG  0x08
 179
 180struct  submit_ctx {
 181        u32 submit_time; /* */
 182        u32 timeout_ms; /* <0: not synchronous, 0: wait forever, >0: up to ms waiting */
 183        int status; /* status for operation */
 184        struct completion done;
 185};
 186
 187enum {
 188        RTW_SCTX_SUBMITTED = -1,
 189        RTW_SCTX_DONE_SUCCESS = 0,
 190        RTW_SCTX_DONE_UNKNOWN,
 191        RTW_SCTX_DONE_TIMEOUT,
 192        RTW_SCTX_DONE_BUF_ALLOC,
 193        RTW_SCTX_DONE_BUF_FREE,
 194        RTW_SCTX_DONE_WRITE_PORT_ERR,
 195        RTW_SCTX_DONE_TX_DESC_NA,
 196        RTW_SCTX_DONE_TX_DENY,
 197        RTW_SCTX_DONE_CCX_PKT_FAIL,
 198        RTW_SCTX_DONE_DRV_STOP,
 199        RTW_SCTX_DONE_DEV_REMOVE,
 200};
 201
 202void rtw_sctx_init(struct submit_ctx *sctx, int timeout_ms);
 203int rtw_sctx_wait(struct submit_ctx *sctx);
 204void rtw_sctx_done_err(struct submit_ctx **sctx, int status);
 205void rtw_sctx_done(struct submit_ctx **sctx);
 206
 207struct xmit_buf {
 208        struct list_head list;
 209        struct adapter *padapter;
 210        u8 *pallocated_buf;
 211        u8 *pbuf;
 212        void *priv_data;
 213        u16 ext_tag; /*  0: Normal xmitbuf, 1: extension xmitbuf. */
 214        u16 flags;
 215        u32 alloc_sz;
 216        u32  len;
 217        struct submit_ctx *sctx;
 218        u32     ff_hwaddr;
 219        struct urb *pxmit_urb[8];
 220        dma_addr_t dma_transfer_addr;   /* (in) dma addr for transfer_buffer */
 221        u8 bpending[8];
 222        int last[8];
 223};
 224
 225struct xmit_frame {
 226        struct list_head list;
 227        struct pkt_attrib attrib;
 228        struct sk_buff *pkt;
 229        int     frame_tag;
 230        struct adapter *padapter;
 231        u8      *buf_addr;
 232        struct xmit_buf *pxmitbuf;
 233
 234        u8      agg_num;
 235        s8      pkt_offset;
 236        u8 ack_report;
 237};
 238
 239struct tx_servq {
 240        struct list_head tx_pending;
 241        struct __queue sta_pending;
 242        int qcnt;
 243};
 244
 245struct sta_xmit_priv {
 246        spinlock_t lock;
 247        int     option;
 248        int     apsd_setting;   /* When bit mask is on, the associated edca
 249                                 * queue supports APSD. */
 250        struct tx_servq be_q;                   /* priority == 0,3 */
 251        struct tx_servq bk_q;                   /* priority == 1,2 */
 252        struct tx_servq vi_q;                   /* priority == 4,5 */
 253        struct tx_servq vo_q;                   /* priority == 6,7 */
 254        struct list_head legacy_dz;
 255        struct list_head apsd;
 256        u16 txseq_tid[16];
 257};
 258
 259struct  hw_txqueue {
 260        volatile int    head;
 261        volatile int    tail;
 262        volatile int    free_sz;        /* in units of 64 bytes */
 263        volatile int      free_cmdsz;
 264        volatile int     txsz[8];
 265        uint    ff_hwaddr;
 266        uint    cmd_hwaddr;
 267        int     ac_tag;
 268};
 269
 270struct agg_pkt_info {
 271        u16 offset;
 272        u16 pkt_len;
 273};
 274
 275struct  xmit_priv {
 276        spinlock_t lock;
 277        struct semaphore xmit_sema;
 278        struct semaphore terminate_xmitthread_sema;
 279        struct __queue be_pending;
 280        struct __queue bk_pending;
 281        struct __queue vi_pending;
 282        struct __queue vo_pending;
 283        struct __queue bm_pending;
 284        u8 *pallocated_frame_buf;
 285        u8 *pxmit_frame_buf;
 286        uint free_xmitframe_cnt;
 287        struct __queue free_xmit_queue;
 288        uint    frag_len;
 289        struct adapter  *adapter;
 290        u8   vcs_setting;
 291        u8      vcs;
 292        u8      vcs_type;
 293        u64     tx_bytes;
 294        u64     tx_pkts;
 295        u64     tx_drop;
 296        u64     last_tx_bytes;
 297        u64     last_tx_pkts;
 298        struct hw_xmit *hwxmits;
 299        u8      hwxmit_entry;
 300        u8      wmm_para_seq[4];/* sequence for wmm ac parameter strength
 301                                 * from large to small. it's value is 0->vo,
 302                                 * 1->vi, 2->be, 3->bk. */
 303        struct semaphore tx_retevt;/* all tx return event; */
 304        u8              txirp_cnt;/*  */
 305        struct tasklet_struct xmit_tasklet;
 306        /* per AC pending irp */
 307        int beq_cnt;
 308        int bkq_cnt;
 309        int viq_cnt;
 310        int voq_cnt;
 311        struct __queue free_xmitbuf_queue;
 312        struct __queue pending_xmitbuf_queue;
 313        u8 *pallocated_xmitbuf;
 314        u8 *pxmitbuf;
 315        uint free_xmitbuf_cnt;
 316        struct __queue free_xmit_extbuf_queue;
 317        u8 *pallocated_xmit_extbuf;
 318        u8 *pxmit_extbuf;
 319        uint free_xmit_extbuf_cnt;
 320        u16     nqos_ssn;
 321        int     ack_tx;
 322        struct mutex ack_tx_mutex;
 323        struct submit_ctx ack_tx_ops;
 324};
 325
 326struct xmit_buf *rtw_alloc_xmitbuf_ext(struct xmit_priv *pxmitpriv);
 327s32 rtw_free_xmitbuf_ext(struct xmit_priv *pxmitpriv,
 328                         struct xmit_buf *pxmitbuf);
 329struct xmit_buf *rtw_alloc_xmitbuf(struct xmit_priv *pxmitpriv);
 330s32 rtw_free_xmitbuf(struct xmit_priv *pxmitpriv,
 331                     struct xmit_buf *pxmitbuf);
 332void rtw_count_tx_stats(struct adapter *padapter,
 333                        struct xmit_frame *pxmitframe, int sz);
 334void rtw_update_protection(struct adapter *padapter, u8 *ie, uint ie_len);
 335s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr,
 336                     struct pkt_attrib *pattrib);
 337s32 rtw_put_snap(u8 *data, u16 h_proto);
 338
 339struct xmit_frame *rtw_alloc_xmitframe(struct xmit_priv *pxmitpriv);
 340s32 rtw_free_xmitframe(struct xmit_priv *pxmitpriv,
 341                       struct xmit_frame *pxmitframe);
 342void rtw_free_xmitframe_queue(struct xmit_priv *pxmitpriv,
 343                              struct __queue *pframequeue);
 344struct tx_servq *rtw_get_sta_pending(struct adapter *padapter,
 345                                     struct sta_info *psta, int up, u8 *ac);
 346s32 rtw_xmitframe_enqueue(struct adapter *padapter,
 347                          struct xmit_frame *pxmitframe);
 348struct xmit_frame *rtw_dequeue_xframe(struct xmit_priv *pxmitpriv,
 349                                      struct hw_xmit *phwxmit_i, int entry);
 350
 351s32 rtw_xmit_classifier(struct adapter *padapter,
 352                        struct xmit_frame *pxmitframe);
 353u32 rtw_calculate_wlan_pkt_size_by_attribue(struct pkt_attrib *pattrib);
 354#define rtw_wlan_pkt_size(f) rtw_calculate_wlan_pkt_size_by_attribue(&f->attrib)
 355s32 rtw_xmitframe_coalesce(struct adapter *padapter, struct sk_buff *pkt,
 356                           struct xmit_frame *pxmitframe);
 357s32 _rtw_init_hw_txqueue(struct hw_txqueue *phw_txqueue, u8 ac_tag);
 358void _rtw_init_sta_xmit_priv(struct sta_xmit_priv *psta_xmitpriv);
 359s32 rtw_txframes_pending(struct adapter *padapter);
 360s32 rtw_txframes_sta_ac_pending(struct adapter *padapter,
 361                                struct pkt_attrib *pattrib);
 362void rtw_init_hwxmits(struct hw_xmit *phwxmit, int entry);
 363s32 _rtw_init_xmit_priv(struct xmit_priv *pxmitpriv, struct adapter *padapter);
 364void _rtw_free_xmit_priv(struct xmit_priv *pxmitpriv);
 365void rtw_alloc_hwxmits(struct adapter *padapter);
 366void rtw_free_hwxmits(struct adapter *padapter);
 367s32 rtw_xmit(struct adapter *padapter, struct sk_buff **pkt);
 368
 369#if defined(CONFIG_88EU_AP_MODE)
 370int xmitframe_enqueue_for_sleeping_sta(struct adapter *padapter, struct xmit_frame *pxmitframe);
 371void stop_sta_xmit(struct adapter *padapter, struct sta_info *psta);
 372void wakeup_sta_to_xmit(struct adapter *padapter, struct sta_info *psta);
 373void xmit_delivery_enabled_frames(struct adapter *padapter, struct sta_info *psta);
 374#endif
 375
 376u8      qos_acm(u8 acm_mask, u8 priority);
 377u32     rtw_get_ff_hwaddr(struct xmit_frame *pxmitframe);
 378int rtw_ack_tx_wait(struct xmit_priv *pxmitpriv, u32 timeout_ms);
 379void rtw_ack_tx_done(struct xmit_priv *pxmitpriv, int status);
 380
 381/* include after declaring struct xmit_buf, in order to avoid warning */
 382#include <xmit_osdep.h>
 383
 384#endif  /* _RTL871X_XMIT_H_ */
 385