[linux-2.6-block.git] / include / linux / sysfs.h

/*
 * sysfs.h - definitions for the device driver filesystem
 *
 * Copyright (c) 2001,2002 Patrick Mochel
 * Copyright (c) 2004 Silicon Graphics, Inc.
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
 *
 * Please see Documentation/filesystems/sysfs.txt for more information.
 */

#ifndef _SYSFS_H_
#define _SYSFS_H_

#include <linux/compiler.h>
#include <linux/errno.h>
#include <linux/list.h>
#include <asm/atomic.h>

struct kobject;
struct module;

/* FIXME
 * The *owner field is no longer used.
 * x86 tree has been cleaned up. The owner
 * attribute is still left for other arches.
 */
struct attribute {
	const char		*name;
	struct module		*owner;
	mode_t			mode;
};

struct attribute_group {
	const char		*name;
	mode_t			(*is_visible)(struct kobject *,
					      struct attribute *, int);
	struct attribute	**attrs;
};


/**
 * Use these macros to make defining attributes easier. See include/linux/device.h
 * for examples..
 */

#define __ATTR(_name,_mode,_show,_store) { \
	.attr = {.name = __stringify(_name), .mode = _mode },	\
	.show	= _show,					\
	.store	= _store,					\
}

#define __ATTR_RO(_name) { \
	.attr	= { .name = __stringify(_name), .mode = 0444 },	\
	.show	= _name##_show,					\
}

#define __ATTR_NULL { .attr = { .name = NULL } }

#define attr_name(_attr) (_attr).attr.name

struct vm_area_struct;

struct bin_attribute {
	struct attribute	attr;
	size_t			size;
	void			*private;
	ssize_t (*read)(struct kobject *, struct bin_attribute *,
			char *, loff_t, size_t);
	ssize_t (*write)(struct kobject *, struct bin_attribute *,
			 char *, loff_t, size_t);
	int (*mmap)(struct kobject *, struct bin_attribute *attr,
		    struct vm_area_struct *vma);
};

struct sysfs_ops {
	ssize_t	(*show)(struct kobject *, struct attribute *,char *);
	ssize_t	(*store)(struct kobject *,struct attribute *,const char *, size_t);
};

struct sysfs_dirent;

#ifdef CONFIG_SYSFS

int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
			    void *data, struct module *owner);

int __must_check sysfs_create_dir(struct kobject *kobj);
void sysfs_remove_dir(struct kobject *kobj);
int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
int __must_check sysfs_move_dir(struct kobject *kobj,
				struct kobject *new_parent_kobj);

int __must_check sysfs_create_file(struct kobject *kobj,
				   const struct attribute *attr);
int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
				  mode_t mode);
void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);

int __must_check sysfs_create_bin_file(struct kobject *kobj,
				       struct bin_attribute *attr);
void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);

int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
				   const char *name);
int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
					  struct kobject *target,
					  const char *name);
void sysfs_remove_link(struct kobject *kobj, const char *name);

int __must_check sysfs_create_group(struct kobject *kobj,
				    const struct attribute_group *grp);
int sysfs_update_group(struct kobject *kobj,
		       const struct attribute_group *grp);
void sysfs_remove_group(struct kobject *kobj,
			const struct attribute_group *grp);
int sysfs_add_file_to_group(struct kobject *kobj,
			const struct attribute *attr, const char *group);
void sysfs_remove_file_from_group(struct kobject *kobj,
			const struct attribute *attr, const char *group);

void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
void sysfs_notify_dirent(struct sysfs_dirent *sd);
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
				      const unsigned char *name);
struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
void sysfs_put(struct sysfs_dirent *sd);
void sysfs_printk_last_file(void);
int __must_check sysfs_init(void);

#else /* CONFIG_SYSFS */

static inline int sysfs_schedule_callback(struct kobject *kobj,
		void (*func)(void *), void *data, struct module *owner)
{
	return -ENOSYS;
}

static inline int sysfs_create_dir(struct kobject *kobj)
{
	return 0;
}

static inline void sysfs_remove_dir(struct kobject *kobj)
{
}

static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
{
	return 0;
}

static inline int sysfs_move_dir(struct kobject *kobj,
				 struct kobject *new_parent_kobj)
{
	return 0;
}

