src/lib/dlt_user_cfg.h

   1 /*\r
   2  * Dlt- Diagnostic Log and Trace daemon\r
   3  * @licence app begin@
   4  *
   5  * Copyright (C) 2011, BMW AG - Alexander Wenzel <alexander.wenzel@bmw.de>
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under the terms of the
   8  * GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  11  * Public License, version 2.1, for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License, version 2.1, along
  14  * with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
  15  *
  16  * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may
  17  * also be applicable to programs even in cases in which the program is not a library in the technical sense.
  18  *
  19  * Linking DLT statically or dynamically with other modules is making a combined work based on DLT. You may
  20  * license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to
  21  * license your linked modules under the GNU Lesser General Public License, version 2.1, you
  22  * may use the program under the following exception.
  23  *
  24  * As a special exception, the copyright holders of DLT give you permission to combine DLT
  25  * with software programs or libraries that are released under any license unless such a combination is not
  26  * permitted by the license of such a software program or library. You may copy and distribute such a
  27  * system following the terms of the GNU Lesser General Public License, version 2.1, including this
  28  * special exception, for DLT and the licenses of the other code concerned.
  29  *
  30  * Note that people who make modified versions of DLT are not obligated to grant this special exception
  31  * for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License,
  32  * version 2.1, gives permission to release a modified version without this exception; this exception
  33  * also makes it possible to release a modified version which carries forward this exception.
  34  *
  35  * @licence end@\r
  36  */\r
  37 \r
  38 \r
  39 /*******************************************************************************\r
  40 **                                                                            **\r
  41 **  SRC-MODULE: dlt_user_cfg.h                                                **\r
  42 **                                                                            **\r
  43 **  TARGET    : linux                                                         **\r
  44 **                                                                            **\r
  45 **  PROJECT   : DLT                                                           **\r
  46 **                                                                            **\r
  47 **  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **\r
  48 **              Markus Klein                                                  **\r
  49 **                                                                            **\r
  50 **  PURPOSE   :                                                               **\r
  51 **                                                                            **\r
  52 **  REMARKS   :                                                               **\r
  53 **                                                                            **\r
  54 **  PLATFORM DEPENDANT [yes/no]: yes                                          **\r
  55 **                                                                            **\r
  56 **  TO BE CHANGED BY USER [yes/no]: no                                        **\r
  57 **                                                                            **\r
  58 *******************************************************************************/\r
  59 \r
  60 /*******************************************************************************\r
  61 **                      Author Identity                                       **\r
  62 ********************************************************************************\r
  63 **                                                                            **\r
  64 ** Initials     Name                       Company                            **\r
  65 ** --------     -------------------------  ---------------------------------- **\r
  66 **  aw          Alexander Wenzel           BMW                                **\r
  67 **  mk          Markus Klein               Fraunhofer ESK                     **\r
  68 *******************************************************************************/\r
  69 \r
  70 /*******************************************************************************\r
  71 **                      Author Identity                                       **\r
  72 ********************************************************************************\r
  73 **                                                                            **\r
  74 ** Initials     Name                       Company                            **\r
  75 ** --------     -------------------------  ---------------------------------- **\r
  76 **  aw          Alexander Wenzel           BMW                                **\r
  77 **  mk          Markus Klein               Fraunhofer ESK                     **\r
  78 *******************************************************************************/\r
  79 \r
  80 #ifndef DLT_USER_CFG_H\r
  81 #define DLT_USER_CFG_H\r
  82 \r
  83 /*************/\r
  84 /* Changable */\r
  85 /*************/\r
  86 \r
  87 /* Size of receive buffer */\r
  88 #define DLT_USER_RCVBUF_MAX_SIZE 10024 \r
  89 \r
  90 /* Size of ring buffer */      \r
  91 #define DLT_USER_RINGBUFFER_MIN_SIZE  10000       \r
  92 #define DLT_USER_RINGBUFFER_MAX_SIZE  60000       \r
  93 #define DLT_USER_RINGBUFFER_STEP_SIZE 10000       \r
  94 \r
  95 /* Temporary buffer length */\r
  96 #define DLT_USER_BUFFER_LENGTH               255\r
  97 \r
  98 /* Number of context entries, which will be allocated, \r
  99    if no more context entries are available */\r
 100 #define DLT_USER_CONTEXT_ALLOC_SIZE          500\r
 101 \r
 102 /* Maximu length of a filename string */\r
 103 #define DLT_USER_MAX_FILENAME_LENGTH         255\r
 104 \r
 105 /* Maximum length of a single version number */\r
 106 #define DLT_USER_MAX_LIB_VERSION_LENGTH         3\r
 107 \r
 108 /* Length of buffer for constructing text output */\r
 109 #define DLT_USER_TEXT_LENGTH               10024\r
 110 \r
 111 /* Stack size of receiver thread */\r
 112 #define DLT_USER_RECEIVERTHREAD_STACKSIZE 100000\r
 113 \r
 114 /* default value for storage to file, not used in daemon connection */\r
 115 #define DLT_USER_DEFAULT_ECU_ID "ECU1"\r
 116 \r
 117 /* Initial log level */\r
 118 #define DLT_USER_INITIAL_LOG_LEVEL    DLT_LOG_INFO\r
 119 \r
 120 /* Initial trace status */\r
 121 #define DLT_USER_INITIAL_TRACE_STATUS DLT_TRACE_STATUS_OFF\r
 122 \r
 123 /* use extended header for non-verbose mode: 0 - don't use, 1 - use */\r
 124 #define DLT_USER_USE_EXTENDED_HEADER_FOR_NONVERBOSE 0\r
 125 \r
 126 /* default message id for non-verbose mode, if no message id was provided */\r
 127 #define DLT_USER_DEFAULT_MSGID 0xffff\r
 128 \r
 129 /* delay in receiver routine in usec (100000 usec = 100ms) */\r
 130 #define DLT_USER_RECEIVE_DELAY 100000 \r
 131 \r
 132 /* Name of environment variable for local print mode */\r
 133 #define DLT_USER_ENV_LOCAL_PRINT_MODE "DLT_LOCAL_PRINT_MODE"\r
 134 \r
 135 /* Timeout offset for resending user buffer at exit in usec (1000 usec = 1ms)*/\r
 136 #define DLT_USER_ATEXIT_RESEND_BUFFER_EXIT_TIMEOUT 100000\r
 137 \r
 138 /* Sleeps between resending user buffer at exit in usec (1000 usec = 1ms)*/\r
 139 #define DLT_USER_ATEXIT_RESEND_BUFFER_SLEEP 1000\r
 140 \r
 141 \r
 142 /************************/\r
 143 /* Don't change please! */\r
 144 /************************/\r
 145 \r
 146 /* Minimum valid ID of an injection message */\r
 147 #define DLT_USER_INJECTION_MIN      0xFFF\r
 148 \r
 149 /* Defines of the different local print modes */\r
 150 #define DLT_PM_UNSET     0\r
 151 #define DLT_PM_AUTOMATIC 1\r
 152 #define DLT_PM_FORCE_ON  2\r
 153 #define DLT_PM_FORCE_OFF 3\r
 154 \r
 155 #endif /* DLT_USER_CFG_H */\r