DLT Common API Wrapper.

Signed-off-by: Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>

2 files changed, 242 insertions, 1 deletions

diff --git a/include/dlt/CMakeLists.txt b/include/dlt/CMakeLists.txt
index 95e764d..76121dd 100644
--- a/include/dlt/CMakeLists.txt
+++ b/include/dlt/CMakeLists.txt
@@ -14,6 +14,6 @@
 # @licence end@
 ########
 
-install(FILES dlt.h dlt_user.h dlt_user_macros.h dlt_client.h dlt_protocol.h dlt_common.h dlt_types.h dlt_version.h dlt_shm.h dlt_offline_trace.h dlt_filetransfer.h
+install(FILES dlt.h dlt_user.h dlt_user_macros.h dlt_client.h dlt_protocol.h dlt_common.h dlt_types.h dlt_version.h dlt_shm.h dlt_offline_trace.h dlt_filetransfer.h dlt_common_api.h
         DESTINATION include/dlt
 	COMPONENT devel)
diff --git a/include/dlt/dlt_common_api.h b/include/dlt/dlt_common_api.h
new file mode 100644
index 0000000..83acac5
--- /dev/null
+++ b/include/dlt/dlt_common_api.h
@@ -0,0 +1,241 @@
+/**

+ * @licence app begin@

+ * Copyright (C) 2014  BMW AG

+ *

+ * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.

+ *

+ * Contributions are licensed to the GENIVI Alliance under one or more

+ * Contribution License Agreements.

+ *

+ * \copyright

+ * This Source Code Form is subject to the terms of the

+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with

+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.

+ *

+ *

+ * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012

+ *

+ * \file dlt_common_api.h

+ * For further information see http://www.genivi.org/.

+ * @licence end@

+ */

+

+/*******************************************************************************

+**                                                                            **

+**  SRC-MODULE: dlt_commpn_api.h                                              **

+**                                                                            **

+**  TARGET    : linux                                                         **
+**                                                                            **
+**  PROJECT   : DLT                                                           **
+**                                                                            **
+**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
+**                                                                            **
+**  PURPOSE   :                                                               **
+**                                                                            **
+**  REMARKS   :                                                               **
+**                                                                            **
+**  PLATFORM DEPENDANT [yes/no]: yes                                          **
+**                                                                            **
+**  TO BE CHANGED BY USER [yes/no]: no                                        **
+**                                                                            **
+*******************************************************************************/
+
+/*******************************************************************************
+**                      Author Identity                                       **
+********************************************************************************
+**                                                                            **
+** Initials     Name                       Company                            **
+** --------     -------------------------  ---------------------------------- **
+**  aw          Alexander Wenzel           BMW                                **
+*******************************************************************************/

+

+#ifndef DLT_COMMON_API_H

+#define DLT_COMMON_API_H

+
+#include "dlt.h"

+

+/**

+ * Create an object for a new context.

+ * Common API with DLT Embedded

+ * This macro has to be called first for every.

+ * @param CONTEXT object containing information about one special logging context

+ */

+/* #define DLT_DECLARE_CONTEXT(CONTEXT) */

+/* UNCHANGED */

+

+/**

+ * Use an object of a new context created in another module.

+ * Common API with DLT Embedded

+ * This macro has to be called first for every.

+ * @param CONTEXT object containing information about one special logging context

+ */

+/* #define DLT_IMPORT_CONTEXT(CONTEXT) */

+/* UNCHANGED */

+

+/**

+ * Register application.

+ * Common API with DLT Embedded

+ * @param APPID application id with maximal four characters

+ * @param DESCRIPTION ASCII string containing description

+ */

+/* #define DLT_REGISTER_APP(APPID,DESCRIPTION) */

+/* UNCHANGED */

+

+/**

+ * Register context including application (with default log level and default trace status)

+ * Common API with DLT Embedded

+ * @param CONTEXT object containing information about one special logging context

+ * @param CONTEXTID context id with maximal four characters

+ * @param APPID context id with maximal four characters

+ * @param DESCRIPTION ASCII string containing description

+ */

+#define DLT_REGISTER_CONTEXT_APP(CONTEXT,CONTEXTID,APPID,DESCRIPTION) \

+	DLT_REGISTER_CONTEXT(CONTEXT,CONTEXTID,DESCRIPTION)

+

+/**

+ * Send log message with variable list of messages (intended for verbose mode)

+ * Common API with DLT Embedded

+ * @param CONTEXT object containing information about one special logging context

+ * @param LOGLEVEL the log level of the log message

+ * @param ARGS variable list of arguments

+ */

+/*****************************************/

+#define DLT_LOG0(CONTEXT,LOGLEVEL) \

+	DLT_LOG(CONTEXT, LOGLEVEL )

+/*****************************************/

+#define DLT_LOG1(CONTEXT,LOGLEVEL, ARGS1) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1)

+/*****************************************/

+#define DLT_LOG2(CONTEXT,LOGLEVEL, ARGS1, ARGS2) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2)

+/*****************************************/

+#define DLT_LOG3(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3)

+/*****************************************/

+#define DLT_LOG4(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4)

+/*****************************************/

+#define DLT_LOG5(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5)

+/*****************************************/

+#define DLT_LOG6(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6)

+/*****************************************/

+#define DLT_LOG7(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7)

+/*****************************************/

+#define DLT_LOG8(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8)

+/*****************************************/

+#define DLT_LOG9(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9)

+/*****************************************/

+#define DLT_LOG10(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10)

+/*****************************************/

+#define DLT_LOG11(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11)

+/*****************************************/

+#define DLT_LOG12(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12)

+/*****************************************/

+#define DLT_LOG13(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13)

+/*****************************************/

+#define DLT_LOG14(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14)

+/*****************************************/

+#define DLT_LOG15(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15)

+/*****************************************/

+#define DLT_LOG16(CONTEXT,LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15, ARGS16) \

+	DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15, ARGS16)

