• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2017 Realtek Corporation.
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  *****************************************************************************/
15 #ifndef	__RTW_RF_H_
16 #define __RTW_RF_H_
17 
18 #define NumRates	(13)
19 #define	B_MODE_RATE_NUM	(4)
20 #define	G_MODE_RATE_NUM	(8)
21 #define	G_MODE_BASIC_RATE_NUM	(3)
22 /* slot time for 11g */
23 #define SHORT_SLOT_TIME					9
24 #define NON_SHORT_SLOT_TIME				20
25 
26 #define CENTER_CH_2G_NUM		14
27 #define CENTER_CH_2G_40M_NUM	9
28 
29 #define CENTER_CH_5G_20M_NUM	28	/* 20M center channels */
30 #define CENTER_CH_5G_40M_NUM	14	/* 40M center channels */
31 #define CENTER_CH_5G_80M_NUM	7	/* 80M center channels */
32 #define CENTER_CH_5G_160M_NUM	3	/* 160M center channels */
33 #define CENTER_CH_5G_ALL_NUM	(CENTER_CH_5G_20M_NUM + CENTER_CH_5G_40M_NUM + CENTER_CH_5G_80M_NUM)
34 
35 #define CENTER_CH_6G_20M_NUM	64	/* 20M center channels */
36 #define CENTER_CH_6G_40M_NUM	32	/* 40M center channels */
37 #define CENTER_CH_6G_80M_NUM	16	/* 80M center channels */
38 #define CENTER_CH_6G_160M_NUM	8	/* 160M center channels */
39 
40 #define	MAX_CHANNEL_NUM_2G		CENTER_CH_2G_NUM
41 #define	MAX_CHANNEL_NUM_5G		CENTER_CH_5G_20M_NUM
42 #define MAX_CHANNEL_NUM_6G		CENTER_CH_6G_20M_NUM
43 #define MAX_CHANNEL_NUM_2G_5G	(MAX_CHANNEL_NUM_2G + MAX_CHANNEL_NUM_5G)
44 
45 #define	MAX_CHANNEL_NUM		( \
46 	MAX_CHANNEL_NUM_2G \
47 	+ (CONFIG_IEEE80211_BAND_5GHZ ? MAX_CHANNEL_NUM_5G : 0) \
48 	+ (CONFIG_IEEE80211_BAND_6GHZ ? MAX_CHANNEL_NUM_6G : 0) \
49 	)
50 
51 extern u8 center_ch_2g[CENTER_CH_2G_NUM];
52 extern u8 center_ch_2g_40m[CENTER_CH_2G_40M_NUM];
53 
54 u8 center_chs_2g_num(u8 bw);
55 u8 center_chs_2g(u8 bw, u8 id);
56 
57 extern u8 center_ch_5g_20m[CENTER_CH_5G_20M_NUM];
58 extern u8 center_ch_5g_40m[CENTER_CH_5G_40M_NUM];
59 extern u8 center_ch_5g_20m_40m[CENTER_CH_5G_20M_NUM + CENTER_CH_5G_40M_NUM];
60 extern u8 center_ch_5g_80m[CENTER_CH_5G_80M_NUM];
61 extern u8 center_ch_5g_all[CENTER_CH_5G_ALL_NUM];
62 
63 u8 center_chs_5g_num(u8 bw);
64 u8 center_chs_5g(u8 bw, u8 id);
65 
66 u8 rtw_get_scch_by_cch_offset(u8 cch, u8 bw, u8 offset);
67 u8 rtw_get_scch_by_cch_opch(u8 cch, u8 bw, u8 opch);
68 
69 u8 rtw_get_op_chs_by_cch_bw(u8 cch, u8 bw, u8 **op_chs, u8 *op_ch_num);
70 
71 u8 rtw_get_offset_by_chbw(u8 ch, u8 bw, u8 *r_offset);
72 u8 rtw_get_center_ch(u8 ch, u8 bw, u8 offset);
73 
74 u8 rtw_get_ch_group(u8 ch, u8 *group, u8 *cck_group);
75 
76 typedef enum _CAPABILITY {
77 	cESS			= 0x0001,
78 	cIBSS			= 0x0002,
79 	cPollable		= 0x0004,
80 	cPollReq			= 0x0008,
81 	cPrivacy		= 0x0010,
82 	cShortPreamble	= 0x0020,
83 	cPBCC			= 0x0040,
84 	cChannelAgility	= 0x0080,
85 	cSpectrumMgnt	= 0x0100,
86 	cQos			= 0x0200,	/* For HCCA, use with CF-Pollable and CF-PollReq */
87 	cShortSlotTime	= 0x0400,
88 	cAPSD			= 0x0800,
89 	cRM				= 0x1000,	/* RRM (Radio Request Measurement) */
90 	cDSSS_OFDM	= 0x2000,
91 	cDelayedBA		= 0x4000,
92 	cImmediateBA	= 0x8000,
93 } CAPABILITY, *PCAPABILITY;
94 
95 enum	_REG_PREAMBLE_MODE {
96 	PREAMBLE_LONG	= 1,
97 	PREAMBLE_AUTO	= 2,
98 	PREAMBLE_SHORT	= 3,
99 };
100 
101 #define rf_path_char(path) (((path) >= RF_PATH_MAX) ? 'X' : 'A' + (path))
102 
103 /* Bandwidth Offset */
104 #define HAL_PRIME_CHNL_OFFSET_DONT_CARE	0
105 #define HAL_PRIME_CHNL_OFFSET_LOWER	1
106 #define HAL_PRIME_CHNL_OFFSET_UPPER	2
107 
108 typedef enum _BAND_TYPE {
109 	BAND_ON_2_4G = 0,
110 	BAND_ON_5G = 1,
111 #if CONFIG_IEEE80211_BAND_6GHZ
112 	BAND_ON_6G = 2,
113 #endif
114 	BAND_MAX,
115 } BAND_TYPE, *PBAND_TYPE;
116 
117 #ifdef CONFIG_NARROWBAND_SUPPORTING
118 enum nb_config {
119 	RTW_NB_CONFIG_NONE		= 0,
120 	RTW_NB_CONFIG_WIDTH_5	= 5,
121 	RTW_NB_CONFIG_WIDTH_10	= 6,
122 };
123 #endif
124 
125 extern const char *const _band_str[];
126 #define band_str(band) (((band) >= BAND_MAX) ? _band_str[BAND_MAX] : _band_str[(band)])
127 
128 extern const u8 _band_to_band_cap[];
129 #define band_to_band_cap(band) (((band) >= BAND_MAX) ? _band_to_band_cap[BAND_MAX] : _band_to_band_cap[(band)])
130 
131 
132 extern const char *const _ch_width_str[];
133 #define ch_width_str(bw) (((bw) < CHANNEL_WIDTH_MAX) ? _ch_width_str[(bw)] : "CHANNEL_WIDTH_MAX")
134 
135 extern const u8 _ch_width_to_bw_cap[];
136 #define ch_width_to_bw_cap(bw) (((bw) < CHANNEL_WIDTH_MAX) ? _ch_width_to_bw_cap[(bw)] : 0)
137 
138 enum opc_bw {
139 	OPC_BW20		= 0,
140 	OPC_BW40PLUS	= 1,
141 	OPC_BW40MINUS	= 2,
142 	OPC_BW80		= 3,
143 	OPC_BW160		= 4,
144 	OPC_BW80P80		= 5,
145 	OPC_BW_NUM,
146 };
147 
148 extern const char *const _opc_bw_str[OPC_BW_NUM];
149 #define opc_bw_str(bw) (((bw) < OPC_BW_NUM) ? _opc_bw_str[(bw)] : "N/A")
150 
151 extern const u8 _opc_bw_to_ch_width[OPC_BW_NUM];
152 #define opc_bw_to_ch_width(bw) (((bw) < OPC_BW_NUM) ? _opc_bw_to_ch_width[(bw)] : CHANNEL_WIDTH_MAX)
153 
154 /* global op class APIs */
155 bool is_valid_global_op_class_id(u8 gid);
156 s16 get_sub_op_class(u8 gid, u8 ch);
157 void dump_global_op_class(void *sel);
158 u8 rtw_get_op_class_by_chbw(u8 ch, u8 bw, u8 offset);
159 u8 rtw_get_bw_offset_by_op_class_ch(u8 gid, u8 ch, u8 *bw, u8 *offset);
160 int get_supported_op_class(_adapter *padapter, u8 *op_set, int len);
161 
162 struct op_ch_t {
163 	u8 ch;
164 	u8 static_non_op:1; /* not in channel list */
165 	u8 no_ir:1;
166 	s16 max_txpwr; /* mBm */
167 };
168 
169 struct op_class_pref_t {
170 	u8 class_id;
171 	BAND_TYPE band;
172 	enum opc_bw bw;
173 	u8 ch_num; /* number of chs */
174 	u8 op_ch_num; /* channel number which is not static non operable */
175 	u8 ir_ch_num; /* channel number which can init radiation */
176 	struct op_ch_t chs[];
177 };
178 
179 int op_class_pref_init(_adapter *adapter);
180 void op_class_pref_deinit(_adapter *adapter);
181 
182 #define REG_BEACON_HINT		0
183 #define REG_TXPWR_CHANGE	1
184 #define REG_CHANGE			2
185 
186 void op_class_pref_apply_regulatory(_adapter *adapter, u8 reason);
187 
188 struct rf_ctl_t;
189 void dump_cap_spt_op_class_ch(void *sel, struct rf_ctl_t *rfctl, bool detail);
190 void dump_reg_spt_op_class_ch(void *sel, struct rf_ctl_t *rfctl, bool detail);
191 void dump_cur_spt_op_class_ch(void *sel, struct rf_ctl_t *rfctl, bool detail);
192 
193 /*
194  * Represent Extention Channel Offset in HT Capabilities
195  * This is available only in 40Mhz mode.
196  *   */
197 typedef enum _EXTCHNL_OFFSET {
198 	EXTCHNL_OFFSET_NO_EXT = 0,
199 	EXTCHNL_OFFSET_UPPER = 1,
200 	EXTCHNL_OFFSET_NO_DEF = 2,
201 	EXTCHNL_OFFSET_LOWER = 3,
202 } EXTCHNL_OFFSET, *PEXTCHNL_OFFSET;
203 
204 typedef enum _VHT_DATA_SC {
205 	VHT_DATA_SC_DONOT_CARE = 0,
206 	VHT_DATA_SC_20_UPPER_OF_80MHZ = 1,
207 	VHT_DATA_SC_20_LOWER_OF_80MHZ = 2,
208 	VHT_DATA_SC_20_UPPERST_OF_80MHZ = 3,
209 	VHT_DATA_SC_20_LOWEST_OF_80MHZ = 4,
210 	VHT_DATA_SC_20_RECV1 = 5,
211 	VHT_DATA_SC_20_RECV2 = 6,
212 	VHT_DATA_SC_20_RECV3 = 7,
213 	VHT_DATA_SC_20_RECV4 = 8,
214 	VHT_DATA_SC_40_UPPER_OF_80MHZ = 9,
215 	VHT_DATA_SC_40_LOWER_OF_80MHZ = 10,
216 } VHT_DATA_SC, *PVHT_DATA_SC_E;
217 
218 typedef enum _PROTECTION_MODE {
219 	PROTECTION_MODE_AUTO = 0,
220 	PROTECTION_MODE_FORCE_ENABLE = 1,
221 	PROTECTION_MODE_FORCE_DISABLE = 2,
222 } PROTECTION_MODE, *PPROTECTION_MODE;
223 
224 #define RF_TYPE_VALID(rf_type) (rf_type < RF_TYPE_MAX)
225 
226 extern const u8 _rf_type_to_rf_tx_cnt[];
227 #define rf_type_to_rf_tx_cnt(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rf_tx_cnt[rf_type] : 0)
228 
229 extern const u8 _rf_type_to_rf_rx_cnt[];
230 #define rf_type_to_rf_rx_cnt(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rf_rx_cnt[rf_type] : 0)
231 
232 extern const char *const _rf_type_to_rfpath_str[];
233 #define rf_type_to_rfpath_str(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rfpath_str[rf_type] : "UNKNOWN")
234 
235 void rf_type_to_default_trx_bmp(enum rf_type rf, enum bb_path *tx, enum bb_path *rx);
236 
237 enum rf_type trx_num_to_rf_type(u8 tx_num, u8 rx_num);
238 enum rf_type trx_bmp_to_rf_type(u8 tx_bmp, u8 rx_bmp);
239 bool rf_type_is_a_in_b(enum rf_type a, enum rf_type b);
240 u8 rtw_restrict_trx_path_bmp_by_trx_num_lmt(u8 trx_path_bmp, u8 tx_num_lmt, u8 rx_num_lmt, u8 *tx_num, u8 *rx_num);
241 u8 rtw_restrict_trx_path_bmp_by_rftype(u8 trx_path_bmp, enum rf_type type, u8 *tx_num, u8 *rx_num);
242 void tx_path_nss_set_default(enum bb_path txpath_nss[], u8 txpath_num_nss[], u8 txpath);
243 void tx_path_nss_set_full_tx(enum bb_path txpath_nss[], u8 txpath_num_nss[], u8 txpath);
244 
245 #if CONFIG_IEEE80211_BAND_6GHZ
246 int rtw_6gch2freq(int chan);
247 #endif
248 
249 int rtw_ch2freq(int chan);
250 int rtw_ch2freq_by_band(BAND_TYPE band, int ch);
251 int rtw_freq2ch(int freq);
252 BAND_TYPE rtw_freq2band(int freq);
253 bool rtw_freq_consecutive(int a, int b);
254 bool rtw_chbw_to_freq_range(u8 ch, u8 bw, u8 offset, u32 *hi, u32 *lo);
255 
256 struct rf_ctl_t;
257 
258 void txpwr_idx_get_dbm_str(s8 idx, u8 txgi_max, u8 txgi_pdbm, SIZE_T cwidth, char dbm_str[], u8 dbm_str_len);
259 
260 #define MBM_PDBM 100
261 #define UNSPECIFIED_MBM 32767 /* maximum of s16 */
262 
263 void txpwr_mbm_get_dbm_str(s16 mbm, SIZE_T cwidth, char dbm_str[], u8 dbm_str_len);
264 s16 mb_of_ntx(u8 ntx);
265 
266 #if CONFIG_TXPWR_LIMIT
267 struct regd_exc_ent {
268 	_list list;
269 	char country[2];
270 	u8 domain;
271 	char lmt_name[0];
272 };
273 
274 void dump_regd_exc_list(void *sel, struct rf_ctl_t *rfctl);
275 void rtw_regd_exc_add_with_nlen(struct rf_ctl_t *rfctl, const char *country, u8 domain, const char *lmt_name, u32 nlen);
276 void rtw_regd_exc_add(struct rf_ctl_t *rfctl, const char *country, u8 domain, const char *lmt_name);
277 struct regd_exc_ent *_rtw_regd_exc_search(struct rf_ctl_t *rfctl, const char *country, u8 domain);
278 struct regd_exc_ent *rtw_regd_exc_search(struct rf_ctl_t *rfctl, const char *country, u8 domain);
279 void rtw_regd_exc_list_free(struct rf_ctl_t *rfctl);
280 
281 void dump_txpwr_lmt(void *sel, _adapter *adapter);
282 void rtw_txpwr_lmt_add_with_nlen(struct rf_ctl_t *rfctl, const char *lmt_name, u32 nlen
283 	, u8 band, u8 bw, u8 tlrs, u8 ntx_idx, u8 ch_idx, s8 lmt);
284 void rtw_txpwr_lmt_add(struct rf_ctl_t *rfctl, const char *lmt_name
285 	, u8 band, u8 bw, u8 tlrs, u8 ntx_idx, u8 ch_idx, s8 lmt);
286 struct txpwr_lmt_ent *_rtw_txpwr_lmt_get_by_name(struct rf_ctl_t *rfctl, const char *lmt_name);
287 struct txpwr_lmt_ent *rtw_txpwr_lmt_get_by_name(struct rf_ctl_t *rfctl, const char *lmt_name);
288 void rtw_txpwr_lmt_list_free(struct rf_ctl_t *rfctl);
289 #endif /* CONFIG_TXPWR_LIMIT */
290 
291 #define BB_GAIN_2G 0
292 #if CONFIG_IEEE80211_BAND_5GHZ
293 #define BB_GAIN_5GLB1 1
294 #define BB_GAIN_5GLB2 2
295 #define BB_GAIN_5GMB1 3
296 #define BB_GAIN_5GMB2 4
297 #define BB_GAIN_5GHB 5
298 #endif
299 
300 #if CONFIG_IEEE80211_BAND_5GHZ
301 #define BB_GAIN_NUM 6
302 #else
303 #define BB_GAIN_NUM 1
304 #endif
305 
306 int rtw_ch_to_bb_gain_sel(int ch);
307 void rtw_rf_set_tx_gain_offset(_adapter *adapter, u8 path, s8 offset);
308 void rtw_rf_apply_tx_gain_offset(_adapter *adapter, u8 ch);
309 
310 /* only check channel ranges */
311 #define rtw_is_2g_ch(ch) (ch >= 1 && ch <= 14)
312 #define rtw_is_5g_ch(ch) ((ch) >= 36 && (ch) <= 177)
313 #define rtw_is_same_band(a, b) \
314 	((rtw_is_2g_ch(a) && rtw_is_2g_ch(b)) \
315 	|| (rtw_is_5g_ch(a) && rtw_is_5g_ch(b)))
316 
317 #define rtw_is_5g_band1(ch) ((ch) >= 36 && (ch) <= 48)
318 #define rtw_is_5g_band2(ch) ((ch) >= 52 && (ch) <= 64)
319 #define rtw_is_5g_band3(ch) ((ch) >= 100 && (ch) <= 144)
320 #define rtw_is_5g_band4(ch) ((ch) >= 149 && (ch) <= 177)
321 #define rtw_is_same_5g_band(a, b) \
322 	((rtw_is_5g_band1(a) && rtw_is_5g_band1(b)) \
323 	|| (rtw_is_5g_band2(a) && rtw_is_5g_band2(b)) \
324 	|| (rtw_is_5g_band3(a) && rtw_is_5g_band3(b)) \
325 	|| (rtw_is_5g_band4(a) && rtw_is_5g_band4(b)))
326 
327 #define rtw_is_6g_band1(ch) ((ch) >= 1 && (ch) <= 93)
328 #define rtw_is_6g_band2(ch) ((ch) >= 97 && (ch) <= 117)
329 #define rtw_is_6g_band3(ch) ((ch) >= 121 && (ch) <= 189)
330 #define rtw_is_6g_band4(ch) ((ch) >= 193 && (ch) <= 237)
331 
332 bool rtw_is_long_cac_range(u32 hi, u32 lo, u8 dfs_region);
333 bool rtw_is_long_cac_ch(u8 ch, u8 bw, u8 offset, u8 dfs_region);
334 
335 #endif /* _RTL8711_RF_H_ */
336