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