Home | History | Annotate | Line # | Download | only in cfe
cfe_api.h revision 1.1 
      1 /* $NetBSD: cfe_api.h,v 1.1 2002/03/05 23:46:41 simonb Exp $ */
      2 
      3 /*
      4  * Copyright 2000, 2001
      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. Neither the "Broadcom Corporation" name nor any
     19  *    trademark or logo of Broadcom Corporation may be used to endorse or
     20  *    promote products derived from this software without the prior written
     21  *    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     *  Broadcom Common Firmware Environment (CFE)
     38     *
     39     *  Device function prototypes		File: cfe_api.h
     40     *
     41     *  This module contains prototypes for cfe_devfuncs.c, a set
     42     *  of wrapper routines to the IOCB interface.  This file,
     43     *  along with cfe_api.c, can be incorporated into programs
     44     *  that need to call CFE.
     45     *
     46     *  Author:  Mitch Lichtenberg (mpl (at) broadcom.com)
     47     *
     48     ********************************************************************* */
     49 
     50 
     51 #define	CFE_EPTSEAL 0x43464531
     52 #define	CFE_APIENTRY 0xBFC00500
     53 #define	CFE_APISEAL  0xBFC00508
     54 
     55 #ifndef __ASSEMBLER__
     56 int cfe_init(cfe_xuint_t handle);
     57 int cfe_open(char *name);
     58 int cfe_close(int handle);
     59 int cfe_readblk(int handle,cfe_xint_t offset,u_char *buffer,int length);
     60 int cfe_read(int handle,u_char *buffer,int length);
     61 int cfe_writeblk(int handle,cfe_xint_t offset,u_char *buffer,int length);
     62 int cfe_write(int handle,u_char *buffer,int length);
     63 int cfe_ioctl(int handle,u_int ioctlnum,u_char *buffer,int length,int *retlen);
     64 int cfe_inpstat(int handle);
     65 int cfe_enumenv(int idx,char *name,int namelen,char *val,int vallen);
     66 int cfe_setenv(char *name,char *val);
     67 int cfe_getenv(char *name,char *dest,int destlen);
     68 long long cfe_getticks(void);
     69 int cfe_exit(int warm,int status);
     70 int cfe_flushcache(int flg);
     71 int cfe_getstdhandle(int flg);
     72 int cfe_getdevinfo(char *name);
     73 int cfe_getmeminfo(int idx,cfe_xuint_t *start,cfe_xuint_t *length,cfe_xuint_t *type);
     74 int cfe_getfwinfo(cfe_fwinfo_t *info);
     75 #endif
     76