1/* SPDX-License-Identifier: GPL-2.0 */ 2#ifndef LINUX_B43_PHY_COMMON_H_ 3#define LINUX_B43_PHY_COMMON_H_ 4 5#include <linux/types.h> 6#include <linux/nl80211.h> 7 8struct b43_wldev; 9 10/* Complex number using 2 32-bit signed integers */ 11struct b43_c32 { s32 i, q; }; 12 13#define CORDIC_CONVERT(value) (((value) >= 0) ? \ 14 ((((value) >> 15) + 1) >> 1) : \ 15 -((((-(value)) >> 15) + 1) >> 1)) 16 17/* PHY register routing bits */ 18#define B43_PHYROUTE 0x0C00 /* PHY register routing bits mask */ 19#define B43_PHYROUTE_BASE 0x0000 /* Base registers */ 20#define B43_PHYROUTE_OFDM_GPHY 0x0400 /* OFDM register routing for G-PHYs */ 21#define B43_PHYROUTE_EXT_GPHY 0x0800 /* Extended G-PHY registers */ 22#define B43_PHYROUTE_N_BMODE 0x0C00 /* N-PHY BMODE registers */ 23 24/* CCK (B-PHY) registers. */ 25#define B43_PHY_CCK(reg) ((reg) | B43_PHYROUTE_BASE) 26/* N-PHY registers. */ 27#define B43_PHY_N(reg) ((reg) | B43_PHYROUTE_BASE) 28/* N-PHY BMODE registers. */ 29#define B43_PHY_N_BMODE(reg) ((reg) | B43_PHYROUTE_N_BMODE) 30/* OFDM (A-PHY) registers. */ 31#define B43_PHY_OFDM(reg) ((reg) | B43_PHYROUTE_OFDM_GPHY) 32/* Extended G-PHY registers. */ 33#define B43_PHY_EXTG(reg) ((reg) | B43_PHYROUTE_EXT_GPHY) 34 35 36/* Masks for the PHY versioning registers. */ 37#define B43_PHYVER_ANALOG 0xF000 38#define B43_PHYVER_ANALOG_SHIFT 12 39#define B43_PHYVER_TYPE 0x0F00 40#define B43_PHYVER_TYPE_SHIFT 8 41#define B43_PHYVER_VERSION 0x00FF 42 43/* PHY writes need to be flushed if we reach limit */ 44#define B43_MAX_WRITES_IN_ROW 24 45 46/** 47 * enum b43_interference_mitigation - Interference Mitigation mode 48 * 49 * @B43_INTERFMODE_NONE: Disabled 50 * @B43_INTERFMODE_NONWLAN: Non-WLAN Interference Mitigation 51 * @B43_INTERFMODE_MANUALWLAN: WLAN Interference Mitigation 52 * @B43_INTERFMODE_AUTOWLAN: Automatic WLAN Interference Mitigation 53 */ 54enum b43_interference_mitigation { 55 B43_INTERFMODE_NONE, 56 B43_INTERFMODE_NONWLAN, 57 B43_INTERFMODE_MANUALWLAN, 58 B43_INTERFMODE_AUTOWLAN, 59}; 60 61/* Antenna identifiers */ 62enum { 63 B43_ANTENNA0 = 0, /* Antenna 0 */ 64 B43_ANTENNA1 = 1, /* Antenna 1 */ 65 B43_ANTENNA_AUTO0 = 2, /* Automatic, starting with antenna 0 */ 66 B43_ANTENNA_AUTO1 = 3, /* Automatic, starting with antenna 1 */ 67 B43_ANTENNA2 = 4, 68 B43_ANTENNA3 = 8, 69 70 B43_ANTENNA_AUTO = B43_ANTENNA_AUTO0, 71 B43_ANTENNA_DEFAULT = B43_ANTENNA_AUTO, 72}; 73 74/** 75 * enum b43_txpwr_result - Return value for the recalc_txpower PHY op. 76 * 77 * @B43_TXPWR_RES_NEED_ADJUST: Values changed. Hardware adjustment is needed. 78 * @B43_TXPWR_RES_DONE: No more work to do. Everything is done. 79 */ 80enum b43_txpwr_result { 81 B43_TXPWR_RES_NEED_ADJUST, 82 B43_TXPWR_RES_DONE, 83}; 84 85/** 86 * struct b43_phy_operations - Function pointers for PHY ops. 87 * 88 * @allocate: Allocate and initialise the PHY data structures. 89 * Must not be NULL. 90 * @free: Destroy and free the PHY data structures. 91 * Must not be NULL. 92 * 93 * @prepare_structs: Prepare the PHY data structures. 94 * The data structures allocated in @allocate are 95 * initialized here. 96 * Must not be NULL. 97 * @prepare_hardware: Prepare the PHY. This is called before b43_chip_init to 98 * do some early early PHY hardware init. 99 * Can be NULL, if not required. 100 * @init: Initialize the PHY. 101 * Must not be NULL. 102 * @exit: Shutdown the PHY. 103 * Can be NULL, if not required. 104 * 105 * @phy_read: Read from a PHY register. 106 * Must not be NULL. 107 * @phy_write: Write to a PHY register. 108 * Must not be NULL. 109 * @phy_maskset: Maskset a PHY register, taking shortcuts. 110 * If it is NULL, a generic algorithm is used. 111 * @radio_read: Read from a Radio register. 112 * Must not be NULL. 113 * @radio_write: Write to a Radio register. 114 * Must not be NULL. 115 * 116 * @supports_hwpctl: Returns a boolean whether Hardware Power Control 117 * is supported or not. 118 * If NULL, hwpctl is assumed to be never supported. 119 * @software_rfkill: Turn the radio ON or OFF. 120 * Possible state values are 121 * RFKILL_STATE_SOFT_BLOCKED or 122 * RFKILL_STATE_UNBLOCKED 123 * Must not be NULL. 124 * @switch_analog: Turn the Analog on/off. 125 * Must not be NULL. 126 * @switch_channel: Switch the radio to another channel. 127 * Must not be NULL. 128 * @get_default_chan: Just returns the default channel number. 129 * Must not be NULL. 130 * @set_rx_antenna: Set the antenna used for RX. 131 * Can be NULL, if not supported. 132 * @interf_mitigation: Switch the Interference Mitigation mode. 133 * Can be NULL, if not supported. 134 * 135 * @recalc_txpower: Recalculate the transmission power parameters. 136 * This callback has to recalculate the TX power settings, 137 * but does not need to write them to the hardware, yet. 138 * Returns enum b43_txpwr_result to indicate whether the hardware 139 * needs to be adjusted. 140 * If B43_TXPWR_NEED_ADJUST is returned, @adjust_txpower 141 * will be called later. 142 * If the parameter "ignore_tssi" is true, the TSSI values should 143 * be ignored and a recalculation of the power settings should be 144 * done even if the TSSI values did not change. 145 * This function may sleep, but should not. 146 * Must not be NULL. 147 * @adjust_txpower: Write the previously calculated TX power settings 148 * (from @recalc_txpower) to the hardware. 149 * This function may sleep. 150 * Can be NULL, if (and ONLY if) @recalc_txpower _always_ 151 * returns B43_TXPWR_RES_DONE. 152 * 153 * @pwork_15sec: Periodic work. Called every 15 seconds. 154 * Can be NULL, if not required. 155 * @pwork_60sec: Periodic work. Called every 60 seconds. 156 * Can be NULL, if not required. 157 */ 158struct b43_phy_operations { 159 /* Initialisation */ 160 int (*allocate)(struct b43_wldev *dev); 161 void (*free)(struct b43_wldev *dev); 162 void (*prepare_structs)(struct b43_wldev *dev); 163 int (*prepare_hardware)(struct b43_wldev *dev); 164 int (*init)(struct b43_wldev *dev); 165 void (*exit)(struct b43_wldev *dev); 166 167 /* Register access */ 168 u16 (*phy_read)(struct b43_wldev *dev, u16 reg); 169 void (*phy_write)(struct b43_wldev *dev, u16 reg, u16 value); 170 void (*phy_maskset)(struct b43_wldev *dev, u16 reg, u16 mask, u16 set); 171 u16 (*radio_read)(struct b43_wldev *dev, u16 reg); 172 void (*radio_write)(struct b43_wldev *dev, u16 reg, u16 value); 173 174 /* Radio */ 175 bool (*supports_hwpctl)(struct b43_wldev *dev); 176 void (*software_rfkill)(struct b43_wldev *dev, bool blocked); 177 void (*switch_analog)(struct b43_wldev *dev, bool on); 178 int (*switch_channel)(struct b43_wldev *dev, unsigned int new_channel); 179 unsigned int (*get_default_chan)(struct b43_wldev *dev); 180 void (*set_rx_antenna)(struct b43_wldev *dev, int antenna); 181 int (*interf_mitigation)(struct b43_wldev *dev, 182 enum b43_interference_mitigation new_mode); 183 184 /* Transmission power adjustment */ 185 enum b43_txpwr_result (*recalc_txpower)(struct b43_wldev *dev, 186 bool ignore_tssi); 187 void (*adjust_txpower)(struct b43_wldev *dev); 188 189 /* Misc */ 190 void (*pwork_15sec)(struct b43_wldev *dev); 191 void (*pwork_60sec)(struct b43_wldev *dev); 192}; 193 194struct b43_phy_g; 195struct b43_phy_n; 196struct b43_phy_lp; 197struct b43_phy_ht; 198struct b43_phy_lcn; 199 200struct b43_phy { 201 /* Hardware operation callbacks. */ 202 const struct b43_phy_operations *ops; 203 204 /* Most hardware context information is stored in the standard- 205 * specific data structures pointed to by the pointers below. 206 * Only one of them is valid (the currently enabled PHY). */ 207#ifdef CONFIG_B43_DEBUG 208 /* No union for debug build to force NULL derefs in buggy code. */ 209 struct { 210#else 211 union { 212#endif 213 /* G-PHY specific information */ 214 struct b43_phy_g *g; 215 /* N-PHY specific information */ 216 struct b43_phy_n *n; 217 /* LP-PHY specific information */ 218 struct b43_phy_lp *lp; 219 /* HT-PHY specific information */ 220 struct b43_phy_ht *ht; 221 /* LCN-PHY specific information */ 222 struct b43_phy_lcn *lcn; 223 /* AC-PHY specific information */ 224 struct b43_phy_ac *ac; 225 }; 226 227 /* Band support flags. */ 228 bool supports_2ghz; 229 bool supports_5ghz; 230 231 /* Is GMODE (2 GHz mode) bit enabled? */ 232 bool gmode; 233 234 /* After power reset full init has to be performed */ 235 bool do_full_init; 236 237 /* Analog Type */ 238 u8 analog; 239 /* B43_PHYTYPE_ */ 240 u8 type; 241 /* PHY revision number. */ 242 u8 rev; 243 244 /* Count writes since last read */ 245 u8 writes_counter; 246 247 /* Radio versioning */ 248 u16 radio_manuf; /* Radio manufacturer */ 249 u16 radio_ver; /* Radio version */ 250 u8 radio_rev; /* Radio revision */ 251 252 /* Software state of the radio */ 253 bool radio_on; 254 255 /* Desired TX power level (in dBm). 256 * This is set by the user and adjusted in b43_phy_xmitpower(). */ 257 int desired_txpower; 258 259 /* Hardware Power Control enabled? */ 260 bool hardware_power_control; 261 262 /* The time (in absolute jiffies) when the next TX power output 263 * check is needed. */ 264 unsigned long next_txpwr_check_time; 265 266 /* Current channel */ 267 struct cfg80211_chan_def *chandef; 268 unsigned int channel; 269 270 /* PHY TX errors counter. */ 271 atomic_t txerr_cnt; 272 273#ifdef CONFIG_B43_DEBUG 274 /* PHY registers locked (w.r.t. firmware) */ 275 bool phy_locked; 276 /* Radio registers locked (w.r.t. firmware) */ 277 bool radio_locked; 278#endif /* B43_DEBUG */ 279}; 280 281 282/** 283 * b43_phy_allocate - Allocate PHY structs 284 * Allocate the PHY data structures, based on the current dev->phy.type 285 */ 286int b43_phy_allocate(struct b43_wldev *dev); 287 288/** 289 * b43_phy_free - Free PHY structs 290 */ 291void b43_phy_free(struct b43_wldev *dev); 292 293/** 294 * b43_phy_init - Initialise the PHY 295 */ 296int b43_phy_init(struct b43_wldev *dev); 297 298/** 299 * b43_phy_exit - Cleanup PHY 300 */ 301void b43_phy_exit(struct b43_wldev *dev); 302 303/** 304 * b43_has_hardware_pctl - Hardware Power Control supported? 305 * Returns a boolean, whether hardware power control is supported. 306 */ 307bool b43_has_hardware_pctl(struct b43_wldev *dev); 308 309/** 310 * b43_phy_read - 16bit PHY register read access 311 */ 312u16 b43_phy_read(struct b43_wldev *dev, u16 reg); 313 314/** 315 * b43_phy_write - 16bit PHY register write access 316 */ 317void b43_phy_write(struct b43_wldev *dev, u16 reg, u16 value); 318 319/** 320 * b43_phy_copy - copy contents of 16bit PHY register to another 321 */ 322void b43_phy_copy(struct b43_wldev *dev, u16 destreg, u16 srcreg); 323 324/** 325 * b43_phy_mask - Mask a PHY register with a mask 326 */ 327void b43_phy_mask(struct b43_wldev *dev, u16 offset, u16 mask); 328 329/** 330 * b43_phy_set - OR a PHY register with a bitmap 331 */ 332void b43_phy_set(struct b43_wldev *dev, u16 offset, u16 set); 333 334/** 335 * b43_phy_maskset - Mask and OR a PHY register with a mask and bitmap 336 */ 337void b43_phy_maskset(struct b43_wldev *dev, u16 offset, u16 mask, u16 set); 338 339/** 340 * b43_radio_read - 16bit Radio register read access 341 */ 342u16 b43_radio_read(struct b43_wldev *dev, u16 reg); 343#define b43_radio_read16 b43_radio_read /* DEPRECATED */ 344 345/** 346 * b43_radio_write - 16bit Radio register write access 347 */ 348void b43_radio_write(struct b43_wldev *dev, u16 reg, u16 value); 349#define b43_radio_write16 b43_radio_write /* DEPRECATED */ 350 351/** 352 * b43_radio_mask - Mask a 16bit radio register with a mask 353 */ 354void b43_radio_mask(struct b43_wldev *dev, u16 offset, u16 mask); 355 356/** 357 * b43_radio_set - OR a 16bit radio register with a bitmap 358 */ 359void b43_radio_set(struct b43_wldev *dev, u16 offset, u16 set); 360 361/** 362 * b43_radio_maskset - Mask and OR a radio register with a mask and bitmap 363 */ 364void b43_radio_maskset(struct b43_wldev *dev, u16 offset, u16 mask, u16 set); 365 366/** 367 * b43_radio_wait_value - Waits for a given value in masked register read 368 */ 369bool b43_radio_wait_value(struct b43_wldev *dev, u16 offset, u16 mask, 370 u16 value, int delay, int timeout); 371 372/** 373 * b43_radio_lock - Lock firmware radio register access 374 */ 375void b43_radio_lock(struct b43_wldev *dev); 376 377/** 378 * b43_radio_unlock - Unlock firmware radio register access 379 */ 380void b43_radio_unlock(struct b43_wldev *dev); 381 382/** 383 * b43_phy_lock - Lock firmware PHY register access 384 */ 385void b43_phy_lock(struct b43_wldev *dev); 386 387/** 388 * b43_phy_unlock - Unlock firmware PHY register access 389 */ 390void b43_phy_unlock(struct b43_wldev *dev); 391 392void b43_phy_put_into_reset(struct b43_wldev *dev); 393void b43_phy_take_out_of_reset(struct b43_wldev *dev); 394 395/** 396 * b43_switch_channel - Switch to another channel 397 */ 398int b43_switch_channel(struct b43_wldev *dev, unsigned int new_channel); 399 400/** 401 * b43_software_rfkill - Turn the radio ON or OFF in software. 402 */ 403void b43_software_rfkill(struct b43_wldev *dev, bool blocked); 404 405/** 406 * b43_phy_txpower_check - Check TX power output. 407 * 408 * Compare the current TX power output to the desired power emission 409 * and schedule an adjustment in case it mismatches. 410 * 411 * @flags: OR'ed enum b43_phy_txpower_check_flags flags. 412 * See the docs below. 413 */ 414void b43_phy_txpower_check(struct b43_wldev *dev, unsigned int flags); 415/** 416 * enum b43_phy_txpower_check_flags - Flags for b43_phy_txpower_check() 417 * 418 * @B43_TXPWR_IGNORE_TIME: Ignore the schedule time and force-redo 419 * the check now. 420 * @B43_TXPWR_IGNORE_TSSI: Redo the recalculation, even if the average 421 * TSSI did not change. 422 */ 423enum b43_phy_txpower_check_flags { 424 B43_TXPWR_IGNORE_TIME = (1 << 0), 425 B43_TXPWR_IGNORE_TSSI = (1 << 1), 426}; 427 428struct work_struct; 429void b43_phy_txpower_adjust_work(struct work_struct *work); 430 431/** 432 * b43_phy_shm_tssi_read - Read the average of the last 4 TSSI from SHM. 433 * 434 * @shm_offset: The SHM address to read the values from. 435 * 436 * Returns the average of the 4 TSSI values, or a negative error code. 437 */ 438int b43_phy_shm_tssi_read(struct b43_wldev *dev, u16 shm_offset); 439 440/** 441 * b43_phy_switch_analog_generic - Generic PHY operation for switching the Analog. 442 * 443 * It does the switching based on the PHY0 core register. 444 * Do _not_ call this directly. Only use it as a switch_analog callback 445 * for struct b43_phy_operations. 446 */ 447void b43_phyop_switch_analog_generic(struct b43_wldev *dev, bool on); 448 449bool b43_is_40mhz(struct b43_wldev *dev); 450 451void b43_phy_force_clock(struct b43_wldev *dev, bool force); 452 453struct b43_c32 b43_cordic(int theta); 454 455#endif /* LINUX_B43_PHY_COMMON_H_ */ 456