2 * Linux/SPARC PROM Configuration Driver
3 * Copyright (C) 1996 Thomas K. Dyas (tdyas@noc.rutgers.edu)
4 * Copyright (C) 1996 Eddie C. Dost (ecd@skynet.be)
6 * This character device driver allows user programs to access the
7 * PROM device tree. It is compatible with the SunOS /dev/openprom
8 * driver and the NetBSD /dev/openprom driver. The SunOS eeprom
9 * utility works without any modifications.
11 * The driver uses a minor number under the misc device major. The
12 * file read/write mode determines the type of access to the PROM.
13 * Interrupts are disabled whenever the driver calls into the PROM for
17 /* This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License as
19 * published by the Free Software Foundation; either version 2 of the
20 * License, or (at your option) any later version.
22 * This program is distributed in the hope that it will be useful, but
23 * WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 * General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 #include <linux/module.h>
33 #include <linux/kernel.h>
34 #include <linux/errno.h>
35 #include <linux/slab.h>
36 #include <linux/mutex.h>
37 #include <linux/string.h>
38 #include <linux/miscdevice.h>
39 #include <linux/init.h>
41 #include <asm/oplib.h>
43 #include <linux/uaccess.h>
44 #include <asm/openpromio.h>
46 #include <linux/pci.h>
49 MODULE_AUTHOR("Thomas K. Dyas (tdyas@noc.rutgers.edu) and Eddie C. Dost (ecd@skynet.be)");
50 MODULE_DESCRIPTION("OPENPROM Configuration Driver");
51 MODULE_LICENSE("GPL");
52 MODULE_VERSION("1.0");
53 MODULE_ALIAS_MISCDEV(SUN_OPENPROM_MINOR
);
55 /* Private data kept by the driver for each descriptor. */
56 typedef struct openprom_private_data
58 struct device_node
*current_node
; /* Current node for SunOS ioctls. */
59 struct device_node
*lastnode
; /* Last valid node used by BSD ioctls. */
62 /* ID of the PROM node containing all of the EEPROM options. */
63 static DEFINE_MUTEX(openprom_mutex
);
64 static struct device_node
*options_node
;
67 * Copy an openpromio structure into kernel space from user space.
68 * This routine does error checking to make sure that all memory
69 * accesses are within bounds. A pointer to the allocated openpromio
70 * structure will be placed in "*opp_p". Return value is the length
71 * of the user supplied buffer.
73 static int copyin(struct openpromio __user
*info
, struct openpromio
**opp_p
)
80 if (get_user(bufsize
, &info
->oprom_size
))
86 /* If the bufsize is too large, just limit it.
87 * Fix from Jason Rappleye.
89 if (bufsize
> OPROMMAXPARAM
)
90 bufsize
= OPROMMAXPARAM
;
92 if (!(*opp_p
= kzalloc(sizeof(int) + bufsize
+ 1, GFP_KERNEL
)))
95 if (copy_from_user(&(*opp_p
)->oprom_array
,
96 &info
->oprom_array
, bufsize
)) {
103 static int getstrings(struct openpromio __user
*info
, struct openpromio
**opp_p
)
111 if (!(*opp_p
= kzalloc(sizeof(int) + OPROMMAXPARAM
+ 1, GFP_KERNEL
)))
114 (*opp_p
)->oprom_size
= 0;
117 while ((n
< 2) && (bufsize
< OPROMMAXPARAM
)) {
118 if (get_user(c
, &info
->oprom_array
[bufsize
])) {
124 (*opp_p
)->oprom_array
[bufsize
++] = c
;
134 * Copy an openpromio structure in kernel space back to user space.
136 static int copyout(void __user
*info
, struct openpromio
*opp
, int len
)
138 if (copy_to_user(info
, opp
, len
))
143 static int opromgetprop(void __user
*argp
, struct device_node
*dp
, struct openpromio
*op
, int bufsize
)
149 !(pval
= of_get_property(dp
, op
->oprom_array
, &len
)) ||
150 len
<= 0 || len
> bufsize
)
151 return copyout(argp
, op
, sizeof(int));
153 memcpy(op
->oprom_array
, pval
, len
);
154 op
->oprom_array
[len
] = '\0';
155 op
->oprom_size
= len
;
157 return copyout(argp
, op
, sizeof(int) + bufsize
);
160 static int opromnxtprop(void __user
*argp
, struct device_node
*dp
, struct openpromio
*op
, int bufsize
)
162 struct property
*prop
;
166 return copyout(argp
, op
, sizeof(int));
167 if (op
->oprom_array
[0] == '\0') {
168 prop
= dp
->properties
;
170 return copyout(argp
, op
, sizeof(int));
171 len
= strlen(prop
->name
);
173 prop
= of_find_property(dp
, op
->oprom_array
, NULL
);
177 (len
= strlen(prop
->next
->name
)) + 1 > bufsize
)
178 return copyout(argp
, op
, sizeof(int));
183 memcpy(op
->oprom_array
, prop
->name
, len
);
184 op
->oprom_array
[len
] = '\0';
185 op
->oprom_size
= ++len
;
187 return copyout(argp
, op
, sizeof(int) + bufsize
);
190 static int opromsetopt(struct device_node
*dp
, struct openpromio
*op
, int bufsize
)
192 char *buf
= op
->oprom_array
+ strlen(op
->oprom_array
) + 1;
193 int len
= op
->oprom_array
+ bufsize
- buf
;
195 return of_set_property(options_node
, op
->oprom_array
, buf
, len
);
198 static int opromnext(void __user
*argp
, unsigned int cmd
, struct device_node
*dp
, struct openpromio
*op
, int bufsize
, DATA
*data
)
202 BUILD_BUG_ON(sizeof(phandle
) != sizeof(int));
204 if (bufsize
< sizeof(phandle
))
207 ph
= *((int *) op
->oprom_array
);
209 dp
= of_find_node_by_phandle(ph
);
227 /* Sibling of node zero is the root node. */
228 if (cmd
!= OPROMNEXT
)
231 dp
= of_find_node_by_path("/");
238 data
->current_node
= dp
;
239 *((int *) op
->oprom_array
) = ph
;
240 op
->oprom_size
= sizeof(phandle
);
242 return copyout(argp
, op
, bufsize
+ sizeof(int));
245 static int oprompci2node(void __user
*argp
, struct device_node
*dp
, struct openpromio
*op
, int bufsize
, DATA
*data
)
249 if (bufsize
>= 2*sizeof(int)) {
251 struct pci_dev
*pdev
;
252 struct device_node
*dp
;
254 pdev
= pci_get_domain_bus_and_slot(0,
255 ((int *) op
->oprom_array
)[0],
256 ((int *) op
->oprom_array
)[1]);
258 dp
= pci_device_to_OF_node(pdev
);
259 data
->current_node
= dp
;
260 *((int *)op
->oprom_array
) = dp
->phandle
;
261 op
->oprom_size
= sizeof(int);
262 err
= copyout(argp
, op
, bufsize
+ sizeof(int));
271 static int oprompath2node(void __user
*argp
, struct device_node
*dp
, struct openpromio
*op
, int bufsize
, DATA
*data
)
275 dp
= of_find_node_by_path(op
->oprom_array
);
278 data
->current_node
= dp
;
279 *((int *)op
->oprom_array
) = ph
;
280 op
->oprom_size
= sizeof(int);
282 return copyout(argp
, op
, bufsize
+ sizeof(int));
285 static int opromgetbootargs(void __user
*argp
, struct openpromio
*op
, int bufsize
)
287 char *buf
= saved_command_line
;
288 int len
= strlen(buf
);
293 strcpy(op
->oprom_array
, buf
);
294 op
->oprom_size
= len
;
296 return copyout(argp
, op
, bufsize
+ sizeof(int));
300 * SunOS and Solaris /dev/openprom ioctl calls.
302 static long openprom_sunos_ioctl(struct file
* file
,
303 unsigned int cmd
, unsigned long arg
,
304 struct device_node
*dp
)
306 DATA
*data
= file
->private_data
;
307 struct openpromio
*opp
= NULL
;
308 int bufsize
, error
= 0;
310 void __user
*argp
= (void __user
*)arg
;
312 if (cmd
== OPROMSETOPT
)
313 bufsize
= getstrings(argp
, &opp
);
315 bufsize
= copyin(argp
, &opp
);
320 mutex_lock(&openprom_mutex
);
325 error
= opromgetprop(argp
, dp
, opp
, bufsize
);
330 error
= opromnxtprop(argp
, dp
, opp
, bufsize
);
335 error
= opromsetopt(dp
, opp
, bufsize
);
341 error
= opromnext(argp
, cmd
, dp
, opp
, bufsize
, data
);
345 error
= oprompci2node(argp
, dp
, opp
, bufsize
, data
);
349 error
= oprompath2node(argp
, dp
, opp
, bufsize
, data
);
352 case OPROMGETBOOTARGS
:
353 error
= opromgetbootargs(argp
, opp
, bufsize
);
360 printk(KERN_INFO
"openprom_sunos_ioctl: unimplemented ioctl\n");
365 printk(KERN_INFO
"openprom_sunos_ioctl: cmd 0x%X, arg 0x%lX\n", cmd
, arg
);
371 mutex_unlock(&openprom_mutex
);
376 static struct device_node
*get_node(phandle n
, DATA
*data
)
378 struct device_node
*dp
= of_find_node_by_phandle(n
);
386 /* Copy in a whole string from userspace into kernelspace. */
387 static char * copyin_string(char __user
*user
, size_t len
)
389 if ((ssize_t
)len
< 0 || (ssize_t
)(len
+ 1) < 0)
390 return ERR_PTR(-EINVAL
);
392 return memdup_user_nul(user
, len
);
396 * NetBSD /dev/openprom ioctl calls.
398 static int opiocget(void __user
*argp
, DATA
*data
)
401 struct device_node
*dp
;
406 if (copy_from_user(&op
, argp
, sizeof(op
)))
409 dp
= get_node(op
.op_nodeid
, data
);
411 str
= copyin_string(op
.op_name
, op
.op_namelen
);
415 pval
= of_get_property(dp
, str
, &len
);
417 if (!pval
|| len
> op
.op_buflen
) {
421 if (copy_to_user(argp
, &op
, sizeof(op
)) ||
422 copy_to_user(op
.op_buf
, pval
, len
))
430 static int opiocnextprop(void __user
*argp
, DATA
*data
)
433 struct device_node
*dp
;
434 struct property
*prop
;
438 if (copy_from_user(&op
, argp
, sizeof(op
)))
441 dp
= get_node(op
.op_nodeid
, data
);
445 str
= copyin_string(op
.op_name
, op
.op_namelen
);
449 if (str
[0] == '\0') {
450 prop
= dp
->properties
;
452 prop
= of_find_property(dp
, str
, NULL
);
463 if (len
> op
.op_buflen
)
466 if (copy_to_user(argp
, &op
, sizeof(op
)))
470 copy_to_user(op
.op_buf
, prop
->value
, len
))
476 static int opiocset(void __user
*argp
, DATA
*data
)
479 struct device_node
*dp
;
483 if (copy_from_user(&op
, argp
, sizeof(op
)))
486 dp
= get_node(op
.op_nodeid
, data
);
490 str
= copyin_string(op
.op_name
, op
.op_namelen
);
494 tmp
= copyin_string(op
.op_buf
, op
.op_buflen
);
500 err
= of_set_property(dp
, str
, tmp
, op
.op_buflen
);
508 static int opiocgetnext(unsigned int cmd
, void __user
*argp
)
510 struct device_node
*dp
;
513 BUILD_BUG_ON(sizeof(phandle
) != sizeof(int));
515 if (copy_from_user(&nd
, argp
, sizeof(phandle
)))
519 if (cmd
!= OPIOCGETNEXT
)
521 dp
= of_find_node_by_path("/");
523 dp
= of_find_node_by_phandle(nd
);
526 if (cmd
== OPIOCGETNEXT
)
534 if (copy_to_user(argp
, &nd
, sizeof(phandle
)))
540 static int openprom_bsd_ioctl(struct file
* file
,
541 unsigned int cmd
, unsigned long arg
)
543 DATA
*data
= file
->private_data
;
544 void __user
*argp
= (void __user
*)arg
;
547 mutex_lock(&openprom_mutex
);
550 err
= opiocget(argp
, data
);
554 err
= opiocnextprop(argp
, data
);
558 err
= opiocset(argp
, data
);
561 case OPIOCGETOPTNODE
:
562 BUILD_BUG_ON(sizeof(phandle
) != sizeof(int));
565 if (copy_to_user(argp
, &options_node
->phandle
, sizeof(phandle
)))
571 err
= opiocgetnext(cmd
, argp
);
578 mutex_unlock(&openprom_mutex
);
585 * Handoff control to the correct ioctl handler.
587 static long openprom_ioctl(struct file
* file
,
588 unsigned int cmd
, unsigned long arg
)
590 DATA
*data
= file
->private_data
;
595 if ((file
->f_mode
& FMODE_READ
) == 0)
597 return openprom_sunos_ioctl(file
, cmd
, arg
,
602 if ((file
->f_mode
& FMODE_WRITE
) == 0)
604 return openprom_sunos_ioctl(file
, cmd
, arg
,
611 if ((file
->f_mode
& FMODE_READ
) == 0)
613 return openprom_sunos_ioctl(file
, cmd
, arg
,
619 case OPROMGETBOOTARGS
:
623 if ((file
->f_mode
& FMODE_READ
) == 0)
625 return openprom_sunos_ioctl(file
, cmd
, arg
, NULL
);
629 case OPIOCGETOPTNODE
:
632 if ((file
->f_mode
& FMODE_READ
) == 0)
634 return openprom_bsd_ioctl(file
,cmd
,arg
);
637 if ((file
->f_mode
& FMODE_WRITE
) == 0)
639 return openprom_bsd_ioctl(file
,cmd
,arg
);
646 static long openprom_compat_ioctl(struct file
*file
, unsigned int cmd
,
652 * SunOS/Solaris only, the NetBSD one's have embedded pointers in
653 * the arg which we'd need to clean up...
667 case OPROMGETBOOTARGS
:
671 rval
= openprom_ioctl(file
, cmd
, arg
);
678 static int openprom_open(struct inode
* inode
, struct file
* file
)
682 data
= kmalloc(sizeof(DATA
), GFP_KERNEL
);
686 mutex_lock(&openprom_mutex
);
687 data
->current_node
= of_find_node_by_path("/");
688 data
->lastnode
= data
->current_node
;
689 file
->private_data
= (void *) data
;
690 mutex_unlock(&openprom_mutex
);
695 static int openprom_release(struct inode
* inode
, struct file
* file
)
697 kfree(file
->private_data
);
701 static const struct file_operations openprom_fops
= {
702 .owner
= THIS_MODULE
,
704 .unlocked_ioctl
= openprom_ioctl
,
705 .compat_ioctl
= openprom_compat_ioctl
,
706 .open
= openprom_open
,
707 .release
= openprom_release
,
710 static struct miscdevice openprom_dev
= {
711 .minor
= SUN_OPENPROM_MINOR
,
713 .fops
= &openprom_fops
,
716 static int __init
openprom_init(void)
718 struct device_node
*dp
;
721 err
= misc_register(&openprom_dev
);
725 dp
= of_find_node_by_path("/");
728 if (!strcmp(dp
->name
, "options"))
735 misc_deregister(&openprom_dev
);
742 static void __exit
openprom_cleanup(void)
744 misc_deregister(&openprom_dev
);
747 module_init(openprom_init
);
748 module_exit(openprom_cleanup
);