Perception Tool Kit (PTK) API Guide
api_memory_if.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2018 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 #if !defined(_API_MEMORY_IF_H_)
63 #define _API_MEMORY_IF_H_
64 
65 #include <stdint.h>
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 
76 #define PTK_API_MAX_MEM_BLK_REQ (8U)
77 
83 typedef enum
84 {
87 
90 
93 
95 
97 
103 typedef struct
104 {
106  uint32_t size;
107 
111  uint32_t align;
112 
116  uint32_t memType;
117 
119 
125 typedef struct
126 {
128  uint32_t numBlks;
129 
132 
134 
140 typedef struct
141 {
143  uint32_t size;
144 
147 
149  void * mem;
150 
152 
158 typedef struct
159 {
161  uint32_t numBlks;
162 
165 
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 
172 #endif /* !defined(_API_MEMORY_IF_H_) */
173 
Single memory block allocation response details.
Definition: api_memory_if.h:140
void * mem
Definition: api_memory_if.h:149
#define PTK_API_MAX_MEM_BLK_REQ
Maximum number of memory blocks per request.
Definition: api_memory_if.h:76
uint32_t memType
Definition: api_memory_if.h:116
uint32_t align
Definition: api_memory_if.h:111
uint32_t numBlks
Definition: api_memory_if.h:128
uint32_t numBlks
Definition: api_memory_if.h:161
PTK_Api_MemoryType memType
Definition: api_memory_if.h:146
Single memory block allocation request details.
Definition: api_memory_if.h:103
Definition: api_memory_if.h:92
Definition: api_memory_if.h:94
uint32_t size
Definition: api_memory_if.h:143
Definition: api_memory_if.h:89
API memory allocation response.
Definition: api_memory_if.h:158
uint32_t size
Definition: api_memory_if.h:106
API memory allocation request.
Definition: api_memory_if.h:125
Definition: api_memory_if.h:86
PTK_Api_MemoryType
Grid data type definition.
Definition: api_memory_if.h:83