NVIDIA DRIVE OS Linux SDK API Reference

6.0.3 Release
NvSIPLCommon.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA CORPORATION and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA CORPORATION is strictly prohibited.
9  */
10 
11 #ifndef NVSIPLCOMMON_HPP
12 #define NVSIPLCOMMON_HPP
13 
14 #include <memory>
15 #include "nvmedia_core.h"
16 
28 #define NVSIPL_TIME_BASE_CLOCK_PTP NVMEDIA_TIME_BASE_CLOCK_PTP
29 #define NVSIPL_TIME_BASE_CLOCK_MONOTONIC NVMEDIA_TIME_BASE_CLOCK_MONOTONIC
30 #define NVSIPL_TIME_BASE_CLOCK_USER_DEFINED NVMEDIA_TIME_BASE_CLOCK_USER_DEFINED
31 
35 namespace nvsipl
36 {
60 
62 
65 {
66  // New status code must be added after NVSIPL_STATUS_OK and before NVSIPL_STATUS_ERROR.
67 
70 
71  // Error codes.
92 };
93 
96 {
121 };
122 
126 typedef struct {
131  std::unique_ptr<uint8_t []> upErrorBuffer;
132 
136  size_t bufferSize;
137 
141  size_t sizeWritten;
143 
146 {
161 };
162 
165 } // namespace nvsipl
166 
167 #endif // NVSIPLCOMMON_HPP
nvsipl::NvSiplRect
NvMediaRect NvSiplRect
See definitions from NvMedia.
Definition: NvSIPLCommon.hpp:55
nvsipl::NvSiplPoint
NvMediaPoint NvSiplPoint
Definition: NvSIPLCommon.hpp:57
nvsipl::NVSIPL_STATUS_NOT_INITIALIZED
@ NVSIPL_STATUS_NOT_INITIALIZED
Indicates a module was not initialized.
Definition: NvSIPLCommon.hpp:87
nvsipl::NVSIPL_STATUS_ERROR
@ NVSIPL_STATUS_ERROR
Indicates an unspecified error that is used when no other error code applies.
Definition: NvSIPLCommon.hpp:91
NvMediaGlobalTime
uint64_t NvMediaGlobalTime
Media global time, measured in microseconds.
Definition: tvmr/include/nvmedia_core.h:90
nvsipl::SIPLGpioEvent
SIPLGpioEvent
CDAC GPIO event codes.
Definition: NvSIPLCommon.hpp:95
nvsipl::SIPLModuleErrorReadFlag
SIPLModuleErrorReadFlag
Flag indicating which module errors to read.
Definition: NvSIPLCommon.hpp:145
nvsipl::SIPLErrorDetails::sizeWritten
size_t sizeWritten
Holds size of error written to the buffer, filled by driver.
Definition: NvSIPLCommon.hpp:141
nvsipl::NVSIPL_GPIO_EVENT_ERROR_BACKEND
@ NVSIPL_GPIO_EVENT_ERROR_BACKEND
An error occurred in backend code, potentially resulting in permanent loss of functionality.
Definition: NvSIPLCommon.hpp:115
nvsipl::NvSiplGlobalTime
NvMediaGlobalTime NvSiplGlobalTime
Definition: NvSIPLCommon.hpp:56
nvsipl::SIPLErrorDetails
Error details for a particular device.
Definition: NvSIPLCommon.hpp:126
nvsipl::NVSIPL_STATUS_INVALID_STATE
@ NVSIPL_STATUS_INVALID_STATE
Indicates a module is in an invalid state.
Definition: NvSIPLCommon.hpp:83
nvsipl::NVSIPL_MODULE_ERROR_READ_ALL
@ NVSIPL_MODULE_ERROR_READ_ALL
Read both sensor and serializer error information when getting error details.
Definition: NvSIPLCommon.hpp:160
nvsipl::NVSIPL_STATUS_OUT_OF_MEMORY
@ NVSIPL_STATUS_OUT_OF_MEMORY
Indicates an out of memory or other system resource error was encountered.
Definition: NvSIPLCommon.hpp:77
nvsipl::NVSIPL_STATUS_BAD_ARGUMENT
@ NVSIPL_STATUS_BAD_ARGUMENT
Indicates one or more invalid arguments was encountered.
Definition: NvSIPLCommon.hpp:73
nvsipl::NVSIPL_GPIO_EVENT_ERROR_WAIT_CANCELLED
@ NVSIPL_GPIO_EVENT_ERROR_WAIT_CANCELLED
Waiting for an interrupt was unexpectedly cancelled, potentially resulting in permanent loss of funct...
Definition: NvSIPLCommon.hpp:105
NvMediaPoint
Defines the location of a point on a two-dimensional object.
Definition: tvmr/include/nvmedia_core.h:147
nvsipl::NvSiplBool
NvMediaBool NvSiplBool
Definition: NvSIPLCommon.hpp:59
NvMediaRect
Holds a rectangular region of a surface.
Definition: tvmr/include/nvmedia_core.h:133
nvsipl::NVSIPL_MODULE_ERROR_READ_SERIALIZER
@ NVSIPL_MODULE_ERROR_READ_SERIALIZER
Read only serializer error information when getting error details.
Definition: NvSIPLCommon.hpp:156
nvsipl::NVSIPL_STATUS_OK
@ NVSIPL_STATUS_OK
Indicates the operation completed successfully without errors.
Definition: NvSIPLCommon.hpp:69
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:64
nvsipl::NVSIPL_GPIO_EVENT_NOTHING
@ NVSIPL_GPIO_EVENT_NOTHING
There is no pending event.
Definition: NvSIPLCommon.hpp:98
nvsipl::NVSIPL_GPIO_EVENT_ERROR_CDAC
@ NVSIPL_GPIO_EVENT_ERROR_CDAC
An error occurred in CDAC code, potentially resulting in permanent loss of functionality.
Definition: NvSIPLCommon.hpp:110
nvsipl::NvSiplPointFloat
NvMediaPointFloat NvSiplPointFloat
Definition: NvSIPLCommon.hpp:58
nvsipl::NVSIPL_GPIO_EVENT_INTR
@ NVSIPL_GPIO_EVENT_INTR
An interrupt has occured.
Definition: NvSIPLCommon.hpp:100
nvsipl::SIPLErrorDetails::bufferSize
size_t bufferSize
Holds the maximum size of error data which can be contained in the buffer.
Definition: NvSIPLCommon.hpp:136
nvsipl::SIPLErrorDetails::upErrorBuffer
std::unique_ptr< uint8_t[]> upErrorBuffer
Buffer which will be filled by driver with error information.
Definition: NvSIPLCommon.hpp:131
nvsipl::NVSIPL_MODULE_ERROR_READ_SENSOR
@ NVSIPL_MODULE_ERROR_READ_SENSOR
Read only sensor error information when getting module error details.
Definition: NvSIPLCommon.hpp:151
nvsipl::NvSiplTimeBase
NvMediaTimeBase NvSiplTimeBase
Definition: NvSIPLCommon.hpp:61
NvMediaPointFloat
Defines the float-precision location of a point on a two-dimensional object.
Definition: tvmr/include/nvmedia_core.h:158
nvsipl::NVSIPL_STATUS_NOT_SUPPORTED
@ NVSIPL_STATUS_NOT_SUPPORTED
Indicates an unsupported operation or argument was encountered.
Definition: NvSIPLCommon.hpp:75
nvsipl::NVSIPL_STATUS_EOF
@ NVSIPL_STATUS_EOF
Indicates that end of file has been reached.
Definition: NvSIPLCommon.hpp:85
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: INvSiplControlAuto.hpp:33
NvMediaBool
uint32_t NvMediaBool
A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.
Definition: tvmr/include/nvmedia_core.h:80
nvsipl::NVSIPL_STATUS_RESOURCE_ERROR
@ NVSIPL_STATUS_RESOURCE_ERROR
Indicates a resource error was encountered.
Definition: NvSIPLCommon.hpp:79
nvsipl::NVSIPL_GPIO_EVENT_ERROR_UNKNOWN
@ NVSIPL_GPIO_EVENT_ERROR_UNKNOWN
A generic error occurred, potentially resulting in permanent loss of functionality.
Definition: NvSIPLCommon.hpp:120
nvsipl::NVSIPL_STATUS_FAULT_STATE
@ NVSIPL_STATUS_FAULT_STATE
Indicates module is in non-recoverable fault state.
Definition: NvSIPLCommon.hpp:89
NvMediaTimeBase
NvMediaTimeBase
Defines clock base for NvMediaTime.
Definition: tvmr/include/nvmedia_core.h:94
nvsipl::NVSIPL_STATUS_TIMED_OUT
@ NVSIPL_STATUS_TIMED_OUT
Indicates an operation timed out.
Definition: NvSIPLCommon.hpp:81