qcacld-3.0: Format ini descriptions

Some ini descriptions are different to common, and some of them include wrong information, so correct them and use unified form. Change-Id: I36348fb26a03cab254fd309d792125b8a21ad02f CRs-Fixed: 2402446
2019-02-20 16:39:53 +08:00
parent d69f5041c5
commit 814ce703b4
12 changed files with 49 additions and 29 deletions
--- a/components/fw_offload/dispatcher/inc/cfg_fwol_generic.h
+++ b/components/fw_offload/dispatcher/inc/cfg_fwol_generic.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
@@ -47,7 +47,8 @@
 		1, \
 		"Enable/Disable Adaptive Noise Immunity")

-/**
+/*
+ * <ini>
 * gSetRTSForSIFSBursting - set rts for sifs bursting
 * @Min: 0
 * @Max: 1
@@ -64,7 +65,7 @@
 		0, \
 		"Set rts for sifs bursting")

-/**
+/*
 * <ini>
 * gMaxMPDUsInAMPDU - max mpdus in ampdu
 * @Min: 0
@@ -85,7 +86,8 @@
 		CFG_VALUE_OR_DEFAULT, \
 		"This ini configure max mpdus in ampdu")

-/**
+/*
+ * <ini>
 * arp_ac_category - ARP access category
 * @Min: 0
 * @Max: 3
@@ -114,7 +116,7 @@
 		"Override the default ARP AC configuration")

 /*
- * </ini>
+ * <ini>
 * gEnableFastPwrTransition - Configuration for fast power transition
 * @Min: 0
 * @Max: 2
--- a/components/ipa/dispatcher/inc/cfg_ipa.h
+++ b/components/ipa/dispatcher/inc/cfg_ipa.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
@@ -61,7 +61,7 @@

 /*
 * <ini>
- * GIPADescSize - IPA descriptor size
+ * gIPADescSize - IPA descriptor size
 * @Min: 800
 * @Max: 8000
 * @Default: 800
@@ -77,7 +77,7 @@
 * </ini>
 */
 #define CFG_DP_IPA_DESC_SIZE \
