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