static inline int sysfs_create_file(struct kobject *kobj,
				    const struct attribute *attr)
{
	return 0;
}

static inline int sysfs_chmod_file(struct kobject *kobj,
				   struct attribute *attr, mode_t mode)
{
	return 0;
}

static inline void sysfs_remove_file(struct kobject *kobj,
				     const struct attribute *attr)
{
}

static inline int sysfs_create_bin_file(struct kobject *kobj,
					struct bin_attribute *attr)
{
	return 0;
}

static inline void sysfs_remove_bin_file(struct kobject *kobj,
					 struct bin_attribute *attr)
{
}

static inline int sysfs_create_link(struct kobject *kobj,
				    struct kobject *target, const char *name)
{
	return 0;
}

static inline int sysfs_create_link_nowarn(struct kobject *kobj,
					   struct kobject *target,
					   const char *name)
{
	return 0;
}

static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
{
}

static inline int sysfs_create_group(struct kobject *kobj,
				     const struct attribute_group *grp)
{
	return 0;
}

static inline int sysfs_update_group(struct kobject *kobj,
				const struct attribute_group *grp)
{
	return 0;
}

static inline void sysfs_remove_group(struct kobject *kobj,
				      const struct attribute_group *grp)
{
}

static inline int sysfs_add_file_to_group(struct kobject *kobj,
		const struct attribute *attr, const char *group)
{
	return 0;
}

static inline void sysfs_remove_file_from_group(struct kobject *kobj,
		const struct attribute *attr, const char *group)
{
}

static inline void sysfs_notify(struct kobject *kobj, const char *dir,
				const char *attr)
{
}
static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
{
}
static inline
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
				      const unsigned char *name)
{
	return NULL;
}
static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
{
	return NULL;
}
static inline void sysfs_put(struct sysfs_dirent *sd)
{
}

static inline int __must_check sysfs_init(void)
{
	return 0;
}

static inline void sysfs_printk_last_file(void)
{
}

#endif /* CONFIG_SYSFS */

#endif /* _SYSFS_H_ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* sysfs.h - definitions for the device driver filesystem
	3	*
	4	* Copyright (c) 2001,2002 Patrick Mochel
	5	* Copyright (c) 2004 Silicon Graphics, Inc.
6d66f5cd TH	6	* Copyright (c) 2007 SUSE Linux Products GmbH
6d66f5cd TH	7	* Copyright (c) 2007 Tejun Heo <teheo@suse.de>
1da177e4 LT	8	*
	9	* Please see Documentation/filesystems/sysfs.txt for more information.
	10	*/
	11
	12	#ifndef _SYSFS_H_
	13	#define _SYSFS_H_
	14
4a7fb636	15	#include <linux/compiler.h>
5851fadc	16	#include <linux/errno.h>
bf0acc33	17	#include <linux/list.h>
1da177e4 LT	18	#include <asm/atomic.h>
	19
	20	struct kobject;
	21	struct module;
	22
7b595756	23	/* FIXME
01e8ef11 PW	24	* The *owner field is no longer used.
	25	* x86 tree has been cleaned up. The owner
	26	* attribute is still left for other arches.
7b595756	27	*/
1da177e4	28	struct attribute {
59f69015 TH	29	const char *name;
59f69015 TH	30	struct module *owner;
1da177e4 LT	31	mode_t mode;
	32	};
	33
	34	struct attribute_group {
59f69015	35	const char *name;
0f423895	36	mode_t (is_visible)(struct kobject ,
d4acd722	37	struct attribute *, int);
59f69015	38	struct attribute **attrs;
1da177e4 LT	39	};
	40
	41
	42
	43	/**
	44	* Use these macros to make defining attributes easier. See include/linux/device.h
	45	* for examples..
	46	*/
	47
	48	#define __ATTR(_name,_mode,_show,_store) { \
7b595756	49	.attr = {.name = __stringify(_name), .mode = _mode }, \
1da177e4 LT	50	.show = _show, \
	51	.store = _store, \
	52	}
	53
	54	#define __ATTR_RO(_name) { \
