drivers/staging/rtl8712/rtl871x_xmit.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2010 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  * Modifications for inclusion into the Linux staging tree are
  19  * Copyright(c) 2010 Larry Finger. All rights reserved.
  20  *
  21  * Contact information:
  22  * WLAN FAE <wlanfae@realtek.com>
  23  * Larry Finger <Larry.Finger@lwfinger.net>
  24  *
  25  ******************************************************************************/
  26 #ifndef _RTL871X_XMIT_H_
  27 #define _RTL871X_XMIT_H_
  28
  29 #include "osdep_service.h"
  30 #include "drv_types.h"
  31 #include "xmit_osdep.h"
  32
  33 #ifdef CONFIG_R8712_TX_AGGR
  34 #define MAX_XMITBUF_SZ  (16384)
  35 #else
  36 #define MAX_XMITBUF_SZ  (2048)
  37 #endif
  38
  39 #define NR_XMITBUFF     (4)
  40
  41 #ifdef CONFIG_R8712_TX_AGGR
  42 #define AGGR_NR_HIGH_BOUND      (4) /*(8) */
  43 #define AGGR_NR_LOW_BOUND       (2)
  44 #endif
  45
  46 #define XMITBUF_ALIGN_SZ 512
  47 #define TX_GUARD_BAND           5
  48 #define MAX_NUMBLKS             (1)
  49
  50 /* Fixed the Big Endian bug when using the software driver encryption.*/
  51 #define WEP_IV(pattrib_iv, txpn, keyidx)\
  52 do { \
  53         pattrib_iv[0] = txpn._byte_.TSC0;\
  54         pattrib_iv[1] = txpn._byte_.TSC1;\
  55         pattrib_iv[2] = txpn._byte_.TSC2;\
  56         pattrib_iv[3] = ((keyidx & 0x3)<<6);\
  57         txpn.val = (txpn.val == 0xffffff) ? 0 : (txpn.val+1);\
  58 } while (0)
  59
  60 /* Fixed the Big Endian bug when doing the Tx.
  61  * The Linksys WRH54G will check this.*/
  62 #define TKIP_IV(pattrib_iv, txpn, keyidx)\
  63 do { \
  64         pattrib_iv[0] = txpn._byte_.TSC1;\
  65         pattrib_iv[1] = (txpn._byte_.TSC1 | 0x20) & 0x7f;\
  66         pattrib_iv[2] = txpn._byte_.TSC0;\
  67         pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);\
  68         pattrib_iv[4] = txpn._byte_.TSC2;\
  69         pattrib_iv[5] = txpn._byte_.TSC3;\
  70         pattrib_iv[6] = txpn._byte_.TSC4;\
  71         pattrib_iv[7] = txpn._byte_.TSC5;\
  72         txpn.val = txpn.val == 0xffffffffffffULL ? 0 : \
  73         (txpn.val+1);\
  74 } while (0)
  75
  76 #define AES_IV(pattrib_iv, txpn, keyidx)\
  77 do { \
  78         pattrib_iv[0] = txpn._byte_.TSC0;\
  79         pattrib_iv[1] = txpn._byte_.TSC1;\
  80         pattrib_iv[2] = 0;\
  81         pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);\
  82         pattrib_iv[4] = txpn._byte_.TSC2;\
  83         pattrib_iv[5] = txpn._byte_.TSC3;\
  84         pattrib_iv[6] = txpn._byte_.TSC4;\
  85         pattrib_iv[7] = txpn._byte_.TSC5;\
  86         txpn.val = txpn.val == 0xffffffffffffULL ? 0 : \
  87         (txpn.val+1);\
  88 } while (0)
  89
  90 struct hw_xmit {
  91         spinlock_t xmit_lock;
  92         struct list_head pending;
  93         struct  __queue *sta_queue;
  94         struct hw_txqueue *phwtxqueue;
  95         sint    txcmdcnt;
  96         int     accnt;
  97 };
  98
  99 struct pkt_attrib {
 100         u8      type;
 101         u8      subtype;
 102         u8      bswenc;
 103         u8      dhcp_pkt;
 104
 105         u16     seqnum;
 106         u16     ether_type;
 107         u16     pktlen;         /* the original 802.3 pkt raw_data len
 108                                  * (not include ether_hdr data) */
 109         u16     last_txcmdsz;
 110
 111         u8      pkt_hdrlen;     /*the original 802.3 pkt header len*/
 112         u8      hdrlen;         /*the WLAN Header Len*/
 113         u8      nr_frags;
 114         u8      ack_policy;
 115         u8      mac_id;
 116         u8      vcs_mode;       /*virtual carrier sense method*/
 117         u8      pctrl;/*per packet txdesc control enable*/
 118         u8      qsel;
 119
 120         u8      priority;
 121         u8      encrypt;        /* when 0 indicate no encrypt. when non-zero,
 122                                  * indicate the encrypt algorith*/
 123         u8      iv_len;
 124         u8      icv_len;
 125         unsigned char iv[8];
 126         unsigned char icv[8];
 127         u8      dst[ETH_ALEN];
 128         u8      src[ETH_ALEN];
 129         u8      ta[ETH_ALEN];
 130         u8      ra[ETH_ALEN];
 131         struct sta_info *psta;
 132 };
 133
 134 #define WLANHDR_OFFSET  64
 135 #define DATA_FRAMETAG           0x01
 136 #define L2_FRAMETAG             0x02
 137 #define MGNT_FRAMETAG           0x03
 138 #define AMSDU_FRAMETAG  0x04
 139 #define EII_FRAMETAG            0x05
 140 #define IEEE8023_FRAMETAG  0x06
 141 #define MP_FRAMETAG             0x07
 142 #define TXAGG_FRAMETAG  0x08
 143
 144 struct xmit_buf {
 145         struct list_head list;
 146
 147         u8 *pallocated_buf;
 148         u8 *pbuf;
 149         void *priv_data;
 150         struct urb *pxmit_urb[8];
 151         u32 aggr_nr;
 152 };
 153
 154 struct xmit_frame {
 155         struct list_head list;
 156         struct pkt_attrib attrib;
 157         _pkt *pkt;
 158         int frame_tag;
 159         struct _adapter *padapter;
 160          u8 *buf_addr;
 161          struct xmit_buf *pxmitbuf;
 162         u8 *mem_addr;
 163         u16 sz[8];
 164         struct urb *pxmit_urb[8];
 165         u8 bpending[8];
 166         u8 last[8];
 167 };
 168
 169 struct tx_servq {
 170         struct list_head tx_pending;
 171         struct  __queue sta_pending;
 172         int qcnt;
 173 };
 174
 175 struct sta_xmit_priv {
 176         spinlock_t lock;
 177         sint    option;
 178         sint    apsd_setting;   /* When bit mask is on, the associated edca
 179                                  * queue supports APSD.*/
 180         struct tx_servq be_q;   /* priority == 0,3 */
 181         struct tx_servq bk_q;   /* priority == 1,2*/
 182         struct tx_servq vi_q;   /*priority == 4,5*/
 183         struct tx_servq vo_q;   /*priority == 6,7*/
 184         struct list_head  legacy_dz;
 185         struct list_head apsd;
 186         u16 txseq_tid[16];
 187         uint    sta_tx_bytes;
 188         u64     sta_tx_pkts;
 189         uint    sta_tx_fail;
 190 };
 191
 192 struct  hw_txqueue {
 193         /*volatile*/ sint       head;
 194         /*volatile*/ sint       tail;
 195         /*volatile*/ sint       free_sz;        /*in units of 64 bytes*/
 196         /*volatile*/ sint      free_cmdsz;
 197         /*volatile*/ sint        txsz[8];
 198         uint    ff_hwaddr;
 199         uint    cmd_hwaddr;
 200         sint    ac_tag;
 201 };
 202
 203 struct  xmit_priv {
 204         spinlock_t lock;
 205         struct semaphore xmit_sema;
 206         struct semaphore terminate_xmitthread_sema;
 207         struct  __queue be_pending;
 208         struct  __queue bk_pending;
 209         struct  __queue vi_pending;
 210         struct  __queue vo_pending;
 211         struct  __queue bm_pending;
 212         struct  __queue legacy_dz_queue;
 213         struct  __queue apsd_queue;
 214         u8 *pallocated_frame_buf;
 215         u8 *pxmit_frame_buf;
 216         uint free_xmitframe_cnt;
 217         uint mapping_addr;
 218         uint pkt_sz;
 219         struct  __queue free_xmit_queue;
 220         struct  hw_txqueue      be_txqueue;
 221         struct  hw_txqueue      bk_txqueue;
 222         struct  hw_txqueue      vi_txqueue;
 223         struct  hw_txqueue      vo_txqueue;
 224         struct  hw_txqueue      bmc_txqueue;
 225         uint    frag_len;
 226         struct _adapter *adapter;
 227         u8   vcs_setting;
 228         u8      vcs;
 229         u8      vcs_type;
 230         u16  rts_thresh;
 231         uint    tx_bytes;
 232         u64     tx_pkts;
 233         uint    tx_drop;
 234         struct hw_xmit *hwxmits;
 235         u8      hwxmit_entry;
 236         struct semaphore tx_retevt;/*all tx return event;*/
 237         u8      txirp_cnt;
 238         struct tasklet_struct xmit_tasklet;
 239         _workitem xmit_pipe4_reset_wi;
 240         _workitem xmit_pipe6_reset_wi;
 241         _workitem xmit_piped_reset_wi;
 242         /*per AC pending irp*/
 243         int beq_cnt;
 244         int bkq_cnt;
 245         int viq_cnt;
 246         int voq_cnt;
 247         struct  __queue free_amsdu_xmit_queue;
 248         u8 *pallocated_amsdu_frame_buf;
 249         u8 *pxmit_amsdu_frame_buf;
 250         uint free_amsdu_xmitframe_cnt;
 251         struct  __queue free_txagg_xmit_queue;
 252         u8 *pallocated_txagg_frame_buf;
 253         u8 *pxmit_txagg_frame_buf;
 254         uint free_txagg_xmitframe_cnt;
 255         int cmdseq;
 256         struct  __queue free_xmitbuf_queue;
 257         struct  __queue pending_xmitbuf_queue;
 258         u8 *pallocated_xmitbuf;
 259         u8 *pxmitbuf;
 260         uint free_xmitbuf_cnt;
 261 };
 262
 263 static inline struct  __queue *get_free_xmit_queue(
 264                                 struct xmit_priv *pxmitpriv)
 265 {
 266         return &(pxmitpriv->free_xmit_queue);
 267 }
 268
 269 int r8712_free_xmitbuf(struct xmit_priv *pxmitpriv,
 270                        struct xmit_buf *pxmitbuf);
 271 struct xmit_buf *r8712_alloc_xmitbuf(struct xmit_priv *pxmitpriv);
 272 void r8712_update_protection(struct _adapter *padapter, u8 *ie, uint ie_len);
 273 struct xmit_frame *r8712_alloc_xmitframe(struct xmit_priv *pxmitpriv);
 274 void r8712_free_xmitframe(struct xmit_priv *pxmitpriv,
 275                           struct xmit_frame *pxmitframe);
 276 void r8712_free_xmitframe_queue(struct xmit_priv *pxmitpriv,
 277                                 struct  __queue *pframequeue);
 278 sint r8712_xmit_classifier(struct _adapter *padapter,
 279                             struct xmit_frame *pxmitframe);
 280 sint r8712_xmitframe_coalesce(struct _adapter *padapter, _pkt *pkt,
 281                               struct xmit_frame *pxmitframe);
 282 sint _r8712_init_hw_txqueue(struct hw_txqueue *phw_txqueue, u8 ac_tag);
 283 void _r8712_init_sta_xmit_priv(struct sta_xmit_priv *psta_xmitpriv);
 284 sint r8712_update_attrib(struct _adapter *padapter, _pkt *pkt,
 285                          struct pkt_attrib *pattrib);
 286 int r8712_txframes_sta_ac_pending(struct _adapter *padapter,
 287                                   struct pkt_attrib *pattrib);
 288 sint _r8712_init_xmit_priv(struct xmit_priv *pxmitpriv,
 289                            struct _adapter *padapter);
 290 void _free_xmit_priv(struct xmit_priv *pxmitpriv);
 291 void r8712_free_xmitframe_ex(struct xmit_priv *pxmitpriv,
 292                              struct xmit_frame *pxmitframe);
 293 int r8712_pre_xmit(struct _adapter *padapter, struct xmit_frame *pxmitframe);
 294 int r8712_xmit_enqueue(struct _adapter *padapter,
 295                        struct xmit_frame *pxmitframe);
 296 int r8712_xmit_direct(struct _adapter *padapter, struct xmit_frame *pxmitframe);
 297 void r8712_xmit_bh(void *priv);
 298
 299 void xmitframe_xmitbuf_attach(struct xmit_frame *pxmitframe,
 300                         struct xmit_buf *pxmitbuf);
 301
 302 #include "rtl8712_xmit.h"
 303
 304 #endif  /*_RTL871X_XMIT_H_*/
 305