staging: rtl8192e: Describe each kernel config option
authorAlman Khan <ak47.almank@gmail.com>
Fri, 26 Aug 2022 11:35:36 +0000 (12:35 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 30 Aug 2022 15:17:03 +0000 (17:17 +0200)
An important thing people want to know is what each option that
they select in their kernel configuration file actually does, so
that they can select the right options for their system, and, once
booted, make sure their hardware works as expected.

Add more details describing each option in the kernel configuration
for the rtl8192e (rtllib) driver so that the end-user understands what
they mean, and, if necessary, enables/disables those features
if they are not required.

Signed-off-by: Alman Khan <ak47.almank@gmail.com>
Link: https://lore.kernel.org/r/d053abd3e60d3f2d7724d6857c28a6a255b4f46b.camel@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/rtl8192e/Kconfig

index 39f5a6a..e06c189 100644 (file)
@@ -10,6 +10,9 @@ config RTLLIB
 
          If unsure, say N.
 
+         This driver adds support for rtllib wireless cards.
+         Only the rtl8192e is supported as of now.
+
 if RTLLIB
 
 config RTLLIB_CRYPTO_CCMP
@@ -23,6 +26,8 @@ config RTLLIB_CRYPTO_CCMP
          CCMP crypto driver for rtllib.
 
          If you enabled RTLLIB, you want this.
+         Adds support for the CCM mode Protocol crypto driver for
+         use in wireless cards (including rtllib cards).
 
 config RTLLIB_CRYPTO_TKIP
        tristate "Support for rtllib TKIP crypto"
@@ -35,6 +40,8 @@ config RTLLIB_CRYPTO_TKIP
          TKIP crypto driver for rtllib.
 
          If you enabled RTLLIB, you want this.
+         Adds support for the Temporal Key Integrity Protocol for
+         the IEEE 802.11i standard for use on wireless cards.
 
 config RTLLIB_CRYPTO_WEP
        tristate "Support for rtllib WEP crypto"
@@ -42,9 +49,12 @@ config RTLLIB_CRYPTO_WEP
        depends on RTLLIB
        default y
        help
-         TKIP crypto driver for rtllib.
+         WEP crypto driver for rtllib.
 
          If you enabled RTLLIB, you want this.
+         Adds support for the (now weak) Wired Equivalent Privacy
+         (WEP) crypto protocol for wireless cards.
+         NOTE: This protocol is now considered insecure.
 
 source "drivers/staging/rtl8192e/rtl8192e/Kconfig"