Browse Source

qcacld-3.0: Add INI/IOCTL template for 11k feature

Add INI and IOCTL template for 11k feature for documentation

Change-Id: If69ff7a7ecf1b9d69daaba1a4297ce8d44cd258a
CRs-Fixed: 2002124
Sreelakshmi Konamki 8 years ago
parent
commit
ded64d7209
2 changed files with 69 additions and 2 deletions
  1. 51 2
      core/hdd/inc/wlan_hdd_cfg.h
  2. 18 0
      core/hdd/src/wlan_hdd_wext.c

+ 51 - 2
core/hdd/inc/wlan_hdd_cfg.h

@@ -3450,24 +3450,73 @@ enum station_keepalive_method {
 #define CFG_TL_DELAYED_TRGR_FRM_INT_MAX                     (4294967295UL)
 #define CFG_TL_DELAYED_TRGR_FRM_INT_DEFAULT                 3000
 
+/*
+ * <ini>
+ * gRrmEnable - Enable/Disable RRM
+ * @Min: 0
+ * @Max: 1
+ * @Default: 0
+ *
+ * This ini is used to controls the capabilities (11 k) included
+ * in the capabilities field.
+ *
+ * Related: None.
+ *
+ * Supported Feature: 11k
+ *
+ * Usage: Internal/External
+ *
+ * </ini>
+ */
 #define CFG_RRM_ENABLE_NAME                              "gRrmEnable"
 #define CFG_RRM_ENABLE_MIN                               (0)
 #define CFG_RRM_ENABLE_MAX                               (1)
 #define CFG_RRM_ENABLE_DEFAULT                           (0)
 
+/*
+ * <ini>
+ * gRrmRandnIntvl - Randomization interval
+ * @Min: 10
+ * @Max: 100
+ * @Default: 100
+ *
+ * This ini is used to set randomization interval which is used to start a timer
+ * of a random value within randomization interval. Next RRM Scan request
+ * will be issued after the expiry of this random interval.
+ *
+ * Related: None.
+ *
+ * Supported Feature: 11k
+ *
+ * Usage: Internal/External
+ *
+ * </ini>
+ */
 #define CFG_RRM_MEAS_RANDOMIZATION_INTVL_NAME            "gRrmRandnIntvl"
 #define CFG_RRM_MEAS_RANDOMIZATION_INTVL_MIN             (10)
 #define CFG_RRM_MEAS_RANDOMIZATION_INTVL_MAX             (100)
 #define CFG_RRM_MEAS_RANDOMIZATION_INTVL_DEFAULT         (100)
 
-/**
- * This INI is used to configure RM enabled capabilities IE.
+/*
+ * <ini>
+ * rm_capability - Configure RM enabled capabilities IE
+ * @Default: 73,10,91,00,04
+ *
+ * This ini is used to configure RM enabled capabilities IE.
  * Using this INI, we can set/unset any of the bits in 5 bytes
  * (last 4bytes are reserved). Bit details are updated as per
  * Draft version of 11mc spec. (Draft P802.11REVmc_D4.2)
  *
  * Bitwise details are defined as bit mask in rrm_global.h
  * Comma is used as a separator for each byte.
+ *
+ * Related: None.
+ *
+ * Supported Feature: 11k
+ *
+ * Usage: Internal/External
+ *
+ * </ini>
  */
 #define CFG_RM_CAPABILITY_NAME            "rm_capability"
 #define CFG_RM_CAPABILITY_DEFAULT         "73,10,91,00,04"

+ 18 - 0
core/hdd/src/wlan_hdd_wext.c

@@ -1777,6 +1777,24 @@ static const hdd_freq_chan_map_t freq_chan_map[] = {
 #define WLAN_PRIV_SET_CHAR_GET_NONE   (SIOCIWFIRSTPRIV + 3)
 #define WE_WOWL_ADD_PTRN     1
 #define WE_WOWL_DEL_PTRN     2
+/*
+ * <ioctl>
+ * neighbor - Send neighbor report request
+ *
+ * @INPUT: string
+ *
+ * @OUTPUT: None
+ *
+ * This IOCTL create a Neighbor report request and send it to peer
+ *
+ * @E.g: iwpriv wlan0 neighbor "SSID"
+ *
+ * Supported Feature: 11k
+ *
+ * Usage: Internal/External
+ *
+ * </ioctl>
+ */
 #define WE_NEIGHBOR_REPORT_REQUEST 3
 /*
  * <ioctl>