cfe_api.h revision 259065
1/* $NetBSD: cfe_api.h,v 1.3 2003/02/07 17:38:48 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 * $FreeBSD: releng/10.0/sys/dev/cfe/cfe_api.h 183370 2008-09-26 03:53:10Z imp $ 36 */ 37 38/* ********************************************************************* 39 * 40 * Broadcom Common Firmware Environment (CFE) 41 * 42 * Device function prototypes File: cfe_api.h 43 * 44 * This file contains declarations for doing callbacks to 45 * cfe from an application. It should be the only header 46 * needed by the application to use this library 47 * 48 * Authors: Mitch Lichtenberg, Chris Demetriou 49 * 50 ********************************************************************* */ 51 52#ifndef CFE_API_H 53#define CFE_API_H 54 55/* 56 * Apply customizations here for different OSes. These need to: 57 * * typedef uint64_t, int64_t, intptr_t, uintptr_t. 58 * * define cfe_strlen() if use of an existing function is desired. 59 * * define CFE_API_IMPL_NAMESPACE if API functions are to use 60 * names in the implementation namespace. 61 * Also, optionally, if the build environment does not do so automatically, 62 * CFE_API_* can be defined here as desired. 63 */ 64/* Begin customization. */ 65#include <sys/stdint.h> /* All of the typedefs. */ 66#include <sys/systm.h> /* strlen() prototype. */ 67 68#define CFE_API_ALL 69#define cfe_strlen(x) strlen(x) 70/* End customization. */ 71 72 73/* ********************************************************************* 74 * Constants 75 ********************************************************************* */ 76 77/* Seal indicating CFE's presence, passed to user program. */ 78#define CFE_EPTSEAL 0x43464531 79 80#define CFE_MI_RESERVED 0 /* memory is reserved, do not use */ 81#define CFE_MI_AVAILABLE 1 /* memory is available */ 82 83#define CFE_FLG_WARMSTART 0x00000001 84#define CFE_FLG_FULL_ARENA 0x00000001 85#define CFE_FLG_ENV_PERMANENT 0x00000001 86 87#define CFE_CPU_CMD_START 1 88#define CFE_CPU_CMD_STOP 0 89 90#define CFE_STDHANDLE_CONSOLE 0 91 92#define CFE_DEV_NETWORK 1 93#define CFE_DEV_DISK 2 94#define CFE_DEV_FLASH 3 95#define CFE_DEV_SERIAL 4 96#define CFE_DEV_CPU 5 97#define CFE_DEV_NVRAM 6 98#define CFE_DEV_CLOCK 7 99#define CFE_DEV_OTHER 8 100#define CFE_DEV_MASK 0x0F 101 102#define CFE_CACHE_FLUSH_D 1 103#define CFE_CACHE_INVAL_I 2 104#define CFE_CACHE_INVAL_D 4 105#define CFE_CACHE_INVAL_L2 8 106 107#define CFE_FWI_64BIT 0x00000001 108#define CFE_FWI_32BIT 0x00000002 109#define CFE_FWI_RELOC 0x00000004 110#define CFE_FWI_UNCACHED 0x00000008 111#define CFE_FWI_MULTICPU 0x00000010 112#define CFE_FWI_FUNCSIM 0x00000020 113#define CFE_FWI_RTLSIM 0x00000040 114 115typedef struct { 116 int64_t fwi_version; /* major, minor, eco version */ 117 int64_t fwi_totalmem; /* total installed mem */ 118 int64_t fwi_flags; /* various flags */ 119 int64_t fwi_boardid; /* board ID */ 120 int64_t fwi_bootarea_va; /* VA of boot area */ 121 int64_t fwi_bootarea_pa; /* PA of boot area */ 122 int64_t fwi_bootarea_size; /* size of boot area */ 123} cfe_fwinfo_t; 124 125 126/* 127 * cfe_strlen is handled specially: If already defined, it has been 128 * overridden in this environment with a standard strlen-like function. 129 */ 130#ifdef cfe_strlen 131# define CFE_API_STRLEN_CUSTOM 132#else 133# ifdef CFE_API_IMPL_NAMESPACE 134# define cfe_strlen(a) __cfe_strlen(a) 135# endif 136int cfe_strlen(char *name); 137#endif 138 139/* 140 * Defines and prototypes for functions which take no arguments. 141 */ 142#ifdef CFE_API_IMPL_NAMESPACE 143int64_t __cfe_getticks(void); 144#define cfe_getticks() __cfe_getticks() 145#else 146int64_t cfe_getticks(void); 147#endif 148 149/* 150 * Defines and prototypes for the rest of the functions. 151 */ 152#ifdef CFE_API_IMPL_NAMESPACE 153#define cfe_close(a) __cfe_close(a) 154#define cfe_cpu_start(a,b,c,d,e) __cfe_cpu_start(a,b,c,d,e) 155#define cfe_cpu_stop(a) __cfe_cpu_stop(a) 156#define cfe_enumenv(a,b,d,e,f) __cfe_enumenv(a,b,d,e,f) 157#define cfe_enummem(a,b,c,d,e) __cfe_enummem(a,b,c,d,e) 158#define cfe_exit(a,b) __cfe_exit(a,b) 159#define cfe_flushcache(a) __cfe_cacheflush(a) 160#define cfe_getdevinfo(a) __cfe_getdevinfo(a) 161#define cfe_getenv(a,b,c) __cfe_getenv(a,b,c) 162#define cfe_getfwinfo(a) __cfe_getfwinfo(a) 163#define cfe_getstdhandle(a) __cfe_getstdhandle(a) 164#define cfe_init(a,b) __cfe_init(a,b) 165#define cfe_inpstat(a) __cfe_inpstat(a) 166#define cfe_ioctl(a,b,c,d,e,f) __cfe_ioctl(a,b,c,d,e,f) 167#define cfe_open(a) __cfe_open(a) 168#define cfe_read(a,b,c) __cfe_read(a,b,c) 169#define cfe_readblk(a,b,c,d) __cfe_readblk(a,b,c,d) 170#define cfe_setenv(a,b) __cfe_setenv(a,b) 171#define cfe_write(a,b,c) __cfe_write(a,b,c) 172#define cfe_writeblk(a,b,c,d) __cfe_writeblk(a,b,c,d) 173#endif /* CFE_API_IMPL_NAMESPACE */ 174 175int cfe_close(int handle); 176int cfe_cpu_start(int cpu, void (*fn)(void), long sp, long gp, long a1); 177int cfe_cpu_stop(int cpu); 178int cfe_enumenv(int idx, char *name, int namelen, char *val, int vallen); 179int cfe_enummem(int idx, int flags, uint64_t *start, uint64_t *length, 180 uint64_t *type); 181int cfe_exit(int warm,int status); 182int cfe_flushcache(int flg); 183int cfe_getdevinfo(char *name); 184int cfe_getenv(char *name, char *dest, int destlen); 185int cfe_getfwinfo(cfe_fwinfo_t *info); 186int cfe_getstdhandle(int flg); 187int cfe_init(uint64_t handle,uint64_t ept); 188int cfe_inpstat(int handle); 189int cfe_ioctl(int handle, unsigned int ioctlnum, unsigned char *buffer, 190 int length, int *retlen, uint64_t offset); 191int cfe_open(char *name); 192int cfe_read(int handle, unsigned char *buffer, int length); 193int cfe_readblk(int handle, int64_t offset, unsigned char *buffer, int length); 194int cfe_setenv(char *name, char *val); 195int cfe_write(int handle, unsigned char *buffer, int length); 196int cfe_writeblk(int handle, int64_t offset, unsigned char *buffer, 197 int length); 198 199#endif /* CFE_API_H */ 200