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