rtlwifi: btcoex: 23b 2ant: add comments to describe how duration adjusted

Since btcoex uses static variables to store the cumulative information
on the wifi status, some tricks are used that are a bit obscure. We add
some comments about the criteria we use to adjust wifi duration.

Signed-off-by: Yan-Hsuan Chuang <yhchuang@realtek.com>
Signed-off-by: Larry Finger <Larry.Finger@lwfinger.net>
Cc: Pkshih <pkshih@realtek.com>
Cc: Birming Chiu <birming@realtek.com>
Cc: Shaofu <shaofu@realtek.com>
Cc: Steven Ting <steventing@realtek.com>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>

diff --git a/drivers/net/wireless/realtek/rtlwifi/btcoexist/halbtc8723b2ant.c b/drivers/net/wireless/realtek/rtlwifi/btcoexist/halbtc8723b2ant.c
index b1a4c8466bc6eeb23ff175a940734f1504612f64..fb72bcd4090c31e0424f3c8011497206c906f520 100644 (file)
--- a/drivers/net/wireless/realtek/rtlwifi/btcoexist/halbtc8723b2ant.c
+++ b/drivers/net/wireless/realtek/rtlwifi/btcoexist/halbtc8723b2ant.c
@@ -1622,6 +1622,9 @@ static void btc8723b2ant_tdma_duration_adjust(struct btc_coexist *btcoexist,
                                dn = 0;
 
                        if (up >= n) {
+                               /* if retry count during continuous n*2
+                                * seconds is 0, enlarge WiFi duration
+                                */
                                wait_count = 0;
                                n = 3;
                                up = 0;
@@ -1638,12 +1641,20 @@ static void btc8723b2ant_tdma_duration_adjust(struct btc_coexist *btcoexist,
                                up = 0;
 
                        if (dn == 2) {
+                               /* if continuous 2 retry count(every 2
+                                * seconds) >0 and < 3, reduce WiFi duration
+                                */
                                if (wait_count <= 2)
+                                       /* avoid loop between the two levels */
                                        m++;
                                else
                                        m = 1;
 
                                if (m >= 20)
+                                       /* maximum of m = 20 ' will recheck if
+                                        * need to adjust wifi duration in
+                                        * maximum time interval 120 seconds
+                                        */
                                        m = 20;
 
                                n = 3 * m;
@@ -1655,12 +1666,20 @@ static void btc8723b2ant_tdma_duration_adjust(struct btc_coexist *btcoexist,
                                         "[BTCoex], Decrease wifi duration for retry_counter<3!!\n");
                        }
                } else {
+                       /* retry count > 3, once retry count > 3, to reduce
+                        *  WiFi duration
+                        */
                        if (wait_count == 1)
+                               /* to avoid loop between the two levels */
                                m++;
                        else
                                m = 1;
 
                        if (m >= 20)
+                               /* maximum of m = 20 ' will recheck if need to
+                                * adjust wifi duration in maximum time interval
+                                * 120 seconds
+                                */
                                m = 20;
 
                        n = 3 * m;