NVIDIA DRIVE OS Linux SDK API Reference

5.2.3 Release
For Test and Development only
nvmedia_cvscratchpad.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020, NVIDIA CORPORATION. All rights reserved. All
3  * information contained herein is proprietary and confidential to NVIDIA
4  * Corporation. Any use, reproduction, or disclosure without the written
5  * permission of NVIDIA Corporation is prohibited.
6  */
7 
17 #ifndef NVMEDIA_CVSCRATCHPAD_H
18 #define NVMEDIA_CVSCRATCHPAD_H
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 #include "nvmedia_core.h"
25 
38 #define NVMEDIA_CVSCRATCHPAD_VERSION_MAJOR (1u)
39 
40 #define NVMEDIA_CVSCRATCHPAD_VERSION_MINOR (1u)
41 
44 typedef enum {
50  /* If more types are needed, add above this and update this. */
52 
54 
61 
73  NvMediaVersion *version
74 );
75 
88  NvMediaDevice *device,
89  uint32_t size,
91 );
92 
104  NvMediaCVScratchpad *handle
105 );
106 
122  const NvMediaCVScratchpad *handle,
123  uint32_t *size,
125 );
126 
129 /*
130  * \defgroup history_nvmedia_cvscratchpad History
131  * Provides change history for the NvMedia CVScratchpad API.
132  *
133  * \section history_nvmedia_cvscratchpad Version History
134  *
135  * <b> Version 1.0 </b> August 3, 2018
136  * - Initial release
137  *
138  * <b> Version 1.1 </b> March 11, 2020
139  * - Fix Minor Misra Violations
140  *
141  **/
142 
143 #ifdef __cplusplus
144 }; /* extern "C" */
145 #endif
146 
147 #endif // NVMEDIA_CVSCRATCHPAD_H
NvMediaCVScratchpadDestroy
NvMediaStatus NvMediaCVScratchpadDestroy(NvMediaCVScratchpad *handle)
Destroys a CVScratchpad handle created by NvMediaCVScratchpadCreate().
NVMEDIA_SCRATCH_MEMORY_TYPE_DRAM
@ NVMEDIA_SCRATCH_MEMORY_TYPE_DRAM
Specifies scratch memory allocated in DRAM.
Definition: nvmedia_cvscratchpad.h:48
NvMediaCVScratchpadGetVersion
NvMediaStatus NvMediaCVScratchpadGetVersion(NvMediaVersion *version)
Returns version information for the CVScratchpad component.
NvMediaCVScratchpad
struct NvMediaCVScratchpad NvMediaCVScratchpad
Holds a descriptor for the CVScratchpad.
Definition: nvmedia_cvscratchpad.h:60
NVMEDIA_SCRATCH_MEMORY_TYPE_CVSRAM
@ NVMEDIA_SCRATCH_MEMORY_TYPE_CVSRAM
Specifies scratch memory allocated in CVSRAM.
Definition: nvmedia_cvscratchpad.h:46
NvMediaDevice
struct NvMediaDevice NvMediaDevice
An opaque handle representing an NvMediaDevice object.
Definition: nvmedia_core.h:348
NvMediaVersion
Holds NvMedia version information.
Definition: nvmedia_core.h:237
nvmedia_core.h
NVIDIA Media Interface: Core
NVMEDIA_SCRATCH_NUM_MEMORY_TYPES
@ NVMEDIA_SCRATCH_NUM_MEMORY_TYPES
Specifies the number of memory types.
Definition: nvmedia_cvscratchpad.h:51
NvMediaStatus
NvMediaStatus
Defines all possible error codes.
Definition: nvmedia_core.h:180
NvMediaCVScratchpadCreate
NvMediaCVScratchpad * NvMediaCVScratchpadCreate(NvMediaDevice *device, uint32_t size, NvMediaCVScratchMemoryAllocationType memoryType)
Creates an NvMedia CVScratchpad handle.
NvMediaCVScratchpadGetProperties
NvMediaStatus NvMediaCVScratchpadGetProperties(const NvMediaCVScratchpad *handle, uint32_t *size, NvMediaCVScratchMemoryAllocationType *memoryType)
Gets the size in bytes and memory location type of a CVScratchpad.
NvMediaCVScratchMemoryAllocationType
NvMediaCVScratchMemoryAllocationType
Specifies the type of memory that is allocated.
Definition: nvmedia_cvscratchpad.h:44