History

wifi: mac80211: fix header kernel-doc typos

Correct typos and fix run-on sentences.

Randy Dunlap committed 3 years ago

Commit cbb56fb1 parent 98e0c7f1 file · +14 −14Browse files

Unified · Split

include/net/mac80211.h+14−14
@@ -79,7 +79,7 @@ · 78 unmodified lines
7979 * helpers for sanity checking. Drivers must ensure all work added onto the
8080 * mac80211 workqueue should be cancelled on the driver stop() callback.
8181 *
82− * mac80211 will flushed the workqueue upon interface removal and during
82+ * mac80211 will flush the workqueue upon interface removal and during
8383 * suspend.
8484 *
8585 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
@@ -138,7 +138,7 @@ · 52 unmodified lines
138138 * field to the frame RX timestamp and report the ack TX timestamp in the
139139 * ieee80211_rx_status struct.
140140 *
141− * Similarly, To report hardware timestamps for Timing Measurement or Fine
141+ * Similarly, to report hardware timestamps for Timing Measurement or Fine
142142 * Timing Measurement frame TX, the driver should set the SKB's hwtstamp field
143143 * to the frame TX timestamp and report the ack RX timestamp in the
144144 * ieee80211_tx_status struct.
@@ -3062,7 +3062,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 2917 unmodified lines
30623062 * The set_key() call for the %SET_KEY command should return 0 if
30633063 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
30643064 * added; if you return 0 then hw_key_idx must be assigned to the
3065− * hardware key index, you are free to use the full u8 range.
3065+ * hardware key index. You are free to use the full u8 range.
30663066 *
30673067 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
30683068 * set, mac80211 will not automatically fall back to software crypto if
@@ -3072,7 +3072,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 3 unmodified lines
30723072 * When the cmd is %DISABLE_KEY then it must succeed.
30733073 *
30743074 * Note that it is permissible to not decrypt a frame even if a key
3075− * for it has been uploaded to hardware, the stack will not make any
3075+ * for it has been uploaded to hardware. The stack will not make any
30763076 * decision based on whether a key has been uploaded or not but rather
30773077 * based on the receive flags.
30783078 *
@@ -3087,7 +3087,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 8 unmodified lines
30873087 * The update_tkip_key() call updates the driver with the new phase 1 key.
30883088 * This happens every time the iv16 wraps around (every 65536 packets). The
30893089 * set_key() call will happen only once for each key (unless the AP did
3090− * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
3090+ * rekeying); it will not include a valid phase 1 key. The valid phase 1 key is
30913091 * provided by update_tkip_key only. The trigger that makes mac80211 call this
30923092 * handler is software decryption with wrap around of iv16.
30933093 *
@@ -3114,7 +3114,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 20 unmodified lines
31143114 *
31153115 * mac80211 has support for various powersave implementations.
31163116 *
3117− * First, it can support hardware that handles all powersaving by itself,
3117+ * First, it can support hardware that handles all powersaving by itself;
31183118 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
31193119 * flag. In that case, it will be told about the desired powersave mode
31203120 * with the %IEEE80211_CONF_PS flag depending on the association status.
@@ -3139,12 +3139,12 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 18 unmodified lines
31393139 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
31403140 * required to pass up beacons. The hardware is still required to handle
31413141 * waking up for multicast traffic; if it cannot the driver must handle that
3142− * as best as it can, mac80211 is too slow to do that.
3142+ * as best as it can; mac80211 is too slow to do that.
31433143 *
31443144 * Dynamic powersave is an extension to normal powersave in which the
31453145 * hardware stays awake for a user-specified period of time after sending a
31463146 * frame so that reply frames need not be buffered and therefore delayed to
3147− * the next wakeup. It's compromise of getting good enough latency when
3147+ * the next wakeup. It's a compromise of getting good enough latency when
31483148 * there's data traffic and still saving significantly power in idle
31493149 * periods.
31503150 *
@@ -3209,7 +3209,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 58 unmodified lines
32093209 * Note that change, for the sake of simplification, also includes information
32103210 * elements appearing or disappearing from the beacon.
32113211 *
3212− * Some hardware supports an "ignore list" instead, just make sure nothing
3212+ * Some hardware supports an "ignore list" instead. Just make sure nothing
32133213 * that was requested is on the ignore list, and include commonly changing
32143214 * information element IDs in the ignore list, for example 11 (BSS load) and
32153215 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
@@ -3220,7 +3220,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 4 unmodified lines
32203220 * In addition to these capabilities, hardware should support notifying the
32213221 * host of changes in the beacon RSSI. This is relevant to implement roaming
32223222 * when no traffic is flowing (when traffic is flowing we see the RSSI of
3223− * the received data packets). This can consist in notifying the host when
3223+ * the received data packets). This can consist of notifying the host when
32243224 * the RSSI changes significantly or when it drops below or rises above
32253225 * configurable thresholds. In the future these thresholds will also be
32263226 * configured by mac80211 (which gets them from userspace) to implement
@@ -3367,8 +3367,8 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 140 unmodified lines
33673367 * period starts for any reason, @release_buffered_frames is called
33683368 * with the number of frames to be released and which TIDs they are
33693369 * to come from. In this case, the driver is responsible for setting
3370− * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
3371− * to help the @more_data parameter is passed to tell the driver if
3370+ * the EOSP (for uAPSD) and MORE_DATA bits in the released frames.
3371+ * To help the @more_data parameter is passed to tell the driver if
33723372 * there is more data on other TIDs -- the TIDs to release frames
33733373 * from are ignored since mac80211 doesn't know how many frames the
33743374 * buffers for those TIDs contain.
@@ -3417,7 +3417,7 @@ void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); · 42 unmodified lines
34173417 * Additionally, the driver has to then use these HW queue IDs for the queue
34183418 * management functions (ieee80211_stop_queue() et al.)
34193419 *
3420− * The driver is free to set up the queue mappings as needed, multiple virtual
3420+ * The driver is free to set up the queue mappings as needed; multiple virtual
34213421 * interfaces may map to the same hardware queues if needed. The setup has to
34223422 * happen during add_interface or change_interface callbacks. For example, a
34233423 * driver supporting station+station and station+AP modes might decide to have
@@ -7266,7 +7266,7 @@ ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq, · 3842 unmodified lines
72667266 *
72677267 * This function is used to check whether given txq is allowed to transmit by
72687268 * the airtime scheduler, and can be used by drivers to access the airtime
7269− * fairness accounting without going using the scheduling order enfored by
7269+ * fairness accounting without using the scheduling order enforced by
72707270 * next_txq().
72717271 *
72727272 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t