1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_PROMIMPL_H
28*0Sstevel@tonic-gate #define	_SYS_PROMIMPL_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * Promif implementation functions and variables.
34*0Sstevel@tonic-gate  *
35*0Sstevel@tonic-gate  * These interfaces are not 'exported' in the same sense that
36*0Sstevel@tonic-gate  * those described in promif.h
37*0Sstevel@tonic-gate  *
38*0Sstevel@tonic-gate  * Used so that the kernel and other stand-alones (eg boot)
39*0Sstevel@tonic-gate  * don't have to directly reference the prom (of which there
40*0Sstevel@tonic-gate  * are now several completely different variants).
41*0Sstevel@tonic-gate  */
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #include <sys/types.h>
44*0Sstevel@tonic-gate #include <sys/promif.h>
45*0Sstevel@tonic-gate #ifdef __ia64
46*0Sstevel@tonic-gate /* XXX Merced -- these includes are for the ia64 simulator */
47*0Sstevel@tonic-gate #include <sys/types_ia64.h>
48*0Sstevel@tonic-gate #include <sys/ssc.h>
49*0Sstevel@tonic-gate #endif
50*0Sstevel@tonic-gate #include <sys/dditypes.h>
51*0Sstevel@tonic-gate #include <sys/ddidmareq.h>
52*0Sstevel@tonic-gate #include <sys/ddi_impldefs.h>
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate #ifdef	__cplusplus
55*0Sstevel@tonic-gate extern "C" {
56*0Sstevel@tonic-gate #endif
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate /*
59*0Sstevel@tonic-gate  * Debugging macros for the promif functions.
60*0Sstevel@tonic-gate  */
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate #define	PROMIF_DMSG_VERBOSE		2
63*0Sstevel@tonic-gate #define	PROMIF_DMSG_NORMAL		1
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate extern int promif_debug;		/* externally patchable */
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate #define	PROMIF_DEBUG			/* define this to enable debugging */
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate #ifdef PROMIF_DEBUG
70*0Sstevel@tonic-gate #define	PROMIF_DPRINTF(args)				\
71*0Sstevel@tonic-gate 	if (promif_debug) { 				\
72*0Sstevel@tonic-gate 		if (promif_debug == PROMIF_DMSG_VERBOSE)	\
73*0Sstevel@tonic-gate 			prom_printf("file %s line %d: ", __FILE__, __LINE__); \
74*0Sstevel@tonic-gate 		prom_printf args;			\
75*0Sstevel@tonic-gate 	}
76*0Sstevel@tonic-gate #else
77*0Sstevel@tonic-gate #define	PROMIF_DPRINTF(args)
78*0Sstevel@tonic-gate #endif /* PROMIF_DEBUG */
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate /*
81*0Sstevel@tonic-gate  * minimum alignment required by prom
82*0Sstevel@tonic-gate  */
83*0Sstevel@tonic-gate #define	PROMIF_MIN_ALIGN	1
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate /*
86*0Sstevel@tonic-gate  * Private utility routines (not exported as part of the interface)
87*0Sstevel@tonic-gate  */
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate extern	char		*prom_strcpy(char *s1, char *s2);
90*0Sstevel@tonic-gate extern	char		*prom_strncpy(char *s1, char *s2, size_t n);
91*0Sstevel@tonic-gate extern	int		prom_strcmp(char *s1, char *s2);
92*0Sstevel@tonic-gate extern	int		prom_strncmp(char *s1, char *s2, size_t n);
93*0Sstevel@tonic-gate extern	int		prom_strlen(char *s);
94*0Sstevel@tonic-gate extern	char		*prom_strrchr(char *s1, char c);
95*0Sstevel@tonic-gate extern	char		*prom_strcat(char *s1, char *s2);
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * Used to print a common before-reboot message.
99*0Sstevel@tonic-gate  */
100*0Sstevel@tonic-gate extern	void		prom_reboot_prompt(void);
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate /*
103*0Sstevel@tonic-gate  * Some calls into the prom (those expected to generate output on the console)
104*0Sstevel@tonic-gate  * are wrappered with these calls so that the caller can ensure that
105*0Sstevel@tonic-gate  * the console framebuffer will be brought to full power before entering the
106*0Sstevel@tonic-gate  * firmware.
107*0Sstevel@tonic-gate  */
108*0Sstevel@tonic-gate extern	promif_owrap_t	*promif_preout(void);
109*0Sstevel@tonic-gate extern	void		promif_postout(promif_owrap_t *);
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate #ifdef	__cplusplus
112*0Sstevel@tonic-gate }
113*0Sstevel@tonic-gate #endif
114*0Sstevel@tonic-gate 
115*0Sstevel@tonic-gate #endif /* !_SYS_PROMIMPL_H */
116