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