Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.10.0.3
openapi_logging.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2022 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_logging.h
28 *
29 * @purpose Logging Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 28/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_LOGGING_H_INCLUDED
39 #define OPENAPI_LOGGING_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_LOG_SEVERITY_UNDEFINED = -1,
47  OPEN_LOG_SEVERITY_EMERGENCY = 0,
48  OPEN_LOG_SEVERITY_ALERT = 1,
49  OPEN_LOG_SEVERITY_CRITICAL = 2,
50  OPEN_LOG_SEVERITY_ERROR = 3,
51  OPEN_LOG_SEVERITY_WARNING = 4,
52  OPEN_LOG_SEVERITY_NOTICE = 5,
53  OPEN_LOG_SEVERITY_INFO = 6,
54  OPEN_LOG_SEVERITY_DEBUG = 7
56 } OPEN_LOG_SEVERITY_t;
57 
58 typedef enum
59 {
60  OPEN_USB_LOGGING_OVERWRITE_ON_FULL = 1,
61  OPEN_USB_LOGGING_STOP_ON_FULL,
62  OPEN_USB_LOGGING_DISABLE,
63 } OPEN_USB_LOGGING_MODE_t;
64 
65 typedef enum
66 {
67  OPEN_USB_LOGGING_STATUS_ACTIVE = 1,
68  OPEN_USB_LOGGING_STATUS_INACTIVE,
69 } OPEN_USB_LOGGING_OPER_STATUS_t;
70 
71 #define OPENAPI_LOG_FORMAT_BUF_SIZE 512
72 
73 #define OPENAPI_LOG_ENTRY_BUF_SIZE (OPENAPI_LOG_FORMAT_BUF_SIZE + 80)
74 
75 #define OPENAPI_TRAP_ENTRY_SIZE (300)
76 
77 typedef struct
78 {
79  char trapEntry[OPENAPI_TRAP_ENTRY_SIZE];
80 } openapiTrapLogEntry_t;
81 
82 #define OPENAPI_TRAP_LOG_BUF_SIZE (256 * sizeof(openapiTrapLogEntry_t))
83 
84 
85 /*****************************************************************/
99 open_error_t openapiCliCmdLoggingModeSet(openapiClientHandle_t *client_handle,
100  OPEN_CONTROL_t cmdLoggingMode);
101 
102 /*****************************************************************/
116 open_error_t openapiCliCmdLoggingModeGet(openapiClientHandle_t *client_handle,
117  OPEN_CONTROL_t *cmdLoggingMode);
118 
119 /*****************************************************************/
134 open_error_t openapiConsoleLoggingModeSet(openapiClientHandle_t *client_handle,
135  OPEN_CONTROL_t loggingConsoleMode);
136 
137 /*****************************************************************/
151 open_error_t openapiConsoleLoggingModeGet(openapiClientHandle_t *client_handle,
152  OPEN_CONTROL_t *loggingConsoleMode);
153 
154 /*****************************************************************/
171 open_error_t openapiConsoleLoggingSeveritySet(openapiClientHandle_t *client_handle,
172  OPEN_LOG_SEVERITY_t severityLevel);
173 
174 /*****************************************************************/
188 open_error_t openapiConsoleLoggingSeverityGet(openapiClientHandle_t *client_handle,
189  OPEN_LOG_SEVERITY_t *severityLevel);
190 
191 /*****************************************************************/
207 open_error_t openapiPersistentLoggingModeSet(openapiClientHandle_t *client_handle,
208  OPEN_CONTROL_t persistentLoggingMode);
209 
210 /*****************************************************************/
227 open_error_t openapiPersistentLoggingSeverityLevelSet(openapiClientHandle_t *client_handle,
228  OPEN_LOG_SEVERITY_t severityLevel);
229 
230 /*****************************************************************/
245 open_error_t openapiPersistentLoggingModeGet(openapiClientHandle_t *client_handle,
246  OPEN_CONTROL_t *loggingPersistentMode);
247 
248 /*****************************************************************/
263 open_error_t openapiPersistentLoggingSeverityLevelGet(openapiClientHandle_t *client_handle,
264  OPEN_LOG_SEVERITY_t *severityLevel);
265 
266 /*****************************************************************/
281 open_error_t openapiSysLogModeSet(openapiClientHandle_t *client_handle,
282  OPEN_CONTROL_t sysLogMode);
283 
284 /*****************************************************************/
298 open_error_t openapiSysLogModeGet(openapiClientHandle_t *client_handle,
299  OPEN_CONTROL_t *sysLogMode);
300 
301 /*****************************************************************/
319 open_error_t openapiSysLogPortSet(openapiClientHandle_t *client_handle,
320  uint32_t port);
321 
322 /*****************************************************************/
336 open_error_t openapiSysLogPortGet(openapiClientHandle_t *client_handle,
337  uint16_t *port);
338 
339 /*****************************************************************/
362 open_error_t openapiLoggingHostAdd(openapiClientHandle_t *client_handle,
363  open_buffdesc *loggingHost);
364 
365 /*****************************************************************/
387 open_error_t openapiLoggingHostPortSet(openapiClientHandle_t *client_handle,
388  open_buffdesc *loggingHost, uint32_t port);
389 
390 /*****************************************************************/
411 open_error_t openapiLoggingHostSeveritySet(openapiClientHandle_t *client_handle,
412  open_buffdesc *loggingHost,
413  OPEN_LOG_SEVERITY_t severityLevel);
414 
415 /*****************************************************************/
433 open_error_t openapiLoggingHostIpAddrNextGet(openapiClientHandle_t *client_handle,
434  open_buffdesc *loggingHost);
435 
436 /*****************************************************************/
453 open_error_t openapiLoggingHostSeverityGet(openapiClientHandle_t *client_handle,
454  open_buffdesc *loggingHost,
455  OPEN_LOG_SEVERITY_t *severityLevel);
456 
457 /*****************************************************************/
474 open_error_t openapiLoggingHostPortGet(openapiClientHandle_t *client_handle,
475  open_buffdesc *loggingHost,
476  uint16_t *port);
477 
478 /*****************************************************************/
496 open_error_t openapiLoggingHostRemove(openapiClientHandle_t *client_handle,
497  open_buffdesc *loggingHost);
498 
499 /*****************************************************************/
512 open_error_t openapiMaxLoggingHostsSupportedGet(openapiClientHandle_t *client_handle,
513  uint32_t *maxLoggingHosts);
514 
515 /*****************************************************************/
529 open_error_t openapiLoggingHostMaxAddrLenGet(openapiClientHandle_t *client_handle,
530  uint32_t *logHostMaxAddrLen);
531 
532 /*****************************************************************/
549 open_error_t openapiSysLogWrite(openapiClientHandle_t *client_handle,
550  open_buffdesc *logMessage,
551  OPEN_LOG_SEVERITY_t severityLevel);
552 
553 /*****************************************************************/
577 open_error_t openapiBufferedLogEntryNextGet(openapiClientHandle_t *client_handle, uint32_t *logIndex,
578  open_buffdesc *logEntry);
579 
580 /*****************************************************************/
592 open_error_t openapiBufferedLogClear(openapiClientHandle_t *client_handle);
593 
594 /*****************************************************************/
609 open_error_t openapiTrapLogGet(openapiClientHandle_t *client_handle, open_buffdesc *trapLogData,
610  uint32_t *numberOfEntries);
611 
612 /*****************************************************************/
624 open_error_t openapiTrapLogClear(openapiClientHandle_t *client_handle);
625 
626 /*****************************************************************/
640 open_error_t openapiUsbLoggingModeSet(openapiClientHandle_t *client_handle,
641  OPEN_USB_LOGGING_MODE_t mode);
642 
643 /*****************************************************************/
657 open_error_t openapiUsbLoggingModeGet(openapiClientHandle_t *client_handle,
658  OPEN_USB_LOGGING_MODE_t *mode);
659 
660 /*****************************************************************/
674 open_error_t openapiUsbLoggingSeveritySet(openapiClientHandle_t *client_handle,
675  OPEN_LOG_SEVERITY_t severity);
676 
677 /*****************************************************************/
691 open_error_t openapiUsbLoggingSeverityGet(openapiClientHandle_t *client_handle,
692  OPEN_LOG_SEVERITY_t *severity);
693 
694 /*****************************************************************/
708 open_error_t openapiUsbLoggingOperStatusGet(openapiClientHandle_t *client_handle,
709  OPEN_USB_LOGGING_OPER_STATUS_t *mode);
710 #endif
711