qcacld-3.0: Documentation refine for some ini items

1) Refine the documentation text of the following items: gTxChainMask1ss gTDLSPuapsdInactivityTime UapsdMask InfraUapsdVoSrvIntv InfraUapsdVoSuspIntv InfraUapsdViSrvIntv InfraUapsdViSuspIntv InfraUapsdBeSrvIntv InfraUapsdBeSuspIntv InfraUapsdBkSrvIntv InfraUapsdBkSuspIntv InfraDirAcVo InfraDirAcBe InfraDirAcBk InfraSbaAcBk burstSizeDefinition tsInfoAckPolicy SingleTIDRC 2) Remove the duplicated definitions of 2 ini items: gTDLSPuapsdInactivityTime gTDLSPuapsdRxFrameThreshold Change-Id: I0f122af2fc91616a38a2c101478bad942292a9ba CRs-Fixed: 2422339
2019-03-20 10:51:06 +08:00
parent 9a427a78ba
commit 346bb7974e
5 changed files with 54 additions and 70 deletions
--- a/mlme/dispatcher/inc/cfg_mlme_chainmask.h
+++ b/mlme/dispatcher/inc/cfg_mlme_chainmask.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2012-2019 The Linux Foundation. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
@@ -116,7 +116,12 @@
 * @Max: 3
 * @Default: 1
 *
- * This ini is used to set default tx chain Mask1ss
+ * This ini is used to set default tx chain Mask for 1ss
+ *
+ * 0 - 3X3
+ * 1 - 2X2
+ * 2 - 3X2
+ * 3 - 2X3
 *
 * Related: None
 *
--- a/mlme/dispatcher/inc/cfg_mlme_fe_wmm.h
+++ b/mlme/dispatcher/inc/cfg_mlme_fe_wmm.h
@@ -64,6 +64,11 @@
 *
 * This ini is used to set TSPEC direction for VO
 *
+ * 0 - uplink
+ * 1 - direct link
+ * 2 - down link
+ * 3 - bidirectional link
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -312,7 +317,7 @@
 * @Max: 4294967295UL
 * @Default: 20
 *
- * This ini is used to set Uapsd service interval for voice.
+ * This ini is used to set Uapsd service interval(in ms) for voice.
 *
 * Related: None.
 *
@@ -337,7 +342,7 @@
 * @Max: 4294967295UL
 * @Default: 2000
 *
- * This ini is used to set Uapsd suspension interval for voice.
+ * This ini is used to set Uapsd suspension interval(in ms) for voice.
 *
 * Related: None.
 *
@@ -362,7 +367,7 @@
 * @Max: 4294967295UL
 * @Default: 300
 *
- * This ini is used to set Uapsd service interval for video.
+ * This ini is used to set Uapsd service interval(in ms) for video.
 *
 * Related: None.
 *
@@ -388,7 +393,7 @@
 * @Max: 4294967295UL
 * @Default: 2000
 *
- * This ini is used to set Uapsd suspension interval for video
+ * This ini is used to set Uapsd suspension interval(in ms) for video
 *
 * Related: None.
 *
@@ -415,6 +420,11 @@
 *
 * This ini is used to set TSPEC direction for BE
 *
+ * 0 - uplink
+ * 1 - direct link
+ * 2 - down link
+ * 3 - bidirectional link
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -538,7 +548,7 @@
 * @Max: 4294967295UL
 * @Default: 300
 *
- * This ini is used to set Uapsd service interval for BE
+ * This ini is used to set Uapsd service interval(in ms) for BE
 *
 * Related: None.
 *
@@ -563,7 +573,7 @@
 * @Max: 4294967295UL
 * @Default: 2000
 *
- * This ini is used to set Uapsd suspension interval for BE
+ * This ini is used to set Uapsd suspension interval(in ms) for BE
 *
 * Related: None.
 *
@@ -590,6 +600,11 @@
 *
 * This ini is used to set TSPEC direction for BK
 *
+ * 0 - uplink
+ * 1 - direct link
+ * 2 - down link
+ * 3 - bidirectional link
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -690,6 +705,11 @@
 *
 * This ini is used to set surplus bandwidth allowance for BK
 *
+ * The 13 least significant bits (LSBs) indicate the decimal part while the
+ * three MSBs indicate the integer part of the number.
+ *
+ * A value of 1 indicates that no additional allocation of time is requested.
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -713,7 +733,7 @@
 * @Max: 4294967295UL
 * @Default: 300
 *
- * This ini is used to set Uapsd service interval for BK
+ * This ini is used to set Uapsd service interval(in ms) for BK
 *
 * Related: None.
 *
@@ -738,7 +758,7 @@
 * @Max: 4294967295UL
 * @Default: 2000
 *
- * This ini is used to set Uapsd suspension interval for BK
+ * This ini is used to set Uapsd suspension interval(in ms) for BK
 *
 * Related: None.
 *
@@ -813,6 +833,12 @@
 *
 * This ini is used to setup U-APSD mask for ACs.
 *
+ * Bit 0 set, Voice both deliver/trigger enabled
+ * Bit 1 set, Video both deliver/trigger enabled
+ * Bit 2 set, Background both deliver/trigger enabled
+ * Bit 3 set, Best Effort both deliver/trigger enabled
+ * others, reserved
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -894,6 +920,9 @@
 *
 * This ini is used to set TS burst size
 *
