1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 2 /* 3 * Copyright (C) 2012-2014, 2018-2020 Intel Corporation 4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016-2017 Intel Deutschland GmbH 6 */ 7 #include "api/commands.h" 8 #include "debugfs.h" 9 #include "dbg.h" 10 #include <linux/seq_file.h> 11 12 #define FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype) \ 13 struct dbgfs_##name##_data { \ 14 argtype *arg; \ 15 bool read_done; \ 16 ssize_t rlen; \ 17 char rbuf[buflen]; \ 18 }; \ 19 static int _iwl_dbgfs_##name##_open(struct inode *inode, \ 20 struct file *file) \ 21 { \ 22 struct dbgfs_##name##_data *data; \ 23 \ 24 data = kzalloc(sizeof(*data), GFP_KERNEL); \ 25 if (!data) \ 26 return -ENOMEM; \ 27 \ 28 data->read_done = false; \ 29 data->arg = inode->i_private; \ 30 file->private_data = data; \ 31 \ 32 return 0; \ 33 } 34 35 #define FWRT_DEBUGFS_READ_WRAPPER(name) \ 36 static ssize_t _iwl_dbgfs_##name##_read(struct file *file, \ 37 char __user *user_buf, \ 38 size_t count, loff_t *ppos) \ 39 { \ 40 struct dbgfs_##name##_data *data = file->private_data; \ 41 \ 42 if (!data->read_done) { \ 43 data->read_done = true; \ 44 data->rlen = iwl_dbgfs_##name##_read(data->arg, \ 45 sizeof(data->rbuf),\ 46 data->rbuf); \ 47 } \ 48 \ 49 if (data->rlen < 0) \ 50 return data->rlen; \ 51 return simple_read_from_buffer(user_buf, count, ppos, \ 52 data->rbuf, data->rlen); \ 53 } 54 55 static int _iwl_dbgfs_release(struct inode *inode, struct file *file) 56 { 57 kfree(file->private_data); 58 59 return 0; 60 } 61 62 #define _FWRT_DEBUGFS_READ_FILE_OPS(name, buflen, argtype) \ 63 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype) \ 64 FWRT_DEBUGFS_READ_WRAPPER(name) \ 65 static const struct file_operations iwl_dbgfs_##name##_ops = { \ 66 .read = _iwl_dbgfs_##name##_read, \ 67 .open = _iwl_dbgfs_##name##_open, \ 68 .llseek = generic_file_llseek, \ 69 .release = _iwl_dbgfs_release, \ 70 } 71 72 #define FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype) \ 73 static ssize_t _iwl_dbgfs_##name##_write(struct file *file, \ 74 const char __user *user_buf, \ 75 size_t count, loff_t *ppos) \ 76 { \ 77 argtype *arg = \ 78 ((struct dbgfs_##name##_data *)file->private_data)->arg;\ 79 char buf[buflen] = {}; \ 80 size_t buf_size = min(count, sizeof(buf) - 1); \ 81 \ 82 if (copy_from_user(buf, user_buf, buf_size)) \ 83 return -EFAULT; \ 84 \ 85 return iwl_dbgfs_##name##_write(arg, buf, buf_size); \ 86 } 87 88 #define _FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, buflen, argtype) \ 89 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype) \ 90 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype) \ 91 FWRT_DEBUGFS_READ_WRAPPER(name) \ 92 static const struct file_operations iwl_dbgfs_##name##_ops = { \ 93 .write = _iwl_dbgfs_##name##_write, \ 94 .read = _iwl_dbgfs_##name##_read, \ 95 .open = _iwl_dbgfs_##name##_open, \ 96 .llseek = generic_file_llseek, \ 97 .release = _iwl_dbgfs_release, \ 98 } 99 100 #define _FWRT_DEBUGFS_WRITE_FILE_OPS(name, buflen, argtype) \ 101 FWRT_DEBUGFS_OPEN_WRAPPER(name, buflen, argtype) \ 102 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen, argtype) \ 103 static const struct file_operations iwl_dbgfs_##name##_ops = { \ 104 .write = _iwl_dbgfs_##name##_write, \ 105 .open = _iwl_dbgfs_##name##_open, \ 106 .llseek = generic_file_llseek, \ 107 .release = _iwl_dbgfs_release, \ 108 } 109 110 #define FWRT_DEBUGFS_READ_FILE_OPS(name, bufsz) \ 111 _FWRT_DEBUGFS_READ_FILE_OPS(name, bufsz, struct iwl_fw_runtime) 112 113 #define FWRT_DEBUGFS_WRITE_FILE_OPS(name, bufsz) \ 114 _FWRT_DEBUGFS_WRITE_FILE_OPS(name, bufsz, struct iwl_fw_runtime) 115 116 #define FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, bufsz) \ 117 _FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, bufsz, struct iwl_fw_runtime) 118 119 #define FWRT_DEBUGFS_ADD_FILE_ALIAS(alias, name, parent, mode) do { \ 120 debugfs_create_file(alias, mode, parent, fwrt, \ 121 &iwl_dbgfs_##name##_ops); \ 122 } while (0) 123 #define FWRT_DEBUGFS_ADD_FILE(name, parent, mode) \ 124 FWRT_DEBUGFS_ADD_FILE_ALIAS(#name, name, parent, mode) 125 126 static int iwl_dbgfs_enabled_severities_write(struct iwl_fw_runtime *fwrt, 127 char *buf, size_t count) 128 { 129 struct iwl_dbg_host_event_cfg_cmd event_cfg; 130 struct iwl_host_cmd hcmd = { 131 .id = WIDE_ID(DEBUG_GROUP, HOST_EVENT_CFG), 132 .flags = CMD_ASYNC, 133 .data[0] = &event_cfg, 134 .len[0] = sizeof(event_cfg), 135 }; 136 u32 enabled_severities; 137 int ret = kstrtou32(buf, 10, &enabled_severities); 138 139 if (ret < 0) 140 return ret; 141 142 event_cfg.enabled_severities = cpu_to_le32(enabled_severities); 143 144 ret = iwl_trans_send_cmd(fwrt->trans, &hcmd); 145 IWL_INFO(fwrt, 146 "sent host event cfg with enabled_severities: %u, ret: %d\n", 147 enabled_severities, ret); 148 149 return ret ?: count; 150 } 151 152 FWRT_DEBUGFS_WRITE_FILE_OPS(enabled_severities, 16); 153 154 static void iwl_fw_timestamp_marker_wk(struct work_struct *work) 155 { 156 int ret; 157 struct iwl_fw_runtime *fwrt = 158 container_of(work, struct iwl_fw_runtime, timestamp.wk.work); 159 unsigned long delay = fwrt->timestamp.delay; 160 161 ret = iwl_fw_send_timestamp_marker_cmd(fwrt); 162 if (!ret && delay) 163 schedule_delayed_work(&fwrt->timestamp.wk, 164 round_jiffies_relative(delay)); 165 else 166 IWL_INFO(fwrt, 167 "stopping timestamp_marker, ret: %d, delay: %u\n", 168 ret, jiffies_to_msecs(delay) / 1000); 169 } 170 171 void iwl_fw_trigger_timestamp(struct iwl_fw_runtime *fwrt, u32 delay) 172 { 173 IWL_INFO(fwrt, 174 "starting timestamp_marker trigger with delay: %us\n", 175 delay); 176 177 iwl_fw_cancel_timestamp(fwrt); 178 179 fwrt->timestamp.delay = msecs_to_jiffies(delay * 1000); 180 181 schedule_delayed_work(&fwrt->timestamp.wk, 182 round_jiffies_relative(fwrt->timestamp.delay)); 183 } 184 185 static ssize_t iwl_dbgfs_timestamp_marker_write(struct iwl_fw_runtime *fwrt, 186 char *buf, size_t count) 187 { 188 int ret; 189 u32 delay; 190 191 ret = kstrtou32(buf, 10, &delay); 192 if (ret < 0) 193 return ret; 194 195 iwl_fw_trigger_timestamp(fwrt, delay); 196 197 return count; 198 } 199 200 static ssize_t iwl_dbgfs_timestamp_marker_read(struct iwl_fw_runtime *fwrt, 201 size_t size, char *buf) 202 { 203 u32 delay_secs = jiffies_to_msecs(fwrt->timestamp.delay) / 1000; 204 205 return scnprintf(buf, size, "%d\n", delay_secs); 206 } 207 208 FWRT_DEBUGFS_READ_WRITE_FILE_OPS(timestamp_marker, 16); 209 210 struct hcmd_write_data { 211 __be32 cmd_id; 212 __be32 flags; 213 __be16 length; 214 u8 data[]; 215 } __packed; 216 217 static ssize_t iwl_dbgfs_send_hcmd_write(struct iwl_fw_runtime *fwrt, char *buf, 218 size_t count) 219 { 220 size_t header_size = (sizeof(u32) * 2 + sizeof(u16)) * 2; 221 size_t data_size = (count - 1) / 2; 222 int ret; 223 struct hcmd_write_data *data; 224 struct iwl_host_cmd hcmd = { 225 .len = { 0, }, 226 .data = { NULL, }, 227 }; 228 229 if (fwrt->ops && fwrt->ops->fw_running && 230 !fwrt->ops->fw_running(fwrt->ops_ctx)) 231 return -EIO; 232 233 if (count < header_size + 1 || count > 1024 * 4) 234 return -EINVAL; 235 236 data = kmalloc(data_size, GFP_KERNEL); 237 if (!data) 238 return -ENOMEM; 239 240 ret = hex2bin((u8 *)data, buf, data_size); 241 if (ret) 242 goto out; 243 244 hcmd.id = be32_to_cpu(data->cmd_id); 245 hcmd.flags = be32_to_cpu(data->flags); 246 hcmd.len[0] = be16_to_cpu(data->length); 247 hcmd.data[0] = data->data; 248 249 if (count != header_size + hcmd.len[0] * 2 + 1) { 250 IWL_ERR(fwrt, 251 "host command data size does not match header length\n"); 252 ret = -EINVAL; 253 goto out; 254 } 255 256 if (fwrt->ops && fwrt->ops->send_hcmd) 257 ret = fwrt->ops->send_hcmd(fwrt->ops_ctx, &hcmd); 258 else 259 ret = -EPERM; 260 261 if (ret < 0) 262 goto out; 263 264 if (hcmd.flags & CMD_WANT_SKB) 265 iwl_free_resp(&hcmd); 266 out: 267 kfree(data); 268 return ret ?: count; 269 } 270 271 FWRT_DEBUGFS_WRITE_FILE_OPS(send_hcmd, 512); 272 273 static ssize_t iwl_dbgfs_fw_dbg_domain_read(struct iwl_fw_runtime *fwrt, 274 size_t size, char *buf) 275 { 276 return scnprintf(buf, size, "0x%08x\n", 277 fwrt->trans->dbg.domains_bitmap); 278 } 279 280 FWRT_DEBUGFS_READ_FILE_OPS(fw_dbg_domain, 20); 281 282 struct iwl_dbgfs_fw_info_priv { 283 struct iwl_fw_runtime *fwrt; 284 }; 285 286 struct iwl_dbgfs_fw_info_state { 287 loff_t pos; 288 }; 289 290 static void *iwl_dbgfs_fw_info_seq_next(struct seq_file *seq, 291 void *v, loff_t *pos) 292 { 293 struct iwl_dbgfs_fw_info_state *state = v; 294 struct iwl_dbgfs_fw_info_priv *priv = seq->private; 295 const struct iwl_fw *fw = priv->fwrt->fw; 296 297 *pos = ++state->pos; 298 if (*pos >= fw->ucode_capa.n_cmd_versions) { 299 kfree(state); 300 return NULL; 301 } 302 303 return state; 304 } 305 306 static void iwl_dbgfs_fw_info_seq_stop(struct seq_file *seq, 307 void *v) 308 { 309 kfree(v); 310 } 311 312 static void *iwl_dbgfs_fw_info_seq_start(struct seq_file *seq, loff_t *pos) 313 { 314 struct iwl_dbgfs_fw_info_priv *priv = seq->private; 315 const struct iwl_fw *fw = priv->fwrt->fw; 316 struct iwl_dbgfs_fw_info_state *state; 317 318 if (*pos >= fw->ucode_capa.n_cmd_versions) 319 return NULL; 320 321 state = kzalloc(sizeof(*state), GFP_KERNEL); 322 if (!state) 323 return NULL; 324 state->pos = *pos; 325 return state; 326 }; 327 328 static int iwl_dbgfs_fw_info_seq_show(struct seq_file *seq, void *v) 329 { 330 struct iwl_dbgfs_fw_info_state *state = v; 331 struct iwl_dbgfs_fw_info_priv *priv = seq->private; 332 const struct iwl_fw *fw = priv->fwrt->fw; 333 const struct iwl_fw_cmd_version *ver; 334 u32 cmd_id; 335 int has_capa; 336 337 if (!state->pos) { 338 seq_puts(seq, "fw_capa:\n"); 339 has_capa = fw_has_capa(&fw->ucode_capa, 340 IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT) ? 1 : 0; 341 seq_printf(seq, 342 " %d: %d\n", 343 IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT, 344 has_capa); 345 seq_puts(seq, "fw_api_ver:\n"); 346 } 347 348 ver = &fw->ucode_capa.cmd_versions[state->pos]; 349 350 cmd_id = WIDE_ID(ver->group, ver->cmd); 351 352 seq_printf(seq, " 0x%04x:\n", cmd_id); 353 seq_printf(seq, " name: %s\n", 354 iwl_get_cmd_string(priv->fwrt->trans, cmd_id)); 355 seq_printf(seq, " cmd_ver: %d\n", ver->cmd_ver); 356 seq_printf(seq, " notif_ver: %d\n", ver->notif_ver); 357 return 0; 358 } 359 360 static const struct seq_operations iwl_dbgfs_info_seq_ops = { 361 .start = iwl_dbgfs_fw_info_seq_start, 362 .next = iwl_dbgfs_fw_info_seq_next, 363 .stop = iwl_dbgfs_fw_info_seq_stop, 364 .show = iwl_dbgfs_fw_info_seq_show, 365 }; 366 367 static int iwl_dbgfs_fw_info_open(struct inode *inode, struct file *filp) 368 { 369 struct iwl_dbgfs_fw_info_priv *priv; 370 371 priv = __seq_open_private(filp, &iwl_dbgfs_info_seq_ops, 372 sizeof(*priv)); 373 374 if (!priv) 375 return -ENOMEM; 376 377 priv->fwrt = inode->i_private; 378 return 0; 379 } 380 381 static const struct file_operations iwl_dbgfs_fw_info_ops = { 382 .owner = THIS_MODULE, 383 .open = iwl_dbgfs_fw_info_open, 384 .read = seq_read, 385 .llseek = seq_lseek, 386 .release = seq_release_private, 387 }; 388 389 void iwl_fwrt_dbgfs_register(struct iwl_fw_runtime *fwrt, 390 struct dentry *dbgfs_dir) 391 { 392 INIT_DELAYED_WORK(&fwrt->timestamp.wk, iwl_fw_timestamp_marker_wk); 393 FWRT_DEBUGFS_ADD_FILE(timestamp_marker, dbgfs_dir, 0200); 394 FWRT_DEBUGFS_ADD_FILE(fw_info, dbgfs_dir, 0200); 395 FWRT_DEBUGFS_ADD_FILE(send_hcmd, dbgfs_dir, 0200); 396 FWRT_DEBUGFS_ADD_FILE(enabled_severities, dbgfs_dir, 0200); 397 FWRT_DEBUGFS_ADD_FILE(fw_dbg_domain, dbgfs_dir, 0400); 398 } 399