diff options
Diffstat (limited to 'include/dlt')
| -rw-r--r-- | include/dlt/dlt_filetransfer.h | 76 | ||||
| -rw-r--r-- | include/dlt/dlt_offline_trace.h | 126 | ||||
| -rwxr-xr-x | include/dlt/dlt_version.h | 2 |
3 files changed, 203 insertions, 1 deletions
diff --git a/include/dlt/dlt_filetransfer.h b/include/dlt/dlt_filetransfer.h new file mode 100644 index 0000000..f70b6f7 --- /dev/null +++ b/include/dlt/dlt_filetransfer.h @@ -0,0 +1,76 @@ +#include <limits.h> /* Needed for LONG_MAX */ +#include <sys/stat.h> /* Needed for struct stat st*/ +#include "dlt.h" /* Needed for DLT Logs */ +#include <signal.h> /* Signal handling */ +#include "errno.h" + +//!Transfer the complete file as several dlt logs. +/**This method transfer the complete file as several dlt logs. At first it will be checked that the file exist. + * In the next step some generic informations about the file will be logged to dlt. + * Now the header will be logged to dlt. See the method dlt_user_log_file_header for more informations. + * Then the method dlt_user_log_data will be called with the parameter to log all packages in a loop with some timeout. + * At last dlt_user_log_end is called to signal that the complete file transfer was okey. This is important for the plugin of the dlt viewer. + * @param fileContext Specific context to log the file to dlt + * @param filename Absolute file path + * @param deleteFlag Flag if the file will be deleted after transfer. 1->delete, 0->notDelete + * @param timeout Timeout in ms to wait between some logs. Important that the FIFO of dlt will not be flooded with to many messages in a short period of time. + * @return Returns 0 if everything was okey. If there was a failure value < 0 will be returned. + */ +extern int dlt_user_log_file_complete(DltContext *fileContext, const char *filename, int deleteFlag, int timeout); + + +//!This method gives information about the number of packages the file have +/**Every file will be divided into several packages. Every package will be logged as a single dlt log. + * The number of packages depends on the BUFFER_SIZE. + * At first it will be checked if the file exist. Then the file will be divided into + * several packages depending on the buffer size. + * @param fileContext Specific context to log the file to dlt + * @param filename Absolute file path + * @return Returns 0 if everything was okey. If there was a failure value < 0 will be returned. + */ +extern int dlt_user_log_file_packagesCount(DltContext *fileContext, const char *filename); + + +//!Logs specific file inforamtions to dlt +/**The filename, file size, file serial number and the number of packages will be logged to dlt. + * @param fileContext Specific context + * @param filename Absolute file path + * @return Returns 0 if everything was okey.If there was a failure value < 0 will be returned. + */ + extern int dlt_user_log_file_infoAbout(DltContext *fileContext, const char *filename); + + +//!Transfer the head of the file as a dlt logs. +/**The head of the file must be logged to dlt because the head contains inforamtion about the file serial number, + * the file name, the file size, package number the file have and the buffer size. + * All these informations are needed from the plugin of the dlt viewer. + * See the Mainpages.c for more informations. + * @param fileContext Specific context to log the file to dlt + * @param filename Absolute file path + * @return Returns 0 if everything was okey. If there was a failure value < 0 will be returned. + */ +extern int dlt_user_log_file_header(DltContext *fileContext, const char *filename); + + +//!Transfer the content data of a file. +/**See the Mainpages.c for more informations. + * @param fileContext Specific context to log the file to dlt + * @param filename Absolute file path + * @param packageToTransfer Package number to transfer. If this param is LONG_MAX, the whole file will be transferred with a specific timeout + * @param timeout Timeout to wait between dlt logs. Important because the dlt FIFO should not be flooded. Default is defined by MIN_TIMEOUT. The given timeout in ms can not be smaller than MIN_TIMEOUT. + * @return Returns 0 if everything was okey. If there was a failure value < 0 will be returned. + */ +extern int dlt_user_log_file_data(DltContext *fileContext, const char *filename, int packageToTransfer, int timeout); + + + +//!Transfer the end of the file as a dlt logs. +/**The end of the file must be logged to dlt because the end contains inforamtion about the file serial number. + * This informations is needed from the plugin of the dlt viewer. + * See the Mainpages.c for more informations. + * @param fileContext Specific context to log the file to dlt + * @param filename Absolute file path + * @param deleteFlag Flag to delete the file after the whole file is transferred (logged to dlt).1->delete,0->NotDelete + * @return Returns 0 if everything was okey. If there was a failure value < 0 will be returned. + */ +extern int dlt_user_log_file_end(DltContext *fileContext, const char *filename,int deleteFlag); diff --git a/include/dlt/dlt_offline_trace.h b/include/dlt/dlt_offline_trace.h new file mode 100644 index 0000000..04c4f1a --- /dev/null +++ b/include/dlt/dlt_offline_trace.h @@ -0,0 +1,126 @@ +/* +* Dlt- Diagnostic Log and Trace user library +* @licence app begin@ + * + * Copyright (C) 2011, BMW AG - Alexander Wenzel <alexander.wenzel@bmw.de> + * + * This program is free software; you can redistribute it and/or modify it under the terms of the + * GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation. + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even + * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General + * Public License, version 2.1, for more details. + * + * You should have received a copy of the GNU Lesser General Public License, version 2.1, along + * with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>. + * + * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may + * also be applicable to programs even in cases in which the program is not a library in the technical sense. + * + * Linking DLT statically or dynamically with other modules is making a combined work based on DLT. You may + * license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to + * license your linked modules under the GNU Lesser General Public License, version 2.1, you + * may use the program under the following exception. + * + * As a special exception, the copyright holders of DLT give you permission to combine DLT + * with software programs or libraries that are released under any license unless such a combination is not + * permitted by the license of such a software program or library. You may copy and distribute such a + * system following the terms of the GNU Lesser General Public License, version 2.1, including this + * special exception, for DLT and the licenses of the other code concerned. + * + * Note that people who make modified versions of DLT are not obligated to grant this special exception + * for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, + * version 2.1, gives permission to release a modified version without this exception; this exception + * also makes it possible to release a modified version which carries forward this exception. + * + * @licence end@ +*/ + + +/******************************************************************************* +** ** +** SRC-MODULE: dlt_offline_trace.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_OFFLINE_TRACE_H +#define DLT_OFFLINE_TRACE_H + +typedef struct +{ + char directory[256]; /**< (String) Store DLT messages to local directory */ + char filename[256]; /**< (String) Filename of currently used log file */ + int fileSize; /**< (int) Maximum size in bytes of one trace file (Default: 1000000) */ + int maxSize; /**< (int) Maximum size of all trace files (Default: 4000000) */ + + int ohandle; +} DltOfflineTrace; + +/** + * Initialise the offline trace + * This function call opens the currently used log file. + * A check of the complete size of the offline trace is done during startup. + * Old files are deleted, if there is not enough space left to create new file. + * This function must be called before using further offline trace functions. + * @param trace pointer to offline trace structure + * @param directory directory where to store offline trace files + * @param fileSize maximum size of one offline trace file. + * @param maxSize maximum size of complete offline trace in bytes. + * @return negative value if there was an error + */ +extern int dlt_offline_trace_init(DltOfflineTrace *trace,const char *directory,int fileSize,int maxSize); + +/** + * Uninitialise the offline trace + * This function call closes currently used log file. + * This function must be called after usage of offline trace + * @param trace pointer to offline trace structure + * @return negative value if there was an error + */ +extern int dlt_offline_trace_free(DltOfflineTrace *buf); + +/** + * Write data into offline trace + * If the current used log file exceeds the max file size, new log file is created. + * A check of the complete size of the offline trace is done before new file is created. + * Old files are deleted, if there is not enough space left to create new file. + * @param trace pointer to offline trace structure + * @param data1 pointer to first data block to be written, null if not used + * @param size1 size in bytes of first data block to be written, 0 if not used + * @param data2 pointer to second data block to be written, null if not used + * @param size2 size in bytes of second data block to be written, 0 if not used + * @param data3 pointer to third data block to be written, null if not used + * @param size3 size in bytes of third data block to be written, 0 if not used + * @return negative value if there was an error + */ +extern int dlt_offline_trace_write(DltOfflineTrace *trace,unsigned char *data1,int size1,unsigned char *data2,int size2,unsigned char *data3,int size3); + +/** + * Get size of currently used offline trace buffer + * @return size in bytes + */ +extern unsigned long dlt_offline_trace_get_total_size(DltOfflineTrace *trace); + +#endif /* DLT_OFFLINE_TRACE_H */ diff --git a/include/dlt/dlt_version.h b/include/dlt/dlt_version.h index 30152fd..7d3b6c6 100755 --- a/include/dlt/dlt_version.h +++ b/include/dlt/dlt_version.h @@ -7,6 +7,6 @@ #define PACKAGE_MAJOR_VERSION "2" #define PACKAGE_MINOR_VERSION "3" #define PACKAGE_PATCH_LEVEL "0" -#define PACKAGE_REVISION "v2.3.0-20-g9e988e6" +#define PACKAGE_REVISION "v2.3.0-25-g966bffa" #endif |