7b595756 TH	55	.attr = { .name = __stringify(_name), .mode = 0444 }, \
7b595756 TH	56	.show = _name##_show, \
1da177e4 LT	57	}
	58
	59	#define __ATTR_NULL { .attr = { .name = NULL } }
	60
	61	#define attr_name(_attr) (_attr).attr.name
	62
	63	struct vm_area_struct;
	64
	65	struct bin_attribute {
	66	struct attribute attr;
	67	size_t size;
	68	void *private;
91a69029 ZR	69	ssize_t (read)(struct kobject , struct bin_attribute *,
	70	char *, loff_t, size_t);
	71	ssize_t (write)(struct kobject , struct bin_attribute *,
	72	char *, loff_t, size_t);
1da177e4 LT	73	int (mmap)(struct kobject , struct bin_attribute *attr,
	74	struct vm_area_struct *vma);
	75	};
	76
	77	struct sysfs_ops {
	78	ssize_t (show)(struct kobject , struct attribute ,char );
	79	ssize_t (store)(struct kobject ,struct attribute ,const char , size_t);
	80	};
	81
f1282c84 NB	82	struct sysfs_dirent;
f1282c84 NB	83
1da177e4 LT	84	#ifdef CONFIG_SYSFS
1da177e4 LT	85
59f69015 TH	86	int sysfs_schedule_callback(struct kobject kobj, void (func)(void *),
59f69015 TH	87	void data, struct module owner);
1da177e4	88
59f69015 TH	89	int __must_check sysfs_create_dir(struct kobject *kobj);
	90	void sysfs_remove_dir(struct kobject *kobj);
	91	int __must_check sysfs_rename_dir(struct kobject kobj, const char new_name);
	92	int __must_check sysfs_move_dir(struct kobject *kobj,
	93	struct kobject *new_parent_kobj);
31e5abe9	94
59f69015 TH	95	int __must_check sysfs_create_file(struct kobject *kobj,
59f69015 TH	96	const struct attribute *attr);
59f69015 TH	97	int __must_check sysfs_chmod_file(struct kobject kobj, struct attribute attr,
	98	mode_t mode);
	99	void sysfs_remove_file(struct kobject kobj, const struct attribute attr);
1da177e4	100
4a7fb636	101	int __must_check sysfs_create_bin_file(struct kobject *kobj,
59f69015	102	struct bin_attribute *attr);
995982ca	103	void sysfs_remove_bin_file(struct kobject kobj, struct bin_attribute attr);
1da177e4	104
59f69015 TH	105	int __must_check sysfs_create_link(struct kobject kobj, struct kobject target,
59f69015 TH	106	const char *name);
36ce6dad CH	107	int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
	108	struct kobject *target,
	109	const char *name);
59f69015 TH	110	void sysfs_remove_link(struct kobject kobj, const char name);
	111
	112	int __must_check sysfs_create_group(struct kobject *kobj,
	113	const struct attribute_group *grp);
0f423895 JB	114	int sysfs_update_group(struct kobject *kobj,
0f423895 JB	115	const struct attribute_group *grp);
59f69015 TH	116	void sysfs_remove_group(struct kobject *kobj,
59f69015 TH	117	const struct attribute_group *grp);
dfa87c82	118	int sysfs_add_file_to_group(struct kobject *kobj,
59f69015	119	const struct attribute attr, const char group);
dfa87c82	120	void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015	121	const struct attribute attr, const char group);
dfa87c82	122
8c0e3998	123	void sysfs_notify(struct kobject kobj, const char dir, const char *attr);
f1282c84 NB	124	void sysfs_notify_dirent(struct sysfs_dirent *sd);
	125	struct sysfs_dirent sysfs_get_dirent(struct sysfs_dirent parent_sd,
	126	const unsigned char *name);
	127	struct sysfs_dirent sysfs_get(struct sysfs_dirent sd);
	128	void sysfs_put(struct sysfs_dirent *sd);
ae87221d	129	void sysfs_printk_last_file(void);
f1282c84	130	int __must_check sysfs_init(void);
f20a9ead	131
1da177e4 LT	132	#else /* CONFIG_SYSFS */
1da177e4 LT	133
d9a9cdfb	134	static inline int sysfs_schedule_callback(struct kobject *kobj,
523ded71	135	void (func)(void ), void data, struct module owner)
d9a9cdfb AS	136	{
	137	return -ENOSYS;
	138	}
	139
59f69015	140	static inline int sysfs_create_dir(struct kobject *kobj)
1da177e4 LT	141	{
	142	return 0;
	143	}
	144
