HealthSignals.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2021 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_CORE_HEALTH_SIGNALS_H_
#define DW_CORE_HEALTH_SIGNALS_H_

#include <dw/core/base/Types.h>

#ifdef __cplusplus
extern "C" {
#endif

// New Health Signal API Definition
// Note: All enums follow the rule that two enum values will have a Hamming Distance > 1

typedef enum dwHealthState {
    HEALTH_STATE_UNKNOWN = 0, // Unable to determine health state
    HEALTH_STATE_OK      = 3,
    HEALTH_STATE_WARN    = 5,
    HEALTH_STATE_ERROR   = 6
} dwHealthState;

typedef enum dwSeverityLevel {
    SEVERITY_LEVEL_UNKNOWN  = 0, // Unable to determine severity level
    SEVERITY_LEVEL_LOW      = 3,
    SEVERITY_LEVEL_MEDIUM   = 5,
    SEVERITY_LEVEL_HIGH     = 6,
    SEVERITY_LEVEL_CRITICAL = 9
} dwSeverityLevel;

#define DW_MAX_MESSAGE_LENGTH 32
#define DW_MAX_HEALTH_KEY_VALUE_PAIRS 16

typedef struct dwHealthKeyValue
{
    char key[DW_MAX_MESSAGE_LENGTH];   
    char value[DW_MAX_MESSAGE_LENGTH]; 
} dwHealthKeyValue;

typedef struct dwHealthSignal
{
    dwTime_t timestamp;

    dwHealthState healthState;

    dwSeverityLevel severityLevel;

    uint8_t score; 

    uint64_t id; 

    uint32_t age; 

    uint32_t sourceID;  
    uint32_t errorCode; 

    uint32_t nValues;                                       
    dwHealthKeyValue values[DW_MAX_HEALTH_KEY_VALUE_PAIRS]; 
} dwHealthSignal;

#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64

typedef struct dwHealthSignalArray
{
    dwHealthSignal signal[DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE];
    uint32_t count; // Number of health signals present in the array
} dwHealthSignalArray;

#ifdef __cplusplus
}
#endif

#endif