-		CFG_INI_UINT("GIPADescSize", \
+		CFG_INI_UINT("gIPADescSize", \
 		800, \
 		8000, \
 		800, \
@@ -109,7 +109,7 @@

 /*
 * <ini>
- * gIPAHighBandwidthMbps - IPA medium bw threshold
+ * gIPAMediumBandwidthMbps - IPA medium bw threshold
 * @Min: 100
 * @Max: 400
 * @Default: 200
@@ -133,7 +133,7 @@

 /*
 * <ini>
- * gIPAHighBandwidthMbps - IPA low bw threshold
+ * gIPALowBandwidthMbps - IPA low bw threshold
 * @Min: 0
 * @Max: 100
 * @Default: 100
--- a/components/mlme/dispatcher/inc/cfg_mlme_fe_wmm.h
+++ b/components/mlme/dispatcher/inc/cfg_mlme_fe_wmm.h
@@ -854,7 +854,7 @@
 #ifdef FEATURE_WLAN_ESE
 /*
 * <ini>
- * UapsdMask - To setup Infra Inactivity Interval for ACs
+ * InfraInactivityInterval - To setup Infra Inactivity Interval for ACs
 * @Min: 0
 * @Max: 4294967295UL
 * @Default: 0
--- a/components/mlme/dispatcher/inc/cfg_mlme_oce.h
+++ b/components/mlme/dispatcher/inc/cfg_mlme_oce.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
@@ -92,6 +92,7 @@
 		"Enable/disable oce feature for SAP")

 /*
+ * <ini>
 * oce_enable_rssi_assoc_reject - Enable/disable rssi based assoc rejection
 * @Min: 0
 * @Max: 1
--- a/components/mlme/dispatcher/inc/cfg_mlme_rates.h
+++ b/components/mlme/dispatcher/inc/cfg_mlme_rates.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
@@ -75,6 +75,7 @@
 		"Disable ABG RATE for TX Data")

 /*
+ * <ini>
 * gSapMaxMCSForTxData - sap 11n max mcs
 * @Min: 0
 * @Max: 383
--- a/components/mlme/dispatcher/inc/cfg_mlme_sap.h
+++ b/components/mlme/dispatcher/inc/cfg_mlme_sap.h
@@ -429,6 +429,7 @@
 			"chan switch hostapd rate enabled")

 /*
+ * <ini>
 * gReducedBeaconInterval - beacon interval reduced
 * @Min: 0
 * @Max: 100
--- a/components/mlme/dispatcher/inc/cfg_mlme_sta.h
+++ b/components/mlme/dispatcher/inc/cfg_mlme_sta.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 above
@@ -193,7 +193,7 @@

 /*
 * <ini>
- * CFG_DOT11P_MODE - 802.11p mode
+ * gDot11PMode - 802.11p mode
 * @Min: CFG_11P_DISABLED
 * @Max: CFG_11P_CONCURRENT
 * @Default: CFG_11P_DISABLED
--- a/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h
+++ b/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h
@@ -138,7 +138,7 @@

 /*
 * <ini>
- * gEnableDynamicDTIM - Enable/Disable modulated DTIM feature
+ * gEnableModulatedDTIM - Enable/Disable modulated DTIM feature
 * @Min: 0
 * @Max: 5
 * @Default: 0
--- a/components/pmo/dispatcher/inc/wlan_pmo_extwow_cfg.h
+++ b/components/pmo/dispatcher/inc/wlan_pmo_extwow_cfg.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
@@ -174,7 +174,7 @@
 			     "Set Keep Alive increment of Ping Interval")
 /*
 * <ini>
- * gExtWoWApp2KAIncPingInterval - Set TCP source port
+ * gExtWoWApp2TcpSrcPort - Set TCP source port
 * @Min: 0
 * @Max: 65535
 * @Default: 5000
@@ -190,7 +190,7 @@
 * </ini>
 */
 #define CFG_EXTWOW_TCP_SRC_PORT \
-		CFG_INI_UINT("gExtWoWApp2KAIncPingInterval", \
+		CFG_INI_UINT("gExtWoWApp2TcpSrcPort", \
 			     0, 65535, 5000, \
 			     CFG_VALUE_OR_DEFAULT, \
 			     "Set TCP source port")
--- a/core/dp/ol/inc/cfg_legacy_dp.h
+++ b/core/dp/ol/inc/cfg_legacy_dp.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
@@ -45,14 +45,16 @@

 /*
 * <ini>
- * Max number of MSDUs per HTT RX IN ORDER INDICATION msg.
+ * maxMSDUsPerRxInd - Max number of MSDUs per HTT RX IN ORDER INDICATION msg.
 * Note that this has a direct impact on the size of source CE rings.
 * It is possible to go below 8, but would require testing; so we are
 * restricting the lower limit to 8 artificially
 *
 * It is recommended that this value is a POWER OF 2.
 *
- * Values lower than 8 are for experimental purposes only.
+ * Values lower than 8 are for experimental purposes only
+ *
+ * </ini>.
 */
 #define CFG_DP_MAX_MSDUS_PER_RXIND \
 	CFG_INI_UINT("maxMSDUsPerRxInd", \
@@ -68,6 +70,8 @@
 * OL_TX_SCHED_WRR_ADV_CAT_CFG_SPEC. The user can tune the
 * WRR TX sched parameters such as skip, credit, limit, credit, disc for VO.
 * e.g., gEnableTxSchedWrrVO = 10, 9, 8, 1, 8
+ *
+ * </ini>
 */
 #define CFG_DP_ENABLE_TX_SCHED_WRR_VO \
 	CFG_INI_STRING("gEnableTxSchedWrrVO", \
@@ -82,10 +86,13 @@
 * OL_TX_SCHED_WRR_ADV_CAT_CFG_SPEC. The user can tune the
 * WRR TX sched parameters such as skip, credit, limit, credit, disc for VI.
 * e.g., gEnableTxSchedWrrVI = 10, 9, 8, 1, 8
+ *
+ * </ini>
 */
 #define CFG_DP_ENABLE_TX_SCHED_WRR_VI \
 	CFG_INI_STRING("gEnableTxSchedWrrVI", \
 	0, 50, "", "Set TX sched parameters for VI")
+
 /*
 * <ini>
 * gEnableTxSchedWrrBE - Set TX sched parameters for BE
@@ -95,6 +102,8 @@
 * OL_TX_SCHED_WRR_ADV_CAT_CFG_SPEC. The user can tune the
 * WRR TX sched parameters such as skip, credit, limit, credit, disc for BE.
 * e.g., gEnableTxSchedWrrBE = 10, 9, 8, 1, 8
+ *
+ * </ini>
 */
 #define CFG_DP_ENABLE_TX_SCHED_WRR_BE \
 	CFG_INI_STRING("gEnableTxSchedWrrBE", \
@@ -109,6 +118,8 @@
 * OL_TX_SCHED_WRR_ADV_CAT_CFG_SPEC. The user can tune the
 * WRR TX sched parameters such as skip, credit, limit, credit, disc for BK.
 * e.g., gEnableTxSchedWrrBK = 10, 9, 8, 1, 8
+ *
+ * </ini>
 */
 #define CFG_DP_ENABLE_TX_SCHED_WRR_BK \
 	CFG_INI_STRING("gEnableTxSchedWrrBK", \
@@ -126,6 +137,8 @@
 *
 * Enable peer unmap confirmation support in the Host. Host will send
 * this support to the FW only if FW support is enabled.
+ *
+ * </ini>
 */
 #define CFG_DP_ENABLE_PEER_UMAP_CONF_SUPPORT \
 		CFG_INI_BOOL("gEnablePeerUnmapConfSupport", \
--- a/core/hdd/inc/hdd_config.h
+++ b/core/hdd/inc/hdd_config.h
@@ -507,7 +507,7 @@ enum hdd_dot11_mode {
 *
 * Usage: External
 *
- * <ini>
+ * </ini>
 */
 #define CFG_OPERATING_CHANNEL CFG_INI_UINT( \
 			"gOperatingChannel", \
--- a/core/hdd/inc/hdd_dp_cfg.h
+++ b/core/hdd/inc/hdd_dp_cfg.h
@@ -632,7 +632,9 @@
 * <ini>
 * RX_THREAD_CPU_AFFINITY_MASK - CPU mask to affine Rx_thread
 *
- * @Default: e
+ * @Min: 0
+ * @Max: 0xFF
+ * @Default: 0x02
 *
 * This ini is used to set Rx_thread CPU affinity
 *
@@ -664,13 +666,11 @@

 /*
 * <ini>
- * RX_THREAD_CPU_AFFINITY_MASK - CPU mask to affine Rx_thread
+ * rpsRxQueueCpuMapList - RPS map for different RX queues
 *
- * @Min: 0
- * @Max: 0xFF
- * @Default: 0
+ * @Default: e
 *
- * This ini is used to set Rx_thread CPU affinity
+ * This ini is used to set RPS map for different RX queues.
 *
 * List of RPS CPU maps for different rx queues registered by WLAN driver
 * Ref - Kernel/Documentation/networking/scaling.txt
@@ -765,6 +765,8 @@

 /*
 * <ini>
+ * enable_multicast_replay_filter - Enable filtering of replayed multicast
+ * packets
 *
 * In a typical infrastructure setup, it is quite normal to receive
 * replayed multicast packets. These packets may cause more harm than