DriveWorks SDK Reference
5.6.215 Release
For Test and Development only

HealthSignals.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) 2021-2022 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_CORE_HEALTH_SIGNALS_H_
48#define DW_CORE_HEALTH_SIGNALS_H_
49
50#include <assert.h>
51
52#include <dw/core/base/Types.h>
53
54#ifdef __cplusplus
55extern "C" {
56#endif
57
69typedef struct dwErrorSignal
70{
74 uint16_t sourceID;
76 uint32_t errorID;
78
80#define DW_MAX_HEALTH_BYTEARRAY_SIZE 1000
81
86typedef struct dwHealthSignal
87{
91 uint16_t sourceID;
93 uint32_t errorID;
94
96 size_t dataSize;
100
102#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64
103
108{
112 uint32_t count;
114
115#ifdef __cplusplus
116}
117
118static_assert(sizeof(dwHealthSignal) == 1024UL, "The size of dwHealthSignal should be 1024. Adjust the size of the field \"data\" if necessary.");
119
120#endif
122#endif
NVIDIA DriveWorks API: Core Types
uint32_t errorID
module defined error
Definition: HealthSignals.h:76
uint32_t count
Number of health signals present in the array.
uint32_t errorID
module defined error
Definition: HealthSignals.h:93
dwTime_t timestamp
timestamp at which the health status was last updated, filled by module
Definition: HealthSignals.h:89
uint16_t sourceID
module id, automatically filled
Definition: HealthSignals.h:91
dwHealthSignal signal[DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE]
The individual signals.
uint8_t data[DW_MAX_HEALTH_BYTEARRAY_SIZE]
optional byte array for additional information
Definition: HealthSignals.h:98
dwTime_t timestamp
timestamp at which the error occured, filled by module
Definition: HealthSignals.h:72
uint16_t sourceID
module id, automatically filled
Definition: HealthSignals.h:74
size_t dataSize
bytes used in the optional byte array
Definition: HealthSignals.h:96
#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE
The maximum number of individual dwHealthSignal that can be stored in a dwHealthSignalArray.
#define DW_MAX_HEALTH_BYTEARRAY_SIZE
The size of the dta field in dwHealthSignal.
Definition: HealthSignals.h:80
Basic error signal that gets reported only when there is an error.
Definition: HealthSignals.h:70
Basic health signal that describes the health status of a particular software element.
Definition: HealthSignals.h:87
Represents an array of health signals.
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: Types.h:82