DriveWorks SDK Reference
5.16.65 Release
For Test and Development only

VehicleIODriver.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) 2019-2023 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
38#ifndef DW_CONTROL_PLUGINS_VEHICLEIO_DRIVER_H_
39#define DW_CONTROL_PLUGINS_VEHICLEIO_DRIVER_H_
40
50#include <dw/core/base/Types.h>
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
64
72
82
92 dwSensorHandle_t sensor);
93
103 dwSensorHandle_t sensor);
104
114
124
133
148dwStatus _dwVehicleIODriver_initialize_V2(dwContextHandle_t context, char8_t const* vehicleTypeString, dwVehicle const* vehicleProperties, dwVehicleIOCapabilities* vehicleIOCapabilities, char8_t const* dbcFilepath, dwVehicleIOState* vioState, dwVehicleIOSafetyState* vioSafetyState, dwVehicleIONonSafetyState* vioNonSafetyState, dwVehicleIOActuationFeedback* vioActuationFeedback);
149
158
167
176
185
194
203
212
221
231dwStatus _dwVehicleIODriver_clearFaults_new(dwSensorHandle_t const sensorHandle, dwVehicleIOSafetyState const* vioSafetyState, dwVehicleIONonSafetyState const* vioNonSafetyState, dwVehicleIOActuationFeedback const* vioActuationFeedback);
232
235#ifdef __cplusplus
236}
237#endif
238
239#endif
dwStatus
Status definition.
Definition: ErrorDefs.h:44
NVIDIA DriveWorks API: Core Types
VehicleIO Capabilities.
NVIDIA DriveWorks API: VehicleIO car controller
Non-safety critical RoV commands.
Non-safety critical RoV state.
Safety critical RoV commands.
Safety critical VIO state.
The vehicle IO state data.
Holds a CAN package.
Definition: CAN.h:113
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:86
Holds a data packet.
Definition: Data.h:61
DEPRECATED: Properties of a passenger car vehicle.
Definition: Vehicle.h:354
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: Sensors.h:88
dwStatus _dwVehicleIODriver_consumeDataForNonSafeState(dwDataPacket const *dataPacket, dwVehicleIONonSafetyState *nonSafetyState)
Extract dwVehicleIONonSafetyState from incoming data packet.
dwStatus _dwVehicleIODriver_consumeDataForActuationFeedback(dwDataPacket const *dataPacket, dwVehicleIOActuationFeedback *actuationFeedback)
Extract dwVehicleIOActuationFeedback from incoming data packet.
dwStatus _dwVehicleIODriver_consume(const dwCANMessage *msg, dwVehicleIOState *state)
Consume a received CAN message and update the vehicle state.
dwStatus _dwVehicleIODriver_sendSafetyCommand(dwVehicleIOSafetyCommand const *safetyCommand, dwSensorHandle_t sensorHandle)
Send dwVehicleIOSafetyCommand over specified sensor.
dwStatus _dwVehicleIODriver_clearFaults_new(dwSensorHandle_t const sensorHandle, dwVehicleIOSafetyState const *vioSafetyState, dwVehicleIONonSafetyState const *vioNonSafetyState, dwVehicleIOActuationFeedback const *vioActuationFeedback)
Clear any outstanding faults based on incoming VIO state structures.
dwStatus _dwVehicleIODriver_setDrivingMode(const dwVehicleIODrivingMode mode)
Set driving mode.
dwStatus _dwVehicleIODriver_initialize()
Initializes the VehicleIO Driver.
dwStatus _dwVehicleIODriver_consumeForSafeState(dwCANMessage const *canMessage, dwVehicleIOSafetyState *safetyState)
Extract dwVehicleIOSafetyState from incoming CAN message.
dwStatus _dwVehicleIODriver_sendCommand(const dwVehicleIOCommand *cmd, dwSensorHandle_t sensor)
Send a vehicle command to the given CAN sensor.
dwStatus _dwVehicleIODriver_consumeDataForSafeState(dwDataPacket const *dataPacket, dwVehicleIOSafetyState *safetyState)
Extract dwVehicleIOSafetyState from incoming data packet.
dwStatus _dwVehicleIODriver_release()
Releases the VehicleIO Driver.
dwStatus _dwVehicleIODriver_consumeForActuationFeedback(dwCANMessage const *canMessage, dwVehicleIOActuationFeedback *actuationFeedback)
Extract dwVehicleIOActuationFeedback from incoming CAN message.
dwStatus _dwVehicleIODriver_sendNonSafetyCommand(dwVehicleIONonSafetyCommand const *nonSafetyCommand, dwSensorHandle_t sensorHandle)
Send dwVehicleIONonSafetyCommand over specified sensor.
dwStatus _dwVehicleIODriver_sendMiscCommand(const dwVehicleIOMiscCommand *cmd, dwSensorHandle_t sensor)
Send misc vehicle command to the given CAN sensor.
dwStatus _dwVehicleIODriver_clearFaults(dwSensorHandle_t sensor, const dwVehicleIOState *state)
Clear faults in current vehicle state.
dwStatus _dwVehicleIODriver_consumeForNonSafeState(dwCANMessage const *canMessage, dwVehicleIONonSafetyState *nonSafetyState)
Extract dwVehicleIONonSafetyState from incoming CAN message.
dwStatus _dwVehicleIODriver_reset()
Reset driver to default state.
dwStatus _dwVehicleIODriver_initialize_V2(dwContextHandle_t context, char8_t const *vehicleTypeString, dwVehicle const *vehicleProperties, dwVehicleIOCapabilities *vehicleIOCapabilities, char8_t const *dbcFilepath, dwVehicleIOState *vioState, dwVehicleIOSafetyState *vioSafetyState, dwVehicleIONonSafetyState *vioNonSafetyState, dwVehicleIOActuationFeedback *vioActuationFeedback)
Initialize Plugin VIO Driver.