openapi_logging.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_logging.h
*
* @purpose   Logging Configuration and Status 
*
* @component OpEN
*
* @create    28/01/2013
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_LOGGING_H_INCLUDED
#define OPENAPI_LOGGING_H_INCLUDED

#include "openapi_common.h"

typedef enum
{ 
  OPEN_LOG_SEVERITY_UNDEFINED = -1, 
  OPEN_LOG_SEVERITY_EMERGENCY = 0, 
  OPEN_LOG_SEVERITY_ALERT     = 1, 
  OPEN_LOG_SEVERITY_CRITICAL  = 2, 
  OPEN_LOG_SEVERITY_ERROR     = 3, 
  OPEN_LOG_SEVERITY_WARNING   = 4, 
  OPEN_LOG_SEVERITY_NOTICE    = 5, 
  OPEN_LOG_SEVERITY_INFO      = 6, 
  OPEN_LOG_SEVERITY_DEBUG     = 7  
} OPEN_LOG_SEVERITY_t;

typedef enum
{
  OPEN_USB_LOGGING_OVERWRITE_ON_FULL = 1, 
  OPEN_USB_LOGGING_STOP_ON_FULL,          
  OPEN_USB_LOGGING_DISABLE,               
} OPEN_USB_LOGGING_MODE_t;

typedef enum
{
  OPEN_USB_LOGGING_STATUS_ACTIVE = 1, 
  OPEN_USB_LOGGING_STATUS_INACTIVE,   
} OPEN_USB_LOGGING_OPER_STATUS_t;

typedef enum
{
  OPEN_MEMORY_WRAP_BEHAVIOR,         
  OPEN_MEMORY_STOP_ON_FULL_BEHAVIOR  
} OPEN_MEMORY_BEHAVIOR_t;

#define OPENAPI_LOG_FORMAT_BUF_SIZE 512

#define OPENAPI_LOG_ENTRY_BUF_SIZE (OPENAPI_LOG_FORMAT_BUF_SIZE + 80)

#define OPENAPI_TRAP_ENTRY_SIZE (300)

#define OPENAPI_LOG_MAX_PERSISTENT_LOGS (3)

#define OPENAPI_LOG_PERSISTENT_FILE_INDEX_MIN (0)
#define OPENAPI_LOG_PERSISTENT_FILE_INDEX_MAX (2)

typedef struct
{
  char trapEntry[OPENAPI_TRAP_ENTRY_SIZE];
} openapiTrapLogEntry_t;

#define OPENAPI_TRAP_LOG_BUF_SIZE (256 * sizeof(openapiTrapLogEntry_t))


/*****************************************************************/
open_error_t openapiCliCmdLoggingModeSet(openapiClientHandle_t *client_handle,
                                         OPEN_CONTROL_t cmdLoggingMode);

/*****************************************************************/
open_error_t openapiCliCmdLoggingModeGet(openapiClientHandle_t *client_handle,
                                         OPEN_CONTROL_t *cmdLoggingMode);

/*****************************************************************/
open_error_t openapiConsoleLoggingModeSet(openapiClientHandle_t *client_handle,
                                          OPEN_CONTROL_t loggingConsoleMode);

/*****************************************************************/
open_error_t openapiConsoleLoggingModeGet(openapiClientHandle_t *client_handle,
                                          OPEN_CONTROL_t *loggingConsoleMode);

/*****************************************************************/
open_error_t openapiConsoleLoggingSeveritySet(openapiClientHandle_t *client_handle,
                                              OPEN_LOG_SEVERITY_t severityLevel);

/*****************************************************************/
open_error_t openapiConsoleLoggingSeverityGet(openapiClientHandle_t *client_handle,
                                              OPEN_LOG_SEVERITY_t *severityLevel);

/*****************************************************************/
open_error_t openapiPersistentLoggingModeSet(openapiClientHandle_t *client_handle,
                                             OPEN_CONTROL_t persistentLoggingMode);

/*****************************************************************/
open_error_t openapiPersistentLoggingSeverityLevelSet(openapiClientHandle_t *client_handle,
                                                      OPEN_LOG_SEVERITY_t severityLevel);

/*****************************************************************/
open_error_t openapiPersistentLoggingModeGet(openapiClientHandle_t *client_handle,
                                             OPEN_CONTROL_t *loggingPersistentMode);

/*****************************************************************/
open_error_t openapiPersistentLoggingSeverityLevelGet(openapiClientHandle_t *client_handle,
                                                      OPEN_LOG_SEVERITY_t *severityLevel);

