staging: brcm80211: revised README
authorRoland Vossen <rvossen@broadcom.com>
Fri, 18 Mar 2011 10:09:34 +0000 (11:09 +0100)
committerGreg Kroah-Hartman <gregkh@suse.de>
Tue, 5 Apr 2011 05:26:18 +0000 (22:26 -0700)
Removed duplicated text sections in README. Removed Bugs/problems that no longer
occur. One brcmsmac instability remains, (to be solved with new ucode), that has
been moved to the TODO file.

Signed-off-by: Roland Vossen <rvossen@broadcom.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
drivers/staging/brcm80211/README

index 6356f80..8ad5586 100644 (file)
@@ -1,64 +1,58 @@
-Broadcom Mac80211 driver
+Broadcom brcmsmac (mac80211-based softmac PCIe) and brcmfmac (SDIO) drivers.
 
-Firmware installation
-======================
-Firmware is available from the Linux firmware repository at:
+Completely open source host drivers, no binary object files.
 
-       git://git.kernel.org/pub/scm/linux/kernel/git/dwmw2/linux-firmware.git
-       http://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
-       https://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
+Support for the following chips:
+===============================
 
-For all chips, copy brcm/bcm43xx-0.fw and brcm/bcm43xx_hdr-0.fw to
-/lib/firmware/brcm (or wherever firmware is normally installed on your system).
+    brcmsmac (PCIe)
+    Name        Device ID
+    BCM4313     0x4727
+    BCM43224    0x4353
+    BCM43225    0x4357
 
-Currently supported chips
-==============
-PCI
-Name           Device ID
-BCM4313                0x4727
-BCM43224       0x4353
-BCM43225       0x4357
+    brcmfmac (SDIO)
+    Name
+    BCM4329
 
+Both brcmsmac and brcmfmac drivers require firmware files that need to be
+separately downloaded.
 
-Bugs/Problems
-==============
-- Driver can get confused while scanning during high throughput, can cause
-  burping, hanging, and possible crashing.
-- Occasional hangs & burps with BCM43224 on 2.4 GHz with dual stream rates.
-- Occasional crashes with BCM43224 on multicore machines.
-
+Firmware
+======================
+Firmware is available from the Linux firmware repository at:
 
-Broadcom fullmac driver
+    git://git.kernel.org/pub/scm/linux/kernel/git/dwmw2/linux-firmware.git
+    http://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
+    https://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
 
-This is production driver.
 
-What's here
-===========
-- Completely open source host driver, no binary object files
-- Features Broadcom's OneDriver architecture (single source base for
-  supported chips and architectures)
-- On-chip firmware loaded using standard request_firmware()
-- Support for BCM4329(SDIO)
+===============================================================
+Broadcom brcmsmac driver
+===============================================================
+- Support for both 32 and 64 bit Linux kernels
 
-What's done
-==========
-- Integration with cfg80211 stack
-- Most of Mac functionality is performed in dongle
-- A-MPDU single stream rates
-- BCM4329:     Dualband, Single stream, 20MHz channels
 
 Firmware installation
 ======================
-Firmware is available from the Linux firmware repository at:
+Copy brcm/bcm43xx-0.fw and brcm/bcm43xx_hdr-0.fw to
+/lib/firmware/brcm (or wherever firmware is normally installed
+on your system).
+
+
+===============================================================
+Broadcom brcmfmac driver
+===============================================================
+- Support for 32 bit Linux kernel, 64 bit untested
 
-       git://git.kernel.org/pub/scm/linux/kernel/git/dwmw2/linux-firmware.git
-       http://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
-       https://git.kernel.org/?p=linux/kernel/git/dwmw2/linux-firmware.git
 
-For 4329 chip, copy brcm/bcm4329-fullmac-4.bin and brcm/bcm4329-fullmac-4.txt
+Firmware installation
+======================
+Copy brcm/bcm4329-fullmac-4.bin and brcm/bcm4329-fullmac-4.txt
 to /lib/firmware/brcm (or wherever firmware is normally installed on your
 system).
 
+
 Contact Info:
 =============
 Brett Rudley           brudley@broadcom.com
@@ -67,4 +61,4 @@ Dowan Kim             dowan@broadcom.com
 Roland Vossen          rvossen@broadcom.com
 Arend van Spriel       arend@broadcom.com
 
-For more info, refer to: http://linuxwireless.org/en/users/Drivers/brcm80211
\ No newline at end of file
+For more info, refer to: http://linuxwireless.org/en/users/Drivers/brcm80211