srm_env.c 6.79 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4
/*
 * srm_env.c - Access to SRM environment
 *             variables through linux' procfs
 *
5
 * (C) 2001,2002,2006 by Jan-Benedict Glaw <jbglaw@lug-owl.de>
Linus Torvalds's avatar
Linus Torvalds committed
6
 *
Paul Bolle's avatar
Paul Bolle committed
7 8
 * This driver is a modified version of Erik Mouw's example proc
 * interface, so: thank you, Erik! He can be reached via email at
Linus Torvalds's avatar
Linus Torvalds committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * <J.A.K.Mouw@its.tudelft.nl>. It is based on an idea
 * provided by DEC^WCompaq^WIntel's "Jumpstart" CD. They
 * included a patch like this as well. Thanks for idea!
 *
 * 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.
 *
 * This program is distributed in the hope that it will be
 * useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more
 * details.
23
 *
Linus Torvalds's avatar
Linus Torvalds committed
24 25 26 27 28 29 30 31
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include <linux/kernel.h>
32
#include <linux/gfp.h>
Linus Torvalds's avatar
Linus Torvalds committed
33 34 35
#include <linux/module.h>
#include <linux/init.h>
#include <linux/proc_fs.h>
36
#include <linux/seq_file.h>
Linus Torvalds's avatar
Linus Torvalds committed
37 38 39 40 41 42 43
#include <asm/console.h>
#include <asm/uaccess.h>
#include <asm/machvec.h>

#define BASE_DIR	"srm_environment"	/* Subdir in /proc/		*/
#define NAMED_DIR	"named_variables"	/* Subdir for known variables	*/
#define NUMBERED_DIR	"numbered_variables"	/* Subdir for all variables	*/
44
#define VERSION		"0.0.6"			/* Module version		*/
Linus Torvalds's avatar
Linus Torvalds committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
#define NAME		"srm_env"		/* Module name			*/

MODULE_AUTHOR("Jan-Benedict Glaw <jbglaw@lug-owl.de>");
MODULE_DESCRIPTION("Accessing Alpha SRM environment through procfs interface");
MODULE_LICENSE("GPL");

typedef struct _srm_env {
	char			*name;
	unsigned long		id;
	struct proc_dir_entry	*proc_entry;
} srm_env_t;

static struct proc_dir_entry	*base_dir;
static struct proc_dir_entry	*named_dir;
static struct proc_dir_entry	*numbered_dir;
static char			number[256][4];

static srm_env_t	srm_named_entries[] = {
	{ "auto_action",	ENV_AUTO_ACTION		},
	{ "boot_dev",		ENV_BOOT_DEV		},
	{ "bootdef_dev",	ENV_BOOTDEF_DEV		},
	{ "booted_dev",		ENV_BOOTED_DEV		},
	{ "boot_file",		ENV_BOOT_FILE		},
	{ "booted_file",	ENV_BOOTED_FILE		},
	{ "boot_osflags",	ENV_BOOT_OSFLAGS	},
	{ "booted_osflags",	ENV_BOOTED_OSFLAGS	},
	{ "boot_reset",		ENV_BOOT_RESET		},
	{ "dump_dev",		ENV_DUMP_DEV		},
	{ "enable_audit",	ENV_ENABLE_AUDIT	},
	{ "license",		ENV_LICENSE		},
	{ "char_set",		ENV_CHAR_SET		},
	{ "language",		ENV_LANGUAGE		},
	{ "tty_dev",		ENV_TTY_DEV		},
	{ NULL,			0			},
};
static srm_env_t	srm_numbered_entries[256];


