documentation updates

This commit is contained in:
morrownr 2021-11-03 12:29:15 -05:00
parent 1c8bdd7ef5
commit 79da24c9bd
3 changed files with 88 additions and 50 deletions

View File

@ -3,7 +3,7 @@
# Purpose: Allow easy access to specific driver options. # Purpose: Allow easy access to specific driver options.
# #
# Edit the following line to change, add or delete options: # Edit the following line to change, add or delete options:
options 88x2bu rtw_drv_log_level=0 rtw_led_ctrl=1 rtw_vht_enable=1 rtw_power_mgnt=1 rtw_beamform_cap=10 rtw_dfs_region_domain=0 rtw_switch_usb_mode=2 options 88x2bu rtw_drv_log_level=0 rtw_led_ctrl=1 rtw_vht_enable=1 rtw_power_mgnt=1 rtw_beamform_cap=0 rtw_dfs_region_domain=0 rtw_switch_usb_mode=2
# #
# After editing is complete, save this file (if using nano: Ctrl+X, Y, Enter) # After editing is complete, save this file (if using nano: Ctrl+X, Y, Enter)
# and reboot to activate the changes. # and reboot to activate the changes.
@ -62,11 +62,11 @@ options 88x2bu rtw_drv_log_level=0 rtw_led_ctrl=1 rtw_vht_enable=1 rtw_power_mgn
# #
# Beamforming options: ( rtw_beamform_cap ) # Beamforming options: ( rtw_beamform_cap )
# #
# 0 = Disable # 0 = Disable (default) (recommended for AP mode)
# 1 = SU Beamformer (recommended for AP mode) # 1 = SU Beamformer
# 2 = SU Beamformee # 2 = SU Beamformee
# 3 = SU Beamformer and SU Beamformee # 3 = SU Beamformer and SU Beamformee
# 10= SU Beamformee and MU Beamformee (default) (recommended for managed mode) # 10= SU Beamformee and MU Beamformee
# 11= SU Beamformer and SU Beamformee and MU Beamformee # 11= SU Beamformer and SU Beamformee and MU Beamformee
# #
# Note: MU Beamformer not supported. # Note: MU Beamformer not supported.
@ -91,10 +91,12 @@ options 88x2bu rtw_drv_log_level=0 rtw_led_ctrl=1 rtw_vht_enable=1 rtw_power_mgn
# USB options: ( rtw_switch_usb_mode ) # USB options: ( rtw_switch_usb_mode )
# #
# 0 = No switch # 0 = No switch
# 1 = Switch from usb 2.0 to usb 3.0 (recommended for managed mode) # 1 = Switch from usb 2.0 to usb 3.0
# 2 = Switch from usb 3.0 to usb 2.0 (default) (recommended for AP mode) # 2 = Switch from usb 3.0 to usb 2.0 (default)
# #
# Note: The 88x2bu driver needs to stay in USB2 mode for AP mode operations. # Note: This driver may need to stay in USB2 mode for AP mode operations
# on some platforms in order to avoid dropping offline. This issue has been
# observed on 32 bit Raspberry Pi OS.
# #
# #
# ----- # -----

File diff suppressed because it is too large Load Diff

View File

@ -130,43 +130,37 @@ There is no need to disable Secure Mode to install this driver. If Secure Mode i
### Installation Steps ### Installation Steps
Step 1: Open a terminal (e.g. Ctrl+Alt+T) ##### Step 1: Open a terminal (e.g. Ctrl+Alt+T)
Step 2: Update the system package information (select the option for the OS you are using) ##### Step 2: Update the system package information (select the option for the OS you are using)
Option for Debian based distributions such as Ubuntu, Linux Mint, and Raspberry Pi OS Option for Debian based distributions such as Ubuntu, Linux Mint, and Raspberry Pi OS
``` `sudo apt update`
sudo apt update
```
Option for Arch based distributions such as Manjaro Option for Arch based distributions such as Manjaro
``` `sudo pacman -Syu`
sudo pacman -Syu
```
Option for Fedora based distributions Option for Fedora based distributions
``` `sudo dnf -y update`
sudo dnf -y update
```
Note: If you do not regularly maintain your system by installing updated packages, it is a good idea to not only update system package information but also to install the updated packages followed by a system reboot. The installation can then be continued with step 3. Note: If you do not regularly maintain your system by installing updated packages, it is a good idea to not only update system package information but also to install the updated packages followed by a system reboot. The installation can then be continued with step 3.
Step 3: Install the required packages (select the option for the OS you are using) ##### Step 3: Install the required packages (select the option for the OS you are using)
Option for Raspberry Pi OS Option for Raspberry Pi OS
``` ```
sudo apt install -y raspberrypi-kernel-headers bc build-essential dkms git sudo apt install -y raspberrypi-kernel-headers bc build-essential dkms git
``` ```
Option for Debian, or Linux Mint Debian Edition (LMDE) Option for Debian and Linux Mint Debian Edition (LMDE)
``` ```
sudo apt install -y linux-headers-$(uname -r) build-essential dkms git libelf-dev sudo apt install -y linux-headers-$(uname -r) build-essential dkms git libelf-dev
``` ```
Option for Ubuntu (all flavors) or Linux Mint Option for Ubuntu (all flavors) and Linux Mint
``` ```
sudo apt install -y dkms git build-essential sudo apt install -y dkms git build-essential
``` ```
@ -176,7 +170,7 @@ Step 3: Install the required packages (select the option for the OS you are usin
sudo dnf -y install git dkms kernel-devel kernel-debug-devel sudo dnf -y install git dkms kernel-devel kernel-debug-devel
``` ```
Options for Arch or Manjaro Options for Arch and Manjaro
if using pacman if using pacman