rtl8xxxu: Document REG_RXFLTMAP registers

Add comments describing how REG_RXFLTMAP0, REG_RXFLTMAP1 and REG_RXFLTMAP2
work.

Signed-off-by: Bruno Randolf <br1@einfach.org>
Signed-off-by: Jes Sorensen <Jes.Sorensen@redhat.com>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>

diff --git a/drivers/net/wireless/realtek/rtl8xxxu/rtl8xxxu_regs.h b/drivers/net/wireless/realtek/rtl8xxxu/rtl8xxxu_regs.h
index d2995f8a331191b62b83844a8c52ac9464da6788..d089eddc920e114096febbddc0760f2ac70e482c 100644 (file)
--- a/drivers/net/wireless/realtek/rtl8xxxu/rtl8xxxu_regs.h
+++ b/drivers/net/wireless/realtek/rtl8xxxu/rtl8xxxu_regs.h
@@ -569,9 +569,12 @@
                                                 (Rx beacon, probe rsp) */
 #define  RCR_ACCEPT_CRC32              BIT(8)  /* Accept CRC32 error packet */
 #define  RCR_ACCEPT_ICV                        BIT(9)  /* Accept ICV error packet */
-#define  RCR_ACCEPT_DATA_FRAME         BIT(11)
-#define  RCR_ACCEPT_CTRL_FRAME         BIT(12)
-#define  RCR_ACCEPT_MGMT_FRAME         BIT(13)
+#define  RCR_ACCEPT_DATA_FRAME         BIT(11) /* Accept all data pkt or use
+                                                  REG_RXFLTMAP2 */
+#define  RCR_ACCEPT_CTRL_FRAME         BIT(12) /* Accept all control pkt or use
+                                                  REG_RXFLTMAP1 */
+#define  RCR_ACCEPT_MGMT_FRAME         BIT(13) /* Accept all mgmt pkt or use
+                                                  REG_RXFLTMAP0 */
 #define  RCR_HTC_LOC_CTRL              BIT(14) /* MFC<--HTC=1 MFC-->HTC=0 */
 #define  RCR_UC_DATA_PKT_INT_ENABLE    BIT(16) /* Enable unicast data packet
                                                   interrupt */
@@ -651,9 +654,20 @@
 #define REG_LPNAV_CTRL                 0x0694
 #define REG_WKFMCAM_CMD                        0x0698
 #define REG_WKFMCAM_RWD                        0x069c
-#define REG_RXFLTMAP0                  0x06a0
-#define REG_RXFLTMAP1                  0x06a2
-#define REG_RXFLTMAP2                  0x06a4
+
+/*
+ * RX Filters: each bit corresponds to the numerical value of the subtype.
+ * If it is set the subtype frame type is passed. The filter is only used when
+ * the RCR_ACCEPT_DATA_FRAME, RCR_ACCEPT_CTRL_FRAME, RCR_ACCEPT_MGMT_FRAME bit
+ * in the RCR are low.
+ *
+ * Example: Beacon subtype is binary 1000 which is decimal 8 so we have to set
+ * bit 8 (0x100) in REG_RXFLTMAP0 to enable reception.
+ */
+#define REG_RXFLTMAP0                  0x06a0  /* Management frames */
+#define REG_RXFLTMAP1                  0x06a2  /* Control frames */
+#define REG_RXFLTMAP2                  0x06a4  /* Data frames */
+
 #define REG_BCN_PSR_RPT                        0x06a8
 #define REG_CALB32K_CTRL               0x06ac
 #define REG_PKT_MON_CTRL               0x06b4