1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/*
* Copyright (C) 2020 ARM Limited. All rights reserved.
*
* Copyright 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef GRALLOC_COMMON_MAPPER_H
#define GRALLOC_COMMON_MAPPER_H
#include <inttypes.h>
#include "mali_gralloc_log.h"
#include "core/mali_gralloc_bufferdescriptor.h"
#include "4.x/gralloc_mapper_hidl_header.h"
namespace arm
{
namespace mapper
{
namespace common
{
using android::hardware::hidl_handle;
using android::hardware::hidl_vec;
using android::hardware::Void;
/**
* Imports a raw buffer handle to create an imported buffer handle for use with
* the rest of the mapper or with other in-process libraries.
*
* @param rawHandle [in] Raw buffer handle to import.
* @param hidl_cb [in] HIDL Callback function to export output information
* @param hidl_cb [in] HIDL callback function generating -
* error : NONE upon success. Otherwise,
* BAD_BUFFER for an invalid buffer
* NO_RESOURCES when the raw handle cannot be imported
* BAD_VALUE when any of the specified attributes are invalid
* buffer : Imported buffer handle
*/
void importBuffer(const hidl_handle &rawHandle, IMapper::importBuffer_cb hidl_cb);
/**
* Frees a buffer handle and releases all the resources associated with it
*
* @param buffer [in] Imported buffer to free
*
* @return Error::BAD_BUFFER for an invalid buffer / when failed to free the buffer
* Error::NONE on successful free
*/
Error freeBuffer(void *buffer);
/**
* Locks the given buffer for the specified CPU usage.
*
* @param buffer [in] Buffer to lock
* @param cpuUsage [in] Specifies one or more CPU usage flags to request
* @param accessRegion [in] Portion of the buffer that the client intends to access
* @param acquireFence [in] Handle for aquire fence object
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE upon success. Otherwise,
* BAD_BUFFER for an invalid buffer
* BAD_VALUE for an invalid input parameters
* data: CPU-accessible pointer to the buffer data
* bytesPerPixel: v3.X Only. Number of bytes per pixel in the buffer
* bytesPerStride: v3.X Only. Bytes per stride of the buffer
*/
void lock(void *buffer, uint64_t cpuUsage, const IMapper::Rect &accessRegion, const hidl_handle &acquireFence,
IMapper::lock_cb hidl_cb);
/**
* Unlocks a buffer to indicate all CPU accesses to the buffer have completed
*
* @param buffer [in] Buffer to lock.
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE upon success. Otherwise,
* BAD_BUFFER for an invalid buffer
* releaseFence: Referrs to a sync fence object
*/
void unlock(void *buffer, IMapper::unlock_cb hidl_cb);
/**
* Validates the buffer against specified descriptor attributes
*
* @param buffer [in] Buffer which needs to be validated.
* @param descriptorInfo [in] Required attributes of the buffer
* @param in_stride [in] Buffer stride returned by IAllocator::allocate,
* or zero if unknown.
*
* @return Error::NONE upon success. Otherwise,
* Error::BAD_BUFFER upon bad buffer input
* Error::BAD_VALUE when any of the specified attributes are invalid
*/
Error validateBufferSize(void *buffer, const IMapper::BufferDescriptorInfo &descriptorInfo, uint32_t stride);
/**
* Get the transport size of a buffer
*
* @param buffer [in] Buffer for computing transport size
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE upon success. Otherwise,
* BAD_BUFFER for an invalid buffer
* numFds: Number of file descriptors needed for transport
* numInts: Number of integers needed for transport
*/
void getTransportSize(void *buffer, IMapper::getTransportSize_cb hidl_cb);
/**
* Test whether the given BufferDescriptorInfo is allocatable.
*
* @param description [in] Description for the buffer
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE, for supported description
* BAD_VALUE, Otherwise,
* supported: Whether the description can be allocated
*/
void isSupported(const IMapper::BufferDescriptorInfo &description, IMapper::isSupported_cb hidl_cb);
/* TODO: implement this feature for exynos */
/**
* Flushes the CPU caches of a mapped buffer.
*
* @param buffer [in] Locked buffer which needs to have CPU caches flushed.
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE upon success. Otherwise, BAD_BUFFER for an invalid buffer or a buffer that
* has not been locked.
* releaseFence: Empty fence signaling completion as all work is completed within the call.
*/
void flushLockedBuffer(void *buffer, IMapper::flushLockedBuffer_cb hidl_cb);
/* TODO: implement this feature for exynos */
/**
* Invalidates the CPU caches of a mapped buffer.
*
* @param buffer [in] Locked buffer which needs to have CPU caches invalidated.
*
* @return Error::NONE upon success.
* Error::BAD_BUFFER for an invalid buffer or a buffer that has not been locked.
*/
Error rereadLockedBuffer(void *buffer);
/**
* Retrieves a Buffer's metadata value.
*
* @param buffer [in] The buffer to query for metadata.
* @param metadataType [in] The type of metadata queried.
* @param hidl_cb [in] HIDL callback function generating -
* error: NONE on success.
* BAD_BUFFER on invalid buffer argument.
* UNSUPPORTED on error when reading or unsupported metadata type.
* metadata: Vector of bytes representing the metadata value.
*/
void get(void *buffer, const IMapper::MetadataType &metadataType, IMapper::get_cb hidl_cb);
/**
* Sets a Buffer's metadata value.
*
* @param buffer [in] The buffer for which to modify metadata.
* @param metadataType [in] The type of metadata to modify.
* @param metadata [in] Vector of bytes representing the new value for the metadata associated with the buffer.
*
* @return Error::NONE on success.
* Error::BAD_BUFFER on invalid buffer argument.
* Error::UNSUPPORTED on error when writing or unsupported metadata type.
*/
Error set(void *buffer, const IMapper::MetadataType &metadataType, const hidl_vec<uint8_t> &metadata);
/**
* Lists all the MetadataTypes supported by IMapper as well as a description
* of each supported MetadataType. For StandardMetadataTypes, the description
* string can be left empty.
*
* @param hidl_cb [in] HIDL callback function generating -
* error: Error status of the call, which may be
* - NONE upon success.
* - NO_RESOURCES if the get cannot be fullfilled due to unavailability of
* resources.
* descriptions: vector of MetadataTypeDescriptions that represent the
* MetadataTypes supported by the device.
*/
void listSupportedMetadataTypes(IMapper::listSupportedMetadataTypes_cb hidl_cb);
/**
* Dumps a buffer's metadata.
*
* @param buffer [in] Buffer that is being dumped
* @param hidl_cb [in] HIDL callback function generating -
* error: Error status of the call, which may be
* - NONE upon success.
* - BAD_BUFFER if the raw handle is invalid.
* - NO_RESOURCES if the get cannot be fullfilled due to unavailability of
* resources.
* bufferDump: Struct representing the metadata being dumped
*/
void dumpBuffer(void *buffer, IMapper::dumpBuffer_cb hidl_cb);
/**
* Dumps the metadata for all the buffers in the current process.
*
* @param hidl_cb [in] HIDL callback function generating -
* error: Error status of the call, which may be
* - NONE upon success.
* - NO_RESOURCES if the get cannot be fullfilled due to unavailability of
* resources.
* bufferDumps: Vector of structs representing the buffers being dumped
*/
void dumpBuffers(IMapper::dumpBuffers_cb hidl_cb);
/**
* Returns the region of shared memory associated with the buffer that is
* reserved for client use.
*
* The shared memory may be allocated from any shared memory allocator.
* The shared memory must be CPU-accessible and virtually contiguous. The
* starting address must be word-aligned.
*
* This function may only be called after importBuffer() has been called by the
* client. The reserved region must remain accessible until freeBuffer() has
* been called. After freeBuffer() has been called, the client must not access
* the reserved region.
*
* This reserved memory may be used in future versions of Android to
* help clients implement backwards compatible features without requiring
* IAllocator/IMapper updates.
*
* @param buffer Imported buffer handle.
* @param hidl_cb [in] HIDL callback function generating -
* error: Error status of the call, which may be
* - NONE upon success.
* - BAD_BUFFER if the buffer is invalid.
* reservedRegion: CPU-accessible pointer to the reserved region
* reservedSize: the size of the reservedRegion that was requested
* in the BufferDescriptorInfo.
*/
void getReservedRegion(void *buffer, IMapper::getReservedRegion_cb _hidl_cb);
} // namespace common
} // namespace mapper
} // namespace arm
#endif /* GRALLOC_COMMON_MAPPER_H */
|
