drivers/mmc/core/debugfs.c

   1 /*
   2  * Debugfs support for hosts and cards
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10 #include <linux/moduleparam.h>
  11 #include <linux/export.h>
  12 #include <linux/debugfs.h>
  13 #include <linux/fs.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/slab.h>
  16 #include <linux/stat.h>
  17 #include <linux/fault-inject.h>
  18
  19 #include <linux/mmc/card.h>
  20 #include <linux/mmc/host.h>
  21
  22 #include "core.h"
  23 #include "mmc_ops.h"
  24
  25 #ifdef CONFIG_FAIL_MMC_REQUEST
  26
  27 static DECLARE_FAULT_ATTR(fail_default_attr);
  28 static char *fail_request;
  29 module_param(fail_request, charp, 0);
  30
  31 #endif /* CONFIG_FAIL_MMC_REQUEST */
  32
  33 /* The debugfs functions are optimized away when CONFIG_DEBUG_FS isn't set. */
  34 static int mmc_ios_show(struct seq_file *s, void *data)
  35 {
  36         static const char *vdd_str[] = {
  37                 [8]     = "2.0",
  38                 [9]     = "2.1",
  39                 [10]    = "2.2",
  40                 [11]    = "2.3",
  41                 [12]    = "2.4",
  42                 [13]    = "2.5",
  43                 [14]    = "2.6",
  44                 [15]    = "2.7",
  45                 [16]    = "2.8",
  46                 [17]    = "2.9",
  47                 [18]    = "3.0",
  48                 [19]    = "3.1",
  49                 [20]    = "3.2",
  50                 [21]    = "3.3",
  51                 [22]    = "3.4",
  52                 [23]    = "3.5",
  53                 [24]    = "3.6",
  54         };
  55         struct mmc_host *host = s->private;
  56         struct mmc_ios  *ios = &host->ios;
  57         const char *str;
  58
  59         seq_printf(s, "clock:\t\t%u Hz\n", ios->clock);
  60         if (host->actual_clock)
  61                 seq_printf(s, "actual clock:\t%u Hz\n", host->actual_clock);
  62         seq_printf(s, "vdd:\t\t%u ", ios->vdd);
  63         if ((1 << ios->vdd) & MMC_VDD_165_195)
  64                 seq_printf(s, "(1.65 - 1.95 V)\n");
  65         else if (ios->vdd < (ARRAY_SIZE(vdd_str) - 1)
  66                         && vdd_str[ios->vdd] && vdd_str[ios->vdd + 1])
  67                 seq_printf(s, "(%s ~ %s V)\n", vdd_str[ios->vdd],
  68                                 vdd_str[ios->vdd + 1]);
  69         else
  70                 seq_printf(s, "(invalid)\n");
  71
  72         switch (ios->bus_mode) {
  73         case MMC_BUSMODE_OPENDRAIN:
  74                 str = "open drain";
  75                 break;
  76         case MMC_BUSMODE_PUSHPULL:
  77                 str = "push-pull";
  78                 break;
  79         default:
  80                 str = "invalid";
  81                 break;
  82         }
  83         seq_printf(s, "bus mode:\t%u (%s)\n", ios->bus_mode, str);
  84
  85         switch (ios->chip_select) {
  86         case MMC_CS_DONTCARE:
  87                 str = "don't care";
  88                 break;
  89         case MMC_CS_HIGH:
  90                 str = "active high";
  91                 break;
  92         case MMC_CS_LOW:
  93                 str = "active low";
  94                 break;
  95         default:
  96                 str = "invalid";
  97                 break;
  98         }
  99         seq_printf(s, "chip select:\t%u (%s)\n", ios->chip_select, str);
 100
 101         switch (ios->power_mode) {
 102         case MMC_POWER_OFF:
 103                 str = "off";
 104                 break;
 105         case MMC_POWER_UP:
 106                 str = "up";
 107                 break;
 108         case MMC_POWER_ON:
 109                 str = "on";
 110                 break;
 111         default:
 112                 str = "invalid";
 113                 break;
 114         }
 115         seq_printf(s, "power mode:\t%u (%s)\n", ios->power_mode, str);
 116         seq_printf(s, "bus width:\t%u (%u bits)\n",
 117                         ios->bus_width, 1 << ios->bus_width);
 118
 119         switch (ios->timing) {
 120         case MMC_TIMING_LEGACY:
 121                 str = "legacy";
 122                 break;
 123         case MMC_TIMING_MMC_HS:
 124                 str = "mmc high-speed";
 125                 break;
 126         case MMC_TIMING_SD_HS:
 127                 str = "sd high-speed";
 128                 break;
 129         case MMC_TIMING_UHS_SDR50:
 130                 str = "sd uhs SDR50";
 131                 break;
 132         case MMC_TIMING_UHS_SDR104:
 133                 str = "sd uhs SDR104";
 134                 break;
 135         case MMC_TIMING_UHS_DDR50:
 136                 str = "sd uhs DDR50";
 137                 break;
 138         case MMC_TIMING_MMC_DDR52:
 139                 str = "mmc DDR52";
 140                 break;
 141         case MMC_TIMING_MMC_HS200:
 142                 str = "mmc HS200";
 143                 break;
 144         case MMC_TIMING_MMC_HS400:
 145                 str = "mmc HS400";
 146                 break;
 147         default:
 148                 str = "invalid";
 149                 break;
 150         }
 151         seq_printf(s, "timing spec:\t%u (%s)\n", ios->timing, str);
 152
 153         switch (ios->signal_voltage) {
 154         case MMC_SIGNAL_VOLTAGE_330:
 155                 str = "3.30 V";
 156                 break;
 157         case MMC_SIGNAL_VOLTAGE_180:
 158                 str = "1.80 V";
 159                 break;
 160         case MMC_SIGNAL_VOLTAGE_120:
 161                 str = "1.20 V";
 162                 break;
 163         default:
 164                 str = "invalid";
 165                 break;
 166         }
 167         seq_printf(s, "signal voltage:\t%u (%s)\n", ios->chip_select, str);
 168
 169         return 0;
 170 }
 171
 172 static int mmc_ios_open(struct inode *inode, struct file *file)
 173 {
 174         return single_open(file, mmc_ios_show, inode->i_private);
 175 }
 176
 177 static const struct file_operations mmc_ios_fops = {
 178         .open           = mmc_ios_open,
 179         .read           = seq_read,
 180         .llseek         = seq_lseek,
 181         .release        = single_release,
 182 };
 183
 184 static int mmc_clock_opt_get(void *data, u64 *val)
 185 {
 186         struct mmc_host *host = data;
 187
 188         *val = host->ios.clock;
 189
 190         return 0;
 191 }
 192
 193 static int mmc_clock_opt_set(void *data, u64 val)
 194 {
 195         struct mmc_host *host = data;
 196
 197         /* We need this check due to input value is u64 */
 198         if (val > host->f_max)
 199                 return -EINVAL;
 200
 201         mmc_claim_host(host);
 202         mmc_set_clock(host, (unsigned int) val);
 203         mmc_release_host(host);
 204
 205         return 0;
 206 }
 207
 208 DEFINE_SIMPLE_ATTRIBUTE(mmc_clock_fops, mmc_clock_opt_get, mmc_clock_opt_set,
 209         "%llu\n");
 210
 211 void mmc_add_host_debugfs(struct mmc_host *host)
 212 {
 213         struct dentry *root;
 214
 215         root = debugfs_create_dir(mmc_hostname(host), NULL);
 216         if (IS_ERR(root))
 217                 /* Don't complain -- debugfs just isn't enabled */
 218                 return;
 219         if (!root)
 220                 /* Complain -- debugfs is enabled, but it failed to
 221                  * create the directory. */
 222                 goto err_root;
 223
 224         host->debugfs_root = root;
 225
 226         if (!debugfs_create_file("ios", S_IRUSR, root, host, &mmc_ios_fops))
 227                 goto err_node;
 228
 229         if (!debugfs_create_file("clock", S_IRUSR | S_IWUSR, root, host,
 230                         &mmc_clock_fops))
 231                 goto err_node;
 232
 233 #ifdef CONFIG_MMC_CLKGATE
 234         if (!debugfs_create_u32("clk_delay", (S_IRUSR | S_IWUSR),
 235                                 root, &host->clk_delay))
 236                 goto err_node;
 237 #endif
 238 #ifdef CONFIG_FAIL_MMC_REQUEST
 239         if (fail_request)
 240                 setup_fault_attr(&fail_default_attr, fail_request);
 241         host->fail_mmc_request = fail_default_attr;
 242         if (IS_ERR(fault_create_debugfs_attr("fail_mmc_request",
 243                                              root,
 244                                              &host->fail_mmc_request)))
 245                 goto err_node;
 246 #endif
 247         return;
 248
 249 err_node:
 250         debugfs_remove_recursive(root);
 251         host->debugfs_root = NULL;
 252 err_root:
 253         dev_err(&host->class_dev, "failed to initialize debugfs\n");
 254 }
 255
 256 void mmc_remove_host_debugfs(struct mmc_host *host)
 257 {
 258         debugfs_remove_recursive(host->debugfs_root);
 259 }
 260
 261 static int mmc_dbg_card_status_get(void *data, u64 *val)
 262 {
 263         struct mmc_card *card = data;
 264         u32             status;
 265         int             ret;
 266
 267         mmc_get_card(card);
 268
 269         ret = mmc_send_status(data, &status);
 270         if (!ret)
 271                 *val = status;
 272
 273         mmc_put_card(card);
 274
 275         return ret;
 276 }
 277 DEFINE_SIMPLE_ATTRIBUTE(mmc_dbg_card_status_fops, mmc_dbg_card_status_get,
 278                 NULL, "%08llx\n");
 279
 280 #define EXT_CSD_STR_LEN 1025
 281
 282 static int mmc_ext_csd_open(struct inode *inode, struct file *filp)
 283 {
 284         struct mmc_card *card = inode->i_private;
 285         char *buf;
 286         ssize_t n = 0;
 287         u8 *ext_csd;
 288         int err, i;
 289
 290         buf = kmalloc(EXT_CSD_STR_LEN + 1, GFP_KERNEL);
 291         if (!buf)
 292                 return -ENOMEM;
 293
 294         mmc_get_card(card);
 295         err = mmc_get_ext_csd(card, &ext_csd);
 296         mmc_put_card(card);
 297         if (err)
 298                 goto out_free;
 299
 300         for (i = 0; i < 512; i++)
 301                 n += sprintf(buf + n, "%02x", ext_csd[i]);
 302         n += sprintf(buf + n, "\n");
 303         BUG_ON(n != EXT_CSD_STR_LEN);
 304
 305         filp->private_data = buf;
 306         kfree(ext_csd);
 307         return 0;
 308
 309 out_free:
 310         kfree(buf);
 311         return err;
 312 }
 313
 314 static ssize_t mmc_ext_csd_read(struct file *filp, char __user *ubuf,
 315                                 size_t cnt, loff_t *ppos)
 316 {
 317         char *buf = filp->private_data;
 318
 319         return simple_read_from_buffer(ubuf, cnt, ppos,
 320                                        buf, EXT_CSD_STR_LEN);
 321 }
 322
 323 static int mmc_ext_csd_release(struct inode *inode, struct file *file)
 324 {
 325         kfree(file->private_data);
 326         return 0;
 327 }
 328
 329 static const struct file_operations mmc_dbg_ext_csd_fops = {
 330         .open           = mmc_ext_csd_open,
 331         .read           = mmc_ext_csd_read,
 332         .release        = mmc_ext_csd_release,
 333         .llseek         = default_llseek,
 334 };
 335
 336 void mmc_add_card_debugfs(struct mmc_card *card)
 337 {
 338         struct mmc_host *host = card->host;
 339         struct dentry   *root;
 340
 341         if (!host->debugfs_root)
 342                 return;
 343
 344         root = debugfs_create_dir(mmc_card_id(card), host->debugfs_root);
 345         if (IS_ERR(root))
 346                 /* Don't complain -- debugfs just isn't enabled */
 347                 return;
 348         if (!root)
 349                 /* Complain -- debugfs is enabled, but it failed to
 350                  * create the directory. */
 351                 goto err;
 352
 353         card->debugfs_root = root;
 354
 355         if (!debugfs_create_x32("state", S_IRUSR, root, &card->state))
 356                 goto err;
 357
 358         if (mmc_card_mmc(card) || mmc_card_sd(card))
 359                 if (!debugfs_create_file("status", S_IRUSR, root, card,
 360                                         &mmc_dbg_card_status_fops))
 361                         goto err;
 362
 363         if (mmc_card_mmc(card))
 364                 if (!debugfs_create_file("ext_csd", S_IRUSR, root, card,
 365                                         &mmc_dbg_ext_csd_fops))
 366                         goto err;
 367
 368         return;
 369
 370 err:
 371         debugfs_remove_recursive(root);
 372         card->debugfs_root = NULL;
 373         dev_err(&card->dev, "failed to initialize debugfs\n");
 374 }
 375
 376 void mmc_remove_card_debugfs(struct mmc_card *card)
 377 {
 378         debugfs_remove_recursive(card->debugfs_root);
 379 }