[PATCH v2] mac80211: Add documentation bits for mac80211_rate_control_flags

[PATCH v2] mac80211: Add documentation bits for mac80211_rate_control_flags

[Sujith]

Signed-off-by: Sujith <Sujith.Manoharan@atheros.com>
---
v2:
--
Replace 'can' with 'should'.

 include/net/mac80211.h |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 9a5869e..2e72a12 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -262,6 +262,26 @@ enum mac80211_tx_control_flags {
 	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(12),
 };
 
+/**
+ * enum mac80211_rate_control_flags - per-rate flags set by the
+ *	Rate Control algorithm.
+ *
+ * These flags are set by the Rate control algorithm for each rate during tx,
+ * in the @flags member of struct ieee80211_tx_rate.
+ *
+ * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
+ * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
+ *	This is set if the current BSS requires ERP protection.
+ * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
+ * @IEEE80211_TX_RC_MCS: HT rate.
+ * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
+ *	Greenfield mode.
+ * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
+ * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
+ *	adjacent 20 MHz channels, if the current channel type is
+ *	NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
+ * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
+ */
 enum mac80211_rate_control_flags {
 	IEEE80211_TX_RC_USE_RTS_CTS		= BIT(0),
 	IEEE80211_TX_RC_USE_CTS_PROTECT		= BIT(1),
-- 
1.6.1

Re: [PATCH v2] mac80211: Add documentation bits for mac80211_rate_control_flags

[Johannes Berg]

[-- Attachment #1: Type: text/plain, Size: 1814 bytes --]

On Thu, 2009-01-22 at 09:00 +0530, Sujith wrote:
> Signed-off-by: Sujith <Sujith.Manoharan@atheros.com>

Thanks.
Acked-by: Johannes Berg <johannes@sipsolutions.net>

> ---
> v2:
> --
> Replace 'can' with 'should'.
> 
>  include/net/mac80211.h |   20 ++++++++++++++++++++
>  1 files changed, 20 insertions(+), 0 deletions(-)
> 
> diff --git a/include/net/mac80211.h b/include/net/mac80211.h
> index 9a5869e..2e72a12 100644
> --- a/include/net/mac80211.h
> +++ b/include/net/mac80211.h
> @@ -262,6 +262,26 @@ enum mac80211_tx_control_flags {
>  	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(12),
>  };
>  
> +/**
> + * enum mac80211_rate_control_flags - per-rate flags set by the
> + *	Rate Control algorithm.
> + *
> + * These flags are set by the Rate control algorithm for each rate during tx,
> + * in the @flags member of struct ieee80211_tx_rate.
> + *
> + * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
> + * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
> + *	This is set if the current BSS requires ERP protection.
> + * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
> + * @IEEE80211_TX_RC_MCS: HT rate.
> + * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
> + *	Greenfield mode.
> + * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
> + * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
> + *	adjacent 20 MHz channels, if the current channel type is
> + *	NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
> + * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
> + */
>  enum mac80211_rate_control_flags {
>  	IEEE80211_TX_RC_USE_RTS_CTS		= BIT(0),
>  	IEEE80211_TX_RC_USE_CTS_PROTECT		= BIT(1),

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 836 bytes --]