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

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  Console prototypes                       File: cfe_console.c
   5     *
   6     *  Prototypes for routines dealing with the console.
   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     *  Constants
  49     ********************************************************************* */
  50
  51 #define VKEY(x)         (0x100|(x))
  52 #define VKEY_UP         VKEY(1)
  53 #define VKEY_DOWN       VKEY(2)
  54 #define VKEY_LEFT       VKEY(3)
  55 #define VKEY_RIGHT      VKEY(4)
  56 #define VKEY_PGUP       VKEY(5)
  57 #define VKEY_PGDN       VKEY(6)
  58 #define VKEY_HOME       VKEY(7)
  59 #define VKEY_END        VKEY(8)
  60 #define VKEY_F1         VKEY(0x10)
  61 #define VKEY_F2         VKEY(0x11)
  62 #define VKEY_F3         VKEY(0x12)
  63 #define VKEY_F4         VKEY(0x13)
  64 #define VKEY_F5         VKEY(0x14)
  65 #define VKEY_F6         VKEY(0x15)
  66 #define VKEY_F7         VKEY(0x16)
  67 #define VKEY_F8         VKEY(0x17)
  68 #define VKEY_F9         VKEY(0x18)
  69 #define VKEY_F10        VKEY(0x19)
  70 #define VKEY_F11        VKEY(0x1A)
  71 #define VKEY_F12        VKEY(0x1B)
  72 #define VKEY_ESC        27
  73
  74
  75 /*  *********************************************************************
  76     *  Prototypes
  77     ********************************************************************* */
  78
  79 int console_open(char *name);
  80 int console_close(void);
  81 int console_read(char *buffer,int length);
  82 int console_write(char *buffer,int length);
  83 int console_status(void);
  84 int console_readkey(void);
  85 int console_readline(char *prompt,char *str,int len);
  86 int console_readline_noedit(char *prompt,char *str,int len);
  87 int console_readline(char *prompt,char *str,int len);
  88 extern char *console_name;
  89 extern int console_handle;
  90 void console_log(const char *tmplt,...);