patch-2.1.16 linux/drivers/sbus/char/openprom.c

• Lines: 611
• Date: Fri Dec 13 11:37:32 1996
• Orig file: v2.1.15/linux/drivers/sbus/char/openprom.c
• Orig date: Thu Jan 1 02:00:00 1970

diff -u --recursive --new-file v2.1.15/linux/drivers/sbus/char/openprom.c linux/drivers/sbus/char/openprom.c
@@ -0,0 +1,610 @@
+/*
+ * Linux/SPARC PROM Configuration Driver
+ * Copyright (C) 1996 Thomas K. Dyas (tdyas@eden.rutgers.edu)
+ * Copyright (C) 1996 Eddie C. Dost  (ecd@skynet.be)
+ *
+ * This character device driver allows user programs to access the
+ * PROM device tree. It is compatible with the SunOS /dev/openprom
+ * driver and the NetBSD /dev/openprom driver. The SunOS eeprom
+ * utility works without any modifications.
+ *
+ * The driver uses a minor number under the misc device major. The
+ * file read/write mode determines the type of access to the PROM.
+ * Interrupts are disabled whenever the driver calls into the PROM for
+ * sanity's sake.
+ */
+
+/* This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * 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.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA. 
+ */
+
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/sched.h>
+#include <linux/errno.h>
+#include <linux/malloc.h>
+#include <linux/string.h>
+#include <linux/miscdevice.h>
+#include <linux/init.h>
+#include <asm/oplib.h>
+#include <asm/system.h>
+#include <asm/uaccess.h>
+
+#include <linux/openpromio.h>
+
+/* Private data kept by the driver for each descriptor. */
+typedef struct openprom_private_data
+{
+	int current_node;	/* Current node for SunOS ioctls. */
+	int lastnode;		/* Last valid node used by BSD ioctls. */
+} DATA;
+
+/* ID of the PROM node containing all of the EEPROM options. */
+static int options_node = 0;
+
+/*
+ * Copy an openpromio structure into kernel space from user space.
+ * This routine does error checking to make sure that all memory
+ * accesses are within bounds. A pointer to the allocated openpromio
+ * structure will be placed in "*opp_p". Return value is the length
+ * of the user supplied buffer.
+ */
+static int copyin(struct openpromio *info, struct openpromio **opp_p)
+{
+	int bufsize;
+
+	if (!info || !opp_p)
+		return -EFAULT;
+
+	get_user_ret(bufsize, &info->oprom_size, -EFAULT);
+
+	if (bufsize == 0 || bufsize > OPROMMAXPARAM)
+		return -EINVAL;
+
+	if (!(*opp_p = kmalloc(sizeof(int) + bufsize + 1, GFP_KERNEL)))
+		return -ENOMEM;
+	memset(*opp_p, 0, sizeof(int) + bufsize + 1);
+
+	if (copy_from_user(&(*opp_p)->oprom_array,
+			   &info->oprom_array, bufsize)) {
+		kfree(*opp_p);
+		return -EFAULT;
+	}
+	return bufsize;
+}
+
+static int getstrings(struct openpromio *info, struct openpromio **opp_p)
+{
+	int n, bufsize;
+	char c;
+
+	if (!info || !opp_p)
+		return -EFAULT;
+
+	if (!(*opp_p = kmalloc(sizeof(int) + OPROMMAXPARAM + 1, GFP_KERNEL)))
+		return -ENOMEM;
+
+	memset(*opp_p, 0, sizeof(int) + OPROMMAXPARAM + 1);
+	(*opp_p)->oprom_size = 0;
+
+	n = bufsize = 0;
+	while ((n < 2) && (bufsize < OPROMMAXPARAM)) {
+		if (get_user(c, &info->oprom_array[bufsize])) {
+			kfree(*opp_p);
+			return -EFAULT;
+		}
+		if (c == '\0')
+			n++;
+		(*opp_p)->oprom_array[bufsize++] = c;
+	}
+	if (!n) {
+		kfree(*opp_p);
+		return -EINVAL;
+	}
+	return bufsize;
+}
+
+/*
+ * Copy an openpromio structure in kernel space back to user space.
+ */
+static int copyout(void *info, struct openpromio *opp, int len)
+{
+	copy_to_user_ret(info, opp, len, -EFAULT);
+	return 0;
+}
+
+/*
+ *	SunOS and Solaris /dev/openprom ioctl calls.
+ */
+static int openprom_sunos_ioctl(struct inode * inode, struct file * file,
+				unsigned int cmd, unsigned long arg, int node)
+{
+	DATA *data = (DATA *) file->private_data;
+	char buffer[OPROMMAXPARAM+1], *buf;
+	struct openpromio *opp;
+	unsigned long flags;
+	int bufsize, len, error = 0;
+
+	if (cmd == OPROMSETOPT)
+		bufsize = getstrings((void *)arg, &opp);
+	else
+		bufsize = copyin((void *)arg, &opp);
+
+	if (bufsize < 0)
+		return bufsize;
+
+	switch (cmd) {
+	case OPROMGETOPT:
+	case OPROMGETPROP:
+		save_and_cli(flags);
+		len = prom_getproplen(node, opp->oprom_array);
+		restore_flags(flags);
+
+		if (len <= 0 || len > bufsize) {
+			error = copyout((void *)arg, opp, sizeof(int));
+			break;
+		}
+
+		save_and_cli(flags);
+		len = prom_getproperty(node, opp->oprom_array, buffer, bufsize);
+		restore_flags(flags);
+
+		memcpy(opp->oprom_array, buffer, len);
+		opp->oprom_array[len] = '\0';
+		opp->oprom_size = len;
+
+		error = copyout((void *)arg, opp, sizeof(int) + bufsize);
+		break;
+
+	case OPROMNXTOPT:
+	case OPROMNXTPROP:
+		save_and_cli(flags);
+		buf = prom_nextprop(node, opp->oprom_array);
+		restore_flags(flags);
+
+		len = strlen(buf);
+		if (len == 0 || len + 1 > bufsize) {
+			error = copyout((void *)arg, opp, sizeof(int));
+			break;
+		}
+
+		memcpy(opp->oprom_array, buf, len);
+		opp->oprom_array[len] = '\0';
+		opp->oprom_size = ++len;
+
+		error = copyout((void *)arg, opp, sizeof(int) + bufsize);
+		break;
+
+	case OPROMSETOPT:
+	case OPROMSETOPT2:
+		buf = opp->oprom_array + strlen(opp->oprom_array) + 1;
+		len = opp->oprom_array + bufsize - buf;
+
+		printk(KERN_DEBUG "OPROMSETOPT%s %s='%s'\n",
+		       (cmd == OPROMSETOPT) ? "" : "2", opp->oprom_array, buf);
+
+		save_and_cli(flags);
+		error = prom_setprop(options_node, opp->oprom_array,
+				     buf, len);
+		restore_flags(flags);
+
+		if (error <= 0)
+			error = -EINVAL;
+		break;
+
+	case OPROMNEXT:
+	case OPROMCHILD:
+		if (bufsize < sizeof(int)) {
+			error = -EINVAL;
+			break;
+		}
+
+		node = *((int *) opp->oprom_array);
+
+		save_and_cli(flags);
+		if (cmd == OPROMNEXT)
+			node = prom_nodeops->no_nextnode(node);
+		else
+			node = prom_nodeops->no_child(node);
+		restore_flags(flags);
+
+		data->current_node = node;
+		*((int *)opp->oprom_array) = node;
+		opp->oprom_size = sizeof(int);
+
+		error = copyout((void *)arg, opp, bufsize + sizeof(int));
+		break;
+
+	case OPROMGETBOOTARGS:
+		save_and_cli(flags);
+		buf = prom_getbootargs();
+		restore_flags(flags);
+
+		len = strlen(buf);
+
+		if (len > bufsize) {
+			error = -EINVAL;
+			break;
+		}
+
+		strcpy(opp->oprom_array, buf);
+		opp->oprom_size = len;
+
+		error = copyout((void *)arg, opp, bufsize + sizeof(int));
+		break;
+
+	case OPROMU2P:
+	case OPROMGETCONS:
+	case OPROMGETFBNAME:
+		printk(KERN_INFO "openprom_sunos_ioctl: unimplemented ioctl\n");
+		error = -EINVAL;
+		break;
+	default:
+		printk(KERN_INFO "openprom_sunos_ioctl: cmd 0x%X, arg 0x%lX\n", cmd, arg);
+		error = -EINVAL;
+		break;
+	}
+
+	kfree(opp);
+	return error;
+}
+
+
+/* Return nonzero if a specific node is in the PROM device tree. */
+static int intree(int root, int node)
+{
+	for (; root != 0; root = prom_getsibling(root))
+		if (root == node || intree(prom_getchild(root),node))
+			return 1;
+	return 0;
+}
+
+/* Return nonzero if a specific node is "valid". */
+static int goodnode(int n, DATA *data)
+{
+	if (n == data->lastnode || n == prom_root_node || n == options_node)
+		return 1;
+	if (n == 0 || n == -1 || !intree(prom_root_node,n))
+		return 0;
+	data->lastnode = n;
+	return 1;
+}
+
+/* Copy in a whole string from userspace into kernelspace. */
+static int copyin_string(char *user, size_t len, char **ptr)
+{
+	char *tmp;
+
+	tmp = kmalloc(len + 1, GFP_KERNEL);
+	if (!tmp)
+		return -ENOMEM;
+
+	if(copy_from_user(tmp, user, len)) {
+		kfree(tmp);
+		return -EFAULT;
+	}
+
+	tmp[len] = '\0';
+
+	*ptr = tmp;
+
+	return 0;
+}
+
+/*
+ *	NetBSD /dev/openprom ioctl calls.
+ */
+static int openprom_bsd_ioctl(struct inode * inode, struct file * file,
+			      unsigned int cmd, unsigned long arg)
+{
+	DATA *data = (DATA *) file->private_data;
+	struct opiocdesc op;
+	unsigned long flags;
+	int error, node, len;
+	char *str, *tmp;
+
+	switch (cmd) {
+	case OPIOCGET:
+		copy_from_user_ret(&op, (void *)arg, sizeof(op), -EFAULT);
+
+		if (!goodnode(op.op_nodeid,data))
+			return -EINVAL;
+
+		error = copyin_string(op.op_name, op.op_namelen, &str);
+		if (error)
+			return error;
+
+		save_and_cli(flags);
+		len = prom_getproplen(op.op_nodeid,str);
+		restore_flags(flags);
+
+		if (len > op.op_buflen) {
+			kfree(str);
+			return -ENOMEM;
+		}
+
+		op.op_buflen = len;
+
+		if (len <= 0) {
+			kfree(str);
+			/* Verified by the above copy_from_user_ret */
+			__copy_to_user_ret((void *)arg, &op,
+					   sizeof(op), -EFAULT);
+			return 0;
+		}
+
+		tmp = kmalloc(len + 1, GFP_KERNEL);
+		if (!tmp) {
+			kfree(str);
+			return -ENOMEM;
+		}
+
+		save_and_cli(flags);
+		prom_getproperty(op.op_nodeid, str, tmp, len);
+		restore_flags(flags);
+
+		tmp[len] = '\0';
+
+		error = __copy_to_user((void *)arg, &op, sizeof(op));
+		if (!error)
+			error = copy_to_user(op.op_buf, tmp, len);
+
+		kfree(tmp);
+		kfree(str);
+
+		return error;
+
+	case OPIOCNEXTPROP:
+		copy_from_user_ret(&op, (void *)arg, sizeof(op), -EFAULT);
+
+		if (!goodnode(op.op_nodeid,data))
+			return -EINVAL;
+
+		error = copyin_string(op.op_name, op.op_namelen, &str);
+		if (error)
+			return error;
+
+		save_and_cli(flags);
+		tmp = prom_nextprop(op.op_nodeid,str);
+		restore_flags(flags);
+
+		if (tmp) {
+			len = strlen(tmp);
+			if (len > op.op_buflen)
+				len = op.op_buflen;
+			else
+				op.op_buflen = len;
+		} else {
+			len = op.op_buflen = 0;
+		}
+
+		error = verify_area(VERIFY_WRITE, (void *)arg, sizeof(op));
+		if (error) {
+			kfree(str);
+			return error;
+		}
+
+		error = verify_area(VERIFY_WRITE, op.op_buf, len);
+		if (error) {
+			kfree(str);
+			return error;
+		}
+
+		error = __copy_to_user((void *)arg, &op, sizeof(op));
+		if (!error) error = __copy_to_user(op.op_buf, tmp, len);
+
+		kfree(str);
+
+		return error;
+
+	case OPIOCSET:
+		copy_from_user_ret(&op, (void *)arg, sizeof(op), -EFAULT);
+
+		if (!goodnode(op.op_nodeid,data))
+			return -EINVAL;
+
+		error = copyin_string(op.op_name, op.op_namelen, &str);
+		if (error)
+			return error;
+
+		error = copyin_string(op.op_buf, op.op_buflen, &tmp);
+		if (error) {
+			kfree(str);
+			return error;
+		}
+
+		save_and_cli(flags);
+		len = prom_setprop(op.op_nodeid,str,tmp,op.op_buflen+1);
+		restore_flags(flags);
+
+		if (len != op.op_buflen)
+			return -EINVAL;
+
+		kfree(str);
+		kfree(tmp);
+
+		return 0;
+
+	case OPIOCGETOPTNODE:
+		copy_to_user_ret((void *)arg, &options_node,
+				 sizeof(int), -EFAULT);
+		return 0;
+
+	case OPIOCGETNEXT:
+	case OPIOCGETCHILD:
+		copy_from_user_ret(&node, (void *)arg, sizeof(int), -EFAULT);
+
+		save_and_cli(flags);
+		if (cmd == OPIOCGETNEXT)
+			node = prom_nodeops->no_nextnode(node);
+		else
+			node = prom_nodeops->no_child(node);
+		restore_flags(flags);
+
+		__copy_to_user_ret((void *)arg, &node, sizeof(int), -EFAULT);
+
+		return 0;
+
+	default:
+		printk(KERN_INFO "openprom_bsd_ioctl: cmd 0x%X\n", cmd);
+		return -EINVAL;
+
+	}
+}
+
+
+/*
+ *	Handoff control to the correct ioctl handler.
+ */
+static int openprom_ioctl(struct inode * inode, struct file * file,
+			  unsigned int cmd, unsigned long arg)
+{
+	DATA *data = (DATA *) file->private_data;
+
+	switch (cmd) {
+	case OPROMGETOPT:
+	case OPROMNXTOPT:
+		if ((file->f_mode & FMODE_READ) == 0)
+			return -EPERM;
+		return openprom_sunos_ioctl(inode, file, cmd, arg,
+					    options_node);
+
+	case OPROMSETOPT:
+	case OPROMSETOPT2:
+		if ((file->f_mode & FMODE_WRITE) == 0)
+			return -EPERM;
+		return openprom_sunos_ioctl(inode, file, cmd, arg,
+					    options_node);
+
+	case OPROMNEXT:
+	case OPROMCHILD:
+	case OPROMGETPROP:
+	case OPROMNXTPROP:
+		if ((file->f_mode & FMODE_READ) == 0)
+			return -EPERM;
+		return openprom_sunos_ioctl(inode, file, cmd, arg,
+					    data->current_node);
+
+	case OPROMU2P:
+	case OPROMGETCONS:
+	case OPROMGETFBNAME:
+	case OPROMGETBOOTARGS:
+		if ((file->f_mode & FMODE_READ) == 0)
+			return -EPERM;
+		return openprom_sunos_ioctl(inode, file, cmd, arg, 0);
+
+	case OPIOCGET:
+	case OPIOCNEXTPROP:
+	case OPIOCGETOPTNODE:
+	case OPIOCGETNEXT:
+	case OPIOCGETCHILD:
+		if ((file->f_mode & FMODE_READ) == 0)
+			return -EBADF;
+		return openprom_bsd_ioctl(inode,file,cmd,arg);
+
+	case OPIOCSET:
+		if ((file->f_mode & FMODE_WRITE) == 0)
+			return -EBADF;
+		return openprom_bsd_ioctl(inode,file,cmd,arg);
+
+	default:
+		printk("openprom_ioctl: cmd 0x%X, arg 0x%lX\n", cmd, arg);
+		return -EINVAL;
+	}
+}
+
+static long long openprom_lseek(struct inode * inode, struct file * file,
+			  long long offset, int origin)
+{
+	return -ESPIPE;
+}
+
+static int openprom_open(struct inode * inode, struct file * file)
+{
+	DATA *data;
+
+	data = (DATA *) kmalloc(sizeof(DATA), GFP_KERNEL);
+	if (!data)
+		return -ENOMEM;
+
+	data->current_node = prom_root_node;
+	data->lastnode = prom_root_node;
+	file->private_data = (void *)data;
+
+	MOD_INC_USE_COUNT;
+
+	return 0;
+}
+
+static void openprom_release(struct inode * inode, struct file * file)
+{
+	kfree_s(file->private_data, sizeof(DATA));
+	MOD_DEC_USE_COUNT;
+}
+
+static struct file_operations openprom_fops = {
+	openprom_lseek,
+	NULL,			/* openprom_read */
+	NULL,			/* openprom_write */
+	NULL,			/* openprom_readdir */
+	NULL,			/* openprom_select */
+	openprom_ioctl,
+	NULL,			/* openprom_mmap */
+	openprom_open,
+	openprom_release
+};
+
+static struct miscdevice misc_openprom = {
+	SUN_OPENPROM_MINOR, "openprom", &openprom_fops
+};
+
+__initfunc(int openprom_init(void))
+{
+	unsigned long flags;
+	int error;
+
+	error = misc_register(&misc_openprom);
+	if (error) {
+		printk(KERN_ERR "openprom: unable to get misc minor\n");
+		return error;
+	}
+
+	save_and_cli(flags);
+	options_node = prom_getchild(prom_root_node);
+	options_node = prom_searchsiblings(options_node,"options");
+	restore_flags(flags);
+
+	if (options_node == 0 || options_node == -1) {
+		printk(KERN_ERR "openprom: unable to find options node\n");
+		misc_deregister(&misc_openprom);
+		return -EIO;
+	}
+
+	return 0;
+}
+
+#ifdef MODULE
+
+int init_module(void)
+{
+	register_symtab(0);
+	return openprom_init();
+}
+
+void cleanup_module(void)
+{
+	misc_deregister(&misc_openprom);
+}
+
+#endif