sys/dev/cfe/cfe_api.h

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