1 /* Copyright (c) 2015, The Linux Foundation. All rights reserved. 2 * 3 * Redistribution and use in source and binary forms, with or without 4 * modification, are permitted provided that the following conditions 5 * are met: 6 * * Redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer. 8 * * Redistributions in binary form must reproduce the above 9 * copyright notice, this list of conditions and the following 10 * disclaimer in the documentation and/or other materials provided 11 * with the distribution. 12 * * Neither the name of The Linux Foundation nor the names of its 13 * contributors may be used to endorse or promote products derived 14 * from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef __WIFI_HAL_WIFILOGGER_DIAG_H__ 30 #define __WIFI_HAL_WIFILOGGER_DIAG_H__ 31 32 #include "common.h" 33 #include "wifi_hal.h" 34 #include "wifilogger_event_defs.h" 35 36 #include <netlink/genl/genl.h> 37 #include <netlink/genl/family.h> 38 #include <netlink/genl/ctrl.h> 39 #include <linux/rtnetlink.h> 40 41 #define ANI_NL_MSG_BASE 0x10 /* Some arbitrary base */ 42 #define WIFI_HAL_USER_SOCK_PORT 646 43 #define WLAN_NL_MSG_CNSS_HOST_EVENT_LOG 17 44 #define ANI_NL_MSG_LOG_HOST_EVENT_LOG_TYPE 0x5050 45 #define ANI_NL_MSG_LOG_HOST_PRINT_TYPE 89 46 #define ANI_NL_MSG_LOG_FW_MSG_TYPE 92 47 48 #define WLAN_PKT_LOG_STATS 0x18E0 49 #define FEATURE_NOT_SUPPORTED 0xFF 50 51 /* 52 * - verbose_level 0 corresponds to no collection 53 * - verbose_level 1 correspond to normal log level, with minimal user impact. 54 * this is the default value 55 * - verbose_level 2 are enabled when user is lazily trying to reproduce a 56 problem, wifi performances and power 57 * can be impacted but device should not otherwise be significantly impacted 58 * - verbose_level 3+ are used when trying to actively debug a problem 59 */ 60 61 enum wifilogger_verbose_level { 62 VERBOSE_NO_COLLECTION, 63 VERBOSE_NORMAL_LOG, 64 VERBOSE_REPRO_PROBLEM, 65 VERBOSE_DEBUG_PROBLEM 66 }; 67 68 enum wifilogger_fw_diag_type { 69 DIAG_TYPE_FW_EVENT, /* send fw event- to diag*/ 70 DIAG_TYPE_FW_LOG, /* send log event- to diag*/ 71 DIAG_TYPE_FW_DEBUG_MSG, /* send dbg message- to diag*/ 72 DIAG_TYPE_FW_MSG = 4, /* send fw message- to diag*/ 73 }; 74 75 enum wifilogger_host_diag_type { 76 DIAG_TYPE_HOST_LOG_MSGS=1, 77 DIAG_TYPE_HOST_EVENTS=2, 78 }; 79 80 enum wlan_diag_frame_type { 81 WLAN_DIAG_TYPE_CONFIG, 82 WLAN_DIAG_TYPE_EVENT, /* Diag Events */ 83 WLAN_DIAG_TYPE_LOG, /* Diag Logs */ 84 WLAN_DIAG_TYPE_MSG, /* F3 messages */ 85 WLAN_DIAG_TYPE_LEGACY_MSG, 86 WLAN_DIAG_TYPE_EVENT_V2, 87 WLAN_DIAG_TYPE_LOG_V2, 88 WLAN_DIAG_TYPE_MSG_V2, 89 }; 90 91 typedef struct event_remap { 92 int q_event; 93 int g_event; 94 } event_remap_t; 95 96 typedef struct { 97 u32 diag_type; 98 u32 timestamp; 99 u32 length; 100 u32 dropped; 101 /* max ATH6KL_FWLOG_PAYLOAD_SIZE bytes */ 102 u_int8_t payload[0]; 103 }__attribute__((packed)) dbglog_slot; 104 105 typedef enum eAniNlModuleTypes { 106 ANI_NL_MSG_PUMAC = ANI_NL_MSG_BASE + 0x01, 107 ANI_NL_MSG_CNSS_DIAG = ANI_NL_MSG_BASE + 0x0B, 108 ANI_NL_MSG_LOG, 109 ANI_NL_MSG_MAX 110 } tAniNlModTypes; 111 112 //All Netlink messages must contain this header 113 typedef struct sAniHdr { 114 unsigned short type; 115 unsigned short length; 116 } tAniHdr, tAniMsgHdr; 117 118 /* 119 * This msg hdr will always follow tAniHdr in all the messages exchanged 120 * between the Applications in userspace the Pseudo Driver, in either 121 * direction. 122 */ 123 typedef struct sAniNlMsg { 124 struct nlmsghdr nlh; // Netlink Header 125 int radio; // unit number of the radio 126 tAniHdr wmsg; // Airgo Message Header 127 } tAniNlHdr; 128 129 typedef struct sAniAppRegReq { 130 tAniNlModTypes type; /* The module id that the application is 131 registering for */ 132 int pid; /* Pid returned in the nl_sockaddr structure 133 in the call getsockbyname after the 134 application opens and binds a netlink 135 socket */ 136 } tAniNlAppRegReq; 137 138 typedef struct host_event_hdr_s 139 { 140 u16 event_id; 141 u16 length; 142 } host_event_hdr_t; 143 144 typedef struct fw_event_hdr_s 145 { 146 u16 diag_type; 147 u16 length; 148 } fw_event_hdr_t; 149 150 typedef struct 151 { 152 u32 reserved:24; 153 u32 diag_event_type:8; 154 }__attribute__((packed)) fw_diag_msg_fixed_hdr_t; 155 156 typedef struct 157 { 158 u32 timestamp:24; 159 u32 diag_event_type:8; 160 /* Below 16-bit field has different formats based on event type */ 161 union { 162 u16 payload_len; 163 struct { 164 u8 payload_len; 165 u8 vdev_level:3; 166 u8 vdev_id:5; 167 }__attribute__((packed)) msg_hdr; 168 }__attribute__((packed)) u; 169 u16 diag_id; 170 u8 payload[0]; 171 }__attribute__((packed)) fw_diag_msg_hdr_t; 172 173 typedef struct 174 { 175 u32 unused:24; 176 u32 diag_event_type:8; 177 u32 timestamp; 178 /* Below 16-bit field has different formats based on event type */ 179 union { 180 u16 payload_len; 181 struct { 182 u8 payload_len; 183 u8 vdev_level:3; 184 u8 vdev_id:5; 185 }__attribute__((packed)) msg_hdr; 186 }__attribute__((packed)) u; 187 u16 diag_id; 188 u8 payload[0]; 189 }__attribute__((packed)) fw_diag_msg_hdr_v2_t; 190 191 typedef struct wlan_wake_lock_event { 192 u32 status; 193 u32 reason; 194 u32 timeout; 195 u32 name_len; 196 char name[]; 197 } wlan_wake_lock_event_t; 198 199 enum log_event_type { 200 WLAN_LOG_TYPE_NON_FATAL, 201 WLAN_LOG_TYPE_FATAL, 202 }; 203 204 enum log_event_indicator { 205 WLAN_LOG_INDICATOR_UNUSED, 206 WLAN_LOG_INDICATOR_FRAMEWORK, 207 WLAN_LOG_INDICATOR_HOST_DRIVER, 208 WLAN_LOG_INDICATOR_FIRMWARE, 209 }; 210 211 enum log_event_host_reason_code { 212 WLAN_LOG_REASON_CODE_UNUSED, 213 WLAN_LOG_REASON_COMMAND_UNSUCCESSFUL, 214 WLAN_LOG_REASON_ROAM_FAIL, 215 WLAN_LOG_REASON_THREAD_STUCK, 216 WLAN_LOG_REASON_DATA_STALL, 217 WLAN_LOG_REASON_SME_COMMAND_STUCK, 218 WLAN_LOG_REASON_ZERO_SCAN_RESULTS, 219 WLAN_LOG_REASON_QUEUE_FULL, 220 WLAN_LOG_REASON_POWER_COLLAPSE_FAIL, 221 WLAN_LOG_REASON_SSR_FAIL, 222 WLAN_LOG_REASON_DISCONNECT_FAIL, 223 WLAN_LOG_REASON_CLEAN_UP_FAIL, 224 WLAN_LOG_REASON_MALLOC_FAIL, 225 WLAN_LOG_REASON_VOS_MSG_UNDER_RUN, 226 WLAN_LOG_REASON_MSG_POST_FAIL, 227 }; 228 229 typedef struct { 230 u32 is_fatal; 231 u32 indicator; 232 u32 reason_code; 233 u32 reserved; 234 } wlan_log_complete_event_t; 235 236 wifi_error diag_message_handler(hal_info *info, nl_msg *msg); 237 238 #endif /* __WIFI_HAL_WIFILOGGER_DIAG_H__ */ 239