/*****************************************************************/
open_error_t openapiPersistentLoggingNumberOfCurrentMessagesGet(openapiClientHandle_t *client_handle,
                                                                uint32_t *persistentLoggingNumMessages);

/*****************************************************************/
open_error_t openapiPersistentLoggingNumberOfPreviousMessagesGet(openapiClientHandle_t *client_handle,
                                                                 uint32_t fileIndex,
                                                                 uint32_t *persistentLoggingNumMessages);

/*****************************************************************/
open_error_t openapiPersistentLoggingEntryNextGet(openapiClientHandle_t *client_handle, uint32_t fileIndex, 
                                                  uint32_t *logIndex, uint32_t *bufIndex, open_buffdesc *logEntry);

/*****************************************************************/
open_error_t openapiTrapLogNumberOfTrapsSinceLastResetGet(openapiClientHandle_t *client_handle,
                                                          uint32_t *numTrapsSinceLastReset);

/*****************************************************************/
open_error_t openapiTrapLogNumberOfTrapsSinceLastViewedGet(openapiClientHandle_t *client_handle,
                                                           uint32_t *numTrapsSinceLastViewed);

/*****************************************************************/
open_error_t openapiTrapLogCapacityGet(openapiClientHandle_t *client_handle,
                                       uint32_t *trapsLogsCapacity);

/*****************************************************************/
open_error_t openapiSysLogModeSet(openapiClientHandle_t *client_handle,
                                  OPEN_CONTROL_t sysLogMode);

/*****************************************************************/
open_error_t openapiSysLogModeGet(openapiClientHandle_t *client_handle,
                                  OPEN_CONTROL_t *sysLogMode);

/*****************************************************************/
open_error_t openapiSysLogPortSet(openapiClientHandle_t *client_handle,
                                  uint32_t port);

/*****************************************************************/
open_error_t openapiSysLogPortGet(openapiClientHandle_t *client_handle,
                                  uint16_t *port);

/*****************************************************************/
open_error_t openapiLoggingHostAdd(openapiClientHandle_t *client_handle,
                                   open_buffdesc *loggingHost);

/*****************************************************************/
open_error_t openapiLoggingHostPortSet(openapiClientHandle_t *client_handle,
                                       open_buffdesc *loggingHost, uint32_t port);

/*****************************************************************/
open_error_t openapiLoggingHostSeveritySet(openapiClientHandle_t *client_handle,
                                           open_buffdesc *loggingHost, 
                                           OPEN_LOG_SEVERITY_t severityLevel);

/*****************************************************************/
open_error_t openapiLoggingHostIpAddrNextGet(openapiClientHandle_t *client_handle,
                                             open_buffdesc *loggingHost);

/*****************************************************************/
open_error_t openapiLoggingHostSeverityGet(openapiClientHandle_t *client_handle,
                                           open_buffdesc *loggingHost, 
                                           OPEN_LOG_SEVERITY_t *severityLevel);

/*****************************************************************/
open_error_t openapiLoggingHostPortGet(openapiClientHandle_t *client_handle,
                                       open_buffdesc *loggingHost, 
                                       uint16_t *port);

/*****************************************************************/
open_error_t openapiLoggingHostRemove(openapiClientHandle_t *client_handle, 
                                      open_buffdesc *loggingHost);

/*****************************************************************/
open_error_t openapiMaxLoggingHostsSupportedGet(openapiClientHandle_t *client_handle,
                                                uint32_t *maxLoggingHosts);

/*****************************************************************/
open_error_t openapiLoggingHostMaxAddrLenGet(openapiClientHandle_t *client_handle,
                                             uint32_t *logHostMaxAddrLen);

/*****************************************************************/
open_error_t openapiSysLogWrite(openapiClientHandle_t *client_handle,
                                open_buffdesc         *logMessage,
                                OPEN_LOG_SEVERITY_t    severityLevel);

/*****************************************************************/
open_error_t openapiBufferedLogEntryNextGet(openapiClientHandle_t *client_handle, uint32_t *logIndex,
                                            open_buffdesc *logEntry);

