DriveWorks SDK Reference
5.16.65 Release
For Test and Development only

SignalStatus.h
Go to the documentation of this file.
1
2// This code contains NVIDIA Confidential Information and is disclosed
3// under the Mutual Non-Disclosure Agreement.
4//
5// Notice
6// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
7// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
8// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
9// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
10//
11// NVIDIA Corporation assumes no responsibility for the consequences of use of such
12// information or for any infringement of patents or other rights of third parties that may
13// result from its use. No license is granted by implication or otherwise under any patent
14// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
15// expressly authorized by NVIDIA. Details are subject to change without notice.
16// This code supersedes and replaces all information previously supplied.
17// NVIDIA Corporation products are not authorized for use as critical
18// components in life support devices or systems without express written approval of
19// NVIDIA Corporation.
20//
21// Copyright (c) 2021-2023 NVIDIA Corporation. All rights reserved.
22//
23// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
24// rights in and to this software and related documentation and any modifications thereto.
25// Any use, reproduction, disclosure or distribution of this software and related
26// documentation without an express license agreement from NVIDIA Corporation is
27// strictly prohibited.
28//
30
46#ifndef DWV_CORE_SIGNAL_STATUS_H_
47#define DWV_CORE_SIGNAL_STATUS_H_
48
50#include <dw/core/base/Types.h>
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
57typedef uint8_t dwSignalValidity;
58
62typedef enum {
78
82typedef enum {
96 DW_SIGNAL_TIMEOUT_NO_INFORMATION DW_DEPRECATED_ENUM("REL_23_09") = 3,
103
107typedef enum {
120 DW_SIGNAL_E2E_NO_INFORMATION DW_DEPRECATED_ENUM("REL_23_09") = 3,
124
137 dwSignalStatus const status,
138 dwSignalTimeoutStatus const timeoutStatus,
139 dwSignalE2EStatus const e2eStatus);
140
153 dwSignalTimeoutStatus* timeoutStatus,
154 dwSignalE2EStatus* e2eStatus,
155 dwSignalValidity const validity);
156
167
168#ifdef __cplusplus
169}
170#endif
172#endif // DWV_CORE_SIGNAL_STATUS_H_
dwStatus
Status definition.
Definition: ErrorDefs.h:44
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Exports
#define DW_API_PUBLIC
Definition: Exports.h:56
uint8_t dwSignalValidity
The type of the encoded status field.
Definition: SignalStatus.h:57
DW_API_PUBLIC dwStatus dwSignal_checkSignalValidity(dwSignalValidity const validity)
Checks whether dwSignal*Status values contains a valid signal.
dwSignalTimeoutStatus
Timeout related status of the signal.
Definition: SignalStatus.h:82
dwSignalE2EStatus
End-2-End related status of the signal.
Definition: SignalStatus.h:107
DW_API_PUBLIC dwStatus dwSignal_decodeSignalValidity(dwSignalStatus *status, dwSignalTimeoutStatus *timeoutStatus, dwSignalE2EStatus *e2eStatus, dwSignalValidity const validity)
Decode dwSignal*Status values from a dwSignalValidity value.
dwSignalStatus
Overall status of the signal.
Definition: SignalStatus.h:62
DW_API_PUBLIC dwStatus dwSignal_encodeSignalValidity(dwSignalValidity *validity, dwSignalStatus const status, dwSignalTimeoutStatus const timeoutStatus, dwSignalE2EStatus const e2eStatus)
Encode dwSignal*Status values into a dwSignalValidity value.
@ DW_SIGNAL_TIMEOUT_NEVER_RECEIVED
This signal has never been received.
Definition: SignalStatus.h:85
@ DW_SIGNAL_TIMEOUT_NONE
No timeout error.
Definition: SignalStatus.h:88
@ DW_SIGNAL_TIMEOUT_MAX_ENUM_VALUE
Signal enum max value.
Definition: SignalStatus.h:101
@ DW_SIGNAL_TIMEOUT_DELAYED
Signal was received before, but is not received for more than twice the specified cycle time.
Definition: SignalStatus.h:99
@ DW_SIGNAL_TIMEOUT_OVERDUE
Signal is overdue.
Definition: SignalStatus.h:93
@ DW_SIGNAL_E2E_SEQ_ERROR
E2E Sequence error.
Definition: SignalStatus.h:114
@ DW_SIGNAL_E2E_MAX_ENUM_VALUE
Signal enum max value.
Definition: SignalStatus.h:122
@ DW_SIGNAL_E2E_HASH_ERROR
Hash error.
Definition: SignalStatus.h:117
@ DW_DEPRECATED_ENUM
No timeout information.
Definition: SignalStatus.h:96
@ DW_SIGNAL_E2E_NO_ERROR
No E2E error.
Definition: SignalStatus.h:110
@ DW_SIGNAL_STATUS_LAST_VALID
Signal contains the last valid value that was set.
Definition: SignalStatus.h:68
@ DW_SIGNAL_STATUS_ERROR
Signal value is in error.
Definition: SignalStatus.h:71
@ DW_SIGNAL_STATUS_OUT_OF_BOUNDS_ERROR
Signal value is outside acceptable bounds.
Definition: SignalStatus.h:74
@ DW_SIGNAL_STATUS_MAX_ENUM_VALUE
Signal enum max value.
Definition: SignalStatus.h:76
@ DW_SIGNAL_STATUS_INIT
Initial value.
Definition: SignalStatus.h:65