#include <unistd.h>
#include <string.h>
#include <ipxe/net80211.h>

Data Structures
struct	ath_ani
struct	ath_cycle_counters
struct	reg_dmn_pair_mapping
struct	ath_regulatory
struct	ath_keyval
struct	ath_ops
	struct ath_ops - Register read/write operations More...
struct	ath_common

Macros
#define	DIV_ROUND_UP(n, d)
#define	BITS_PER_BYTE 8
#define	BITS_TO_LONGS(nr)
#define	BIT(nr)
#define	min(x, y)
#define	max(x, y)
#define	abs(x)
#define	___constant_swab16(x)
#define	___constant_swab32(x)
#define	__swab16(x)
#define	__swab32(x)
#define	swab16 __swab16
#define	swab32 __swab32
#define	ATH_KEYMAX 128 /* max key cache size we handle */

Enumerations
enum	ath_device_state { ATH_HW_UNAVAILABLE , ATH_HW_INITIALIZED }
enum	ath_bus_type { ATH_PCI , ATH_AHB , ATH_USB }
enum	ath_crypt_caps { ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0) , ATH_CRYPT_CAP_MIC_COMBINED = BIT(1) }
enum	ath_cipher { ATH_CIPHER_WEP = 0 , ATH_CIPHER_AES_OCB = 1 , ATH_CIPHER_AES_CCM = 2 , ATH_CIPHER_CKIP = 3 , ATH_CIPHER_TKIP = 4 , ATH_CIPHER_CLR = 5 , ATH_CIPHER_MIC = 127 }

Functions
	FILE_LICENCE (BSD2)
	FILE_SECBOOT (FORBIDDEN)
static int32_t	sign_extend32 (uint32_t value, int index)
static u16	__get_unaligned_le16 (const u8 *p)
static u32	__get_unaligned_le32 (const u8 *p)
static u16	get_unaligned_le16 (const void *p)
static u32	get_unaligned_le32 (const void *p)
void	ath_hw_setbssidmask (struct ath_common *common)
	ath_hw_set_bssid_mask - filter out bssids we listen
int	ath_hw_keyreset (struct ath_common *common, u16 entry)
void	ath_hw_cycle_counters_update (struct ath_common *common)
	ath_hw_cycle_counters_update - common function to update cycle counters
int32_t	ath_hw_get_listen_time (struct ath_common *common)

Macro Definition Documentation

◆ DIV_ROUND_UP

#define DIV_ROUND_UP	(		n,
			d )

Value:

(((n) + (d) - 1) / (d))

Definition at line 31 of file ath.h.

Referenced by ath9k_hw_computetxtime().

◆ BITS_PER_BYTE

#define BITS_PER_BYTE 8

Definition at line 32 of file ath.h.

◆ BITS_TO_LONGS

#define BITS_TO_LONGS ( nr )

Value:

DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long))

BITS_PER_BYTE

#define BITS_PER_BYTE

Definition ath.h:32

DIV_ROUND_UP

#define DIV_ROUND_UP(n, d)

Definition ath.h:31

Definition at line 33 of file ath.h.

◆ BIT

#define BIT ( nr )

Value:

(1UL << (nr))

Definition at line 34 of file ath.h.

Referenced by ar9003_hw_ant_ctrl_apply(), ar9003_hw_atten_apply(), ar9003_hw_do_getnf(), ar9003_hw_iqcal_collect(), ar9003_hw_power_control_override(), ath9k_hw_4k_set_board_values(), ath9k_hw_apply_gpio_override(), ath9k_hw_ar9300_get_eeprom(), ath9k_hw_fill_cap_info(), and get_streams().

◆ min

#define min	(		x,
			y )

Value:

        ({                                      \
        typeof(x) _min1 = (x);                                \
        typeof(y) _min2 = (y);                                \
        (void) (&_min1 == &_min2);                      \
        _min1 < _min2 ? _min1 : _min2; })

Definition at line 36 of file ath.h.

#define min(x, y) ({                                    \
        typeof(x) _min1 = (x);                          \
        typeof(y) _min2 = (y);                          \
        (void) (&_min1 == &_min2);                      \
        _min1 < _min2 ? _min1 : _min2; })

