diff options
Diffstat (limited to 'fs/debugfs/file.c')
| -rw-r--r-- | fs/debugfs/file.c | 299 | 
1 files changed, 263 insertions, 36 deletions
diff --git a/fs/debugfs/file.c b/fs/debugfs/file.c index 89d394d8fe2..63146295153 100644 --- a/fs/debugfs/file.c +++ b/fs/debugfs/file.c @@ -15,9 +15,13 @@  #include <linux/module.h>  #include <linux/fs.h> +#include <linux/seq_file.h>  #include <linux/pagemap.h>  #include <linux/namei.h>  #include <linux/debugfs.h> +#include <linux/io.h> +#include <linux/slab.h> +#include <linux/atomic.h>  static ssize_t default_read_file(struct file *file, char __user *buf,  				 size_t count, loff_t *ppos) @@ -31,18 +35,10 @@ static ssize_t default_write_file(struct file *file, const char __user *buf,  	return count;  } -static int default_open(struct inode *inode, struct file *file) -{ -	if (inode->i_private) -		file->private_data = inode->i_private; - -	return 0; -} -  const struct file_operations debugfs_file_operations = {  	.read =		default_read_file,  	.write =	default_write_file, -	.open =		default_open, +	.open =		simple_open,  	.llseek =	noop_llseek,  }; @@ -95,7 +91,7 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_u8(const char *name, mode_t mode, +struct dentry *debugfs_create_u8(const char *name, umode_t mode,  				 struct dentry *parent, u8 *value)  {  	/* if there are no write bits set, make read only */ @@ -147,7 +143,7 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_u16(const char *name, mode_t mode, +struct dentry *debugfs_create_u16(const char *name, umode_t mode,  				  struct dentry *parent, u16 *value)  {  	/* if there are no write bits set, make read only */ @@ -199,7 +195,7 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_u32(const char *name, mode_t mode, +struct dentry *debugfs_create_u32(const char *name, umode_t mode,  				 struct dentry *parent, u32 *value)  {  	/* if there are no write bits set, make read only */ @@ -252,7 +248,7 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_u64(const char *name, mode_t mode, +struct dentry *debugfs_create_u64(const char *name, umode_t mode,  				 struct dentry *parent, u64 *value)  {  	/* if there are no write bits set, make read only */ @@ -298,7 +294,7 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n   * @value: a pointer to the variable that the file should read to and write   *         from.   */ -struct dentry *debugfs_create_x8(const char *name, mode_t mode, +struct dentry *debugfs_create_x8(const char *name, umode_t mode,  				 struct dentry *parent, u8 *value)  {  	/* if there are no write bits set, make read only */ @@ -322,7 +318,7 @@ EXPORT_SYMBOL_GPL(debugfs_create_x8);   * @value: a pointer to the variable that the file should read to and write   *         from.   */ -struct dentry *debugfs_create_x16(const char *name, mode_t mode, +struct dentry *debugfs_create_x16(const char *name, umode_t mode,  				 struct dentry *parent, u16 *value)  {  	/* if there are no write bits set, make read only */ @@ -346,7 +342,7 @@ EXPORT_SYMBOL_GPL(debugfs_create_x16);   * @value: a pointer to the variable that the file should read to and write   *         from.   */ -struct dentry *debugfs_create_x32(const char *name, mode_t mode, +struct dentry *debugfs_create_x32(const char *name, umode_t mode,  				 struct dentry *parent, u32 *value)  {  	/* if there are no write bits set, make read only */ @@ -370,7 +366,7 @@ EXPORT_SYMBOL_GPL(debugfs_create_x32);   * @value: a pointer to the variable that the file should read to and write   *         from.   */ -struct dentry *debugfs_create_x64(const char *name, mode_t mode, +struct dentry *debugfs_create_x64(const char *name, umode_t mode,  				 struct dentry *parent, u64 *value)  {  	return debugfs_create_file(name, mode, parent, value, &fops_x64); @@ -401,13 +397,54 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,   * @value: a pointer to the variable that the file should read to and write   *         from.   */ -struct dentry *debugfs_create_size_t(const char *name, mode_t mode, +struct dentry *debugfs_create_size_t(const char *name, umode_t mode,  				     struct dentry *parent, size_t *value)  {  	return debugfs_create_file(name, mode, parent, value, &fops_size_t);  }  EXPORT_SYMBOL_GPL(debugfs_create_size_t); +static int debugfs_atomic_t_set(void *data, u64 val) +{ +	atomic_set((atomic_t *)data, val); +	return 0; +} +static int debugfs_atomic_t_get(void *data, u64 *val) +{ +	*val = atomic_read((atomic_t *)data); +	return 0; +} +DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get, +			debugfs_atomic_t_set, "%lld\n"); +DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%lld\n"); +DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%lld\n"); + +/** + * debugfs_create_atomic_t - create a debugfs file that is used to read and + * write an atomic_t value + * @name: a pointer to a string containing the name of the file to create. + * @mode: the permission that the file should have + * @parent: a pointer to the parent dentry for this file.  This should be a + *          directory dentry if set.  If this parameter is %NULL, then the + *          file will be created in the root of the debugfs filesystem. + * @value: a pointer to the variable that the file should read to and write + *         from. + */ +struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, +				 struct dentry *parent, atomic_t *value) +{ +	/* if there are no write bits set, make read only */ +	if (!(mode & S_IWUGO)) +		return debugfs_create_file(name, mode, parent, value, +					&fops_atomic_t_ro); +	/* if there are no read bits set, make write only */ +	if (!(mode & S_IRUGO)) +		return debugfs_create_file(name, mode, parent, value, +					&fops_atomic_t_wo); + +	return debugfs_create_file(name, mode, parent, value, &fops_atomic_t); +} +EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);  static ssize_t read_file_bool(struct file *file, char __user *user_buf,  			      size_t count, loff_t *ppos) @@ -428,33 +465,25 @@ static ssize_t write_file_bool(struct file *file, const char __user *user_buf,  			       size_t count, loff_t *ppos)  {  	char buf[32]; -	int buf_size; +	size_t buf_size; +	bool bv;  	u32 *val = file->private_data;  	buf_size = min(count, (sizeof(buf)-1));  	if (copy_from_user(buf, user_buf, buf_size))  		return -EFAULT; -	switch (buf[0]) { -	case 'y': -	case 'Y': -	case '1': -		*val = 1; -		break; -	case 'n': -	case 'N': -	case '0': -		*val = 0; -		break; -	} -	 +	buf[buf_size] = '\0'; +	if (strtobool(buf, &bv) == 0) +		*val = bv; +  	return count;  }  static const struct file_operations fops_bool = {  	.read =		read_file_bool,  	.write =	write_file_bool, -	.open =		default_open, +	.open =		simple_open,  	.llseek =	default_llseek,  }; @@ -482,7 +511,7 @@ static const struct file_operations fops_bool = {   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_bool(const char *name, mode_t mode, +struct dentry *debugfs_create_bool(const char *name, umode_t mode,  				   struct dentry *parent, u32 *value)  {  	return debugfs_create_file(name, mode, parent, value, &fops_bool); @@ -499,7 +528,7 @@ static ssize_t read_file_blob(struct file *file, char __user *user_buf,  static const struct file_operations fops_blob = {  	.read =		read_file_blob, -	.open =		default_open, +	.open =		simple_open,  	.llseek =	default_llseek,  }; @@ -527,10 +556,208 @@ static const struct file_operations fops_blob = {   * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling   * code.   */ -struct dentry *debugfs_create_blob(const char *name, mode_t mode, +struct dentry *debugfs_create_blob(const char *name, umode_t mode,  				   struct dentry *parent,  				   struct debugfs_blob_wrapper *blob)  {  	return debugfs_create_file(name, mode, parent, blob, &fops_blob);  }  EXPORT_SYMBOL_GPL(debugfs_create_blob); + +struct array_data { +	void *array; +	u32 elements; +}; + +static size_t u32_format_array(char *buf, size_t bufsize, +			       u32 *array, int array_size) +{ +	size_t ret = 0; + +	while (--array_size >= 0) { +		size_t len; +		char term = array_size ? ' ' : '\n'; + +		len = snprintf(buf, bufsize, "%u%c", *array++, term); +		ret += len; + +		buf += len; +		bufsize -= len; +	} +	return ret; +} + +static int u32_array_open(struct inode *inode, struct file *file) +{ +	struct array_data *data = inode->i_private; +	int size, elements = data->elements; +	char *buf; + +	/* +	 * Max size: +	 *  - 10 digits + ' '/'\n' = 11 bytes per number +	 *  - terminating NUL character +	 */ +	size = elements*11; +	buf = kmalloc(size+1, GFP_KERNEL); +	if (!buf) +		return -ENOMEM; +	buf[size] = 0; + +	file->private_data = buf; +	u32_format_array(buf, size, data->array, data->elements); + +	return nonseekable_open(inode, file); +} + +static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len, +			      loff_t *ppos) +{ +	size_t size = strlen(file->private_data); + +	return simple_read_from_buffer(buf, len, ppos, +					file->private_data, size); +} + +static int u32_array_release(struct inode *inode, struct file *file) +{ +	kfree(file->private_data); + +	return 0; +} + +static const struct file_operations u32_array_fops = { +	.owner	 = THIS_MODULE, +	.open	 = u32_array_open, +	.release = u32_array_release, +	.read	 = u32_array_read, +	.llseek  = no_llseek, +}; + +/** + * debugfs_create_u32_array - create a debugfs file that is used to read u32 + * array. + * @name: a pointer to a string containing the name of the file to create. + * @mode: the permission that the file should have. + * @parent: a pointer to the parent dentry for this file.  This should be a + *          directory dentry if set.  If this parameter is %NULL, then the + *          file will be created in the root of the debugfs filesystem. + * @array: u32 array that provides data. + * @elements: total number of elements in the array. + * + * This function creates a file in debugfs with the given name that exports + * @array as data. If the @mode variable is so set it can be read from. + * Writing is not supported. Seek within the file is also not supported. + * Once array is created its size can not be changed. + * + * The function returns a pointer to dentry on success. If debugfs is not + * enabled in the kernel, the value -%ENODEV will be returned. + */ +struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, +					    struct dentry *parent, +					    u32 *array, u32 elements) +{ +	struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL); + +	if (data == NULL) +		return NULL; + +	data->array = array; +	data->elements = elements; + +	return debugfs_create_file(name, mode, parent, data, &u32_array_fops); +} +EXPORT_SYMBOL_GPL(debugfs_create_u32_array); + +#ifdef CONFIG_HAS_IOMEM + +/* + * The regset32 stuff is used to print 32-bit registers using the + * seq_file utilities. We offer printing a register set in an already-opened + * sequential file or create a debugfs file that only prints a regset32. + */ + +/** + * debugfs_print_regs32 - use seq_print to describe a set of registers + * @s: the seq_file structure being used to generate output + * @regs: an array if struct debugfs_reg32 structures + * @nregs: the length of the above array + * @base: the base address to be used in reading the registers + * @prefix: a string to be prefixed to every output line + * + * This function outputs a text block describing the current values of + * some 32-bit hardware registers. It is meant to be used within debugfs + * files based on seq_file that need to show registers, intermixed with other + * information. The prefix argument may be used to specify a leading string, + * because some peripherals have several blocks of identical registers, + * for example configuration of dma channels + */ +int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, +			   int nregs, void __iomem *base, char *prefix) +{ +	int i, ret = 0; + +	for (i = 0; i < nregs; i++, regs++) { +		if (prefix) +			ret += seq_printf(s, "%s", prefix); +		ret += seq_printf(s, "%s = 0x%08x\n", regs->name, +				  readl(base + regs->offset)); +	} +	return ret; +} +EXPORT_SYMBOL_GPL(debugfs_print_regs32); + +static int debugfs_show_regset32(struct seq_file *s, void *data) +{ +	struct debugfs_regset32 *regset = s->private; + +	debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, ""); +	return 0; +} + +static int debugfs_open_regset32(struct inode *inode, struct file *file) +{ +	return single_open(file, debugfs_show_regset32, inode->i_private); +} + +static const struct file_operations fops_regset32 = { +	.open =		debugfs_open_regset32, +	.read =		seq_read, +	.llseek =	seq_lseek, +	.release =	single_release, +}; + +/** + * debugfs_create_regset32 - create a debugfs file that returns register values + * @name: a pointer to a string containing the name of the file to create. + * @mode: the permission that the file should have + * @parent: a pointer to the parent dentry for this file.  This should be a + *          directory dentry if set.  If this parameter is %NULL, then the + *          file will be created in the root of the debugfs filesystem. + * @regset: a pointer to a struct debugfs_regset32, which contains a pointer + *          to an array of register definitions, the array size and the base + *          address where the register bank is to be found. + * + * This function creates a file in debugfs with the given name that reports + * the names and values of a set of 32-bit registers. If the @mode variable + * is so set it can be read from. Writing is not supported. + * + * This function will return a pointer to a dentry if it succeeds.  This + * pointer must be passed to the debugfs_remove() function when the file is + * to be removed (no automatic cleanup happens if your module is unloaded, + * you are responsible here.)  If an error occurs, %NULL will be returned. + * + * If debugfs is not enabled in the kernel, the value -%ENODEV will be + * returned.  It is not wise to check for this value, but rather, check for + * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling + * code. + */ +struct dentry *debugfs_create_regset32(const char *name, umode_t mode, +				       struct dentry *parent, +				       struct debugfs_regset32 *regset) +{ +	return debugfs_create_file(name, mode, parent, regset, &fops_regset32); +} +EXPORT_SYMBOL_GPL(debugfs_create_regset32); + +#endif /* CONFIG_HAS_IOMEM */  | 
