rtl818x: Add some documentation to the TX desc flags
authorMichael Buesch <mb@bu3sch.de>
Sun, 9 Aug 2009 15:57:30 +0000 (17:57 +0200)
committerJohn W. Linville <linville@tuxdriver.com>
Fri, 14 Aug 2009 13:13:55 +0000 (09:13 -0400)
Add some TX desc flags docs.

Signed-off-by: Michael Buesch <mb@bu3sch.de>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
drivers/net/wireless/rtl818x/rtl818x.h

index 34a5555cc19c04fe3162f634e34c7937ac570018..562222e6cf1f40c90906ad45850851cf952dd0a1 100644 (file)
@@ -194,8 +194,18 @@ struct rtl818x_rf_ops {
        void (*conf_erp)(struct ieee80211_hw *, struct ieee80211_bss_conf *);
 };
 
-/* Tx/Rx flags are common between RTL818X chips */
-
+/**
+ * enum rtl818x_tx_desc_flags - Tx/Rx flags are common between RTL818X chips
+ *
+ * @RTL818X_TX_DESC_FLAG_NO_ENC: Disable hardware based encryption.
+ * @RTL818X_TX_DESC_FLAG_TX_OK: TX frame was ACKed.
+ * @RTL818X_TX_DESC_FLAG_SPLCP: Use short preamble.
+ * @RTL818X_TX_DESC_FLAG_MOREFRAG: More fragments follow.
+ * @RTL818X_TX_DESC_FLAG_CTS: Use CTS-to-self protection.
+ * @RTL818X_TX_DESC_FLAG_RTS: Use RTS/CTS protection.
+ * @RTL818X_TX_DESC_FLAG_LS: Last segment of the frame.
+ * @RTL818X_TX_DESC_FLAG_FS: First segment of the frame.
+ */
 enum rtl818x_tx_desc_flags {
        RTL818X_TX_DESC_FLAG_NO_ENC     = (1 << 15),
        RTL818X_TX_DESC_FLAG_TX_OK      = (1 << 15),