Referenced by ar5008_hw_process_ini(), ar9003_hw_process_ini(), ar9003_hw_set_power_per_rate_table(), ath5k_get_max_ctl_power(), ath5k_get_pcdac_intercepts(), ath5k_setup_channel_powertable(), ath5k_setup_rate_powertable(), ath9k_change_gain_boundary_setting(), ath9k_hw_channel_change(), ath9k_hw_get_gain_boundaries_pdadcs(), ath9k_hw_set_4k_power_per_rate_table(), ath9k_hw_set_ack_timeout(), ath9k_hw_set_ar9287_power_per_rate_table(), ath9k_hw_set_cts_timeout(), ath9k_hw_set_def_power_per_rate_table(), ath9k_hw_set_txpowerlimit(), ath9k_hw_set_txq_props(), ath9k_hw_setslottime(), ath_ani_calibrate(), bzimage_check_initrds(), fdtmem_describe(), fdtmem_describe_region(), golan_provide_pages(), golan_take_pages(), initrd_region(), int15_describe(), memmap_describe(), memmap_init(), memmap_update(), start_timer(), tcp_rx_opts(), and utf8_accumulate().

◆ max

#define max	(		x,
			y )

Value:

        ({                                      \
        typeof(x) _max1 = (x);                                \
        typeof(y) _max2 = (y);                                \
        (void) (&_max1 == &_max2);                      \
        _max1 > _max2 ? _max1 : _max2; })

Definition at line 41 of file ath.h.

#define max(x, y) ({                                    \
        typeof(x) _max1 = (x);                          \
        typeof(y) _max2 = (y);                          \
        (void) (&_max1 == &_max2);                      \
        _max1 > _max2 ? _max1 : _max2; })

Referenced by ar9003_hw_set_power_per_rate_table(), ath5k_copy_channels(), ath5k_eeprom_read_freq_list(), ath5k_get_chan_pcal_surrounding_piers(), ath5k_get_linear_pcdac_min(), ath5k_get_pcdac_intercepts(), ath5k_get_rate_pcal_data(), ath5k_setup_channel_powertable(), ath9k_hw_get_gain_boundaries_pdadcs(), ath9k_hw_set_4k_power_per_rate_table(), ath9k_hw_set_ar9287_power_per_rate_table(), ath9k_hw_set_def_power_per_rate_table(), bigint_reduce_raw(), bzimage_check_initrds(), cpio_header(), cpio_max(), eap_tx_nak(), efi_path_check(), efifb_glyphs(), elf_load(), elf_segment(), elf_segments(), elfboot_exec(), elfboot_probe(), fdtmem_describe(), fdtmem_register(), fdtmem_relocate(), gve_describe(), jme_tx_clean(), memmap_update(), memmove(), mp_boot_cpuid(), mp_max_cpuid(), multiboot_exec(), multiboot_load_elf(), multiboot_load_raw(), peerdist_discovery_reply(), png_pixel(), png_pixels_pass(), pnm_pixbuf(), prep_segment(), relocate(), strncasecmp(), strncmp(), strncpy(), strndup(), strnlen(), timer_expired(), tls_client_hello(), ucode_update_all(), usb_refill_init(), usb_refill_limit(), usbblk_in_refill(), wcsnlen(), and xve_update_mtu().

◆ abs

#define abs ( x )

Value:

                ({                                      \
                long ret;                               \
                if (sizeof(x) == sizeof(long)) {       \
                        long __x = (x);                        \
                        ret = (__x < 0) ? -__x : __x;   \
                } else {                                \
                        int __x = (x);                 \
                        ret = (__x < 0) ? -__x : __x;   \
                }                                       \
                ret;                                    \
        })

Definition at line 46 of file ath.h.

#define abs(x) ({                                       \
                long ret;                               \
                if (sizeof(x) == sizeof(long)) {        \
                        long __x = (x);                 \
                        ret = (__x < 0) ? -__x : __x;   \
                } else {                                \
                        int __x = (x);                  \
                        ret = (__x < 0) ? -__x : __x;   \
                }                                       \
                ret;                                    \
        })

