summaryrefslogtreecommitdiffstats
path: root/include/hardware_legacy/wifi_logger.h
diff options
context:
space:
mode:
authorPierre Vandwalle <vandwalle@google.com>2015-02-10 15:03:34 -0800
committerPierre Vandwalle <vandwalle@google.com>2015-02-10 15:03:34 -0800
commitf654d41b8b81de38051200ac6cf34007ae55f646 (patch)
treea5a5ee400778cf44e1ec6f49e2fe12d98a7ddcfc /include/hardware_legacy/wifi_logger.h
parent3325028cf62f55a33e61f28c667d1b2bf47ce9aa (diff)
downloadhardware_libhardware_legacy-f654d41b8b81de38051200ac6cf34007ae55f646.zip
hardware_libhardware_legacy-f654d41b8b81de38051200ac6cf34007ae55f646.tar.gz
hardware_libhardware_legacy-f654d41b8b81de38051200ac6cf34007ae55f646.tar.bz2
add some wifi interface statistics (beacon tsf offset) and guard time
Change-Id: If0286abc0942bed40bf321438117546f0e6dbd25
Diffstat (limited to 'include/hardware_legacy/wifi_logger.h')
-rw-r--r--include/hardware_legacy/wifi_logger.h28
1 files changed, 21 insertions, 7 deletions
diff --git a/include/hardware_legacy/wifi_logger.h b/include/hardware_legacy/wifi_logger.h
index 9742ab3..a201b49 100644
--- a/include/hardware_legacy/wifi_logger.h
+++ b/include/hardware_legacy/wifi_logger.h
@@ -95,8 +95,19 @@ typedef struct {
/**
- * This structure represent a logger entry within a ring.
- * Binary entries can be used so as to store packet data or vendor specific information.
+ * This structure represent a logger entry within a ring buffer.
+ * Wifi driver are responsible to manage the ring buffer and write the debug
+ * information into those rings.
+ *
+ * In general, the debug entries can be used to store meaningful 802.11 information (SME, MLME,
+ * connection and packet statistics) as well as vendor proprietary data that is specific to a
+ * specific driver or chipset.
+ * Binary entries can be used so as to store packet data or vendor specific information and
+ * will be treated as blobs of data by android.
+ *
+ * A user land process will be started by framework so as to periodically retrieve the
+ * data logged by drivers into their ring buffer, store the data into log files and include
+ * the logs into android bugreports.
*/
typedef struct {
u16 entry_size:13;
@@ -130,11 +141,14 @@ typedef struct {
u32 read_bytes; // number of bytes that was read from the buffer by user land, monotonously increasing integer
} wifi_ring_buffer_status;
-/* API to trigger the debug collection.
- Unless his API is invoked - logging is not triggered.
- - verbose_level 0 corresponds to minimal or no collection
- - verbose_level 1+ are TBD
- */
+/**
+ * API to trigger the debug collection.
+ * Unless his API is invoked - logging is not triggered.
+ * - verbose_level 0 corresponds to minimal or no collection
+ * - verbose_level 1+ are TBD
+ *
+ * buffer_name represent the name of the ring for which data collection shall start.
+ */
wifi_error wifi_start_logging(wifi_interface_handle iface, u32 verbose_level, u8 * buffer_name);
/* callback for reporting ring buffer status */