source: trunk/libs/newlib/src/libgloss/mips/cfe_api.h @ 612

/* From: CFE Id: cfe_api.h,v 1.29 2002/07/09 23:29:11 cgd Exp $ */

/*
 * Copyright 2000, 2001, 2002
 * Broadcom Corporation. All rights reserved.
 * 
 * This software is furnished under license and may be used and copied only
 * in accordance with the following terms and conditions.  Subject to these
 * conditions, you may download, copy, install, use, modify and distribute
 * modified or unmodified copies of this software in source and/or binary
 * form. No title or ownership is transferred hereby.
 * 
 * 1) Any source code used, modified or distributed must reproduce and
 *    retain this copyright notice and list of conditions as they appear in
 *    the source file.
 * 
 * 2) No right is granted to use any trade name, trademark, or logo of
 *    Broadcom Corporation.  The "Broadcom Corporation" name may not be
 *    used to endorse or promote products derived from this software
 *    without the prior written permission of Broadcom Corporation.
 * 
 * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
 *    WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 *    NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
 *    FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
 *    LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *    OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*  *********************************************************************
    *
    *  Broadcom Common Firmware Environment (CFE)
    *
    *  Device function prototypes               File: cfe_api.h
    *
    *  This file contains declarations for doing callbacks to
    *  cfe from an application.  It should be the only header
    *  needed by the application to use this library
    *
    *  Authors:  Mitch Lichtenberg, Chris Demetriou
    *
    ********************************************************************* */

#ifndef CFE_API_H
#define CFE_API_H

/*
 * Apply customizations here for different OSes.  These need to:
 *      * typedef uint64_t, int64_t, intptr_t, uintptr_t.
 *      * define cfe_strlen() if use of an existing function is desired.
 *      * define CFE_API_IMPL_NAMESPACE if API functions are to use
 *        names in the implementation namespace.
 * Also, optionally, if the build environment does not do so automatically,
 * CFE_API_* can be defined here as desired.
 */
/* Begin customization. */
#include <stdint.h>
#include <string.h>
#define cfe_strlen(s)   strlen(s)

#define CFE_API_ALL
#define CFE_API_IMPL_NAMESPACE

/* Return the stack size to be used for the program.  Normally 32KB.  The
   normal memory allocator uses the bottom of the stack as its heap limit,
   so if your application uses a lot of stack space define this function
   appropriately to keep the heap from growing into the stack.  */
unsigned long __libcfe_stack_size(void) __attribute__((__weak__));

/* Return the (max address + 1) to be used by this program.  (This address
   minus '_end' is used as the heap size, so the address should be in the
   same address space segments as _end.  The normal memory allocator
   queries CFE to determine the available memory.  */
void *__libcfe_mem_limit(void) __attribute__((__weak__));

/* If the configuration ability provided by __libcfe_mem_limit() and
   __libcfe_stack_size() do not provide enough flexibility for your
   application's memory allocation needs, you can replace the normal
   low-level allocator by providing the functions listed below and
   also the function:

        void *sbrk(ptrdiff_t incr);

   If you provide any of these functions, you should provide all three,
   and be sure to link them into your application as a .o file (rather
   than a .a).

   __libcfe_meminit() is responsible for initializing the low-level
   memory allocator.

   __libcfe_stack_top() returns a pointer to the top (highest address;
   the stack grows down from that address) of the stack to be used by
   the program.  */
void __libcfe_meminit (void);
void *__libcfe_stack_top (void);

/* End customization. */


/*  *********************************************************************
    *  Constants
    ********************************************************************* */

/* Seal indicating CFE's presence, passed to user program. */
#define CFE_EPTSEAL 0x43464531

#define CFE_MI_RESERVED 0               /* memory is reserved, do not use */
#define CFE_MI_AVAILABLE 1              /* memory is available */

#define CFE_FLG_WARMSTART     0x00000001
#define CFE_FLG_FULL_ARENA    0x00000001
#define CFE_FLG_ENV_PERMANENT 0x00000001

#define CFE_CPU_CMD_START 1
#define CFE_CPU_CMD_STOP 0

#define CFE_STDHANDLE_CONSOLE   0

#define CFE_DEV_NETWORK         1
#define CFE_DEV_DISK            2
#define CFE_DEV_FLASH           3
#define CFE_DEV_SERIAL          4
#define CFE_DEV_CPU             5
#define CFE_DEV_NVRAM           6
#define CFE_DEV_CLOCK           7
#define CFE_DEV_OTHER           8
#define CFE_DEV_MASK            0x0F

#define CFE_CACHE_FLUSH_D       1
#define CFE_CACHE_INVAL_I       2
#define CFE_CACHE_INVAL_D       4
#define CFE_CACHE_INVAL_L2      8

