SignalStatus.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef DWV_CORE_SIGNAL_STATUS_H_
#define DWV_CORE_SIGNAL_STATUS_H_
 
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint8_t dwSignalValidity;
 
typedef enum {
    DW_SIGNAL_STATUS_INIT = 0,
    DW_SIGNAL_STATUS_LAST_VALID = 1,
    DW_SIGNAL_STATUS_ERROR = 2,
    DW_SIGNAL_STATUS_OUT_OF_BOUNDS_ERROR = 3,
    DW_SIGNAL_STATUS_MAX_ENUM_VALUE = 3
} dwSignalStatus;
 
typedef enum {
    DW_SIGNAL_TIMEOUT_NEVER_RECEIVED = 0,
    DW_SIGNAL_TIMEOUT_NONE = 1,
    DW_SIGNAL_TIMEOUT_OVERDUE = 2,
    DW_SIGNAL_TIMEOUT_NO_INFORMATION DW_DEPRECATED_ENUM("REL_23_09") = 3,
    DW_SIGNAL_TIMEOUT_DELAYED = 4,
    DW_SIGNAL_TIMEOUT_MAX_ENUM_VALUE = 4
} dwSignalTimeoutStatus;
 
typedef enum {
    DW_SIGNAL_E2E_NO_ERROR = 0,
    DW_SIGNAL_E2E_SEQ_ERROR = 1,
    DW_SIGNAL_E2E_HASH_ERROR = 2,
    DW_SIGNAL_E2E_NO_INFORMATION DW_DEPRECATED_ENUM("REL_23_09") = 3,
    DW_SIGNAL_E2E_MAX_ENUM_VALUE = 3
} dwSignalE2EStatus;
 
DW_API_PUBLIC
dwStatus dwSignal_encodeSignalValidity(dwSignalValidity* validity,
                                       dwSignalStatus const status,
                                       dwSignalTimeoutStatus const timeoutStatus,
                                       dwSignalE2EStatus const e2eStatus);
 
DW_API_PUBLIC
dwStatus dwSignal_decodeSignalValidity(dwSignalStatus* status,
                                       dwSignalTimeoutStatus* timeoutStatus,
                                       dwSignalE2EStatus* e2eStatus,
                                       dwSignalValidity const validity);
 
DW_API_PUBLIC
dwStatus dwSignal_checkSignalValidity(dwSignalValidity const validity);
 
#ifdef __cplusplus
}
#endif
 
#endif // DWV_CORE_SIGNAL_STATUS_H_