qcacld-3.0: Add INI template for SSR feature

Add INI template for ssr feature for documentation.

CRs-Fixed: 1108400
Change-Id: I4c14205aab5d3ab353eb39cc0c04e18a2d6fe576
This commit is contained in:
Manjeet Singh 2017-01-06 17:38:16 +05:30 • committed by snandini
commit a5acc16871

View file

@ -5002,6 +5002,26 @@ enum hdd_link_speed_rpt_type {
#define CFG_P2P_DEVICE_ADDRESS_ADMINISTRATED_MAX (1)
#define CFG_P2P_DEVICE_ADDRESS_ADMINISTRATED_DEFAULT (1)
/*
* <ini>
* gEnableSSR - Enable/Disable SSR
* @Min: 0
* @Max: 1
* @Default: 1
*
* This ini is used to enable/disable System Self Recovery at the times of
* System crash or fatal errors
* gEnableSSR = 0 Disabled
* gEnableSSR = 1 wlan shutdown and re-init happens
*
* Related: None
*
* Supported Feature: SSR
*
* Usage: External
*
* </ini>
*/
#define CFG_ENABLE_SSR "gEnableSSR"
#define CFG_ENABLE_SSR_MIN (0)
#define CFG_ENABLE_SSR_MAX (1)
@ -6866,8 +6886,26 @@ enum hdd_link_speed_rpt_type {
#define CFG_ENABLE_FW_LOG_DEFAULT (CFG_ENABLE_FW_LOG_WMI)
/*
* Enable/Disable SSR for USB
* <ini>
* gEnableFwSelfRecovery - Enable/disable FW self-recovery for USB
* @Min: 0
* @Max: 1
* @Default: 0
*
* This ini is used to enable/disable FW self-recovery
* gEnableFwSelfRecovery = 0: Disabled
* gEnableFwSelfRecovery = 1: Driver triggers SSR instead of triggering
* kernel panic after firmware crash.
*
* Related: gEnableSSR
*
* Supported Feature: SSR
*
* Usage: External
*
* </ini>
*/
#define CFG_ENABLE_FW_SELF_RECOVERY_NAME "gEnableFwSelfRecovery"
#define CFG_ENABLE_FW_SELF_RECOVERY_DISABLE (0)
#define CFG_ENABLE_FW_SELF_RECOVERY_ENABLE (1)
@ -8968,11 +9006,25 @@ enum dot11p_mode {
#define CFG_ADAPT_DWELL_WIFI_THRESH_DEFAULT (10)
/*
* This parameter will help to debug ssr reinit failure issues
* by raising vos bug so dumps can be collected. If OEM
* wants to avoid this crash, just disable this parameter.
* wlan driver will only recover after driver unload and load.
* Default: Enable
* <ini>
* g_bug_on_reinit_failure - Enable/Disable bug on reinit
* @Min: 0
* @Max: 1
* @Default: 1
*
* This ini is used to debug ssr reinit failure issues by raising vos bug so
* dumps can be collected.
* g_bug_on_reinit_failure = 0 wlan driver will only recover after driver
* unload and load
* g_bug_on_reinit_failure = 1 raise vos bug to collect dumps
*
* Related: gEnableSSR
*
* Supported Feature: SSR
*
* Usage: External
*
* </ini>
*/
#define CFG_BUG_ON_REINIT_FAILURE_NAME "g_bug_on_reinit_failure"
#define CFG_BUG_ON_REINIT_FAILURE_MIN (0)
@ -9225,7 +9277,26 @@ enum dot11p_mode {
#define CFG_OPTIMIZE_CA_EVENT_ENABLE (1)
#define CFG_OPTIMIZE_CA_EVENT_DEFAULT (0)
/* Trigger BUG ON when firmware fails to send response */
/*
* <ini>
* fw_timeout_crash - Enable/Disable BUG ON
* @Min: 0
* @Max: 1
* @Default: 0
*
* This ini is used to Trigger host crash when firmware fails to send the
* response to host
* fw_timeout_crash = 0 Disabled
* fw_timeout_crash = 1 Trigger host crash
*
* Related: None
*
* Supported Feature: SSR
*
* Usage: Internal/External
*
* </ini>
*/
#define CFG_CRASH_FW_TIMEOUT_NAME "fw_timeout_crash"
#define CFG_CRASH_FW_TIMEOUT_DISABLE (0)
#define CFG_CRASH_FW_TIMEOUT_ENABLE (1)