gralloc_priv.h revision 5fd30e6b24fdb48b95c1aab8546da63a07a58043 
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
33enum {
34    /* gralloc usage bits indicating the type
35     * of allocation that should be used */
36
37    /* SYSTEM heap comes from kernel vmalloc,
38     * can never be uncached, is not secured*/
39    GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP     =       GRALLOC_USAGE_PRIVATE_0,
40    /* SF heap is used for application buffers, is not secured */
41    GRALLOC_USAGE_PRIVATE_UI_CONTIG_HEAP  =       GRALLOC_USAGE_PRIVATE_1,
42    /* IOMMU heap comes from manually allocated pages,
43     * can be cached/uncached, is not secured */
44    GRALLOC_USAGE_PRIVATE_IOMMU_HEAP      =       GRALLOC_USAGE_PRIVATE_2,
45    /* MM heap is a carveout heap for video, can be secured*/
46    GRALLOC_USAGE_PRIVATE_MM_HEAP         =       GRALLOC_USAGE_PRIVATE_3,
47    /* CAMERA heap is a carveout heap for camera, is not secured*/
48    GRALLOC_USAGE_PRIVATE_CAMERA_HEAP     =       0x01000000,
49
50    /* Set this for allocating uncached memory (using O_DSYNC)
51     * cannot be used with noncontiguous heaps */
52    GRALLOC_USAGE_PRIVATE_UNCACHED        =       0x02000000,
53
54    /* This flag can be set to disable genlock synchronization
55     * for the gralloc buffer. If this flag is set the caller
56     * is required to perform explicit synchronization.
57     * WARNING - flag is outside the standard PRIVATE region
58     * and may need to be moved if the gralloc API changes
59     */
60    GRALLOC_USAGE_PRIVATE_UNSYNCHRONIZED  =       0X04000000,
61
62    /* Buffer content should be displayed on an external display only */
63    GRALLOC_USAGE_PRIVATE_EXTERNAL_ONLY   =       0x08000000,
64
65    /* Only this buffer content should be displayed on external, even if
66     * other EXTERNAL_ONLY buffers are available. Used during suspend.
67     */
68    GRALLOC_USAGE_PRIVATE_EXTERNAL_BLOCK  =       0x00100000,
69
70    /* Close Caption displayed on an external display only */
71    GRALLOC_USAGE_PRIVATE_EXTERNAL_CC     =       0x00200000,
72
73    /* Use this flag to request content protected buffers. Please note
74     * that this flag is different from the GRALLOC_USAGE_PROTECTED flag
75     * which can be used for buffers that are not secured for DRM
76     * but still need to be protected from screen captures
77     */
78    GRALLOC_USAGE_PRIVATE_CP_BUFFER       =       0x00400000,
79};
80
81enum {
82    /* Gralloc perform enums
83    */
84    GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER =
85                                    GRALLOC_MODULE_PERFORM_PRIVATE_START,
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_CAMERA_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_TILED     = 0x7FA30C03,
101    HAL_PIXEL_FORMAT_YCbCr_420_SP           = 0x109,
102    HAL_PIXEL_FORMAT_YCrCb_420_SP_ADRENO    = 0x7FA30C01,
103    HAL_PIXEL_FORMAT_YCrCb_422_SP           = 0x10B,
104    HAL_PIXEL_FORMAT_R_8                    = 0x10D,
105    HAL_PIXEL_FORMAT_RG_88                  = 0x10E,
106    HAL_PIXEL_FORMAT_YCbCr_444_SP           = 0x10F,
107    HAL_PIXEL_FORMAT_YCrCb_444_SP           = 0x110,
108    HAL_PIXEL_FORMAT_INTERLACE              = 0x180,
109
110};
111
112/* possible formats for 3D content*/
113enum {
114    HAL_NO_3D                         = 0x0000,
115    HAL_3D_IN_SIDE_BY_SIDE_L_R        = 0x10000,
116    HAL_3D_IN_TOP_BOTTOM              = 0x20000,
117    HAL_3D_IN_INTERLEAVE              = 0x40000,
118    HAL_3D_IN_SIDE_BY_SIDE_R_L        = 0x80000,
119    HAL_3D_OUT_SIDE_BY_SIDE           = 0x1000,
120    HAL_3D_OUT_TOP_BOTTOM             = 0x2000,
121    HAL_3D_OUT_INTERLEAVE             = 0x4000,
122    HAL_3D_OUT_MONOSCOPIC             = 0x8000
123};
124
125enum {
126    BUFFER_TYPE_UI = 0,
127    BUFFER_TYPE_VIDEO
128};
129
130/*****************************************************************************/
131
132#ifdef __cplusplus
133struct private_handle_t : public native_handle {
134#else
135    struct private_handle_t {
136        native_handle_t nativeHandle;
137#endif
138        enum {
139            PRIV_FLAGS_FRAMEBUFFER        = 0x00000001,
140            PRIV_FLAGS_USES_PMEM          = 0x00000002,
141            PRIV_FLAGS_USES_PMEM_ADSP     = 0x00000004,
142            PRIV_FLAGS_USES_ION           = 0x00000008,
143            PRIV_FLAGS_USES_ASHMEM        = 0x00000010,
144            PRIV_FLAGS_NEEDS_FLUSH        = 0x00000020,
145            PRIV_FLAGS_DO_NOT_FLUSH       = 0x00000040,
146            PRIV_FLAGS_SW_LOCK            = 0x00000080,
147            PRIV_FLAGS_NONCONTIGUOUS_MEM  = 0x00000100,
148            // Set by HWC when storing the handle
149            PRIV_FLAGS_HWC_LOCK           = 0x00000200,
150            PRIV_FLAGS_SECURE_BUFFER      = 0x00000400,
151            // For explicit synchronization
152            PRIV_FLAGS_UNSYNCHRONIZED     = 0x00000800,
153            // Not mapped in userspace
154            PRIV_FLAGS_NOT_MAPPED         = 0x00001000,
155            // Display on external only
156            PRIV_FLAGS_EXTERNAL_ONLY      = 0x00002000,
157            // Display only this buffer on external
158            PRIV_FLAGS_EXTERNAL_BLOCK     = 0x00004000,
159            // Display this buffer on external as close caption
160            PRIV_FLAGS_EXTERNAL_CC        = 0x00008000,
161            PRIV_FLAGS_VIDEO_ENCODER      = 0x00010000,
162            PRIV_FLAGS_CAMERA_WRITE       = 0x00020000,
163            PRIV_FLAGS_CAMERA_READ        = 0x00040000,
164        };
165
166        // file-descriptors
167        int     fd;
168        // genlock handle to be dup'd by the binder
169        int     genlockHandle;
170        // ints
171        int     magic;
172        int     flags;
173        int     size;
174        int     offset;
175        int     bufferType;
176        int     base;
177        // The gpu address mapped into the mmu.
178        // If using ashmem, set to 0, they don't care
179        int     gpuaddr;
180        int     pid;   // deprecated
181        int     format;
182        int     width;
183        int     height;
184        // local fd of the genlock device.
185        int     genlockPrivFd;
186
187#ifdef __cplusplus
188        static const int sNumInts = 12;
189        static const int sNumFds = 2;
190        static const int sMagic = 'gmsm';
191
192        private_handle_t(int fd, int size, int flags, int bufferType,
193                         int format,int width, int height) :
194            fd(fd), genlockHandle(-1), magic(sMagic),
195            flags(flags), size(size), offset(0),
196            bufferType(bufferType), base(0), gpuaddr(0),
197            pid(0), format(format),
198            width(width), height(height), genlockPrivFd(-1)
199        {
200            version = sizeof(native_handle);
201            numInts = sNumInts;
202            numFds = sNumFds;
203        }
204        ~private_handle_t() {
205            magic = 0;
206        }
207
208        bool usesPhysicallyContiguousMemory() {
209            return (flags & PRIV_FLAGS_USES_PMEM) != 0;
210        }
211
212        static int validate(const native_handle* h) {
213            const private_handle_t* hnd = (const private_handle_t*)h;
214            if (!h || h->version != sizeof(native_handle) ||
215                h->numInts != sNumInts || h->numFds != sNumFds ||
216                hnd->magic != sMagic)
217            {
218                ALOGD("Invalid gralloc handle (at %p): "
219                      "ver(%d/%d) ints(%d/%d) fds(%d/%d) magic(%c%c%c%c/%c%c%c%c)",
220                      h,
221                      h ? h->version : -1, sizeof(native_handle),
222                      h ? h->numInts : -1, sNumInts,
223                      h ? h->numFds : -1, sNumFds,
224                      hnd ? (((hnd->magic >> 24) & 0xFF)?
225                             ((hnd->magic >> 24) & 0xFF) : '-') : '?',
226                      hnd ? (((hnd->magic >> 16) & 0xFF)?
227                             ((hnd->magic >> 16) & 0xFF) : '-') : '?',
228                      hnd ? (((hnd->magic >> 8) & 0xFF)?
229                             ((hnd->magic >> 8) & 0xFF) : '-') : '?',
230                      hnd ? (((hnd->magic >> 0) & 0xFF)?
231                             ((hnd->magic >> 0) & 0xFF) : '-') : '?',
232                      (sMagic >> 24) & 0xFF,
233                      (sMagic >> 16) & 0xFF,
234                      (sMagic >> 8) & 0xFF,
235                      (sMagic >> 0) & 0xFF);
236                return -EINVAL;
237            }
238            return 0;
239        }
240
241        static private_handle_t* dynamicCast(const native_handle* in) {
242            if (validate(in) == 0) {
243                return (private_handle_t*) in;
244            }
245            return NULL;
246        }
247#endif
248    };
249
250#endif /* GRALLOC_PRIV_H_ */
251