drivers/net/wireless/intel/iwlwifi/fw/dbg.h

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  10  * Copyright(c) 2015 - 2017 Intel Deutschland GmbH
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program;
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <linuxwifi@intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  34  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  35  * Copyright(c) 2015 - 2017 Intel Deutschland GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  *****************************************************************************/
  65
  66 #ifndef __iwl_fw_dbg_h__
  67 #define __iwl_fw_dbg_h__
  68 #include <linux/workqueue.h>
  69 #include <net/cfg80211.h>
  70 #include "runtime.h"
  71 #include "file.h"
  72 #include "error-dump.h"
  73
  74 /**
  75  * struct iwl_fw_dump_desc - describes the dump
  76  * @len: length of trig_desc->data
  77  * @trig_desc: the description of the dump
  78  */
  79 struct iwl_fw_dump_desc {
  80         size_t len;
  81         /* must be last */
  82         struct iwl_fw_error_dump_trigger_desc trig_desc;
  83 };
  84
  85 extern const struct iwl_fw_dump_desc iwl_dump_desc_assert;
  86
  87 static inline void iwl_fw_free_dump_desc(struct iwl_fw_runtime *fwrt)
  88 {
  89         if (fwrt->dump.desc != &iwl_dump_desc_assert)
  90                 kfree(fwrt->dump.desc);
  91         fwrt->dump.desc = NULL;
  92 }
  93
  94 void iwl_fw_error_dump(struct iwl_fw_runtime *fwrt);
  95 int iwl_fw_dbg_collect_desc(struct iwl_fw_runtime *fwrt,
  96                             const struct iwl_fw_dump_desc *desc,
  97                             const struct iwl_fw_dbg_trigger_tlv *trigger);
  98 int iwl_fw_dbg_collect(struct iwl_fw_runtime *fwrt,
  99                        enum iwl_fw_dbg_trigger trig,
 100                        const char *str, size_t len,
 101                        const struct iwl_fw_dbg_trigger_tlv *trigger);
 102 int iwl_fw_dbg_collect_trig(struct iwl_fw_runtime *fwrt,
 103                             struct iwl_fw_dbg_trigger_tlv *trigger,
 104                             const char *fmt, ...) __printf(3, 4);
 105 int iwl_fw_start_dbg_conf(struct iwl_fw_runtime *fwrt, u8 id);
 106
 107 #define iwl_fw_dbg_trigger_enabled(fw, id) ({                   \
 108         void *__dbg_trigger = (fw)->dbg_trigger_tlv[(id)];      \
 109         unlikely(__dbg_trigger);                                \
 110 })
 111
 112 static inline struct iwl_fw_dbg_trigger_tlv*
 113 _iwl_fw_dbg_get_trigger(const struct iwl_fw *fw, enum iwl_fw_dbg_trigger id)
 114 {
 115         return fw->dbg_trigger_tlv[id];
 116 }
 117
 118 #define iwl_fw_dbg_get_trigger(fw, id) ({                       \
 119         BUILD_BUG_ON(!__builtin_constant_p(id));                \
 120         BUILD_BUG_ON((id) >= FW_DBG_TRIGGER_MAX);               \
 121         _iwl_fw_dbg_get_trigger((fw), (id));                    \
 122 })
 123
 124 static inline bool
 125 iwl_fw_dbg_trigger_vif_match(struct iwl_fw_dbg_trigger_tlv *trig,
 126                              struct wireless_dev *wdev)
 127 {
 128         u32 trig_vif = le32_to_cpu(trig->vif_type);
 129
 130         return trig_vif == IWL_FW_DBG_CONF_VIF_ANY ||
 131                wdev->iftype == trig_vif;
 132 }
 133
 134 static inline bool
 135 iwl_fw_dbg_trigger_stop_conf_match(struct iwl_fw_runtime *fwrt,
 136                                    struct iwl_fw_dbg_trigger_tlv *trig)
 137 {
 138         return ((trig->mode & IWL_FW_DBG_TRIGGER_STOP) &&
 139                 (fwrt->dump.conf == FW_DBG_INVALID ||
 140                 (BIT(fwrt->dump.conf) & le32_to_cpu(trig->stop_conf_ids))));
 141 }
 142
 143 static inline bool
 144 iwl_fw_dbg_no_trig_window(struct iwl_fw_runtime *fwrt,
 145                           struct iwl_fw_dbg_trigger_tlv *trig)
 146 {
 147         unsigned long wind_jiff =
 148                 msecs_to_jiffies(le16_to_cpu(trig->trig_dis_ms));
 149         u32 id = le32_to_cpu(trig->id);
 150
 151         /* If this is the first event checked, jump to update start ts */
 152         if (fwrt->dump.non_collect_ts_start[id] &&
 153             (time_after(fwrt->dump.non_collect_ts_start[id] + wind_jiff,
 154                         jiffies)))
 155                 return true;
 156
 157         fwrt->dump.non_collect_ts_start[id] = jiffies;
 158         return false;
 159 }
 160
 161 static inline bool
 162 iwl_fw_dbg_trigger_check_stop(struct iwl_fw_runtime *fwrt,
 163                               struct wireless_dev *wdev,
 164                               struct iwl_fw_dbg_trigger_tlv *trig)
 165 {
 166         if (wdev && !iwl_fw_dbg_trigger_vif_match(trig, wdev))
 167                 return false;
 168
 169         if (iwl_fw_dbg_no_trig_window(fwrt, trig)) {
 170                 IWL_WARN(fwrt, "Trigger %d occurred while no-collect window.\n",
 171                          trig->id);
 172                 return false;
 173         }
 174
 175         return iwl_fw_dbg_trigger_stop_conf_match(fwrt, trig);
 176 }
 177
 178 static inline void
 179 _iwl_fw_dbg_trigger_simple_stop(struct iwl_fw_runtime *fwrt,
 180                                 struct wireless_dev *wdev,
 181                                 struct iwl_fw_dbg_trigger_tlv *trigger)
 182 {
 183         if (!trigger)
 184                 return;
 185
 186         if (!iwl_fw_dbg_trigger_check_stop(fwrt, wdev, trigger))
 187                 return;
 188
 189         iwl_fw_dbg_collect_trig(fwrt, trigger, NULL);
 190 }
 191
 192 #define iwl_fw_dbg_trigger_simple_stop(fwrt, wdev, trig)        \
 193         _iwl_fw_dbg_trigger_simple_stop((fwrt), (wdev),         \
 194                                         iwl_fw_dbg_get_trigger((fwrt)->fw,\
 195                                                                (trig)))
 196
 197 static inline void iwl_fw_dump_conf_clear(struct iwl_fw_runtime *fwrt)
 198 {
 199         fwrt->dump.conf = FW_DBG_INVALID;
 200 }
 201
 202 void iwl_fw_error_dump_wk(struct work_struct *work);
 203
 204 static inline void iwl_fw_flush_dump(struct iwl_fw_runtime *fwrt)
 205 {
 206         flush_delayed_work(&fwrt->dump.wk);
 207 }
 208
 209 static inline void iwl_fw_cancel_dump(struct iwl_fw_runtime *fwrt)
 210 {
 211         cancel_delayed_work_sync(&fwrt->dump.wk);
 212 }
 213
 214 #endif  /* __iwl_fw_dbg_h__ */