linux-wireless.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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	[thread overview]
Message-ID: <1565252549-25524-4-git-send-email-yhchuang@realtek.com> (raw)
In-Reply-To: <1565252549-25524-1-git-send-email-yhchuang@realtek.com>

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


  parent reply	other threads:[~2019-08-08  8:22 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-08  8:22 [PATCH v3 0/3] rtw88: update 8822c firmware files yhchuang
2019-08-08  8:22 ` [PATCH v3 1/3] rtw88: RTL8822C: update rtw8822c_fw.bin to v7.3 yhchuang
2019-08-08  8:22 ` [PATCH v3 2/3] rtw88: RTL8822C: add WoW firmware v7.3 yhchuang
2019-08-08  8:22 ` yhchuang [this message]
2019-08-15 11:42 ` [PATCH v3 0/3] rtw88: update 8822c firmware files Josh Boyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1565252549-25524-4-git-send-email-yhchuang@realtek.com \
    --to=yhchuang@realtek.com \
    --cc=Larry.Finger@lwfinger.net \
    --cc=arend.vanspriel@broadcom.com \
    --cc=briannorris@chromium.org \
    --cc=jwboyer@kernel.org \
    --cc=linux-firmware@kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).