[linux-2.6-block.git] / drivers / mmc / core / debugfs.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Debugfs support for hosts and cards
 *
 * Copyright (C) 2008 Atmel Corporation
 */
#include <linux/moduleparam.h>
#include <linux/export.h>
#include <linux/debugfs.h>
#include <linux/fs.h>
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/stat.h>
#include <linux/fault-inject.h>

#include <linux/mmc/card.h>
#include <linux/mmc/host.h>

#include "core.h"
#include "card.h"
#include "host.h"
#include "mmc_ops.h"

#ifdef CONFIG_FAIL_MMC_REQUEST

static DECLARE_FAULT_ATTR(fail_default_attr);
static char *fail_request;
module_param(fail_request, charp, 0);

#endif /* CONFIG_FAIL_MMC_REQUEST */

/* The debugfs functions are optimized away when CONFIG_DEBUG_FS isn't set. */
static int mmc_ios_show(struct seq_file *s, void *data)
{
	static const char *vdd_str[] = {
		[8]	= "2.0",
		[9]	= "2.1",
		[10]	= "2.2",
		[11]	= "2.3",
		[12]	= "2.4",
		[13]	= "2.5",
		[14]	= "2.6",
		[15]	= "2.7",
		[16]	= "2.8",
		[17]	= "2.9",
		[18]	= "3.0",
		[19]	= "3.1",
		[20]	= "3.2",
		[21]	= "3.3",
		[22]	= "3.4",
		[23]	= "3.5",
		[24]	= "3.6",
	};
	struct mmc_host	*host = s->private;
	struct mmc_ios	*ios = &host->ios;
	const char *str;

	seq_printf(s, "clock:\t\t%u Hz\n", ios->clock);
	if (host->actual_clock)
		seq_printf(s, "actual clock:\t%u Hz\n", host->actual_clock);
	seq_printf(s, "vdd:\t\t%u ", ios->vdd);
	if ((1 << ios->vdd) & MMC_VDD_165_195)
		seq_printf(s, "(1.65 - 1.95 V)\n");
	else if (ios->vdd < (ARRAY_SIZE(vdd_str) - 1)
			&& vdd_str[ios->vdd] && vdd_str[ios->vdd + 1])
		seq_printf(s, "(%s ~ %s V)\n", vdd_str[ios->vdd],
				vdd_str[ios->vdd + 1]);
	else
		seq_printf(s, "(invalid)\n");

	switch (ios->bus_mode) {
	case MMC_BUSMODE_OPENDRAIN:
		str = "open drain";
		break;
	case MMC_BUSMODE_PUSHPULL:
		str = "push-pull";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "bus mode:\t%u (%s)\n", ios->bus_mode, str);

	switch (ios->chip_select) {
	case MMC_CS_DONTCARE:
		str = "don't care";
		break;
	case MMC_CS_HIGH:
		str = "active high";
		break;
	case MMC_CS_LOW:
		str = "active low";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "chip select:\t%u (%s)\n", ios->chip_select, str);

	switch (ios->power_mode) {
	case MMC_POWER_OFF:
		str = "off";
		break;
	case MMC_POWER_UP:
		str = "up";
		break;
	case MMC_POWER_ON:
		str = "on";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "power mode:\t%u (%s)\n", ios->power_mode, str);
	seq_printf(s, "bus width:\t%u (%u bits)\n",
			ios->bus_width, 1 << ios->bus_width);

	switch (ios->timing) {
	case MMC_TIMING_LEGACY:
		str = "legacy";
		break;
	case MMC_TIMING_MMC_HS:
		str = "mmc high-speed";
		break;
	case MMC_TIMING_SD_HS:
		str = "sd high-speed";
		break;
	case MMC_TIMING_UHS_SDR12:
		str = "sd uhs SDR12";
		break;
	case MMC_TIMING_UHS_SDR25:
		str = "sd uhs SDR25";
		break;
	case MMC_TIMING_UHS_SDR50:
		str = "sd uhs SDR50";
		break;
	case MMC_TIMING_UHS_SDR104:
		str = "sd uhs SDR104";
		break;
	case MMC_TIMING_UHS_DDR50:
		str = "sd uhs DDR50";
		break;
	case MMC_TIMING_MMC_DDR52:
		str = "mmc DDR52";
		break;
	case MMC_TIMING_MMC_HS200:
		str = "mmc HS200";
		break;
	case MMC_TIMING_MMC_HS400:
		str = mmc_card_hs400es(host->card) ?
			"mmc HS400 enhanced strobe" : "mmc HS400";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "timing spec:\t%u (%s)\n", ios->timing, str);

	switch (ios->signal_voltage) {
	case MMC_SIGNAL_VOLTAGE_330:
		str = "3.30 V";
		break;
	case MMC_SIGNAL_VOLTAGE_180:
		str = "1.80 V";
		break;
	case MMC_SIGNAL_VOLTAGE_120:
		str = "1.20 V";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "signal voltage:\t%u (%s)\n", ios->signal_voltage, str);

	switch (ios->drv_type) {
	case MMC_SET_DRIVER_TYPE_A:
		str = "driver type A";
		break;
	case MMC_SET_DRIVER_TYPE_B:
		str = "driver type B";
		break;
	case MMC_SET_DRIVER_TYPE_C:
		str = "driver type C";
		break;
	case MMC_SET_DRIVER_TYPE_D:
		str = "driver type D";
		break;
	default:
		str = "invalid";
		break;
	}
	seq_printf(s, "driver type:\t%u (%s)\n", ios->drv_type, str);

	return 0;
}
DEFINE_SHOW_ATTRIBUTE(mmc_ios);

