NvSIPLCommon.hpp File Reference

Detailed Description

NVIDIA SIPL: Common Data Structures - SIPL

Definition in file NvSIPLCommon.hpp.

Go to the source code of this file.

Data Structures
struct	nvsipl::NvSiplRect
	Holds a rectangular region of a surface. More...
struct	nvsipl::NvSiplPoint
	Defines the location of a point on a two-dimensional object. More...
struct	nvsipl::NvSiplPointFloat
	Defines the float-precision location of a point on a two-dimensional object. More...
struct	nvsipl::SIPLErrorDetails
	Error details for a particular device. More...

Namespaces
	nvsipl
	Contains the classes and variables for implementation of SIPL.

Macros
#define	SIPL_TRUE
	A true NvSiplBool value. More...
#define	SIPL_FALSE
	A false NvSiplBool value. More...
#define	NVSIPL_GPIO_DEVICE_DESERIALIZER   (static_cast<uint32_t>(1U) << 0U)
	GPIO originated from the deserializer. More...
#define	NVSIPL_GPIO_DEVICE_SERIALIZER_0   (static_cast<uint32_t>(1U) << 8U)
	GPIO originated from a serializer on link 0. More...
#define	NVSIPL_GPIO_DEVICE_SERIALIZER_1   (static_cast<uint32_t>(1U) << 9U)
	GPIO originated from a serializer on link 1. More...
#define	NVSIPL_GPIO_DEVICE_SERIALIZER_2   (static_cast<uint32_t>(1U) << 10U)
	GPIO originated from a serializer on link 2. More...
#define	NVSIPL_GPIO_DEVICE_SERIALIZER_3   (static_cast<uint32_t>(1U) << 11U)
	GPIO originated from a serializer on link 3. More...
#define	NVSIPL_GPIO_DEVICE_SENSOR_0   (static_cast<uint32_t>(1U) << 16U)
	GPIO originated from a sensor on link 0. More...
#define	NVSIPL_GPIO_DEVICE_SENSOR_1   (static_cast<uint32_t>(1U) << 17U)
	GPIO originated from a sensor on link 1. More...
#define	NVSIPL_GPIO_DEVICE_SENSOR_2   (static_cast<uint32_t>(1U) << 18U)
	GPIO originated from a sensor on link 2. More...
#define	NVSIPL_GPIO_DEVICE_SENSOR_3   (static_cast<uint32_t>(1U) << 19U)
	GPIO originated from a sensor on link 3. More...
#define	NVSIPL_GPIO_DEVICE_INTR_ERR   (static_cast<uint32_t>(1U) << 24U)
	GPIO is configured for error interrupts. More...
#define	NVSIPL_GPIO_DEVICE_INTR_ERR_GETSTATUS   (static_cast<uint32_t>(1U) << 25U)
	GPIO is configured for error interrupt localization. More...
#define	NVSIPL_GPIO_DEVICE_SERIALIZER_SHIFT   (8U)
	Offset to NVSIPL_GPIO_DEVICE_SERIALIZER_0 flag. More...
#define	NVSIPL_GPIO_DEVICE_SENSOR_SHIFT   (16U)
	Offset to NVSIPL_GPIO_DEVICE_SENSOR_0 flag. More...

Typedefs
using	nvsipl::NvSiplGlobalTime = uint64_t
	Media global time, measured in microseconds. More...
using	nvsipl::NvSiplBool = uint32_t
	A boolean value, holding SIPL_TRUE or SIPL_FALSE. More...

Enumerations
enum	nvsipl::NvSiplTimeBase {   nvsipl::NVSIPL_TIME_BASE_CLOCK_PTP,   nvsipl::NVSIPL_TIME_BASE_CLOCK_MONOTONIC,   nvsipl::NVSIPL_TIME_BASE_CLOCK_USER_DEFINED }
	Defines clock base for NvSiplTime. More...
enum	nvsipl::SIPLStatus {   nvsipl::NVSIPL_STATUS_OK = 0,   nvsipl::NVSIPL_STATUS_BAD_ARGUMENT,   nvsipl::NVSIPL_STATUS_NOT_SUPPORTED,   nvsipl::NVSIPL_STATUS_OUT_OF_MEMORY,   nvsipl::NVSIPL_STATUS_RESOURCE_ERROR,   nvsipl::NVSIPL_STATUS_TIMED_OUT,   nvsipl::NVSIPL_STATUS_INVALID_STATE,   nvsipl::NVSIPL_STATUS_EOF,   nvsipl::NVSIPL_STATUS_NOT_INITIALIZED,   nvsipl::NVSIPL_STATUS_FAULT_STATE,   nvsipl::NVSIPL_STATUS_ERROR }
	Defines the status codes returned by functions in SIPL modules. More...
enum	nvsipl::SIPLGpioEvent {   nvsipl::NVSIPL_GPIO_EVENT_NOTHING = 0,   nvsipl::NVSIPL_GPIO_EVENT_INTR,   nvsipl::NVSIPL_GPIO_EVENT_INTR_TIMEOUT,   nvsipl::NVSIPL_GPIO_EVENT_ERROR_CAMGPIO,   nvsipl::NVSIPL_GPIO_EVENT_ERROR_BACKEND,   nvsipl::NVSIPL_GPIO_EVENT_ERROR_UNKNOWN }
	CDAC GPIO event codes. More...
enum	nvsipl::SIPLModuleErrorReadFlag {   nvsipl::NVSIPL_MODULE_ERROR_READ_SENSOR,   nvsipl::NVSIPL_MODULE_ERROR_READ_SERIALIZER,   nvsipl::NVSIPL_MODULE_ERROR_READ_ALL }
	Flag indicating which module errors to read. More...

Macro Definition Documentation

NVSIPL_GPIO_DEVICE_SENSOR_SHIFT

#define NVSIPL_GPIO_DEVICE_SENSOR_SHIFT   (16U)

Offset to NVSIPL_GPIO_DEVICE_SENSOR_0 flag.

Definition at line 64 of file NvSIPLCommon.hpp.

NVSIPL_GPIO_DEVICE_SERIALIZER_SHIFT

#define NVSIPL_GPIO_DEVICE_SERIALIZER_SHIFT   (8U)

Offset to NVSIPL_GPIO_DEVICE_SERIALIZER_0 flag.

Definition at line 62 of file NvSIPLCommon.hpp.

SIPL_FALSE

#define SIPL_FALSE

A false NvSiplBool value.

Definition at line 29 of file NvSIPLCommon.hpp.

SIPL_TRUE

#define SIPL_TRUE

A true NvSiplBool value.

Definition at line 26 of file NvSIPLCommon.hpp.