[v3] wifi: rtl8xxxu: Support new chip RTL8710BU aka RTL8188GU

This chip is found in cheap "free driver" USB adapters from Aliexpress.
Initially they pretend to be a CD-ROM containing the driver for Windows.
"Ejecting" switches the device to wifi mode.

Features: 2.4 GHz, b/g/n mode, 1T1R, 150 Mbps.

This chip is more unique than other Realtek chips:

* The registers at addresses 0x0-0xff, which all the other chips use,
  can't be used here. New registers at 0x8000-0x80ff must be used
  instead. And it's not a simple matter of adding 0x8000: 0x2
  (REG_SYS_FUNC) became 0x8004, 0x80 (REG_MCU_FW_DL) became 0x8090,
  etc.

* Also there are a few new registers which must be accessed indirectly
  because their addresses don't fit in 16 bits. No other chips seem to
  have these.

* The vendor driver compiles to 8188gu.ko, but the code calls the chip
  RTL8710B(U) pretty much everywhere, including messages visible to the
  user.

Another difference compared to the other chips supported by rtl8xxxu is
that it has a new PHY status struct, or three of them actually, from
which we extract the RSSI, among other things. This is not unique,
though, just new. The chips supported by rtw88 also use it.

Signed-off-by: Bitterblue Smith <rtl8821cerfe2@gmail.com>
---
v3:
 - Suggestions from Ping-Ke Shih:
   - Use IS_ALIGNED macro in rtl8710b_indirect_read32() and
     rtl8710b_indirect_write32().
   - Initialise sec_ch_above in rtl8710bu_config_channel() and move an
     if statement in rtl8710bu_phy_iq_calibrate() in order to silence
     warnings about possibly uninitialised variables.

v2:
 - Suggestions from Ping-Ke Shih:
   - Add comma after the last member of enum rtl8xxxu_rtl_chip.
   - Add comment about struct mutex syson_indirect_access_mutex.
   - Declare variables in reverse Christmas tree order in
     rtl8710b_read_efuse().
   - Remove unnecessary variable ret from rtl8710bu_identify_chip().
   - Add definition for register 0xaac.
   - Use the existing macros REG_SYS_FUNC, SYS_FUNC_BBRSTB, and
     SYS_FUNC_BB_GLB_RSTN instead of magic numbers in
     rtl8710bu_active_to_lps().
   - Declare reg_mcu_fw_dl separately in rtl8xxxu_download_firmware().
 - Add spaces after /* and before */ in some comments.
 - Rearrange the declarations in rtl8710b_read_efuse8() as well.
 - Load the right firmware based on the chip manufacturer (UMC/SMIC).
 - Use the mask 0xc0 instead of 0xf0 to detect the chip manufacturer in
   rtl8710bu_identify_chip(). There was an extra shift in the vendor
   driver which I missed.
 - Make the vid and pid fields of struct rtl8710bu_efuse two bytes
   each, and the filler field res7 one byte shorter.

 - I was lazy and didn't do some things the right way in v1. I thought
   surely there are no more chips to support. But since then I
   discovered that the RTL8192FU can be bought from Aliexpress for
   6.66 $. 😄 It will need the same PHY status parsing as the RTL8710BU,
   which is why there are these extra changes:
   - Initialise priv->cck_new_agc in rtl8xxxu_init_device() always,
     regardless of the chip family.
   - Pass the PHY status structs to the CCK RSSI functions.
   - Move the "old AGC" CCK RSSI calculation from
     rtl8710bu_rx_parse_phystats_type0() to a new function
     rtl8710b_cck_rssi().
   - Rename the functions rtl8710bu_rx_parse_phystats* to
     jaguar2_rx_parse_phystats* and move them to rtl8xxxu_core.c.
   - Modify the functions jaguar2_rx_parse_phystats_type{1,2} to handle
     2T2R chips as well.
---
 drivers/net/wireless/realtek/rtl8xxxu/Kconfig |    2 +-
 .../net/wireless/realtek/rtl8xxxu/Makefile    |    2 +-
 .../net/wireless/realtek/rtl8xxxu/rtl8xxxu.h  |  313 ++-
 .../realtek/rtl8xxxu/rtl8xxxu_8188e.c         |    5 +-
 .../realtek/rtl8xxxu/rtl8xxxu_8188f.c         |    7 +-
 .../realtek/rtl8xxxu/rtl8xxxu_8192c.c         |    2 +
 .../realtek/rtl8xxxu/rtl8xxxu_8192e.c         |    5 +-
 .../realtek/rtl8xxxu/rtl8xxxu_8710b.c         | 1878 +++++++++++++++++
 .../realtek/rtl8xxxu/rtl8xxxu_8723a.c         |    5 +-
 .../realtek/rtl8xxxu/rtl8xxxu_8723b.c         |    5 +-
 .../wireless/realtek/rtl8xxxu/rtl8xxxu_core.c |  275 ++-
 .../wireless/realtek/rtl8xxxu/rtl8xxxu_regs.h |   44 +
 12 files changed, 2481 insertions(+), 62 deletions(-)
 create mode 100644 drivers/net/wireless/realtek/rtl8xxxu/rtl8xxxu_8710b.c

Message ID	4edbe29f-00b9-8eef-9789-20bed0b141e2@gmail.com
State	New
Headers	show Return-Path: <linux-wireless-owner@vger.kernel.org> Message-ID: <4edbe29f-00b9-8eef-9789-20bed0b141e2@gmail.com> Date: Mon, 13 Mar 2023 15:58:14 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.8.0 Content-Language: en-US To: "linux-wireless@vger.kernel.org" <linux-wireless@vger.kernel.org> Cc: Jes Sorensen <Jes.Sorensen@gmail.com>, Ping-Ke Shih <pkshih@realtek.com>, Jiajie Chen <c@jia.je> From: Bitterblue Smith <rtl8821cerfe2@gmail.com> Subject: [PATCH v3] wifi: rtl8xxxu: Support new chip RTL8710BU aka RTL8188GU Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	[v3] wifi: rtl8xxxu: Support new chip RTL8710BU aka RTL8188GU \| expand [v3] wifi: rtl8xxxu: Support new chip RTL8710BU aka RTL8188GU

[v3] wifi: rtl8xxxu: Support new chip RTL8710BU aka RTL8188GU

Commit Message

Comments

Patch