carl9170 firmware: add note about rx filter usage

This patch adds a note about what it means when
a rx filter bit is set. Because unlike what most
people assume, it means that the data which matches
the condition is discarded and not
"passed to the host".

Reported-by: Javier Lopez <jlopex@cozybit.com>
Signed-off-by: Christian Lamparter <chunkeey@googlemail.com>

diff --git a/include/shared/fwcmd.h b/include/shared/fwcmd.h
index 9443c802b25b8578f6afd2b2cb66243ab47f34f1..9111d4ffc1b3851309af860a7b2e3e8175a2fb3e 100644 (file)
--- a/include/shared/fwcmd.h
+++ b/include/shared/fwcmd.h
@@ -156,6 +156,14 @@ struct carl9170_psm {
 } __packed;
 #define CARL9170_PSM_SIZE              4
 
+/*
+ * Note: If a bit in rx_filter is set, then it
+ * means that the particular frames which matches
+ * the condition are FILTERED/REMOVED/DISCARDED!
+ * (This is can be a bit confusing, especially
+ * because someone people think it's the exact
+ * opposite way, so watch out!)
+ */
 struct carl9170_rx_filter_cmd {
        __le32          rx_filter;
 } __packed;