Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
0002 /*
0003  * Copyright (C) 2012-2014, 2018-2020 Intel Corporation
0004  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
0005  * Copyright (C) 2016-2017 Intel Deutschland GmbH
0006  */
0007 #include "api/commands.h"
0008 #include "debugfs.h"
0009 #include "dbg.h"
0010 #include <linux/seq_file.h>
0011 
0012 #define FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype)        \
0013 struct dbgfs_##name##_data {                        \
0014     argtype *arg;                           \
0015     bool read_done;                         \
0016     ssize_t rlen;                           \
0017     char rbuf[buflen];                      \
0018 };                                  \
0019 static int _iwl_dbgfs_##name##_open(struct inode *inode,        \
0020                     struct file *file)          \
0021 {                                   \
0022     struct dbgfs_##name##_data *data;               \
0023                                     \
0024     data = kzalloc(sizeof(*data), GFP_KERNEL);          \
0025     if (!data)                          \
0026         return -ENOMEM;                     \
0027                                     \
0028     data->read_done = false;                    \
0029     data->arg = inode->i_private;                   \
0030     file->private_data = data;                  \
0031                                     \
0032     return 0;                           \
0033 }
0034 
0035 #define FWRT_DEBUGFS_READ_WRAPPER(name)                 \
0036 static ssize_t _iwl_dbgfs_##name##_read(struct file *file,      \
0037                     char __user *user_buf,      \
0038                     size_t count, loff_t *ppos) \
0039 {                                   \
0040     struct dbgfs_##name##_data *data = file->private_data;      \
0041                                     \
0042     if (!data->read_done) {                     \
0043         data->read_done = true;                 \
0044         data->rlen = iwl_dbgfs_##name##_read(data->arg,     \
0045                              sizeof(data->rbuf),\
0046                              data->rbuf);   \
0047     }                               \
0048                                     \
0049     if (data->rlen < 0)                     \
0050         return data->rlen;                  \
0051     return simple_read_from_buffer(user_buf, count, ppos,       \
0052                        data->rbuf, data->rlen);     \
0053 }
0054 
0055 static int _iwl_dbgfs_release(struct inode *inode, struct file *file)
0056 {
0057     kfree(file->private_data);
0058 
0059     return 0;
0060 }
0061 
0062 #define _FWRT_DEBUGFS_READ_FILE_OPS(name, buflen, argtype)      \
0063 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype)            \
0064 FWRT_DEBUGFS_READ_WRAPPER(name)                     \
0065 static const struct file_operations iwl_dbgfs_##name##_ops = {      \
0066     .read = _iwl_dbgfs_##name##_read,               \
0067     .open = _iwl_dbgfs_##name##_open,               \
0068     .llseek = generic_file_llseek,                  \
0069     .release = _iwl_dbgfs_release,                  \
0070 }
0071 
0072 #define FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype)       \
0073 static ssize_t _iwl_dbgfs_##name##_write(struct file *file,     \
0074                      const char __user *user_buf,   \
0075                      size_t count, loff_t *ppos)    \
0076 {                                   \
0077     argtype *arg =                          \
0078         ((struct dbgfs_##name##_data *)file->private_data)->arg;\
0079     char buf[buflen] = {};                      \
0080     size_t buf_size = min(count, sizeof(buf) -  1);         \
0081                                     \
0082     if (copy_from_user(buf, user_buf, buf_size))            \
0083         return -EFAULT;                     \
0084                                     \
0085     return iwl_dbgfs_##name##_write(arg, buf, buf_size);        \
0086 }
0087 
0088 #define _FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, buflen, argtype)    \
0089 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype)            \
0090 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype)           \
0091 FWRT_DEBUGFS_READ_WRAPPER(name)                     \
0092 static const struct file_operations iwl_dbgfs_##name##_ops = {      \
0093     .write = _iwl_dbgfs_##name##_write,             \
0094     .read = _iwl_dbgfs_##name##_read,               \
0095     .open = _iwl_dbgfs_##name##_open,               \
0096     .llseek = generic_file_llseek,                  \
0097     .release = _iwl_dbgfs_release,                  \
0098 }
0099 
0100 #define _FWRT_DEBUGFS_WRITE_FILE_OPS(name, buflen, argtype)     \
0101 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype)            \
0102 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype)           \
0103 static const struct file_operations iwl_dbgfs_##name##_ops = {      \
0104     .write = _iwl_dbgfs_##name##_write,             \
0105     .open = _iwl_dbgfs_##name##_open,               \
0106     .llseek = generic_file_llseek,                  \
0107     .release = _iwl_dbgfs_release,                  \
0108 }
0109 
0110 #define FWRT_DEBUGFS_READ_FILE_OPS(name, bufsz)             \
0111     _FWRT_DEBUGFS_READ_FILE_OPS(name, bufsz, struct iwl_fw_runtime)
0112 
0113 #define FWRT_DEBUGFS_WRITE_FILE_OPS(name, bufsz)            \
0114     _FWRT_DEBUGFS_WRITE_FILE_OPS(name, bufsz, struct iwl_fw_runtime)
0115 
0116 #define FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, bufsz)           \
0117     _FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, bufsz, struct iwl_fw_runtime)
0118 
0119 #define FWRT_DEBUGFS_ADD_FILE_ALIAS(alias, name, parent, mode) do { \
0120     debugfs_create_file(alias, mode, parent, fwrt,          \
0121                 &iwl_dbgfs_##name##_ops);           \
0122     } while (0)
0123 #define FWRT_DEBUGFS_ADD_FILE(name, parent, mode) \
0124     FWRT_DEBUGFS_ADD_FILE_ALIAS(#name, name, parent, mode)
0125 
0126 static int iwl_fw_send_timestamp_marker_cmd(struct iwl_fw_runtime *fwrt)
0127 {
0128     struct iwl_mvm_marker marker = {
0129         .dw_len = sizeof(struct iwl_mvm_marker) / 4,
0130         .marker_id = MARKER_ID_SYNC_CLOCK,
0131 
0132         /* the real timestamp is taken from the ftrace clock
0133          * this is for finding the match between fw and kernel logs
0134          */
0135         .timestamp = cpu_to_le64(fwrt->timestamp.seq++),
0136     };
0137 
0138     struct iwl_host_cmd hcmd = {
0139         .id = MARKER_CMD,
0140         .flags = CMD_ASYNC,
0141         .data[0] = &marker,
0142         .len[0] = sizeof(marker),
0143     };
0144 
0145     return iwl_trans_send_cmd(fwrt->trans, &hcmd);
0146 }
0147 
0148 static int iwl_dbgfs_enabled_severities_write(struct iwl_fw_runtime *fwrt,
0149                           char *buf, size_t count)
0150 {
0151     struct iwl_dbg_host_event_cfg_cmd event_cfg;
0152     struct iwl_host_cmd hcmd = {
0153         .id = WIDE_ID(DEBUG_GROUP, HOST_EVENT_CFG),
0154         .flags = CMD_ASYNC,
0155         .data[0] = &event_cfg,
0156         .len[0] = sizeof(event_cfg),
0157     };
0158     u32 enabled_severities;
0159     int ret = kstrtou32(buf, 10, &enabled_severities);
0160 
0161     if (ret < 0)
0162         return ret;
0163 
0164     event_cfg.enabled_severities = cpu_to_le32(enabled_severities);
0165 
0166     ret = iwl_trans_send_cmd(fwrt->trans, &hcmd);
0167     IWL_INFO(fwrt,
0168          "sent host event cfg with enabled_severities: %u, ret: %d\n",
0169          enabled_severities, ret);
0170 
0171     return ret ?: count;
0172 }
0173 
0174 FWRT_DEBUGFS_WRITE_FILE_OPS(enabled_severities, 16);
0175 
0176 static void iwl_fw_timestamp_marker_wk(struct work_struct *work)
0177 {
0178     int ret;
0179     struct iwl_fw_runtime *fwrt =
0180         container_of(work, struct iwl_fw_runtime, timestamp.wk.work);
0181     unsigned long delay = fwrt->timestamp.delay;
0182 
0183     ret = iwl_fw_send_timestamp_marker_cmd(fwrt);
0184     if (!ret && delay)
0185         schedule_delayed_work(&fwrt->timestamp.wk,
0186                       round_jiffies_relative(delay));
0187     else
0188         IWL_INFO(fwrt,
0189              "stopping timestamp_marker, ret: %d, delay: %u\n",
0190              ret, jiffies_to_msecs(delay) / 1000);
0191 }
0192 
0193 void iwl_fw_trigger_timestamp(struct iwl_fw_runtime *fwrt, u32 delay)
0194 {
0195     IWL_INFO(fwrt,
0196          "starting timestamp_marker trigger with delay: %us\n",
0197          delay);
0198 
0199     iwl_fw_cancel_timestamp(fwrt);
0200 
0201     fwrt->timestamp.delay = msecs_to_jiffies(delay * 1000);
0202 
0203     schedule_delayed_work(&fwrt->timestamp.wk,
0204                   round_jiffies_relative(fwrt->timestamp.delay));
0205 }
0206 
0207 static ssize_t iwl_dbgfs_timestamp_marker_write(struct iwl_fw_runtime *fwrt,
0208                         char *buf, size_t count)
0209 {
0210     int ret;
0211     u32 delay;
0212 
0213     ret = kstrtou32(buf, 10, &delay);
0214     if (ret < 0)
0215         return ret;
0216 
0217     iwl_fw_trigger_timestamp(fwrt, delay);
0218 
0219     return count;
0220 }
0221 
0222 static ssize_t iwl_dbgfs_timestamp_marker_read(struct iwl_fw_runtime *fwrt,
0223                            size_t size, char *buf)
0224 {
0225     u32 delay_secs = jiffies_to_msecs(fwrt->timestamp.delay) / 1000;
0226 
0227     return scnprintf(buf, size, "%d\n", delay_secs);
0228 }
0229 
0230 FWRT_DEBUGFS_READ_WRITE_FILE_OPS(timestamp_marker, 16);
0231 
0232 struct hcmd_write_data {
0233     __be32 cmd_id;
0234     __be32 flags;
0235     __be16 length;
0236     u8 data[];
0237 } __packed;
0238 
0239 static ssize_t iwl_dbgfs_send_hcmd_write(struct iwl_fw_runtime *fwrt, char *buf,
0240                      size_t count)
0241 {
0242     size_t header_size = (sizeof(u32) * 2 + sizeof(u16)) * 2;
0243     size_t data_size = (count - 1) / 2;
0244     int ret;
0245     struct hcmd_write_data *data;
0246     struct iwl_host_cmd hcmd = {
0247         .len = { 0, },
0248         .data = { NULL, },
0249     };
0250 
0251     if (fwrt->ops && fwrt->ops->fw_running &&
0252         !fwrt->ops->fw_running(fwrt->ops_ctx))
0253         return -EIO;
0254 
0255     if (count < header_size + 1 || count > 1024 * 4)
0256         return -EINVAL;
0257 
0258     data = kmalloc(data_size, GFP_KERNEL);
0259     if (!data)
0260         return -ENOMEM;
0261 
0262     ret = hex2bin((u8 *)data, buf, data_size);
0263     if (ret)
0264         goto out;
0265 
0266     hcmd.id = be32_to_cpu(data->cmd_id);
0267     hcmd.flags = be32_to_cpu(data->flags);
0268     hcmd.len[0] = be16_to_cpu(data->length);
0269     hcmd.data[0] = data->data;
0270 
0271     if (count != header_size + hcmd.len[0] * 2 + 1) {
0272         IWL_ERR(fwrt,
0273             "host command data size does not match header length\n");
0274         ret = -EINVAL;
0275         goto out;
0276     }
0277 
0278     if (fwrt->ops && fwrt->ops->send_hcmd)
0279         ret = fwrt->ops->send_hcmd(fwrt->ops_ctx, &hcmd);
0280     else
0281         ret = -EPERM;
0282 
0283     if (ret < 0)
0284         goto out;
0285 
0286     if (hcmd.flags & CMD_WANT_SKB)
0287         iwl_free_resp(&hcmd);
0288 out:
0289     kfree(data);
0290     return ret ?: count;
0291 }
0292 
0293 FWRT_DEBUGFS_WRITE_FILE_OPS(send_hcmd, 512);
0294 
0295 static ssize_t iwl_dbgfs_fw_dbg_domain_read(struct iwl_fw_runtime *fwrt,
0296                         size_t size, char *buf)
0297 {
0298     return scnprintf(buf, size, "0x%08x\n",
0299              fwrt->trans->dbg.domains_bitmap);
0300 }
0301 
0302 FWRT_DEBUGFS_READ_FILE_OPS(fw_dbg_domain, 20);
0303 
0304 struct iwl_dbgfs_fw_info_priv {
0305     struct iwl_fw_runtime *fwrt;
0306 };
0307 
0308 struct iwl_dbgfs_fw_info_state {
0309     loff_t pos;
0310 };
0311 
0312 static void *iwl_dbgfs_fw_info_seq_next(struct seq_file *seq,
0313                     void *v, loff_t *pos)
0314 {
0315     struct iwl_dbgfs_fw_info_state *state = v;
0316     struct iwl_dbgfs_fw_info_priv *priv = seq->private;
0317     const struct iwl_fw *fw = priv->fwrt->fw;
0318 
0319     *pos = ++state->pos;
0320     if (*pos >= fw->ucode_capa.n_cmd_versions)
0321         return NULL;
0322 
0323     return state;
0324 }
0325 
0326 static void iwl_dbgfs_fw_info_seq_stop(struct seq_file *seq,
0327                        void *v)
0328 {
0329     kfree(v);
0330 }
0331 
0332 static void *iwl_dbgfs_fw_info_seq_start(struct seq_file *seq, loff_t *pos)
0333 {
0334     struct iwl_dbgfs_fw_info_priv *priv = seq->private;
0335     const struct iwl_fw *fw = priv->fwrt->fw;
0336     struct iwl_dbgfs_fw_info_state *state;
0337 
0338     if (*pos >= fw->ucode_capa.n_cmd_versions)
0339         return NULL;
0340 
0341     state = kzalloc(sizeof(*state), GFP_KERNEL);
0342     if (!state)
0343         return NULL;
0344     state->pos = *pos;
0345     return state;
0346 };
0347 
0348 static int iwl_dbgfs_fw_info_seq_show(struct seq_file *seq, void *v)
0349 {
0350     struct iwl_dbgfs_fw_info_state *state = v;
0351     struct iwl_dbgfs_fw_info_priv *priv = seq->private;
0352     const struct iwl_fw *fw = priv->fwrt->fw;
0353     const struct iwl_fw_cmd_version *ver;
0354     u32 cmd_id;
0355 
0356     if (!state->pos)
0357         seq_puts(seq, "fw_api_ver:\n");
0358 
0359     ver = &fw->ucode_capa.cmd_versions[state->pos];
0360 
0361     cmd_id = WIDE_ID(ver->group, ver->cmd);
0362 
0363     seq_printf(seq, "  0x%04x:\n", cmd_id);
0364     seq_printf(seq, "    name: %s\n",
0365            iwl_get_cmd_string(priv->fwrt->trans, cmd_id));
0366     seq_printf(seq, "    cmd_ver: %d\n", ver->cmd_ver);
0367     seq_printf(seq, "    notif_ver: %d\n", ver->notif_ver);
0368     return 0;
0369 }
0370 
0371 static const struct seq_operations iwl_dbgfs_info_seq_ops = {
0372     .start = iwl_dbgfs_fw_info_seq_start,
0373     .next = iwl_dbgfs_fw_info_seq_next,
0374     .stop = iwl_dbgfs_fw_info_seq_stop,
0375     .show = iwl_dbgfs_fw_info_seq_show,
0376 };
0377 
0378 static int iwl_dbgfs_fw_info_open(struct inode *inode, struct file *filp)
0379 {
0380     struct iwl_dbgfs_fw_info_priv *priv;
0381 
0382     priv = __seq_open_private(filp, &iwl_dbgfs_info_seq_ops,
0383                   sizeof(*priv));
0384 
0385     if (!priv)
0386         return -ENOMEM;
0387 
0388     priv->fwrt = inode->i_private;
0389     return 0;
0390 }
0391 
0392 static const struct file_operations iwl_dbgfs_fw_info_ops = {
0393     .owner = THIS_MODULE,
0394     .open = iwl_dbgfs_fw_info_open,
0395     .read = seq_read,
0396     .llseek = seq_lseek,
0397     .release = seq_release_private,
0398 };
0399 
0400 void iwl_fwrt_dbgfs_register(struct iwl_fw_runtime *fwrt,
0401                 struct dentry *dbgfs_dir)
0402 {
0403     INIT_DELAYED_WORK(&fwrt->timestamp.wk, iwl_fw_timestamp_marker_wk);
0404     FWRT_DEBUGFS_ADD_FILE(timestamp_marker, dbgfs_dir, 0200);
0405     FWRT_DEBUGFS_ADD_FILE(fw_info, dbgfs_dir, 0200);
0406     FWRT_DEBUGFS_ADD_FILE(send_hcmd, dbgfs_dir, 0200);
0407     FWRT_DEBUGFS_ADD_FILE(enabled_severities, dbgfs_dir, 0200);
0408     FWRT_DEBUGFS_ADD_FILE(fw_dbg_domain, dbgfs_dir, 0400);
0409 }