[mirror_ubuntu-zesty-kernel.git] / drivers / mmc / mmc_sysfs.c

/*
 *  linux/drivers/mmc/mmc_sysfs.c
 *
 *  Copyright (C) 2003 Russell King, All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 *  MMC sysfs/driver model support.
 */
#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/idr.h>

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

#include "mmc.h"

#define dev_to_mmc_card(d)	container_of(d, struct mmc_card, dev)
#define to_mmc_driver(d)	container_of(d, struct mmc_driver, drv)
#define cls_dev_to_mmc_host(d)	container_of(d, struct mmc_host, class_dev)

#define MMC_ATTR(name, fmt, args...)					\
static ssize_t mmc_##name##_show (struct device *dev, struct device_attribute *attr, char *buf)	\
{									\
	struct mmc_card *card = dev_to_mmc_card(dev);			\
	return sprintf(buf, fmt, args);					\
}

MMC_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
	card->raw_cid[2], card->raw_cid[3]);
MMC_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
	card->raw_csd[2], card->raw_csd[3]);
MMC_ATTR(scr, "%08x%08x\n", card->raw_scr[0], card->raw_scr[1]);
MMC_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
MMC_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
MMC_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
MMC_ATTR(manfid, "0x%06x\n", card->cid.manfid);
MMC_ATTR(name, "%s\n", card->cid.prod_name);
MMC_ATTR(oemid, "0x%04x\n", card->cid.oemid);
MMC_ATTR(serial, "0x%08x\n", card->cid.serial);

#define MMC_ATTR_RO(name) __ATTR(name, S_IRUGO, mmc_##name##_show, NULL)

static struct device_attribute mmc_dev_attrs[] = {
	MMC_ATTR_RO(cid),
	MMC_ATTR_RO(csd),
	MMC_ATTR_RO(date),
	MMC_ATTR_RO(fwrev),
	MMC_ATTR_RO(hwrev),
	MMC_ATTR_RO(manfid),
	MMC_ATTR_RO(name),
	MMC_ATTR_RO(oemid),
	MMC_ATTR_RO(serial),
	__ATTR_NULL
};

static struct device_attribute mmc_dev_attr_scr = MMC_ATTR_RO(scr);


static void mmc_release_card(struct device *dev)
{
	struct mmc_card *card = dev_to_mmc_card(dev);

	kfree(card);
}

/*
 * This currently matches any MMC driver to any MMC card - drivers
 * themselves make the decision whether to drive this card in their
 * probe method.  However, we force "bad" cards to fail.
 */
static int mmc_bus_match(struct device *dev, struct device_driver *drv)
{
	struct mmc_card *card = dev_to_mmc_card(dev);
	return !mmc_card_bad(card);
}

static int
mmc_bus_uevent(struct device *dev, char **envp, int num_envp, char *buf,
		int buf_size)
{
	struct mmc_card *card = dev_to_mmc_card(dev);
	char ccc[13];
	int i = 0;

#define add_env(fmt,val)						\
	({								\
		int len, ret = -ENOMEM;					\
		if (i < num_envp) {					\
			envp[i++] = buf;				\
			len = snprintf(buf, buf_size, fmt, val) + 1;	\
			buf_size -= len;				\
			buf += len;					\
			if (buf_size >= 0)				\
				ret = 0;				\
		}							\
		ret;							\
	})

	for (i = 0; i < 12; i++)
		ccc[i] = card->csd.cmdclass & (1 << i) ? '1' : '0';
	ccc[12] = '\0';

	i = 0;
	add_env("MMC_CCC=%s", ccc);
	add_env("MMC_MANFID=%06x", card->cid.manfid);
	add_env("MMC_NAME=%s", mmc_card_name(card));
	add_env("MMC_OEMID=%04x", card->cid.oemid);

	return 0;
}

static int mmc_bus_suspend(struct device *dev, pm_message_t state)
{
	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	struct mmc_card *card = dev_to_mmc_card(dev);
	int ret = 0;

	if (dev->driver && drv->suspend)
		ret = drv->suspend(card, state);
	return ret;
}

static int mmc_bus_resume(struct device *dev)
{
	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	struct mmc_card *card = dev_to_mmc_card(dev);
	int ret = 0;

	if (dev->driver && drv->resume)
		ret = drv->resume(card);
	return ret;
}

static int mmc_bus_probe(struct device *dev)
{
	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	struct mmc_card *card = dev_to_mmc_card(dev);

	return drv->probe(card);
}

