xref: /netbsd-src/sys/dev/ofw/openfirm.h (revision fad4c9f71477ae11cea2ee75ec82151ac770a534)
1 /*	$NetBSD: openfirm.h,v 1.22 2006/06/14 19:42:34 uwe Exp $	*/
2 
3 /*
4  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
5  * Copyright (C) 1995, 1996 TooLs GmbH.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by TooLs GmbH.
19  * 4. The name of TooLs GmbH may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 /*
34  * Prototypes for OpenFirmware Interface Routines
35  */
36 
37 /*
38  * Machine-independent OpenFirmware-related structures.
39  * XXX THESE DO NOT BELONG HERE.
40  */
41 
42 /*
43  * Generic OpenFirmware probe argument.
44  * This is how all probe structures must start
45  * in order to support generic OpenFirmware device drivers.
46  */
47 struct ofbus_attach_args {
48 	const char	*oba_busname;
49 	char		oba_ofname[64];
50 	int		oba_phandle;
51 
52 	/*
53 	 * Special unit field for disk devices.
54 	 * This is a KLUDGE to work around the fact that OpenFirmware
55 	 * doesn't probe the scsi bus completely.
56 	 * YES, I THINK THIS IS A BUG IN THE OPENFIRMWARE DEFINITION!!!	XXX
57 	 * See also ofdisk.c.
58 	 */
59 	int		oba_unit;
60 };
61 
62 
63 /*
64  * Functions and variables provided by machine-dependent code.
65  */
66 extern char *OF_buf;
67 
68 int	OF_peer(int);
69 int	OF_child(int);
70 int	OF_parent(int);
71 int	OF_instance_to_package(int);
72 int	OF_getproplen(int, const char *);
73 int	OF_getprop(int, const char *, void *, int);
74 int	OF_nextprop(int, const char *, void *);
75 int	OF_setprop(int, const char *, const void *, int);
76 int	OF_finddevice(const char *);
77 int	OF_instance_to_path(int, char *, int);
78 int	OF_package_to_path(int, char *, int);
79 int	OF_call_method_1(const char *, int, int, ...);
80 int	OF_call_method(const char *, int, int, int, ...);
81 int	OF_open(const char *);
82 void	OF_close(int);
83 int	OF_read(int, void *, int);
84 int	OF_write(int, const void *, int);
85 int	OF_seek(int, u_quad_t);
86 void	*OF_claim(void *, u_int, u_int);
87 void	OF_release(void *, u_int);
88 int	OF_milliseconds(void);
89 void	OF_boot(const char *) __attribute__((__noreturn__));
90 void	OF_enter(void);
91 void	OF_exit(void) __attribute__((__noreturn__));
92 void	(*OF_set_callback(void(*)(void *)))(void *);
93 int	openfirmware(void *);
94 
95 /*
96  * Functions and variables provided by machine-independent code.
97  */
98 int	of_compatible(int, const char * const *);
99 int	of_decode_int(const unsigned char *);
100 int	of_packagename(int, char *, int);
101 
102 int	*of_network_decode_media(int, int *, int *);
103