search

morrownr / 8812au-20210820

Linux Driver for USB WiFi Adapters that are based on the RTL8812AU Chipset - v5.13.6-23
Other
149 stars 34 forks source link
linux-driver realtek rtl8812au usb wifi

readme

8812au ( 8812au.ko ) :rocket:

Linux Driver for USB WiFi Adapters that are based on the RTL8812AU Chipset

[!NOTE] Please read the file "supported-device-IDs" for information about how to confirm that this is the correct driver for your adapter.

[!WARNING] Posting this driver is not a recommendation for Linux users to buy USB WiFi adapters based on the Realtek chipsets supported by this driver.

Realtek's out-of-kernel wifi drivers, such as this one, are not Linux Wireless Standards-compliant and appear to be designed to be used by skilled programmers producing products such as embedded systems. Users of desktop and server distros such as Ubuntu, Debian, Manjaro, Fedora, Raspberry Pi OS and other mainline desktop and server distros will likely find adapters that use in-kernel drivers (Linux Wireless Standards compliant) to be more stable and much more trouble-free. The following links will provide more information:

Supported Features

[!NOTE] Monitor mode is not supported. Linux users that want good support for monitor mode in a dual band or tri-band adapter should seek out USB WiFi adapters based on the mt7610u, mt7612u or mt7921au chipsets.

A FAQ is available in this repo with the name FAQ.md

Additional documentation is in the file 8812au.conf

Compatible CPU Architectures

[!NOTE] Additional CPU architectures may work but I currently only have the hardware to test the above.

Compatible Kernels

[!NOTE] Note: Kernels earlier than 5.4 may work but are not tested or supported.

Tested Compilers

Tested Linux Distributions

[!NOTE] The information in this section depends largely on user reports which can be provided via PR or message in Issues.

Red Hat Enterprise Linux (RHEL)

RHEL and distros based on RHEL are supported by Red Hat devs due to the way kernel patches are handled in Red Hat. I support knowledgable RHEL developers if they want to merge the required support and keep it current. I reserve the right to delete this support without notice if it causes any problems.

Current RHEL maintainer: none

Android

Android is supported in the driver according to Realtek. I will support knowledgable Android developers if they want to merge and keep current the required support (most likely just instructions about how to compile and maybe a modification or two to the Makefile).

Current Android maintainer: none

OpenWRT

[!WARNING] OpenWRT is not supported.

OpenWRT provides drivers for USB WiFi adapters. OpenWRT provided drivers include support for the MT7921au (AXE3000), MT7612u (AC1200), MT7610u (AC600) chipsets. It is a challenge to use Realtek based adapters that use out-of-kernel drivers with OpenWRT so it is strongly advised to use the already supported chipsets.

Compatible Devices

Installation Information

It is recommended that you follow the installation instructions in the Installation Steps section. Avoid installation by downloading the zip file if at all possible. Support can only be provided, on a best effort basis, if the instructions in the Installation Steps section are followed.

[!WARNING] Installing multiple out-of-kernel drivers for the same hardware usually does not end well. The install-driver.sh script has the capability to detect and remove most conflicting drivers but not all.

If this driver does not work well after installation and you have previously installed a driver that you did not remove, it is suggested that you run the following command in an effort to determine if you need to take action to manually remove conflicting drivers:

sudo dkms status

[!IMPORTANT] If you decide to do a distro upgrade, which will likely install a new version of kernel such as 5.15 to 6.1, you need to update this driver with the newest available code and then reinstall it before performing the disto upgrade. See the section "Upgrading the Driver" for the relevant instructions.

Internet access is required for initial installation. There are numerous ways to enable temporary internet access depending on your hardware and situation. One method is to use tethering from a phone.. Another method is to keep a WiFi adapter that uses an in-kernel driver in your toolkit.

You will need to use the terminal interface. The quick way to open a terminal: Ctrl+Alt+T (hold down on the Ctrl and Alt keys then press the T key).

An alternative terminal is to use SSH (Secure Shell) from the same or from another computer, in which case you will be in a suitable terminal after logging in, but this step requires that an SSH daemon/server has already been configured. (There are lots of SSH guides available, e.g., for the Raspberry Pi and for Ubuntu. Do not forget to secure the SSH server.)