static int mmc_bus_remove(struct device *dev)
{
	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	struct mmc_card *card = dev_to_mmc_card(dev);

	drv->remove(card);

	return 0;
}

static struct bus_type mmc_bus_type = {
	.name		= "mmc",
	.dev_attrs	= mmc_dev_attrs,
	.match		= mmc_bus_match,
	.uevent		= mmc_bus_uevent,
	.probe		= mmc_bus_probe,
	.remove		= mmc_bus_remove,
	.suspend	= mmc_bus_suspend,
	.resume		= mmc_bus_resume,
};

/**
 *	mmc_register_driver - register a media driver
 *	@drv: MMC media driver
 */
int mmc_register_driver(struct mmc_driver *drv)
{
	drv->drv.bus = &mmc_bus_type;
	return driver_register(&drv->drv);
}

EXPORT_SYMBOL(mmc_register_driver);

/**
 *	mmc_unregister_driver - unregister a media driver
 *	@drv: MMC media driver
 */
void mmc_unregister_driver(struct mmc_driver *drv)
{
	drv->drv.bus = &mmc_bus_type;
	driver_unregister(&drv->drv);
}

EXPORT_SYMBOL(mmc_unregister_driver);


/*
 * Internal function.  Initialise a MMC card structure.
 */
void mmc_init_card(struct mmc_card *card, struct mmc_host *host)
{
	memset(card, 0, sizeof(struct mmc_card));
	card->host = host;
	device_initialize(&card->dev);
	card->dev.parent = card->host->dev;
	card->dev.bus = &mmc_bus_type;
	card->dev.release = mmc_release_card;
}

/*
 * Internal function.  Register a new MMC card with the driver model.
 */
int mmc_register_card(struct mmc_card *card)
{
	int ret;

	snprintf(card->dev.bus_id, sizeof(card->dev.bus_id),
		 "%s:%04x", mmc_hostname(card->host), card->rca);

	ret = device_add(&card->dev);
	if (ret == 0) {
		if (mmc_card_sd(card)) {
			ret = device_create_file(&card->dev, &mmc_dev_attr_scr);
			if (ret)
				device_del(&card->dev);
		}
	}
	return ret;
}

/*
 * Internal function.  Unregister a new MMC card with the
 * driver model, and (eventually) free it.
 */
void mmc_remove_card(struct mmc_card *card)
{
	if (mmc_card_present(card)) {
		if (mmc_card_sd(card))
			device_remove_file(&card->dev, &mmc_dev_attr_scr);

		device_del(&card->dev);
	}

	put_device(&card->dev);
}


static void mmc_host_classdev_release(struct class_device *dev)
{
	struct mmc_host *host = cls_dev_to_mmc_host(dev);
	kfree(host);
}

static struct class mmc_host_class = {
	.name		= "mmc_host",
	.release	= mmc_host_classdev_release,
};

static DEFINE_IDR(mmc_host_idr);
static DEFINE_SPINLOCK(mmc_host_lock);

/*
 * Internal function. Allocate a new MMC host.
 */
struct mmc_host *mmc_alloc_host_sysfs(int extra, struct device *dev)
{
	struct mmc_host *host;

	host = kmalloc(sizeof(struct mmc_host) + extra, GFP_KERNEL);
	if (host) {
		memset(host, 0, sizeof(struct mmc_host) + extra);

		host->dev = dev;
		host->class_dev.dev = host->dev;
		host->class_dev.class = &mmc_host_class;
		class_device_initialize(&host->class_dev);
	}

	return host;
}

/*
 * Internal function. Register a new MMC host with the MMC class.
 */
int mmc_add_host_sysfs(struct mmc_host *host)
{
	int err;

	if (!idr_pre_get(&mmc_host_idr, GFP_KERNEL))
		return -ENOMEM;

	spin_lock(&mmc_host_lock);
	err = idr_get_new(&mmc_host_idr, host, &host->index);
	spin_unlock(&mmc_host_lock);
	if (err)
		return err;

	snprintf(host->class_dev.class_id, BUS_ID_SIZE,
		 "mmc%d", host->index);

	return class_device_add(&host->class_dev);
}

/*
 * Internal function. Unregister a MMC host with the MMC class.
 */
void mmc_remove_host_sysfs(struct mmc_host *host)
{
	class_device_del(&host->class_dev);

	spin_lock(&mmc_host_lock);
	idr_remove(&mmc_host_idr, host->index);
	spin_unlock(&mmc_host_lock);
}

