NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
HealthSignals.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2016-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 #ifndef DW_CORE_HEALTH_HEALTHSIGNALS_H_
13 #define DW_CORE_HEALTH_HEALTHSIGNALS_H_
14 // Generated by dwProto from health_signals.proto DO NOT EDIT BY HAND!
15 // See //3rdparty/shared/dwproto/README.md for more information
16 
41 #include <dw/pbwire/BasicTypes.h>
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 #define DW_MAX_ERROR_SIGNAL_ERRORS_COUNT 32U
48 #define DW_MAX_HEALTH_BYTEARRAY_SIZE 862U
50 #define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64
52 
56 // coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-SWSADR-003
57 // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
58 typedef struct dwErrorSignal
59 {
62 
64  uint16_t sourceID;
65 
67  size_t count;
68 
71  // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
73 
78 // coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-SWSADR-003
79 // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
80 typedef struct dwHealthSignal
81 {
84 
86  uint16_t sourceID;
87 
89  size_t count;
90 
93 
95  size_t dataSize;
96 
99  // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
101 
105 // coverity[misra_c_2012_rule_2_4_violation] Deviation Record: AV-NDAS-SWSADR-003
106 // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
107 typedef struct dwHealthSignalArray
108 {
111  uint32_t count;
112  // coverity[misra_c_2012_rule_2_3_violation] Deviation Record: AV-NDAS-DWPROTO-SWSADR-006
114 
115 #ifdef __cplusplus
116 }
117 #endif
118 
122 #endif // DW_CORE_HEALTH_HEALTHSIGNALS_H_
dwHealthSignalArray
struct dwHealthSignalArray dwHealthSignalArray
Represents an array of health signals.
dwErrorSignal::sourceID
uint16_t sourceID
module id, automatically filled
Definition: HealthSignals.h:64
dwHealthSignalArray::count
uint32_t count
Stores the occupied/valid length of healthSignals.
Definition: HealthSignals.h:111
dwErrorSignal::count
size_t count
the number of errors in errorIds
Definition: HealthSignals.h:67
dwErrorSignal::timestamp
dwTime_t timestamp
timestamp at which the error occured, filled by module
Definition: HealthSignals.h:61
dwHealthSignalArray::healthSignals
dwHealthSignal healthSignals[DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE]
The individual signals.
Definition: HealthSignals.h:110
DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE
#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE
The maximum number of individual dwHealthSignal that can be stored in a dwHealthSignalArray.
Definition: HealthSignals.h:51
dwHealthSignal
struct dwHealthSignal dwHealthSignal
Basic health signal that describes the health status of a particular software element.
dwHealthSignal::data
uint8_t data[DW_MAX_HEALTH_BYTEARRAY_SIZE]
optional byte array for additional information
Definition: HealthSignals.h:98
dwTime_t
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:54
dwHealthSignal::count
size_t count
the number of errors in errorIds
Definition: HealthSignals.h:89
dwHealthSignal
Basic health signal that describes the health status of a particular software element.
Definition: HealthSignals.h:80
dwHealthSignal::timestamp
dwTime_t timestamp
timestamp at which the health status was last updated, filled by module
Definition: HealthSignals.h:83
dwHealthSignal::errorIDs
uint32_t errorIDs[DW_MAX_ERROR_SIGNAL_ERRORS_COUNT]
module defined error
Definition: HealthSignals.h:92
DW_MAX_HEALTH_BYTEARRAY_SIZE
#define DW_MAX_HEALTH_BYTEARRAY_SIZE
The size of the data field in dwHealthSignal.
Definition: HealthSignals.h:49
DW_MAX_ERROR_SIGNAL_ERRORS_COUNT
#define DW_MAX_ERROR_SIGNAL_ERRORS_COUNT
Definition: HealthSignals.h:47
dwHealthSignalArray
Represents an array of health signals.
Definition: HealthSignals.h:107
dwErrorSignal::errorIDs
uint32_t errorIDs[DW_MAX_ERROR_SIGNAL_ERRORS_COUNT]
module defined error
Definition: HealthSignals.h:70
dwErrorSignal
struct dwErrorSignal dwErrorSignal
Basic error signal that gets reported only when there is an error.
dwHealthSignal::sourceID
uint16_t sourceID
module id, automatically filled
Definition: HealthSignals.h:86
dwHealthSignal::dataSize
size_t dataSize
bytes used in the optional byte array
Definition: HealthSignals.h:95
dwErrorSignal
Basic error signal that gets reported only when there is an error.
Definition: HealthSignals.h:58