xpadneo, docs: Fix various spelling mistakes and phrasing

Signed-off-by: Kai Krakow <[email protected]>

docs/3P-BUGS.md

@@ -5,8 +5,8 @@ some of which are fixed now - others are not:
 
 * Broken Battery Indicator in KDE
   fixed! https://www.kde.org/announcements/kde-frameworks-5.45.0.php
-* Cambridge Silicon Radio (CSR) chipsets do have problems while reconnecting (OUI 00:1A:7D)
+* Cambridge Silicon Radio (CSR) chip sets do have problems while reconnecting (OUI 00:1A:7D)
   * Most of these problems may be fixed in kernel 5.10
-* Qualcomm chipsets may have performance and lag problems (OUI 9C:B6:D0)
+* Qualcomm chip sets may have performance and lag problems (OUI 9C:B6:D0)
 * Some Bluetooth dongles may need additional firmware for proper operation
   * Possible solution: try installing `linux-firmware` from your distribution

docs/BT_DONGLES.md

@@ -26,42 +26,42 @@ If `btmgmt` command is not available, try `bluetoothctl mgmt.info` instead.
 ### Cambridge Silicon Radio
 
 * [Panda Bluetooth 4.0 USB Nano Adapter](https://www.amazon.com/gp/product/B00BCU4TZE/)
-  * Chipset: CSR ???
+  * Chip set: CSR ???
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Re-Connection Problems
     * Reliable once connected
   * Reported by @ugly95 [here](https://github.com/atar-axis/xpadneo/issues/76#issuecomment-462532230)
 * [MIATONE Bluetooth Adapter Bluetooth CSR 4.0](https://www.amazon.com/gp/product/B00M1ATR4C/)
-  * Chipset: CSR 8510
+  * Chip set: CSR 8510
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Re-Connection Problems
     * Reliable once connected
   * Reported by @ugly95 [here](https://github.com/atar-axis/xpadneo/issues/76#issuecomment-462532230)
 * [CSL - Bluetooth 4.0 USB Adapter](https://www.amazon.de/dp/B01N0368AY)
-  * Chipset: CSR 8510 A10
+  * Chip set: CSR 8510 A10
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Re-Connection Problems
     * Initial Connection Problems
   * Reported by @germangoergs [here](https://github.com/atar-axis/xpadneo/issues/91) and [here](https://github.com/atar-axis/xpadneo/issues/93#issuecomment-480997846)
 * [Sabrent USB Bluetooth 4.0 Micro Adapter for PC](https://www.amazon.com/gp/product/B06XHY5VXF/)
-  * Chipset CSR ???
+  * Chip set CSR ???
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Re-Connection Problems
     * Reliable once connected
   * Reported by @ugly95 [here](https://github.com/atar-axis/xpadneo/issues/93#issuecomment-481065171)
 * [Yizhet USB nano Bluetooth 4.0 Adapter](https://www.amazon.de/gp/product/B01LR8CNXU/)
-  * Chipset CSR 8510 A10
+  * Chip set CSR 8510 A10
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Re-Connection Problems
     * Reliable once connected
   * Reported by @NoXPhasma [here](https://github.com/atar-axis/xpadneo/issues/91#issuecomment-484815264)
 * [TP-Link USB Bluetooth Adapter Bluetooth 4.0 (UB400)](https://www.amazon.com/gp/product/B07V1SZCY6)
-  * Chipset: CSR ???
+  * Chip set: CSR ???
   * `ID 0a12:0001 Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)`
   * Performance:
     * Connection is flawless
@@ -70,20 +70,20 @@ If `btmgmt` command is not available, try `bluetoothctl mgmt.info` instead.
 
 ### Broadcom
 
-* [Plugable USB Bluetooth 4.0 Low Energy Micro Adapter](https://www.amazon.com/Plugable-Bluetooth-Adapter-Raspberry-Compatible/dp/B009ZIILLI/)
-  * Chipset: BCM20702A0
+* [Pluggable USB Bluetooth 4.0 Low Energy Micro Adapter](https://www.amazon.com/Plugable-Bluetooth-Adapter-Raspberry-Compatible/dp/B009ZIILLI/)
+  * Chip set: BCM20702A0
   * `ID 0a5c:21e8 Broadcom Corp. BCM20702A0 Bluetooth 4.0`
   * Performance:
     * Connection flawless
-    * Sometimes laggy while Gameplay
+    * Sometimes laggy in games
   * Reported by @ugly95 [here](https://github.com/atar-axis/xpadneo/issues/93#issuecomment-481065171) and [here](https://github.com/atar-axis/xpadneo/issues/76#issuecomment-464397584)
 * [Targus BT 4.0 USB adapter](https://www.targus.com/au/acb75au)
-  * Chipset: BCM20702A0
+  * Chip set: BCM20702A0
   * `ID 0a5c:21e8 Broadcom Corp. BCM20702A0 Bluetooth 4.0`
   * Performance:
     * Connection flawless
-    * Sometimes laggy while Gameplay
-  * Reported by Zowayix [here](https://github.com/atar-axis/xpadneo/issues/93#issuecomment-487280791)
+    * Sometimes laggy in games
+  * Reported by @Zowayix [here](https://github.com/atar-axis/xpadneo/issues/93#issuecomment-487280791)
 
 
 ### Qualcomm
@@ -96,35 +96,35 @@ If `btmgmt` command is not available, try `bluetoothctl mgmt.info` instead.
 
 * Status: incompatible (https://github.com/atar-axis/xpadneo/issues/270)
   * OUI: DC:1B:A1 (Intel)
-  * Used as on-board chipset: Gigabyte B450 Aorus Pro WiFi 1.0 with integrated Bluetooth
+  * Used as on-board chip set: Gigabyte B450 AORUS Pro WiFi 1.0 with integrated Bluetooth
 * Status: bluetoothd logs "Request attribute has encountered an unlikely error"
-  * Chipset: AX200
-  * Used as on-board chipset: ASUS B550-i
+  * Chip set: AX200
+  * Used as on-board chip set: ASUS B550-i
 
 
 ### Realtek
 
-Known bad firmware for RTL8761BU chipset is 0xdfc6d922. It causes frequent
+Known bad firmware for RTL8761BU chip set is 0xdfc6d922. It causes frequent
 reconnects. Firmware version can be found in the kernel log:
 ```
 $ sudo dmesg | grep 'RTL: fw version'
 [   21.193448] Bluetooth: hci0: RTL: fw version 0xdfc6d922
 ```
 
 * [TP-Link USB Bluetooth Adapter Bluetooth 5.0 (UB500)](https://www.amazon.com/gp/product/B09DMP6T22)
-  * Chipset: RTL8761BU
+  * Chip set: RTL8761BU
   * `ID 2357:0604 TP-Link TP-Link UB500 Adapter`
   * Performance:
     * Disconnects after some random interval and reconnects
     * When it's connected, it's good
   * Reported by @Arian8j2 [here](https://github.com/atar-axis/xpadneo/issues/389#issuecomment-1677012088)
 * [Simplecom NB409 Bluetooth 5.0 USB Wireless Dongle with A2DP EDR](https://www.mwave.com.au/product/simplecom-nb409-bluetooth-50-usb-wireless-dongle-with-a2dp-edr-ac38550)
-  * Chipset: RTL8761BU
+  * Chip set: RTL8761BU
   * `ID 0bda:8771 Realtek Semiconductor Corp. Bluetooth Radio`
   * Status: it works straight out of the box for a user on Manjaro KDE with kernel 5.15 and 6.1
   * Reported by @mscharley [here](https://github.com/atar-axis/xpadneo/issues/406)
 * [UGREEN Bluetooth 5.0 USB Adapter (CM390)](https://www.amazon.com/gp/product/B08R8992YC/)
-  * Chipset: RTL8761BU
+  * Chip set: RTL8761BU
   * `ID 0bda:8771 Realtek Semiconductor Corp. Bluetooth Radio`
   * Performance:
     * Connection flawless if good firmware is being used

docs/CONFIGURATION.md

@@ -27,7 +27,7 @@ files in `/sys/module/hid_xpadneo/parameters`:
   * Specify your controller MAC address in the format `11:22:33:44:55:66`
   * Specify the flags as sum of the following:
     * `1` if your controller does not support pulse parameters (i.e., 8BitDo controllers)
-    * `2` if your controller does not support trigger rumble (most clones in compat-mode)
+    * `2` if your controller does not support trigger rumble (most clones in compatibility mode)
     * `4` if your controller does not support individual motor programming (i.e., 8BitDo controllers)
     * `8` if your controller supports hardware profiles (auto-detected, do not set manually)
     * `16` if your controller boots in Linux mode (auto-detected, do not change manually)

docs/DEBUGGING.md

@@ -9,7 +9,7 @@ Otherwise, the driver reports most incidents, quirks, and fixes to `dmesg`.
 
 ### Environment
 
-Useful information can now be aquired with the commands:
+Useful information can now be acquired with the commands:
 
   * `dmesg`: I advise you to run `dmesg -wdH` in a terminal while you connect your controller from a second terminal
     to get hardware information in realtime.

docs/PACKAGING.md

@@ -1,7 +1,7 @@
 ## Packaging
 
 From v0.10 on, xpadneo provides a `Makefile` to help package maintainers
-avoding a lot of the duplicate work which was historically done by the
+avoiding a lot of the duplicate work which was historically done by the
 installer script. This also allows for prefixed installation to prepare an
 install image before merging the package to the live system.
 
@@ -61,7 +61,7 @@ make ETC_PREFIX=/usr/lib install
 
 # This can be combined with prefixed installation
 make PREFIX=/tmp/xpadneo-image ETC_PREFIX=/usr/lib install
-dmks add hid-xpadneo
+dkms add hid-xpadneo
 ```
 
 In all these usages, xpadneo will never try to build and install the kernel
@@ -109,7 +109,7 @@ package installation. It is a development tool.
 
 ### Summary
 
-Package maintainers are adviced to migration to the new installation method.
+Package maintainers are advised to migrate to the new installation method.
 Please provide feedback if you see problems or missing features.
 
 Package maintainers **SHOULD NOT** use `install.sh` or its sibling scripts

docs/README.md

@@ -269,7 +269,7 @@ Kernel maintainers should also include the `uhid` module (`CONFIG_UHID`) because
 models with firmware 5.x or higher) cannot create the HID input device which is handled in user-space by the bluez
 daemon.
 
-* On **Arch** and Arch-based distros (like **EndeavourOS**), try
+* On **Arch** and Arch-based distributions (like **EndeavourOS**), try
   `sudo pacman -S dkms linux-headers bluez bluez-utils`
 * On **Debian** based systems (like Ubuntu) you can install those packages by running
   ``sudo apt-get install dkms linux-headers-`uname -r` ``
@@ -280,7 +280,7 @@ daemon.
 * On **openSUSE** (tested on Tumbleweed, should work for Leap), it is
   `sudo zypper install dkms make bluez kernel-devel kernel-source`
 * On **OSMC** you will have to run the following commands
-  ``sudo apt-get install dkms rbp2-headers-`uname -r` ``
+  ``sudo apt-get install dkms rbp2-headers-`uname -r`\``
   ``sudo ln -s "/usr/src/rbp2-headers-`uname -r`" "/lib/modules/`uname -r`/build"`` (as a [workaround](https://github.com/osmc/osmc/issues/471))
 * On **Raspbian**, it is
   `sudo apt-get install dkms raspberrypi-kernel-headers`

docs/SDL.md

@@ -2,9 +2,9 @@
 
 We fixed the following problem by pretending we are in Windows wireless mode
 by faking the *input device PID* to `0x02E0`. The original PID `0x02FD`
-triggeres several unwanted fixups at multiple layers, i.e. SDL or the HTML5
+triggers several unwanted fixups at multiple layers, i.e. SDL or the HTML5
 game controller API. The following paragraphs document the originally
-wrong behaviour observed and we clearly don't want our fixed mappings to be
+wrong behavior observed and we clearly don't want our fixed mappings to be
 "fixed" again by layers detected a seemingly wrong button mapping:
 
 Since after libSDL2 2.0.8, SDL contains a fix for the wrong mapping introduced
@@ -46,7 +46,7 @@ You can find the values by looking at dmesg when `xpadneo` detects
 your device. In dmesg, find the device path, then change to the
 device path below `/sys` and look for the files in the `id` directory.
 
-The name value after the id is purely cosmetical, you can name it
+The name value after the id is purely cosmetically, you can name it
 whatever you like. It may show up in games as a visual identifier.
 
 If running Wine games, to properly support xpadneo, ensure you have

docs/TROUBLESHOOTING.md

@@ -38,12 +38,12 @@ References:
 * https://wiki.archlinux.org/title/Bluetooth_mouse#Mouse_lag
 
 
-#### Incompatible Bluetooth Chipset
+#### Incompatible Bluetooth Chip Set
 
-Some chipsets, e.g. the CSR 85xx or Intel AX200 (and variants like 3xxx), do have problems when you try to reconnect
+Some chip sets, e.g. the CSR 85xx or Intel AX200 (and variants like 3xxx), do have problems when you try to reconnect
 the gamepad.
 
-Some chipsets may need additional driver firmware to work correctly. Try installing
+Some chip sets may need additional driver firmware to work correctly. Try installing
 `linux-firmware` from your distribution.
 
 See below, if this happens since a firmware upgrade of the controller.
@@ -62,7 +62,7 @@ Reference:
 #### Gamepad Asks for a PIN During Pairing
 
 A user found that with genuine Xbox controllers, the fix is often to use an external USB dongle instead of the internal
-chipset for pairing the controller (recommended to try first).
+chip set for pairing the controller (recommended to try first).
 
 If it still asks for a PIN, try `0000` to connect the controller. It should happen just once.
 
@@ -88,7 +88,7 @@ Reference:
 
 ### Gamepad Is Connected but Did not Rumble
 
-If the gamepad does connect but it doesn't rumble, then mosty probably the wrong driver is loaded,
+If the gamepad does connect but it doesn't rumble, then most probably the wrong driver is loaded,
 or the gamepad is quirky and doesn't fully support the protocol. Your kernel may also be missing the `uhid` module
 which is needed by all Bluetooth LE devices for input capabilities because the bluez daemon will handle HID data in
 user-space. Most distributions include  `uhid` but if in doubt, ask your distribution kernel maintainers.
@@ -102,7 +102,7 @@ gamepad.
 
 ### Gamepad Has Quirks (i.e., wrong rumble behavior)
 
-You may want to try serveral combinations of quirk flags added to the module paramters.
+You may want to try several combinations of quirk flags added to the module parameters.
 See [Configuration](https://atar-axis.github.io/xpadneo/#configuration) and `modinfo hid-xpadneo`
 for more information. You may also want to use the hidraw testing utility which bypasses the
 driver and let's you try different combination of parameters. The utility is located at
@@ -112,7 +112,7 @@ driver and let's you try different combination of parameters. The utility is loc
 ### Gamepad Does not Connect at All, Runs A Reconnect Loop, or Immediately Disconnects
 
 Check whether ERTM was disabled (see above). Also, some newer models use a different Bluetooth protocol "Bluetooth
-low energe" (BLE) which you may accidentally have disabled. Check the following settings in `/etc/bluetooth/main.conf`:
+low energy" (BLE) which you may accidentally have disabled. Check the following settings in `/etc/bluetooth/main.conf`:
 ```
 [General]
 ControllerMode = dual
@@ -130,7 +130,7 @@ not pairing with Bluez. There are some specific workarounds:
   update the firmware of the controller. When it's done, your controller should work just fine with any Linux system.
   - If you paired your controller to your linux computer before updating the firmware, and the controller is still not connecting properly after the firmware update, try removing the bluetooth device and re-pairing through the usual process. 
 - If it didn't work, you can try these two workarounds:
-    - Use a Windows 10 computer *on the same Bluetooth adapter* to pair with the controller. It must absolutly be on
+    - Use a Windows 10 computer *on the same Bluetooth adapter* to pair with the controller. It must absolutely be on
       the same Bluetooth adapter, i.e. the same computer (can be inside a virtual machine with Bluetooth passthrough)
       if it's an internal Bluetooth adapter, or the same Bluetooth dongle. Then, you can get the pairing keys and
       install them within your Linux Bluetooth system.

docs/descriptors/xbe2_unknown.md

@@ -98,8 +98,8 @@ BB: on/off for ABXY, LB, RB
 If Profile != 00, then ONLY THE FIRST ROW's (!!!) BB are on/off values for the paddles:
 0b0002 4013 // 1 = P1, etc.
 
-ST: on/off for Start and Sticks (thumbstick buttons)
-0b0000 SRL0 // S = Start, R/L = Right/Left thumbstick button
+ST: on/off for Start and Sticks (thumb stick buttons)
+0b0000 SRL0 // S = Start, R/L = Right/Left thumb stick button
 
 SE: on/off for Select
 0b0000 000S // S = Select

hid-xpadneo/Makefile

@@ -8,7 +8,7 @@ all: modules
 ../VERSION:
 	$(MAKE) -C .. $(@:../%=%)
 
-# convenience rules for local dvelopment
+# convenience rules for local development
 
 clean modules modules_install: ../VERSION
 	$(MAKE) -C $(KERNEL_SOURCE_DIR) INSTALL_MOD_DIR="kernel/drivers/hid" LD=$(LD) M=$(shell pwd)/src VERSION="$(shell cat ../VERSION)" $@