Source code for elos/libelosdlt/types.h

// SPDX-License-Identifier: MIT
#pragma once

#include <stdint.h>
#include <sys/cdefs.h>
#include <time.h>


#define DLT_ID_SIZE 4





[docs][docs]/*******************************************************************
 * The header fragment of an DLT message.
 *
 * Note: This assumes to always use the extended header
 *
 * Members:
 *     headerTyp: Bit field to define the anatomy of the header
 *     messageCount: sequence number of messages
 *     length: overall length of a message starting and including this header
 *     ecuId: used as ECU id in DLT log
 *     sessionId: the process id of the process sending this messages
 *     monotonicTimestamp: time in nano sec since system start
 *     messageInfo: Bit field to define kind of a message (Request/Response,
 *                  message type, verbose)
 *     argCount: Number of arguments attached to this message
 *     appId: used as application id in DLT log
 *     contextId: used as context id in DLT log
 ******************************************************************/
typedef struct elosDltMessage {

[docs][docs]    struct {

[docs][docs]        uint8_t useExtendedHeader : 1;


[docs][docs]        uint8_t msbFirst : 1;


[docs][docs]        uint8_t withEcuId : 1;


[docs][docs]        uint8_t withSessionID : 1;


[docs][docs]        uint8_t withTimestamp : 1;


[docs][docs]        uint8_t protocolVersion1 : 1;


[docs][docs]        uint8_t reserved : 2;

    } headerTyp;


[docs][docs]    uint8_t messageCount;


[docs][docs]    uint16_t length;


[docs][docs]    char ecuId[DLT_ID_SIZE];


[docs][docs]    uint32_t sessionId;


[docs][docs]    uint32_t monotonicTimestamp;


[docs][docs]    uint8_t messageInfo;


[docs][docs]    uint8_t argCount;


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    char contextId[DLT_ID_SIZE];


} __attribute__((aligned(1), packed)) elosDltMessage_t;



[docs][docs]/*******************************************************************
 * Types of DLT user messages currently supported.
 *
 ******************************************************************/
typedef enum elosDltUserMessageTypeE {

    ELOS_USER_MESSAGE_TYPE_UNDEFINED = 0,


    ELOS_USER_MESSAGE_TYPE_LOG = 1,


    ELOS_USER_MESSAGE_TYPE_REGISTER_APPLICATION = 2,


    ELOS_USER_MESSAGE_TYPE_UNREGISTER_APPLICATION = 3,


    ELOS_USER_MESSAGE_TYPE_REGISTER_CONTEXT = 4,


    ELOS_USER_MESSAGE_TYPE_UNREGISTER_CONTEXT = 5,

} elosDltUserMessageTypeE_t;



[docs][docs]/*******************************************************************
 * The protocol fragment introducing a DLT control message.
 *
 * Note: only supported for connection types TCP and UNIX socket?
 *
 * Members:
 *     serviceID: define the remote service to call
 ******************************************************************/
typedef struct elosDltControlMessage {

[docs][docs]    uint32_t serviceID;


[docs][docs]    uint32_t length;


} __attribute__((aligned(1), packed)) elosDltControlMessage_t;



[docs][docs]/*******************************************************************
 * The protocol fragment introducing a DLT user message.
 *
 * Note: only supported for connection type pipe?
 *
 * Members:
 *     magicNumber: magic identifier to determine message start, shall be
 *                 `['D', 'U', 'H', 0x01]`
 *     type: the message type which follows.
 ******************************************************************/
typedef struct elosDltUserMessage {

[docs][docs]    char magicNumber[DLT_ID_SIZE];


[docs][docs]    elosDltUserMessageTypeE_t type;


} __attribute__((aligned(1), packed)) elosDltUserMessage_t;



[docs][docs]/*******************************************************************
 * A DLT protocol fragment to define an serialized value to be logged
 *
 * Members:
 *     typeInfo: define the type of value
 *     argSize: define the size of the value in bytes
 *     nameSize: the size of the name string for this value
 *     name: the value name or key.
 ******************************************************************/
typedef struct elosDltLogArgument {

[docs][docs]    uint32_t typeInfo;


[docs][docs]    uint16_t argSize;


[docs][docs]    uint16_t nameSize;


[docs][docs]    char name[20];


} __attribute__((aligned(1), packed)) elosDltLogArgument_t;



