Appiko
SEGGER_RTT.h
1 /*********************************************************************
2 * SEGGER MICROCONTROLLER GmbH & Co. KG *
3 * Solutions for real time microcontroller applications *
4 **********************************************************************
5 * *
6 * (c) 2014 - 2016 SEGGER Microcontroller GmbH & Co. KG *
7 * *
8 * www.segger.com Support: support@segger.com *
9 * *
10 **********************************************************************
11 * *
12 * SEGGER RTT * Real Time Transfer for embedded targets *
13 * *
14 **********************************************************************
15 * *
16 * All rights reserved. *
17 * *
18 * SEGGER strongly recommends to not make any changes *
19 * to or modify the source code of this software in order to stay *
20 * compatible with the RTT protocol and J-Link. *
21 * *
22 * Redistribution and use in source and binary forms, with or *
23 * without modification, are permitted provided that the following *
24 * conditions are met: *
25 * *
26 * o Redistributions of source code must retain the above copyright *
27 * notice, this list of conditions and the following disclaimer. *
28 * *
29 * o Redistributions in binary form must reproduce the above *
30 * copyright notice, this list of conditions and the following *
31 * disclaimer in the documentation and/or other materials provided *
32 * with the distribution. *
33 * *
34 * o Neither the name of SEGGER Microcontroller GmbH & Co. KG *
35 * nor the names of its contributors may be used to endorse or *
36 * promote products derived from this software without specific *
37 * prior written permission. *
38 * *
39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
40 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, *
41 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF *
42 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE *
43 * DISCLAIMED. IN NO EVENT SHALL SEGGER Microcontroller BE LIABLE FOR *
44 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR *
45 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT *
46 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; *
47 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
48 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE *
50 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH *
51 * DAMAGE. *
52 * *
53 **********************************************************************
54 ---------------------------END-OF-HEADER------------------------------
55 File : SEGGER_RTT.h
56 Purpose : Implementation of SEGGER real-time transfer which allows
57  real-time communication on targets which support debugger
58  memory accesses while the CPU is running.
59 Revision: $Rev: 4351 $
60 ----------------------------------------------------------------------
61 */
62 
63 #ifndef SEGGER_RTT_H
64 #define SEGGER_RTT_H
65 
66 #include "SEGGER_RTT_Conf.h"
67 
68 /*********************************************************************
69 *
70 * Defines, fixed
71 *
72 **********************************************************************
73 */
74 
75 /*********************************************************************
76 *
77 * Types
78 *
79 **********************************************************************
80 */
81 
82 //
83 // Description for a circular buffer (also called "ring buffer")
84 // which is used as up-buffer (T->H)
85 //
86 typedef struct {
87  const char* sName; // Optional name. Standard names so far are: "Terminal", "SysView", "J-Scope_t4i4"
88  char* pBuffer; // Pointer to start of buffer
89  unsigned SizeOfBuffer; // Buffer size in bytes. Note that one byte is lost, as this implementation does not fill up the buffer in order to avoid the problem of being unable to distinguish between full and empty.
90  unsigned WrOff; // Position of next item to be written by either target.
91  volatile unsigned RdOff; // Position of next item to be read by host. Must be volatile since it may be modified by host.
92  unsigned Flags; // Contains configuration flags
93 } SEGGER_RTT_BUFFER_UP;
94 
95 //
96 // Description for a circular buffer (also called "ring buffer")
97 // which is used as down-buffer (H->T)
98 //
99 typedef struct {
100  const char* sName; // Optional name. Standard names so far are: "Terminal", "SysView", "J-Scope_t4i4"
101  char* pBuffer; // Pointer to start of buffer
102  unsigned SizeOfBuffer; // Buffer size in bytes. Note that one byte is lost, as this implementation does not fill up the buffer in order to avoid the problem of being unable to distinguish between full and empty.
103  volatile unsigned WrOff; // Position of next item to be written by host. Must be volatile since it may be modified by host.
104  unsigned RdOff; // Position of next item to be read by target (down-buffer).
105  unsigned Flags; // Contains configuration flags
106 } SEGGER_RTT_BUFFER_DOWN;
107 
108 //
109 // RTT control block which describes the number of buffers available
110 // as well as the configuration for each buffer
111 //
112 //
113 typedef struct {
114  char acID[16]; // Initialized to "SEGGER RTT"
115  int MaxNumUpBuffers; // Initialized to SEGGER_RTT_MAX_NUM_UP_BUFFERS (type. 2)
116  int MaxNumDownBuffers; // Initialized to SEGGER_RTT_MAX_NUM_DOWN_BUFFERS (type. 2)
117  SEGGER_RTT_BUFFER_UP aUp[SEGGER_RTT_MAX_NUM_UP_BUFFERS]; // Up buffers, transferring information up from target via debug probe to host
118  SEGGER_RTT_BUFFER_DOWN aDown[SEGGER_RTT_MAX_NUM_DOWN_BUFFERS]; // Down buffers, transferring information down from host via debug probe to target
119 } SEGGER_RTT_CB;
120 
121 /*********************************************************************
122 *
123 * Global data
124 *
125 **********************************************************************
126 */
127 extern SEGGER_RTT_CB _SEGGER_RTT;
128 
129 /*********************************************************************
130 *
131 * RTT API functions
132 *
133 **********************************************************************
134 */
135 #ifdef __cplusplus
136  extern "C" {
137 #endif
138 int SEGGER_RTT_AllocDownBuffer (const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags);
139 int SEGGER_RTT_AllocUpBuffer (const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags);
140 int SEGGER_RTT_ConfigUpBuffer (unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags);
141 int SEGGER_RTT_ConfigDownBuffer (unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags);
142 int SEGGER_RTT_GetKey (void);
143 unsigned SEGGER_RTT_HasData (unsigned BufferIndex);
144 int SEGGER_RTT_HasKey (void);
145 void SEGGER_RTT_Init (void);
146 unsigned SEGGER_RTT_Read (unsigned BufferIndex, void* pBuffer, unsigned BufferSize);
147 unsigned SEGGER_RTT_ReadNoLock (unsigned BufferIndex, void* pData, unsigned BufferSize);
148 int SEGGER_RTT_SetNameDownBuffer (unsigned BufferIndex, const char* sName);
149 int SEGGER_RTT_SetNameUpBuffer (unsigned BufferIndex, const char* sName);
150 int SEGGER_RTT_SetFlagsDownBuffer (unsigned BufferIndex, unsigned Flags);
151 int SEGGER_RTT_SetFlagsUpBuffer (unsigned BufferIndex, unsigned Flags);
152 int SEGGER_RTT_WaitKey (void);
153 unsigned SEGGER_RTT_Write (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
154 unsigned SEGGER_RTT_WriteNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
155 unsigned SEGGER_RTT_WriteSkipNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
156 unsigned SEGGER_RTT_WriteString (unsigned BufferIndex, const char* s);
157 void SEGGER_RTT_WriteWithOverwriteNoLock(unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
158 //
159 // Function macro for performance optimization
160 //
161 #define SEGGER_RTT_HASDATA(n) (_SEGGER_RTT.aDown[n].WrOff - _SEGGER_RTT.aDown[n].RdOff)
162 
163 /*********************************************************************
164 *
165 * RTT "Terminal" API functions
166 *
167 **********************************************************************
168 */
169 int SEGGER_RTT_SetTerminal (char TerminalId);
170 int SEGGER_RTT_TerminalOut (char TerminalId, const char* s);
171 
172 /*********************************************************************
173 *
174 * RTT printf functions (require SEGGER_RTT_printf.c)
175 *
176 **********************************************************************
177 */
178 int SEGGER_RTT_printf(unsigned BufferIndex, const char * sFormat, ...);
179 #ifdef __cplusplus
180  }
181 #endif
182 
183 /*********************************************************************
184 *
185 * Defines
186 *
187 **********************************************************************
188 */
189 
190 //
191 // Operating modes. Define behavior if buffer is full (not enough space for entire message)
192 //
193 #define SEGGER_RTT_MODE_NO_BLOCK_SKIP (0U) // Skip. Do not block, output nothing. (Default)
194 #define SEGGER_RTT_MODE_NO_BLOCK_TRIM (1U) // Trim: Do not block, output as much as fits.
195 #define SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL (2U) // Block: Wait until there is space in the buffer.
196 #define SEGGER_RTT_MODE_MASK (3U)
197 
198 //
199 // Control sequences, based on ANSI.
200 // Can be used to control color, and clear the screen
201 //
202 #define RTT_CTRL_RESET "" // Reset to default colors
203 #define RTT_CTRL_CLEAR "" // Clear screen, reposition cursor to top left
204 
205 #define RTT_CTRL_TEXT_BLACK ""
206 #define RTT_CTRL_TEXT_RED ""
207 #define RTT_CTRL_TEXT_GREEN ""
208 #define RTT_CTRL_TEXT_YELLOW ""
209 #define RTT_CTRL_TEXT_BLUE ""
210 #define RTT_CTRL_TEXT_MAGENTA ""
211 #define RTT_CTRL_TEXT_CYAN ""
212 #define RTT_CTRL_TEXT_WHITE ""
213 
214 #define RTT_CTRL_TEXT_BRIGHT_BLACK ""
215 #define RTT_CTRL_TEXT_BRIGHT_RED ""
216 #define RTT_CTRL_TEXT_BRIGHT_GREEN ""
217 #define RTT_CTRL_TEXT_BRIGHT_YELLOW ""
218 #define RTT_CTRL_TEXT_BRIGHT_BLUE ""
219 #define RTT_CTRL_TEXT_BRIGHT_MAGENTA ""
220 #define RTT_CTRL_TEXT_BRIGHT_CYAN ""
221 #define RTT_CTRL_TEXT_BRIGHT_WHITE ""
222 
223 #define RTT_CTRL_BG_BLACK ""
224 #define RTT_CTRL_BG_RED ""
225 #define RTT_CTRL_BG_GREEN ""
226 #define RTT_CTRL_BG_YELLOW ""
227 #define RTT_CTRL_BG_BLUE ""
228 #define RTT_CTRL_BG_MAGENTA ""
229 #define RTT_CTRL_BG_CYAN ""
230 #define RTT_CTRL_BG_WHITE ""
231 
232 #define RTT_CTRL_BG_BRIGHT_BLACK ""
233 #define RTT_CTRL_BG_BRIGHT_RED ""
234 #define RTT_CTRL_BG_BRIGHT_GREEN ""
235 #define RTT_CTRL_BG_BRIGHT_YELLOW ""
236 #define RTT_CTRL_BG_BRIGHT_BLUE ""
237 #define RTT_CTRL_BG_BRIGHT_MAGENTA ""
238 #define RTT_CTRL_BG_BRIGHT_CYAN ""
239 #define RTT_CTRL_BG_BRIGHT_WHITE ""
240 
241 
242 #endif
243 
244 /*************************** End of file ****************************/
Generated by   doxygen 1.8.15