nsframework/log_library/client/include/native_service/loglibrarylog_if.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 /**
  17  * @file
  18  * @brief \~english This file contains defines and LOGLIBRARYLOG_Freeze API for free frameworkunifiedlog.
  19  *
  20  */
  21 /** @addtogroup BaseSystem
  22  *  @{
  23  */
  24 /** @addtogroup native_service
  25  *  @ingroup BaseSystem
  26  *  @{
  27  */
  28 /** @addtogroup log_library
  29  *  @ingroup native_service
  30  *  @{
  31  */
  32
  33 #ifndef __LOGLIBRARYLOG_IF_H__  // NOLINT  (readability/nolint)
  34 #define __LOGLIBRARYLOG_IF_H__
  35
  36 #define FRAMEWORKUNIFIEDLOG_SHARED_MEM_NAME "loglibrarylogconfig.cfg"
  37 #define FRAMEWORKUNIFIEDLOG_RAMDISC_NAME "/ramd/BS/ss/logger_service/rwdata/frameworkunifiedlog/frameworkunified_debug.log"
  38 #define FRAMEWORKUNIFIEDLOG_RAMDISC_PATH "/ramd/BS/ss/logger_service/rwdata/frameworkunifiedlog"
  39
  40 // Out put mode
  41 #define FRAMEWORKUNIFIEDLOG_FLAG_MODE_DEBUG    1  // Debug
  42 #define FRAMEWORKUNIFIEDLOG_FLAG_MODE_RELEASE  0  // :Release
  43
  44 // RealtimeLog mode
  45 #define LOGLIBRARYLOG_REALTIMELOG_DISABLE_MASK     0x80
  46 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_FREEZE      0xFF  // : FREEZE
  47
  48 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_OFF         0  // :ALL OFF
  49 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_UART        1  // :UARTOUT
  50 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_USB         2  // :USB OUT
  51 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_USB_DISABLE \
  52     (FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_USB | LOGLIBRARYLOG_REALTIMELOG_DISABLE_MASK)
  53 #define FRAMEWORKUNIFIEDLOG_REALTIMELOG_MODE_MAX         3  // :MAX NUM
  54
  55 //////////////////////////////////////////////////////////////////////////////////////
  56 /// \ingroup LOGLIBRARYLOG_Freeze
  57 /// \~english @par Brief
  58 ///       Freeze Loglibrarylog API.
  59 /// \~english @retval 0: success
  60 /// \~english @retval -1: error
  61 /// \~english @par Prerequisite
  62 ///       - none
  63 /// \~english @par Conditions of processing failure
  64 ///       - none
  65 /// \~english @par Classification
  66 ///       Public
  67 /// \~english @par Type
  68 ///       Sync Only
  69 /// \~english @par Detail
  70 ///       This API is provide to freeze Loglibrarylog.
  71 /// \~english @see none
  72 ////////////////////////////////////////////////////////////////////////////////
  73 int LOGLIBRARYLOG_Freeze(void);
  74
  75 #endif  // __LOGLIBRARYLOG_IF_H__  // NOLINT  (readability/nolint)
  76 /** @}*/
  77 /** @}*/
  78 /** @}*/
  79 /** @}*/