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