You will need to have sufficient access rights to use sudo so that commands can be executed as the root user. (If the command sudo echo Yes returns "Yes", with or without having to enter your password, you do have sufficient access rights.)

DKMS is used for the installation, if available. DKMS is a system utility which will automatically recompile and reinstall this driver when a new kernel is installed. DKMS is provided by and maintained by Dell.

It is recommended that you do not delete the driver directory after installation as the directory contains information and scripts that you may need in the future.

Secure Boot: see FAQ.

Installation Steps

[!NOTE] The installation instructions are for the novice user. Experienced users are welcome to alter the installation to meet their needs. Support will be provided, on a best effort basis, based on the steps below. Another way to word this paragraph is that if you do not follow the below steps for installation, you are your own tech support.

  1. Open a terminal.

  2. Update and upgrade system packages.

    The exact command will vary based on your Linux distribution.

    Commands for some common distributions are provided below. - Debian-based distributions (including Ubuntu, Kali, Armbian, and Rasperry Pi OS): ``` shell sudo apt update && sudo apt upgrade ``` - Arch-based distributions (e.g. Manjaro): ``` shell sudo pacman -Syu ``` - Fedora-based distributions: ``` shell sudo dnf upgrade ``` - openSUSE-based distributions: ``` shell sudo zypper update ``` - Void Linux: ``` shell sudo xbps-install -Syu ```

  3. Reboot your operating system:

    sudo reboot

  4. Install the build dependencies.

    • Mandatory packages:
      • gcc
      • make
      • bc
      • kernel-headers
      • build-essential
      • git
    • Highly recommended packages:
      • dkms
      • rfkill
      • iw
      • ip
    • Mandatory packages if Secure Boot is active:
      • openssl
      • sign-file
      • mokutil

    The exact package names will vary based on your Linux distribution.

    [!TIP] If you are asked to choose a provider, make sure to choose the one that corresponds to your version of the linux kernel (for example, "linux510-headers" for Linux kernel version 5.10). If you install the incorrect version, you'll have to uninstall it and install the correct version.

    Commands for some common Linux distributions - Armbian (arm64): ``` shell sudo apt install -y build-essential ``` - Raspberry Pi OS (arm/arm64): ``` shell sudo apt install -y raspberrypi-kernel-headers build-essential bc dkms git ``` - Debian, Kali, and Raspberry Pi Desktop (x86): ``` shell sudo apt install -y linux-headers-$(uname -r) build-essential bc dkms git libelf-dev rfkill iw ``` Additionally, if using kali-pi for RasPi4B/5B: ``` shell sudo apt install -y kalipi-kernel-headers build-essential bc dkms git ``` - Ubuntu and Ubuntu-based distros: ``` shell sudo apt install -y build-essential dkms git iw ``` - Fedora: ``` shell sudo dnf -y install git dkms kernel-devel ``` If secure boot is active, also install `openssl`. - openSUSE: ``` shell sudo zypper install -t pattern devel_kernel dkms ``` - Alpine: ``` shell sudo apk add linux-lts-dev make gcc ``` - Void Linux: ``` shell sudo xbps-install linux-headers dkms git make ``` - Arch and Manjaro (if using Manjaro for , see note) - If using RasPi4B/5B: ``` shell sudo pacman -S --noconfirm linux-rpi4-headers dkms git bc ``` - For all other hardware: ``` shell sudo pacman -S --noconfirm linux-headers dkms git bc iw ```

  5. Clone this repository.

    git clone https://github.com/morrownr/8812au-20210820.git

  6. Move to the newly created driver directory.

    cd 8812au-20210820

  7. Run the installation script.

    ./install-driver.sh

[!WARNING] The compilation may fail if the major version of gcc that is in use is not the same as the major version of gcc that was used to compile the kernel that is in use.

Example of bad situation:

gcc 12.1 (used to compile the kernel)
gcc 10.3 (version of gcc in use)

Example of good situation:

gcc 12.2 (used to compile the kernel)
gcc 12.1 (version of gcc in use)

To determine the values:

