release/src-rt-6.x.4708/cfe/cfe/include/cfe.h

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  CFE version # and prototypes             File: cfe.h
   5     *
   6     *  CFE's version # temporarily lives here.
   7     *
   8     *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
   9     *
  10     *********************************************************************
  11     *
  12     *  Copyright 2000,2001,2002,2003
  13     *  Broadcom Corporation. All rights reserved.
  14     *
  15     *  This software is furnished under license and may be used and
  16     *  copied only in accordance with the following terms and
  17     *  conditions.  Subject to these conditions, you may download,
  18     *  copy, install, use, modify and distribute modified or unmodified
  19     *  copies of this software in source and/or binary form.  No title
  20     *  or ownership is transferred hereby.
  21     *
  22     *  1) Any source code used, modified or distributed must reproduce
  23     *     and retain this copyright notice and list of conditions
  24     *     as they appear in the source file.
  25     *
  26     *  2) No right is granted to use any trade name, trademark, or
  27     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
  28     *     name may not be used to endorse or promote products derived
  29     *     from this software without the prior written permission of
  30     *     Broadcom Corporation.
  31     *
  32     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  33     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  34     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  35     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  36     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  37     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  38     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  39     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  40     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  41     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  42     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  43     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  44     *     THE POSSIBILITY OF SUCH DAMAGE.
  45     ********************************************************************* */
  46
  47
  48 /*  *********************************************************************
  49     *  Version number
  50     ********************************************************************* */
  51
  52 #define CFE_VER_MAJOR   CFE_VER_MAJ
  53 #define CFE_VER_MINOR   CFE_VER_MIN
  54 #define CFE_VER_BUILD   CFE_VER_ECO
  55
  56 /*  *********************************************************************
  57     *  Some runtime startup parameters
  58     ********************************************************************* */
  59
  60 extern unsigned cfe_startflags;
  61
  62 #define CFE_INIT_USER   0x0000FFFF              /* these are BSP-specific flags */
  63 #define CFE_INIT_SAFE   0x00010000              /* "Safe mode" */
  64 #define CFE_INIT_PCI    0x00020000              /* Initialize PCI */
  65 #define CFE_LDT_SLAVE   0x00040000              /* Select LDT slave mode */
  66
  67 /*  *********************************************************************
  68     *  Other constants
  69     ********************************************************************* */
  70
  71 #define CFE_MAX_HANDLE 64               /* max file handles */
  72
  73 /*  *********************************************************************
  74     *  prototypes
  75     ********************************************************************* */
  76
  77 void board_console_init(void);
  78 void board_device_init(void);
  79 void board_final_init(void);
  80 void board_device_reset(void);
  81 #define CFE_BUFFER_CONSOLE "buffer"
  82 int cfe_set_console(char *);
  83 int cfe_set_envdevice(char *);
  84 void cfe_restart(void);
  85 void cfe_command_loop(void);
  86 void cfe_leds(unsigned int val);
  87 void cfe_ledstr(const char *str);
  88 void cfe_launch(unsigned long ept);
  89 void cfe_start(unsigned long ept);
  90 void cfe_warmstart(unsigned long long);
  91 #define SETLEDS(x) cfe_ledstr(x)
  92 const char *cfe_errortext(int err);
  93 #ifdef CFG_NFLASH
  94 void ui_get_boot_flashdev(char *flashdev);
  95 void ui_get_os_flashdev(char *flashdev);
  96 void ui_get_trx_flashdev(char *flashdev);
  97 void dump_nflash(int block_no);
  98 #endif /* CFG_NFLASH */