/*
 * Internal function. Free a MMC host.
 */
void mmc_free_host_sysfs(struct mmc_host *host)
{
	class_device_put(&host->class_dev);
}


static int __init mmc_init(void)
{
	int ret = bus_register(&mmc_bus_type);
	if (ret == 0) {
		ret = class_register(&mmc_host_class);
		if (ret)
			bus_unregister(&mmc_bus_type);
	}
	return ret;
}

static void __exit mmc_exit(void)
{
	class_unregister(&mmc_host_class);
	bus_unregister(&mmc_bus_type);
}

module_init(mmc_init);
module_exit(mmc_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/mmc/mmc_sysfs.c
	3	*
	4	* Copyright (C) 2003 Russell King, All Rights Reserved.
	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	* MMC sysfs/driver model support.
	11	*/
	12	#include <linux/module.h>
	13	#include <linux/init.h>
	14	#include <linux/device.h>
dce77377	15	#include <linux/idr.h>
1da177e4 LT	16
	17	#include <linux/mmc/card.h>
	18	#include <linux/mmc/host.h>
	19
	20	#include "mmc.h"
	21
	22	#define dev_to_mmc_card(d) container_of(d, struct mmc_card, dev)
	23	#define to_mmc_driver(d) container_of(d, struct mmc_driver, drv)
00b137cf	24	#define cls_dev_to_mmc_host(d) container_of(d, struct mmc_host, class_dev)
1da177e4 LT	25
1da177e4 LT	26	#define MMC_ATTR(name, fmt, args...) \
e404e274	27	static ssize_t mmc_##name##_show (struct device dev, struct device_attribute attr, char *buf) \
1da177e4 LT	28	{ \
	29	struct mmc_card *card = dev_to_mmc_card(dev); \
	30	return sprintf(buf, fmt, args); \
	31	}
	32
	33	MMC_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
	34	card->raw_cid[2], card->raw_cid[3]);
	35	MMC_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
	36	card->raw_csd[2], card->raw_csd[3]);
a9c4342b	37	MMC_ATTR(scr, "%08x%08x\n", card->raw_scr[0], card->raw_scr[1]);
1da177e4 LT	38	MMC_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
	39	MMC_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
	40	MMC_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
	41	MMC_ATTR(manfid, "0x%06x\n", card->cid.manfid);
	42	MMC_ATTR(name, "%s\n", card->cid.prod_name);
	43	MMC_ATTR(oemid, "0x%04x\n", card->cid.oemid);
	44	MMC_ATTR(serial, "0x%08x\n", card->cid.serial);
	45
	46	#define MMC_ATTR_RO(name) __ATTR(name, S_IRUGO, mmc_##name##_show, NULL)
	47
	48	static struct device_attribute mmc_dev_attrs[] = {
	49	MMC_ATTR_RO(cid),
	50	MMC_ATTR_RO(csd),
	51	MMC_ATTR_RO(date),
	52	MMC_ATTR_RO(fwrev),
	53	MMC_ATTR_RO(hwrev),
	54	MMC_ATTR_RO(manfid),
	55	MMC_ATTR_RO(name),
	56	MMC_ATTR_RO(oemid),
	57	MMC_ATTR_RO(serial),
	58	__ATTR_NULL
	59	};
	60
4bc20a8d PO	61	static struct device_attribute mmc_dev_attr_scr = MMC_ATTR_RO(scr);
4bc20a8d PO	62
1da177e4 LT	63
	64	static void mmc_release_card(struct device *dev)
	65	{
	66	struct mmc_card *card = dev_to_mmc_card(dev);
	67
	68	kfree(card);
	69	}
	70
	71	/*
	72	* This currently matches any MMC driver to any MMC card - drivers
	73	* themselves make the decision whether to drive this card in their
	74	* probe method. However, we force "bad" cards to fail.
	75	*/
	76	static int mmc_bus_match(struct device dev, struct device_driver drv)
	77	{
	78	struct mmc_card *card = dev_to_mmc_card(dev);
	79	return !mmc_card_bad(card);
	80	}
	81
	82	static int