cat /proc/version
gcc --version

If you find your system in a bad situation, it is recommended that you install a version of gcc that matches the major version of gcc that was used to compile your kernel. Here is an example for Ubuntu:

sudo apt install gcc-12

If your system is a low memory system, it is recommended that you terminate running apps so as to provide the maximum amount of RAM to the compilation process.

For automated builds (non-interactive), use NoPrompt as an option.

sudo ./install-driver.sh

or

sudo sh install-driver.sh

Note: If you elect to skip the reboot at the end of the installation script, the driver may not load immediately and the driver options will not be applied. Rebooting is strongly recommended.

Note: Fedora users that have secure boot turned on may need to run the following to enroll the key:

sudo mokutil --import /var/lib/dkms/mok.pub

Manual Installation Instructions

The installation script, install-driver.sh, automates the installation process. If you want to or need to do a basic command line installation, though, this section lists the relevant steps.

[!NOTE] If you use the Manual Installation Instructions, you will need to repeat the installation process each time a new kernel is installed in your distro.

  1. make clean
  2. make -j$(nproc)
  3. If secure boot is off:
    1. sudo make install
    2. sudo reboot

  4. If secure boot is on:

    Please read to the end of this section before coming back here to enter commands.

    1. sudo make sign-install

      You will be promted for a password, please remember the password as it will be used in some of the following steps.

    2. sudo reboot

    3. The MOK managerment screen will appear during boot with a message similar to the following:

      Shim UEFI Key Management Press any key...

    4. Select "Enroll key".

    5. Select "Continue".

    6. Select "Yes"

    7. When promted, enter the password you entered earlier.

      If you enter the wrong password, your computer will not be bootable. In this case:

      1. Use the BOOT menu from your BIOS to boot.
      2. sudo mokutil --reset
      3. Restart your computer.
      4. Use the BOOT menu from BIOS to boot.
      5. In the MOK managerment screen, select reset MOK list.
      6. Reboot.
      7. Rerun from the step sudo make sign-install.

Manual Removal Instructions

To remove the driver if installed by the Manual Installation Instructions, run the following commands from your cloned copy of this repository.

  1. sudo make uninstall
  2. sudo reboot

If you use the manual installation instructions, or if dkms is not installed, you will need to repeat the process each time a new kernel is installed in your distro.

Driver Options (edit-options.sh)

[!TIP] In Linux, driver options are also called "module parameters".

A file called 8812au.conf will be installed in /etc/modprobe.d by default if you use the installation script, install-driver.sh. If you are following the Manual Installation Instructions, you can use the edit-options.sh script to install and/or edit the file.

The installation script, install-driver.sh, will prompt you to edit the options.

8812au.conf will be read and applied to the driver on each system boot.

To edit the driver options file, run the edit-options.sh script:

sudo ./edit-options.sh

Documentation for Driver Options is included in the file 8812au.conf.

Upgrading the Driver

[!TIP] Linux development is continuous, therefore work on this driver is continuous.

Upgrading the driver is advised in the following situations:

To upgrade, perform the following steps:

  1. Open a terminal (e.g. Ctrl+Alt+T).
  2. Move to the driver directory, e.g. cd ~/src/8812au-20210629.
  3. Pull updated code from this repo: git pull

  4. Reinstall the driver: sudo ./install-driver.sh

    The install-driver.sh script will automatically remove the previously installed driver.

Removal of the Driver (remove-driver.sh)

Removing the driver is advised in the following situations:

The following removes everything that has been installed, with the exception of the build dependency packages and the driver directory. The driver directory can be deleted after running this script.

  1. Open a terminal (e.g. Ctrl+Alt+T).
  2. Move to the driver directory, e.g. cd ~/src/8812au-20210629.

  3. Run the removal script: sudo ./remove-driver.sh

    For automated builds (non-interactive), use NoPrompt as an option.

Recommended WiFi Router/ Access Point Settings

[!NOTE] These recommendations apply when using your adapter in managed (client) mode, not AP mode.

These are general recommendations, some of which may not apply to your specific situation.

After making and saving changes, reboot the router.

Recommendations regarding USB

To Contribute:

Go to Main Menu