Skip to content

Arthur-Philip-Dent/rtl88x2bu

BranchesTags
 
 

Repository files navigation

Administrative Note

As of upstream version 5.6.1, I'm moving away from individual repositories for each upstream version in favor of a single repository with version-based branches. Hopefully, this will help with clutter and URL consistency moving forward. The archived repositories are available here:

Driver for rtl88x2bu wifi adaptors

Updated driver for rtl88x2bu wifi adaptors based on Realtek's source distributed with myriad adapters.

Realtek's 5.6.1.6 source was found bundled with the Cudy WU1200 AC1200 High Gain USB Wi-Fi Adapter and can be downloaded from Cudy's website.

Build confirmed on:

  • Linux version 5.4.0-91-generic on Linux Mint 20.2 (30 November 2021)
  • Linux version 5.15.89 on Manjaro (3 February 2023)
  • Linux version 5.19 on Ubuntu 22.4
  • Linux version 6.1.0-9-amd64 on Debian Bookworm
  • Linux version 6.1.* (self compiled) on Debian Bookworm and Ubuntu 22.04
  • Linux version 6.2.* (self compiled) on Debian Bookworm and Ubuntu 22.04
  • Linux version 6.3.* (self compiled) on Debian Bookworm and Ubuntu 22.04
  • Linux version 6.4.3 (self compiled) on Debian Bookworm
  • Linux version 6.5.5 (self compiled) on Debian Bookworm
  • Linux version 6.6.1 (self compiled) on Debian Bookworm
  • Linux version 6.7.2 (self compiled) on Debian Bookworm and Ubuntu 22.04

Using and Installing the Driver

Simple Usage

In order to make direct use of the driver it should suffice to build the driver with make and to load it with insmod 88x2bu.ko. This will allow you to use the driver directly without changing your system persistently.

It might happen that your system freezes instantaneously. Ensure to not loose important work by saving and such beforehand.

DKMS installation

If you want to have the driver available at startup, it will be convenient to register it in DKMS. An executable explanation of how to do so can be found in the script deploy.sh. Since registering a kernel module in DKMS is a major intervention, only execute it if you understand what the script does.

Unknown Symbol Errors

Some users reported problems due to Unknown symbol in module. This can be caused by old deployments of the driver still being present in the systems directories. One solution reported was to forcefully remove all old driver modules:

