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