[PATCH] rtl818x: Add some documentation to the TX desc flags

[PATCH] rtl818x: Add some documentation to the TX desc flags

[Michael Buesch]

Add some TX desc flags docs.

Signed-off-by: Michael Buesch <mb@bu3sch.de>

---

It's incomplete. Just the ones I could easily figure out by myself...


 drivers/net/wireless/rtl818x/rtl818x.h |   14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

--- wireless-testing.orig/drivers/net/wireless/rtl818x/rtl818x.h
+++ wireless-testing/drivers/net/wireless/rtl818x/rtl818x.h
@@ -187,22 +187,32 @@ struct rtl818x_csr {
 } __attribute__((packed));
 
 struct rtl818x_rf_ops {
 	char *name;
 	void (*init)(struct ieee80211_hw *);
 	void (*stop)(struct ieee80211_hw *);
 	void (*set_chan)(struct ieee80211_hw *, struct ieee80211_conf *);
 	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),
 	RTL818X_TX_DESC_FLAG_SPLCP	= (1 << 16),
 	RTL818X_TX_DESC_FLAG_RX_UNDER	= (1 << 16),
 	RTL818X_TX_DESC_FLAG_MOREFRAG	= (1 << 17),
 	RTL818X_TX_DESC_FLAG_CTS	= (1 << 18),
 	RTL818X_TX_DESC_FLAG_RTS	= (1 << 23),
 	RTL818X_TX_DESC_FLAG_LS		= (1 << 28),
 	RTL818X_TX_DESC_FLAG_FS		= (1 << 29),

-- 
Greetings, Michael.

Re: [PATCH] rtl818x: Add some documentation to the TX desc flags

[Larry Finger]

Michael Buesch wrote:
> Add some TX desc flags docs.
> 
> Signed-off-by: Michael Buesch <mb@bu3sch.de>
> 
> ---
> 
> It's incomplete. Just the ones I could easily figure out by myself...

ack

Thanks for the start. In a quick check, the one you didn't fill in
(RTL818X_TX_DESC_FLAG_RX_UNDER) is not used and should be removed.
I'll do that and add the RX desc flags.

Larry