/* SPDX-License-Identifier: GPL-2.0 */ #ifndef LINUX_B43_PHY_COMMON_H_ #define LINUX_B43_PHY_COMMON_H_ #include <linux/types.h> #include <linux/nl80211.h> struct b43_wldev; /* PHY register routing bits */ #define B43_PHYROUTE … #define B43_PHYROUTE_BASE … #define B43_PHYROUTE_OFDM_GPHY … #define B43_PHYROUTE_EXT_GPHY … #define B43_PHYROUTE_N_BMODE … /* CCK (B-PHY) registers. */ #define B43_PHY_CCK(reg) … /* N-PHY registers. */ #define B43_PHY_N(reg) … /* N-PHY BMODE registers. */ #define B43_PHY_N_BMODE(reg) … /* OFDM (A-PHY) registers. */ #define B43_PHY_OFDM(reg) … /* Extended G-PHY registers. */ #define B43_PHY_EXTG(reg) … /* Masks for the PHY versioning registers. */ #define B43_PHYVER_ANALOG … #define B43_PHYVER_ANALOG_SHIFT … #define B43_PHYVER_TYPE … #define B43_PHYVER_TYPE_SHIFT … #define B43_PHYVER_VERSION … /* PHY writes need to be flushed if we reach limit */ #define B43_MAX_WRITES_IN_ROW … /** * enum b43_interference_mitigation - Interference Mitigation mode * * @B43_INTERFMODE_NONE: Disabled * @B43_INTERFMODE_NONWLAN: Non-WLAN Interference Mitigation * @B43_INTERFMODE_MANUALWLAN: WLAN Interference Mitigation * @B43_INTERFMODE_AUTOWLAN: Automatic WLAN Interference Mitigation */ enum b43_interference_mitigation { … }; /* Antenna identifiers */ enum { … }; /** * enum b43_txpwr_result - Return value for the recalc_txpower PHY op. * * @B43_TXPWR_RES_NEED_ADJUST: Values changed. Hardware adjustment is needed. * @B43_TXPWR_RES_DONE: No more work to do. Everything is done. */ enum b43_txpwr_result { … }; /** * struct b43_phy_operations - Function pointers for PHY ops. * * @allocate: Allocate and initialise the PHY data structures. * Must not be NULL. * @free: Destroy and free the PHY data structures. * Must not be NULL. * * @prepare_structs: Prepare the PHY data structures. * The data structures allocated in @allocate are * initialized here. * Must not be NULL. * @prepare_hardware: Prepare the PHY. This is called before b43_chip_init to * do some early PHY hardware init. * Can be NULL, if not required. * @init: Initialize the PHY. * Must not be NULL. * @exit: Shutdown the PHY. * Can be NULL, if not required. * * @phy_read: Read from a PHY register. * Must not be NULL. * @phy_write: Write to a PHY register. * Must not be NULL. * @phy_maskset: Maskset a PHY register, taking shortcuts. * If it is NULL, a generic algorithm is used. * @radio_read: Read from a Radio register. * Must not be NULL. * @radio_write: Write to a Radio register. * Must not be NULL. * * @supports_hwpctl: Returns a boolean whether Hardware Power Control * is supported or not. * If NULL, hwpctl is assumed to be never supported. * @software_rfkill: Turn the radio ON or OFF. * Possible state values are * RFKILL_STATE_SOFT_BLOCKED or * RFKILL_STATE_UNBLOCKED * Must not be NULL. * @switch_analog: Turn the Analog on/off. * Must not be NULL. * @switch_channel: Switch the radio to another channel. * Must not be NULL. * @get_default_chan: Just returns the default channel number. * Must not be NULL. * @set_rx_antenna: Set the antenna used for RX. * Can be NULL, if not supported. * @interf_mitigation: Switch the Interference Mitigation mode. * Can be NULL, if not supported. * * @recalc_txpower: Recalculate the transmission power parameters. * This callback has to recalculate the TX power settings, * but does not need to write them to the hardware, yet. * Returns enum b43_txpwr_result to indicate whether the hardware * needs to be adjusted. * If B43_TXPWR_NEED_ADJUST is returned, @adjust_txpower * will be called later. * If the parameter "ignore_tssi" is true, the TSSI values should * be ignored and a recalculation of the power settings should be * done even if the TSSI values did not change. * This function may sleep, but should not. * Must not be NULL. * @adjust_txpower: Write the previously calculated TX power settings * (from @recalc_txpower) to the hardware. * This function may sleep. * Can be NULL, if (and ONLY if) @recalc_txpower _always_ * returns B43_TXPWR_RES_DONE. * * @pwork_15sec: Periodic work. Called every 15 seconds. * Can be NULL, if not required. * @pwork_60sec: Periodic work. Called every 60 seconds. * Can be NULL, if not required. */ struct b43_phy_operations { … }; struct b43_phy_g; struct b43_phy_n; struct b43_phy_lp; struct b43_phy_ht; struct b43_phy_lcn; struct b43_phy { … }; /** * b43_phy_allocate - Allocate PHY structs * Allocate the PHY data structures, based on the current dev->phy.type */ int b43_phy_allocate(struct b43_wldev *dev); /** * b43_phy_free - Free PHY structs */ void b43_phy_free(struct b43_wldev *dev); /** * b43_phy_init - Initialise the PHY */ int b43_phy_init(struct b43_wldev *dev); /** * b43_phy_exit - Cleanup PHY */ void b43_phy_exit(struct b43_wldev *dev); /** * b43_has_hardware_pctl - Hardware Power Control supported? * Returns a boolean, whether hardware power control is supported. */ bool b43_has_hardware_pctl(struct b43_wldev *dev); /** * b43_phy_read - 16bit PHY register read access */ u16 b43_phy_read(struct b43_wldev *dev, u16 reg); /** * b43_phy_write - 16bit PHY register write access */ void b43_phy_write(struct b43_wldev *dev, u16 reg, u16 value); /** * b43_phy_copy - copy contents of 16bit PHY register to another */ void b43_phy_copy(struct b43_wldev *dev, u16 destreg, u16 srcreg); /** * b43_phy_mask - Mask a PHY register with a mask */ void b43_phy_mask(struct b43_wldev *dev, u16 offset, u16 mask); /** * b43_phy_set - OR a PHY register with a bitmap */ void b43_phy_set(struct b43_wldev *dev, u16 offset, u16 set); /** * b43_phy_maskset - Mask and OR a PHY register with a mask and bitmap */ void b43_phy_maskset(struct b43_wldev *dev, u16 offset, u16 mask, u16 set); /** * b43_radio_read - 16bit Radio register read access */ u16 b43_radio_read(struct b43_wldev *dev, u16 reg); #define b43_radio_read16 … /** * b43_radio_write - 16bit Radio register write access */ void b43_radio_write(struct b43_wldev *dev, u16 reg, u16 value); #define b43_radio_write16 … /** * b43_radio_mask - Mask a 16bit radio register with a mask */ void b43_radio_mask(struct b43_wldev *dev, u16 offset, u16 mask); /** * b43_radio_set - OR a 16bit radio register with a bitmap */ void b43_radio_set(struct b43_wldev *dev, u16 offset, u16 set); /** * b43_radio_maskset - Mask and OR a radio register with a mask and bitmap */ void b43_radio_maskset(struct b43_wldev *dev, u16 offset, u16 mask, u16 set); /** * b43_radio_wait_value - Waits for a given value in masked register read */ bool b43_radio_wait_value(struct b43_wldev *dev, u16 offset, u16 mask, u16 value, int delay, int timeout); /** * b43_radio_lock - Lock firmware radio register access */ void b43_radio_lock(struct b43_wldev *dev); /** * b43_radio_unlock - Unlock firmware radio register access */ void b43_radio_unlock(struct b43_wldev *dev); /** * b43_phy_lock - Lock firmware PHY register access */ void b43_phy_lock(struct b43_wldev *dev); /** * b43_phy_unlock - Unlock firmware PHY register access */ void b43_phy_unlock(struct b43_wldev *dev); void b43_phy_put_into_reset(struct b43_wldev *dev); void b43_phy_take_out_of_reset(struct b43_wldev *dev); /** * b43_switch_channel - Switch to another channel */ int b43_switch_channel(struct b43_wldev *dev, unsigned int new_channel); /** * b43_software_rfkill - Turn the radio ON or OFF in software. */ void b43_software_rfkill(struct b43_wldev *dev, bool blocked); /** * b43_phy_txpower_check - Check TX power output. * * Compare the current TX power output to the desired power emission * and schedule an adjustment in case it mismatches. * * @flags: OR'ed enum b43_phy_txpower_check_flags flags. * See the docs below. */ void b43_phy_txpower_check(struct b43_wldev *dev, unsigned int flags); /** * enum b43_phy_txpower_check_flags - Flags for b43_phy_txpower_check() * * @B43_TXPWR_IGNORE_TIME: Ignore the schedule time and force-redo * the check now. * @B43_TXPWR_IGNORE_TSSI: Redo the recalculation, even if the average * TSSI did not change. */ enum b43_phy_txpower_check_flags { … }; struct work_struct; void b43_phy_txpower_adjust_work(struct work_struct *work); /** * b43_phy_shm_tssi_read - Read the average of the last 4 TSSI from SHM. * * @shm_offset: The SHM address to read the values from. * * Returns the average of the 4 TSSI values, or a negative error code. */ int b43_phy_shm_tssi_read(struct b43_wldev *dev, u16 shm_offset); /** * b43_phy_switch_analog_generic - Generic PHY operation for switching the Analog. * * It does the switching based on the PHY0 core register. * Do _not_ call this directly. Only use it as a switch_analog callback * for struct b43_phy_operations. */ void b43_phyop_switch_analog_generic(struct b43_wldev *dev, bool on); bool b43_is_40mhz(struct b43_wldev *dev); void b43_phy_force_clock(struct b43_wldev *dev, bool force); #endif /* LINUX_B43_PHY_COMMON_H_ */