+

+/**

+ * Send log message with variable list of messages (intended for non-verbose mode)

+ * Common API with DLT Embedded

+ * @param CONTEXT object containing information about one special logging context

+ * @param LOGLEVEL the log level of the log message

+ * @param MSGID the message id of log message

+ * @param ARGS variable list of arguments:

+ calls to DLT_STRING(), DLT_BOOL(), DLT_FLOAT32(), DLT_FLOAT64(),

+ DLT_INT(), DLT_UINT(), DLT_RAW()

+ */

+/*****************************************/

+#define DLT_LOG_ID0(CONTEXT,LOGLEVEL,MSGID) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID )

+/*****************************************/

+#define DLT_LOG_ID1(CONTEXT,LOGLEVEL,MSGID, ARGS1) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1)

+/*****************************************/

+#define DLT_LOG_ID2(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2)

+/*****************************************/

+#define DLT_LOG_ID3(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3)

+/*****************************************/

+#define DLT_LOG_ID4(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4)

+/*****************************************/

+#define DLT_LOG_ID5(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5)

+/*****************************************/

+#define DLT_LOG_ID6(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6)

+/*****************************************/

+#define DLT_LOG_ID7(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7)

+/*****************************************/

+#define DLT_LOG_ID8(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8)

+/*****************************************/

+#define DLT_LOG_ID9(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9)

+/*****************************************/

+#define DLT_LOG_ID10(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10)

+/*****************************************/

+#define DLT_LOG_ID11(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11)

+/*****************************************/

+#define DLT_LOG_ID12(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12)

+/*****************************************/

+#define DLT_LOG_ID13(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13)

+/*****************************************/

+#define DLT_LOG_ID14(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14)

+/*****************************************/

+#define DLT_LOG_ID15(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15)

+/*****************************************/

+#define DLT_LOG_ID16(CONTEXT,LOGLEVEL,MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15, ARGS16) \

+	DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12, ARGS13, ARGS14, ARGS15, ARGS16)

+

+/**

+ * Unregister context.

+ * Common API with DLT Embedded

+ * @param CONTEXT object containing information about one special logging context

+ */

+/* #define DLT_UNREGISTER_CONTEXT(CONTEXT) */

+/* UNCHANGED */

+

+/**

+ * Unregister application.

+ * Common API with DLT Embedded

+ */

+/* #define DLT_UNREGISTER_APP() */

+/* UNCHANGED */

+

+/**

+ * Add string parameter to the log messsage.

+ * Common API with DLT Embedded

+ * In the future in none verbose mode the string will not be sent via DLT message.

+ * @param TEXT ASCII string

+ */

+#define DLT_CSTRING(TEXT) \

+        DLT_STRING(TEXT)

+

+#endif /* DLT_COMMON_API_H */

+