Received-SPF: pass (google.com: best guess record for domain of linux-wireless-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Authenticated-By: 
From:   <yhchuang@realtek.com>
To:     <jwboyer@kernel.org>
CC:     <linux-firmware@kernel.org>, <linux-wireless@vger.kernel.org>,
        <Larry.Finger@lwfinger.net>, <briannorris@chromium.org>,
        <arend.vanspriel@broadcom.com>
Subject: [PATCH v3 3/3] rtw88: add a README file
Date:   Thu, 8 Aug 2019 16:22:29 +0800
Message-ID: <1565252549-25524-4-git-send-email-yhchuang@realtek.com>
In-Reply-To: <1565252549-25524-1-git-send-email-yhchuang@realtek.com>
References: <1565252549-25524-1-git-send-email-yhchuang@realtek.com>
MIME-Version: 1.0
Content-Type: text/plain
Sender: linux-wireless-owner@vger.kernel.org
Precedence: bulk

From: Yan-Hsuan Chuang <yhchuang@realtek.com>

Add a README to describe the firmware usage, and support status

Signed-off-by: Yan-Hsuan Chuang <yhchuang@realtek.com>
---
 rtw88/README | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 rtw88/README

diff --git a/rtw88/README b/rtw88/README
new file mode 100644
index 0000000..7ee24b3
--- /dev/null
+++ b/rtw88/README
@@ -0,0 +1,28 @@
+
+ rtw88 firmware
+================
+
+This repository contains firmware images supported by Realtek's wireless
+driver rtw88. And some of the devices run with more than one firmware
+file. Basically, a "normal" firmware is necessary to be downloaded to
+the device.
+And another is called "wowlan" firmware, it should be loaded when a
+device is going to suspend. Which means driver will "re-download/swap"
+the firmware image. The wowlan firmware contains wake up functions that
+can recognize specific events and send a wake up signal to device if
+needed, and the system will resume to running state. During resume,
+driver will then swap the normal firmware back, return to running state.
+
+If any distros or platforms do not require wowlan feature, they can
+_only_ pick the normal firmware. And everything still works fine,
+except that the device cannot be waken from the wireless NICs.
+
+Currently supported devices with corresponding firmwares:
+
+RTL8822BE
+    rtw8822b_fw.bin
+
+RTL8822CE
+    rtw8822c_fw.bin
+    rtw8822c_wow_fw.bin
+
-- 
2.7.4