312c004d	83	mmc_bus_uevent(struct device dev, char envp, int num_envp, char buf,
1da177e4 LT	84	int buf_size)
	85	{
	86	struct mmc_card *card = dev_to_mmc_card(dev);
	87	char ccc[13];
	88	int i = 0;
	89
	90	#define add_env(fmt,val) \
	91	({ \
	92	int len, ret = -ENOMEM; \
	93	if (i < num_envp) { \
	94	envp[i++] = buf; \
	95	len = snprintf(buf, buf_size, fmt, val) + 1; \
	96	buf_size -= len; \
	97	buf += len; \
	98	if (buf_size >= 0) \
	99	ret = 0; \
	100	} \
	101	ret; \
	102	})
	103
	104	for (i = 0; i < 12; i++)
	105	ccc[i] = card->csd.cmdclass & (1 << i) ? '1' : '0';
	106	ccc[12] = '\0';
	107
	108	i = 0;
	109	add_env("MMC_CCC=%s", ccc);
	110	add_env("MMC_MANFID=%06x", card->cid.manfid);
	111	add_env("MMC_NAME=%s", mmc_card_name(card));
	112	add_env("MMC_OEMID=%04x", card->cid.oemid);
	113
	114	return 0;
	115	}
	116
	117	static int mmc_bus_suspend(struct device *dev, pm_message_t state)
	118	{
	119	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	120	struct mmc_card *card = dev_to_mmc_card(dev);
	121	int ret = 0;
	122
	123	if (dev->driver && drv->suspend)
	124	ret = drv->suspend(card, state);
	125	return ret;
	126	}
	127
	128	static int mmc_bus_resume(struct device *dev)
	129	{
	130	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	131	struct mmc_card *card = dev_to_mmc_card(dev);
	132	int ret = 0;
	133
	134	if (dev->driver && drv->resume)
	135	ret = drv->resume(card);
	136	return ret;
	137	}
	138
4d0b653c	139	static int mmc_bus_probe(struct device *dev)
1da177e4 LT	140	{
	141	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	142	struct mmc_card *card = dev_to_mmc_card(dev);
	143
	144	return drv->probe(card);
	145	}
	146
4d0b653c	147	static int mmc_bus_remove(struct device *dev)
1da177e4 LT	148	{
	149	struct mmc_driver *drv = to_mmc_driver(dev->driver);
	150	struct mmc_card *card = dev_to_mmc_card(dev);
	151
	152	drv->remove(card);
	153
	154	return 0;
	155	}
	156
4d0b653c RK	157	static struct bus_type mmc_bus_type = {
	158	.name = "mmc",
	159	.dev_attrs = mmc_dev_attrs,
	160	.match = mmc_bus_match,
	161	.uevent = mmc_bus_uevent,
	162	.probe = mmc_bus_probe,
	163	.remove = mmc_bus_remove,
	164	.suspend = mmc_bus_suspend,
	165	.resume = mmc_bus_resume,
	166	};
1da177e4 LT	167
	168	/**
	169	* mmc_register_driver - register a media driver
	170	* @drv: MMC media driver
	171	*/
	172	int mmc_register_driver(struct mmc_driver *drv)
	173	{
	174	drv->drv.bus = &mmc_bus_type;
1da177e4 LT	175	return driver_register(&drv->drv);
	176	}
	177
	178	EXPORT_SYMBOL(mmc_register_driver);
	179
	180	/**
	181	* mmc_unregister_driver - unregister a media driver
	182	* @drv: MMC media driver
	183	*/
	184	void mmc_unregister_driver(struct mmc_driver *drv)
	185	{
	186	drv->drv.bus = &mmc_bus_type;
	187	driver_unregister(&drv->drv);
	188	}
	189
	190	EXPORT_SYMBOL(mmc_unregister_driver);
	191
	192
	193	/*
	194	* Internal function. Initialise a MMC card structure.
	195	*/
	196	void mmc_init_card(struct mmc_card card, struct mmc_host host)
	197	{
	198	memset(card, 0, sizeof(struct mmc_card));
	199	card->host = host;
	200	device_initialize(&card->dev);
	201	card->dev.parent = card->host->dev;
	202	card->dev.bus = &mmc_bus_type;
	203	card->dev.release = mmc_release_card;
	204	}
	205
	206	/*
	207	* Internal function. Register a new MMC card with the driver model.
	208	*/
	209	int mmc_register_card(struct mmc_card *card)
	210	{
4bc20a8d PO	211	int ret;
4bc20a8d PO	212
1da177e4	213	snprintf(card->dev.bus_id, sizeof(card->dev.bus_id),
d366b643	214	"%s:%04x", mmc_hostname(card->host), card->rca);
1da177e4	215
4bc20a8d PO	216	ret = device_add(&card->dev);
	217	if (ret == 0) {
	218	if (mmc_card_sd(card)) {
	219	ret = device_create_file(&card->dev, &mmc_dev_attr_scr);
	220	if (ret)
	221	device_del(&card->dev);
	222	}
	223	}
	224	return ret;
1da177e4 LT	225	}
	226
	227	/*
	228	* Internal function. Unregister a new MMC card with the
	229	* driver model, and (eventually) free it.
	230	*/
	231	void mmc_remove_card(struct mmc_card *card)
	232	{
4bc20a8d PO	233	if (mmc_card_present(card)) {
	234	if (mmc_card_sd(card))
	235	device_remove_file(&card->dev, &mmc_dev_attr_scr);
	236
1da177e4	237	device_del(&card->dev);
4bc20a8d	238	}
1da177e4 LT	239
	240	put_device(&card->dev);
	241	}
	242
	243
