From bfc88b4a0d4fa2bc7956035ef774b1b754113880 Mon Sep 17 00:00:00 2001 From: wadesong Date: Thu, 14 Mar 2019 16:35:05 +0800 Subject: [PATCH] qcacld-3.0: cfg ini documentation refine Some malformed comments were discovered when generating the official documentation of wlan cfg ini items. Refine the documentation text of the following items in one batch: gEnableDynamicDTIM g_sap_chanswitch_mode gVhtChannelWidth gDataInactivityTimeout Change-Id: I2b1455d0ea27fd35dc0cf66316c7dc3b348ee0ac CRs-Fixed: 2416086 --- components/mlme/dispatcher/inc/cfg_mlme_sap.h | 10 +++++++++- components/mlme/dispatcher/inc/cfg_mlme_timeout.h | 7 ++++--- components/mlme/dispatcher/inc/cfg_mlme_vht_caps.h | 4 ++-- components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h | 2 +- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/components/mlme/dispatcher/inc/cfg_mlme_sap.h b/components/mlme/dispatcher/inc/cfg_mlme_sap.h index 3c83dc5dfbc0..6485ffad65eb 100644 --- a/components/mlme/dispatcher/inc/cfg_mlme_sap.h +++ b/components/mlme/dispatcher/inc/cfg_mlme_sap.h @@ -371,10 +371,18 @@ * @Max: 1 * @Default: 1 * - * This ini is used to configure channel switch mode + * This ini is used to configure the value of channel switch mode, which is + * contained in the Channel Switch Announcement(CSA) information element sent + * by an SAP. + * + * 0 - CSA receiving STA doesn't need to do anything + * 1 - CSA receiving STA shall not transmit any more frames on the channel + * until the scheduled channel switch occurs * * Related: none * + * Supported Feature: SAP + * * Usage: External * * diff --git a/components/mlme/dispatcher/inc/cfg_mlme_timeout.h b/components/mlme/dispatcher/inc/cfg_mlme_timeout.h index 0c23fe357586..4b7428f101d4 100644 --- a/components/mlme/dispatcher/inc/cfg_mlme_timeout.h +++ b/components/mlme/dispatcher/inc/cfg_mlme_timeout.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2018 The Linux Foundation. All rights reserved. + * Copyright (c) 2011-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 @@ -264,12 +264,13 @@ /* * - * gDataInactivityTimeout - Data activity timeout for non wow mode. + * gDataInactivityTimeout - Data inactivity timeout for non wow mode. * @Min: 1 * @Max: 255 * @Default: 200 * - * This ini is used to set data inactivity timeout in non wow mode. + * This ini is used to set data inactivity timeout value, in milliseconds, of + * non wow mode. * * Supported Feature: inactivity timeout in non wow mode * diff --git a/components/mlme/dispatcher/inc/cfg_mlme_vht_caps.h b/components/mlme/dispatcher/inc/cfg_mlme_vht_caps.h index b9c417246fbe..cfdca20ca053 100644 --- a/components/mlme/dispatcher/inc/cfg_mlme_vht_caps.h +++ b/components/mlme/dispatcher/inc/cfg_mlme_vht_caps.h @@ -217,9 +217,9 @@ * gVhtChannelWidth - Channel width capability for 11ac * @Min: 0 * @Max: 4 - * @Default: 3 + * @Default: 2 * - * This ini is used to set channel width capability for 11AC. + * This ini is used to set channel width capability for 11AC. * eHT_CHANNEL_WIDTH_20MHZ = 0, * eHT_CHANNEL_WIDTH_40MHZ = 1, * eHT_CHANNEL_WIDTH_80MHZ = 2, diff --git a/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h b/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h index a71679dc7ad4..fbeafe48cd99 100644 --- a/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h +++ b/components/pmo/dispatcher/inc/wlan_pmo_common_cfg.h @@ -121,7 +121,7 @@ * * This ini is used to enable/disable dynamic DTIM. * - * 0 -Disable Dynamic DTIM + * 0 - Disable Dynamic DTIM * 1 to 5 - SLM will switch to DTIM specified here when host suspends and * switch DTIM1 when host resumes *