xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8822bs/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 
38 extern u8 center_ch_2g[CENTER_CH_2G_NUM];
39 extern u8 center_ch_2g_40m[CENTER_CH_2G_40M_NUM];
40 
41 u8 center_chs_2g_num(u8 bw);
42 u8 center_chs_2g(u8 bw, u8 id);
43 
44 extern u8 center_ch_5g_20m[CENTER_CH_5G_20M_NUM];
45 extern u8 center_ch_5g_40m[CENTER_CH_5G_40M_NUM];
46 extern u8 center_ch_5g_20m_40m[CENTER_CH_5G_20M_NUM + CENTER_CH_5G_40M_NUM];
47 extern u8 center_ch_5g_80m[CENTER_CH_5G_80M_NUM];
48 extern u8 center_ch_5g_all[CENTER_CH_5G_ALL_NUM];
49 
50 u8 center_chs_5g_num(u8 bw);
51 u8 center_chs_5g(u8 bw, u8 id);
52 
53 u8 rtw_get_scch_by_cch_offset(u8 cch, u8 bw, u8 offset);
54 u8 rtw_get_scch_by_cch_opch(u8 cch, u8 bw, u8 opch);
55 
56 u8 rtw_get_op_chs_by_cch_bw(u8 cch, u8 bw, u8 **op_chs, u8 *op_ch_num);
57 
58 u8 rtw_get_ch_group(u8 ch, u8 *group, u8 *cck_group);
59 
60 typedef enum _CAPABILITY {
61 	cESS			= 0x0001,
62 	cIBSS			= 0x0002,
63 	cPollable		= 0x0004,
64 	cPollReq			= 0x0008,
65 	cPrivacy		= 0x0010,
66 	cShortPreamble	= 0x0020,
67 	cPBCC			= 0x0040,
68 	cChannelAgility	= 0x0080,
69 	cSpectrumMgnt	= 0x0100,
70 	cQos			= 0x0200,	/* For HCCA, use with CF-Pollable and CF-PollReq */
71 	cShortSlotTime	= 0x0400,
72 	cAPSD			= 0x0800,
73 	cRM				= 0x1000,	/* RRM (Radio Request Measurement) */
74 	cDSSS_OFDM	= 0x2000,
75 	cDelayedBA		= 0x4000,
76 	cImmediateBA	= 0x8000,
77 } CAPABILITY, *PCAPABILITY;
78 
79 enum	_REG_PREAMBLE_MODE {
80 	PREAMBLE_LONG	= 1,
81 	PREAMBLE_AUTO	= 2,
82 	PREAMBLE_SHORT	= 3,
83 };
84 
85 #define rf_path_char(path) (((path) >= RF_PATH_MAX) ? 'X' : 'A' + (path))
86 
87 /* Bandwidth Offset */
88 #define HAL_PRIME_CHNL_OFFSET_DONT_CARE	0
89 #define HAL_PRIME_CHNL_OFFSET_LOWER	1
90 #define HAL_PRIME_CHNL_OFFSET_UPPER	2
91 
92 typedef enum _BAND_TYPE {
93 	BAND_ON_2_4G = 0,
94 	BAND_ON_5G = 1,
95 	BAND_MAX,
96 } BAND_TYPE, *PBAND_TYPE;
97 
98 #ifdef CONFIG_NARROWBAND_SUPPORTING
99 enum nb_config {
100 	RTW_NB_CONFIG_NONE		= 0,
101 	RTW_NB_CONFIG_WIDTH_5	= 5,
102 	RTW_NB_CONFIG_WIDTH_10	= 6,
103 };
104 #endif
105 
106 extern const char *const _band_str[];
107 #define band_str(band) (((band) >= BAND_MAX) ? _band_str[BAND_MAX] : _band_str[(band)])
108 
109 extern const u8 _band_to_band_cap[];
110 #define band_to_band_cap(band) (((band) >= BAND_MAX) ? _band_to_band_cap[BAND_MAX] : _band_to_band_cap[(band)])
111 
112 
113 extern const char *const _ch_width_str[];
114 #define ch_width_str(bw) (((bw) < CHANNEL_WIDTH_MAX) ? _ch_width_str[(bw)] : "CHANNEL_WIDTH_MAX")
115 
116 extern const u8 _ch_width_to_bw_cap[];
117 #define ch_width_to_bw_cap(bw) (((bw) < CHANNEL_WIDTH_MAX) ? _ch_width_to_bw_cap[(bw)] : 0)
118 
119 /*
120  * Represent Extention Channel Offset in HT Capabilities
121  * This is available only in 40Mhz mode.
122  *   */
123 typedef enum _EXTCHNL_OFFSET {
124 	EXTCHNL_OFFSET_NO_EXT = 0,
125 	EXTCHNL_OFFSET_UPPER = 1,
126 	EXTCHNL_OFFSET_NO_DEF = 2,
127 	EXTCHNL_OFFSET_LOWER = 3,
128 } EXTCHNL_OFFSET, *PEXTCHNL_OFFSET;
129 
130 typedef enum _VHT_DATA_SC {
131 	VHT_DATA_SC_DONOT_CARE = 0,
132 	VHT_DATA_SC_20_UPPER_OF_80MHZ = 1,
133 	VHT_DATA_SC_20_LOWER_OF_80MHZ = 2,
134 	VHT_DATA_SC_20_UPPERST_OF_80MHZ = 3,
135 	VHT_DATA_SC_20_LOWEST_OF_80MHZ = 4,
136 	VHT_DATA_SC_20_RECV1 = 5,
137 	VHT_DATA_SC_20_RECV2 = 6,
138 	VHT_DATA_SC_20_RECV3 = 7,
139 	VHT_DATA_SC_20_RECV4 = 8,
140 	VHT_DATA_SC_40_UPPER_OF_80MHZ = 9,
141 	VHT_DATA_SC_40_LOWER_OF_80MHZ = 10,
142 } VHT_DATA_SC, *PVHT_DATA_SC_E;
143 
144 typedef enum _PROTECTION_MODE {
145 	PROTECTION_MODE_AUTO = 0,
146 	PROTECTION_MODE_FORCE_ENABLE = 1,
147 	PROTECTION_MODE_FORCE_DISABLE = 2,
148 } PROTECTION_MODE, *PPROTECTION_MODE;
149 
150 #define RF_TYPE_VALID(rf_type) (rf_type < RF_TYPE_MAX)
151 
152 extern const u8 _rf_type_to_rf_tx_cnt[];
153 #define rf_type_to_rf_tx_cnt(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rf_tx_cnt[rf_type] : 0)
154 
155 extern const u8 _rf_type_to_rf_rx_cnt[];
156 #define rf_type_to_rf_rx_cnt(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rf_rx_cnt[rf_type] : 0)
157 
158 extern const char *const _rf_type_to_rfpath_str[];
159 #define rf_type_to_rfpath_str(rf_type) (RF_TYPE_VALID(rf_type) ? _rf_type_to_rfpath_str[rf_type] : "UNKNOWN")
160 
161 void rf_type_to_default_trx_bmp(enum rf_type rf, enum bb_path *tx, enum bb_path *rx);
162 
163 enum rf_type trx_num_to_rf_type(u8 tx_num, u8 rx_num);
164 enum rf_type trx_bmp_to_rf_type(u8 tx_bmp, u8 rx_bmp);
165 bool rf_type_is_a_in_b(enum rf_type a, enum rf_type b);
166 u8 rtw_restrict_trx_path_bmp_by_rftype(u8 trx_path_bmp, enum rf_type type, u8 *tx_num, u8 *rx_num);
167 void tx_path_nss_set_default(enum bb_path txpath_nss[], u8 txpath_num_nss[], u8 txpath);
168 void tx_path_nss_set_full_tx(enum bb_path txpath_nss[], u8 txpath_num_nss[], u8 txpath);
169 
170 int rtw_ch2freq(int chan);
171 int rtw_freq2ch(int freq);
172 bool rtw_chbw_to_freq_range(u8 ch, u8 bw, u8 offset, u32 *hi, u32 *lo);
173 
174 struct rf_ctl_t;
175 
176 typedef enum _REGULATION_TXPWR_LMT {
177 	TXPWR_LMT_NONE = 0, /* no limit */
178 	TXPWR_LMT_FCC = 1,
179 	TXPWR_LMT_MKK = 2,
180 	TXPWR_LMT_ETSI = 3,
181 	TXPWR_LMT_IC = 4,
182 	TXPWR_LMT_KCC = 5,
183 	TXPWR_LMT_ACMA = 6,
184 	TXPWR_LMT_CHILE = 7,
185 	TXPWR_LMT_MEXICO = 8,
186 	TXPWR_LMT_WW = 9, /* smallest of all available limit, keep last */
187 } REGULATION_TXPWR_LMT;
188 
189 extern const char *const _regd_str[];
190 #define regd_str(regd) (((regd) > TXPWR_LMT_WW) ? _regd_str[TXPWR_LMT_WW] : _regd_str[(regd)])
191 
192 void txpwr_idx_get_dbm_str(s8 idx, u8 txgi_max, u8 txgi_pdbm, SIZE_T cwidth, char dbm_str[], u8 dbm_str_len);
193 
194 #define MBM_PDBM 100
195 #define UNSPECIFIED_MBM 32767 /* maximum of s16 */
196 
197 void txpwr_mbm_get_dbm_str(s16 mbm, SIZE_T cwidth, char dbm_str[], u8 dbm_str_len);
198 s16 mb_of_ntx(u8 ntx);
199 
200 #if CONFIG_TXPWR_LIMIT
201 struct regd_exc_ent {
202 	_list list;
203 	char country[2];
204 	u8 domain;
205 	char regd_name[0];
206 };
207 
208 void dump_regd_exc_list(void *sel, struct rf_ctl_t *rfctl);
209 void rtw_regd_exc_add_with_nlen(struct rf_ctl_t *rfctl, const char *country, u8 domain, const char *regd_name, u32 nlen);
210 void rtw_regd_exc_add(struct rf_ctl_t *rfctl, const char *country, u8 domain, const char *regd_name);
211 struct regd_exc_ent *_rtw_regd_exc_search(struct rf_ctl_t *rfctl, const char *country, u8 domain);
212 struct regd_exc_ent *rtw_regd_exc_search(struct rf_ctl_t *rfctl, const char *country, u8 domain);
213 void rtw_regd_exc_list_free(struct rf_ctl_t *rfctl);
214 
215 void dump_txpwr_lmt(void *sel, _adapter *adapter);
216 void rtw_txpwr_lmt_add_with_nlen(struct rf_ctl_t *rfctl, const char *regd_name, u32 nlen
217 	, u8 band, u8 bw, u8 tlrs, u8 ntx_idx, u8 ch_idx, s8 lmt);
218 void rtw_txpwr_lmt_add(struct rf_ctl_t *rfctl, const char *regd_name
219 	, u8 band, u8 bw, u8 tlrs, u8 ntx_idx, u8 ch_idx, s8 lmt);
220 struct txpwr_lmt_ent *_rtw_txpwr_lmt_get_by_name(struct rf_ctl_t *rfctl, const char *regd_name);
221 struct txpwr_lmt_ent *rtw_txpwr_lmt_get_by_name(struct rf_ctl_t *rfctl, const char *regd_name);
222 void rtw_txpwr_lmt_list_free(struct rf_ctl_t *rfctl);
223 #endif /* CONFIG_TXPWR_LIMIT */
224 
225 #define BB_GAIN_2G 0
226 #if CONFIG_IEEE80211_BAND_5GHZ
227 #define BB_GAIN_5GLB1 1
228 #define BB_GAIN_5GLB2 2
229 #define BB_GAIN_5GMB1 3
230 #define BB_GAIN_5GMB2 4
231 #define BB_GAIN_5GHB 5
232 #endif
233 
234 #if CONFIG_IEEE80211_BAND_5GHZ
235 #define BB_GAIN_NUM 6
236 #else
237 #define BB_GAIN_NUM 1
238 #endif
239 
240 int rtw_ch_to_bb_gain_sel(int ch);
241 void rtw_rf_set_tx_gain_offset(_adapter *adapter, u8 path, s8 offset);
242 void rtw_rf_apply_tx_gain_offset(_adapter *adapter, u8 ch);
243 
244 /* only check channel ranges */
245 #define rtw_is_2g_ch(ch) (ch >= 1 && ch <= 14)
246 #define rtw_is_5g_ch(ch) ((ch) >= 36 && (ch) <= 177)
247 #define rtw_is_same_band(a, b) \
248 	((rtw_is_2g_ch(a) && rtw_is_2g_ch(b)) \
249 	|| (rtw_is_5g_ch(a) && rtw_is_5g_ch(b)))
250 
251 #define rtw_is_5g_band1(ch) ((ch) >= 36 && (ch) <= 48)
252 #define rtw_is_5g_band2(ch) ((ch) >= 52 && (ch) <= 64)
253 #define rtw_is_5g_band3(ch) ((ch) >= 100 && (ch) <= 144)
254 #define rtw_is_5g_band4(ch) ((ch) >= 149 && (ch) <= 177)
255 #define rtw_is_same_5g_band(a, b) \
256 	((rtw_is_5g_band1(a) && rtw_is_5g_band1(b)) \
257 	|| (rtw_is_5g_band2(a) && rtw_is_5g_band2(b)) \
258 	|| (rtw_is_5g_band3(a) && rtw_is_5g_band3(b)) \
259 	|| (rtw_is_5g_band4(a) && rtw_is_5g_band4(b)))
260 
261 bool rtw_is_long_cac_range(u32 hi, u32 lo, u8 dfs_region);
262 bool rtw_is_long_cac_ch(u8 ch, u8 bw, u8 offset, u8 dfs_region);
263 
264 #endif /* _RTL8711_RF_H_ */
265