xref: /netbsd/sys/arch/sbmips/stand/common/cfe_api.h (revision c4a72b64)
1 /* $NetBSD: cfe_api.h,v 1.1 2002/11/09 06:20:40 cgd Exp $ */
2 /* from: SiByte Id: cfe_api.h,v 1.29 2002/07/09 23:29:11 cgd Exp $ */
3 
4 /*
5  * Copyright 2000, 2001, 2002
6  * Broadcom Corporation. All rights reserved.
7  *
8  * This software is furnished under license and may be used and copied only
9  * in accordance with the following terms and conditions.  Subject to these
10  * conditions, you may download, copy, install, use, modify and distribute
11  * modified or unmodified copies of this software in source and/or binary
12  * form. No title or ownership is transferred hereby.
13  *
14  * 1) Any source code used, modified or distributed must reproduce and
15  *    retain this copyright notice and list of conditions as they appear in
16  *    the source file.
17  *
18  * 2) No right is granted to use any trade name, trademark, or logo of
19  *    Broadcom Corporation.  The "Broadcom Corporation" name may not be
20  *    used to endorse or promote products derived from this software
21  *    without the prior written permission of Broadcom Corporation.
22  *
23  * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
24  *    WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
25  *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
26  *    NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
27  *    FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
28  *    LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
31  *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32  *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
33  *    OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 /*  *********************************************************************
37     *
38     *  Broadcom Common Firmware Environment (CFE)
39     *
40     *  Device function prototypes		File: cfe_api.h
41     *
42     *  This file contains declarations for doing callbacks to
43     *  cfe from an application.  It should be the only header
44     *  needed by the application to use this library
45     *
46     *  Authors:  Mitch Lichtenberg, Chris Demetriou
47     *
48     ********************************************************************* */
49 
50 #ifndef CFE_API_H
51 #define CFE_API_H
52 
53 /*
54  * Apply customizations here for different OSes.  These need to:
55  *	* typedef uint64_t, int64_t, intptr_t, uintptr_t.
56  *	* define cfe_strlen() if use of an existing function is desired.
57  *	* define CFE_API_IMPL_NAMESPACE if API functions are to use
58  *	  names in the implementation namespace.
59  * Also, optionally, if the build environment does not do so automatically,
60  * CFE_API_* can be defined here as desired.
61  */
62 /* Begin customization. */
63 #include <sys/stdint.h>			/* All of the typedefs.  */
64 #include <lib/libkern/libkern.h>	/* strlen() prototype.  */
65 
66 #define	CFE_API_close
67 #define	CFE_API_common
68 #define	CFE_API_flushcache
69 #define	CFE_API_getenv
70 #define	CFE_API_getstdhandle
71 #define	CFE_API_getticks
72 #define	CFE_API_ioctl
73 #define	CFE_API_open
74 #define	CFE_API_read
75 #define	CFE_API_readblk
76 #define	CFE_API_write
77 #define	CFE_API_writeblk
78 
79 #define	cfe_strlen(x)	strlen(x)
80 /* End customization. */
81 
82 
83 /*  *********************************************************************
84     *  Constants
85     ********************************************************************* */
86 
87 /* Seal indicating CFE's presence, passed to user program. */
88 #define CFE_EPTSEAL 0x43464531
89 
90 #define CFE_MI_RESERVED	0		/* memory is reserved, do not use */
91 #define CFE_MI_AVAILABLE 1		/* memory is available */
92 
93 #define CFE_FLG_WARMSTART     0x00000001
94 #define CFE_FLG_FULL_ARENA    0x00000001
95 #define CFE_FLG_ENV_PERMANENT 0x00000001
96 
97 #define CFE_CPU_CMD_START 1
98 #define CFE_CPU_CMD_STOP 0
99 
100 #define CFE_STDHANDLE_CONSOLE	0
101 
102 #define CFE_DEV_NETWORK 	1
103 #define CFE_DEV_DISK		2
104 #define CFE_DEV_FLASH		3
105 #define CFE_DEV_SERIAL		4
106 #define CFE_DEV_CPU		5
107 #define CFE_DEV_NVRAM		6
108 #define CFE_DEV_CLOCK           7
109 #define CFE_DEV_OTHER		8
110 #define CFE_DEV_MASK		0x0F
111 
112 #define CFE_CACHE_FLUSH_D	1
113 #define CFE_CACHE_INVAL_I	2
114 #define CFE_CACHE_INVAL_D	4
115 #define CFE_CACHE_INVAL_L2	8
116 
117 #define CFE_FWI_64BIT		0x00000001
118 #define CFE_FWI_32BIT		0x00000002
119 #define CFE_FWI_RELOC		0x00000004
120 #define CFE_FWI_UNCACHED	0x00000008
121 #define CFE_FWI_MULTICPU	0x00000010
122 #define CFE_FWI_FUNCSIM		0x00000020
123 #define CFE_FWI_RTLSIM		0x00000040
124 
125 typedef struct {
126     int64_t fwi_version;		/* major, minor, eco version */
127     int64_t fwi_totalmem;		/* total installed mem */
128     int64_t fwi_flags;		        /* various flags */
129     int64_t fwi_boardid;		/* board ID */
130     int64_t fwi_bootarea_va;		/* VA of boot area */
131     int64_t fwi_bootarea_pa;		/* PA of boot area */
132     int64_t fwi_bootarea_size;	        /* size of boot area */
133 } cfe_fwinfo_t;
134 
135 
136 /*
137  * cfe_strlen is handled specially: If already defined, it has been
138  * overridden in this environment with a standard strlen-like function.
139  */
140 #ifdef cfe_strlen
141 # define CFE_API_STRLEN_CUSTOM
142 #else
143 # ifdef CFE_API_IMPL_NAMESPACE
144 #  define cfe_strlen(a)			__cfe_strlen(a)
145 # endif
146 int cfe_strlen(char *name);
147 #endif
148 
149 /*
150  * Defines and prototypes for functions which take no arguments.
151  */
152 #ifdef CFE_API_IMPL_NAMESPACE
153 int64_t __cfe_getticks(void);
154 #define cfe_getticks()			__cfe_getticks()
155 #else
156 int64_t cfe_getticks(void);
157 #endif
158 
159 /*
160  * Defines and prototypes for the rest of the functions.
161  */
162 #ifdef CFE_API_IMPL_NAMESPACE
163 #define cfe_close(a)			__cfe_close(a)
164 #define cfe_cpu_start(a,b,c,d,e)	__cfe_cpu_start(a,b,c,d,e)
165 #define cfe_cpu_stop(a)			__cfe_cpu_stop(a)
166 #define cfe_enumenv(a,b,d,e,f)		__cfe_enumenv(a,b,d,e,f)
167 #define cfe_enummem(a,b,c,d,e)		__cfe_enummem(a,b,c,d,e)
168 #define cfe_exit(a,b)			__cfe_exit(a,b)
169 #define cfe_flushcache(a)		__cfe_cacheflush(a)
170 #define cfe_getdevinfo(a)		__cfe_getdevinfo(a)
171 #define cfe_getenv(a,b,c)		__cfe_getenv(a,b,c)
172 #define cfe_getfwinfo(a)		__cfe_getfwinfo(a)
173 #define cfe_getstdhandle(a)		__cfe_getstdhandle(a)
174 #define cfe_init(a,b)			__cfe_init(a,b)
175 #define cfe_inpstat(a)			__cfe_inpstat(a)
176 #define cfe_ioctl(a,b,c,d,e,f)		__cfe_ioctl(a,b,c,d,e,f)
177 #define cfe_open(a)			__cfe_open(a)
178 #define cfe_read(a,b,c)			__cfe_read(a,b,c)
179 #define cfe_readblk(a,b,c,d)		__cfe_readblk(a,b,c,d)
180 #define cfe_setenv(a,b)			__cfe_setenv(a,b)
181 #define cfe_write(a,b,c)		__cfe_write(a,b,c)
182 #define cfe_writeblk(a,b,c,d)		__cfe_writeblk(a,b,c,d)
183 #endif /* CFE_API_IMPL_NAMESPACE */
184 
185 int cfe_close(int handle);
186 int cfe_cpu_start(int cpu, void (*fn)(void), long sp, long gp, long a1);
187 int cfe_cpu_stop(int cpu);
188 int cfe_enumenv(int idx, char *name, int namelen, char *val, int vallen);
189 int cfe_enummem(int idx, int flags, uint64_t *start, uint64_t *length,
190 		uint64_t *type);
191 int cfe_exit(int warm,int status);
192 int cfe_flushcache(int flg);
193 int cfe_getdevinfo(char *name);
194 int cfe_getenv(char *name, char *dest, int destlen);
195 int cfe_getfwinfo(cfe_fwinfo_t *info);
196 int cfe_getstdhandle(int flg);
197 int cfe_init(uint64_t handle,uint64_t ept);
198 int cfe_inpstat(int handle);
199 int cfe_ioctl(int handle, unsigned int ioctlnum, unsigned char *buffer,
200 	      int length, int *retlen, uint64_t offset);
201 int cfe_open(char *name);
202 int cfe_read(int handle, unsigned char *buffer, int length);
203 int cfe_readblk(int handle, int64_t offset, unsigned char *buffer, int length);
204 int cfe_setenv(char *name, char *val);
205 int cfe_write(int handle, unsigned char *buffer, int length);
206 int cfe_writeblk(int handle, int64_t offset, unsigned char *buffer,
207 		 int length);
208 
209 #endif /* CFE_API_H */
210