From de36dfeff890086a9f30cd0052715fbaa9554087 Mon Sep 17 00:00:00 2001 From: morrownr Date: Sun, 24 Sep 2023 14:59:23 -0500 Subject: [PATCH] update docs --- FAQ.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++---- Makefile | 16 ++----------- README.md | 50 +++++++++++++++++++++++++-------------- 3 files changed, 101 insertions(+), 36 deletions(-) diff --git a/FAQ.md b/FAQ.md index dd91225..599675b 100644 --- a/FAQ.md +++ b/FAQ.md @@ -8,7 +8,7 @@ driver is installed but does not seem to be working. What is wrong? Answer: This question often comes up after installing the driver to a system that has Secure Boot on. To test if there is a Secure Boot related problem, turn secure boot off in the system BIOS and reboot. If the driver -works as expected after reboot, them the problem is likely related to +works as expected after reboot, then the problem is likely related to Secure Boot. What will increase my chances of having a sucessessful installation on a @@ -20,7 +20,7 @@ the easiest solution is likely to do a clean reinstallation with Secure Boot on. Ubuntu is used as the example but other distros should be similar to one -degree or another. During the installation there will be a box on one of +degree or another. During the installation there may be a box on one of installation pages that will appear if the installation program detects that Secure Boot is on. You will need to check the appropriate box and supply a password. You can use the same password that you use for the system @@ -41,8 +41,43 @@ Here is a link regarding Debian and Secure Boot: https://wiki.debian.org/SecureBoot -There is work underway to add Secure Boot support for systems that do not -have `dkms` available or if a manual installation is desired. +If you are using a basic command line (non-dkms) installation, see the +following section in the Installation Steps part of the README: + +If you use the `install-driver.sh` script and see the following message + +`SecureBoot enabled - read FAQ about SecureBoot` + +You need to read the following: + +The MOK managerment screen will appear during boot: + +`Shim UEFI Key Management" + +`Press any key...` + +Select "Enroll key" + +Select "Continue" + +Select "Yes" + +When promted, enter the password you entered earlier. + +If you enter the wrong password, your computer will not be bootable. In +this case, use the BOOT menu from your BIOS to boot then as follows: + +``` +sudo mokutil --reset +``` + +Restart your computer and use the BOOT menu from BIOS to boot. In the MOK +managerment screen, select `reset MOK list`. Then Reboot and retry the +driver installation. + +Manual Installation Instructions + +It provides secure boot instructions. ----- @@ -158,6 +193,34 @@ dtoverlay=disable-wifi ----- +Question: When running `sudo sh install-driver.sh` on my RasPi 4B or +400, I see the following: + +``` +Your kernel header files aren't properly installed. +Please consult your distro documentation or user support forums. +Once the header files are properly installed, please run... +``` + +Answer: The Pi 4/400 firmware now prefers the 64-bit kernel if one +exists so even if you installed the 32 bit version of the RasPiOS, +you may now have the 64 bit kernel active. + +The fix: + +add the following to /boot/config.txt and reboot: + +arm_64bit=0 + +Reference: + +https://forums.raspberrypi.com/viewtopic.php?p=2091532&hilit=Tp+link#p2091532 + +Note to RasPiOS devs: We really really wish you would consider the +consequences of the changes you make. Thank you. + +----- + Question: I have an adapter with the 8821cu chipset and it supports bluetooth. The bluetooth works but the wifi does not. What is wrong? diff --git a/Makefile b/Makefile index 34ddda0..9364b54 100644 --- a/Makefile +++ b/Makefile @@ -1352,20 +1352,8 @@ ifeq ($(CONFIG_PLATFORM_AUTODETECT), y) EXTRA_CFLAGS += -DCONFIG_LITTLE_ENDIAN EXTRA_CFLAGS += -DCONFIG_IOCTL_CFG80211 -DRTW_USE_CFG80211_STA_EVENT -SUBARCH := $(shell uname -m) - -ifeq ($(SUBARCH), aarch64) -SUBARCH := arm64 -endif - -ifeq ($(SUBARCH), armv7l) -SUBARCH := arm -endif - -ifeq ($(SUBARCH), armv6l) -SUBARCH := arm -endif - +#SUBARCH := $(shell uname -m) +SUBARCH := $(shell uname -m | sed -e "s/i.86/i386/; s/ppc/powerpc/; s/armv.l/arm/; s/aarch64/arm64/; s/riscv.*/riscv/;") ARCH ?= $(SUBARCH) CROSS_COMPILE ?= diff --git a/README.md b/README.md index 8839ee1..fc9f845 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ confirm that this is the correct driver for your adapter. ### Not supported -- hcxdumptool +- hcxdumptool (see hcxdumptool documentation) ### A FAQ is available in this repo with the name `FAQ.md` @@ -54,24 +54,27 @@ confirm that this is the correct driver for your adapter. ### Compatible CPU Architectures -- x86, i686 +- x86, i386, i686 - x86-64, amd64 - armv6l, armv7l (arm) - aarch64 (arm64) +Note: Additional CPU architectures may work but I currently only have +the hardware to test the above. + ### Compatible Kernels - Kernels: 4.19 - 5.11 (Realtek) -- Kernels: 5.12 - 6.5 (community support) +- Kernels: 5.12 - 6.6 (community support) ### Tested Compilers -- gcc 10, 11 and 12 +- gcc 10, 11, 12 and 13 ### Tested Linux Distributions -Note: The information in this section depends largely on user reports which can -be provided via PR or message in Issues. +Note: The information in this section depends largely on user reports +which can be provided via PR or message in Issues. - [Arch Linux](https://www.archlinux.org) (kernels 5.4 and 5.11) @@ -81,13 +84,13 @@ be provided via PR or message in Issues. - [Fedora](https://getfedora.org) Fedora 38 (6.2.13-300) -- [Kali Linux](https://www.kali.org/) (kernel 5.10) +- [Kali Linux](https://www.kali.org/) (kernel 6.3) -- [Manjaro](https://manjaro.org) (kernel 5.13) +- [Manjaro](https://manjaro.org) (kernel 5.15) - [openSUSE](https://www.opensuse.org/) Tumbleweed (rolling) (kernel 5.15) -- [Raspberry Pi OS](https://www.raspberrypi.org) (2023-05-03) (ARM 32 bit and 64 bit) (kernel 6.1.38) +- [Raspberry Pi OS](https://www.raspberrypi.org) (2023-05-03)(ARM 32 bit and 64 bit) (kernel 6.1.38) - [Raspberry Pi Desktop](https://www.raspberrypi.org) (2022-07-01) (x86 32 bit) (kernel 5.10) @@ -97,17 +100,27 @@ be provided via PR or message in Issues. - [Void Linux](https://voidlinux.org/) (kernel 5.18) -Note: Red Hat Enterprise Linux (RHEL) and distros based on RHEL are not -supported due to the way kernel patches are handled. I will support -knowledgable RHEL developers if they want to merge the required -support and keep it current. I reserve the right to delete this support -if it causes any problems. +Note: Red Hat Enterprise Linux (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 Note: 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 + +Note: 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 - EDUP EP-AC1651 (nano) (single-state, single-function) @@ -604,11 +617,12 @@ as good as it. ----- -To-Do: +To Contribute: -- Test for installation in VM's. -- Reduce the size of the README while keeping the needed information. -- Optimize scripts. +Fork this repository. +Make your edits. +TEST THEM! +Create a pull request. -----