diff options
author | Yacine Belkadi <yacine.belkadi.1@gmail.com> | 2013-01-12 07:54:14 -0500 |
---|---|---|
committer | Johannes Berg <johannes.berg@intel.com> | 2013-01-16 09:14:18 -0500 |
commit | 0ae997dc75efb60d47f0c71890f1e972f7d462c1 (patch) | |
tree | 3c1cae75c2c630947f876c8d09afa6b69beb6367 /include/net/mac80211.h | |
parent | 0c0280bd0ba410326eecdaeb1b936696eda6381d (diff) |
{cfg,mac}80211.h: fix some kernel-doc warnings
When building the 80211 DocBook, scripts/kernel-doc reports
the following type of warnings:
Warning(include/net/cfg80211.h:334): No description found for return value of 'cfg80211_get_chandef_type'
These warnings are only reported when scripts/kernel-doc
runs in verbose mode.
To fix these use "Return:" to describe function return values.
Signed-off-by: Yacine Belkadi <yacine.belkadi.1@gmail.com>
[adjust for freq_reg_info() change]
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Diffstat (limited to 'include/net/mac80211.h')
-rw-r--r-- | include/net/mac80211.h | 74 |
1 files changed, 60 insertions, 14 deletions
diff --git a/include/net/mac80211.h b/include/net/mac80211.h index 23daed3c78ed..79bc8709e83b 100644 --- a/include/net/mac80211.h +++ b/include/net/mac80211.h | |||
@@ -1522,6 +1522,8 @@ struct ieee80211_hw { | |||
1522 | * structure can then access it via hw->priv. Note that mac802111 drivers should | 1522 | * structure can then access it via hw->priv. Note that mac802111 drivers should |
1523 | * not use wiphy_priv() to try to get their private driver structure as this | 1523 | * not use wiphy_priv() to try to get their private driver structure as this |
1524 | * is already used internally by mac80211. | 1524 | * is already used internally by mac80211. |
1525 | * | ||
1526 | * Return: The mac80211 driver hw struct of @wiphy. | ||
1525 | */ | 1527 | */ |
1526 | struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); | 1528 | struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); |
1527 | 1529 | ||
@@ -2673,6 +2675,8 @@ struct ieee80211_ops { | |||
2673 | * | 2675 | * |
2674 | * @priv_data_len: length of private data | 2676 | * @priv_data_len: length of private data |
2675 | * @ops: callbacks for this device | 2677 | * @ops: callbacks for this device |
2678 | * | ||
2679 | * Return: A pointer to the new hardware device, or %NULL on error. | ||
2676 | */ | 2680 | */ |
2677 | struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, | 2681 | struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, |
2678 | const struct ieee80211_ops *ops); | 2682 | const struct ieee80211_ops *ops); |
@@ -2685,6 +2689,8 @@ struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, | |||
2685 | * need to fill the contained wiphy's information. | 2689 | * need to fill the contained wiphy's information. |
2686 | * | 2690 | * |
2687 | * @hw: the device to register as returned by ieee80211_alloc_hw() | 2691 | * @hw: the device to register as returned by ieee80211_alloc_hw() |
2692 | * | ||
2693 | * Return: 0 on success. An error code otherwise. | ||
2688 | */ | 2694 | */ |
2689 | int ieee80211_register_hw(struct ieee80211_hw *hw); | 2695 | int ieee80211_register_hw(struct ieee80211_hw *hw); |
2690 | 2696 | ||
@@ -2731,6 +2737,8 @@ extern char *__ieee80211_create_tpt_led_trigger( | |||
2731 | * of the trigger so you can automatically link the LED device. | 2737 | * of the trigger so you can automatically link the LED device. |
2732 | * | 2738 | * |
2733 | * @hw: the hardware to get the LED trigger name for | 2739 | * @hw: the hardware to get the LED trigger name for |
2740 | * | ||
2741 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | ||
2734 | */ | 2742 | */ |
2735 | static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) | 2743 | static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) |
2736 | { | 2744 | { |
@@ -2750,6 +2758,8 @@ static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) | |||
2750 | * of the trigger so you can automatically link the LED device. | 2758 | * of the trigger so you can automatically link the LED device. |
2751 | * | 2759 | * |
2752 | * @hw: the hardware to get the LED trigger name for | 2760 | * @hw: the hardware to get the LED trigger name for |
2761 | * | ||
2762 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | ||
2753 | */ | 2763 | */ |
2754 | static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) | 2764 | static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) |
2755 | { | 2765 | { |
@@ -2769,6 +2779,8 @@ static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) | |||
2769 | * of the trigger so you can automatically link the LED device. | 2779 | * of the trigger so you can automatically link the LED device. |
2770 | * | 2780 | * |
2771 | * @hw: the hardware to get the LED trigger name for | 2781 | * @hw: the hardware to get the LED trigger name for |
2782 | * | ||
2783 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | ||
2772 | */ | 2784 | */ |
2773 | static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) | 2785 | static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) |
2774 | { | 2786 | { |
@@ -2788,6 +2800,8 @@ static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) | |||
2788 | * of the trigger so you can automatically link the LED device. | 2800 | * of the trigger so you can automatically link the LED device. |
2789 | * | 2801 | * |
2790 | * @hw: the hardware to get the LED trigger name for | 2802 | * @hw: the hardware to get the LED trigger name for |
2803 | * | ||
2804 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | ||
2791 | */ | 2805 | */ |
2792 | static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) | 2806 | static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) |
2793 | { | 2807 | { |
@@ -2805,9 +2819,10 @@ static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) | |||
2805 | * @blink_table: the blink table -- needs to be ordered by throughput | 2819 | * @blink_table: the blink table -- needs to be ordered by throughput |
2806 | * @blink_table_len: size of the blink table | 2820 | * @blink_table_len: size of the blink table |
2807 | * | 2821 | * |
2808 | * This function returns %NULL (in case of error, or if no LED | 2822 | * Return: %NULL (in case of error, or if no LED triggers are |
2809 | * triggers are configured) or the name of the new trigger. | 2823 | * configured) or the name of the new trigger. |
2810 | * This function must be called before ieee80211_register_hw(). | 2824 | * |
2825 | * Note: This function must be called before ieee80211_register_hw(). | ||
2811 | */ | 2826 | */ |
2812 | static inline char * | 2827 | static inline char * |
2813 | ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags, | 2828 | ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags, |
@@ -2940,10 +2955,10 @@ static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, | |||
2940 | * Calls to this function for a single hardware must be synchronized against | 2955 | * Calls to this function for a single hardware must be synchronized against |
2941 | * each other. | 2956 | * each other. |
2942 | * | 2957 | * |
2943 | * The function returns -EINVAL when the requested PS mode is already set. | ||
2944 | * | ||
2945 | * @sta: currently connected sta | 2958 | * @sta: currently connected sta |
2946 | * @start: start or stop PS | 2959 | * @start: start or stop PS |
2960 | * | ||
2961 | * Return: 0 on success. -EINVAL when the requested PS mode is already set. | ||
2947 | */ | 2962 | */ |
2948 | int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); | 2963 | int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); |
2949 | 2964 | ||
@@ -2957,6 +2972,8 @@ int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); | |||
2957 | * | 2972 | * |
2958 | * @sta: currently connected sta | 2973 | * @sta: currently connected sta |
2959 | * @start: start or stop PS | 2974 | * @start: start or stop PS |
2975 | * | ||
2976 | * Return: Like ieee80211_sta_ps_transition(). | ||
2960 | */ | 2977 | */ |
2961 | static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta, | 2978 | static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta, |
2962 | bool start) | 2979 | bool start) |
@@ -3094,6 +3111,8 @@ void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets); | |||
3094 | * according to the current DTIM parameters/TIM bitmap. | 3111 | * according to the current DTIM parameters/TIM bitmap. |
3095 | * | 3112 | * |
3096 | * The driver is responsible for freeing the returned skb. | 3113 | * The driver is responsible for freeing the returned skb. |
3114 | * | ||
3115 | * Return: The beacon template. %NULL on error. | ||
3097 | */ | 3116 | */ |
3098 | struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, | 3117 | struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, |
3099 | struct ieee80211_vif *vif, | 3118 | struct ieee80211_vif *vif, |
@@ -3105,6 +3124,8 @@ struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, | |||
3105 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | 3124 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
3106 | * | 3125 | * |
3107 | * See ieee80211_beacon_get_tim(). | 3126 | * See ieee80211_beacon_get_tim(). |
3127 | * | ||
3128 | * Return: See ieee80211_beacon_get_tim(). | ||
3108 | */ | 3129 | */ |
3109 | static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, | 3130 | static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, |
3110 | struct ieee80211_vif *vif) | 3131 | struct ieee80211_vif *vif) |
@@ -3121,6 +3142,8 @@ static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, | |||
3121 | * hardware. The destination address should be set by the caller. | 3142 | * hardware. The destination address should be set by the caller. |
3122 | * | 3143 | * |
3123 | * Can only be called in AP mode. | 3144 | * Can only be called in AP mode. |
3145 | * | ||
3146 | * Return: The Probe Response template. %NULL on error. | ||
3124 | */ | 3147 | */ |
3125 | struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, | 3148 | struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, |
3126 | struct ieee80211_vif *vif); | 3149 | struct ieee80211_vif *vif); |
@@ -3136,6 +3159,8 @@ struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, | |||
3136 | * | 3159 | * |
3137 | * Note: Caller (or hardware) is responsible for setting the | 3160 | * Note: Caller (or hardware) is responsible for setting the |
3138 | * &IEEE80211_FCTL_PM bit. | 3161 | * &IEEE80211_FCTL_PM bit. |
3162 | * | ||
3163 | * Return: The PS Poll template. %NULL on error. | ||
3139 | */ | 3164 | */ |
3140 | struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, | 3165 | struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, |
3141 | struct ieee80211_vif *vif); | 3166 | struct ieee80211_vif *vif); |
@@ -3151,6 +3176,8 @@ struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, | |||
3151 | * | 3176 | * |
3152 | * Note: Caller (or hardware) is responsible for setting the | 3177 | * Note: Caller (or hardware) is responsible for setting the |
3153 | * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. | 3178 | * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. |
3179 | * | ||
3180 | * Return: The nullfunc template. %NULL on error. | ||
3154 | */ | 3181 | */ |
3155 | struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, | 3182 | struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, |
3156 | struct ieee80211_vif *vif); | 3183 | struct ieee80211_vif *vif); |
@@ -3165,6 +3192,8 @@ struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, | |||
3165 | * | 3192 | * |
3166 | * Creates a Probe Request template which can, for example, be uploaded to | 3193 | * Creates a Probe Request template which can, for example, be uploaded to |
3167 | * hardware. | 3194 | * hardware. |
3195 | * | ||
3196 | * Return: The Probe Request template. %NULL on error. | ||
3168 | */ | 3197 | */ |
3169 | struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, | 3198 | struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, |
3170 | struct ieee80211_vif *vif, | 3199 | struct ieee80211_vif *vif, |
@@ -3200,6 +3229,8 @@ void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, | |||
3200 | * If the RTS is generated in firmware, but the host system must provide | 3229 | * If the RTS is generated in firmware, but the host system must provide |
3201 | * the duration field, the low-level driver uses this function to receive | 3230 | * the duration field, the low-level driver uses this function to receive |
3202 | * the duration field value in little-endian byteorder. | 3231 | * the duration field value in little-endian byteorder. |
3232 | * | ||
3233 | * Return: The duration. | ||
3203 | */ | 3234 | */ |
3204 | __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, | 3235 | __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, |
3205 | struct ieee80211_vif *vif, size_t frame_len, | 3236 | struct ieee80211_vif *vif, size_t frame_len, |
@@ -3235,6 +3266,8 @@ void ieee80211_ctstoself_get(struct ieee80211_hw *hw, | |||
3235 | * If the CTS-to-self is generated in firmware, but the host system must provide | 3266 | * If the CTS-to-self is generated in firmware, but the host system must provide |
3236 | * the duration field, the low-level driver uses this function to receive | 3267 | * the duration field, the low-level driver uses this function to receive |
3237 | * the duration field value in little-endian byteorder. | 3268 | * the duration field value in little-endian byteorder. |
3269 | * | ||
3270 | * Return: The duration. | ||
3238 | */ | 3271 | */ |
3239 | __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, | 3272 | __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, |
3240 | struct ieee80211_vif *vif, | 3273 | struct ieee80211_vif *vif, |
@@ -3251,6 +3284,8 @@ __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, | |||
3251 | * | 3284 | * |
3252 | * Calculate the duration field of some generic frame, given its | 3285 | * Calculate the duration field of some generic frame, given its |
3253 | * length and transmission rate (in 100kbps). | 3286 | * length and transmission rate (in 100kbps). |
3287 | * | ||
3288 | * Return: The duration. | ||
3254 | */ | 3289 | */ |
3255 | __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, | 3290 | __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, |
3256 | struct ieee80211_vif *vif, | 3291 | struct ieee80211_vif *vif, |
@@ -3267,9 +3302,10 @@ __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, | |||
3267 | * hardware/firmware does not implement buffering of broadcast/multicast | 3302 | * hardware/firmware does not implement buffering of broadcast/multicast |
3268 | * frames when power saving is used, 802.11 code buffers them in the host | 3303 | * frames when power saving is used, 802.11 code buffers them in the host |
3269 | * memory. The low-level driver uses this function to fetch next buffered | 3304 | * memory. The low-level driver uses this function to fetch next buffered |
3270 | * frame. In most cases, this is used when generating beacon frame. This | 3305 | * frame. In most cases, this is used when generating beacon frame. |
3271 | * function returns a pointer to the next buffered skb or NULL if no more | 3306 | * |
3272 | * buffered frames are available. | 3307 | * Return: A pointer to the next buffered skb or NULL if no more buffered |
3308 | * frames are available. | ||
3273 | * | 3309 | * |
3274 | * Note: buffered frames are returned only after DTIM beacon frame was | 3310 | * Note: buffered frames are returned only after DTIM beacon frame was |
3275 | * generated with ieee80211_beacon_get() and the low-level driver must thus | 3311 | * generated with ieee80211_beacon_get() and the low-level driver must thus |
@@ -3449,6 +3485,8 @@ void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); | |||
3449 | * @queue: queue number (counted from zero). | 3485 | * @queue: queue number (counted from zero). |
3450 | * | 3486 | * |
3451 | * Drivers should use this function instead of netif_stop_queue. | 3487 | * Drivers should use this function instead of netif_stop_queue. |
3488 | * | ||
3489 | * Return: %true if the queue is stopped. %false otherwise. | ||
3452 | */ | 3490 | */ |
3453 | 3491 | ||
3454 | int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); | 3492 | int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); |
@@ -3646,7 +3684,9 @@ void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, | |||
3646 | * @vif: virtual interface to look for station on | 3684 | * @vif: virtual interface to look for station on |
3647 | * @addr: station's address | 3685 | * @addr: station's address |
3648 | * | 3686 | * |
3649 | * This function must be called under RCU lock and the | 3687 | * Return: The station, if found. %NULL otherwise. |
3688 | * | ||
3689 | * Note: This function must be called under RCU lock and the | ||
3650 | * resulting pointer is only valid under RCU lock as well. | 3690 | * resulting pointer is only valid under RCU lock as well. |
3651 | */ | 3691 | */ |
3652 | struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, | 3692 | struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, |
@@ -3659,7 +3699,9 @@ struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, | |||
3659 | * @addr: remote station's address | 3699 | * @addr: remote station's address |
3660 | * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'. | 3700 | * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'. |
3661 | * | 3701 | * |
3662 | * This function must be called under RCU lock and the | 3702 | * Return: The station, if found. %NULL otherwise. |
3703 | * | ||
3704 | * Note: This function must be called under RCU lock and the | ||
3663 | * resulting pointer is only valid under RCU lock as well. | 3705 | * resulting pointer is only valid under RCU lock as well. |
3664 | * | 3706 | * |
3665 | * NOTE: You may pass NULL for localaddr, but then you will just get | 3707 | * NOTE: You may pass NULL for localaddr, but then you will just get |
@@ -3789,7 +3831,9 @@ void ieee80211_iter_chan_contexts_atomic( | |||
3789 | * information. This function must only be called from within the | 3831 | * information. This function must only be called from within the |
3790 | * .bss_info_changed callback function and only in managed mode. The function | 3832 | * .bss_info_changed callback function and only in managed mode. The function |
3791 | * is only useful when the interface is associated, otherwise it will return | 3833 | * is only useful when the interface is associated, otherwise it will return |
3792 | * NULL. | 3834 | * %NULL. |
3835 | * | ||
3836 | * Return: The Probe Request template. %NULL on error. | ||
3793 | */ | 3837 | */ |
3794 | struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw, | 3838 | struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw, |
3795 | struct ieee80211_vif *vif); | 3839 | struct ieee80211_vif *vif); |
@@ -4136,12 +4180,14 @@ void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif, | |||
4136 | void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif); | 4180 | void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif); |
4137 | 4181 | ||
4138 | /** | 4182 | /** |
4139 | * ieee80211_ave_rssi - report the average rssi for the specified interface | 4183 | * ieee80211_ave_rssi - report the average RSSI for the specified interface |
4140 | * | 4184 | * |
4141 | * @vif: the specified virtual interface | 4185 | * @vif: the specified virtual interface |
4142 | * | 4186 | * |
4143 | * This function return the average rssi value for the requested interface. | 4187 | * Note: This function assumes that the given vif is valid. |
4144 | * It assumes that the given vif is valid. | 4188 | * |
4189 | * Return: The average RSSI value for the requested interface, or 0 if not | ||
4190 | * applicable. | ||
4145 | */ | 4191 | */ |
4146 | int ieee80211_ave_rssi(struct ieee80211_vif *vif); | 4192 | int ieee80211_ave_rssi(struct ieee80211_vif *vif); |
4147 | 4193 | ||