Skip to content

Commit

Permalink
ath9k: define all EEPROM fields in Little Endian format
Browse files Browse the repository at this point in the history 
The ar9300_eeprom logic is already using only 8-bit (endian neutral),
__le16 and __le32 fields to state explicitly how the values should be
interpreted.
All other EEPROM implementations (4k, 9287 and def) were using u16 and
u32 fields with additional logic to swap the values (read from the
original EEPROM) so they match the current CPUs endianness.

The EEPROM format defaults to "all values are Little Endian", indicated
by the absence of the AR5416_EEPMISC_BIG_ENDIAN in the u8 EEPMISC
register. If we detect that the EEPROM indicates Big Endian mode
(AR5416_EEPMISC_BIG_ENDIAN is set in the EEPMISC register) then we'll
swap the values to convert them into Little Endian. This is done by
activating the EEPMISC based logic in ath9k_hw_nvram_swap_data even if
AH_NO_EEP_SWAP is set (this makes ath9k behave like the FreeBSD driver,
which also does not have a flag to enable swapping based on the
AR5416_EEPMISC_BIG_ENDIAN bit). Before this logic was only used to
enable swapping when "current CPU endianness != EEPROM endianness".

After changing all relevant fields to __le16 and __le32 sparse was used
to check that all code which reads any of these fields uses
le{16,32}_to_cpu.

Signed-off-by: Martin Blumenstingl <martin.blumenstingl@googlemail.com>
Signed-off-by: Kalle Valo <kvalo@qca.qualcomm.com>
  • Loading branch information
Martin Blumenstingl authored and Kalle Valo committed Dec 15, 2016
1 parent 68fbe79 commit 4bca530
Show file tree
Hide file tree
Showing 5 changed files with 174 additions and 234 deletions.
27 changes: 6 additions & 21 deletions drivers/net/wireless/ath/ath9k/eeprom.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,17 +155,10 @@ bool ath9k_hw_nvram_read(struct ath_hw *ah, u32 off, u16 *data)
return ret;
}

#ifdef __BIG_ENDIAN
#define EXPECTED_EEPMISC_ENDIAN AR5416_EEPMISC_BIG_ENDIAN
#else
#define EXPECTED_EEPMISC_ENDIAN 0
#endif

int ath9k_hw_nvram_swap_data(struct ath_hw *ah, bool *swap_needed, int size)
{
u16 magic;
u16 *eepdata;
u8 eepmisc;
int i;
bool needs_byteswap = false;
struct ath_common *common = ath9k_hw_common(ah);
Expand Down Expand Up @@ -203,25 +196,17 @@ int ath9k_hw_nvram_swap_data(struct ath_hw *ah, bool *swap_needed, int size)
}
}

*swap_needed = false;

eepmisc = ah->eep_ops->get_eepmisc(ah);
if ((eepmisc & AR5416_EEPMISC_BIG_ENDIAN) != EXPECTED_EEPMISC_ENDIAN) {
if (ah->ah_flags & AH_NO_EEP_SWAP) {
ath_info(common,
"Ignoring endianness difference in eepmisc register.\n");
} else {
*swap_needed = true;
ath_dbg(common, EEPROM,
"EEPROM needs swapping according to the eepmisc register.\n");
}
if (ah->eep_ops->get_eepmisc(ah) & AR5416_EEPMISC_BIG_ENDIAN) {
*swap_needed = true;
ath_dbg(common, EEPROM,
"Big Endian EEPROM detected according to EEPMISC register.\n");
} else {
*swap_needed = false;
}

return 0;
}

#undef EXPECTED_EEPMISC_VAL