static int mmc_clock_opt_get(void *data, u64 *val)
{
	struct mmc_host *host = data;

	*val = host->ios.clock;

	return 0;
}

static int mmc_clock_opt_set(void *data, u64 val)
{
	struct mmc_host *host = data;

	/* We need this check due to input value is u64 */
	if (val != 0 && (val > host->f_max || val < host->f_min))
		return -EINVAL;

	mmc_claim_host(host);
	mmc_set_clock(host, (unsigned int) val);
	mmc_release_host(host);

	return 0;
}

DEFINE_SIMPLE_ATTRIBUTE(mmc_clock_fops, mmc_clock_opt_get, mmc_clock_opt_set,
	"%llu\n");

void mmc_add_host_debugfs(struct mmc_host *host)
{
	struct dentry *root;

	root = debugfs_create_dir(mmc_hostname(host), NULL);
	host->debugfs_root = root;

	debugfs_create_file("ios", S_IRUSR, root, host, &mmc_ios_fops);
	debugfs_create_x32("caps", S_IRUSR, root, &host->caps);
	debugfs_create_x32("caps2", S_IRUSR, root, &host->caps2);
	debugfs_create_file("clock", S_IRUSR | S_IWUSR, root, host,
			    &mmc_clock_fops);

#ifdef CONFIG_FAIL_MMC_REQUEST
	if (fail_request)
		setup_fault_attr(&fail_default_attr, fail_request);
	host->fail_mmc_request = fail_default_attr;
	fault_create_debugfs_attr("fail_mmc_request", root,
				  &host->fail_mmc_request);
#endif
}

void mmc_remove_host_debugfs(struct mmc_host *host)
{
	debugfs_remove_recursive(host->debugfs_root);
}

void mmc_add_card_debugfs(struct mmc_card *card)
{
	struct mmc_host	*host = card->host;
	struct dentry	*root;

	if (!host->debugfs_root)
		return;

	root = debugfs_create_dir(mmc_card_id(card), host->debugfs_root);
	card->debugfs_root = root;

	debugfs_create_x32("state", S_IRUSR, root, &card->state);
}

void mmc_remove_card_debugfs(struct mmc_card *card)
{
	debugfs_remove_recursive(card->debugfs_root);
	card->debugfs_root = NULL;
}
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
6edd8ee6 HS	2	/*
	3	* Debugfs support for hosts and cards
	4	*
	5	* Copyright (C) 2008 Atmel Corporation
6edd8ee6	6	*/
3f102ae9	7	#include <linux/moduleparam.h>
3ef77af1	8	#include <linux/export.h>
6edd8ee6 HS	9	#include <linux/debugfs.h>
	10	#include <linux/fs.h>
	11	#include <linux/seq_file.h>
5a0e3ad6	12	#include <linux/slab.h>
6edd8ee6	13	#include <linux/stat.h>
1b676f70	14	#include <linux/fault-inject.h>
6edd8ee6	15
f4b7f927	16	#include <linux/mmc/card.h>
6edd8ee6 HS	17	#include <linux/mmc/host.h>
	18
	19	#include "core.h"
4facdde1	20	#include "card.h"
5857b29b	21	#include "host.h"
f4b7f927	22	#include "mmc_ops.h"
6edd8ee6	23
34f50508 PF	24	#ifdef CONFIG_FAIL_MMC_REQUEST
	25
	26	static DECLARE_FAULT_ATTR(fail_default_attr);
	27	static char *fail_request;
	28	module_param(fail_request, charp, 0);
	29
	30	#endif /* CONFIG_FAIL_MMC_REQUEST */
	31
