net/mac80211/debugfs.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * mac80211 debugfs for wireless PHYs
   4  *
   5  * Copyright 2007       Johannes Berg <johannes@sipsolutions.net>
   6  * Copyright 2013-2014  Intel Mobile Communications GmbH
   7  * Copyright (C) 2018 - 2019 Intel Corporation
   8  */
   9
  10 #include <linux/debugfs.h>
  11 #include <linux/rtnetlink.h>
  12 #include <linux/vmalloc.h>
  13 #include "ieee80211_i.h"
  14 #include "driver-ops.h"
  15 #include "rate.h"
  16 #include "debugfs.h"
  17
  18 #define DEBUGFS_FORMAT_BUFFER_SIZE 100
  19
  20 int mac80211_format_buffer(char __user *userbuf, size_t count,
  21                                   loff_t *ppos, char *fmt, ...)
  22 {
  23         va_list args;
  24         char buf[DEBUGFS_FORMAT_BUFFER_SIZE];
  25         int res;
  26
  27         va_start(args, fmt);
  28         res = vscnprintf(buf, sizeof(buf), fmt, args);
  29         va_end(args);
  30
  31         return simple_read_from_buffer(userbuf, count, ppos, buf, res);
  32 }
  33
  34 #define DEBUGFS_READONLY_FILE_FN(name, fmt, value...)                   \
  35 static ssize_t name## _read(struct file *file, char __user *userbuf,    \
  36                             size_t count, loff_t *ppos)                 \
  37 {                                                                       \
  38         struct ieee80211_local *local = file->private_data;             \
  39                                                                         \
  40         return mac80211_format_buffer(userbuf, count, ppos,             \
  41                                       fmt "\n", ##value);               \
  42 }
  43
  44 #define DEBUGFS_READONLY_FILE_OPS(name)                 \
  45 static const struct file_operations name## _ops = {                     \
  46         .read = name## _read,                                           \
  47         .open = simple_open,                                            \
  48         .llseek = generic_file_llseek,                                  \
  49 };
  50
  51 #define DEBUGFS_READONLY_FILE(name, fmt, value...)              \
  52         DEBUGFS_READONLY_FILE_FN(name, fmt, value)              \
  53         DEBUGFS_READONLY_FILE_OPS(name)
  54
  55 #define DEBUGFS_ADD(name)                                               \
  56         debugfs_create_file(#name, 0400, phyd, local, &name## _ops);
  57
  58 #define DEBUGFS_ADD_MODE(name, mode)                                    \
  59         debugfs_create_file(#name, mode, phyd, local, &name## _ops);
  60
  61
  62 DEBUGFS_READONLY_FILE(hw_conf, "%x",
  63                       local->hw.conf.flags);
  64 DEBUGFS_READONLY_FILE(user_power, "%d",
  65                       local->user_power_level);
  66 DEBUGFS_READONLY_FILE(power, "%d",
  67                       local->hw.conf.power_level);
  68 DEBUGFS_READONLY_FILE(total_ps_buffered, "%d",
  69                       local->total_ps_buffered);
  70 DEBUGFS_READONLY_FILE(wep_iv, "%#08x",
  71                       local->wep_iv & 0xffffff);
  72 DEBUGFS_READONLY_FILE(rate_ctrl_alg, "%s",
  73         local->rate_ctrl ? local->rate_ctrl->ops->name : "hw/driver");
  74
  75 static ssize_t aqm_read(struct file *file,
  76                         char __user *user_buf,
  77                         size_t count,
  78                         loff_t *ppos)
  79 {
  80         struct ieee80211_local *local = file->private_data;
  81         struct fq *fq = &local->fq;
  82         char buf[200];
  83         int len = 0;
  84
  85         spin_lock_bh(&local->fq.lock);
  86         rcu_read_lock();
  87
  88         len = scnprintf(buf, sizeof(buf),
  89                         "access name value\n"
  90                         "R fq_flows_cnt %u\n"
  91                         "R fq_backlog %u\n"
  92                         "R fq_overlimit %u\n"
  93                         "R fq_overmemory %u\n"
  94                         "R fq_collisions %u\n"
  95                         "R fq_memory_usage %u\n"
  96                         "RW fq_memory_limit %u\n"
  97                         "RW fq_limit %u\n"
  98                         "RW fq_quantum %u\n",
  99                         fq->flows_cnt,
 100                         fq->backlog,
 101                         fq->overmemory,
 102                         fq->overlimit,
 103                         fq->collisions,
 104                         fq->memory_usage,
 105                         fq->memory_limit,
 106                         fq->limit,
 107                         fq->quantum);
 108
 109         rcu_read_unlock();
 110         spin_unlock_bh(&local->fq.lock);
 111
 112         return simple_read_from_buffer(user_buf, count, ppos,
 113                                        buf, len);
 114 }
 115
 116 static ssize_t aqm_write(struct file *file,
 117                          const char __user *user_buf,
 118                          size_t count,
 119                          loff_t *ppos)
 120 {
 121         struct ieee80211_local *local = file->private_data;
 122         char buf[100];
 123         size_t len;
 124
 125         if (count > sizeof(buf))
 126                 return -EINVAL;
 127
 128         if (copy_from_user(buf, user_buf, count))
 129                 return -EFAULT;
 130
 131         buf[sizeof(buf) - 1] = '\0';
 132         len = strlen(buf);
 133         if (len > 0 && buf[len-1] == '\n')
 134                 buf[len-1] = 0;
 135
 136         if (sscanf(buf, "fq_limit %u", &local->fq.limit) == 1)
 137                 return count;
 138         else if (sscanf(buf, "fq_memory_limit %u", &local->fq.memory_limit) == 1)
 139                 return count;
 140         else if (sscanf(buf, "fq_quantum %u", &local->fq.quantum) == 1)
 141                 return count;
 142
 143         return -EINVAL;
 144 }
 145
 146 static const struct file_operations aqm_ops = {
 147         .write = aqm_write,
 148         .read = aqm_read,
 149         .open = simple_open,
 150         .llseek = default_llseek,
 151 };
 152
 153 static ssize_t aql_txq_limit_read(struct file *file,
 154                                   char __user *user_buf,
 155                                   size_t count,
 156                                   loff_t *ppos)
 157 {
 158         struct ieee80211_local *local = file->private_data;
 159         char buf[400];
 160         int len = 0;
 161
 162         len = scnprintf(buf, sizeof(buf),
 163                         "AC     AQL limit low   AQL limit high\n"
 164                         "VO     %u              %u\n"
 165                         "VI     %u              %u\n"
 166                         "BE     %u              %u\n"
 167                         "BK     %u              %u\n",
 168                         local->aql_txq_limit_low[IEEE80211_AC_VO],
 169                         local->aql_txq_limit_high[IEEE80211_AC_VO],
 170                         local->aql_txq_limit_low[IEEE80211_AC_VI],
 171                         local->aql_txq_limit_high[IEEE80211_AC_VI],
 172                         local->aql_txq_limit_low[IEEE80211_AC_BE],
 173                         local->aql_txq_limit_high[IEEE80211_AC_BE],
 174                         local->aql_txq_limit_low[IEEE80211_AC_BK],
 175                         local->aql_txq_limit_high[IEEE80211_AC_BK]);
 176         return simple_read_from_buffer(user_buf, count, ppos,
 177                                        buf, len);
 178 }
 179
 180 static ssize_t aql_txq_limit_write(struct file *file,
 181                                    const char __user *user_buf,
 182                                    size_t count,
 183                                    loff_t *ppos)
 184 {
 185         struct ieee80211_local *local = file->private_data;
 186         char buf[100];
 187         size_t len;
 188         u32 ac, q_limit_low, q_limit_high, q_limit_low_old, q_limit_high_old;
 189         struct sta_info *sta;
 190
 191         if (count > sizeof(buf))
 192                 return -EINVAL;
 193
 194         if (copy_from_user(buf, user_buf, count))
 195                 return -EFAULT;
 196
 197         buf[sizeof(buf) - 1] = 0;
 198         len = strlen(buf);
 199         if (len > 0 && buf[len - 1] == '\n')
 200                 buf[len - 1] = 0;
 201
 202         if (sscanf(buf, "%u %u %u", &ac, &q_limit_low, &q_limit_high) != 3)
 203                 return -EINVAL;
 204
 205         if (ac >= IEEE80211_NUM_ACS)
 206                 return -EINVAL;
 207
 208         q_limit_low_old = local->aql_txq_limit_low[ac];
 209         q_limit_high_old = local->aql_txq_limit_high[ac];
 210
 211         local->aql_txq_limit_low[ac] = q_limit_low;
 212         local->aql_txq_limit_high[ac] = q_limit_high;
 213
 214         mutex_lock(&local->sta_mtx);
 215         list_for_each_entry(sta, &local->sta_list, list) {
 216                 /* If a sta has customized queue limits, keep it */
 217                 if (sta->airtime[ac].aql_limit_low == q_limit_low_old &&
 218                     sta->airtime[ac].aql_limit_high == q_limit_high_old) {
 219                         sta->airtime[ac].aql_limit_low = q_limit_low;
 220                         sta->airtime[ac].aql_limit_high = q_limit_high;
 221                 }
 222         }
 223         mutex_unlock(&local->sta_mtx);
 224         return count;
 225 }
 226
 227 static const struct file_operations aql_txq_limit_ops = {
 228         .write = aql_txq_limit_write,
 229         .read = aql_txq_limit_read,
 230         .open = simple_open,
 231         .llseek = default_llseek,
 232 };
 233
 234 static ssize_t force_tx_status_read(struct file *file,
 235                                     char __user *user_buf,
 236                                     size_t count,
 237                                     loff_t *ppos)
 238 {
 239         struct ieee80211_local *local = file->private_data;
 240         char buf[3];
 241         int len = 0;
 242
 243         len = scnprintf(buf, sizeof(buf), "%d\n", (int)local->force_tx_status);
 244
 245         return simple_read_from_buffer(user_buf, count, ppos,
 246                                        buf, len);
 247 }
 248
 249 static ssize_t force_tx_status_write(struct file *file,
 250                                      const char __user *user_buf,
 251                                      size_t count,
 252                                      loff_t *ppos)
 253 {
 254         struct ieee80211_local *local = file->private_data;
 255         char buf[3];
 256         size_t len;
 257
 258         if (count > sizeof(buf))
 259                 return -EINVAL;
 260
 261         if (copy_from_user(buf, user_buf, count))
 262                 return -EFAULT;
 263
 264         buf[sizeof(buf) - 1] = '\0';
 265         len = strlen(buf);
 266         if (len > 0 && buf[len - 1] == '\n')
 267                 buf[len - 1] = 0;
 268
 269         if (buf[0] == '0' && buf[1] == '\0')
 270                 local->force_tx_status = 0;
 271         else if (buf[0] == '1' && buf[1] == '\0')
 272                 local->force_tx_status = 1;
 273         else
 274                 return -EINVAL;
 275
 276         return count;
 277 }
 278
 279 static const struct file_operations force_tx_status_ops = {
 280         .write = force_tx_status_write,
 281         .read = force_tx_status_read,
 282         .open = simple_open,
 283         .llseek = default_llseek,
 284 };
 285
 286 #ifdef CONFIG_PM
 287 static ssize_t reset_write(struct file *file, const char __user *user_buf,
 288                            size_t count, loff_t *ppos)
 289 {
 290         struct ieee80211_local *local = file->private_data;
 291
 292         rtnl_lock();
 293         __ieee80211_suspend(&local->hw, NULL);
 294         __ieee80211_resume(&local->hw);
 295         rtnl_unlock();
 296
 297         return count;
 298 }
 299
 300 static const struct file_operations reset_ops = {
 301         .write = reset_write,
 302         .open = simple_open,
 303         .llseek = noop_llseek,
 304 };
 305 #endif
 306
 307 static const char *hw_flag_names[] = {
 308 #define FLAG(F) [IEEE80211_HW_##F] = #F
 309         FLAG(HAS_RATE_CONTROL),
 310         FLAG(RX_INCLUDES_FCS),
 311         FLAG(HOST_BROADCAST_PS_BUFFERING),
 312         FLAG(SIGNAL_UNSPEC),
 313         FLAG(SIGNAL_DBM),
 314         FLAG(NEED_DTIM_BEFORE_ASSOC),
 315         FLAG(SPECTRUM_MGMT),
 316         FLAG(AMPDU_AGGREGATION),
 317         FLAG(SUPPORTS_PS),
 318         FLAG(PS_NULLFUNC_STACK),
 319         FLAG(SUPPORTS_DYNAMIC_PS),
 320         FLAG(MFP_CAPABLE),
 321         FLAG(WANT_MONITOR_VIF),
 322         FLAG(NO_AUTO_VIF),
 323         FLAG(SW_CRYPTO_CONTROL),
 324         FLAG(SUPPORT_FAST_XMIT),
 325         FLAG(REPORTS_TX_ACK_STATUS),
 326         FLAG(CONNECTION_MONITOR),
 327         FLAG(QUEUE_CONTROL),
 328         FLAG(SUPPORTS_PER_STA_GTK),
 329         FLAG(AP_LINK_PS),
 330         FLAG(TX_AMPDU_SETUP_IN_HW),
 331         FLAG(SUPPORTS_RC_TABLE),
 332         FLAG(P2P_DEV_ADDR_FOR_INTF),
 333         FLAG(TIMING_BEACON_ONLY),
 334         FLAG(SUPPORTS_HT_CCK_RATES),
 335         FLAG(CHANCTX_STA_CSA),
 336         FLAG(SUPPORTS_CLONED_SKBS),
 337         FLAG(SINGLE_SCAN_ON_ALL_BANDS),
 338         FLAG(TDLS_WIDER_BW),
 339         FLAG(SUPPORTS_AMSDU_IN_AMPDU),
 340         FLAG(BEACON_TX_STATUS),
 341         FLAG(NEEDS_UNIQUE_STA_ADDR),
 342         FLAG(SUPPORTS_REORDERING_BUFFER),
 343         FLAG(USES_RSS),
 344         FLAG(TX_AMSDU),
 345         FLAG(TX_FRAG_LIST),
 346         FLAG(REPORTS_LOW_ACK),
 347         FLAG(SUPPORTS_TX_FRAG),
 348         FLAG(SUPPORTS_TDLS_BUFFER_STA),
 349         FLAG(DEAUTH_NEED_MGD_TX_PREP),
 350         FLAG(DOESNT_SUPPORT_QOS_NDP),
 351         FLAG(BUFF_MMPDU_TXQ),
 352         FLAG(SUPPORTS_VHT_EXT_NSS_BW),
 353         FLAG(STA_MMPDU_TXQ),
 354         FLAG(TX_STATUS_NO_AMPDU_LEN),
 355         FLAG(SUPPORTS_MULTI_BSSID),
 356         FLAG(SUPPORTS_ONLY_HE_MULTI_BSSID),
 357         FLAG(AMPDU_KEYBORDER_SUPPORT),
 358 #undef FLAG
 359 };
 360
 361 static ssize_t hwflags_read(struct file *file, char __user *user_buf,
 362                             size_t count, loff_t *ppos)
 363 {
 364         struct ieee80211_local *local = file->private_data;
 365         size_t bufsz = 30 * NUM_IEEE80211_HW_FLAGS;
 366         char *buf = kzalloc(bufsz, GFP_KERNEL);
 367         char *pos = buf, *end = buf + bufsz - 1;
 368         ssize_t rv;
 369         int i;
 370
 371         if (!buf)
 372                 return -ENOMEM;
 373
 374         /* fail compilation if somebody adds or removes
 375          * a flag without updating the name array above
 376          */
 377         BUILD_BUG_ON(ARRAY_SIZE(hw_flag_names) != NUM_IEEE80211_HW_FLAGS);
 378
 379         for (i = 0; i < NUM_IEEE80211_HW_FLAGS; i++) {
 380                 if (test_bit(i, local->hw.flags))
 381                         pos += scnprintf(pos, end - pos, "%s\n",
 382                                          hw_flag_names[i]);
 383         }
 384
 385         rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
 386         kfree(buf);
 387         return rv;
 388 }
 389
 390 static ssize_t misc_read(struct file *file, char __user *user_buf,
 391                          size_t count, loff_t *ppos)
 392 {
 393         struct ieee80211_local *local = file->private_data;
 394         /* Max len of each line is 16 characters, plus 9 for 'pending:\n' */
 395         size_t bufsz = IEEE80211_MAX_QUEUES * 16 + 9;
 396         char *buf;
 397         char *pos, *end;
 398         ssize_t rv;
 399         int i;
 400         int ln;
 401
 402         buf = kzalloc(bufsz, GFP_KERNEL);
 403         if (!buf)
 404                 return -ENOMEM;
 405
 406         pos = buf;
 407         end = buf + bufsz - 1;
 408
 409         pos += scnprintf(pos, end - pos, "pending:\n");
 410
 411         for (i = 0; i < IEEE80211_MAX_QUEUES; i++) {
 412                 ln = skb_queue_len(&local->pending[i]);
 413                 pos += scnprintf(pos, end - pos, "[%i] %d\n",
 414                                  i, ln);
 415         }
 416
 417         rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
 418         kfree(buf);
 419         return rv;
 420 }
 421
 422 static ssize_t queues_read(struct file *file, char __user *user_buf,
 423                            size_t count, loff_t *ppos)
 424 {
 425         struct ieee80211_local *local = file->private_data;
 426         unsigned long flags;
 427         char buf[IEEE80211_MAX_QUEUES * 20];
 428         int q, res = 0;
 429
 430         spin_lock_irqsave(&local->queue_stop_reason_lock, flags);
 431         for (q = 0; q < local->hw.queues; q++)
 432                 res += sprintf(buf + res, "%02d: %#.8lx/%d\n", q,
 433                                 local->queue_stop_reasons[q],
 434                                 skb_queue_len(&local->pending[q]));
 435         spin_unlock_irqrestore(&local->queue_stop_reason_lock, flags);
 436
 437         return simple_read_from_buffer(user_buf, count, ppos, buf, res);
 438 }
 439
 440 DEBUGFS_READONLY_FILE_OPS(hwflags);
 441 DEBUGFS_READONLY_FILE_OPS(queues);
 442 DEBUGFS_READONLY_FILE_OPS(misc);
 443
 444 /* statistics stuff */
 445
 446 static ssize_t format_devstat_counter(struct ieee80211_local *local,
 447         char __user *userbuf,
 448         size_t count, loff_t *ppos,
 449         int (*printvalue)(struct ieee80211_low_level_stats *stats, char *buf,
 450                           int buflen))
 451 {
 452         struct ieee80211_low_level_stats stats;
 453         char buf[20];
 454         int res;
 455
 456         rtnl_lock();
 457         res = drv_get_stats(local, &stats);
 458         rtnl_unlock();
 459         if (res)
 460                 return res;
 461         res = printvalue(&stats, buf, sizeof(buf));
 462         return simple_read_from_buffer(userbuf, count, ppos, buf, res);
 463 }
 464
 465 #define DEBUGFS_DEVSTATS_FILE(name)                                     \
 466 static int print_devstats_##name(struct ieee80211_low_level_stats *stats,\
 467                                  char *buf, int buflen)                 \
 468 {                                                                       \
 469         return scnprintf(buf, buflen, "%u\n", stats->name);             \
 470 }                                                                       \
 471 static ssize_t stats_ ##name## _read(struct file *file,                 \
 472                                      char __user *userbuf,              \
 473                                      size_t count, loff_t *ppos)        \
 474 {                                                                       \
 475         return format_devstat_counter(file->private_data,               \
 476                                       userbuf,                          \
 477                                       count,                            \
 478                                       ppos,                             \
 479                                       print_devstats_##name);           \
 480 }                                                                       \
 481                                                                         \
 482 static const struct file_operations stats_ ##name## _ops = {            \
 483         .read = stats_ ##name## _read,                                  \
 484         .open = simple_open,                                            \
 485         .llseek = generic_file_llseek,                                  \
 486 };
 487
 488 #define DEBUGFS_STATS_ADD(name)                                 \
 489         debugfs_create_u32(#name, 0400, statsd, &local->name);
 490 #define DEBUGFS_DEVSTATS_ADD(name)                                      \
 491         debugfs_create_file(#name, 0400, statsd, local, &stats_ ##name## _ops);
 492
 493 DEBUGFS_DEVSTATS_FILE(dot11ACKFailureCount);
 494 DEBUGFS_DEVSTATS_FILE(dot11RTSFailureCount);
 495 DEBUGFS_DEVSTATS_FILE(dot11FCSErrorCount);
 496 DEBUGFS_DEVSTATS_FILE(dot11RTSSuccessCount);
 497
 498 void debugfs_hw_add(struct ieee80211_local *local)
 499 {
 500         struct dentry *phyd = local->hw.wiphy->debugfsdir;
 501         struct dentry *statsd;
 502
 503         if (!phyd)
 504                 return;
 505
 506         local->debugfs.keys = debugfs_create_dir("keys", phyd);
 507
 508         DEBUGFS_ADD(total_ps_buffered);
 509         DEBUGFS_ADD(wep_iv);
 510         DEBUGFS_ADD(rate_ctrl_alg);
 511         DEBUGFS_ADD(queues);
 512         DEBUGFS_ADD(misc);
 513 #ifdef CONFIG_PM
 514         DEBUGFS_ADD_MODE(reset, 0200);
 515 #endif
 516         DEBUGFS_ADD(hwflags);
 517         DEBUGFS_ADD(user_power);
 518         DEBUGFS_ADD(power);
 519         DEBUGFS_ADD(hw_conf);
 520         DEBUGFS_ADD_MODE(force_tx_status, 0600);
 521
 522         if (local->ops->wake_tx_queue)
 523                 DEBUGFS_ADD_MODE(aqm, 0600);
 524
 525         debugfs_create_u16("airtime_flags", 0600,
 526                            phyd, &local->airtime_flags);
 527
 528         DEBUGFS_ADD(aql_txq_limit);
 529         debugfs_create_u32("aql_threshold", 0600,
 530                            phyd, &local->aql_threshold);
 531
 532         statsd = debugfs_create_dir("statistics", phyd);
 533
 534         /* if the dir failed, don't put all the other things into the root! */
 535         if (!statsd)
 536                 return;
 537
 538 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 539         DEBUGFS_STATS_ADD(dot11TransmittedFragmentCount);
 540         DEBUGFS_STATS_ADD(dot11MulticastTransmittedFrameCount);
 541         DEBUGFS_STATS_ADD(dot11FailedCount);
 542         DEBUGFS_STATS_ADD(dot11RetryCount);
 543         DEBUGFS_STATS_ADD(dot11MultipleRetryCount);
 544         DEBUGFS_STATS_ADD(dot11FrameDuplicateCount);
 545         DEBUGFS_STATS_ADD(dot11ReceivedFragmentCount);
 546         DEBUGFS_STATS_ADD(dot11MulticastReceivedFrameCount);
 547         DEBUGFS_STATS_ADD(dot11TransmittedFrameCount);
 548         DEBUGFS_STATS_ADD(tx_handlers_drop);
 549         DEBUGFS_STATS_ADD(tx_handlers_queued);
 550         DEBUGFS_STATS_ADD(tx_handlers_drop_wep);
 551         DEBUGFS_STATS_ADD(tx_handlers_drop_not_assoc);
 552         DEBUGFS_STATS_ADD(tx_handlers_drop_unauth_port);
 553         DEBUGFS_STATS_ADD(rx_handlers_drop);
 554         DEBUGFS_STATS_ADD(rx_handlers_queued);
 555         DEBUGFS_STATS_ADD(rx_handlers_drop_nullfunc);
 556         DEBUGFS_STATS_ADD(rx_handlers_drop_defrag);
 557         DEBUGFS_STATS_ADD(tx_expand_skb_head);
 558         DEBUGFS_STATS_ADD(tx_expand_skb_head_cloned);
 559         DEBUGFS_STATS_ADD(rx_expand_skb_head_defrag);
 560         DEBUGFS_STATS_ADD(rx_handlers_fragments);
 561         DEBUGFS_STATS_ADD(tx_status_drop);
 562 #endif
 563         DEBUGFS_DEVSTATS_ADD(dot11ACKFailureCount);
 564         DEBUGFS_DEVSTATS_ADD(dot11RTSFailureCount);
 565         DEBUGFS_DEVSTATS_ADD(dot11FCSErrorCount);
 566         DEBUGFS_DEVSTATS_ADD(dot11RTSSuccessCount);
 567 }