Skip to contentSkip to conversation

ath9k: of_init: add endian check

PATCH In review Álvaro Fernández Rojas 4 participants 9 messages Apr 17, 2023

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

v2 cover ath9k: of_init: add endian check

Add new endian check flag to allow checking the endianness of EEPROM and swap its values if needed.
This flag was already present on ath9k_platform_data as "endian_check".

For compatibility with current devices the AH_NO_EEP_SWAP flag will be activated only when qca,endian-check isn't present in the device tree. This is because some devices have the magic values swapped but not the actual EEPROM data, so activating the flag for those devices will break them.

Álvaro Fernández Rojas (2):
dt-bindings: net: wireless: ath9k: document endian check
ath9k: fix calibration data endianness

 .../devicetree/bindings/net/wireless/qca,ath9k.yaml          | 5 +++++
 drivers/net/wireless/ath/ath9k/init.c                        | 5 +++--
 2 files changed, 8 insertions(+), 2 deletions(-)
Signature · 1 line
2.30.2
#1 lore raw

PATCH v2 1/2 dt-bindings: net: wireless: ath9k: document endian check

Document new endian check flag to allow checking the endianness of EEPROM and swap its values if needed.

---
 .../devicetree/bindings/net/wireless/qca,ath9k.yaml          | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +5 -0
index 0e5412cff2bc..ff9ca5e3674b 100644
@@ -44,6 +44,11 @@ properties:
 
   ieee80211-freq-limit: true
 
+  qca,endian-check:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Indicates that the EEPROM endianness should be checked
+
   qca,no-eeprom:
     $ref: /schemas/types.yaml#/definitions/flag
     description:
Signature · 1 line
2.30.2
#2 lore raw

Re: [PATCH v2 1/2] dt-bindings: net: wireless: ath9k: document endian check

Quoted 4 lines · Álvaro Fernández Rojas

Document new endian check flag to allow checking the endianness of EEPROM and swap its values if needed.

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

You missed the lists so this won't be tested. Resend following Linux kernel submission process.

Quoted 9 lines
---
 .../devicetree/bindings/net/wireless/qca,ath9k.yaml          | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +0 -0
index 0e5412cff2bc..ff9ca5e3674b 100644

Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml properties: · line 50

Quoted 7 lines
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +4 -0
@@ -44,6 +44,11 @@ properties:
 
   ieee80211-freq-limit: true
 
+  qca,endian-check:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Indicates that the EEPROM endianness should be checked

Does not look like hardware property. Do not instruct what driver should or should not do. It's not the purpose of DT.

Best regards,
Krzysztof

#3 lore raw

Re: [PATCH v2 1/2] dt-bindings: net: wireless: ath9k: document endian check

Quoted 6 lines · Krzysztof Kozlowski
Quoted 6 lines
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +0 -0
@@ -44,6 +44,11 @@ properties:
 
   ieee80211-freq-limit: true
 
Quoted 7 lines

Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml properties: · line 50

Quoted 4 lines
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +4 -0
+  qca,endian-check:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Indicates that the EEPROM endianness should be checked

Does not look like hardware property. Do not instruct what driver should or should not do. It's not the purpose of DT.

Also the documentation is vague and is not really telling anything new what could be figured out from the property name, I would not be able to understand just from this what value should be used.

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#4 lore raw

Re: [PATCH v2 1/2] dt-bindings: net: wireless: ath9k: document endian check

In reply to Krzysztof Kozlowski
Quoted 11 lines · Krzysztof Kozlowski
Quoted 4 lines · Álvaro Fernández Rojas

Document new endian check flag to allow checking the endianness of EEPROM and swap its values if needed.

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

I forgot to get the updated list for v2, sorry for that!

Quoted 3 lines

You missed the lists so this won't be tested. Resend following Linux kernel submission process.

Looks like we will need v3 anyway, so I'll get all the maintainers in the next version.

Quoted 26 lines
Quoted 11 lines

---
 .../devicetree/bindings/net/wireless/qca,ath9k.yaml          | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +0 -0
index 0e5412cff2bc..ff9ca5e3674b 100644

Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml properties: · line 50

Quoted 7 lines
Documentation/devicetree/bindings/net/wireless/qca,ath9k.yaml +4 -0
@@ -44,6 +44,11 @@ properties:
 
   ieee80211-freq-limit: true
 
+  qca,endian-check:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Indicates that the EEPROM endianness should be checked

Does not look like hardware property. Do not instruct what driver should or should not do. It's not the purpose of DT.

