SensorCommonPlugin.h

Go to the documentation of this file.

 
//
// 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 & AFFILIATES 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 & AFFILIATES. 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 & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// 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_COMMON_PLUGIN_H
#define DW_SENSORS_COMMON_PLUGIN_H
 
#include <dw/core/base/Types.h>
#include <dw/core/context/Context.h>
 
#include <dw/sensors/common/SensorTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* dwSensorPluginSensorHandle_t;
 
// Enum to indicate the relationship between raw and decoded data for a custom sensor
typedef enum {
    DW_SENSORS_RAW_DEC_ONE_TO_ONE = 0,
    DW_SENSORS_RAW_DEC_MANY_TO_ONE = 1,
    DW_SENSORS_RAW_DEC_NOT_SUPPORTED = 2
} dwSensorPlugin_rawToDecMap;
 
// Enum to define Time Domain
typedef enum {
    DW_SENSORS_PLUGIN_TIME_DOMAIN_HOST   = 0, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_TSC    = 1, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_PTP    = 2, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_UTC    = 3, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_UTCTOH = 4, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_MISC   = 5, 
    DW_SENSORS_PLUGIN_TIME_DOMAIN_COUNT  = 6  
} dwSensorPlugin_timeDomain;
 
typedef struct
{
    size_t packetSize;
    dwSensorPlugin_rawToDecMap rawToDec;
} dwSensorPluginProperties;
 
// Holds the sensor firmware version information
typedef struct
{
    // Separate the fwVersion string into three pieces.
    uint64_t versionMajor; // Firmware version major number
    uint64_t versionMinor; // Firmware version minor number
    uint64_t versionPatch; // Firmware version patch number
    char* versionString;   // Firmware version string
} dwSensorPlugin_firmwareVersion;
 
// Holds the sensor information
typedef struct
{
    dwSensorPlugin_firmwareVersion firmware;
} dwSensorPlugin_information;
 
// Enum to indicate which level the raw data to read from
typedef enum {
    DW_SENSORS_RAW_DATA_LEVEL_ZERO  = 0, // Raw data same as from readRawData, TP segment in SOME/IP use case
    DW_SENSORS_RAW_DATA_LEVEL_ONE   = 1, // Raw data combined from LEVEL_ZERO raw Data, reassembled pdu(from segments) in SOME/IP use case
    DW_SENSORS_RAW_DATA_LEVEL_TWO   = 2, // Raw data combined from LEVEL_ONE raw Data, combined pdu(from split pdus)
    DW_SENSORS_RAW_DATA_LEVEL_COUNT = 3  // Count for validating user passed level
} dwSensorPlugin_rawDataLevel;
 
typedef dwStatus (*dwSensorPlugin_createHandle)(dwSensorPluginSensorHandle_t* handle,
                                                dwSensorPluginProperties* properties,
                                                char const* params, dwContextHandle_t ctx);
 
typedef dwStatus (*dwSensorPlugin_release)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_createSensor)(char const* params, dwSALHandle_t sal, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_start)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_stop)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_reset)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_readRawData)(uint8_t const** data, size_t* size, dwTime_t* timestamp,
                                               dwTime_t timeout_us, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_returnRawData)(uint8_t const* data, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_pushData)(size_t* lenPushed, uint8_t const* data, size_t const size, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_getSensorInformation)(dwSensorPlugin_information* information, dwSensorPluginSensorHandle_t sensor);
 
DW_DEPRECATED("dwSensorPlugin_getRawPackets is deprecated and will be removed in next major release. Please use dwSensorPlugin_getRawPackets instead")
typedef dwStatus (*dwSensorPlugin_getRawPackets)(uint8_t const* const rawData, size_t* const size,
                                                 dwSensorPlugin_rawDataLevel level, int32_t groupNum, uint8_t const** const data, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_getRawPacketsNew)(uint8_t const* const rawData, size_t* const size,
                                                    dwSensorPlugin_rawDataLevel level, int32_t groupNum, uint8_t const** const data, int32_t* extra1, int32_t* extra2, dwSensorPluginSensorHandle_t handle);
typedef dwStatus (*dwSensorPlugin_rawDataReadyForDecode)(size_t* offset, size_t* size, uint8_t const* const data, dwSensorPluginSensorHandle_t ctx);
 
typedef struct
{
    dwSensorPlugin_createHandle createHandle;
    dwSensorPlugin_createSensor createSensor;
    dwSensorPlugin_release release;
    dwSensorPlugin_start start;
    dwSensorPlugin_stop stop;
    dwSensorPlugin_reset reset;
    dwSensorPlugin_readRawData readRawData;
    dwSensorPlugin_returnRawData returnRawData;
    dwSensorPlugin_pushData pushData;
    dwSensorPlugin_getSensorInformation getSensorInformation;
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
    dwSensorPlugin_getRawPackets getRawPackets;
#pragma GCC diagnostic pop
    dwSensorPlugin_getRawPacketsNew getRawPacketsNew;
    dwSensorPlugin_rawDataReadyForDecode rawDataReadyForDecode;
} dwSensorCommonPluginFunctions;
 
#ifdef __cplusplus
}
#endif
 
#endif