• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 enum {
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 
81 enum {
82     /* Gralloc perform enums
83     */
84     GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER = 0x080000001,
85 };
86 
87 #define GRALLOC_HEAP_MASK   (GRALLOC_USAGE_PRIVATE_UI_CONTIG_HEAP |\
88                              GRALLOC_USAGE_PRIVATE_SYSTEM_HEAP    |\
89                              GRALLOC_USAGE_PRIVATE_IOMMU_HEAP     |\
90                              GRALLOC_USAGE_PRIVATE_MM_HEAP        |\
91                              GRALLOC_USAGE_PRIVATE_CAMERA_HEAP)
92 
93 #define INTERLACE_MASK 0x80
94 #define S3D_FORMAT_MASK 0xFF000
95 /*****************************************************************************/
96 enum {
97     /* OEM specific HAL formats */
98     HAL_PIXEL_FORMAT_NV12_ENCODEABLE        = 0x102,
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*/
112 enum {
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 
124 enum {
125     BUFFER_TYPE_UI = 0,
126     BUFFER_TYPE_VIDEO
127 };
128 
129 /*****************************************************************************/
130 
131 #ifdef __cplusplus
132 struct 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         };
164 
165         // file-descriptors
166         int     fd;
167         // genlock handle to be dup'd by the binder
168         int     genlockHandle;
169         // ints
170         int     magic;
171         int     flags;
172         int     size;
173         int     offset;
174         int     bufferType;
175         int     base;
176         // The gpu address mapped into the mmu.
177         // If using ashmem, set to 0, they don't care
178         int     gpuaddr;
179         int     pid;   // deprecated
180         int     format;
181         int     width;
182         int     height;
183         // local fd of the genlock device.
184         int     genlockPrivFd;
185 
186 #ifdef __cplusplus
187         static const int sNumInts = 12;
188         static const int sNumFds = 2;
189         static const int sMagic = 'gmsm';
190 
private_handle_tprivate_handle_t191         private_handle_t(int fd, int size, int flags, int bufferType,
192                          int format,int width, int height) :
193             fd(fd), genlockHandle(-1), magic(sMagic),
194             flags(flags), size(size), offset(0),
195             bufferType(bufferType), base(0), gpuaddr(0),
196             pid(0), format(format),
197             width(width), height(height), genlockPrivFd(-1)
198         {
199             version = sizeof(native_handle);
200             numInts = sNumInts;
201             numFds = sNumFds;
202         }
~private_handle_tprivate_handle_t203         ~private_handle_t() {
204             magic = 0;
205         }
206 
usesPhysicallyContiguousMemoryprivate_handle_t207         bool usesPhysicallyContiguousMemory() {
208             return (flags & PRIV_FLAGS_USES_PMEM) != 0;
209         }
210 
validateprivate_handle_t211         static int validate(const native_handle* h) {
212             const private_handle_t* hnd = (const private_handle_t*)h;
213             if (!h || h->version != sizeof(native_handle) ||
214                 h->numInts != sNumInts || h->numFds != sNumFds ||
215                 hnd->magic != sMagic)
216             {
217                 ALOGD("Invalid gralloc handle (at %p): "
218                       "ver(%d/%d) ints(%d/%d) fds(%d/%d) magic(%c%c%c%c/%c%c%c%c)",
219                       h,
220                       h ? h->version : -1, sizeof(native_handle),
221                       h ? h->numInts : -1, sNumInts,
222                       h ? h->numFds : -1, sNumFds,
223                       hnd ? (((hnd->magic >> 24) & 0xFF)?
224                              ((hnd->magic >> 24) & 0xFF) : '-') : '?',
225                       hnd ? (((hnd->magic >> 16) & 0xFF)?
226                              ((hnd->magic >> 16) & 0xFF) : '-') : '?',
227                       hnd ? (((hnd->magic >> 8) & 0xFF)?
228                              ((hnd->magic >> 8) & 0xFF) : '-') : '?',
229                       hnd ? (((hnd->magic >> 0) & 0xFF)?
230                              ((hnd->magic >> 0) & 0xFF) : '-') : '?',
231                       (sMagic >> 24) & 0xFF,
232                       (sMagic >> 16) & 0xFF,
233                       (sMagic >> 8) & 0xFF,
234                       (sMagic >> 0) & 0xFF);
235                 return -EINVAL;
236             }
237             return 0;
238         }
239 
dynamicCastprivate_handle_t240         static private_handle_t* dynamicCast(const native_handle* in) {
241             if (validate(in) == 0) {
242                 return (private_handle_t*) in;
243             }
244             return NULL;
245         }
246 #endif
247     };
248 
249 #endif /* GRALLOC_PRIV_H_ */
250