CANPlugin.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef DW_SENSORS_CAN_PLUGIN_H
#define DW_SENSORS_CAN_PLUGIN_H
 
#include <dw/sensors/legacy/plugins/SensorCommonPlugin.h>
#include <dw/sensors/canbus/CAN.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//readRawData should return always a dwCANMessage
 
typedef dwStatus (*dwSensorCANPlugin_clearFilter)(dwSensorPluginSensorHandle_t sensor);
 
typedef dwStatus (*dwSensorCANPlugin_setFilter)(const uint32_t* canIDs, const uint32_t* masks, uint16_t numCanIDs, dwSensorPluginSensorHandle_t sensor);
 
typedef dwStatus (*dwSensorCANPlugin_setUseHwTimestamps)(bool use, dwSensorPluginSensorHandle_t sensor);
 
typedef dwStatus (*dwSensorCANPlugin_send)(const dwCANMessage* msg, dwTime_t timeout_us, dwSensorPluginSensorHandle_t sensor);
 
typedef dwStatus (*dwSensorCANPlugin_parseDataBuffer)(dwCANMessage* output,
                                                      dwSensorPluginSensorHandle_t sensor);
 
typedef struct
{
    dwSensorCommonPluginFunctions common;
    dwSensorCANPlugin_clearFilter clearFilter;
    dwSensorCANPlugin_setFilter setFilter;
    dwSensorCANPlugin_setUseHwTimestamps setUseHwTimestamps;
    dwSensorCANPlugin_send send;
    dwSensorCANPlugin_parseDataBuffer parseDataBuffer;
} dwSensorCANPluginFunctionTable;
 
dwStatus dwSensorCANPlugin_getFunctionTable(dwSensorCANPluginFunctionTable* functions);
 
#ifdef __cplusplus
}
#endif
 
#endif