1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/****************************************************************************
* include/nuttx/syslog/ramlog.h
* The RAM logging driver
*
* Copyright (C) 2012, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/* The RAM logging driver is a driver that was intended to support debugging
* output (syslogging) when the normal serial output is not available. For
* example, if you are using a telnet or USB serial console, the debug
* output will get lost.
*
* The RAM logging driver is similar to a pipe in that it saves the
* debugging output in a FIFO in RAM. It differs from a pipe in numerous
* details as needed to support logging.
*
* This driver is built when CONFIG_RAMLOG is defined in the Nuttx
* configuration.
*/
#ifndef __INCLUDE_NUTTX_SYSLOG_RAMLOG_H
#define __INCLUDE_NUTTX_SYSLOG_RAMLOG_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/syslog/syslog.h>
#ifdef CONFIG_RAMLOG
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
/* CONFIG_RAMLOG - Enables the RAM logging feature
* CONFIG_RAMLOG_CONSOLE - Use the RAM logging device as a system console.
* If this feature is enabled (along with CONFIG_DEV_CONSOLE), then all
* console output will be re-directed to a circular buffer in RAM. This
* is useful, for example, if the only console is a Telnet console. Then
* in that case, console output from non-Telnet threads will go to the
* circular buffer and can be viewed using the NSH 'dmesg' command.
* CONFIG_RAMLOG_SYSLOG - Use the RAM logging device for the syslogging
* interface. If this feature is enabled (along with CONFIG_SYSLOG),
* then all debug output (only) will be re-directed to the circular
* buffer in RAM. This RAM log can be view from NSH using the 'dmesg'
* command. NOTE: Unlike the limited, generic character driver SYSLOG
* device, the RAMLOG *can* be used to generate debug output from interrupt
* level handlers.
* CONFIG_RAMLOG_NPOLLWAITERS - The number of threads than can be waiting
* for this driver on poll(). Default: 4
*
* If CONFIG_RAMLOG_CONSOLE or CONFIG_RAMLOG_SYSLOG is selected, then the
* following may also be provided:
*
* CONFIG_RAMLOG_BUFSIZE - Size of the console RAM log. Default: 1024
*/
#ifndef CONFIG_DEV_CONSOLE
# undef CONFIG_RAMLOG_CONSOLE
#endif
#ifndef CONFIG_SYSLOG
# undef CONFIG_RAMLOG_SYSLOG
#endif
#if defined(CONFIG_RAMLOG_SYSLOG) && !defined(CONFIG_SYSLOG_DEVPATH)
# define CONFIG_SYSLOG_DEVPATH "/dev/ramlog"
#endif
#ifndef CONFIG_RAMLOG_NPOLLWAITERS
# define CONFIG_RAMLOG_NPOLLWAITERS 4
#endif
#ifndef CONFIG_SYSLOG
# undef CONFIG_RAMLOG_SYSLOG
#endif
#ifndef CONFIG_RAMLOG_BUFSIZE
# define CONFIG_RAMLOG_BUFSIZE 1024
#endif
/* The normal behavior of the RAM log when used as a SYSLOG is to return
* end-of-file if there is no data in the RAM log (rather than blocking until
* data is available). That allows you to 'cat' the SYSLOG with no ill
* consequences.
*/
#ifdef CONFIG_SYSLOG
# undef CONFIG_RAMLOG_NONBLOCKING
# define CONFIG_RAMLOG_NONBLOCKING 1
#endif
/* When used as a console or syslogging device, the RAM log will pre-pend
* line-feeds with carriage returns.
*/
#if defined(CONFIG_RAMLOG_CONSOLE) || defined(CONFIG_RAMLOG_SYSLOG)
# undef CONFIG_RAMLOG_CRLF
# define CONFIG_RAMLOG_CRLF 1
#endif
/****************************************************************************
* Public Data
****************************************************************************/
#ifndef __ASSEMBLY__
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: ramlog_register
*
* Description:
* Create the RAM logging device and register it at the specified path.
* Mostly likely this path will be /dev/console.
*
* This interface is not normally used but can be made available is
* someone just wants to tinker with the RAM log as a generic character
* device. Normally both CONFIG_RAMLOG_CONSOLE and CONFIG_RAMLOG_SYSLOG
* would be set (to capture all output in the log) -OR- just
* CONFIG_RAMLOG_SYSLOG would be set to capture debug output only
* in the log.
*
****************************************************************************/
#if !defined(CONFIG_RAMLOG_CONSOLE) && !defined(CONFIG_RAMLOG_SYSLOG)
EXTERN int ramlog_register(FAR const char *devpath, FAR char *buffer,
size_t buflen);
#endif
/****************************************************************************
* Name: ramlog_consoleinit
*
* Description:
* Create the RAM logging device and register it at the specified path.
* Mostly likely this path will be /dev/console.
*
* If CONFIG_RAMLOG_SYSLOG is also defined, then the same RAM logging
* device is also registered at CONFIG_SYSLOG_DEVPATH
*
****************************************************************************/
#ifdef CONFIG_RAMLOG_CONSOLE
EXTERN int ramlog_consoleinit(void);
#endif
/****************************************************************************
* Name: ramlog_sysloginit
*
* Description:
* Create the RAM logging device and register it at the specified path.
* Mostly likely this path will be CONFIG_SYSLOG_DEVPATH
*
* If CONFIG_RAMLOG_CONSOLE is also defined, then this functionality is
* performed when ramlog_consoleinit() is called.
*
****************************************************************************/
#ifdef CONFIG_RAMLOG_SYSLOG
EXTERN int ramlog_sysloginit(void);
#endif
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* CONFIG_RAMLOG */
#endif /* __INCLUDE_NUTTX_SYSLOG_RAMLOG_H */
|