59f69015	145	static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4	146	{
1da177e4 LT	147	}
1da177e4 LT	148
59f69015	149	static inline int sysfs_rename_dir(struct kobject kobj, const char new_name)
1da177e4	150	{
0b4a4fea	151	return 0;
1da177e4 LT	152	}
1da177e4 LT	153
59f69015 TH	154	static inline int sysfs_move_dir(struct kobject *kobj,
59f69015 TH	155	struct kobject *new_parent_kobj)
8a82472f CH	156	{
	157	return 0;
	158	}
	159
59f69015 TH	160	static inline int sysfs_create_file(struct kobject *kobj,
59f69015 TH	161	const struct attribute *attr)
1da177e4 LT	162	{
	163	return 0;
	164	}
	165
59f69015 TH	166	static inline int sysfs_chmod_file(struct kobject *kobj,
59f69015 TH	167	struct attribute *attr, mode_t mode)
31e5abe9 KS	168	{
	169	return 0;
	170	}
1da177e4	171
59f69015 TH	172	static inline void sysfs_remove_file(struct kobject *kobj,
59f69015 TH	173	const struct attribute *attr)
1da177e4	174	{
1da177e4 LT	175	}
1da177e4 LT	176
59f69015 TH	177	static inline int sysfs_create_bin_file(struct kobject *kobj,
59f69015 TH	178	struct bin_attribute *attr)
1da177e4 LT	179	{
	180	return 0;
	181	}
	182
3612e06b DR	183	static inline void sysfs_remove_bin_file(struct kobject *kobj,
3612e06b DR	184	struct bin_attribute *attr)
1da177e4	185	{
1da177e4 LT	186	}
1da177e4 LT	187
59f69015 TH	188	static inline int sysfs_create_link(struct kobject *kobj,
59f69015 TH	189	struct kobject target, const char name)
1da177e4 LT	190	{
	191	return 0;
	192	}
	193
36ce6dad CH	194	static inline int sysfs_create_link_nowarn(struct kobject *kobj,
	195	struct kobject *target,
	196	const char *name)
	197	{
	198	return 0;
	199	}
	200
59f69015	201	static inline void sysfs_remove_link(struct kobject kobj, const char name)
1da177e4	202	{
1da177e4 LT	203	}
1da177e4 LT	204
59f69015 TH	205	static inline int sysfs_create_group(struct kobject *kobj,
59f69015 TH	206	const struct attribute_group *grp)
1da177e4 LT	207	{
	208	return 0;
	209	}
	210
1cbfb7a5 RD	211	static inline int sysfs_update_group(struct kobject *kobj,
	212	const struct attribute_group *grp)
	213	{
	214	return 0;
	215	}
	216
59f69015 TH	217	static inline void sysfs_remove_group(struct kobject *kobj,
59f69015 TH	218	const struct attribute_group *grp)
1da177e4	219	{
1da177e4 LT	220	}
1da177e4 LT	221
dfa87c82 AS	222	static inline int sysfs_add_file_to_group(struct kobject *kobj,
	223	const struct attribute attr, const char group)
	224	{
	225	return 0;
	226	}
	227
	228	static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3	229	const struct attribute attr, const char group)
dfa87c82	230	{
dfa87c82 AS	231	}
dfa87c82 AS	232
8c0e3998 TP	233	static inline void sysfs_notify(struct kobject kobj, const char dir,
8c0e3998 TP	234	const char *attr)
4508a7a7 N	235	{
4508a7a7 N	236	}
f1282c84 NB	237	static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
	238	{
	239	}
	240	static inline
	241	struct sysfs_dirent sysfs_get_dirent(struct sysfs_dirent parent_sd,
	242	const unsigned char *name)
	243	{
	244	return NULL;
	245	}
	246	static inline struct sysfs_dirent sysfs_get(struct sysfs_dirent sd)
	247	{
	248	return NULL;
	249	}
	250	static inline void sysfs_put(struct sysfs_dirent *sd)
	251	{
	252	}
4508a7a7	253
f20a9ead AM	254	static inline int __must_check sysfs_init(void)
	255	{
	256	return 0;
	257	}
	258
ae87221d AM	259	static inline void sysfs_printk_last_file(void)
	260	{
	261	}
	262
1da177e4 LT	263	#endif /* CONFIG_SYSFS */
	264
	265	#endif /* _SYSFS_H_ */