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 36enum { 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 73enum { 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/*****************************************************************************/ 97enum { 98 /* OEM specific HAL formats */ 99 HAL_PIXEL_FORMAT_NV12_ENCODEABLE = 0x102, 100 HAL_PIXEL_FORMAT_YCbCr_420_SP_VENUS = 0x7FA30C04, 101 HAL_PIXEL_FORMAT_YCbCr_420_SP_TILED = 0x7FA30C03, 102 HAL_PIXEL_FORMAT_YCbCr_420_SP = 0x109, 103 HAL_PIXEL_FORMAT_YCrCb_420_SP_ADRENO = 0x7FA30C01, 104 HAL_PIXEL_FORMAT_YCrCb_422_SP = 0x10B, 105 HAL_PIXEL_FORMAT_R_8 = 0x10D, 106 HAL_PIXEL_FORMAT_RG_88 = 0x10E, 107 HAL_PIXEL_FORMAT_YCbCr_444_SP = 0x10F, 108 HAL_PIXEL_FORMAT_YCrCb_444_SP = 0x110, 109 HAL_PIXEL_FORMAT_YCrCb_422_I = 0x111, 110 HAL_PIXEL_FORMAT_BGRX_8888 = 0x112, 111 HAL_PIXEL_FORMAT_NV21_ZSL = 0x113, 112 HAL_PIXEL_FORMAT_INTERLACE = 0x180, 113 //v4l2_fourcc('Y', 'U', 'Y', 'L'). 24 bpp YUYV 4:2:2 10 bit per component 114 HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT = 0x4C595559, 115 //v4l2_fourcc('Y', 'B', 'W', 'C'). 10 bit per component. This compressed 116 //format reduces the memory access bandwidth 117 HAL_PIXEL_FORMAT_YCbCr_422_I_10BIT_COMPRESSED = 0x43574259, 118 119 //Khronos ASTC formats 120 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_4x4_KHR = 0x93B0, 121 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x4_KHR = 0x93B1, 122 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_5x5_KHR = 0x93B2, 123 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x5_KHR = 0x93B3, 124 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_6x6_KHR = 0x93B4, 125 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x5_KHR = 0x93B5, 126 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x6_KHR = 0x93B6, 127 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_8x8_KHR = 0x93B7, 128 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x5_KHR = 0x93B8, 129 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x6_KHR = 0x93B9, 130 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x8_KHR = 0x93BA, 131 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_10x10_KHR = 0x93BB, 132 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x10_KHR = 0x93BC, 133 HAL_PIXEL_FORMAT_COMPRESSED_RGBA_ASTC_12x12_KHR = 0x93BD, 134 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR = 0x93D0, 135 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR = 0x93D1, 136 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR = 0x93D2, 137 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR = 0x93D3, 138 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR = 0x93D4, 139 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR = 0x93D5, 140 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR = 0x93D6, 141 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR = 0x93D7, 142 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR = 0x93D8, 143 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR = 0x93D9, 144 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR = 0x93DA, 145 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR = 0x93DB, 146 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR = 0x93DC, 147 HAL_PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR = 0x93DD, 148}; 149 150/* possible formats for 3D content*/ 151enum { 152 HAL_NO_3D = 0x0000, 153 HAL_3D_IN_SIDE_BY_SIDE_L_R = 0x10000, 154 HAL_3D_IN_TOP_BOTTOM = 0x20000, 155 HAL_3D_IN_INTERLEAVE = 0x40000, 156 HAL_3D_IN_SIDE_BY_SIDE_R_L = 0x80000, 157 HAL_3D_OUT_SIDE_BY_SIDE = 0x1000, 158 HAL_3D_OUT_TOP_BOTTOM = 0x2000, 159 HAL_3D_OUT_INTERLEAVE = 0x4000, 160 HAL_3D_OUT_MONOSCOPIC = 0x8000 161}; 162 163enum { 164 BUFFER_TYPE_UI = 0, 165 BUFFER_TYPE_VIDEO 166}; 167 168/*****************************************************************************/ 169 170#ifdef __cplusplus 171struct private_handle_t : public native_handle { 172#else 173 struct private_handle_t { 174 native_handle_t nativeHandle; 175#endif 176 enum { 177 PRIV_FLAGS_FRAMEBUFFER = 0x00000001, 178 PRIV_FLAGS_USES_PMEM = 0x00000002, 179 PRIV_FLAGS_USES_PMEM_ADSP = 0x00000004, 180 PRIV_FLAGS_USES_ION = 0x00000008, 181 PRIV_FLAGS_USES_ASHMEM = 0x00000010, 182 PRIV_FLAGS_NEEDS_FLUSH = 0x00000020, 183 PRIV_FLAGS_DO_NOT_FLUSH = 0x00000040, 184 PRIV_FLAGS_SW_LOCK = 0x00000080, 185 PRIV_FLAGS_NONCONTIGUOUS_MEM = 0x00000100, 186 // Set by HWC when storing the handle 187 PRIV_FLAGS_HWC_LOCK = 0x00000200, 188 PRIV_FLAGS_SECURE_BUFFER = 0x00000400, 189 // For explicit synchronization 190 PRIV_FLAGS_UNSYNCHRONIZED = 0x00000800, 191 // Not mapped in userspace 192 PRIV_FLAGS_NOT_MAPPED = 0x00001000, 193 // Display on external only 194 PRIV_FLAGS_EXTERNAL_ONLY = 0x00002000, 195 PRIV_FLAGS_VIDEO_ENCODER = 0x00010000, 196 PRIV_FLAGS_CAMERA_WRITE = 0x00020000, 197 PRIV_FLAGS_CAMERA_READ = 0x00040000, 198 PRIV_FLAGS_HW_COMPOSER = 0x00080000, 199 PRIV_FLAGS_HW_TEXTURE = 0x00100000, 200 PRIV_FLAGS_ITU_R_601 = 0x00200000, 201 PRIV_FLAGS_ITU_R_601_FR = 0x00400000, 202 PRIV_FLAGS_ITU_R_709 = 0x00800000, 203 PRIV_FLAGS_SECURE_DISPLAY = 0x01000000, 204 // Buffer is rendered in Tile Format 205 PRIV_FLAGS_TILE_RENDERED = 0x02000000, 206 // Buffer rendered using CPU/SW renderer 207 PRIV_FLAGS_CPU_RENDERED = 0x04000000 208 }; 209 210 // file-descriptors 211 int fd; 212 int fd_metadata; // fd for the meta-data 213 // ints 214 int magic; 215 int flags; 216 unsigned int size; 217 unsigned int offset; 218 int bufferType; 219 uint64_t base __attribute__((aligned(8))); 220 unsigned int offset_metadata; 221 // The gpu address mapped into the mmu. 222 uint64_t gpuaddr __attribute__((aligned(8))); 223 int format; 224 int width; 225 int height; 226 uint64_t base_metadata __attribute__((aligned(8))); 227 228#ifdef __cplusplus 229 static const int sNumFds = 2; 230 static inline int sNumInts() { 231 return ((sizeof(private_handle_t) - sizeof(native_handle_t)) / 232 sizeof(int)) - sNumFds; 233 } 234 static const int sMagic = 'gmsm'; 235 236 private_handle_t(int fd, unsigned int size, int flags, int bufferType, 237 int format, int width, int height, int eFd = -1, 238 unsigned int eOffset = 0, uint64_t eBase = 0) : 239 fd(fd), fd_metadata(eFd), magic(sMagic), 240 flags(flags), size(size), offset(0), bufferType(bufferType), 241 base(0), offset_metadata(eOffset), gpuaddr(0), 242 format(format), width(width), height(height), 243 base_metadata(eBase) 244 { 245 version = (int) sizeof(native_handle); 246 numInts = sNumInts(); 247 numFds = sNumFds; 248 } 249 ~private_handle_t() { 250 magic = 0; 251 } 252 253 bool usesPhysicallyContiguousMemory() { 254 return (flags & PRIV_FLAGS_USES_PMEM) != 0; 255 } 256 257 static int validate(const native_handle* h) { 258 const private_handle_t* hnd = (const private_handle_t*)h; 259 if (!h || h->version != sizeof(native_handle) || 260 h->numInts != sNumInts() || h->numFds != sNumFds || 261 hnd->magic != sMagic) 262 { 263 ALOGD("Invalid gralloc handle (at %p): " 264 "ver(%d/%zu) ints(%d/%d) fds(%d/%d)" 265 "magic(%c%c%c%c/%c%c%c%c)", 266 h, 267 h ? h->version : -1, sizeof(native_handle), 268 h ? h->numInts : -1, sNumInts(), 269 h ? h->numFds : -1, sNumFds, 270 hnd ? (((hnd->magic >> 24) & 0xFF)? 271 ((hnd->magic >> 24) & 0xFF) : '-') : '?', 272 hnd ? (((hnd->magic >> 16) & 0xFF)? 273 ((hnd->magic >> 16) & 0xFF) : '-') : '?', 274 hnd ? (((hnd->magic >> 8) & 0xFF)? 275 ((hnd->magic >> 8) & 0xFF) : '-') : '?', 276 hnd ? (((hnd->magic >> 0) & 0xFF)? 277 ((hnd->magic >> 0) & 0xFF) : '-') : '?', 278 (sMagic >> 24) & 0xFF, 279 (sMagic >> 16) & 0xFF, 280 (sMagic >> 8) & 0xFF, 281 (sMagic >> 0) & 0xFF); 282 return -EINVAL; 283 } 284 return 0; 285 } 286 287 static private_handle_t* dynamicCast(const native_handle* in) { 288 if (validate(in) == 0) { 289 return (private_handle_t*) in; 290 } 291 return NULL; 292 } 293#endif 294 }; 295 296#endif /* GRALLOC_PRIV_H_ */ 297