1 /*
2  * Copyright (c) 2011-2016,2018-2019, 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 template <class Type1, class Type2>
ALIGN(Type1 x,Type2 align)67 inline Type1 ALIGN(Type1 x, Type2 align) {
68   return (Type1)((x + (Type1)align - 1) & ~((Type1)align - 1));
69 }
70 
71 enum PlaneComponent {
72   /* luma */
73   PLANE_COMPONENT_Y = 1 << 0,
74   /* chroma blue */
75   PLANE_COMPONENT_Cb = 1 << 1,
76   /* chroma red */
77   PLANE_COMPONENT_Cr = 1 << 2,
78 
79   /* red */
80   PLANE_COMPONENT_R = 1 << 10,
81   /* green */
82   PLANE_COMPONENT_G = 1 << 11,
83   /* blue */
84   PLANE_COMPONENT_B = 1 << 12,
85 
86   /* alpha */
87   PLANE_COMPONENT_A = 1 << 20,
88 
89   /* raw data plane */
90   PLANE_COMPONENT_RAW = 1 << 30,
91 
92   /* meta information plane */
93   PLANE_COMPONENT_META = 1 << 31,
94 };
95 
96 struct PlaneLayoutInfo {
97   /** Components represented the type of plane. */
98   PlaneComponent component;
99 
100   /** horizontal subsampling. Must be a positive power of 2. */
101   uint32_t h_subsampling;
102 
103   /** vertical subsampling. Must be a positive power of 2. */
104   uint32_t v_subsampling;
105 
106   /** offset to the first byte of the top-left pixel of the plane
107    *  and it is calculated from the start of the buffer.
108    *  Add base of the handle with offset to get the first byte of the plane.
109    */
110   uint32_t offset;
111 
112   /** step is the distance in bytes from one pixel value to the next. */
113   int32_t step;
114 
115   /** stride of the plane in pixels */
116   int32_t stride;
117 
118   /** stride of the plane in in bytes */
119   int32_t stride_bytes;
120 
121   /** plane height or vertical stride */
122   int32_t scanlines;
123 
124   /** size of the plane in bytes */
125   uint32_t size;
126 };
127 
128 bool IsYuvFormat(int format);
129 bool IsCompressedRGBFormat(int format);
130 bool IsUncompressedRGBFormat(int format);
131 uint32_t GetBppForUncompressedRGB(int format);
132 bool CpuCanAccess(uint64_t usage);
133 bool CpuCanRead(uint64_t usage);
134 bool CpuCanWrite(uint64_t usage);
135 int GetBpp(int format);
136 unsigned int GetSize(const BufferInfo &d, unsigned int alignedw, unsigned int alignedh);
137 int GetBufferSizeAndDimensions(const BufferInfo &d, unsigned int *size, unsigned int *alignedw,
138                                unsigned int *alignedh);
139 int GetBufferSizeAndDimensions(const BufferInfo &d, unsigned int *size, unsigned int *alignedw,
140                                unsigned int *alignedh, GraphicsMetadata *graphics_metadata);
141 void GetCustomDimensions(private_handle_t *hnd, int *stride, int *height);
142 void GetColorSpaceFromMetadata(private_handle_t *hnd, int *color_space);
143 void GetAlignedWidthAndHeight(const BufferInfo &d, unsigned int *aligned_w,
144                               unsigned int *aligned_h);
145 int GetYUVPlaneInfo(const private_handle_t *hnd, struct android_ycbcr ycbcr[2]);
146 int GetYUVPlaneInfo(const BufferInfo &info, int32_t format, int32_t width, int32_t height,
147                     int32_t flags, int *plane_count, PlaneLayoutInfo plane_info[8]);
148 void GetRGBPlaneInfo(const BufferInfo &info, int32_t format, int32_t width, int32_t height,
149                      int32_t flags, int *plane_count, PlaneLayoutInfo *plane_info);
150 unsigned int GetRgbMetaSize(int format, uint32_t width, uint32_t height, uint64_t usage);
151 void GetYuvSubSamplingFactor(int32_t format, int *h_subsampling, int *v_subsampling);
152 void CopyPlaneLayoutInfotoAndroidYcbcr(uint64_t base, int plane_count, PlaneLayoutInfo *plane_info,
153                                        struct android_ycbcr *ycbcr);
154 int GetRgbDataAddress(private_handle_t *hnd, void **rgb_data);
155 bool IsUBwcFormat(int format);
156 bool IsUBwcSupported(int format);
157 bool IsUBwcPISupported(int format, uint64_t usage);
158 bool IsUBwcEnabled(int format, uint64_t usage);
159 void GetYuvUBwcWidthAndHeight(int width, int height, int format, unsigned int *aligned_w,
160                               unsigned int *aligned_h);
161 void GetYuvSPPlaneInfo(const BufferInfo &info, int format, uint32_t width, uint32_t height,
162                        uint32_t bpp, PlaneLayoutInfo *plane_info);
163 void GetYuvUbwcSPPlaneInfo(uint32_t width, uint32_t height, int color_format,
164                            PlaneLayoutInfo *plane_info);
165 void GetYuvUbwcInterlacedSPPlaneInfo(uint32_t width, uint32_t height,
166                                      PlaneLayoutInfo plane_info[8]);
167 void GetRgbUBwcBlockSize(uint32_t bpp, int *block_width, int *block_height);
168 unsigned int GetRgbUBwcMetaBufferSize(int width, int height, uint32_t bpp);
169 unsigned int GetUBwcSize(int width, int height, int format, unsigned int alignedw,
170                          unsigned int alignedh);
171 int GetBufferLayout(private_handle_t *hnd, uint32_t stride[4], uint32_t offset[4],
172                     uint32_t *num_planes);
173 uint32_t GetDataAlignment(int format, uint64_t usage);
174 int GetGpuResourceSizeAndDimensions(const BufferInfo &info, unsigned int *size,
175                                     unsigned int *alignedw, unsigned int *alignedh,
176                                     GraphicsMetadata *graphics_metadata);
177 bool CanUseAdrenoForSize(int buffer_type, uint64_t usage);
178 bool GetAdrenoSizeAPIStatus();
179 bool UseUncached(int format, uint64_t usage);
180 uint64_t GetHandleFlags(int format, uint64_t usage);
181 int GetImplDefinedFormat(uint64_t usage, int format);
182 int GetCustomFormatFlags(int format, uint64_t usage, int *custom_format, uint64_t *priv_flags);
183 int GetBufferType(int inputFormat);
184 bool IsGPUFlagSupported(uint64_t usage);
185 bool HasAlphaComponent(int32_t format);
186 }  // namespace gralloc
187 
188 #endif  // __GR_UTILS_H__
189