dlt_client.h

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), 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/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_client.h                                                  **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
**              Markus Klein                                                  **
**                                                                            **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  aw          Alexander Wenzel           BMW                                **
**  mk          Markus Klein               Fraunhofer ESK                     **
*******************************************************************************/

/*******************************************************************************
**                      Revision Control History                              **
*******************************************************************************/

/*
 * $LastChangedRevision$
 * $LastChangedDate$
 * $LastChangedBy$
 */

#ifndef DLT_CLIENT_H
#define DLT_CLIENT_H

#include "dlt_types.h"
#include "dlt_common.h"

typedef enum
{
    DLT_CLIENT_MODE_UNDEFINED = -1,
    DLT_CLIENT_MODE_TCP,
    DLT_CLIENT_MODE_SERIAL,
    DLT_CLIENT_MODE_UNIX
} DltClientMode;

typedef struct
{
    DltReceiver receiver;  
    int sock;              
    char *servIP;          
    int port;              
    char *serialDevice;    
    char *socketPath;      
    char ecuid[4];           
    speed_t baudrate;      
    DltClientMode mode;    
} DltClient;

#ifdef __cplusplus
extern "C" {
#endif

void dlt_client_register_message_callback(int (*registerd_callback) (DltMessage *message, void *data));

int dlt_client_init_port(DltClient *client, int port, int verbose);

DltReturnValue dlt_client_init(DltClient *client, int verbose);
DltReturnValue dlt_client_connect(DltClient *client, int verbose);
DltReturnValue dlt_client_cleanup(DltClient *client, int verbose);
DltReturnValue dlt_client_main_loop(DltClient *client, void *data, int verbose);
DltReturnValue dlt_client_send_ctrl_msg(DltClient *client, char *apid, char *ctid, uint8_t *payload, uint32_t size);
DltReturnValue dlt_client_send_inject_msg(DltClient *client, char *apid, char *ctid, uint32_t serviceID, uint8_t *buffer, uint32_t size);
DltReturnValue dlt_client_send_log_level(DltClient *client, char *apid, char *ctid, uint8_t logLevel);
int dlt_client_get_log_info(DltClient *client);
void dlt_getloginfo_init( void );
void dlt_getloginfo_free( void );
DltReturnValue dlt_client_send_trace_status(DltClient *client, char *apid, char *ctid, uint8_t traceStatus);
DltReturnValue dlt_client_send_default_log_level(DltClient *client, uint8_t defaultLogLevel);
int dlt_client_send_all_log_level(DltClient *client, uint8_t LogLevel);
DltReturnValue dlt_client_send_default_trace_status(DltClient *client, uint8_t defaultTraceStatus);
DltReturnValue dlt_client_send_timing_pakets(DltClient *client, uint8_t timingPakets);
DltReturnValue dlt_client_send_store_config(DltClient *client);
DltReturnValue dlt_client_send_reset_to_factory_default(DltClient *client);

DltReturnValue dlt_client_setbaudrate(DltClient *client, int baudrate);

int dlt_client_set_server_ip(DltClient *client, char *ipaddr);

int dlt_client_set_serial_device(DltClient *client, char *serial_device);

int dlt_client_set_socket_path(DltClient *client, char *socket_path);

#ifdef __cplusplus
}
#endif

#endif /* DLT_CLIENT_H */