sudo dkms remove rtl88x2bu/5.8.7.4 --all
find /lib/modules -name cfg80211.ko -ls
sudo rm -f /lib/modules/*/updates/net/wireless/cfg80211.ko

This can also be caused by cfg80211 module not being present in the kernel. You can remedy this by running:

sudo modprobe cfg80211

Linux 5.18+ and RTW88 Driver

Starting from Linux 5.18, some distributions have added experimental RTW88 USB support (include RTW88x2BU support). It is not yet stable but if it works well on your system, then you no longer need this driver. But if it doesn't work or is unstable, you need to manually blacklist it because it has a higher loading priority than this external drivers.

Check the currently loaded module using lsmod. If you see rtw88_core, rtw88_usb, or any name beginning with rtw88_ then you are using the RTW88 driver. If you see 88x2bu then you are using this RTW88x2BU driver.

To blacklist RTW88 8822bu USB driver, run the following command. It will replace the existing *.conf file with the echoed content.

echo "blacklist rtw88_8822bu" | sudo tee /etc/modprobe.d/rtw8822bu.conf

Then reboot your system.

Secure Boot

Secure Boot will prevent the module from loading as it isn't signed. In order to check whether you have secure boot enabled, you couly run mokutil --sb-state. If you see something like SecureBoot disabled, you do not take to setup module signing.

If Secure Boot is enabled on your machine, you either could disable it in BIOS or UEFI or you could set up signing the module. How to do so is described here.

Raspberry Pi Access Point

# Update all packages per normal
sudo apt update
sudo apt upgrade

# Install prereqs
sudo apt install git dnsmasq hostapd bc build-essential dkms raspberrypi-kernel-headers

# Reboot just in case there were any kernel updates
sudo reboot

# Pull down the driver source
git clone https://github.com/cilynx/rtl88x2bu
cd rtl88x2bu/

# Configure for RasPi
sed -i 's/I386_PC = y/I386_PC = n/' Makefile
sed -i 's/ARM_RPI = n/ARM_RPI = y/' Makefile

# DKMS as above
VER=$(sed -n 's/\PACKAGE_VERSION="\(.*\)"/\1/p' dkms.conf)
sudo rsync -rvhP ./ /usr/src/rtl88x2bu-${VER}
sudo dkms add -m rtl88x2bu -v ${VER}
sudo dkms build -m rtl88x2bu -v ${VER} # Takes ~3-minutes on a 3B+
sudo dkms install -m rtl88x2bu -v ${VER}

# Plug in your adapter then confirm your new interface name
ip addr

# Set a static IP for the new interface (adjust if you have a different interface name or preferred IP)
sudo tee -a /etc/dhcpcd.conf <<EOF
interface wlan1
    static ip_address=192.168.4.1/24
    nohook wpa_supplicant
EOF

# Clobber the default dnsmasq config
sudo tee /etc/dnsmasq.conf <<EOF
interface=wlan1
  dhcp-range=192.168.4.100,192.168.4.199,255.255.255.0,24h
EOF

# Configure hostapd
sudo tee /etc/hostapd/hostapd.conf <<EOF
interface=wlan1
driver=nl80211
ssid=pinet
hw_mode=g
channel=7
wmm_enabled=0
macaddr_acl=0
auth_algs=1
ignore_broadcast_ssid=0
wpa=2
wpa_passphrase=CorrectHorseBatteryStaple
wpa_key_mgmt=WPA-PSK
wpa_pairwise=TKIP
rsn_pairwise=CCMP
EOF

sudo sed -i 's|#DAEMON_CONF=""|DAEMON_CONF="/etc/hostapd/hostapd.conf"|' /etc/default/hostapd

# Enable hostapd
sudo systemctl unmask hostapd
sudo systemctl enable hostapd

# Reboot to pick up the config changes
sudo reboot

If you want 802.11an speeds 144Mbps you could use this config below:

# Configure hostapd
sudo tee /etc/hostapd/hostapd.conf <<EOF
interface=wlx74ee2ae24062
driver=nl80211
ssid=borg

macaddr_acl=0
auth_algs=1
ignore_broadcast_ssid=0
wpa=2
wpa_passphrase=toe54321
wpa_key_mgmt=WPA-PSK
wpa_pairwise=TKIP
rsn_pairwise=CCMP

hw_mode=a
channel=36
wmm_enabled=1

country_code=US

require_ht=1
ieee80211ac=1
require_vht=1

#This below is supposed to get us 867Mbps and works on rtl8814au doesn't work on this driver yet
#vht_oper_chwidth=1
#vht_oper_centr_freq_seg0_idx=157

ieee80211n=1
ieee80211ac=1
EOF

$ iwconfig
wlx74ee2ae24062  IEEE 802.11an  ESSID:"borg"  Nickname:"<WIFI@REALTEK>"
          Mode:Master  Frequency:5.18 GHz  Access Point: 74:EE:2A:E2:40:62
          Bit Rate:144.4 Mb/s   Sensitivity:0/0
          Retry:off   RTS thr:off   Fragment thr:off
          Power Management:off
          Link Quality=0/100  Signal level=-100 dBm  Noise level=0 dBm
          Rx invalid nwid:0  Rx invalid crypt:0  Rx invalid frag:0
          Tx excessive retries:0  Invalid misc:0   Missed beacon:0

If you want to setup masquerading or bridging, check out the official Raspberry Pi docs.

The shortest way to self-compile your driver-module:

#! /bin/bash

# build_88x2bu.sh - rtl88x2bu-make-wrapper by Arthur-Philip-Dent
# just do the steps to make your rtl88x2bu-driver (redo after each kernel-update) 
# greetings fly out to @beckerstef and @marcone
# thanks to @cilynx for the rtl88x2bu-tree to make it so easy just wrapped this script around
# it's not perfect, still learning! Suggestions welcomed!
# 
# HECK, yeah, I have to get more into this github
# Best Regards
# 
# The Hithhiker 

# find out if the bookworms are in...
if [ -e /boot/firmware ]
  then 
    # set firmware folder
    BOOT_DIR=/boot/firmware
  else
    BOOT_DIR=/boot
fi 

# if we are in a TeslaUSB device.... make sure the system is rw
if sudo test -e /root/bin/remountfs_rw 
  then 
    echo -e "Ahhh, a TeslaUSB device! \n... unlocking ro partitions.\n"
    sudo /root/bin/remountfs_rw 2>&1
    echo
fi

# set if we do update/upgrade in same time
# but only, if this is the first call
if [ -f "$(dirname $0)/.rebooted_rebuild_88x2bu" ] 
  then 
    # we have been here already, delete marker
    rm "$(dirname $0)/.rebooted_rebuild_88x2bu" 2>&1
    UPD=0  
  else
    echo -e -n "It is recommended to do a full upgrade of OS first. Proceed with update (y/n - ENTER)? "
    read choice
    case "$choice" in
      n|N ) UPD=0;;
      * )  UPD=1;;
    esac
    choice=
    echo 
    
    
    if [ ${UPD} -eq 1 ]
      then
        # better upgrade all to make sure we are all set
        echo -e "Taking care of system-updates/upgrades...\n"
        sudo apt-get -y update
        sudo apt-get -y upgrade
        echo -e "Please come back here again after rebooting!\n\nRebooting in 5 sec...\n"  
        touch "$(dirname $0)/.rebooted_rebuild_88x2bu" 2>&1
        sleep 5
        sudo reboot now
        sleep 5
        exit 0 # get out o'here... 
      else
        echo -e "We have been here for update earlier!\nNothing else to do.\nWe proceed...\n"
        sleep 5
    fi
fi 

# setting up development env and make sure to have all we need to compile modules
echo -e "Setting up development env ...\nchecking all tools...\n"
sudo apt-get -y install build-essential bc git wget libssl-dev bison flex dkms libncurses-dev raspberrypi-kernel-headers iperf

# throw away old stuff and get the code for the rtl8812bu kernel module
if [ -d ~/rtl8812bu-build ]
  then
    rm -fr ~/rtl8812bu-build
fi

mkdir -p ~/rtl8812bu-build/
cd ~/rtl8812bu-build/

echo -e "Fetching sources...\n"
git clone https://github.com/Arthur-Philip-Dent/rtl88x2bu.git

cd ~/rtl8812bu-build/rtl88x2bu/

# modify the makefile for raspi
echo -e "Modify make-file...\n"
sed -i '/CONFIG_PLATFORM_I386_PC = y/c\CONFIG_PLATFORM_I386_PC = n' Makefile
sed -i '/CONFIG_PLATFORM_ARM_RPI = n/c\CONFIG_PLATFORM_ARM_RPI = y' Makefile

# Set the module and version
echo -e "Checking module-version...\n"
NAME=$(sed -n 's/\PACKAGE_NAME="\(.*\)"/\1/p' dkms.conf)
VER=$(sed -n 's/\PACKAGE_VERSION="\(.*\)"/\1/p' dkms.conf)
KERNEL_VERSION=$(uname -r)


# Check if the module is already in the DKMS tree for the current kernel version
if ! dkms status -m $NAME -v $VER -k $KERNEL_VERSION | grep -q installed
  then
    echo -e "We need a new build...\n"
    # copy the sources to the DKMS (dynamic kernel module support) to get ready for build
    sudo rsync -rvhP ./ /usr/src/${NAME}-${VER} > /dev/null
    sleep 10

    # add the rtl88x2bu code to the dkms build-tree
    sudo dkms add -m ${NAME} -v ${VER}
    sleep 10

    # build the rtl88x2bu module (we added only this so its only this module being build)
    sudo dkms build -m ${NAME} -v ${VER}
    sleep 10

    # install the newly built kernel module into dkms
    sudo dkms install -m ${NAME} -v ${VER}
    sleep 10

    # load the installed kernel modul rtl88x2bu into the kernel an cross fingers
    # to force USB2.0 480MBit
    #sudo modprobe 88x2bu rtw_switch_usb_mode=2
    # to force USB3.0 5000MBit
    sudo modprobe 88x2bu rtw_switch_usb_mode=1
    sudo sh -c 'echo options 88x2bu rtw_switch_usb_mode=1 > /etc/modprobe.d/99-88x2bu.conf'
    sleep 10

    # test if command was successful and module rtl88x2bu is loaded
    echo -e "Testing, if built was succesful...\nPls ignore the \"PM usage count underflow\" error!\n"
    dmesg | grep ${NAME}
    sleep 10

     
  else
    # If already installed, show a message
      echo -e "Module ${NAME}-${VER} is already installed for kernel ${KERNEL_VERSION}.\nNo new built needed!\n"
fi

# Ask for user for disableing internal WiFi
echo -e -n "Running with two WLAN-adapters can cause problems. Better deactivate the internal wlan0 (y/n - ENTER) "
read choice
case "${choice}" in
  n|N ) TERMINATE_WLAN0=0;;
  * ) TERMINATE_WLAN0=1;;
esac
choice=
echo 


# check ${BOOT_DIR}/config.txt for entry "dtoverlay=disable-wifi"
if [ ${TERMINATE_WLAN0} -eq 1 ] && sudo grep -q "^.*dtoverlay=disable-wifi" "${BOOT_DIR}/config.txt" 

  # Make entry in ${BOOT_DIR}/config.txt only, when not exists 
  then
    echo -e "Entry in config.txt for disabling internal WiFi exists... \nun-commenting it, if necessary, so it does take effect...\ninternal wlan0 deactivated now\n"
    sudo sed -i -e 's/.*dtoverlay=disable-wifi/dtoverlay=disable-wifi/' "${BOOT_DIR}/config.txt"

  # no entry, but obviously we didn't find one to activate
  elif [ ${TERMINATE_WLAN0} -eq 1 ] 
    then
      echo -e "Adding lines to ${BOOT_DIR}/config.txt: \n   # disable WiFi\n   dtoverlay=disable-wifi\n" 
      echo -e "# disable WiFi\ndtoverlay=disable-wifi" >> ${BOOT_DIR}/config.txt

  # If entry exists and user doesn't want to terminate... heck, if entry is not commented out...
  elif [ ${TERMINATE_WLAN0} -eq 0 ] && sudo grep -q "^.*dtoverlay=disable-wifi" "${BOOT_DIR}/config.txt"
    then 
      echo -e "Entry in config.txt for disabling internal WiFi exists... \ncommenting if necessary, so it doesn't take effect...\ninternal wlan0 active now\n"
      sudo sed -i -e 's/.*dtoverlay=disable-wifi/# dtoverlay=disable-wifi/' "${BOOT_DIR}/config.txt"
fi    

# Ask for user confirmation before rebooting
echo -e -n "After (re-)compiling kernel modules an/or changing the ${BOOT_DIR}/config.txt a reboot is a good idea!\nDo you want to reboot now? (y/n - ENTER) "
read choice
case "${choice}" in
  n|N ) echo -e "You chose not to reboot. \nPlease reboot your system later to apply changes, if there are any.\n";;
  * ) sudo reboot now;;
esac
choice=
echo 

exit 0 # get out o'here...

About

rtl88x2bu driver updated for current kernels.

www.wolfteck.com/2018/02/22/wsky_1200mbps_wireless_usb_wifi_adapter/

Resources

Readme

License

GPL-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • C 99.6%
  • Other 0.4%