xref: /netbsd-src/sys/arch/sun2/include/promlib.h (revision df0caa2637da0538ecdf6b878c4d08e684b43d8f)
1 /*	$NetBSD: promlib.h,v 1.7 2005/06/03 22:02:30 tsutsui Exp $ */
2 
3 /*-
4  * Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Paul Kranenburg and Matthew Fredette.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Macros and functions to hide the Sun2 PROM interface from the
41  * common Sun parts of the kernel.
42  */
43 
44 #ifndef _MACHINE_PROMLIB_H_
45 #define _MACHINE_PROMLIB_H_
46 
47 #include <machine/mon.h>
48 
49 #ifdef	_SUN2_PROMLIB_PRIVATE
50 #define	romVectorPtr	((struct sunromvec *) SUN2_PROM_BASE)
51 #endif	/* _SUN2_PROMLIB_PRIVATE */
52 
53 /*
54  * We define both of these, since there are places where their
55  * functionality is the same, and some common code knows that
56  * (e.g. dev/sun/zs.c).
57  */
58 #define PROM_OLDMON	0
59 #define PROM_OBP_V0	1
60 
61 void	prom_init(void);	/* To setup promops */
62 
63 #define	prom_version()	(PROM_OLDMON)
64 int	prom_memsize(void);
65 int	prom_stdin(void);
66 int	prom_stdout(void);
67 int	prom_kbdid(void);
68 int	prom_getchar(void);
69 int	prom_peekchar(void);
70 void	prom_putchar(int);
71 void	prom_putstr(char *, int);
72 void	prom_printf(const char *, ...);
73 void	prom_abort(void);
74 void	prom_halt(void) __attribute__((__noreturn__));
75 void	prom_boot(const char *) __attribute__((__noreturn__));
76 char	*prom_getbootpath(void);
77 char	*prom_getbootfile(void);
78 char	*prom_getbootargs(void);
79 int	prom_sd_target(int);
80 #define	callrom		prom_abort
81 
82 /*
83  * We also provide these, to keep #ifdef'ing down in common
84  * code.  These should be revisited.  The worst offender is
85  * our definition of CPU_ISSUN4, for the benefit of
86  * sys/dev/sun/fb.c.
87  */
88 #define PROM_OBP_V2	2
89 #define PROM_OBP_V3	3
90 #define PROM_OPENFIRM	4
91 #define prom_getpropint(a, b, c) (0)
92 #define CPU_ISSUN4 (1)
93 
94 #endif /* _MACHINE_PROMLIB_H_ */
95