gralloc_priv.h revision d9540d2b12538965e83044dcf62f01ffb3bdadfb 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 * Copyright (c) 2011-2012, Code Aurora Forum. 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    /* CAMERA heap is a carveout heap for camera, is not secured*/
51    GRALLOC_USAGE_PRIVATE_CAMERA_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    /* This flag can be set to disable genlock synchronization
58     * for the gralloc buffer. If this flag is set the caller
59     * is required to perform explicit synchronization.
60     * WARNING - flag is outside the standard PRIVATE region
61     * and may need to be moved if the gralloc API changes
62     */
63    GRALLOC_USAGE_PRIVATE_UNSYNCHRONIZED  =       0X04000000,
64
65    /* Buffer content should be displayed on an external display only */
66    GRALLOC_USAGE_PRIVATE_EXTERNAL_ONLY   =       0x08000000,
67
68    /* Only this buffer content should be displayed on external, even if
69     * other EXTERNAL_ONLY buffers are available. Used during suspend.
70     */
71    GRALLOC_USAGE_PRIVATE_EXTERNAL_BLOCK  =       0x00100000,
72
73    /* Close Caption displayed on an external display only */
74    GRALLOC_USAGE_PRIVATE_EXTERNAL_CC     =       0x00200000,
75
76    /* Use this flag to request content protected buffers. Please note
77     * that this flag is different from the GRALLOC_USAGE_PROTECTED flag
78     * which can be used for buffers that are not secured for DRM
79     * but still need to be protected from screen captures
80     */
81    GRALLOC_USAGE_PRIVATE_CP_BUFFER       =       0x00400000,
82};
83
84enum {
85    /* Gralloc perform enums
86    */
87    GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER =
88                                    GRALLOC_MODULE_PERFORM_PRIVATE_START,
89};
90
91#define GRALLOC_HEAP_MASK   (GRALLOC_USAGE_PRIVATE_UI_CONTIG_HEAP |\
92                             GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP    |\
93                             GRALLOC_USAGE_PRIVATE_IOMMU_HEAP     |\
94                             GRALLOC_USAGE_PRIVATE_MM_HEAP        |\
95                             GRALLOC_USAGE_PRIVATE_CAMERA_HEAP)
96
97#define INTERLACE_MASK 0x80
98#define S3D_FORMAT_MASK 0xFF000
99/*****************************************************************************/
100enum {
101    /* OEM specific HAL formats */
102    HAL_PIXEL_FORMAT_NV12_ENCODEABLE        = 0x102,
103    HAL_PIXEL_FORMAT_YCbCr_420_SP_VENUS     = 0x7FA30C04,
104    HAL_PIXEL_FORMAT_YCbCr_420_SP_TILED     = 0x7FA30C03,
105    HAL_PIXEL_FORMAT_YCbCr_420_SP           = 0x109,
106    HAL_PIXEL_FORMAT_YCrCb_420_SP_ADRENO    = 0x7FA30C01,
107    HAL_PIXEL_FORMAT_YCrCb_422_SP           = 0x10B,
108    HAL_PIXEL_FORMAT_R_8                    = 0x10D,
109    HAL_PIXEL_FORMAT_RG_88                  = 0x10E,
110    HAL_PIXEL_FORMAT_YCbCr_444_SP           = 0x10F,
111    HAL_PIXEL_FORMAT_YCrCb_444_SP           = 0x110,
112    HAL_PIXEL_FORMAT_INTERLACE              = 0x180,
113
114};
115
116/* possible formats for 3D content*/
117enum {
118    HAL_NO_3D                         = 0x0000,
119    HAL_3D_IN_SIDE_BY_SIDE_L_R        = 0x10000,
120    HAL_3D_IN_TOP_BOTTOM              = 0x20000,
121    HAL_3D_IN_INTERLEAVE              = 0x40000,
122    HAL_3D_IN_SIDE_BY_SIDE_R_L        = 0x80000,
123    HAL_3D_OUT_SIDE_BY_SIDE           = 0x1000,
124    HAL_3D_OUT_TOP_BOTTOM             = 0x2000,
125    HAL_3D_OUT_INTERLEAVE             = 0x4000,
126    HAL_3D_OUT_MONOSCOPIC             = 0x8000
127};
128
129enum {
130    BUFFER_TYPE_UI = 0,
131    BUFFER_TYPE_VIDEO
132};
133
134/*****************************************************************************/
135
136#ifdef __cplusplus
137struct private_handle_t : public native_handle {
138#else
139    struct private_handle_t {
140        native_handle_t nativeHandle;
141#endif
142        enum {
143            PRIV_FLAGS_FRAMEBUFFER        = 0x00000001,
144            PRIV_FLAGS_USES_PMEM          = 0x00000002,
145            PRIV_FLAGS_USES_PMEM_ADSP     = 0x00000004,
146            PRIV_FLAGS_USES_ION           = 0x00000008,
147            PRIV_FLAGS_USES_ASHMEM        = 0x00000010,
148            PRIV_FLAGS_NEEDS_FLUSH        = 0x00000020,
149            PRIV_FLAGS_DO_NOT_FLUSH       = 0x00000040,
150            PRIV_FLAGS_SW_LOCK            = 0x00000080,
151            PRIV_FLAGS_NONCONTIGUOUS_MEM  = 0x00000100,
152            // Set by HWC when storing the handle
153            PRIV_FLAGS_HWC_LOCK           = 0x00000200,
154            PRIV_FLAGS_SECURE_BUFFER      = 0x00000400,
155            // For explicit synchronization
156            PRIV_FLAGS_UNSYNCHRONIZED     = 0x00000800,
157            // Not mapped in userspace
158            PRIV_FLAGS_NOT_MAPPED         = 0x00001000,
159            // Display on external only
160            PRIV_FLAGS_EXTERNAL_ONLY      = 0x00002000,
161            // Display only this buffer on external
162            PRIV_FLAGS_EXTERNAL_BLOCK     = 0x00004000,
163            // Display this buffer on external as close caption
164            PRIV_FLAGS_EXTERNAL_CC        = 0x00008000,
165            PRIV_FLAGS_VIDEO_ENCODER      = 0x00010000,
166            PRIV_FLAGS_CAMERA_WRITE       = 0x00020000,
167            PRIV_FLAGS_CAMERA_READ        = 0x00040000,
168        };
169
170        // file-descriptors
171        int     fd;
172        // genlock handle to be dup'd by the binder
173        int     genlockHandle;
174        int     fd_metadata;          // fd for the meta-data
175        // ints
176        int     magic;
177        int     flags;
178        int     size;
179        int     offset;
180        int     bufferType;
181        int     base;
182        int     offset_metadata;
183        // The gpu address mapped into the mmu.
184        // If using ashmem, set to 0, they don't care
185        int     gpuaddr;
186        int     pid;   // deprecated
187        int     format;
188        int     width;
189        int     height;
190        // local fd of the genlock device.
191        int     genlockPrivFd;
192        int     base_metadata;
193
194#ifdef __cplusplus
195        static const int sNumInts = 14;
196        static const int sNumFds = 3;
197        static const int sMagic = 'gmsm';
198
199        private_handle_t(int fd, int size, int flags, int bufferType,
200                         int format,int width, int height, int eFd = -1,
201                         int eOffset = 0, int eBase = 0) :
202            fd(fd), genlockHandle(-1), fd_metadata(eFd), magic(sMagic),
203            flags(flags), size(size), offset(0), bufferType(bufferType),
204            base(0), offset_metadata(eOffset), gpuaddr(0), pid(getpid()),
205            format(format), width(width), height(height), genlockPrivFd(-1),
206            base_metadata(eBase)
207        {
208            version = sizeof(native_handle);
209            numInts = sNumInts;
210            numFds = sNumFds;
211        }
212        ~private_handle_t() {
213            magic = 0;
214        }
215
216        bool usesPhysicallyContiguousMemory() {
217            return (flags & PRIV_FLAGS_USES_PMEM) != 0;
218        }
219
220        static int validate(const native_handle* h) {
221            const private_handle_t* hnd = (const private_handle_t*)h;
222            if (!h || h->version != sizeof(native_handle) ||
223                h->numInts != sNumInts || h->numFds != sNumFds ||
224                hnd->magic != sMagic)
225            {
226                ALOGD("Invalid gralloc handle (at %p): "
227                      "ver(%d/%d) ints(%d/%d) fds(%d/%d) magic(%c%c%c%c/%c%c%c%c)",
228                      h,
229                      h ? h->version : -1, sizeof(native_handle),
230                      h ? h->numInts : -1, sNumInts,
231                      h ? h->numFds : -1, sNumFds,
232                      hnd ? (((hnd->magic >> 24) & 0xFF)?
233                             ((hnd->magic >> 24) & 0xFF) : '-') : '?',
234                      hnd ? (((hnd->magic >> 16) & 0xFF)?
235                             ((hnd->magic >> 16) & 0xFF) : '-') : '?',
236                      hnd ? (((hnd->magic >> 8) & 0xFF)?
237                             ((hnd->magic >> 8) & 0xFF) : '-') : '?',
238                      hnd ? (((hnd->magic >> 0) & 0xFF)?
239                             ((hnd->magic >> 0) & 0xFF) : '-') : '?',
240                      (sMagic >> 24) & 0xFF,
241                      (sMagic >> 16) & 0xFF,
242                      (sMagic >> 8) & 0xFF,
243                      (sMagic >> 0) & 0xFF);
244                return -EINVAL;
245            }
246            return 0;
247        }
248
249        static private_handle_t* dynamicCast(const native_handle* in) {
250            if (validate(in) == 0) {
251                return (private_handle_t*) in;
252            }
253            return NULL;
254        }
255#endif
256    };
257
258#endif /* GRALLOC_PRIV_H_ */
259