1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved. 5 * 6 ******************************************************************************/ 7 #ifndef _RTW_XMIT_H_ 8 #define _RTW_XMIT_H_ 9 10 #include <linux/completion.h> 11 12 #define MAX_XMITBUF_SZ (20480) /* 20k */ 13 14 #define NR_XMITBUFF (16) 15 16 #define XMITBUF_ALIGN_SZ 512 17 18 /* xmit extension buff definition */ 19 #define MAX_XMIT_EXTBUF_SZ (1536) 20 #define NR_XMIT_EXTBUFF (32) 21 22 #define MAX_CMDBUF_SZ (5120) /* 4096) */ 23 24 #define MAX_NUMBLKS (1) 25 26 #define XMIT_VO_QUEUE (0) 27 #define XMIT_VI_QUEUE (1) 28 #define XMIT_BE_QUEUE (2) 29 #define XMIT_BK_QUEUE (3) 30 31 #define VO_QUEUE_INX 0 32 #define VI_QUEUE_INX 1 33 #define BE_QUEUE_INX 2 34 #define BK_QUEUE_INX 3 35 #define BCN_QUEUE_INX 4 36 #define MGT_QUEUE_INX 5 37 #define HIGH_QUEUE_INX 6 38 39 #define HW_QUEUE_ENTRY 8 40 41 #define WEP_IV(pattrib_iv, dot11txpn, keyidx)\ 42 do {\ 43 pattrib_iv[0] = dot11txpn._byte_.TSC0;\ 44 pattrib_iv[1] = dot11txpn._byte_.TSC1;\ 45 pattrib_iv[2] = dot11txpn._byte_.TSC2;\ 46 pattrib_iv[3] = ((keyidx & 0x3)<<6);\ 47 dot11txpn.val = (dot11txpn.val == 0xffffff) ? 0 : (dot11txpn.val + 1);\ 48 } while (0) 49 50 51 #define TKIP_IV(pattrib_iv, dot11txpn, keyidx)\ 52 do {\ 53 pattrib_iv[0] = dot11txpn._byte_.TSC1;\ 54 pattrib_iv[1] = (dot11txpn._byte_.TSC1 | 0x20) & 0x7f;\ 55 pattrib_iv[2] = dot11txpn._byte_.TSC0;\ 56 pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);\ 57 pattrib_iv[4] = dot11txpn._byte_.TSC2;\ 58 pattrib_iv[5] = dot11txpn._byte_.TSC3;\ 59 pattrib_iv[6] = dot11txpn._byte_.TSC4;\ 60 pattrib_iv[7] = dot11txpn._byte_.TSC5;\ 61 dot11txpn.val = dot11txpn.val == 0xffffffffffffULL ? 0 : (dot11txpn.val + 1);\ 62 } while (0) 63 64 #define AES_IV(pattrib_iv, dot11txpn, keyidx)\ 65 do {\ 66 pattrib_iv[0] = dot11txpn._byte_.TSC0;\ 67 pattrib_iv[1] = dot11txpn._byte_.TSC1;\ 68 pattrib_iv[2] = 0;\ 69 pattrib_iv[3] = BIT(5) | ((keyidx & 0x3)<<6);\ 70 pattrib_iv[4] = dot11txpn._byte_.TSC2;\ 71 pattrib_iv[5] = dot11txpn._byte_.TSC3;\ 72 pattrib_iv[6] = dot11txpn._byte_.TSC4;\ 73 pattrib_iv[7] = dot11txpn._byte_.TSC5;\ 74 dot11txpn.val = dot11txpn.val == 0xffffffffffffULL ? 0 : (dot11txpn.val + 1);\ 75 } while (0) 76 77 78 #define HWXMIT_ENTRY 4 79 80 /* For Buffer Descriptor ring architecture */ 81 #define TXDESC_SIZE 40 82 83 #define TXDESC_OFFSET TXDESC_SIZE 84 85 #define TXDESC_40_BYTES 86 87 struct tx_desc { 88 __le32 txdw0; 89 __le32 txdw1; 90 __le32 txdw2; 91 __le32 txdw3; 92 __le32 txdw4; 93 __le32 txdw5; 94 __le32 txdw6; 95 __le32 txdw7; 96 97 #ifdef TXDESC_40_BYTES 98 __le32 txdw8; 99 __le32 txdw9; 100 #endif 101 }; 102 103 union txdesc { 104 struct tx_desc txdesc; 105 unsigned int value[TXDESC_SIZE>>2]; 106 }; 107 108 struct hw_xmit { 109 /* spinlock_t xmit_lock; */ 110 /* struct list_head pending; */ 111 struct __queue *sta_queue; 112 /* struct hw_txqueue *phwtxqueue; */ 113 /* signed int txcmdcnt; */ 114 int accnt; 115 }; 116 117 /* reduce size */ 118 struct pkt_attrib { 119 u8 type; 120 u8 subtype; 121 u8 bswenc; 122 u8 dhcp_pkt; 123 u16 ether_type; 124 u16 seqnum; 125 u16 pkt_hdrlen; /* the original 802.3 pkt header len */ 126 u16 hdrlen; /* the WLAN Header Len */ 127 u32 pktlen; /* the original 802.3 pkt raw_data len (not include ether_hdr data) */ 128 u32 last_txcmdsz; 129 u8 nr_frags; 130 u8 encrypt; /* when 0 indicates no encryption; when non-zero, indicates the encryption algorithm */ 131 u8 iv_len; 132 u8 icv_len; 133 u8 iv[18]; 134 u8 icv[16]; 135 u8 priority; 136 u8 ack_policy; 137 u8 mac_id; 138 u8 vcs_mode; /* virtual carrier sense method */ 139 u8 dst[ETH_ALEN]; 140 u8 src[ETH_ALEN]; 141 u8 ta[ETH_ALEN]; 142 u8 ra[ETH_ALEN]; 143 u8 key_idx; 144 u8 qos_en; 145 u8 ht_en; 146 u8 raid;/* rate adpative id */ 147 u8 bwmode; 148 u8 ch_offset;/* PRIME_CHNL_OFFSET */ 149 u8 sgi;/* short GI */ 150 u8 ampdu_en;/* tx ampdu enable */ 151 u8 ampdu_spacing; /* ampdu_min_spacing for peer sta's rx */ 152 u8 mdata;/* more data bit */ 153 u8 pctrl;/* per packet txdesc control enable */ 154 u8 triggered;/* for ap mode handling Power Saving sta */ 155 u8 qsel; 156 u8 order;/* order bit */ 157 u8 eosp; 158 u8 rate; 159 u8 intel_proxim; 160 u8 retry_ctrl; 161 u8 mbssid; 162 u8 ldpc; 163 u8 stbc; 164 struct sta_info *psta; 165 166 u8 rtsen; 167 u8 cts2self; 168 union Keytype dot11tkiptxmickey; 169 /* union Keytype dot11tkiprxmickey; */ 170 union Keytype dot118021x_UncstKey; 171 172 u8 icmp_pkt; 173 174 }; 175 176 #define WLANHDR_OFFSET 64 177 178 #define NULL_FRAMETAG (0x0) 179 #define DATA_FRAMETAG 0x01 180 #define MGNT_FRAMETAG 0x03 181 182 enum { 183 XMITBUF_DATA = 0, 184 XMITBUF_MGNT = 1, 185 XMITBUF_CMD = 2, 186 }; 187 188 struct submit_ctx { 189 unsigned long submit_time; /* */ 190 u32 timeout_ms; /* <0: not synchronous, 0: wait forever, >0: up to ms waiting */ 191 int status; /* status for operation */ 192 struct completion done; 193 }; 194 195 enum { 196 RTW_SCTX_SUBMITTED = -1, 197 RTW_SCTX_DONE_SUCCESS = 0, 198 RTW_SCTX_DONE_UNKNOWN, 199 RTW_SCTX_DONE_TIMEOUT, 200 RTW_SCTX_DONE_BUF_ALLOC, 201 RTW_SCTX_DONE_BUF_FREE, 202 RTW_SCTX_DONE_WRITE_PORT_ERR, 203 RTW_SCTX_DONE_TX_DESC_NA, 204 RTW_SCTX_DONE_TX_DENY, 205 RTW_SCTX_DONE_CCX_PKT_FAIL, 206 RTW_SCTX_DONE_DRV_STOP, 207 RTW_SCTX_DONE_DEV_REMOVE, 208 RTW_SCTX_DONE_CMD_ERROR, 209 }; 210 211 212 void rtw_sctx_init(struct submit_ctx *sctx, int timeout_ms); 213 int rtw_sctx_wait(struct submit_ctx *sctx); 214 void rtw_sctx_done_err(struct submit_ctx **sctx, int status); 215 void rtw_sctx_done(struct submit_ctx **sctx); 216 217 struct xmit_buf { 218 struct list_head list; 219 220 struct adapter *padapter; 221 222 u8 *pallocated_buf; 223 224 u8 *pbuf; 225 226 void *priv_data; 227 228 u16 buf_tag; /* 0: Normal xmitbuf, 1: extension xmitbuf, 2:cmd xmitbuf */ 229 u16 flags; 230 u32 alloc_sz; 231 232 u32 len; 233 234 struct submit_ctx *sctx; 235 236 u8 *phead; 237 u8 *pdata; 238 u8 *ptail; 239 u8 *pend; 240 u32 ff_hwaddr; 241 u8 pg_num; 242 u8 agg_num; 243 }; 244 245 246 struct xmit_frame { 247 struct list_head list; 248 249 struct pkt_attrib attrib; 250 251 struct sk_buff *pkt; 252 253 int frame_tag; 254 255 struct adapter *padapter; 256 257 u8 *buf_addr; 258 259 struct xmit_buf *pxmitbuf; 260 261 u8 pg_num; 262 u8 agg_num; 263 264 u8 ack_report; 265 266 u8 *alloc_addr; /* the actual address this xmitframe allocated */ 267 u8 ext_tag; /* 0:data, 1:mgmt */ 268 269 }; 270 271 struct tx_servq { 272 struct list_head tx_pending; 273 struct __queue sta_pending; 274 int qcnt; 275 }; 276 277 278 struct sta_xmit_priv { 279 spinlock_t lock; 280 signed int option; 281 signed int apsd_setting; /* When bit mask is on, the associated edca queue supports APSD. */ 282 283 284 /* struct tx_servq blk_q[MAX_NUMBLKS]; */ 285 struct tx_servq be_q; /* priority == 0, 3 */ 286 struct tx_servq bk_q; /* priority == 1, 2 */ 287 struct tx_servq vi_q; /* priority == 4, 5 */ 288 struct tx_servq vo_q; /* priority == 6, 7 */ 289 struct list_head legacy_dz; 290 struct list_head apsd; 291 292 u16 txseq_tid[16]; 293 294 /* uint sta_tx_bytes; */ 295 /* u64 sta_tx_pkts; */ 296 /* uint sta_tx_fail; */ 297 298 299 }; 300 301 302 struct hw_txqueue { 303 volatile signed int head; 304 volatile signed int tail; 305 volatile signed int free_sz; /* in units of 64 bytes */ 306 volatile signed int free_cmdsz; 307 volatile signed int txsz[8]; 308 uint ff_hwaddr; 309 uint cmd_hwaddr; 310 signed int ac_tag; 311 }; 312 313 enum cmdbuf_type { 314 CMDBUF_BEACON = 0x00, 315 CMDBUF_RSVD, 316 CMDBUF_MAX 317 }; 318 319 struct xmit_priv { 320 321 spinlock_t lock; 322 323 struct completion xmit_comp; 324 struct completion terminate_xmitthread_comp; 325 326 /* struct __queue blk_strms[MAX_NUMBLKS]; */ 327 struct __queue be_pending; 328 struct __queue bk_pending; 329 struct __queue vi_pending; 330 struct __queue vo_pending; 331 struct __queue bm_pending; 332 333 /* struct __queue legacy_dz_queue; */ 334 /* struct __queue apsd_queue; */ 335 336 u8 *pallocated_frame_buf; 337 u8 *pxmit_frame_buf; 338 uint free_xmitframe_cnt; 339 struct __queue free_xmit_queue; 340 341 /* uint mapping_addr; */ 342 /* uint pkt_sz; */ 343 344 u8 *xframe_ext_alloc_addr; 345 u8 *xframe_ext; 346 uint free_xframe_ext_cnt; 347 struct __queue free_xframe_ext_queue; 348 349 /* struct hw_txqueue be_txqueue; */ 350 /* struct hw_txqueue bk_txqueue; */ 351 /* struct hw_txqueue vi_txqueue; */ 352 /* struct hw_txqueue vo_txqueue; */ 353 /* struct hw_txqueue bmc_txqueue; */ 354 355 uint frag_len; 356 357 struct adapter *adapter; 358 359 u8 vcs_setting; 360 u8 vcs; 361 u8 vcs_type; 362 /* u16 rts_thresh; */ 363 364 u64 tx_bytes; 365 u64 tx_pkts; 366 u64 tx_drop; 367 u64 last_tx_pkts; 368 369 struct hw_xmit *hwxmits; 370 u8 hwxmit_entry; 371 372 u8 wmm_para_seq[4];/* sequence for wmm ac parameter strength from large to small. it's value is 0->vo, 1->vi, 2->be, 3->bk. */ 373 374 void *SdioXmitThread; 375 struct completion SdioXmitStart; 376 struct completion SdioXmitTerminate; 377 378 struct __queue free_xmitbuf_queue; 379 struct __queue pending_xmitbuf_queue; 380 u8 *pallocated_xmitbuf; 381 u8 *pxmitbuf; 382 uint free_xmitbuf_cnt; 383 384 struct __queue free_xmit_extbuf_queue; 385 u8 *pallocated_xmit_extbuf; 386 u8 *pxmit_extbuf; 387 uint free_xmit_extbuf_cnt; 388 389 struct xmit_buf pcmd_xmitbuf[CMDBUF_MAX]; 390 391 u16 nqos_ssn; 392 393 int ack_tx; 394 struct mutex ack_tx_mutex; 395 struct submit_ctx ack_tx_ops; 396 u8 seq_no; 397 spinlock_t lock_sctx; 398 }; 399 400 extern struct xmit_frame *__rtw_alloc_cmdxmitframe(struct xmit_priv *pxmitpriv, 401 enum cmdbuf_type buf_type); 402 #define rtw_alloc_cmdxmitframe(p) __rtw_alloc_cmdxmitframe(p, CMDBUF_RSVD) 403 #define rtw_alloc_bcnxmitframe(p) __rtw_alloc_cmdxmitframe(p, CMDBUF_BEACON) 404 405 extern struct xmit_buf *rtw_alloc_xmitbuf_ext(struct xmit_priv *pxmitpriv); 406 extern s32 rtw_free_xmitbuf_ext(struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf); 407 408 extern struct xmit_buf *rtw_alloc_xmitbuf(struct xmit_priv *pxmitpriv); 409 extern s32 rtw_free_xmitbuf(struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf); 410 411 void rtw_count_tx_stats(struct adapter *padapter, struct xmit_frame *pxmitframe, int sz); 412 extern void rtw_update_protection(struct adapter *padapter, u8 *ie, uint ie_len); 413 extern s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattrib); 414 extern s32 rtw_put_snap(u8 *data, u16 h_proto); 415 416 extern struct xmit_frame *rtw_alloc_xmitframe(struct xmit_priv *pxmitpriv); 417 struct xmit_frame *rtw_alloc_xmitframe_ext(struct xmit_priv *pxmitpriv); 418 struct xmit_frame *rtw_alloc_xmitframe_once(struct xmit_priv *pxmitpriv); 419 extern s32 rtw_free_xmitframe(struct xmit_priv *pxmitpriv, struct xmit_frame *pxmitframe); 420 extern void rtw_free_xmitframe_queue(struct xmit_priv *pxmitpriv, struct __queue *pframequeue); 421 struct tx_servq *rtw_get_sta_pending(struct adapter *padapter, struct sta_info *psta, signed int up, u8 *ac); 422 int rtw_xmitframe_enqueue(struct adapter *padapter, struct xmit_frame *pxmitframe); 423 424 extern u32 rtw_calculate_wlan_pkt_size_by_attribue(struct pkt_attrib *pattrib); 425 #define rtw_wlan_pkt_size(f) rtw_calculate_wlan_pkt_size_by_attribue(&f->attrib) 426 extern s32 rtw_xmitframe_coalesce(struct adapter *padapter, struct sk_buff *pkt, struct xmit_frame *pxmitframe); 427 extern s32 rtw_mgmt_xmitframe_coalesce(struct adapter *padapter, struct sk_buff *pkt, struct xmit_frame *pxmitframe); 428 s32 _rtw_init_hw_txqueue(struct hw_txqueue *phw_txqueue, u8 ac_tag); 429 void _rtw_init_sta_xmit_priv(struct sta_xmit_priv *psta_xmitpriv); 430 431 432 s32 rtw_txframes_pending(struct adapter *padapter); 433 void rtw_init_hwxmits(struct hw_xmit *phwxmit, signed int entry); 434 435 436 s32 _rtw_init_xmit_priv(struct xmit_priv *pxmitpriv, struct adapter *padapter); 437 void _rtw_free_xmit_priv(struct xmit_priv *pxmitpriv); 438 439 440 void rtw_free_hwxmits(struct adapter *padapter); 441 442 443 s32 rtw_xmit(struct adapter *padapter, struct sk_buff **pkt); 444 bool xmitframe_hiq_filter(struct xmit_frame *xmitframe); 445 446 signed int xmitframe_enqueue_for_sleeping_sta(struct adapter *padapter, struct xmit_frame *pxmitframe); 447 void stop_sta_xmit(struct adapter *padapter, struct sta_info *psta); 448 void wakeup_sta_to_xmit(struct adapter *padapter, struct sta_info *psta); 449 void xmit_delivery_enabled_frames(struct adapter *padapter, struct sta_info *psta); 450 451 u8 query_ra_short_GI(struct sta_info *psta); 452 453 u8 qos_acm(u8 acm_mask, u8 priority); 454 455 void enqueue_pending_xmitbuf(struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf); 456 void enqueue_pending_xmitbuf_to_head(struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf); 457 struct xmit_buf *dequeue_pending_xmitbuf(struct xmit_priv *pxmitpriv); 458 struct xmit_buf *dequeue_pending_xmitbuf_under_survey(struct xmit_priv *pxmitpriv); 459 signed int check_pending_xmitbuf(struct xmit_priv *pxmitpriv); 460 int rtw_xmit_thread(void *context); 461 462 u32 rtw_get_ff_hwaddr(struct xmit_frame *pxmitframe); 463 464 int rtw_ack_tx_wait(struct xmit_priv *pxmitpriv, u32 timeout_ms); 465 void rtw_ack_tx_done(struct xmit_priv *pxmitpriv, int status); 466 467 /* include after declaring struct xmit_buf, in order to avoid warning */ 468 #include <xmit_osdep.h> 469 470 #endif /* _RTL871X_XMIT_H_ */ 471