SignalStatus.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-2022 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 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,
} dwSignalStatus;

typedef enum {
    DW_SIGNAL_TIMEOUT_NEVER_RECEIVED = 0,
    DW_SIGNAL_TIMEOUT_NONE = 1,
    DW_SIGNAL_TIMEOUT_OVERDUE = 2,
    DW_SIGNAL_TIMEOUT_NO_INFORMATION = 3,
} 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 = 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);

#ifdef __cplusplus
}
#endif

#endif // DWV_CORE_SIGNAL_STATUS_H_