rtw88: add a README file

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

[Added to WHENCE by Josh Boyer <jwboyer@kernel.org>]

Signed-off-by: Yan-Hsuan Chuang <yhchuang@realtek.com>
Signed-off-by: Josh Boyer <jwboyer@kernel.org>
This commit is contained in:
Yan-Hsuan Chuang 2019-08-08 16:22:29 +08:00 committed by Josh Boyer
parent 7e431c5dee
commit 5621bfcde3
No known key found for this signature in database
GPG Key ID: A31B6BD72486CFD6
2 changed files with 29 additions and 0 deletions

1
WHENCE
View File

@ -2792,6 +2792,7 @@ Info: Sent to Larry Finger by Realtek engineer Yan-Hsuan Chuang <yhchuang@realte
File: rtw88/rtw8822b_fw.bin
File: rtw88/rtw8822c_fw.bin
File: rtw88/rtw8822c_wow_fw.bin
File: rtw88/README
Licence: Redistributable. See LICENCE.rtlwifi_firmware.txt for details.

28
rtw88/README Normal file
View File

@ -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