83
static int srm_env_proc_show(struct seq_file *m, void *v)
Linus Torvalds's avatar
Linus Torvalds committed
84 85 86
{
	unsigned long	ret;
	srm_env_t	*entry;
87
	char		*page;
Linus Torvalds's avatar
Linus Torvalds committed
88

89
	entry = m->private;
90 91 92
	page = (char *)__get_free_page(GFP_USER);
	if (!page)
		return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
93

94
	ret = callback_getenv(entry->id, page, PAGE_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
95

96
	if ((ret >> 61) == 0) {
97 98
		seq_write(m, page, ret);
		ret = 0;
99
	} else
100 101 102 103
		ret = -EFAULT;
	free_page((unsigned long)page);
	return ret;
}
Linus Torvalds's avatar
Linus Torvalds committed
104

105 106 107
static int srm_env_proc_open(struct inode *inode, struct file *file)
{
	return single_open(file, srm_env_proc_show, PDE(inode)->data);
Linus Torvalds's avatar
Linus Torvalds committed
108 109
}

110 111
static ssize_t srm_env_proc_write(struct file *file, const char __user *buffer,
				  size_t count, loff_t *pos)
Linus Torvalds's avatar
Linus Torvalds committed
112 113
{
	int res;
Al Viro's avatar
Al Viro committed
114
	srm_env_t	*entry = PDE(file_inode(file))->data;
Linus Torvalds's avatar
Linus Torvalds committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
	char		*buf = (char *) __get_free_page(GFP_USER);
	unsigned long	ret1, ret2;

	if (!buf)
		return -ENOMEM;

	res = -EINVAL;
	if (count >= PAGE_SIZE)
		goto out;

	res = -EFAULT;
	if (copy_from_user(buf, buffer, count))
		goto out;
	buf[count] = '\0';

	ret1 = callback_setenv(entry->id, buf, count);
	if ((ret1 >> 61) == 0) {
132
		do
Linus Torvalds's avatar
Linus Torvalds committed
133 134 135 136 137 138 139 140 141 142
			ret2 = callback_save_env();
		while((ret2 >> 61) == 1);
		res = (int) ret1;
	}

 out:
	free_page((unsigned long)buf);
	return res;
}

143 144 145 146 147 148 149 150 151
static const struct file_operations srm_env_proc_fops = {
	.owner		= THIS_MODULE,
	.open		= srm_env_proc_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
	.write		= srm_env_proc_write,
};

Linus Torvalds's avatar
Linus Torvalds committed
152 153 154 155 156 157
static void
srm_env_cleanup(void)
{
	srm_env_t	*entry;
	unsigned long	var_num;

158
	if (base_dir) {
Linus Torvalds's avatar
Linus Torvalds committed
159 160 161
		/*
		 * Remove named entries
		 */
162
		if (named_dir) {
Linus Torvalds's avatar
Linus Torvalds committed
163
			entry = srm_named_entries;
164 165
			while (entry->name != NULL && entry->id != 0) {
				if (entry->proc_entry) {
Linus Torvalds's avatar
Linus Torvalds committed
166 167 168 169 170 171 172 173 174 175 176 177
					remove_proc_entry(entry->name,
							named_dir);
					entry->proc_entry = NULL;
				}
				entry++;
			}
			remove_proc_entry(NAMED_DIR, base_dir);
		}

		/*
		 * Remove numbered entries
		 */
178 179
		if (numbered_dir) {
			for (var_num = 0; var_num <= 255; var_num++) {
Linus Torvalds's avatar
Linus Torvalds committed
180 181
				entry =	&srm_numbered_entries[var_num];

182
				if (entry->proc_entry) {
Linus Torvalds's avatar
Linus Torvalds committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
					remove_proc_entry(entry->name,
							numbered_dir);
					entry->proc_entry	= NULL;
					entry->name		= NULL;
				}
			}
			remove_proc_entry(NUMBERED_DIR, base_dir);
		}

		remove_proc_entry(BASE_DIR, NULL);
	}

	return;
}

static int __init
srm_env_init(void)
{
	srm_env_t	*entry;
	unsigned long	var_num;

	/*
	 * Check system
	 */
207
	if (!alpha_using_srm) {
Linus Torvalds's avatar
Linus Torvalds committed
208 209 210
		printk(KERN_INFO "%s: This Alpha system doesn't "
				"know about SRM (or you've booted "
				"SRM->MILO->Linux, which gets "
211
				"misdetected)...\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
212 213 214 215 216 217
		return -ENODEV;
	}

	/*
	 * Init numbers
	 */
218
	for (var_num = 0; var_num <= 255; var_num++)
Linus Torvalds's avatar
Linus Torvalds committed
219 220 221 222 223 224
		sprintf(number[var_num], "%ld", var_num);

	/*
	 * Create base directory
	 */
	base_dir = proc_mkdir(BASE_DIR, NULL);
225
	if (!base_dir) {
Linus Torvalds's avatar
Linus Torvalds committed
226 227 228 229 230 231 232 233 234
		printk(KERN_ERR "Couldn't create base dir /proc/%s\n",
				BASE_DIR);
		goto cleanup;
	}

	/*
	 * Create per-name subdirectory
	 */
	named_dir = proc_mkdir(NAMED_DIR, base_dir);
235
	if (!named_dir) {
Linus Torvalds's avatar
Linus Torvalds committed
236 237 238 239 240 241 242 243 244
		printk(KERN_ERR "Couldn't create dir /proc/%s/%s\n",
				BASE_DIR, NAMED_DIR);
		goto cleanup;
	}

	/*
	 * Create per-number subdirectory
	 */
	numbered_dir = proc_mkdir(NUMBERED_DIR, base_dir);
245
	if (!numbered_dir) {
Linus Torvalds's avatar
Linus Torvalds committed
246 247 248 249 250 251 252 253 254 255
		printk(KERN_ERR "Couldn't create dir /proc/%s/%s\n",
				BASE_DIR, NUMBERED_DIR);
		goto cleanup;

	}

	/*
	 * Create all named nodes
	 */
	entry = srm_named_entries;
256
	while (entry->name && entry->id) {
257 258
		entry->proc_entry = proc_create_data(entry->name, 0644, named_dir,
						     &srm_env_proc_fops, entry);
259
		if (!entry->proc_entry)
Linus Torvalds's avatar
Linus Torvalds committed
260 261 262 263 264 265 266
			goto cleanup;
		entry++;
	}

	/*
	 * Create all numbered nodes
	 */
267
	for (var_num = 0; var_num <= 255; var_num++) {
Linus Torvalds's avatar
Linus Torvalds committed
268 269 270
		entry = &srm_numbered_entries[var_num];
		entry->name = number[var_num];

271 272
		entry->proc_entry = proc_create_data(entry->name, 0644, numbered_dir,
						     &srm_env_proc_fops, entry);
273
		if (!entry->proc_entry)
Linus Torvalds's avatar
Linus Torvalds committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
			goto cleanup;

		entry->id			= var_num;
	}

	printk(KERN_INFO "%s: version %s loaded successfully\n", NAME,
			VERSION);

	return 0;

cleanup:
	srm_env_cleanup();

	return -ENOMEM;
}

static void __exit
srm_env_exit(void)
{
	srm_env_cleanup();
	printk(KERN_INFO "%s: unloaded successfully\n", NAME);

	return;
}

module_init(srm_env_init);
module_exit(srm_env_exit);