Referenced by ar5008_hw_spur_mitigate(), ar9002_hw_spur_mitigate(), ar9003_hw_detect_outlier(), ar9003_hw_find_mag_approx(), ar9003_hw_spur_mitigate_ofdm(), ath9k_hw_ar9300_set_txpower(), and png_paeth_predictor().

◆ ___constant_swab16

#define ___constant_swab16 ( x )

Value:

        ((uint16_t)(                    \
        (((uint16_t)(x) & (uint16_t)0x00ffU) << 8) |           \
        (((uint16_t)(x) & (uint16_t)0xff00U) >> 8)))

Definition at line 58 of file ath.h.

#define ___constant_swab16(x) ((uint16_t)(                      \
        (((uint16_t)(x) & (uint16_t)0x00ffU) << 8) |            \
        (((uint16_t)(x) & (uint16_t)0xff00U) >> 8)))

◆ ___constant_swab32

#define ___constant_swab32 ( x )

Value:

        ((uint32_t)(                    \
        (((uint32_t)(x) & (uint32_t)0x000000ffUL) << 24) |     \
        (((uint32_t)(x) & (uint32_t)0x0000ff00UL) <<  8) |     \
        (((uint32_t)(x) & (uint32_t)0x00ff0000UL) >>  8) |     \
        (((uint32_t)(x) & (uint32_t)0xff000000UL) >> 24)))

Definition at line 61 of file ath.h.

#define ___constant_swab32(x) ((uint32_t)(                      \
        (((uint32_t)(x) & (uint32_t)0x000000ffUL) << 24) |      \
        (((uint32_t)(x) & (uint32_t)0x0000ff00UL) <<  8) |      \
        (((uint32_t)(x) & (uint32_t)0x00ff0000UL) >>  8) |      \
        (((uint32_t)(x) & (uint32_t)0xff000000UL) >> 24)))

◆ __swab16

#define __swab16 ( x )

Value:

___constant_swab16(x)

___constant_swab16

#define ___constant_swab16(x)

Definition ath.h:58

Definition at line 66 of file ath.h.

◆ __swab32

#define __swab32 ( x )

Value:

___constant_swab32(x)

___constant_swab32

#define ___constant_swab32(x)

Definition ath.h:61

Definition at line 67 of file ath.h.

◆ swab16

#define swab16 __swab16

Definition at line 68 of file ath.h.

Referenced by ath9k_hw_4k_check_eeprom(), ath9k_hw_ar9287_check_eeprom(), and ath9k_hw_def_check_eeprom().

◆ swab32

#define swab32 __swab32

Definition at line 69 of file ath.h.

Referenced by ath9k_hw_4k_check_eeprom(), ath9k_hw_ar9287_check_eeprom(), and ath9k_hw_def_check_eeprom().

◆ ATH_KEYMAX

#define ATH_KEYMAX 128 /* max key cache size we handle */

Definition at line 103 of file ath.h.

Enumeration Type Documentation

◆ ath_device_state

enum ath_device_state

Enumerator
ATH_HW_UNAVAILABLE
ATH_HW_INITIALIZED

Definition at line 121 of file ath.h.

                      {
        ATH_HW_UNAVAILABLE,
        ATH_HW_INITIALIZED,
};

◆ ath_bus_type

enum ath_bus_type

Enumerator
ATH_PCI
ATH_AHB
ATH_USB

Definition at line 126 of file ath.h.

                  {
        ATH_PCI,
        ATH_AHB,
        ATH_USB,
};

◆ ath_crypt_caps

enum ath_crypt_caps

Enumerator
ATH_CRYPT_CAP_CIPHER_AESCCM
ATH_CRYPT_CAP_MIC_COMBINED

Definition at line 149 of file ath.h.

                    {
        ATH_CRYPT_CAP_CIPHER_AESCCM          = BIT(0),
        ATH_CRYPT_CAP_MIC_COMBINED            = BIT(1),
};

◆ ath_cipher

enum ath_cipher

Enumerator
ATH_CIPHER_WEP
ATH_CIPHER_AES_OCB
ATH_CIPHER_AES_CCM
ATH_CIPHER_CKIP
ATH_CIPHER_TKIP
ATH_CIPHER_CLR
ATH_CIPHER_MIC

