gralloc_priv.h revision eb43d2b7b681164a58e3f86bd0b0d88eea6a3591 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 * Copyright (c) 2011-2013, 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    /* Only this buffer content should be displayed on external, even if
64     * other EXTERNAL_ONLY buffers are available. Used during suspend.
65     */
66    GRALLOC_USAGE_PRIVATE_EXTERNAL_BLOCK  =       0x00100000,
67
68    /* Close Caption displayed on an external display only */
69    GRALLOC_USAGE_PRIVATE_EXTERNAL_CC     =       0x00200000,
70
71    /* Use this flag to request content protected buffers. Please note
72     * that this flag is different from the GRALLOC_USAGE_PROTECTED flag
73     * which can be used for buffers that are not secured for DRM
74     * but still need to be protected from screen captures
75     */
76    GRALLOC_USAGE_PRIVATE_CP_BUFFER       =       0x00400000,
77};
78
79enum {
80    /* Gralloc perform enums
81    */
82    GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER = 1,
83    GRALLOC_MODULE_PERFORM_GET_STRIDE,
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/*****************************************************************************/
95enum {
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_INTERLACE              = 0x180,
108
109};
110
111/* possible formats for 3D content*/
112enum {
113    HAL_NO_3D                         = 0x0000,
114    HAL_3D_IN_SIDE_BY_SIDE_L_R        = 0x10000,
115    HAL_3D_IN_TOP_BOTTOM              = 0x20000,
116    HAL_3D_IN_INTERLEAVE              = 0x40000,
117    HAL_3D_IN_SIDE_BY_SIDE_R_L        = 0x80000,
118    HAL_3D_OUT_SIDE_BY_SIDE           = 0x1000,
119    HAL_3D_OUT_TOP_BOTTOM             = 0x2000,
120    HAL_3D_OUT_INTERLEAVE             = 0x4000,
121    HAL_3D_OUT_MONOSCOPIC             = 0x8000
122};
123
124enum {
125    BUFFER_TYPE_UI = 0,
126    BUFFER_TYPE_VIDEO
127};
128
129/*****************************************************************************/
130
131#ifdef __cplusplus
132struct private_handle_t : public native_handle {
133#else
134    struct private_handle_t {
135        native_handle_t nativeHandle;
136#endif
137        enum {
138            PRIV_FLAGS_FRAMEBUFFER        = 0x00000001,
139            PRIV_FLAGS_USES_PMEM          = 0x00000002,
140            PRIV_FLAGS_USES_PMEM_ADSP     = 0x00000004,
141            PRIV_FLAGS_USES_ION           = 0x00000008,
142            PRIV_FLAGS_USES_ASHMEM        = 0x00000010,
143            PRIV_FLAGS_NEEDS_FLUSH        = 0x00000020,
144            PRIV_FLAGS_DO_NOT_FLUSH       = 0x00000040,
145            PRIV_FLAGS_SW_LOCK            = 0x00000080,
146            PRIV_FLAGS_NONCONTIGUOUS_MEM  = 0x00000100,
147            // Set by HWC when storing the handle
148            PRIV_FLAGS_HWC_LOCK           = 0x00000200,
149            PRIV_FLAGS_SECURE_BUFFER      = 0x00000400,
150            // For explicit synchronization
151            PRIV_FLAGS_UNSYNCHRONIZED     = 0x00000800,
152            // Not mapped in userspace
153            PRIV_FLAGS_NOT_MAPPED         = 0x00001000,
154            // Display on external only
155            PRIV_FLAGS_EXTERNAL_ONLY      = 0x00002000,
156            // Display only this buffer on external
157            PRIV_FLAGS_EXTERNAL_BLOCK     = 0x00004000,
158            // Display this buffer on external as close caption
159            PRIV_FLAGS_EXTERNAL_CC        = 0x00008000,
160            PRIV_FLAGS_VIDEO_ENCODER      = 0x00010000,
161            PRIV_FLAGS_CAMERA_WRITE       = 0x00020000,
162            PRIV_FLAGS_CAMERA_READ        = 0x00040000,
163            PRIV_FLAGS_HW_COMPOSER        = 0x00080000,
164            PRIV_FLAGS_HW_TEXTURE         = 0x00100000,
165            PRIV_FLAGS_ITU_R_601          = 0x00200000,
166            PRIV_FLAGS_ITU_R_601_FR       = 0x00400000,
167            PRIV_FLAGS_ITU_R_709          = 0x00800000,
168        };
169
170        // file-descriptors
171        int     fd;
172        int     fd_metadata;          // fd for the meta-data
173        // ints
174        int     magic;
175        int     flags;
176        int     size;
177        int     offset;
178        int     bufferType;
179        int     base;
180        int     offset_metadata;
181        // The gpu address mapped into the mmu.
182        int     gpuaddr;
183        int     format;
184        int     width;
185        int     height;
186        int     base_metadata;
187
188#ifdef __cplusplus
189        static const int sNumInts = 12;
190        static const int sNumFds = 2;
191        static const int sMagic = 'gmsm';
192
193        private_handle_t(int fd, int size, int flags, int bufferType,
194                         int format,int width, int height, int eFd = -1,
195                         int eOffset = 0, int eBase = 0) :
196            fd(fd), fd_metadata(eFd), magic(sMagic),
197            flags(flags), size(size), offset(0), bufferType(bufferType),
198            base(0), offset_metadata(eOffset), gpuaddr(0),
199            format(format), width(width), height(height),
200            base_metadata(eBase)
201        {
202            version = sizeof(native_handle);
203            numInts = sNumInts;
204            numFds = sNumFds;
205        }
206        ~private_handle_t() {
207            magic = 0;
208        }
209
210        bool usesPhysicallyContiguousMemory() {
211            return (flags & PRIV_FLAGS_USES_PMEM) != 0;
212        }
213
214        static int validate(const native_handle* h) {
215            const private_handle_t* hnd = (const private_handle_t*)h;
216            if (!h || h->version != sizeof(native_handle) ||
217                h->numInts != sNumInts || h->numFds != sNumFds ||
218                hnd->magic != sMagic)
219            {
220                ALOGD("Invalid gralloc handle (at %p): "
221                      "ver(%d/%d) ints(%d/%d) fds(%d/%d) magic(%c%c%c%c/%c%c%c%c)",
222                      h,
223                      h ? h->version : -1, sizeof(native_handle),
224                      h ? h->numInts : -1, sNumInts,
225                      h ? h->numFds : -1, sNumFds,
226                      hnd ? (((hnd->magic >> 24) & 0xFF)?
227                             ((hnd->magic >> 24) & 0xFF) : '-') : '?',
228                      hnd ? (((hnd->magic >> 16) & 0xFF)?
229                             ((hnd->magic >> 16) & 0xFF) : '-') : '?',
230                      hnd ? (((hnd->magic >> 8) & 0xFF)?
231                             ((hnd->magic >> 8) & 0xFF) : '-') : '?',
232                      hnd ? (((hnd->magic >> 0) & 0xFF)?
233                             ((hnd->magic >> 0) & 0xFF) : '-') : '?',
234                      (sMagic >> 24) & 0xFF,
235                      (sMagic >> 16) & 0xFF,
236                      (sMagic >> 8) & 0xFF,
237                      (sMagic >> 0) & 0xFF);
238                return -EINVAL;
239            }
240            return 0;
241        }
242
243        static private_handle_t* dynamicCast(const native_handle* in) {
244            if (validate(in) == 0) {
245                return (private_handle_t*) in;
246            }
247            return NULL;
248        }
249#endif
250    };
251
252#endif /* GRALLOC_PRIV_H_ */
253