/*****************************************************************/
open_error_t openapiBufferedLogClear(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiBufferedLogModeSet(openapiClientHandle_t *client_handle,
                                       OPEN_CONTROL_t bufferedLoggingMode);

/*****************************************************************/
open_error_t openapiBufferedLogModeGet(openapiClientHandle_t *client_handle,
                                       OPEN_CONTROL_t *bufferedLoggingMode);

/*****************************************************************/
open_error_t openapiBufferedLogBehaviorSet(openapiClientHandle_t *client_handle,
                                           OPEN_MEMORY_BEHAVIOR_t bufferedLoggingBehavior);

/*****************************************************************/
open_error_t openapiBufferedLogBehaviorGet(openapiClientHandle_t *client_handle,
                                           OPEN_MEMORY_BEHAVIOR_t *bufferedLoggingBehavior);

/*****************************************************************/
open_error_t openapiBufferedLogSeverityFilterSet(openapiClientHandle_t *client_handle,
                                                 OPEN_LOG_SEVERITY_t bufferedLoggingSeverityFilter);

/*****************************************************************/
open_error_t openapiBufferedLogSeverityFilterGet(openapiClientHandle_t *client_handle,
                                                 OPEN_LOG_SEVERITY_t *bufferedLoggingSeverityFilter);

/*****************************************************************/
open_error_t openapiBufferedLogNumberOfMessagesGet(openapiClientHandle_t *client_handle,
                                                   uint32_t *bufferedLoggingNumMessages);

/*****************************************************************/
open_error_t openapiTrapLogGet(openapiClientHandle_t *client_handle, open_buffdesc *trapLogData,
                               uint32_t *numberOfEntries);

/*****************************************************************/
open_error_t openapiTrapLogClear(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiUsbLoggingModeSet(openapiClientHandle_t *client_handle,
                                      OPEN_USB_LOGGING_MODE_t mode);

/*****************************************************************/
open_error_t openapiUsbLoggingModeGet(openapiClientHandle_t *client_handle,
                                      OPEN_USB_LOGGING_MODE_t *mode);

/*****************************************************************/
open_error_t openapiUsbLoggingSeveritySet(openapiClientHandle_t *client_handle,
                                         OPEN_LOG_SEVERITY_t severity);

/*****************************************************************/
open_error_t openapiUsbLoggingSeverityGet(openapiClientHandle_t *client_handle,
                                          OPEN_LOG_SEVERITY_t *severity);

/*****************************************************************/
open_error_t openapiUsbLoggingOperStatusGet(openapiClientHandle_t *client_handle,
                                            OPEN_USB_LOGGING_OPER_STATUS_t *mode);

/*************************************************************************/
open_error_t openapiLogSuppressDupLogRepeatIntvlGet(openapiClientHandle_t *client_handle, uint32_t *interval);

/*************************************************************************/
open_error_t openapiLogSuppressDupLogRepeatIntvlSet(openapiClientHandle_t *client_handle, uint32_t interval);

/*************************************************************************/
open_error_t openapiLogSuppressDupLogModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiLogSuppressDupLogModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiLogUsbDeviceNumberSet(openapiClientHandle_t *client_handle, uint32_t devNumber);

/*****************************************************************/
open_error_t openapiLogUsbDeviceNumberGet(openapiClientHandle_t *client_handle, uint32_t *devNumber);

/*************************************************************************/
open_error_t
openapiLogPersistentSeverityLevelSet(openapiClientHandle_t *client_handle,
                                     OPEN_LOG_SEVERITY_t lvl0Sev,
                                     OPEN_LOG_SEVERITY_t lvl1Sev,
                                     OPEN_LOG_SEVERITY_t lvl2Sev);

/*************************************************************************/
open_error_t
openapiLogPersistentSeverityLevelGet(openapiClientHandle_t *client_handle,
                                     OPEN_LOG_SEVERITY_t *pLvl0Sev,
                                     OPEN_LOG_SEVERITY_t *pLvl1Sev,
                                     OPEN_LOG_SEVERITY_t *pLvl2Sev);

/*****************************************************************/
open_error_t
openapiPersistentLoggingLogLvlPersistentFileMsgCountGet(openapiClientHandle_t *client_handle,
                                                        uint32_t fileIndex,
                                                        uint32_t logLvl,
                                                        uint32_t *pPersistentLoggingNumMessages);

/*****************************************************************/
open_error_t
openapiPersistentLoggingLogLvlEntryNextGet(openapiClientHandle_t *client_handle,
                                           uint32_t fileIndex,
                                           uint32_t logLvl,
                                           uint32_t index,
                                           uint32_t *pBufIndex,
                                           open_buffdesc *pLogEntry);
#endif