SEGGER_RTT.h

00001 /*********************************************************************
00002 *              SEGGER MICROCONTROLLER SYSTEME GmbH                   *
00003 *        Solutions for real time microcontroller applications        *
00004 **********************************************************************
00005 *                                                                    *
00006 *        (c) 1996-2014 SEGGER Microcontroller Systeme GmbH           *
00007 *                                                                    *
00008 * Internet: www.segger.com Support: support@segger.com               *
00009 *                                                                    *
00010 **********************************************************************
00011 ----------------------------------------------------------------------
00012 File    : SEGGER_RTT.h
00013 Date    : 17 Dec 2014
00014 Purpose : Implementation of SEGGER real-time terminal which allows
00015           real-time terminal communication on targets which support
00016           debugger memory accesses while the CPU is running.
00017 ---------------------------END-OF-HEADER------------------------------
00018 */
00019 
00020 /*********************************************************************
00021 *
00022 *       Defines
00023 *
00024 **********************************************************************
00025 */
00026 #define SEGGER_RTT_MODE_MASK                  (3 << 0)
00027 
00028 #define SEGGER_RTT_MODE_NO_BLOCK_SKIP         (0)
00029 #define SEGGER_RTT_MODE_NO_BLOCK_TRIM         (1 << 0)
00030 #define SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL    (1 << 1)
00031 
00032 #define RTT_CTRL_RESET                ""
00033 
00034 #define RTT_CTRL_CLEAR                ""
00035 
00036 #define RTT_CTRL_TEXT_BLACK           ""
00037 #define RTT_CTRL_TEXT_RED             ""
00038 #define RTT_CTRL_TEXT_GREEN           ""
00039 #define RTT_CTRL_TEXT_YELLOW          ""
00040 #define RTT_CTRL_TEXT_BLUE            ""
00041 #define RTT_CTRL_TEXT_MAGENTA         ""
00042 #define RTT_CTRL_TEXT_CYAN            ""
00043 #define RTT_CTRL_TEXT_WHITE           ""
00044 
00045 #define RTT_CTRL_TEXT_BRIGHT_BLACK    ""
00046 #define RTT_CTRL_TEXT_BRIGHT_RED      ""
00047 #define RTT_CTRL_TEXT_BRIGHT_GREEN    ""
00048 #define RTT_CTRL_TEXT_BRIGHT_YELLOW   ""
00049 #define RTT_CTRL_TEXT_BRIGHT_BLUE     ""
00050 #define RTT_CTRL_TEXT_BRIGHT_MAGENTA  ""
00051 #define RTT_CTRL_TEXT_BRIGHT_CYAN     ""
00052 #define RTT_CTRL_TEXT_BRIGHT_WHITE    ""
00053 
00054 #define RTT_CTRL_BG_BLACK             ""
00055 #define RTT_CTRL_BG_RED               ""
00056 #define RTT_CTRL_BG_GREEN             ""
00057 #define RTT_CTRL_BG_YELLOW            ""
00058 #define RTT_CTRL_BG_BLUE              ""
00059 #define RTT_CTRL_BG_MAGENTA           ""
00060 #define RTT_CTRL_BG_CYAN              ""
00061 #define RTT_CTRL_BG_WHITE             ""
00062 
00063 #define RTT_CTRL_BG_BRIGHT_BLACK      ""
00064 #define RTT_CTRL_BG_BRIGHT_RED        ""
00065 #define RTT_CTRL_BG_BRIGHT_GREEN      ""
00066 #define RTT_CTRL_BG_BRIGHT_YELLOW     ""
00067 #define RTT_CTRL_BG_BRIGHT_BLUE       ""
00068 #define RTT_CTRL_BG_BRIGHT_MAGENTA    ""
00069 #define RTT_CTRL_BG_BRIGHT_CYAN       ""
00070 #define RTT_CTRL_BG_BRIGHT_WHITE      ""
00071 
00072 
00073 /*********************************************************************
00074 *
00075 *       RTT API functions
00076 *
00077 **********************************************************************
00078 */
00079 
00080 int     SEGGER_RTT_Read             (unsigned BufferIndex,       char* pBuffer, unsigned BufferSize);
00081 int     SEGGER_RTT_Write            (unsigned BufferIndex, const char* pBuffer, unsigned NumBytes);
00082 int     SEGGER_RTT_WriteString      (unsigned BufferIndex, const char* s);
00083 
00084 int     SEGGER_RTT_GetKey           (void);
00085 int     SEGGER_RTT_WaitKey          (void);
00086 int     SEGGER_RTT_HasKey           (void);
00087 
00088 int     SEGGER_RTT_ConfigUpBuffer   (unsigned BufferIndex, const char* sName, char* pBuffer, int BufferSize, int Flags);
00089 int     SEGGER_RTT_ConfigDownBuffer (unsigned BufferIndex, const char* sName, char* pBuffer, int BufferSize, int Flags);
00090 
00091 void    SEGGER_RTT_Init             (void);
00092 
00093 /*********************************************************************
00094 *
00095 *       RTT "Terminal" API functions
00096 *
00097 **********************************************************************
00098 */
00099 void    SEGGER_RTT_SetTerminal        (char TerminalId);
00100 int     SEGGER_RTT_TerminalOut        (char TerminalId, const char* s);
00101 
00102 /*********************************************************************
00103 *
00104 *       RTT printf functions (require SEGGER_RTT_printf.c)
00105 *
00106 **********************************************************************
00107 */
00108 int SEGGER_RTT_printf(unsigned BufferIndex, const char * sFormat, ...);
00109 
00110 /*************************** End of file ****************************/