Interpreter.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_SENSORS_CANBUS_INTERPRETER_H_
#define DW_SENSORS_CANBUS_INTERPRETER_H_

#include <dw/core/Config.h>
#include <dw/core/base/Exports.h>

#include <dw/sensors/canbus/CAN.h>
#include <dw/sensors/canbus/interpreter/VehicleData.h>

#define DW_SENSORS_CAN_INTERPRETER_MESSAGE_MAX_SIGNALS 128

#define DW_SENSORS_CAN_INTERPRETER_MAX_MESSAGE_NAME_LEN 32

#define DW_SENSORS_CAN_INTERPRETER_MAX_SIGNAL_NAME_LEN 32

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwCANInterpreterObject* dwCANInterpreterHandle_t;

typedef void (*dwCANInterpreterAddMessageFunc_t)(const dwCANMessage* msg, void* userData);

typedef uint32_t (*dwCANInterpreterGetNumAvailableFunc_t)(void* userData);

typedef bool (*dwCANInterpreterGetSignalInfoFunc_t)(const char8_t** name, dwTrivialDataType* type,
                                                    dwCANVehicleData* data,
                                                    uint32_t idx, void* userData);

typedef bool (*dwCANInterpreterGetDataf32Func_t)(float32_t* value, dwTime_t* timestamp_us, uint32_t idx, void* userData);

typedef bool (*dwCANInterpreterGetDataf64Func_t)(float64_t* value, dwTime_t* timestamp_us, uint32_t idx, void* userData);

typedef bool (*dwCANInterpreterGetDatai32Func_t)(int32_t* value, dwTime_t* timestamp_us, uint32_t idx, void* userData);

typedef struct dwCANInterpreterInterface
{
    dwCANInterpreterAddMessageFunc_t addMessage;
    dwCANInterpreterGetNumAvailableFunc_t getNumAvailableSignals;
    dwCANInterpreterGetSignalInfoFunc_t getSignalInfo;
    dwCANInterpreterGetDataf32Func_t getDataf32;
    dwCANInterpreterGetDataf64Func_t getDataf64;
    dwCANInterpreterGetDatai32Func_t getDatai32;
} dwCANInterpreterInterface;

DW_API_PUBLIC
dwStatus dwCANInterpreter_buildFromCallbacks(dwCANInterpreterHandle_t* interpreter, dwCANInterpreterInterface callbacks,
                                             void* userData, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwCANInterpreter_buildFromDBC(dwCANInterpreterHandle_t* interpreter,
                                       const char8_t* inputDBC,
                                       dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwCANInterpreter_buildFromDBCString(dwCANInterpreterHandle_t* interpreter,
                                             const char8_t* dbc,
                                             dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwCANInterpreter_release(dwCANInterpreterHandle_t interpreter);

// ------------ encoding
DW_API_PUBLIC
dwStatus dwCANInterpreter_getNumberSignalsInMessage(uint32_t* num,
                                                    const dwCANMessage* msg,
                                                    dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getSignalNameInMessage(const char8_t** name, uint32_t idx,
                                                 const dwCANMessage* msg,
                                                 dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_createMessage(dwCANMessage* msg, uint32_t id, dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_createMessageFromName(dwCANMessage* msg, const char8_t* msgName,
                                                dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_encodef32(float32_t value, const char8_t* signal,
                                    dwCANMessage* msg,
                                    dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_encodef64(float64_t value, const char8_t* signal,
                                    dwCANMessage* msg,
                                    dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_encodei32(int32_t value, const char8_t* signal,
                                    dwCANMessage* msg,
                                    dwCANInterpreterHandle_t interpreter);

// ----------------- consumption
DW_API_PUBLIC
dwStatus dwCANInterpreter_consume(const dwCANMessage* msg,
                                  dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getNumberSignals(uint32_t* num, dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getDataSignalIndex(uint32_t* idx, dwCANVehicleData data,
                                             dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getSignalName(const char8_t** name, uint32_t idx,
                                        dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getSignalType(dwTrivialDataType* type, uint32_t idx,
                                        dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getSignalRange(float64_t* minimum, float64_t* maximum, uint32_t idx,
                                         dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getf32(float32_t* value, dwTime_t* timestamp_us, uint32_t idx, dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_getf64(float64_t* value, dwTime_t* timestamp_us, uint32_t idx, dwCANInterpreterHandle_t interpreter);

DW_API_PUBLIC
dwStatus dwCANInterpreter_geti32(int32_t* value, dwTime_t* timestamp_us, uint32_t idx, dwCANInterpreterHandle_t interpreter);

#ifdef __cplusplus
}
#endif

#endif // DW_SENSORS_CANBUS_INTERPRETER_H_