6edd8ee6 HS	32	/* The debugfs functions are optimized away when CONFIG_DEBUG_FS isn't set. */
	33	static int mmc_ios_show(struct seq_file s, void data)
	34	{
	35	static const char *vdd_str[] = {
	36	[8] = "2.0",
	37	[9] = "2.1",
	38	[10] = "2.2",
	39	[11] = "2.3",
	40	[12] = "2.4",
	41	[13] = "2.5",
	42	[14] = "2.6",
	43	[15] = "2.7",
	44	[16] = "2.8",
	45	[17] = "2.9",
	46	[18] = "3.0",
	47	[19] = "3.1",
	48	[20] = "3.2",
	49	[21] = "3.3",
	50	[22] = "3.4",
	51	[23] = "3.5",
	52	[24] = "3.6",
	53	};
	54	struct mmc_host *host = s->private;
	55	struct mmc_ios *ios = &host->ios;
	56	const char *str;
	57
	58	seq_printf(s, "clock:\t\t%u Hz\n", ios->clock);
df16219f GC	59	if (host->actual_clock)
df16219f GC	60	seq_printf(s, "actual clock:\t%u Hz\n", host->actual_clock);
6edd8ee6 HS	61	seq_printf(s, "vdd:\t\t%u ", ios->vdd);
	62	if ((1 << ios->vdd) & MMC_VDD_165_195)
	63	seq_printf(s, "(1.65 - 1.95 V)\n");
	64	else if (ios->vdd < (ARRAY_SIZE(vdd_str) - 1)
	65	&& vdd_str[ios->vdd] && vdd_str[ios->vdd + 1])
	66	seq_printf(s, "(%s ~ %s V)\n", vdd_str[ios->vdd],
	67	vdd_str[ios->vdd + 1]);
	68	else
	69	seq_printf(s, "(invalid)\n");
	70
	71	switch (ios->bus_mode) {
	72	case MMC_BUSMODE_OPENDRAIN:
	73	str = "open drain";
	74	break;
	75	case MMC_BUSMODE_PUSHPULL:
	76	str = "push-pull";
	77	break;
	78	default:
	79	str = "invalid";
	80	break;
	81	}
	82	seq_printf(s, "bus mode:\t%u (%s)\n", ios->bus_mode, str);
	83
	84	switch (ios->chip_select) {
	85	case MMC_CS_DONTCARE:
	86	str = "don't care";
	87	break;
	88	case MMC_CS_HIGH:
	89	str = "active high";
	90	break;
	91	case MMC_CS_LOW:
	92	str = "active low";
	93	break;
	94	default:
	95	str = "invalid";
	96	break;
	97	}
	98	seq_printf(s, "chip select:\t%u (%s)\n", ios->chip_select, str);
	99
	100	switch (ios->power_mode) {
	101	case MMC_POWER_OFF:
	102	str = "off";
	103	break;
	104	case MMC_POWER_UP:
	105	str = "up";
	106	break;
	107	case MMC_POWER_ON:
	108	str = "on";
	109	break;
	110	default:
	111	str = "invalid";
	112	break;
	113	}
	114	seq_printf(s, "power mode:\t%u (%s)\n", ios->power_mode, str);
	115	seq_printf(s, "bus width:\t%u (%u bits)\n",
	116	ios->bus_width, 1 << ios->bus_width);
	117
	118	switch (ios->timing) {
	119	case MMC_TIMING_LEGACY:
	120	str = "legacy";
	121	break;
	122	case MMC_TIMING_MMC_HS:
	123	str = "mmc high-speed";
	124	break;
125	case MMC_TIMING_SD_HS:
126	str = "sd high-speed";
127	break;
85f45058 SL	128	case MMC_TIMING_UHS_SDR12:
	129	str = "sd uhs SDR12";
	130	break;
	131	case MMC_TIMING_UHS_SDR25:
	132	str = "sd uhs SDR25";
	133	break;
cd8a3666 AL	134	case MMC_TIMING_UHS_SDR50:
	135	str = "sd uhs SDR50";
	136	break;
	137	case MMC_TIMING_UHS_SDR104:
	138	str = "sd uhs SDR104";
	139	break;
	140	case MMC_TIMING_UHS_DDR50:
	141	str = "sd uhs DDR50";
	142	break;
79f7ae7c SJ	143	case MMC_TIMING_MMC_DDR52:
	144	str = "mmc DDR52";
	145	break;
a4924c71	146	case MMC_TIMING_MMC_HS200:
577fb131	147	str = "mmc HS200";
a4924c71	148	break;
0a5b6438	149	case MMC_TIMING_MMC_HS400:
bc26235b SL	150	str = mmc_card_hs400es(host->card) ?
bc26235b SL	151	"mmc HS400 enhanced strobe" : "mmc HS400";
0a5b6438	152	break;
6edd8ee6 HS	153	default:
	154	str = "invalid";
	155	break;
	156	}
	157	seq_printf(s, "timing spec:\t%u (%s)\n", ios->timing, str);
	158
42cd95a0 JR	159	switch (ios->signal_voltage) {
	160	case MMC_SIGNAL_VOLTAGE_330:
	161	str = "3.30 V";
	162	break;
	163	case MMC_SIGNAL_VOLTAGE_180:
	164	str = "1.80 V";
	165	break;
	166	case MMC_SIGNAL_VOLTAGE_120:
	167	str = "1.20 V";
	168	break;
	169	default:
	170	str = "invalid";
	171	break;
	172	}
0036e746	173	seq_printf(s, "signal voltage:\t%u (%s)\n", ios->signal_voltage, str);
42cd95a0	174
d1f23f93 SL	175	switch (ios->drv_type) {
	176	case MMC_SET_DRIVER_TYPE_A:
	177	str = "driver type A";
	178	break;
	179	case MMC_SET_DRIVER_TYPE_B:
	180	str = "driver type B";
	181	break;
	182	case MMC_SET_DRIVER_TYPE_C:
	183	str = "driver type C";
	184	break;
	185	case MMC_SET_DRIVER_TYPE_D:
	186	str = "driver type D";
	187	break;
	188	default:
	189	str = "invalid";
	190	break;
	191	}
	192	seq_printf(s, "driver type:\t%u (%s)\n", ios->drv_type, str);
	193
6edd8ee6 HS	194	return 0;
6edd8ee6 HS	195	}
871cfe05	196	DEFINE_SHOW_ATTRIBUTE(mmc_ios);
6edd8ee6	197
703aae3d AS	198	static int mmc_clock_opt_get(void data, u64 val)
	199	{
	200	struct mmc_host *host = data;
	201
	202	*val = host->ios.clock;
	203
	204	return 0;
	205	}
	206
	207	static int mmc_clock_opt_set(void *data, u64 val)
	208	{
	209	struct mmc_host *host = data;
	210
	211	/* We need this check due to input value is u64 */
e5905ff1	212	if (val != 0 && (val > host->f_max \|\| val < host->f_min))
703aae3d AS	213	return -EINVAL;
	214
	215	mmc_claim_host(host);
	216	mmc_set_clock(host, (unsigned int) val);
	217	mmc_release_host(host);
	218
	219	return 0;
	220	}
	221
	222	DEFINE_SIMPLE_ATTRIBUTE(mmc_clock_fops, mmc_clock_opt_get, mmc_clock_opt_set,
	223	"%llu\n");
	224