bool ath9k_hw_nvram_validate_checksum(struct ath_hw *ah, int size)
{
u32 i, sum = 0;
Expand Down
75 changes: 43 additions & 32 deletions drivers/net/wireless/ath/ath9k/eeprom.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@
#include <net/cfg80211.h>
#include "ar9003_eeprom.h"

/* helpers to swap EEPROM fields, which are stored as __le16 or __le32. Since
* we are 100% sure about it we __force these to u16/u32 for the swab calls to
* silence the sparse checks. These macros are used when we have a Big Endian
* EEPROM (according to AR5416_EEPMISC_BIG_ENDIAN) and need to convert the
* fields to __le16/__le32.
*/
#define EEPROM_FIELD_SWAB16(field) \
(field = (__force __le16)swab16((__force u16)field))
#define EEPROM_FIELD_SWAB32(field) \
(field = (__force __le32)swab32((__force u32)field))

#ifdef __BIG_ENDIAN
#define AR5416_EEPROM_MAGIC 0x5aa5
#else
Expand Down Expand Up @@ -270,19 +281,19 @@ enum ath9k_hal_freq_band {
};

struct base_eep_header {
u16 length;
u16 checksum;
u16 version;
__le16 length;
__le16 checksum;
__le16 version;
u8 opCapFlags;
u8 eepMisc;
u16 regDmn[2];
__le16 regDmn[2];
u8 macAddr[6];
u8 rxMask;
u8 txMask;
u16 rfSilent;
u16 blueToothOptions;
u16 deviceCap;
u32 binBuildNumber;
__le16 rfSilent;
__le16 blueToothOptions;
__le16 deviceCap;
__le32 binBuildNumber;
u8 deviceType;
u8 pwdclkind;
u8 fastClk5g;
Expand All @@ -300,33 +311,33 @@ struct base_eep_header {
} __packed;

struct base_eep_header_4k {
u16 length;
u16 checksum;
u16 version;
__le16 length;
__le16 checksum;
__le16 version;
u8 opCapFlags;
u8 eepMisc;
u16 regDmn[2];
__le16 regDmn[2];
u8 macAddr[6];
u8 rxMask;
u8 txMask;
u16 rfSilent;
u16 blueToothOptions;
u16 deviceCap;
u32 binBuildNumber;
__le16 rfSilent;
__le16 blueToothOptions;
__le16 deviceCap;
__le32 binBuildNumber;
u8 deviceType;
u8 txGainType;
} __packed;


struct spur_chan {
u16 spurChan;
__le16 spurChan;
u8 spurRangeLow;
u8 spurRangeHigh;
} __packed;

struct modal_eep_header {
u32 antCtrlChain[AR5416_MAX_CHAINS];
u32 antCtrlCommon;
__le32 antCtrlChain[AR5416_MAX_CHAINS];
__le32 antCtrlCommon;
u8 antennaGainCh[AR5416_MAX_CHAINS];
u8 switchSettling;
u8 txRxAttenCh[AR5416_MAX_CHAINS];
Expand Down Expand Up @@ -361,7 +372,7 @@ struct modal_eep_header {
u8 db_ch1;
u8 lna_ctl;
u8 miscBits;
u16 xpaBiasLvlFreq[3];
__le16 xpaBiasLvlFreq[3];
u8 futureModal[6];

struct spur_chan spurChans[AR_EEPROM_MODAL_SPURS];
Expand All @@ -375,8 +386,8 @@ struct calDataPerFreqOpLoop {
} __packed;

struct modal_eep_4k_header {
u32 antCtrlChain[AR5416_EEP4K_MAX_CHAINS];
u32 antCtrlCommon;
__le32 antCtrlChain[AR5416_EEP4K_MAX_CHAINS];
__le32 antCtrlCommon;
u8 antennaGainCh[AR5416_EEP4K_MAX_CHAINS];
u8 switchSettling;
u8 txRxAttenCh[AR5416_EEP4K_MAX_CHAINS];
Expand Down Expand Up @@ -440,19 +451,19 @@ struct modal_eep_4k_header {
} __packed;

struct base_eep_ar9287_header {
u16 length;
u16 checksum;
u16 version;
__le16 length;
__le16 checksum;
__le16 version;
u8 opCapFlags;
u8 eepMisc;
u16 regDmn[2];
__le16 regDmn[2];
u8 macAddr[6];
u8 rxMask;
u8 txMask;
u16 rfSilent;
u16 blueToothOptions;
u16 deviceCap;
u32 binBuildNumber;
__le16 rfSilent;
__le16 blueToothOptions;
__le16 deviceCap;
__le32 binBuildNumber;
u8 deviceType;
u8 openLoopPwrCntl;
int8_t pwrTableOffset;
Expand All @@ -462,8 +473,8 @@ struct base_eep_ar9287_header {
} __packed;

struct modal_eep_ar9287_header {
u32 antCtrlChain[AR9287_MAX_CHAINS];
u32 antCtrlCommon;
__le32 antCtrlChain[AR9287_MAX_CHAINS];
__le32 antCtrlCommon;
int8_t antennaGainCh[AR9287_MAX_CHAINS];
u8 switchSettling;
u8 txRxAttenCh[AR9287_MAX_CHAINS];
Expand Down
94 changes: 36 additions & 58 deletions drivers/net/wireless/ath/ath9k/eeprom_4k.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@

static int ath9k_hw_4k_get_eeprom_ver(struct ath_hw *ah)
{
u16 version = ah->eeprom.map4k.baseEepHeader.version;
u16 version = le16_to_cpu(ah->eeprom.map4k.baseEepHeader.version);

return (version & AR5416_EEP_VER_MAJOR_MASK) >>
AR5416_EEP_VER_MAJOR_SHIFT;
}

static int ath9k_hw_4k_get_eeprom_rev(struct ath_hw *ah)
{
u16 version = ah->eeprom.map4k.baseEepHeader.version;
u16 version = le16_to_cpu(ah->eeprom.map4k.baseEepHeader.version);

return version & AR5416_EEP_VER_MINOR_MASK;
}
Expand Down Expand Up @@ -76,8 +76,8 @@ static bool ath9k_hw_4k_fill_eeprom(struct ath_hw *ah)
static u32 ath9k_dump_4k_modal_eeprom(char *buf, u32 len, u32 size,
struct modal_eep_4k_header *modal_hdr)
{
PR_EEP("Chain0 Ant. Control", modal_hdr->antCtrlChain[0]);
PR_EEP("Ant. Common Control", modal_hdr->antCtrlCommon);
PR_EEP("Chain0 Ant. Control", le16_to_cpu(modal_hdr->antCtrlChain[0]));
PR_EEP("Ant. Common Control", le32_to_cpu(modal_hdr->antCtrlCommon));
PR_EEP("Chain0 Ant. Gain", modal_hdr->antennaGainCh[0]);
PR_EEP("Switch Settle", modal_hdr->switchSettling);
PR_EEP("Chain0 TxRxAtten", modal_hdr->txRxAttenCh[0]);
Expand Down Expand Up @@ -132,6 +132,7 @@ static u32 ath9k_hw_4k_dump_eeprom(struct ath_hw *ah, bool dump_base_hdr,
{
struct ar5416_eeprom_4k *eep = &ah->eeprom.map4k;
struct base_eep_header_4k *pBase = &eep->baseEepHeader;
u32 binBuildNumber = le32_to_cpu(pBase->binBuildNumber);

if (!dump_base_hdr) {
len += scnprintf(buf + len, size - len,
Expand All @@ -143,10 +144,10 @@ static u32 ath9k_hw_4k_dump_eeprom(struct ath_hw *ah, bool dump_base_hdr,

PR_EEP("Major Version", ath9k_hw_4k_get_eeprom_ver(ah));
PR_EEP("Minor Version", ath9k_hw_4k_get_eeprom_rev(ah));
PR_EEP("Checksum", pBase->checksum);
PR_EEP("Length", pBase->length);
PR_EEP("RegDomain1", pBase->regDmn[0]);
PR_EEP("RegDomain2", pBase->regDmn[1]);
PR_EEP("Checksum", le16_to_cpu(pBase->checksum));
PR_EEP("Length", le16_to_cpu(pBase->length));
PR_EEP("RegDomain1", le16_to_cpu(pBase->regDmn[0]));
PR_EEP("RegDomain2", le16_to_cpu(pBase->regDmn[1]));
PR_EEP("TX Mask", pBase->txMask);
PR_EEP("RX Mask", pBase->rxMask);
PR_EEP("Allow 5GHz", !!(pBase->opCapFlags & AR5416_OPFLAGS_11A));
Expand All @@ -160,9 +161,9 @@ static u32 ath9k_hw_4k_dump_eeprom(struct ath_hw *ah, bool dump_base_hdr,
PR_EEP("Disable 5Ghz HT40", !!(pBase->opCapFlags &
AR5416_OPFLAGS_N_5G_HT40));
PR_EEP("Big Endian", !!(pBase->eepMisc & AR5416_EEPMISC_BIG_ENDIAN));
PR_EEP("Cal Bin Major Ver", (pBase->binBuildNumber >> 24) & 0xFF);
PR_EEP("Cal Bin Minor Ver", (pBase->binBuildNumber >> 16) & 0xFF);
PR_EEP("Cal Bin Build", (pBase->binBuildNumber >> 8) & 0xFF);
PR_EEP("Cal Bin Major Ver", (binBuildNumber >> 24) & 0xFF);
PR_EEP("Cal Bin Minor Ver", (binBuildNumber >> 16) & 0xFF);
PR_EEP("Cal Bin Build", (binBuildNumber >> 8) & 0xFF);
PR_EEP("TX Gain type", pBase->txGainType);

len += scnprintf(buf + len, size - len, "%20s : %pM\n", "MacAddress",
Expand Down Expand Up @@ -194,54 +195,31 @@ static int ath9k_hw_4k_check_eeprom(struct ath_hw *ah)
return err;

if (need_swap)
el = swab16(eep->baseEepHeader.length);
el = swab16((__force u16)eep->baseEepHeader.length);
else
el = eep->baseEepHeader.length;
el = le16_to_cpu(eep->baseEepHeader.length);

el = min(el / sizeof(u16), SIZE_EEPROM_4K);
if (!ath9k_hw_nvram_validate_checksum(ah, el))
return -EINVAL;

if (need_swap) {
u32 integer;
u16 word;

word = swab16(eep->baseEepHeader.length);
eep->baseEepHeader.length = word;

word = swab16(eep->baseEepHeader.checksum);
eep->baseEepHeader.checksum = word;

word = swab16(eep->baseEepHeader.version);
eep->baseEepHeader.version = word;

word = swab16(eep->baseEepHeader.regDmn[0]);
eep->baseEepHeader.regDmn[0] = word;

word = swab16(eep->baseEepHeader.regDmn[1]);
eep->baseEepHeader.regDmn[1] = word;

word = swab16(eep->baseEepHeader.rfSilent);
eep->baseEepHeader.rfSilent = word;

word = swab16(eep->baseEepHeader.blueToothOptions);
eep->baseEepHeader.blueToothOptions = word;

word = swab16(eep->baseEepHeader.deviceCap);
eep->baseEepHeader.deviceCap = word;

integer = swab32(eep->modalHeader.antCtrlCommon);
eep->modalHeader.antCtrlCommon = integer;

for (i = 0; i < AR5416_EEP4K_MAX_CHAINS; i++) {
integer = swab32(eep->modalHeader.antCtrlChain[i]);
eep->modalHeader.antCtrlChain[i] = integer;
}

for (i = 0; i < AR_EEPROM_MODAL_SPURS; i++) {
word = swab16(eep->modalHeader.spurChans[i].spurChan);
eep->modalHeader.spurChans[i].spurChan = word;
}
EEPROM_FIELD_SWAB16(eep->baseEepHeader.length);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.checksum);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.version);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.regDmn[0]);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.regDmn[1]);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.rfSilent);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.blueToothOptions);
EEPROM_FIELD_SWAB16(eep->baseEepHeader.deviceCap);
EEPROM_FIELD_SWAB32(eep->modalHeader.antCtrlCommon);

for (i = 0; i < AR5416_EEP4K_MAX_CHAINS; i++)
EEPROM_FIELD_SWAB32(eep->modalHeader.antCtrlChain[i]);

for (i = 0; i < AR_EEPROM_MODAL_SPURS; i++)
EEPROM_FIELD_SWAB16(
eep->modalHeader.spurChans[i].spurChan);
}

if (!ath9k_hw_nvram_check_version(ah, AR5416_EEP_VER,
Expand Down Expand Up @@ -270,13 +248,13 @@ static u32 ath9k_hw_4k_get_eeprom(struct ath_hw *ah,
case EEP_MAC_MSW:
return get_unaligned_be16(pBase->macAddr + 4);
case EEP_REG_0:
return pBase->regDmn[0];
return le16_to_cpu(pBase->regDmn[0]);
case EEP_OP_CAP:
return pBase->deviceCap;
return le16_to_cpu(pBase->deviceCap);
case EEP_OP_MODE:
return pBase->opCapFlags;
case EEP_RF_SILENT:
return pBase->rfSilent;
return le16_to_cpu(pBase->rfSilent);
case EEP_OB_2:
return pModal->ob_0;
case EEP_DB_2:
Expand Down Expand Up @@ -724,7 +702,7 @@ static void ath9k_hw_4k_set_gain(struct ath_hw *ah,
{
ENABLE_REG_RMW_BUFFER(ah);
REG_RMW(ah, AR_PHY_SWITCH_CHAIN_0,
pModal->antCtrlChain[0], 0);
le32_to_cpu(pModal->antCtrlChain[0]), 0);

REG_RMW(ah, AR_PHY_TIMING_CTRL4(0),
SM(pModal->iqCalICh[0], AR_PHY_TIMING_CTRL4_IQCORR_Q_I_COFF) |
Expand Down Expand Up @@ -790,7 +768,7 @@ static void ath9k_hw_4k_set_board_values(struct ath_hw *ah,
pModal = &eep->modalHeader;
txRxAttenLocal = 23;

REG_WRITE(ah, AR_PHY_SWITCH_COM, pModal->antCtrlCommon);
REG_WRITE(ah, AR_PHY_SWITCH_COM, le32_to_cpu(pModal->antCtrlCommon));

/* Single chain for 4K EEPROM*/
ath9k_hw_4k_set_gain(ah, pModal, eep, txRxAttenLocal);
Expand Down Expand Up @@ -1054,7 +1032,7 @@ static void ath9k_hw_4k_set_board_values(struct ath_hw *ah,

static u16 ath9k_hw_4k_get_spur_channel(struct ath_hw *ah, u16 i, bool is2GHz)
{
return ah->eeprom.map4k.modalHeader.spurChans[i].spurChan;
return le16_to_cpu(ah->eeprom.map4k.modalHeader.spurChans[i].spurChan);
}

static u8 ath9k_hw_4k_get_eepmisc(struct ath_hw *ah)
Expand Down
Loading

0 comments on commit 4bca530

Please sign in to comment.