drivers/staging/rtlwifi/base.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /******************************************************************************
   3  *
   4  * Copyright(c) 2009-2012  Realtek Corporation.
   5  *
   6  * Contact Information:
   7  * wlanfae <wlanfae@realtek.com>
   8  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
   9  * Hsinchu 300, Taiwan.
  10  *
  11  * Larry Finger <Larry.Finger@lwfinger.net>
  12  *
  13  *****************************************************************************/
  14
  15 #ifndef __RTL_BASE_H__
  16 #define __RTL_BASE_H__
  17
  18 enum ap_peer {
  19         PEER_UNKNOWN = 0,
  20         PEER_RTL = 1,
  21         PEER_RTL_92SE = 2,
  22         PEER_BROAD = 3,
  23         PEER_RAL = 4,
  24         PEER_ATH = 5,
  25         PEER_CISCO = 6,
  26         PEER_MARV = 7,
  27         PEER_AIRGO = 9,
  28         PEER_MAX = 10,
  29 };
  30
  31 #define RTL_DUMMY_OFFSET        0
  32 #define RTL_DUMMY_UNIT          8
  33 #define RTL_TX_DUMMY_SIZE       (RTL_DUMMY_OFFSET * RTL_DUMMY_UNIT)
  34 #define RTL_TX_DESC_SIZE        32
  35 #define RTL_TX_HEADER_SIZE      (RTL_TX_DESC_SIZE + RTL_TX_DUMMY_SIZE)
  36
  37 #define MAX_BIT_RATE_40MHZ_MCS15        300     /* Mbps */
  38 #define MAX_BIT_RATE_40MHZ_MCS7         150     /* Mbps */
  39
  40 #define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS9   867     /* Mbps */
  41 #define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS7   650     /* Mbps */
  42 #define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS9    780     /* Mbps */
  43 #define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS7    585     /* Mbps */
  44
  45 #define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS9   434     /* Mbps */
  46 #define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS7   325     /* Mbps */
  47 #define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS9    390     /* Mbps */
  48 #define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS7    293     /* Mbps */
  49
  50 #define FRAME_OFFSET_FRAME_CONTROL      0
  51 #define FRAME_OFFSET_DURATION           2
  52 #define FRAME_OFFSET_ADDRESS1           4
  53 #define FRAME_OFFSET_ADDRESS2           10
  54 #define FRAME_OFFSET_ADDRESS3           16
  55 #define FRAME_OFFSET_SEQUENCE           22
  56 #define FRAME_OFFSET_ADDRESS4           24
  57 #define MAX_LISTEN_INTERVAL             10
  58 #define MAX_RATE_TRIES                  4
  59
  60 #define SET_80211_HDR_FRAME_CONTROL(_hdr, _val)         \
  61         WRITEEF2BYTE(_hdr, _val)
  62 #define SET_80211_HDR_TYPE_AND_SUBTYPE(_hdr, _val)      \
  63         WRITEEF1BYTE(_hdr, _val)
  64 #define SET_80211_HDR_PWR_MGNT(_hdr, _val)              \
  65         SET_BITS_TO_LE_2BYTE(_hdr, 12, 1, _val)
  66 #define SET_80211_HDR_TO_DS(_hdr, _val)                 \
  67         SET_BITS_TO_LE_2BYTE(_hdr, 8, 1, _val)
  68
  69 #define SET_80211_PS_POLL_AID(_hdr, _val)               \
  70         (*(u16 *)((u8 *)(_hdr) + 2) = _val)
  71 #define SET_80211_PS_POLL_BSSID(_hdr, _val)             \
  72         ether_addr_copy(((u8 *)(_hdr)) + 4, (u8 *)(_val))
  73 #define SET_80211_PS_POLL_TA(_hdr, _val)                \
  74         ether_addr_copy(((u8 *)(_hdr)) + 10, (u8 *)(_val))
  75
  76 #define SET_80211_HDR_DURATION(_hdr, _val)      \
  77         (*(u16 *)((u8 *)(_hdr) + FRAME_OFFSET_DURATION) = le16_to_cpu(_val))
  78 #define SET_80211_HDR_ADDRESS1(_hdr, _val)      \
  79         CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS1, (u8 *)(_val))
  80 #define SET_80211_HDR_ADDRESS2(_hdr, _val)      \
  81         CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS2, (u8 *)(_val))
  82 #define SET_80211_HDR_ADDRESS3(_hdr, _val)      \
  83         CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS3, (u8 *)(_val))
  84 #define SET_80211_HDR_FRAGMENT_SEQUENCE(_hdr, _val)  \
  85         WRITEEF2BYTE((u8 *)(_hdr) + FRAME_OFFSET_SEQUENCE, _val)
  86
  87 #define SET_BEACON_PROBE_RSP_TIME_STAMP_LOW(__phdr, __val)      \
  88         WRITEEF4BYTE(((u8 *)(__phdr)) + 24, __val)
  89 #define SET_BEACON_PROBE_RSP_TIME_STAMP_HIGH(__phdr, __val) \
  90         WRITEEF4BYTE(((u8 *)(__phdr)) + 28, __val)
  91 #define SET_BEACON_PROBE_RSP_BEACON_INTERVAL(__phdr, __val) \
  92         WRITEEF2BYTE(((u8 *)(__phdr)) + 32, __val)
  93 #define GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr)            \
  94         READEF2BYTE(((u8 *)(__phdr)) + 34)
  95 #define SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
  96         WRITEEF2BYTE(((u8 *)(__phdr)) + 34, __val)
  97 #define MASK_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
  98         SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, \
  99         (GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) & (~(__val))))
 100
 101 #define SET_TX_DESC_SPE_RPT(__pdesc, __val)                     \
 102         SET_BITS_TO_LE_4BYTE((__pdesc) + 8, 19, 1, __val)
 103 #define SET_TX_DESC_SW_DEFINE(__pdesc, __val)   \
 104         SET_BITS_TO_LE_4BYTE((__pdesc) + 24, 0, 12, __val)
 105
 106 int rtl_init_core(struct ieee80211_hw *hw);
 107 void rtl_deinit_core(struct ieee80211_hw *hw);
 108 void rtl_init_rx_config(struct ieee80211_hw *hw);
 109 void rtl_init_rfkill(struct ieee80211_hw *hw);
 110 void rtl_deinit_rfkill(struct ieee80211_hw *hw);
 111
 112 void rtl_watch_dog_timer_callback(struct timer_list *t);
 113 void rtl_deinit_deferred_work(struct ieee80211_hw *hw);
 114
 115 bool rtl_action_proc(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);
 116 int rtlwifi_rate_mapping(struct ieee80211_hw *hw, bool isht,
 117                          bool isvht, u8 desc_rate);
 118 bool rtl_tx_mgmt_proc(struct ieee80211_hw *hw, struct sk_buff *skb);
 119 u8 rtl_is_special_data(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx,
 120                        bool is_enc);
 121
 122 bool rtl_is_tx_report_skb(struct ieee80211_hw *hw, struct sk_buff *skb);
 123 void rtl_get_tx_report(struct rtl_tcb_desc *ptcb_desc, u8 *pdesc,
 124                        struct ieee80211_hw *hw);
 125 void rtl_tx_report_handler(struct ieee80211_hw *hw, u8 *tmp_buf,
 126                            u8 c2h_cmd_len);
 127 bool rtl_check_tx_report_acked(struct ieee80211_hw *hw);
 128 void rtl_wait_tx_report_acked(struct ieee80211_hw *hw, u32 wait_ms);
 129 u32 rtl_get_hal_edca_param(struct ieee80211_hw *hw,
 130                            struct ieee80211_vif *vif,
 131                            enum wireless_mode wirelessmode,
 132                            struct ieee80211_tx_queue_params *param);
 133
 134 void rtl_beacon_statistic(struct ieee80211_hw *hw, struct sk_buff *skb);
 135 void rtl_collect_scan_list(struct ieee80211_hw *hw, struct sk_buff *skb);
 136 void rtl_scan_list_expire(struct ieee80211_hw *hw);
 137 int rtl_tx_agg_start(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
 138                      struct ieee80211_sta *sta, u16 tid, u16 *ssn);
 139 int rtl_tx_agg_stop(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
 140                     struct ieee80211_sta *sta, u16 tid);
 141 int rtl_tx_agg_oper(struct ieee80211_hw *hw,
 142                     struct ieee80211_sta *sta, u16 tid);
 143 int rtl_rx_agg_start(struct ieee80211_hw *hw,
 144                      struct ieee80211_sta *sta, u16 tid);
 145 int rtl_rx_agg_stop(struct ieee80211_hw *hw,
 146                     struct ieee80211_sta *sta, u16 tid);
 147 void rtl_rx_ampdu_apply(struct rtl_priv *rtlpriv);
 148 void rtl_watchdog_wq_callback(void *data);
 149 void rtl_fwevt_wq_callback(void *data);
 150 void rtl_c2hcmd_wq_callback(void *data);
 151 void rtl_c2hcmd_launcher(struct ieee80211_hw *hw, int exec);
 152 void rtl_c2hcmd_enqueue(struct ieee80211_hw *hw, u8 tag, u8 len, u8 *val);
 153
 154 u8 rtl_mrate_idx_to_arfr_id(
 155         struct ieee80211_hw *hw, u8 rate_index,
 156         enum wireless_mode wirelessmode);
 157 void rtl_get_tcb_desc(struct ieee80211_hw *hw,
 158                       struct ieee80211_tx_info *info,
 159                       struct ieee80211_sta *sta,
 160                       struct sk_buff *skb, struct rtl_tcb_desc *tcb_desc);
 161
 162 int rtl_send_smps_action(struct ieee80211_hw *hw,
 163                          struct ieee80211_sta *sta,
 164                          enum ieee80211_smps_mode smps);
 165 u8 *rtl_find_ie(u8 *data, unsigned int len, u8 ie);
 166 void rtl_recognize_peer(struct ieee80211_hw *hw, u8 *data, unsigned int len);
 167 u8 rtl_tid_to_ac(u8 tid);
 168 void rtl_easy_concurrent_retrytimer_callback(struct timer_list *t);
 169 extern struct rtl_global_var rtl_global_var;
 170 void rtl_phy_scan_operation_backup(struct ieee80211_hw *hw, u8 operation);
 171 bool rtl_check_beacon_key(struct ieee80211_hw *hw, void *data,
 172                           unsigned int len);
 173 int rtl_core_module_init(void);
 174 void rtl_core_module_exit(void);
 175 #endif