#define CFE_FWI_64BIT           0x00000001
#define CFE_FWI_32BIT           0x00000002
#define CFE_FWI_RELOC           0x00000004
#define CFE_FWI_UNCACHED        0x00000008
#define CFE_FWI_MULTICPU        0x00000010
#define CFE_FWI_FUNCSIM         0x00000020
#define CFE_FWI_RTLSIM          0x00000040

typedef struct {
    int64_t fwi_version;                /* major, minor, eco version */
    int64_t fwi_totalmem;               /* total installed mem */
    int64_t fwi_flags;                  /* various flags */
    int64_t fwi_boardid;                /* board ID */
    int64_t fwi_bootarea_va;            /* VA of boot area */
    int64_t fwi_bootarea_pa;            /* PA of boot area */
    int64_t fwi_bootarea_size;          /* size of boot area */
} cfe_fwinfo_t;


/*
 * cfe_strlen is handled specially: If already defined, it has been
 * overridden in this environment with a standard strlen-like function.
 */
#ifdef cfe_strlen
# define CFE_API_STRLEN_CUSTOM
#else
# ifdef CFE_API_IMPL_NAMESPACE
#  define cfe_strlen(a)                 __cfe_strlen(a)
# endif
int cfe_strlen(char *name);
#endif

/*
 * Defines and prototypes for functions which take no arguments.
 */
#ifdef CFE_API_IMPL_NAMESPACE
int64_t __cfe_getticks(void);
#define cfe_getticks()                  __cfe_getticks()
#else
int64_t cfe_getticks(void);
#endif

/*
 * Defines and prototypes for the rest of the functions.
 */
#ifdef CFE_API_IMPL_NAMESPACE
#define cfe_close(a)                    __cfe_close(a)
#define cfe_cpu_start(a,b,c,d,e)        __cfe_cpu_start(a,b,c,d,e)
#define cfe_cpu_stop(a)                 __cfe_cpu_stop(a)
#define cfe_enumenv(a,b,d,e,f)          __cfe_enumenv(a,b,d,e,f)
#define cfe_enummem(a,b,c,d,e)          __cfe_enummem(a,b,c,d,e)
#define cfe_exit(a,b)                   __cfe_exit(a,b)
#define cfe_flushcache(a)               __cfe_cacheflush(a)
#define cfe_getdevinfo(a)               __cfe_getdevinfo(a)
#define cfe_getenv(a,b,c)               __cfe_getenv(a,b,c)
#define cfe_getfwinfo(a)                __cfe_getfwinfo(a)
#define cfe_getstdhandle(a)             __cfe_getstdhandle(a)
#define cfe_init(a,b)                   __cfe_init(a,b)
#define cfe_inpstat(a)                  __cfe_inpstat(a)
#define cfe_ioctl(a,b,c,d,e,f)          __cfe_ioctl(a,b,c,d,e,f)
#define cfe_open(a)                     __cfe_open(a)
#define cfe_read(a,b,c)                 __cfe_read(a,b,c)
#define cfe_readblk(a,b,c,d)            __cfe_readblk(a,b,c,d)
#define cfe_setenv(a,b)                 __cfe_setenv(a,b)
#define cfe_write(a,b,c)                __cfe_write(a,b,c)
#define cfe_writeblk(a,b,c,d)           __cfe_writeblk(a,b,c,d)
#endif /* CFE_API_IMPL_NAMESPACE */

int cfe_close(int handle);
int cfe_cpu_start(int cpu, void (*fn)(void), long sp, long gp, long a1);
int cfe_cpu_stop(int cpu);
int cfe_enumenv(int idx, char *name, int namelen, char *val, int vallen);
int cfe_enummem(int idx, int flags, uint64_t *start, uint64_t *length,
                uint64_t *type);
int cfe_exit(int warm,int status);
int cfe_flushcache(int flg);
int cfe_getdevinfo(char *name);
int cfe_getenv(char *name, char *dest, int destlen);
int cfe_getfwinfo(cfe_fwinfo_t *info);
int cfe_getstdhandle(int flg);
int cfe_init(uint64_t handle,uint64_t ept);
int cfe_inpstat(int handle);
int cfe_ioctl(int handle, unsigned int ioctlnum, unsigned char *buffer,
              int length, int *retlen, uint64_t offset);
int cfe_open(char *name);
int cfe_read(int handle, unsigned char *buffer, int length);
int cfe_readblk(int handle, int64_t offset, unsigned char *buffer, int length);
int cfe_setenv(char *name, char *val);
int cfe_write(int handle, unsigned char *buffer, int length);
int cfe_writeblk(int handle, int64_t offset, unsigned char *buffer,
                 int length);

#endif /* CFE_API_H */