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