Best regards,
Krzysztof

#5 lore raw

PATCH v2 2/2 ath9k: of_init: add endian check

In reply to Álvaro Fernández Rojas

BCM63xx (Big Endian MIPS) devices store the calibration data in MTD partitions but it needs to be swapped in order to work, otherwise it fails:
ath9k 0000:00:01.0: enabling device (0000 -> 0002)
ath: phy0: Ignoring endianness difference in EEPROM magic bytes.
ath: phy0: Bad EEPROM VER 0x0001 or REV 0x00e0
ath: phy0: Unable to initialize hardware; initialization status: -22 ath9k 0000:00:01.0: Failed to initialize device
ath9k: probe of 0000:00:01.0 failed with error -22

For compatibility with current devices the AH_NO_EEP_SWAP flag will be activated only when qca,endian-check isn't present in the device tree. This is because some devices have the magic values swapped but not the actual EEPROM data, so activating the flag for those devices will break them.

---
 drivers/net/wireless/ath/ath9k/init.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/wireless/ath/ath9k/init.c +3 -2
index 4f00400c7ffb..abde953aec61 100644
@@ -615,7 +615,6 @@ static int ath9k_nvmem_request_eeprom(struct ath_softc *sc)
 
 	ah->nvmem_blob_len = len;
 	ah->ah_flags &= ~AH_USE_EEPROM;
-	ah->ah_flags |= AH_NO_EEP_SWAP;
 
 	return 0;
 }
@@ -688,9 +687,11 @@ static int ath9k_of_init(struct ath_softc *sc)
 			return ret;
 
 		ah->ah_flags &= ~AH_USE_EEPROM;
-		ah->ah_flags |= AH_NO_EEP_SWAP;
 	}
 
+	if (!of_property_read_bool(np, "qca,endian-check"))
+		ah->ah_flags |= AH_NO_EEP_SWAP;
+
 	of_get_mac_address(np, common->macaddr);
 
 	return 0;
Signature · 1 line
2.30.2
#6 lore raw
Quoted 32 lines · Álvaro Fernández Rojas

BCM63xx (Big Endian MIPS) devices store the calibration data in MTD partitions but it needs to be swapped in order to work, otherwise it fails:
ath9k 0000:00:01.0: enabling device (0000 -> 0002)
ath: phy0: Ignoring endianness difference in EEPROM magic bytes.
ath: phy0: Bad EEPROM VER 0x0001 or REV 0x00e0
ath: phy0: Unable to initialize hardware; initialization status: -22 ath9k 0000:00:01.0: Failed to initialize device
ath9k: probe of 0000:00:01.0 failed with error -22

For compatibility with current devices the AH_NO_EEP_SWAP flag will be activated only when qca,endian-check isn't present in the device tree. This is because some devices have the magic values swapped but not the actual EEPROM data, so activating the flag for those devices will break them.

---
 drivers/net/wireless/ath/ath9k/init.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/wireless/ath/ath9k/init.c +0 -1
index 4f00400c7ffb..abde953aec61 100644
@@ -615,7 +615,6 @@ static int ath9k_nvmem_request_eeprom(struct ath_softc *sc)
 
 	ah->nvmem_blob_len = len;
 	ah->ah_flags &= ~AH_USE_EEPROM;
-	ah->ah_flags |= AH_NO_EEP_SWAP;
 
 	return 0;
 }

drivers/net/wireless/ath/ath9k/init.c static int ath9k_of_init(struct ath_softc *sc) · line 694

Quoted 9 lines
drivers/net/wireless/ath/ath9k/init.c +3 -1
@@ -688,9 +687,11 @@ static int ath9k_of_init(struct ath_softc *sc)
 			return ret;
 
 		ah->ah_flags &= ~AH_USE_EEPROM;
-		ah->ah_flags |= AH_NO_EEP_SWAP;
 	}
 
+	if (!of_property_read_bool(np, "qca,endian-check"))
+		ah->ah_flags |= AH_NO_EEP_SWAP;
+

So I'm not sure just setting (or not) this flag actually leads to consistent behaviour. The code in ath9k_hw_nvram_swap_data() that reacts to this flag does an endianness check before swapping, and the behaviour of this check depends on the CPU endianness. However, the byte swapping you're after here also swaps u8 members of the eeprom, so it's not really a data endianness swap, and I don't think it should depend on the endianness of the CPU?