Definition at line 165 of file ath.h.

                {
        ATH_CIPHER_WEP = 0,
        ATH_CIPHER_AES_OCB = 1,
        ATH_CIPHER_AES_CCM = 2,
        ATH_CIPHER_CKIP = 3,
        ATH_CIPHER_TKIP = 4,
        ATH_CIPHER_CLR = 5,
        ATH_CIPHER_MIC = 127
};

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2 )

◆ FILE_SECBOOT()

FILE_SECBOOT ( FORBIDDEN )

◆ sign_extend32()

int32_t sign_extend32	(	uint32_t	value,
		int	index )

inlinestatic

Definition at line 71 of file ath.h.

{
        uint8_t shift = 31 - index;
        return (int32_t)(value << shift) >> shift;
}

References index, and value.

Referenced by ar5008_hw_do_getnf(), ar9002_hw_do_getnf(), and ar9003_hw_do_getnf().

◆ __get_unaligned_le16()

u16 __get_unaligned_le16 ( const u8 * p )

inlinestatic

Definition at line 77 of file ath.h.

{
        return p[0] | p[1] << 8;
}

References u16, and u8.

Referenced by get_unaligned_le16().

◆ __get_unaligned_le32()

u32 __get_unaligned_le32 ( const u8 * p )

inlinestatic

Definition at line 81 of file ath.h.

{
        return p[0] | p[1] << 8 | p[2] << 16 | p[3] << 24;
}

References u32, and u8.

Referenced by get_unaligned_le32().

◆ get_unaligned_le16()

u16 get_unaligned_le16 ( const void * p )

inlinestatic

Definition at line 85 of file ath.h.

{
        return __get_unaligned_le16((const u8 *)p);
}

References __get_unaligned_le16(), u16, and u8.

Referenced by ath9k_hw_reset(), ath9k_hw_write_associd(), and ath_hw_setbssidmask().

◆ get_unaligned_le32()

u32 get_unaligned_le32 ( const void * p )

inlinestatic

Definition at line 89 of file ath.h.

{
        return __get_unaligned_le32((const u8 *)p);
}

References __get_unaligned_le32(), u32, and u8.

Referenced by ath9k_hw_reset(), ath9k_hw_write_associd(), and ath_hw_setbssidmask().

◆ ath_hw_setbssidmask()

void ath_hw_setbssidmask ( struct ath_common * common )

ath_hw_set_bssid_mask - filter out bssids we listen

@common: the ath_common struct for the device.

BSSID masking is a method used by AR5212 and newer hardware to inform PCU which bits of the interface's MAC address should be looked at when trying to decide which packets to ACK. In station mode and AP mode with a single BSS every bit matters since we lock to only one BSS. In AP mode with multiple BSSes (virtual interfaces) not every bit matters because hw must accept frames for all BSSes and so we tweak some bits of our mac address in order to have multiple BSSes.

NOTE: This is a simple filter and does not filter out all relevant frames. Some frames that are not for us might get ACKed from us by PCU because they just match the mask.

When handling multiple BSSes you can get the BSSID mask by computing the set of ~ ( MAC XOR BSSID ) for all bssids we handle.