6edd8ee6 HS	225	void mmc_add_host_debugfs(struct mmc_host *host)
	226	{
	227	struct dentry *root;
	228
	229	root = debugfs_create_dir(mmc_hostname(host), NULL);
6edd8ee6 HS	230	host->debugfs_root = root;
6edd8ee6 HS	231
a04c50aa GKH	232	debugfs_create_file("ios", S_IRUSR, root, host, &mmc_ios_fops);
	233	debugfs_create_x32("caps", S_IRUSR, root, &host->caps);
	234	debugfs_create_x32("caps2", S_IRUSR, root, &host->caps2);
	235	debugfs_create_file("clock", S_IRUSR \| S_IWUSR, root, host,
	236	&mmc_clock_fops);
6edd8ee6	237
1b676f70	238	#ifdef CONFIG_FAIL_MMC_REQUEST
34f50508 PF	239	if (fail_request)
	240	setup_fault_attr(&fail_default_attr, fail_request);
	241	host->fail_mmc_request = fail_default_attr;
a04c50aa GKH	242	fault_create_debugfs_attr("fail_mmc_request", root,
a04c50aa GKH	243	&host->fail_mmc_request);
04566831	244	#endif
6edd8ee6 HS	245	}
	246
	247	void mmc_remove_host_debugfs(struct mmc_host *host)
	248	{
	249	debugfs_remove_recursive(host->debugfs_root);
	250	}
f4b7f927	251
f4b7f927 HS	252	void mmc_add_card_debugfs(struct mmc_card *card)
	253	{
	254	struct mmc_host *host = card->host;
	255	struct dentry *root;
	256
	257	if (!host->debugfs_root)
	258	return;
	259
	260	root = debugfs_create_dir(mmc_card_id(card), host->debugfs_root);
f4b7f927 HS	261	card->debugfs_root = root;
f4b7f927 HS	262
a04c50aa	263	debugfs_create_x32("state", S_IRUSR, root, &card->state);
f4b7f927 HS	264	}
	265
	266	void mmc_remove_card_debugfs(struct mmc_card *card)
	267	{
	268	debugfs_remove_recursive(card->debugfs_root);
f9f0da98	269	card->debugfs_root = NULL;
f4b7f927	270	}