So at least conceptually, the magic byte check in ath9k_hw_nvram_swap_data() is wrong; instead the byteswap check should just be checking against the little-endian version of the firmware (i.e., 0xa55a; I think that's what your device has, right?). However, since we're setting an explicit per-device property anyway (in the device tree), maybe it's better to just have that be an "eeprom needs swapping" flag and do the swap unconditionally if it's set? I think that would address Krzysztof's comment as well ("needs swapping" is a hardware property, "do the check" is not).

Now, the question becomes whether the "check" code path is actually used for anything today? The old mail thread I quoted in the other thread seems to indicate it's not, but it's not quite clear from the code whether there's currently any way to call into ath9k_hw_nvram_swap_data() without the NO_EEP_SWAP flag being set?

WDYT?

-Toke

#7 lore raw
Quoted 53 lines · Toke Høiland-Jørgensen
Quoted 32 lines · Álvaro Fernández Rojas

BCM63xx (Big Endian MIPS) devices store the calibration data in MTD partitions but it needs to be swapped in order to work, otherwise it fails:
ath9k 0000:00:01.0: enabling device (0000 -> 0002)
ath: phy0: Ignoring endianness difference in EEPROM magic bytes.
ath: phy0: Bad EEPROM VER 0x0001 or REV 0x00e0
ath: phy0: Unable to initialize hardware; initialization status: -22 ath9k 0000:00:01.0: Failed to initialize device
ath9k: probe of 0000:00:01.0 failed with error -22

For compatibility with current devices the AH_NO_EEP_SWAP flag will be activated only when qca,endian-check isn't present in the device tree. This is because some devices have the magic values swapped but not the actual EEPROM data, so activating the flag for those devices will break them.

---
 drivers/net/wireless/ath/ath9k/init.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/wireless/ath/ath9k/init.c +0 -1
index 4f00400c7ffb..abde953aec61 100644
@@ -615,7 +615,6 @@ static int ath9k_nvmem_request_eeprom(struct ath_softc *sc)
 
      ah->nvmem_blob_len = len;
      ah->ah_flags &= ~AH_USE_EEPROM;
-     ah->ah_flags |= AH_NO_EEP_SWAP;
 
      return 0;
 }

drivers/net/wireless/ath/ath9k/init.c static int ath9k_of_init(struct ath_softc *sc) · line 694

Quoted 9 lines
drivers/net/wireless/ath/ath9k/init.c +3 -1
@@ -688,9 +687,11 @@ static int ath9k_of_init(struct ath_softc *sc)
                      return ret;
 
              ah->ah_flags &= ~AH_USE_EEPROM;
-             ah->ah_flags |= AH_NO_EEP_SWAP;
      }
 
+     if (!of_property_read_bool(np, "qca,endian-check"))
+             ah->ah_flags |= AH_NO_EEP_SWAP;
+

So I'm not sure just setting (or not) this flag actually leads to consistent behaviour. The code in ath9k_hw_nvram_swap_data() that reacts to this flag does an endianness check before swapping, and the behaviour of this check depends on the CPU endianness. However, the byte swapping you're after here also swaps u8 members of the eeprom, so it's not really a data endianness swap, and I don't think it should depend on the endianness of the CPU?

Quoted 9 lines