[docs][docs]/*******************************************************************
 * A DLT message to register a new application context.
 *
 * Members:
 *     header: The user message header
 *     appId: used as new application id to be register
 *     pid: the process id of the process sending this messages
 *     length: the length of the application description.
 ******************************************************************/
typedef struct elosDltgRegisterApplication_t {

[docs][docs]    elosDltUserMessage_t header;


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    int32_t pid;


[docs][docs]    uint32_t length;


} __attribute__((aligned(1), packed)) elosDltRegisterApplication_t;



[docs][docs]/*******************************************************************
 * A DLT message to unregister an existing application context.
 *
 * Members:
 *     header: The user message header
 *     appId: used as application id to be unregistered
 *     pid: the process id of the process sending this messages
 ******************************************************************/
typedef struct elosDltgUnregisterApplication_t {

[docs][docs]    elosDltUserMessage_t header;


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    int32_t pid;


} __attribute__((aligned(1), packed)) elosDltUnregisterApplication_t;



[docs][docs]/*******************************************************************
 * A DLT message to register a context for an existing application context.
 *
 * Members:
 *     header: The user message header
 *     appId: used as application id to register a new context for
 *     contextId: used as new context id to be registered
 *     logLevelPosition: purpose currently unknown and unused for now
 *     logLevel: initial log level for this context
 *     traceStatus: set to 0; purpose currently unknown and unused
 *     pid: the process id of the process sending this messages
 *     length: the length of the context description.
 ******************************************************************/
typedef struct elosDltgRegisterContext {

[docs][docs]    elosDltUserMessage_t header;


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    char contextId[DLT_ID_SIZE];


[docs][docs]    int32_t logLevelPosition;


[docs][docs]    int8_t logLevel;


[docs][docs]    int8_t traceStatus;


[docs][docs]    int32_t pid;


[docs][docs]    uint32_t length;


} __attribute__((aligned(1), packed)) elosDltRegisterContext_t;



[docs][docs]/*******************************************************************
 * A DLT message to unregister a context for an existing application context.
 *
 * Members:
 *     header: The user message header
 *     appId: used as application id to unregister a new context for
 *     contextId: used as new context id to be unregistered
 *     pid: the process id of the process sending this messages
 ******************************************************************/
typedef struct elosDltgUnregisterContext {

[docs][docs]    elosDltUserMessage_t header;


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    char contextId[DLT_ID_SIZE];


[docs][docs]    int32_t pid;


} __attribute__((aligned(1), packed)) elosDltUnregisterContext_t;



[docs][docs]/*******************************************************************
 * Parameter struct used to configure a new DLT connection.
 *
 * Members:
 *     socketPath: path to unix domain socket of DLT-Daemon
 *     host: IP address or name of DLT-Daemon
 *     pipePath: path to pipe of DLT-Daemon
 *     port: port the DLT-Daemon to connect to
 *     socketFd: file descriptor of active connection or -1 if not connected
 *     messageCount: count of messages transmitted by this connection
 *     ecuId: used as ECU id in DLT log
 *     appId: used as application id in DLT log
 *     contextId: used as context id in DLT log
 ******************************************************************/
typedef struct elosDltConnection {

[docs][docs]    char *socketPath;


[docs][docs]    char *host;


[docs][docs]    char *pipePath;


[docs][docs]    int port;


[docs][docs]    int socketFd;


[docs][docs]    size_t messageCount;


[docs][docs]    char ecuId[DLT_ID_SIZE];


[docs][docs]    char appId[DLT_ID_SIZE];


[docs][docs]    char contextId[DLT_ID_SIZE];

} elosDltConnection_t;



[docs][docs]/*******************************************************************
 * Parameter struct used to configure a new DLT connection.
 *
 * Members:
 *     ecuId: used as ECU id in DLT log
 *     appId: used as application id in DLT log
 *     contextId: used as context id in DLT log
 ******************************************************************/
typedef struct elosDltConnectionParam {

[docs][docs]    const char *ecuId;


[docs][docs]    const char *contextId;


[docs][docs]    const char *appId;

} elosDltConnectionParam_t;