• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2011-2017, The Linux Foundation. All rights reserved.
3  * Not a Contribution
4  *
5  * Copyright (C) 2008 The Android Open Source Project
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 #ifndef __GR_PRIV_HANDLE_H__
21 #define __GR_PRIV_HANDLE_H__
22 
23 #include <errno.h>
24 
25 #include <log/log.h>
26 #include <hardware/gralloc1.h>
27 #include <hardware/gralloc.h>
28 #include <cinttypes>
29 
30 #define GRALLOC1_FUNCTION_PERFORM 0x00001000
31 
32 #define DBG_HANDLE false
33 
34 typedef gralloc1_error_t (*GRALLOC1_PFN_PERFORM)(gralloc1_device_t *device, int operation, ...);
35 
36 #define PRIV_HANDLE_CONST(exp) static_cast<const private_handle_t *>(exp)
37 
38 struct private_handle_t : public native_handle_t {
39   enum {
40     PRIV_FLAGS_FRAMEBUFFER = 0x00000001,
41     PRIV_FLAGS_USES_ION = 0x00000008,
42     PRIV_FLAGS_NEEDS_FLUSH = 0x00000020,
43     PRIV_FLAGS_INTERNAL_ONLY = 0x00000040,
44     PRIV_FLAGS_NON_CPU_WRITER = 0x00000080,
45     PRIV_FLAGS_CACHED = 0x00000200,
46     PRIV_FLAGS_SECURE_BUFFER = 0x00000400,
47     PRIV_FLAGS_EXTERNAL_ONLY = 0x00002000,
48     PRIV_FLAGS_PROTECTED_BUFFER = 0x00004000,
49     PRIV_FLAGS_VIDEO_ENCODER = 0x00010000,
50     PRIV_FLAGS_CAMERA_WRITE = 0x00020000,
51     PRIV_FLAGS_CAMERA_READ = 0x00040000,
52     PRIV_FLAGS_HW_COMPOSER = 0x00080000,
53     PRIV_FLAGS_HW_TEXTURE = 0x00100000,
54     PRIV_FLAGS_ITU_R_601 = 0x00200000,     // Unused from display
55     PRIV_FLAGS_ITU_R_601_FR = 0x00400000,  // Unused from display
56     PRIV_FLAGS_ITU_R_709 = 0x00800000,     // Unused from display
57     PRIV_FLAGS_SECURE_DISPLAY = 0x01000000,
58     PRIV_FLAGS_TILE_RENDERED = 0x02000000,
59     PRIV_FLAGS_CPU_RENDERED = 0x04000000,
60     PRIV_FLAGS_UBWC_ALIGNED = 0x08000000,
61     PRIV_FLAGS_DISP_CONSUMER = 0x10000000,
62     PRIV_FLAGS_CLIENT_ALLOCATED = 0x20000000,   // Ion buffer allocated outside of gralloc
63   };
64 
65   // file-descriptors dup'd over IPC
66   int fd;
67   int fd_metadata;
68 
69   // values sent over IPC
70   int magic;
71   int flags;
72   int width;        // holds width of the actual buffer allocated
73   int height;       // holds height of the  actual buffer allocated
74   int unaligned_width;   // holds width client asked to allocate
75   int unaligned_height;  // holds height client asked to allocate
76   int format;
77   int buffer_type;
78   unsigned int size;
79   unsigned int offset;
80   unsigned int offset_metadata;
81   uint64_t base                            __attribute__((aligned(8)));
82   uint64_t base_metadata                   __attribute__((aligned(8)));
83   uint64_t gpuaddr                         __attribute__((aligned(8)));
84   uint64_t id                              __attribute__((aligned(8)));
85   gralloc1_producer_usage_t producer_usage __attribute__((aligned(8)));
86   gralloc1_consumer_usage_t consumer_usage __attribute__((aligned(8)));
87   unsigned int layer_count;
88 
89   static const int kNumFds = 2;
90   static const int kMagic = 'gmsm';
91 
NumIntsprivate_handle_t92   static inline int NumInts() {
93     return ((sizeof(private_handle_t) - sizeof(native_handle_t)) / sizeof(int))
94         - kNumFds;
95   }
96 
97   private_handle_t(int fd,
98                    int meta_fd,
99                    int flags,
100                    int width,
101                    int height,
102                    int uw,
103                    int uh,
104                    int format,
105                    int buf_type,
106                    unsigned int size,
107                    gralloc1_producer_usage_t prod_usage = GRALLOC1_PRODUCER_USAGE_NONE,
108                    gralloc1_consumer_usage_t cons_usage = GRALLOC1_CONSUMER_USAGE_NONE)
fdprivate_handle_t109       : fd(fd),
110         fd_metadata(meta_fd),
111         magic(kMagic),
112         flags(flags),
113         width(width),
114         height(height),
115         unaligned_width(uw),
116         unaligned_height(uh),
117         format(format),
118         buffer_type(buf_type),
119         size(size),
120         offset(0),
121         offset_metadata(0),
122         base(0),
123         base_metadata(0),
124         gpuaddr(0),
125         id(0),
126         producer_usage(prod_usage),
127         consumer_usage(cons_usage),
128         layer_count(1) {
129     version = static_cast<int>(sizeof(native_handle));
130     numInts = NumInts();
131     numFds = kNumFds;
132   }
133 
134 // Legacy constructor used by some clients
private_handle_tprivate_handle_t135   private_handle_t(int fd, unsigned int size, int usage, int buf_type, int format, int w, int h)
136   : private_handle_t(fd, -1, PRIV_FLAGS_CLIENT_ALLOCATED, w, h, 0, 0, format, buf_type, size,
137                      static_cast<gralloc1_producer_usage_t>(usage),
138                      static_cast<gralloc1_consumer_usage_t>(usage)) {
139   }
140 
~private_handle_tprivate_handle_t141   ~private_handle_t() {
142     magic = 0;
143     ALOGE_IF(DBG_HANDLE, "Deleting buffer handle %p", this);
144   }
145 
validateprivate_handle_t146   static int validate(const native_handle *h) {
147     const private_handle_t *hnd = (const private_handle_t *)h;
148     if (!h || h->version != sizeof(native_handle) || h->numInts != NumInts() ||
149         h->numFds != kNumFds || hnd->magic != kMagic) {
150       ALOGE(
151           "Invalid gralloc handle (at %p): ver(%d/%zu) ints(%d/%d) fds(%d/%d) "
152           "magic(%c%c%c%c/%c%c%c%c)",
153           h, h ? h->version : -1, sizeof(native_handle), h ? h->numInts : -1, NumInts(),
154           h ? h->numFds : -1, kNumFds,
155           hnd ? (((hnd->magic >> 24) & 0xFF) ? ((hnd->magic >> 24) & 0xFF) : '-') : '?',
156           hnd ? (((hnd->magic >> 16) & 0xFF) ? ((hnd->magic >> 16) & 0xFF) : '-') : '?',
157           hnd ? (((hnd->magic >> 8) & 0xFF) ? ((hnd->magic >> 8) & 0xFF) : '-') : '?',
158           hnd ? (((hnd->magic >> 0) & 0xFF) ? ((hnd->magic >> 0) & 0xFF) : '-') : '?',
159           (kMagic >> 24) & 0xFF, (kMagic >> 16) & 0xFF, (kMagic >> 8) & 0xFF, (kMagic >> 0) & 0xFF);
160       return -EINVAL;
161     }
162 
163     return 0;
164   }
165 
Dumpprivate_handle_t166   static void Dump(const private_handle_t *hnd) {
167     ALOGD("handle id:%" PRIu64 " wxh:%dx%d uwxuh:%dx%d size: %d fd:%d fd_meta:%d flags:0x%x "
168           "prod_usage:0x%" PRIx64" cons_usage:0x%" PRIx64 " format:0x%x layer_count: %d",
169           hnd->id, hnd->width, hnd->height, hnd->unaligned_width, hnd->unaligned_height, hnd->size,
170           hnd->fd, hnd->fd_metadata, hnd->flags, hnd->producer_usage, hnd->consumer_usage,
171           hnd->format, hnd->layer_count);
172   }
173 
GetUnalignedWidthprivate_handle_t174   int GetUnalignedWidth() const { return unaligned_width; }
175 
GetUnalignedHeightprivate_handle_t176   int GetUnalignedHeight() const { return unaligned_height; }
177 
GetColorFormatprivate_handle_t178   int GetColorFormat() const { return format; }
179 
GetLayerCountprivate_handle_t180   unsigned int GetLayerCount() const { return layer_count; }
181 
GetStrideprivate_handle_t182   int GetStride() const {
183     // In handle we currently store aligned width after allocation.
184     return width;
185   }
186 
GetConsumerUsageprivate_handle_t187   gralloc1_consumer_usage_t GetConsumerUsage() const { return consumer_usage; }
188 
GetProducerUsageprivate_handle_t189   gralloc1_producer_usage_t GetProducerUsage() const { return producer_usage; }
190 
GetBackingstoreprivate_handle_t191   uint64_t GetBackingstore() const { return id; }
192 };
193 
194 #endif  // __GR_PRIV_HANDLE_H__
195