When you do this you are essentially computing the common bits of all your BSSes. Later it is assumed the hardware will "and" (&) the BSSID mask with the MAC address to obtain the relevant bits and compare the result with (frame's BSSID & mask) to see if they match.

Simple example: on your card you have have two BSSes you have created with BSSID-01 and BSSID-02. Lets assume BSSID-01 will not use the MAC address. There is another BSSID-03 but you are not part of it. For simplicity's sake, assuming only 4 bits for a mac address and for BSSIDs you can then have:

MAC: 0001 | BSSID-01: 0100 | --> Belongs to us BSSID-02: 1001 |

/

BSSID-03: 0110 | --> External

Our bssid_mask would then be:

        On loop iteration for BSSID-01:
        ~(0001 ^ 0100)  -> ~(0101)
                        ->   1010
        bssid_mask      =    1010

        On loop iteration for BSSID-02:
        bssid_mask &= ~(0001   ^   1001)
        bssid_mask =   (1010)  & ~(0001 ^ 1001)
        bssid_mask =   (1010)  & ~(1000)
        bssid_mask =   (1010)  &  (0111)
        bssid_mask =   0010

A bssid_mask of 0010 means "only pay attention to the second least significant bit". This is because its the only bit common amongst the MAC and all BSSIDs we support. To findout what the real common bit is we can simply "&" the bssid_mask now with any BSSID we have or our MAC address (we assume the hardware uses the MAC address).

Now, suppose there's an incoming frame for BSSID-03:

IFRAME-01: 0110

An easy eye-inspeciton of this already should tell you that this frame will not pass our check. This is because the bssid_mask tells the hardware to only look at the second least significant bit and the common bit amongst the MAC and BSSIDs is 0, this frame has the 2nd LSB as 1, which does not match 0.

So with IFRAME-01 we assume the hardware will do:

allow = (IFRAME-01 & bssid_mask) == (bssid_mask & MAC) ? 1 : 0;

--> allow = (0110 & 0010) == (0010 & 0001) ? 1 : 0; --> allow = (0010) == 0000 ? 1 : 0; --> allow = 0

Lets now test a frame that should work:

IFRAME-02: 0001 (we should allow)

allow = (IFRAME-02 & bssid_mask) == (bssid_mask & MAC) ? 1 : 0;

--> allow = (0001 & 0010) == (0010 & 0001) ? 1 :0; --> allow = (0000) == (0000) --> allow = 1

Other examples:

IFRAME-03: 0100 --> allowed IFRAME-04: 1001 --> allowed IFRAME-05: 1101 --> allowed but its not for us!!!

Definition at line 122 of file ath_hw.c.

{
        void *ah = common->ah;
 
        REG_WRITE(ah, get_unaligned_le32(common->bssidmask), AR_BSSMSKL);
        REG_WRITE(ah, get_unaligned_le16(common->bssidmask + 4), AR_BSSMSKU);
}

References ah, AR_BSSMSKL, AR_BSSMSKU, common, get_unaligned_le16(), get_unaligned_le32(), and REG_WRITE.

Referenced by ath9k_hw_reset(), and ath_opmode_init().

◆ ath_hw_keyreset()

int ath_hw_keyreset	(	struct ath_common *	common,
		u16	entry )

Definition at line 43 of file ath_key.c.

{
        u32 keyType;
        void *ah = common->ah;
 
        if (entry >= common->keymax) {
                DBG("ath: keycache entry %d out of range\n", entry);
                return 0;
        }
 
        keyType = REG_READ(ah, AR_KEYTABLE_TYPE(entry));
 
        ENABLE_REGWRITE_BUFFER(ah);
 
        REG_WRITE(ah, AR_KEYTABLE_KEY0(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_KEY1(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_KEY2(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_KEY3(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_KEY4(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_TYPE(entry), AR_KEYTABLE_TYPE_CLR);
        REG_WRITE(ah, AR_KEYTABLE_MAC0(entry), 0);
        REG_WRITE(ah, AR_KEYTABLE_MAC1(entry), 0);
 
        if (keyType == AR_KEYTABLE_TYPE_TKIP) {
                u16 micentry = entry + 64;
 
                REG_WRITE(ah, AR_KEYTABLE_KEY0(micentry), 0);
                REG_WRITE(ah, AR_KEYTABLE_KEY1(micentry), 0);
                REG_WRITE(ah, AR_KEYTABLE_KEY2(micentry), 0);
                REG_WRITE(ah, AR_KEYTABLE_KEY3(micentry), 0);
                if (common->crypt_caps & ATH_CRYPT_CAP_MIC_COMBINED) {
                        REG_WRITE(ah, AR_KEYTABLE_KEY4(micentry), 0);
                        REG_WRITE(ah, AR_KEYTABLE_TYPE(micentry),
                                  AR_KEYTABLE_TYPE_CLR);
                }
 
        }
 
        REGWRITE_BUFFER_FLUSH(ah);
 
        return 1;
}

References ah, AR_KEYTABLE_KEY0, AR_KEYTABLE_KEY1, AR_KEYTABLE_KEY2, AR_KEYTABLE_KEY3, AR_KEYTABLE_KEY4, AR_KEYTABLE_MAC0, AR_KEYTABLE_MAC1, AR_KEYTABLE_TYPE, AR_KEYTABLE_TYPE_CLR, AR_KEYTABLE_TYPE_TKIP, ATH_CRYPT_CAP_MIC_COMBINED, common, DBG, ENABLE_REGWRITE_BUFFER, REG_READ, REG_WRITE, REGWRITE_BUFFER_FLUSH, u16, and u32.

Referenced by ath9k_init_crypto().

◆ ath_hw_cycle_counters_update()

void ath_hw_cycle_counters_update ( struct ath_common * common )

ath_hw_cycle_counters_update - common function to update cycle counters

@common: the ath_common struct for the device.

This function is used to update all cycle counters in one place. It has to be called while holding common->cc_lock!

Definition at line 139 of file ath_hw.c.

{
        u32 cycles, busy, rx, tx;
        void *ah = common->ah;
 
        /* freeze */
        REG_WRITE(ah, AR_MIBC_FMC, AR_MIBC);
 
        /* read */
        cycles = REG_READ(ah, AR_CCCNT);
        busy = REG_READ(ah, AR_RCCNT);
        rx = REG_READ(ah, AR_RFCNT);
        tx = REG_READ(ah, AR_TFCNT);
 
        /* clear */
        REG_WRITE(ah, 0, AR_CCCNT);
        REG_WRITE(ah, 0, AR_RFCNT);
        REG_WRITE(ah, 0, AR_RCCNT);
        REG_WRITE(ah, 0, AR_TFCNT);
 
        /* unfreeze */
        REG_WRITE(ah, 0, AR_MIBC);
 
        /* update all cycle counters here */
        common->cc_ani.cycles += cycles;
        common->cc_ani.rx_busy += busy;
        common->cc_ani.rx_frame += rx;
        common->cc_ani.tx_frame += tx;
 
        common->cc_survey.cycles += cycles;
        common->cc_survey.rx_busy += busy;
        common->cc_survey.rx_frame += rx;
        common->cc_survey.tx_frame += tx;
}

References ah, AR_CCCNT, AR_MIBC, AR_MIBC_FMC, AR_RCCNT, AR_RFCNT, AR_TFCNT, common, REG_READ, REG_WRITE, rx, tx, and u32.

Referenced by ath9k_hw_ani_read_counters(), and ath_update_survey_stats().

◆ ath_hw_get_listen_time()

int32_t ath_hw_get_listen_time ( struct ath_common * common )

Definition at line 174 of file ath_hw.c.

{
        struct ath_cycle_counters *cc = &common->cc_ani;
        int32_t listen_time;
 
        listen_time = (cc->cycles - cc->rx_frame - cc->tx_frame) /
                      (common->clockrate * 1000);
 
        memset(cc, 0, sizeof(*cc));
 
        return listen_time;
}

References common, ath_cycle_counters::cycles, memset(), ath_cycle_counters::rx_frame, and ath_cycle_counters::tx_frame.

Referenced by ath9k_hw_ani_read_counters().

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

◆ DIV_ROUND_UP

◆ BITS_PER_BYTE

◆ BITS_TO_LONGS

◆ BIT

◆ min

◆ max

◆ abs

◆ ___constant_swab16

◆ ___constant_swab32

◆ __swab16

◆ __swab32

◆ swab16

◆ swab32

◆ ATH_KEYMAX

Enumeration Type Documentation

◆ ath_device_state

◆ ath_bus_type

◆ ath_crypt_caps

◆ ath_cipher

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

◆ sign_extend32()

◆ __get_unaligned_le16()

◆ __get_unaligned_le32()

◆ get_unaligned_le16()

◆ get_unaligned_le32()

◆ ath_hw_setbssidmask()

/

BSSID-03: 0110 | --> External

◆ ath_hw_keyreset()

◆ ath_hw_cycle_counters_update()

◆ ath_hw_get_listen_time()