DriveWorks SDK Reference
5.10.90 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 <dw/core/base/Types.h>
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
64#define DW_MAX_ERROR_SIGNAL_ERRORS_COUNT 32U
65
69typedef struct dwErrorSignal
70{
74 uint16_t sourceID;
76 size_t count;
80
82#define DW_MAX_HEALTH_BYTEARRAY_SIZE 862U
83
88typedef struct dwHealthSignal
89{
93 uint16_t sourceID;
95 size_t count;
98
100 size_t dataSize;
104
106#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64
107
112{
116 uint32_t count;
118
119#ifdef __cplusplus
120}
121#endif
123#endif
NVIDIA DriveWorks API: Core Types
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:63
uint32_t count
Number of health signals present in the array.
dwTime_t timestamp
timestamp at which the health status was last updated, filled by module
Definition: HealthSignals.h:91
uint32_t errorIDs[DW_MAX_ERROR_SIGNAL_ERRORS_COUNT]
module defined error
Definition: HealthSignals.h:78
uint16_t sourceID
module id, automatically filled
Definition: HealthSignals.h:93
dwHealthSignal signal[DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE]
The individual signals.
size_t count
the number of errors in errorIds
Definition: HealthSignals.h:95
uint8_t data[DW_MAX_HEALTH_BYTEARRAY_SIZE]
optional byte array for additional information
size_t count
the number of errors in errorIds
Definition: HealthSignals.h:76
uint32_t errorIDs[DW_MAX_ERROR_SIGNAL_ERRORS_COUNT]
module defined error
Definition: HealthSignals.h:97
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
#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 data field in dwHealthSignal.
Definition: HealthSignals.h:82
#define DW_MAX_ERROR_SIGNAL_ERRORS_COUNT
Definition: HealthSignals.h:64
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:89
Represents an array of health signals.