00b137cf RK	244	static void mmc_host_classdev_release(struct class_device *dev)
	245	{
	246	struct mmc_host *host = cls_dev_to_mmc_host(dev);
	247	kfree(host);
	248	}
	249
	250	static struct class mmc_host_class = {
	251	.name = "mmc_host",
	252	.release = mmc_host_classdev_release,
	253	};
	254
dce77377 RK	255	static DEFINE_IDR(mmc_host_idr);
	256	static DEFINE_SPINLOCK(mmc_host_lock);
	257
00b137cf RK	258	/*
	259	* Internal function. Allocate a new MMC host.
	260	*/
	261	struct mmc_host mmc_alloc_host_sysfs(int extra, struct device dev)
	262	{
	263	struct mmc_host *host;
	264
	265	host = kmalloc(sizeof(struct mmc_host) + extra, GFP_KERNEL);
	266	if (host) {
	267	memset(host, 0, sizeof(struct mmc_host) + extra);
	268
	269	host->dev = dev;
	270	host->class_dev.dev = host->dev;
	271	host->class_dev.class = &mmc_host_class;
	272	class_device_initialize(&host->class_dev);
	273	}
	274
	275	return host;
	276	}
	277
	278	/*
	279	* Internal function. Register a new MMC host with the MMC class.
	280	*/
	281	int mmc_add_host_sysfs(struct mmc_host *host)
	282	{
dce77377 RK	283	int err;
	284
	285	if (!idr_pre_get(&mmc_host_idr, GFP_KERNEL))
	286	return -ENOMEM;
	287
	288	spin_lock(&mmc_host_lock);
	289	err = idr_get_new(&mmc_host_idr, host, &host->index);
	290	spin_unlock(&mmc_host_lock);
	291	if (err)
	292	return err;
00b137cf	293
1ad434d7	294	snprintf(host->class_dev.class_id, BUS_ID_SIZE,
dce77377	295	"mmc%d", host->index);
00b137cf	296
00b137cf RK	297	return class_device_add(&host->class_dev);
	298	}
	299
	300	/*
	301	* Internal function. Unregister a MMC host with the MMC class.
	302	*/
	303	void mmc_remove_host_sysfs(struct mmc_host *host)
	304	{
	305	class_device_del(&host->class_dev);
dce77377 RK	306
	307	spin_lock(&mmc_host_lock);
	308	idr_remove(&mmc_host_idr, host->index);
	309	spin_unlock(&mmc_host_lock);
00b137cf RK	310	}
	311
	312	/*
	313	* Internal function. Free a MMC host.
	314	*/
	315	void mmc_free_host_sysfs(struct mmc_host *host)
	316	{
	317	class_device_put(&host->class_dev);
	318	}
	319
	320
1da177e4 LT	321	static int __init mmc_init(void)
1da177e4 LT	322	{
00b137cf RK	323	int ret = bus_register(&mmc_bus_type);
	324	if (ret == 0) {
	325	ret = class_register(&mmc_host_class);
	326	if (ret)
	327	bus_unregister(&mmc_bus_type);
	328	}
	329	return ret;
1da177e4 LT	330	}
	331
	332	static void __exit mmc_exit(void)
	333	{
00b137cf	334	class_unregister(&mmc_host_class);
1da177e4 LT	335	bus_unregister(&mmc_bus_type);
	336	}
	337
	338	module_init(mmc_init);
	339	module_exit(mmc_exit);