NvSIPLCommon.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2018-2024 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 NVSIPLCOMMON_HPP
#define NVSIPLCOMMON_HPP
 
#include <memory>
#include <cmath>
 
#define SIPL_TRUE  (0 == 0)
 
#define SIPL_FALSE (0 == 1)
 
#define NVSIPL_GPIO_DEVICE_DESERIALIZER         (static_cast<uint32_t>(1U) << 0U)
 
#define NVSIPL_GPIO_DEVICE_SERIALIZER_0         (static_cast<uint32_t>(1U) << 8U)
 
#define NVSIPL_GPIO_DEVICE_SERIALIZER_1         (static_cast<uint32_t>(1U) << 9U)
 
#define NVSIPL_GPIO_DEVICE_SERIALIZER_2         (static_cast<uint32_t>(1U) << 10U)
 
#define NVSIPL_GPIO_DEVICE_SERIALIZER_3         (static_cast<uint32_t>(1U) << 11U)
 
#define NVSIPL_GPIO_DEVICE_SENSOR_0             (static_cast<uint32_t>(1U) << 16U)
 
#define NVSIPL_GPIO_DEVICE_SENSOR_1             (static_cast<uint32_t>(1U) << 17U)
 
#define NVSIPL_GPIO_DEVICE_SENSOR_2             (static_cast<uint32_t>(1U) << 18U)
 
#define NVSIPL_GPIO_DEVICE_SENSOR_3             (static_cast<uint32_t>(1U) << 19U)
 
#define NVSIPL_GPIO_DEVICE_INTR_ERR             (static_cast<uint32_t>(1U) << 24U)
 
#define NVSIPL_GPIO_DEVICE_INTR_ERR_GETSTATUS   (static_cast<uint32_t>(1U) << 25U)
 
#define NVSIPL_GPIO_DEVICE_SERIALIZER_SHIFT     (8U)
 
#define NVSIPL_GPIO_DEVICE_SENSOR_SHIFT         (16U)
 
namespace nvsipl
{
struct NvSiplRect {
    uint16_t x0;
    uint16_t y0;
    uint16_t x1;
    uint16_t y1;
};
 
using NvSiplGlobalTime = uint64_t;
 
struct NvSiplPoint {
    int32_t x;
    int32_t y;
};
 
struct NvSiplPointFloat {
    float_t x;
    float_t y;
};
 
using NvSiplBool = uint32_t;
 
enum NvSiplTimeBase : std::uint8_t {
    NVSIPL_TIME_BASE_CLOCK_PTP = 0,
    NVSIPL_TIME_BASE_CLOCK_MONOTONIC,
    NVSIPL_TIME_BASE_CLOCK_USER_DEFINED,
};
 
enum SIPLStatus : std::uint8_t
{
    // New status code must be added after NVSIPL_STATUS_OK and before NVSIPL_STATUS_ERROR.
 
    NVSIPL_STATUS_OK = 0,
 
    // Error codes.
    NVSIPL_STATUS_BAD_ARGUMENT,
    NVSIPL_STATUS_NOT_SUPPORTED,
    NVSIPL_STATUS_OUT_OF_MEMORY,
    NVSIPL_STATUS_RESOURCE_ERROR,
    NVSIPL_STATUS_TIMED_OUT,
    NVSIPL_STATUS_INVALID_STATE,
    NVSIPL_STATUS_EOF,
    NVSIPL_STATUS_NOT_INITIALIZED,
    NVSIPL_STATUS_FAULT_STATE,
    NVSIPL_STATUS_ERROR
};
 
enum SIPLGpioEvent : std::uint8_t
{
    NVSIPL_GPIO_EVENT_NOTHING = 0,
    NVSIPL_GPIO_EVENT_INTR,
    NVSIPL_GPIO_EVENT_INTR_TIMEOUT,
    NVSIPL_GPIO_EVENT_ERROR_CAMGPIO,
    NVSIPL_GPIO_EVENT_ERROR_BACKEND,
    NVSIPL_GPIO_EVENT_ERROR_UNKNOWN,
};
 
struct SIPLErrorDetails {
    std::unique_ptr<uint8_t []> upErrorBuffer;
 
    size_t bufferSize;
 
    size_t sizeWritten;
};
 
enum SIPLModuleErrorReadFlag : std::uint8_t
{
    NVSIPL_MODULE_ERROR_READ_SENSOR,
    NVSIPL_MODULE_ERROR_READ_SERIALIZER,
    NVSIPL_MODULE_ERROR_READ_ALL,
};
 
}  // namespace nvsipl
 
#endif // NVSIPLCOMMON_HPP