+ * 0 - burst is disabled
+ * 1 - burst is enabled
+ *
 * Related: None.
 *
 * Supported Feature: WMM
@@ -915,12 +944,11 @@
 * @Default: 0x00
 *
 * This ini is used to set TS ack policy
- * TS Info Ack Policy can be either of the
- * following values:
- * enum mlme_ts_info_ack_policy {
- * TS_INFO_ACK_POLICY_NORMAL_ACK = 0,
- * TS_INFO_ACK_POLICY_HT_IMMEDIATE_BLOCK_ACK = 1,
- * }
+ *
+ * TS Info Ack Policy can be either of the following values:
+ *
+ * 0 - normal ack
+ * 1 - HT immediate block ack
 *
 * Related: None.
 *
--- a/mlme/dispatcher/inc/cfg_mlme_sta.h
+++ b/mlme/dispatcher/inc/cfg_mlme_sta.h
@@ -322,6 +322,9 @@
 *
 * This ini is used to set replay counter for all TID's
 *
+ * 0 - Separate replay counter for all TID
+ * 1 - Single replay counter for all TID
+ *
 * Related: None.
 *
 * Supported Feature: WMM
--- a/tdls/dispatcher/inc/wlan_tdls_cfg.h
+++ b/tdls/dispatcher/inc/wlan_tdls_cfg.h
@@ -80,7 +80,7 @@
 * @Max: 10
 * @Default: 0
 *
- * This ini is used to configure peer uapsd inactivity time.
+ * This ini is used to configure peer uapsd inactivity time(in ms).
 *
 * Related: gEnableTDLSSupport.
 *
@@ -466,56 +466,6 @@
 	CFG_VALUE_OR_DEFAULT, \
 	"Preferred TDLS channel bandwidth")

-/*
- * <ini>
- * gTDLSPuapsdInactivityTime - Peer UAPSD Inactivity time.
- * @Min: 0
- * @Max: 10
- * @Default: 0
- *
- * This ini is used to configure peer uapsd inactivity time.
- *
- * Related: gEnableTDLSSupport.
- *
- * Supported Feature: TDLS
- *
- * Usage: Internal/External
- *
- * </ini>
- */
-#define CFG_TDLS_PUAPSD_INACTIVITY_TIME CFG_INI_UINT( \
-	"gTDLSPuapsdInactivityTime", \
-	0, \
-	10, \
-	0, \
-	CFG_VALUE_OR_DEFAULT, \
-	"Peer UAPSD Inactivity time")
-
-/*
- * <ini>
- * gTDLSPuapsdInactivityTime - Peer UAPSD Inactivity time.
- * @Min: 0
- * @Max: 10
- * @Default: 0
- *
- * This ini is used to configure peer uapsd inactivity time.
- *
- * Related: gEnableTDLSSupport.
- *
- * Supported Feature: TDLS
- *
- * Usage: Internal/External
- *
- * </ini>
- */
-#define CFG_TDLS_PUAPSD_RX_FRAME_THRESHOLD CFG_INI_UINT( \
-	"gTDLSPuapsdRxFrameThreshold", \
-	10, \
-	20, \
-	10, \
-	CFG_VALUE_OR_DEFAULT, \
-	"Peer UAPSD Rx frame threshold")
-
 /*
 * <ini>
 * gTDLSPuapsdPTIWindow - This ini is used to configure peer traffic indication
@@ -720,8 +670,6 @@
 	CFG(CFG_TDLS_RSSI_DELTA) \
 	CFG(CFG_TDLS_PREFERRED_OFF_CHANNEL_NUM) \
 	CFG(CFG_TDLS_PREFERRED_OFF_CHANNEL_BW) \
-	CFG(CFG_TDLS_PUAPSD_INACTIVITY_TIME) \
-	CFG(CFG_TDLS_PUAPSD_RX_FRAME_THRESHOLD) \
 	CFG(CFG_TDLS_PUAPSD_PEER_TRAFFIC_IND_WINDOW) \
 	CFG(CFG_TDLS_PUAPSD_PEER_TRAFFIC_RSP_TIMEOUT) \
 	CFG(CFG_TDLS_EXTERNAL_CONTROL) \
--- a/tdls/dispatcher/src/wlan_tdls_ucfg_api.c
+++ b/tdls/dispatcher/src/wlan_tdls_ucfg_api.c
@@ -173,7 +173,7 @@ static QDF_STATUS tdls_object_init_params(
 	tdls_soc_obj->tdls_configs.tdls_tx_pkt_threshold =
 			cfg_get(psoc, CFG_TDLS_TX_PACKET_THRESHOLD);
 	tdls_soc_obj->tdls_configs.tdls_rx_pkt_threshold =
-			cfg_get(psoc, CFG_TDLS_PUAPSD_RX_FRAME_THRESHOLD);
+			cfg_get(psoc, CFG_TDLS_RX_FRAME_THRESHOLD);
 	tdls_soc_obj->tdls_configs.tdls_max_discovery_attempt =
 			cfg_get(psoc, CFG_TDLS_MAX_DISCOVERY_ATTEMPT);
 	tdls_soc_obj->tdls_configs.tdls_idle_timeout =