1 /* 2 * Copyright (C) 2008 The Android Open Source Project 3 * Copyright (c) 2011-2014, The Linux Foundation. All rights reserved. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 #ifndef GRALLOC_PRIV_H_ 19 #define GRALLOC_PRIV_H_ 20 21 #include <stdint.h> 22 #include <limits.h> 23 #include <sys/cdefs.h> 24 #include <hardware/gralloc.h> 25 #include <pthread.h> 26 #include <errno.h> 27 #include <unistd.h> 28 29 #include <cutils/native_handle.h> 30 31 #include <cutils/log.h> 32 33 #define ROUND_UP_PAGESIZE(x) ( (((unsigned long)(x)) + PAGE_SIZE-1) & \ 34 (~(PAGE_SIZE-1)) ) 35 36 enum { 37 /* gralloc usage bits indicating the type 38 * of allocation that should be used */ 39 40 /* SYSTEM heap comes from kernel vmalloc, 41 * can never be uncached, is not secured*/ 42 GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP = GRALLOC_USAGE_PRIVATE_0, 43 /* SF heap is used for application buffers, is not secured */ 44 GRALLOC_USAGE_PRIVATE_UI_CONTIG_HEAP = GRALLOC_USAGE_PRIVATE_1, 45 /* IOMMU heap comes from manually allocated pages, 46 * can be cached/uncached, is not secured */ 47 GRALLOC_USAGE_PRIVATE_IOMMU_HEAP = GRALLOC_USAGE_PRIVATE_2, 48 /* MM heap is a carveout heap for video, can be secured*/ 49 GRALLOC_USAGE_PRIVATE_MM_HEAP = GRALLOC_USAGE_PRIVATE_3, 50 /* ADSP heap is a carveout heap, is not secured*/ 51 GRALLOC_USAGE_PRIVATE_ADSP_HEAP = 0x01000000, 52 53 /* Set this for allocating uncached memory (using O_DSYNC) 54 * cannot be used with noncontiguous heaps */ 55 GRALLOC_USAGE_PRIVATE_UNCACHED = 0x02000000, 56 57 /* Buffer content should be displayed on an primary display only */ 58 GRALLOC_USAGE_PRIVATE_INTERNAL_ONLY = 0x04000000, 59 60 /* Buffer content should be displayed on an external display only */ 61 GRALLOC_USAGE_PRIVATE_EXTERNAL_ONLY = 0x08000000, 62 63 /* This flag is set for WFD usecase */ 64 GRALLOC_USAGE_PRIVATE_WFD = 0x00200000, 65 66 /* CAMERA heap is a carveout heap for camera, is not secured*/ 67 GRALLOC_USAGE_PRIVATE_CAMERA_HEAP = 0x00400000, 68 69 /* This flag is used for SECURE display usecase */ 70 GRALLOC_USAGE_PRIVATE_SECURE_DISPLAY = 0x00800000, 71 }; 72 73 enum { 74 /* Gralloc perform enums 75 */ 76 GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER = 1, 77 // This will be deprecated from latest graphics drivers. This is kept 78 // for those backward compatibility i.e., newer Display HAL + older graphics 79 // libraries 80 GRALLOC_MODULE_PERFORM_GET_STRIDE, 81 GRALLOC_MODULE_PERFORM_GET_CUSTOM_STRIDE_FROM_HANDLE, 82 GRALLOC_MODULE_PERFORM_GET_CUSTOM_STRIDE_AND_HEIGHT_FROM_HANDLE, 83 GRALLOC_MODULE_PERFORM_GET_ATTRIBUTES, 84 GRALLOC_MODULE_PERFORM_GET_COLOR_SPACE_FROM_HANDLE, 85 GRALLOC_MODULE_PERFORM_GET_YUV_PLANE_INFO, 86 }; 87 88 #define GRALLOC_HEAP_MASK (GRALLOC_USAGE_PRIVATE_UI_CONTIG_HEAP |\ 89 GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP |\ 90 GRALLOC_USAGE_PRIVATE_IOMMU_HEAP |\ 91 GRALLOC_USAGE_PRIVATE_MM_HEAP |\ 92 GRALLOC_USAGE_PRIVATE_ADSP_HEAP) 93 94 #define INTERLACE_MASK 0x80 95 #define S3D_FORMAT_MASK 0xFF000 96 /*****************************************************************************/ 97 enum { 98 /* OEM specific HAL formats */ 99 HAL_PIXEL_FORMAT_RGBA_5551 = 6, 100 HAL_PIXEL_FORMAT_RGBA_4444 = 7, 101 HAL_PIXEL_FORMAT_NV12_ENCODEABLE = 0x102, 102 HAL_PIXEL_FORMAT_YCbCr_420_SP_VENUS = 0x7FA30C04, 103 HAL_PIXEL_FORMAT_YCbCr_420_SP_TILED = 0x7FA30C03, 104 HAL_PIXEL_FORMAT_YCbCr_420_SP = 0x109, 105 HAL_PIXEL_FORMAT_YCrCb_420_SP_ADRENO = 0x7FA30C01, 106 HAL_PIXEL_FORMAT_YCrCb_422_SP = 0x10B, 107 HAL_PIXEL_FORMAT_R_8 = 0x10D, 108 HAL_PIXEL_FORMAT_RG_88 = 0x10E, 109 HAL_PIXEL_FORMAT_YCbCr_444_SP = 0x10F, 110 HAL_PIXEL_FORMAT_YCrCb_444_SP = 0x110, 111 HAL_PIXEL_FORMAT_YCrCb_422_I = 0x111, 112 HAL_PIXEL_FORMAT_BGRX_8888 = 0x112, 113 HAL_PIXEL_FORMAT_NV21_ZSL = 0x113, 114 HAL_PIXEL_FORMAT_INTERLACE = 0x180, 115 //v4l2_fourcc('Y', 'U', 'Y', 'L'). 24 bpp YUYV 4:2:2 10 bit per component 116 HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT = 0x4C595559, 117 //v4l2_fourcc('Y', 'B', 'W', 'C'). 10 bit per component. This compressed 118 //format reduces the memory access bandwidth 119 HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT_COMPRESSED = 0x43574259, 120 121 //Khronos ASTC formats 122 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_4x4_KHR = 0x93B0, 123 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x4_KHR = 0x93B1, 124 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x5_KHR = 0x93B2, 125 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x5_KHR = 0x93B3, 126 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x6_KHR = 0x93B4, 127 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x5_KHR = 0x93B5, 128 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x6_KHR = 0x93B6, 129 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x8_KHR = 0x93B7, 130 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x5_KHR = 0x93B8, 131 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x6_KHR = 0x93B9, 132 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x8_KHR = 0x93BA, 133 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x10_KHR = 0x93BB, 134 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x10_KHR = 0x93BC, 135 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x12_KHR = 0x93BD, 136 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR = 0x93D0, 137 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR = 0x93D1, 138 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR = 0x93D2, 139 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR = 0x93D3, 140 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR = 0x93D4, 141 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR = 0x93D5, 142 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR = 0x93D6, 143 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR = 0x93D7, 144 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR = 0x93D8, 145 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR = 0x93D9, 146 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR = 0x93DA, 147 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR = 0x93DB, 148 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR = 0x93DC, 149 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR = 0x93DD, 150 }; 151 152 /* possible formats for 3D content*/ 153 enum { 154 HAL_NO_3D = 0x0000, 155 HAL_3D_IN_SIDE_BY_SIDE_L_R = 0x10000, 156 HAL_3D_IN_TOP_BOTTOM = 0x20000, 157 HAL_3D_IN_INTERLEAVE = 0x40000, 158 HAL_3D_IN_SIDE_BY_SIDE_R_L = 0x80000, 159 HAL_3D_OUT_SIDE_BY_SIDE = 0x1000, 160 HAL_3D_OUT_TOP_BOTTOM = 0x2000, 161 HAL_3D_OUT_INTERLEAVE = 0x4000, 162 HAL_3D_OUT_MONOSCOPIC = 0x8000 163 }; 164 165 enum { 166 BUFFER_TYPE_UI = 0, 167 BUFFER_TYPE_VIDEO 168 }; 169 170 /*****************************************************************************/ 171 172 #ifdef __cplusplus 173 struct private_handle_t : public native_handle { 174 #else 175 struct private_handle_t { 176 native_handle_t nativeHandle; 177 #endif 178 enum { 179 PRIV_FLAGS_FRAMEBUFFER = 0x00000001, 180 PRIV_FLAGS_USES_PMEM = 0x00000002, 181 PRIV_FLAGS_USES_PMEM_ADSP = 0x00000004, 182 PRIV_FLAGS_USES_ION = 0x00000008, 183 PRIV_FLAGS_USES_ASHMEM = 0x00000010, 184 PRIV_FLAGS_NEEDS_FLUSH = 0x00000020, 185 PRIV_FLAGS_INTERNAL_ONLY = 0x00000040, 186 PRIV_FLAGS_NON_CPU_WRITER = 0x00000080, 187 PRIV_FLAGS_NONCONTIGUOUS_MEM = 0x00000100, 188 PRIV_FLAGS_CACHED = 0x00000200, 189 PRIV_FLAGS_SECURE_BUFFER = 0x00000400, 190 // For explicit synchronization 191 PRIV_FLAGS_UNSYNCHRONIZED = 0x00000800, 192 // Not mapped in userspace 193 PRIV_FLAGS_NOT_MAPPED = 0x00001000, 194 // Display on external only 195 PRIV_FLAGS_EXTERNAL_ONLY = 0x00002000, 196 PRIV_FLAGS_VIDEO_ENCODER = 0x00010000, 197 PRIV_FLAGS_CAMERA_WRITE = 0x00020000, 198 PRIV_FLAGS_CAMERA_READ = 0x00040000, 199 PRIV_FLAGS_HW_COMPOSER = 0x00080000, 200 PRIV_FLAGS_HW_TEXTURE = 0x00100000, 201 PRIV_FLAGS_ITU_R_601 = 0x00200000, 202 PRIV_FLAGS_ITU_R_601_FR = 0x00400000, 203 PRIV_FLAGS_ITU_R_709 = 0x00800000, 204 PRIV_FLAGS_SECURE_DISPLAY = 0x01000000, 205 // Buffer is rendered in Tile Format 206 PRIV_FLAGS_TILE_RENDERED = 0x02000000, 207 // Buffer rendered using CPU/SW renderer 208 PRIV_FLAGS_CPU_RENDERED = 0x04000000 209 }; 210 211 // file-descriptors 212 int fd; 213 int fd_metadata; // fd for the meta-data 214 // ints 215 int magic; 216 int flags; 217 unsigned int size; 218 unsigned int offset; 219 int bufferType; 220 uint64_t base __attribute__((aligned(8))); 221 unsigned int offset_metadata; 222 // The gpu address mapped into the mmu. 223 uint64_t gpuaddr __attribute__((aligned(8))); 224 int format; 225 int width; 226 int height; 227 uint64_t base_metadata __attribute__((aligned(8))); 228 229 #ifdef __cplusplus 230 static const int sNumFds = 2; sNumIntsprivate_handle_t231 static inline int sNumInts() { 232 return ((sizeof(private_handle_t) - sizeof(native_handle_t)) / 233 sizeof(int)) - sNumFds; 234 } 235 static const int sMagic = 'gmsm'; 236 237 private_handle_t(int fd, unsigned int size, int flags, int bufferType, 238 int format, int width, int height, int eFd = -1, 239 unsigned int eOffset = 0, uint64_t eBase = 0) : fdprivate_handle_t240 fd(fd), fd_metadata(eFd), magic(sMagic), 241 flags(flags), size(size), offset(0), bufferType(bufferType), 242 base(0), offset_metadata(eOffset), gpuaddr(0), 243 format(format), width(width), height(height), 244 base_metadata(eBase) 245 { 246 version = (int) sizeof(native_handle); 247 numInts = sNumInts(); 248 numFds = sNumFds; 249 } ~private_handle_tprivate_handle_t250 ~private_handle_t() { 251 base_metadata = 0; 252 magic = 0; 253 fd_metadata = 0; 254 } 255 usesPhysicallyContiguousMemoryprivate_handle_t256 bool usesPhysicallyContiguousMemory() { 257 return (flags & PRIV_FLAGS_USES_PMEM) != 0; 258 } 259 validateprivate_handle_t260 static int validate(const native_handle* h) { 261 const private_handle_t* hnd = (const private_handle_t*)h; 262 if (!h || h->version != sizeof(native_handle) || 263 h->numInts != sNumInts() || h->numFds != sNumFds || 264 hnd->magic != sMagic) 265 { 266 ALOGE("Invalid gralloc handle (at %p): " 267 "ver(%d/%zu) ints(%d/%d) fds(%d/%d)" 268 "magic(%c%c%c%c/%c%c%c%c)", 269 h, 270 h ? h->version : -1, sizeof(native_handle), 271 h ? h->numInts : -1, sNumInts(), 272 h ? h->numFds : -1, sNumFds, 273 hnd ? (((hnd->magic >> 24) & 0xFF)? 274 ((hnd->magic >> 24) & 0xFF) : '-') : '?', 275 hnd ? (((hnd->magic >> 16) & 0xFF)? 276 ((hnd->magic >> 16) & 0xFF) : '-') : '?', 277 hnd ? (((hnd->magic >> 8) & 0xFF)? 278 ((hnd->magic >> 8) & 0xFF) : '-') : '?', 279 hnd ? (((hnd->magic >> 0) & 0xFF)? 280 ((hnd->magic >> 0) & 0xFF) : '-') : '?', 281 (sMagic >> 24) & 0xFF, 282 (sMagic >> 16) & 0xFF, 283 (sMagic >> 8) & 0xFF, 284 (sMagic >> 0) & 0xFF); 285 return -EINVAL; 286 } 287 return 0; 288 } 289 dynamicCastprivate_handle_t290 static private_handle_t* dynamicCast(const native_handle* in) { 291 if (validate(in) == 0) { 292 return (private_handle_t*) in; 293 } 294 return NULL; 295 } 296 #endif 297 }; 298 299 #endif /* GRALLOC_PRIV_H_ */ 300