1 /*
2 * Copyright (c) 2011-2016,2018-2020, The Linux Foundation. All rights reserved.
3
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution.
13 * * Neither the name of The Linux Foundation nor the names of its
14 * contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef __GR_UTILS_H__
31 #define __GR_UTILS_H__
32
33 #include <android/hardware/graphics/common/1.2/types.h>
34 #include "gralloc_priv.h"
35 #include "qdMetaData.h"
36
37 #define SZ_2M 0x200000
38 #define SZ_1M 0x100000
39 #define SZ_4K 0x1000
40
41 #define SIZE_4K 4096
42 #define SIZE_8K 8192
43
44 #ifdef SLAVE_SIDE_CP
45 #define SECURE_ALIGN SZ_1M
46 #else // MASTER_SIDE_CP
47 #define SECURE_ALIGN SZ_4K
48 #endif
49
50 #define INT(exp) static_cast<int>(exp)
51 #define UINT(exp) static_cast<unsigned int>(exp)
52
53 using android::hardware::graphics::common::V1_1::BufferUsage;
54
55 namespace gralloc {
56 struct BufferInfo {
57 BufferInfo(int w, int h, int f, uint64_t usage = 0)
widthBufferInfo58 : width(w), height(h), format(f), layer_count(1), usage(usage) {}
59 int width;
60 int height;
61 int format;
62 int layer_count;
63 uint64_t usage;
64 };
65
66 struct GrallocProperties {
67 bool use_system_heap_for_sensors = true;
68 bool ubwc_disable = false;
69 bool ahardware_buffer_disable = false;
70 };
71
72 template <class Type1, class Type2>
ALIGN(Type1 x,Type2 align)73 inline Type1 ALIGN(Type1 x, Type2 align) {
74 return (Type1)((x + (Type1)align - 1) & ~((Type1)align - 1));
75 }
76
77 enum class Error : int32_t {
78 /**
79 * No error.
80 */
81 NONE = 0,
82 /**
83 * Invalid BufferDescriptor.
84 */
85 BAD_DESCRIPTOR = 1,
86 /**
87 * Invalid buffer handle.
88 */
89 BAD_BUFFER = 2,
90 /**
91 * Invalid HardwareBufferDescription.
92 */
93 BAD_VALUE = 3,
94 /**
95 * Resource unavailable.
96 */
97 NO_RESOURCES = 5,
98 /**
99 * Permanent failure.
100 */
101 UNSUPPORTED = 7,
102 };
103
104 enum PlaneComponent {
105 /* luma */
106 PLANE_COMPONENT_Y = 1 << 0,
107 /* chroma blue */
108 PLANE_COMPONENT_Cb = 1 << 1,
109 /* chroma red */
110 PLANE_COMPONENT_Cr = 1 << 2,
111
112 /* red */
113 PLANE_COMPONENT_R = 1 << 10,
114 /* green */
115 PLANE_COMPONENT_G = 1 << 11,
116 /* blue */
117 PLANE_COMPONENT_B = 1 << 12,
118
119 /* alpha */
120 PLANE_COMPONENT_A = 1 << 20,
121
122 /* raw data plane */
123 PLANE_COMPONENT_RAW = 1 << 30,
124
125 /* meta information plane */
126 PLANE_COMPONENT_META = 1 << 31,
127 };
128
129 struct PlaneLayoutInfo {
130 /** Components represented the type of plane. */
131 PlaneComponent component;
132
133 /** horizontal subsampling. Must be a positive power of 2. */
134 uint32_t h_subsampling;
135
136 /** vertical subsampling. Must be a positive power of 2. */
137 uint32_t v_subsampling;
138
139 /** offset to the first byte of the top-left pixel of the plane
140 * and it is calculated from the start of the buffer.
141 * Add base of the handle with offset to get the first byte of the plane.
142 */
143 uint32_t offset;
144
145 /** step is the distance in bytes from one pixel value to the next. */
146 int32_t step;
147
148 /** stride of the plane in pixels */
149 int32_t stride;
150
151 /** stride of the plane in in bytes */
152 int32_t stride_bytes;
153
154 /** plane height or vertical stride */
155 int32_t scanlines;
156
157 /** size of the plane in bytes */
158 uint32_t size;
159 };
160
161 bool IsYuvFormat(int format);
162 bool IsCompressedRGBFormat(int format);
163 bool IsUncompressedRGBFormat(int format);
164 uint32_t GetBppForUncompressedRGB(int format);
165 bool CpuCanAccess(uint64_t usage);
166 bool CpuCanRead(uint64_t usage);
167 bool CpuCanWrite(uint64_t usage);
168 int GetBpp(int format);
169 unsigned int GetSize(const BufferInfo &d, unsigned int alignedw, unsigned int alignedh);
170 int GetBufferSizeAndDimensions(const BufferInfo &d, unsigned int *size, unsigned int *alignedw,
171 unsigned int *alignedh);
172 int GetBufferSizeAndDimensions(const BufferInfo &d, unsigned int *size, unsigned int *alignedw,
173 unsigned int *alignedh, GraphicsMetadata *graphics_metadata);
174 void GetCustomDimensions(private_handle_t *hnd, int *stride, int *height);
175 void GetColorSpaceFromMetadata(private_handle_t *hnd, int *color_space);
176 void GetAlignedWidthAndHeight(const BufferInfo &d, unsigned int *aligned_w,
177 unsigned int *aligned_h);
178 int GetYUVPlaneInfo(const private_handle_t *hnd, struct android_ycbcr ycbcr[2]);
179 int GetYUVPlaneInfo(const BufferInfo &info, int32_t format, int32_t width, int32_t height,
180 int32_t flags, int *plane_count, PlaneLayoutInfo plane_info[8]);
181 void GetRGBPlaneInfo(const BufferInfo &info, int32_t format, int32_t width, int32_t height,
182 int32_t flags, int *plane_count, PlaneLayoutInfo *plane_info);
183 unsigned int GetRgbMetaSize(int format, uint32_t width, uint32_t height, uint64_t usage);
184 void GetYuvSubSamplingFactor(int32_t format, int *h_subsampling, int *v_subsampling);
185 void CopyPlaneLayoutInfotoAndroidYcbcr(uint64_t base, int plane_count, PlaneLayoutInfo *plane_info,
186 struct android_ycbcr *ycbcr);
187 int GetRgbDataAddress(private_handle_t *hnd, void **rgb_data);
188 bool IsUBwcFormat(int format);
189 bool IsUBwcSupported(int format);
190 bool IsUBwcPISupported(int format, uint64_t usage);
191 bool IsUBwcEnabled(int format, uint64_t usage);
192 bool IsCameraCustomFormat(int format);
193 void GetYuvUBwcWidthAndHeight(int width, int height, int format, unsigned int *aligned_w,
194 unsigned int *aligned_h);
195 void GetYuvSPPlaneInfo(const BufferInfo &info, int format, uint32_t width, uint32_t height,
196 uint32_t bpp, PlaneLayoutInfo *plane_info);
197 void GetYuvUbwcSPPlaneInfo(uint32_t width, uint32_t height, int color_format,
198 PlaneLayoutInfo *plane_info);
199 void GetYuvUbwcInterlacedSPPlaneInfo(uint32_t width, uint32_t height,
200 PlaneLayoutInfo plane_info[8]);
201 void GetRgbUBwcBlockSize(uint32_t bpp, int *block_width, int *block_height);
202 unsigned int GetRgbUBwcMetaBufferSize(int width, int height, uint32_t bpp);
203 unsigned int GetUBwcSize(int width, int height, int format, unsigned int alignedw,
204 unsigned int alignedh);
205 int GetBufferLayout(private_handle_t *hnd, uint32_t stride[4], uint32_t offset[4],
206 uint32_t *num_planes);
207 uint32_t GetDataAlignment(int format, uint64_t usage);
208 int GetGpuResourceSizeAndDimensions(const BufferInfo &info, unsigned int *size,
209 unsigned int *alignedw, unsigned int *alignedh,
210 GraphicsMetadata *graphics_metadata);
211 bool CanUseAdrenoForSize(int buffer_type, uint64_t usage);
212 bool GetAdrenoSizeAPIStatus();
213 bool UseUncached(int format, uint64_t usage);
214 uint64_t GetHandleFlags(int format, uint64_t usage);
215 int GetImplDefinedFormat(uint64_t usage, int format);
216 int GetCustomFormatFlags(int format, uint64_t usage, int *custom_format, uint64_t *priv_flags);
217 int GetBufferType(int inputFormat);
218 bool IsGPUFlagSupported(uint64_t usage);
219 bool HasAlphaComponent(int32_t format);
220
221 void GetDRMFormat(uint32_t format, uint32_t flags, uint32_t *drm_format,
222 uint64_t *drm_format_modifier);
223 bool CanAllocateZSLForSecureCamera();
224 } // namespace gralloc
225
226 #endif // __GR_UTILS_H__
227