DriveWorks SDK Reference
5.20.37 Release
For Test and Development only

SensorTypes.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2023-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
47#ifndef DW_SENSORS_COMMON_SENSORTYPES_H_
48#define DW_SENSORS_COMMON_SENSORTYPES_H_
49
50#include <dw/core/base/Types.h>
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
57typedef enum dwPlatformOS {
60
63
66
70
72typedef struct dwSALObject* dwSALHandle_t;
73
75typedef struct dwSensorObject* dwSensorHandle_t;
76
78#define DW_SENSOR_MAX_PROTOCOL_NAME_LENGTH 32
80#define DW_SENSOR_MAX_PARAMETER_STRING_LENGTH 512
81
83typedef struct dwSensorParams
84{
88 const char8_t* protocol;
89
95 const char8_t* parameters;
96
102 const void* auxiliarydata;
103
105
107typedef enum dwSensorType {
129
132{
135
137 uint64_t event;
138
140 uint64_t offset;
141
143 uint64_t size;
144
146
148#define DW_SENSOR_ERROR_ID_OFFSET_BIT 24U
150#define DW_SENSOR_ERROR_ID_OFFSET (1U << DW_SENSOR_ERROR_ID_OFFSET_BIT)
151
156typedef enum dwSensorErrorID {
181 /* Place holder error IDs - use SEH official error IDs later */
189
190#ifdef __cplusplus
191}
192#endif
193
195#endif // DW_SENSORS_COMMON_SENSORTYPES_H_
NVIDIA DriveWorks API: Core Types
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:65
uint64_t event
count of this event
Definition: SensorTypes.h:137
uint64_t offset
offset into a file of this event
Definition: SensorTypes.h:140
const void * auxiliarydata
Additional data to pass to sensor creation function.
Definition: SensorTypes.h:102
const char8_t * parameters
Array of additional parameters provided to sensor creation.
Definition: SensorTypes.h:95
uint64_t size
size of the event present in the virtual data file, in bytes
Definition: SensorTypes.h:143
const char8_t * protocol
Name of the protocol.
Definition: SensorTypes.h:88
dwTime_t timestamp
timestamp of this entry [us]
Definition: SensorTypes.h:134
struct dwSALObject * dwSALHandle_t
Handle representing the Sensor Abstraction Layer interface.
Definition: SensorTypes.h:72
dwSensorType
Defines the type of sensors that are available in DriveWorks.
Definition: SensorTypes.h:107
dwPlatformOS
Defines the operating system in use.
Definition: SensorTypes.h:57
dwSensorErrorID
Sensor Error ID to be used in, e.g., dwErrorSignal.errorID[31:24] when DW_SENSOR_ERROR_CODE_OFFSET_BI...
Definition: SensorTypes.h:156
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: SensorTypes.h:75
@ DW_SENSOR_LIDAR
Lidar.
Definition: SensorTypes.h:111
@ DW_SENSOR_ULTRASONIC
Ultrasonic.
Definition: SensorTypes.h:125
@ DW_SENSOR_COUNT
Sensor count which the sensor type value is less than.
Definition: SensorTypes.h:127
@ DW_SENSOR_CAN
CAN.
Definition: SensorTypes.h:117
@ DW_SENSOR_IMU
IMU.
Definition: SensorTypes.h:115
@ DW_SENSOR_RADAR
RADAR.
Definition: SensorTypes.h:119
@ DW_SENSOR_CAMERA
CAMERA.
Definition: SensorTypes.h:109
@ DW_SENSOR_GPS
GPS.
Definition: SensorTypes.h:113
@ DW_SENSOR_TIME
TIME.
Definition: SensorTypes.h:121
@ DW_SENSOR_DATA
DATA.
Definition: SensorTypes.h:123
@ DW_PLATFORM_OS_V5Q
aarch64 based Drive 5 QNX.
Definition: SensorTypes.h:65
@ DW_PLATFORM_OS_V5L
aarch64 based Drive 5 Linux.
Definition: SensorTypes.h:62
@ DW_PLATFORM_OS_LINUX
Default Linux based platform.
Definition: SensorTypes.h:59
@ DW_PLATFORM_NUM
Number of available platforms.
Definition: SensorTypes.h:68
@ DW_SENSOR_ERROR_CODE_NO_NEW_DATA
no new data received
Definition: SensorTypes.h:161
@ DW_SENSORS_ERROR_CODE_IMU_ALIGNMENT_STATUS
IMU sensor bad alignment status.
Definition: SensorTypes.h:187
@ DW_SENSOR_ERROR_NO_DATA_FROM_PUBLISHER
No data is received from publisher.
Definition: SensorTypes.h:163
@ DW_RADAR_ERROR_CODE_ZERO_RETURNS
Radar specific errors: zero return.
Definition: SensorTypes.h:178
@ DW_SENSOR_ERROR_CODE_INVALID
sensor ok
Definition: SensorTypes.h:158
@ DW_RADAR_ERROR_CODE_NUM_RETURNS_OUT_OF_RANGE
Radar specific errors: return num is out of range.
Definition: SensorTypes.h:176
@ DW_SENSOR_ERROR_CODE_NON_MONOTONIC_DATA
Non monotonic timestamp received from the sensor.
Definition: SensorTypes.h:172
@ DW_SENSOR_ERROR_NOT_ENOUGH_DATA
Not enough dats from publisher since initialization.
Definition: SensorTypes.h:165
@ DW_SENSORS_ERROR_CODE_GPS_ACCURACY
GPS sensor accuracy warning.
Definition: SensorTypes.h:185
@ DW_RADAR_ERROR_CODE_AZIMUTH_OUT_OF_RANGE
Radar specific errors: azimuth is out of range.
Definition: SensorTypes.h:174
@ DW_SENSOR_ERROR_E2E_FAILURE
E2E failures.
Definition: SensorTypes.h:167
@ DW_SENSORS_ERROR_CODE_GPS_MODE
GPS sensor working mode error.
Definition: SensorTypes.h:183
@ DW_SENSOR_ERROR_STATE_MACHINE_DISABLED
State machine is disabled.
Definition: SensorTypes.h:169
@ DW_RADAR_ERROR_CODE_END_INDEX
Radar specific errors: end index.
Definition: SensorTypes.h:180
Holds sets of parameters for sensor creation.
Definition: SensorTypes.h:84
A seek structure is made of memory offset, eventcount and timestamp.
Definition: SensorTypes.h:132