1 /* 2 * Copyright (C) 2008 The Android Open Source Project 3 * Copyright (c) 2011-2015, 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 44 /* Non linear, Universal Bandwidth Compression */ 45 GRALLOC_USAGE_PRIVATE_ALLOC_UBWC = GRALLOC_USAGE_PRIVATE_1, 46 47 /* IOMMU heap comes from manually allocated pages, 48 * can be cached/uncached, is not secured */ 49 GRALLOC_USAGE_PRIVATE_IOMMU_HEAP = GRALLOC_USAGE_PRIVATE_2, 50 /* MM heap is a carveout heap for video, can be secured*/ 51 GRALLOC_USAGE_PRIVATE_MM_HEAP = GRALLOC_USAGE_PRIVATE_3, 52 /* ADSP heap is a carveout heap, is not secured*/ 53 GRALLOC_USAGE_PRIVATE_ADSP_HEAP = 0x01000000, 54 55 /* Set this for allocating uncached memory (using O_DSYNC) 56 * cannot be used with noncontiguous heaps */ 57 GRALLOC_USAGE_PRIVATE_UNCACHED = 0x02000000, 58 59 /* Buffer content should be displayed on an primary display only */ 60 GRALLOC_USAGE_PRIVATE_INTERNAL_ONLY = 0x04000000, 61 62 /* Buffer content should be displayed on an external display only */ 63 GRALLOC_USAGE_PRIVATE_EXTERNAL_ONLY = 0x08000000, 64 65 /* This flag is set for WFD usecase */ 66 GRALLOC_USAGE_PRIVATE_WFD = 0x00200000, 67 68 /* CAMERA heap is a carveout heap for camera, is not secured*/ 69 GRALLOC_USAGE_PRIVATE_CAMERA_HEAP = 0x00400000, 70 71 /* This flag is used for SECURE display usecase */ 72 GRALLOC_USAGE_PRIVATE_SECURE_DISPLAY = 0x00800000, 73 }; 74 75 /* define Gralloc perform */ 76 #define GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER 1 77 // This will be used by the graphics drivers to know if certain features 78 // are defined in this display HAL. 79 // Ex: Newer GFX libraries + Older Display HAL 80 #define GRALLOC_MODULE_PERFORM_GET_STRIDE 2 81 #define GRALLOC_MODULE_PERFORM_GET_CUSTOM_STRIDE_FROM_HANDLE 3 82 #define GRALLOC_MODULE_PERFORM_GET_CUSTOM_STRIDE_AND_HEIGHT_FROM_HANDLE 4 83 #define GRALLOC_MODULE_PERFORM_GET_ATTRIBUTES 5 84 #define GRALLOC_MODULE_PERFORM_GET_COLOR_SPACE_FROM_HANDLE 6 85 #define GRALLOC_MODULE_PERFORM_GET_YUV_PLANE_INFO 7 86 #define GRALLOC_MODULE_PERFORM_GET_MAP_SECURE_BUFFER_INFO 8 87 88 #define GRALLOC_HEAP_MASK (GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP |\ 89 GRALLOC_USAGE_PRIVATE_IOMMU_HEAP |\ 90 GRALLOC_USAGE_PRIVATE_MM_HEAP |\ 91 GRALLOC_USAGE_PRIVATE_ADSP_HEAP) 92 93 #define INTERLACE_MASK 0x80 94 #define S3D_FORMAT_MASK 0xFF000 95 /*****************************************************************************/ 96 97 /* OEM specific HAL formats */ 98 99 #define HAL_PIXEL_FORMAT_RGBA_5551 6 100 #define HAL_PIXEL_FORMAT_RGBA_4444 7 101 #define HAL_PIXEL_FORMAT_NV12_ENCODEABLE 0x102 102 #define HAL_PIXEL_FORMAT_YCbCr_420_SP_VENUS 0x7FA30C04 103 #define HAL_PIXEL_FORMAT_YCbCr_420_SP_TILED 0x7FA30C03 104 #define HAL_PIXEL_FORMAT_YCbCr_420_SP 0x109 105 #define HAL_PIXEL_FORMAT_YCrCb_420_SP_ADRENO 0x7FA30C01 106 #define HAL_PIXEL_FORMAT_YCrCb_422_SP 0x10B 107 #define HAL_PIXEL_FORMAT_R_8 0x10D 108 #define HAL_PIXEL_FORMAT_RG_88 0x10E 109 #define HAL_PIXEL_FORMAT_YCbCr_444_SP 0x10F 110 #define HAL_PIXEL_FORMAT_YCrCb_444_SP 0x110 111 #define HAL_PIXEL_FORMAT_YCrCb_422_I 0x111 112 #define HAL_PIXEL_FORMAT_BGRX_8888 0x112 113 #define HAL_PIXEL_FORMAT_NV21_ZSL 0x113 114 #define HAL_PIXEL_FORMAT_INTERLACE 0x180 115 116 //v4l2_fourcc('Y', 'U', 'Y', 'L'). 24 bpp YUYV 4:2:2 10 bit per component 117 #define HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT 0x4C595559 118 119 //v4l2_fourcc('Y', 'B', 'W', 'C'). 10 bit per component. This compressed 120 //format reduces the memory access bandwidth 121 #define HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT_COMPRESSED 0x43574259 122 123 // UBWC aligned Venus format 124 #define HAL_PIXEL_FORMAT_YCbCr_420_SP_VENUS_UBWC 0x7FA30C06 125 126 //Khronos ASTC formats 127 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_4x4_KHR 0x93B0 128 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x4_KHR 0x93B1 129 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x5_KHR 0x93B2 130 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x5_KHR 0x93B3 131 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x6_KHR 0x93B4 132 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x5_KHR 0x93B5 133 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x6_KHR 0x93B6 134 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x8_KHR 0x93B7 135 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x5_KHR 0x93B8 136 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x6_KHR 0x93B9 137 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x8_KHR 0x93BA 138 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x10_KHR 0x93BB 139 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x10_KHR 0x93BC 140 #define HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x12_KHR 0x93BD 141 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR 0x93D0 142 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR 0x93D1 143 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR 0x93D2 144 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR 0x93D3 145 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR 0x93D4 146 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR 0x93D5 147 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR 0x93D6 148 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR 0x93D7 149 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR 0x93D8 150 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR 0x93D9 151 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR 0x93DA 152 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR 0x93DB 153 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR 0x93DC 154 #define HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR 0x93DD 155 156 /* possible formats for 3D content*/ 157 enum { 158 HAL_NO_3D = 0x0000, 159 HAL_3D_IN_SIDE_BY_SIDE_L_R = 0x10000, 160 HAL_3D_IN_TOP_BOTTOM = 0x20000, 161 HAL_3D_IN_INTERLEAVE = 0x40000, 162 HAL_3D_IN_SIDE_BY_SIDE_R_L = 0x80000, 163 HAL_3D_OUT_SIDE_BY_SIDE = 0x1000, 164 HAL_3D_OUT_TOP_BOTTOM = 0x2000, 165 HAL_3D_OUT_INTERLEAVE = 0x4000, 166 HAL_3D_OUT_MONOSCOPIC = 0x8000 167 }; 168 169 enum { 170 BUFFER_TYPE_UI = 0, 171 BUFFER_TYPE_VIDEO 172 }; 173 174 /*****************************************************************************/ 175 176 #ifdef __cplusplus 177 struct private_handle_t : public native_handle { 178 #else 179 struct private_handle_t { 180 native_handle_t nativeHandle; 181 #endif 182 enum { 183 PRIV_FLAGS_FRAMEBUFFER = 0x00000001, 184 PRIV_FLAGS_USES_PMEM = 0x00000002, 185 PRIV_FLAGS_USES_PMEM_ADSP = 0x00000004, 186 PRIV_FLAGS_USES_ION = 0x00000008, 187 PRIV_FLAGS_USES_ASHMEM = 0x00000010, 188 PRIV_FLAGS_NEEDS_FLUSH = 0x00000020, 189 PRIV_FLAGS_NON_CPU_WRITER = 0x00000080, 190 PRIV_FLAGS_NONCONTIGUOUS_MEM = 0x00000100, 191 PRIV_FLAGS_CACHED = 0x00000200, 192 PRIV_FLAGS_SECURE_BUFFER = 0x00000400, 193 // For explicit synchronization 194 PRIV_FLAGS_UNSYNCHRONIZED = 0x00000800, 195 // Not mapped in userspace 196 PRIV_FLAGS_NOT_MAPPED = 0x00001000, 197 // Display on external only 198 PRIV_FLAGS_EXTERNAL_ONLY = 0x00002000, 199 // Set by HWC for protected non secure buffers 200 PRIV_FLAGS_PROTECTED_BUFFER = 0x00004000, 201 PRIV_FLAGS_VIDEO_ENCODER = 0x00010000, 202 PRIV_FLAGS_CAMERA_WRITE = 0x00020000, 203 PRIV_FLAGS_CAMERA_READ = 0x00040000, 204 PRIV_FLAGS_HW_COMPOSER = 0x00080000, 205 PRIV_FLAGS_HW_TEXTURE = 0x00100000, 206 PRIV_FLAGS_ITU_R_601 = 0x00200000, 207 PRIV_FLAGS_ITU_R_601_FR = 0x00400000, 208 PRIV_FLAGS_ITU_R_709 = 0x00800000, 209 PRIV_FLAGS_SECURE_DISPLAY = 0x01000000, 210 // Buffer is rendered in Tile Format 211 PRIV_FLAGS_TILE_RENDERED = 0x02000000, 212 // Buffer rendered using CPU/SW renderer 213 PRIV_FLAGS_CPU_RENDERED = 0x04000000, 214 // Buffer is allocated with UBWC alignment 215 PRIV_FLAGS_UBWC_ALIGNED = 0x08000000 216 }; 217 218 // file-descriptors 219 int fd; 220 int fd_metadata; // fd for the meta-data 221 // ints 222 int magic; 223 int flags; 224 unsigned int size; 225 unsigned int offset; 226 int bufferType; 227 uint64_t base __attribute__((aligned(8))); 228 unsigned int offset_metadata; 229 // The gpu address mapped into the mmu. 230 uint64_t gpuaddr __attribute__((aligned(8))); 231 int format; 232 int width; 233 int height; 234 235 int original_width; 236 int original_format; 237 int producer_usage; 238 int consumer_usage; 239 uint64_t backing_store __attribute__((aligned(8))); 240 241 uint64_t base_metadata __attribute__((aligned(8))); 242 243 #ifdef __cplusplus 244 static const int sNumFds = 2; sNumIntsprivate_handle_t245 static inline int sNumInts() { 246 return ((sizeof(private_handle_t) - sizeof(native_handle_t)) / 247 sizeof(int)) - sNumFds; 248 } 249 static const int sMagic = 'gmsm'; 250 251 private_handle_t(int fd, unsigned int size, int flags, int bufferType, 252 int format, int width, int height, int eFd = -1, 253 unsigned int eOffset = 0, uint64_t eBase = 0) : 254 fd(fd), fd_metadata(eFd), magic(sMagic), 255 flags(flags), size(size), offset(0), bufferType(bufferType), 256 base(0), offset_metadata(eOffset), gpuaddr(0), 257 format(format), width(width), height(height), 258 original_width(0), original_format(0), 259 producer_usage(0), consumer_usage(0), 260 backing_store(0), 261 base_metadata(eBase) 262 { 263 version = (int) sizeof(native_handle); 264 numInts = sNumInts(); 265 numFds = sNumFds; 266 } ~private_handle_tprivate_handle_t267 ~private_handle_t() { 268 magic = 0; 269 } 270 usesPhysicallyContiguousMemoryprivate_handle_t271 bool usesPhysicallyContiguousMemory() { 272 return (flags & PRIV_FLAGS_USES_PMEM) != 0; 273 } 274 validateprivate_handle_t275 static int validate(const native_handle* h) { 276 const private_handle_t* hnd = (const private_handle_t*)h; 277 if (!h || h->version != sizeof(native_handle) || 278 h->numInts != sNumInts() || h->numFds != sNumFds || 279 hnd->magic != sMagic) 280 { 281 ALOGD("Invalid gralloc handle (at %p): " 282 "ver(%d/%zu) ints(%d/%d) fds(%d/%d)" 283 "magic(%c%c%c%c/%c%c%c%c)", 284 h, 285 h ? h->version : -1, sizeof(native_handle), 286 h ? h->numInts : -1, sNumInts(), 287 h ? h->numFds : -1, sNumFds, 288 hnd ? (((hnd->magic >> 24) & 0xFF)? 289 ((hnd->magic >> 24) & 0xFF) : '-') : '?', 290 hnd ? (((hnd->magic >> 16) & 0xFF)? 291 ((hnd->magic >> 16) & 0xFF) : '-') : '?', 292 hnd ? (((hnd->magic >> 8) & 0xFF)? 293 ((hnd->magic >> 8) & 0xFF) : '-') : '?', 294 hnd ? (((hnd->magic >> 0) & 0xFF)? 295 ((hnd->magic >> 0) & 0xFF) : '-') : '?', 296 (sMagic >> 24) & 0xFF, 297 (sMagic >> 16) & 0xFF, 298 (sMagic >> 8) & 0xFF, 299 (sMagic >> 0) & 0xFF); 300 return -EINVAL; 301 } 302 return 0; 303 } 304 dynamicCastprivate_handle_t305 static private_handle_t* dynamicCast(const native_handle* in) { 306 if (validate(in) == 0) { 307 return (private_handle_t*) in; 308 } 309 return NULL; 310 } 311 #endif 312 }; 313 314 #endif /* GRALLOC_PRIV_H_ */ 315