So at least conceptually, the magic byte check in ath9k_hw_nvram_swap_data() is wrong; instead the byteswap check should just be checking against the little-endian version of the firmware (i.e., 0xa55a; I think that's what your device has, right?). However, since we're setting an explicit per-device property anyway (in the device tree), maybe it's better to just have that be an "eeprom needs swapping" flag and do the swap unconditionally if it's set? I think that would address Krzysztof's comment as well ("needs swapping" is a hardware property, "do the check" is not).

Yes, you're right, it's probably better to introduce a new and more clear flag that swaps the content inconditionally.

Quoted 6 lines

Now, the question becomes whether the "check" code path is actually used for anything today? The old mail thread I quoted in the other thread seems to indicate it's not, but it's not quite clear from the code whether there's currently any way to call into ath9k_hw_nvram_swap_data() without the NO_EEP_SWAP flag being set?

It's only used when endian_check is enabled in ath9k_platform_data:
https://github.com/torvalds/linux/blob/6a8f57ae2eb07ab39a6f0ccad60c760743051026/drivers/net/wireless/ath/ath9k/init.c#L645
We're currently using it on OpenWrt for bmips:
https://github.com/Noltari/openwrt/blob/457549665fcb93667453ef48c50bf43eddd776ef/target/linux/bmips/files/arch/mips/bmips/ath9k-fixup.c#L198-L199

Quoted 4 lines

WDYT?

-Toke

#8 lore raw
Quoted 69 lines · Álvaro Fernández Rojas
Quoted 53 lines · Toke Høiland-Jørgensen
Quoted 32 lines · Álvaro Fernández Rojas

BCM63xx (Big Endian MIPS) devices store the calibration data in MTD partitions but it needs to be swapped in order to work, otherwise it fails:
ath9k 0000:00:01.0: enabling device (0000 -> 0002)
ath: phy0: Ignoring endianness difference in EEPROM magic bytes.
ath: phy0: Bad EEPROM VER 0x0001 or REV 0x00e0
ath: phy0: Unable to initialize hardware; initialization status: -22 ath9k 0000:00:01.0: Failed to initialize device
ath9k: probe of 0000:00:01.0 failed with error -22

For compatibility with current devices the AH_NO_EEP_SWAP flag will be activated only when qca,endian-check isn't present in the device tree. This is because some devices have the magic values swapped but not the actual EEPROM data, so activating the flag for those devices will break them.

---
 drivers/net/wireless/ath/ath9k/init.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/wireless/ath/ath9k/init.c +0 -1
index 4f00400c7ffb..abde953aec61 100644
@@ -615,7 +615,6 @@ static int ath9k_nvmem_request_eeprom(struct ath_softc *sc)
 
      ah->nvmem_blob_len = len;
      ah->ah_flags &= ~AH_USE_EEPROM;
-     ah->ah_flags |= AH_NO_EEP_SWAP;
 
      return 0;
 }

drivers/net/wireless/ath/ath9k/init.c static int ath9k_of_init(struct ath_softc *sc) · line 694

Quoted 9 lines
drivers/net/wireless/ath/ath9k/init.c +3 -1
@@ -688,9 +687,11 @@ static int ath9k_of_init(struct ath_softc *sc)
                      return ret;
 
              ah->ah_flags &= ~AH_USE_EEPROM;
-             ah->ah_flags |= AH_NO_EEP_SWAP;
      }
 
+     if (!of_property_read_bool(np, "qca,endian-check"))
+             ah->ah_flags |= AH_NO_EEP_SWAP;
+

So I'm not sure just setting (or not) this flag actually leads to consistent behaviour. The code in ath9k_hw_nvram_swap_data() that reacts to this flag does an endianness check before swapping, and the behaviour of this check depends on the CPU endianness. However, the byte swapping you're after here also swaps u8 members of the eeprom, so it's not really a data endianness swap, and I don't think it should depend on the endianness of the CPU?

Quoted 9 lines

So at least conceptually, the magic byte check in ath9k_hw_nvram_swap_data() is wrong; instead the byteswap check should just be checking against the little-endian version of the firmware (i.e., 0xa55a; I think that's what your device has, right?). However, since we're setting an explicit per-device property anyway (in the device tree), maybe it's better to just have that be an "eeprom needs swapping" flag and do the swap unconditionally if it's set? I think that would address Krzysztof's comment as well ("needs swapping" is a hardware property, "do the check" is not).

Yes, you're right, it's probably better to introduce a new and more clear flag that swaps the content inconditionally.

Quoted 1 line
Quoted 8 lines
Quoted 5 lines

Now, the question becomes whether the "check" code path is actually used for anything today? The old mail thread I quoted in the other thread seems to indicate it's not, but it's not quite clear from the code whether there's currently any way to call into ath9k_hw_nvram_swap_data() without the NO_EEP_SWAP flag being set?

It's only used when endian_check is enabled in ath9k_platform_data:
https://github.com/torvalds/linux/blob/6a8f57ae2eb07ab39a6f0ccad60c760743051026/drivers/net/wireless/ath/ath9k/init.c#L645

Right, I found that, but was looking for anywhere that sets it, and couldn't find that anywhere. So this exists solely for the use of out of tree code?

Quoted 2 lines

We're currently using it on OpenWrt for bmips:
https://github.com/Noltari/openwrt/blob/457549665fcb93667453ef48c50bf43eddd776ef/target/linux/bmips/files/arch/mips/bmips/ath9k-fixup.c#L198-L199

Hmm, but that is arguably wrong in the same way, in that it triggers the code in ath9k_hw_nvram_swap_data() which swaps or not depending on the CPU endianness.

Is the magic byte check actually useful for that user? I.e., are there some devices that have 0xa55a as magic bytes, and some that have 0x5aa5? Or could the device tree flag in that fixup driver above be replaced with the one you're proposing here?

-Toke