hwc_utils.h revision 73337e3c21aa7ebcf11e5ffe45e4b5f8adf47465 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 * Copyright (C)2012-2013, The Linux Foundation. All rights reserved.
4 *
5 * Not a Contribution, Apache license notifications and license are retained
6 * for attribution purposes only.
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 *      http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21#ifndef HWC_UTILS_H
22#define HWC_UTILS_H
23
24#define HWC_REMOVE_DEPRECATED_VERSIONS 1
25#include <fcntl.h>
26#include <hardware/hwcomposer.h>
27#include <gr.h>
28#include <gralloc_priv.h>
29#include <utils/String8.h>
30#include "qdMetaData.h"
31#include <overlayUtils.h>
32
33#define ALIGN_TO(x, align)     (((x) + ((align)-1)) & ~((align)-1))
34#define LIKELY( exp )       (__builtin_expect( (exp) != 0, true  ))
35#define UNLIKELY( exp )     (__builtin_expect( (exp) != 0, false ))
36#define MAX_NUM_APP_LAYERS 32
37
38//Fwrd decls
39struct hwc_context_t;
40
41namespace ovutils = overlay::utils;
42
43namespace overlay {
44class Overlay;
45class Rotator;
46class RotMgr;
47}
48
49namespace qhwc {
50//fwrd decl
51class QueuedBufferStore;
52class ExternalDisplay;
53class VirtualDisplay;
54class IFBUpdate;
55class IVideoOverlay;
56class MDPComp;
57class CopyBit;
58class HwcDebug;
59class AssertiveDisplay;
60
61
62struct MDPInfo {
63    int version;
64    char panel;
65    bool hasOverlay;
66};
67
68struct DisplayAttributes {
69    uint32_t vsync_period; //nanos
70    uint32_t xres;
71    uint32_t yres;
72    uint32_t stride;
73    float xdpi;
74    float ydpi;
75    int fd;
76    bool connected; //Applies only to pluggable disp.
77    //Connected does not mean it ready to use.
78    //It should be active also. (UNBLANKED)
79    bool isActive;
80    // In pause state, composition is bypassed
81    // used for WFD displays only
82    bool isPause;
83    // To trigger padding round to clean up mdp
84    // pipes
85    bool isConfiguring;
86};
87
88struct ListStats {
89    int numAppLayers; //Total - 1, excluding FB layer.
90    int skipCount;
91    int fbLayerIndex; //Always last for now. = numAppLayers
92    //Video specific
93    int yuvCount;
94    int yuvIndices[MAX_NUM_APP_LAYERS];
95    int extOnlyLayerIndex;
96    bool needsAlphaScale;
97    bool preMultipliedAlpha;
98    // Notifies hwcomposer about the start and end of animation
99    // This will be set to true during animation, otherwise false.
100    bool isDisplayAnimating;
101};
102
103struct LayerProp {
104    uint32_t mFlags; //qcom specific layer flags
105    LayerProp():mFlags(0) {};
106};
107
108struct VsyncState {
109    bool enable;
110    bool fakevsync;
111};
112
113struct BwcPM {
114    static void setBwc(hwc_context_t *ctx, const hwc_rect_t& crop,
115            const hwc_rect_t& dst, const int& transform,
116            ovutils::eMdpFlags& mdpFlags);
117};
118
119// LayerProp::flag values
120enum {
121    HWC_MDPCOMP = 0x00000001,
122    HWC_COPYBIT = 0x00000002,
123};
124
125class LayerRotMap {
126public:
127    LayerRotMap() { reset(); }
128    enum { MAX_SESS = 3 };
129    void add(hwc_layer_1_t* layer, overlay::Rotator *rot);
130    void reset();
131    uint32_t getCount() const;
132    hwc_layer_1_t* getLayer(uint32_t index) const;
133    overlay::Rotator* getRot(uint32_t index) const;
134    void setReleaseFd(const int& fence);
135private:
136    hwc_layer_1_t* mLayer[MAX_SESS];
137    overlay::Rotator* mRot[MAX_SESS];
138    uint32_t mCount;
139};
140
141inline uint32_t LayerRotMap::getCount() const {
142    return mCount;
143}
144
145inline hwc_layer_1_t* LayerRotMap::getLayer(uint32_t index) const {
146    if(index >= mCount) return NULL;
147    return mLayer[index];
148}
149
150inline overlay::Rotator* LayerRotMap::getRot(uint32_t index) const {
151    if(index >= mCount) return NULL;
152    return mRot[index];
153}
154
155// -----------------------------------------------------------------------------
156// Utility functions - implemented in hwc_utils.cpp
157void dumpLayer(hwc_layer_1_t const* l);
158void setListStats(hwc_context_t *ctx, const hwc_display_contents_1_t *list,
159        int dpy);
160void initContext(hwc_context_t *ctx);
161void closeContext(hwc_context_t *ctx);
162//Crops source buffer against destination and FB boundaries
163void calculate_crop_rects(hwc_rect_t& crop, hwc_rect_t& dst,
164                         const hwc_rect_t& scissor, int orient);
165void getNonWormholeRegion(hwc_display_contents_1_t* list,
166                              hwc_rect_t& nwr);
167bool isSecuring(hwc_context_t* ctx, hwc_layer_1_t const* layer);
168bool isSecureModePolicy(int mdpVersion);
169bool isExternalActive(hwc_context_t* ctx);
170bool needsScaling(hwc_context_t* ctx, hwc_layer_1_t const* layer, const int& dpy);
171bool isAlphaPresent(hwc_layer_1_t const* layer);
172int hwc_vsync_control(hwc_context_t* ctx, int dpy, int enable);
173
174//Helper function to dump logs
175void dumpsys_log(android::String8& buf, const char* fmt, ...);
176
177/* Calculates the destination position based on the action safe rectangle */
178void getActionSafePosition(hwc_context_t *ctx, int dpy, uint32_t& x,
179                                        uint32_t& y, uint32_t& w, uint32_t& h);
180
181
182void getAspectRatioPosition(hwc_context_t *ctx, int dpy, int orientation,
183                        uint32_t& x, uint32_t& y, uint32_t& w, uint32_t& h);
184
185//Close acquireFenceFds of all layers of incoming list
186void closeAcquireFds(hwc_display_contents_1_t* list);
187
188//Sync point impl.
189int hwc_sync(hwc_context_t *ctx, hwc_display_contents_1_t* list, int dpy,
190        int fd);
191
192//Trims a layer's source crop which is outside of screen boundary.
193void trimLayer(hwc_context_t *ctx, const int& dpy, const int& transform,
194        hwc_rect_t& crop, hwc_rect_t& dst);
195
196//Sets appropriate mdp flags for a layer.
197void setMdpFlags(hwc_layer_1_t *layer,
198        ovutils::eMdpFlags &mdpFlags,
199        int rotDownscale, int transform);
200
201int configRotator(overlay::Rotator *rot, const ovutils::Whf& whf,
202        hwc_rect_t& crop, const ovutils::eMdpFlags& mdpFlags,
203        const ovutils::eTransform& orient, const int& downscale);
204
205int configMdp(overlay::Overlay *ov, const ovutils::PipeArgs& parg,
206        const ovutils::eTransform& orient, const hwc_rect_t& crop,
207        const hwc_rect_t& pos, const MetaData_t *metadata,
208        const ovutils::eDest& dest);
209
210void updateSource(ovutils::eTransform& orient, ovutils::Whf& whf,
211        hwc_rect_t& crop);
212
213//Routine to configure low resolution panels (<= 2048 width)
214int configureLowRes(hwc_context_t *ctx, hwc_layer_1_t *layer, const int& dpy,
215        ovutils::eMdpFlags& mdpFlags, ovutils::eZorder& z,
216        ovutils::eIsFg& isFg, const ovutils::eDest& dest,
217        overlay::Rotator **rot);
218
219//Routine to configure high resolution panels (> 2048 width)
220int configureHighRes(hwc_context_t *ctx, hwc_layer_1_t *layer, const int& dpy,
221        ovutils::eMdpFlags& mdpFlags, ovutils::eZorder& z,
222        ovutils::eIsFg& isFg, const ovutils::eDest& lDest,
223        const ovutils::eDest& rDest, overlay::Rotator **rot);
224
225//On certain targets DMA pipes are used for rotation and they won't be available
226//for line operations. On a per-target basis we can restrict certain use cases
227//from using rotator, since we know before-hand that such scenarios can lead to
228//extreme unavailability of pipes. This can also be done via hybrid calculations
229//also involving many more variables like number of write-back interfaces etc,
230//but the variety of scenarios is too high to warrant that.
231bool canUseRotator(hwc_context_t *ctx);
232
233int getLeftSplit(hwc_context_t *ctx, const int& dpy);
234
235// Inline utility functions
236static inline bool isSkipLayer(const hwc_layer_1_t* l) {
237    return (UNLIKELY(l && (l->flags & HWC_SKIP_LAYER)));
238}
239
240// Returns true if the buffer is yuv
241static inline bool isYuvBuffer(const private_handle_t* hnd) {
242    return (hnd && (hnd->bufferType == BUFFER_TYPE_VIDEO));
243}
244
245// Returns true if the buffer is secure
246static inline bool isSecureBuffer(const private_handle_t* hnd) {
247    return (hnd && (private_handle_t::PRIV_FLAGS_SECURE_BUFFER & hnd->flags));
248}
249//Return true if buffer is marked locked
250static inline bool isBufferLocked(const private_handle_t* hnd) {
251    return (hnd && (private_handle_t::PRIV_FLAGS_HWC_LOCK & hnd->flags));
252}
253
254//Return true if buffer is for external display only
255static inline bool isExtOnly(const private_handle_t* hnd) {
256    return (hnd && (hnd->flags & private_handle_t::PRIV_FLAGS_EXTERNAL_ONLY));
257}
258
259//Return true if buffer is for external display only with a BLOCK flag.
260static inline bool isExtBlock(const private_handle_t* hnd) {
261    return (hnd && (hnd->flags & private_handle_t::PRIV_FLAGS_EXTERNAL_BLOCK));
262}
263
264//Return true if buffer is for external display only with a Close Caption flag.
265static inline bool isExtCC(const private_handle_t* hnd) {
266    return (hnd && (hnd->flags & private_handle_t::PRIV_FLAGS_EXTERNAL_CC));
267}
268
269template<typename T> inline T max(T a, T b) { return (a > b) ? a : b; }
270template<typename T> inline T min(T a, T b) { return (a < b) ? a : b; }
271
272// Initialize uevent thread
273void init_uevent_thread(hwc_context_t* ctx);
274// Initialize vsync thread
275void init_vsync_thread(hwc_context_t* ctx);
276
277inline void getLayerResolution(const hwc_layer_1_t* layer,
278                               int& width, int& height)
279{
280    hwc_rect_t displayFrame  = layer->displayFrame;
281    width = displayFrame.right - displayFrame.left;
282    height = displayFrame.bottom - displayFrame.top;
283}
284
285static inline int openFb(int dpy) {
286    int fd = -1;
287    const char *devtmpl = "/dev/graphics/fb%u";
288    char name[64] = {0};
289    snprintf(name, 64, devtmpl, dpy);
290    fd = open(name, O_RDWR);
291    return fd;
292}
293
294template <class T>
295inline void swap(T& a, T& b) {
296    T tmp = a;
297    a = b;
298    b = tmp;
299}
300
301}; //qhwc namespace
302
303// -----------------------------------------------------------------------------
304// HWC context
305// This structure contains overall state
306struct hwc_context_t {
307    hwc_composer_device_1_t device;
308    const hwc_procs_t* proc;
309
310    //CopyBit objects
311    qhwc::CopyBit *mCopyBit[HWC_NUM_DISPLAY_TYPES];
312
313    //Overlay object - NULL for non overlay devices
314    overlay::Overlay *mOverlay;
315    //Holds a few rot objects
316    overlay::RotMgr *mRotMgr;
317
318    //Primary and external FB updater
319    qhwc::IFBUpdate *mFBUpdate[HWC_NUM_DISPLAY_TYPES];
320    // External display related information
321    qhwc::ExternalDisplay *mExtDisplay;
322    qhwc::VirtualDisplay *mVirtualDisplay;
323    qhwc::MDPInfo mMDP;
324    qhwc::VsyncState vstate;
325    qhwc::DisplayAttributes dpyAttr[HWC_NUM_DISPLAY_TYPES];
326    qhwc::ListStats listStats[HWC_NUM_DISPLAY_TYPES];
327    qhwc::LayerProp *layerProp[HWC_NUM_DISPLAY_TYPES];
328    qhwc::MDPComp *mMDPComp[HWC_NUM_DISPLAY_TYPES];
329    qhwc::HwcDebug *mHwcDebug[HWC_NUM_DISPLAY_TYPES];
330    qhwc::AssertiveDisplay *mAD;
331
332    // No animation on External display feature
333    // Notifies hwcomposer about the device orientation before animation.
334    int deviceOrientation;
335    // Stores the crop, dest rect and transform value of video before animation.
336    hwc_rect_t mPrevCropVideo;
337    hwc_rect_t mPrevDestVideo;
338    int mPrevTransformVideo;
339    //Securing in progress indicator
340    bool mSecuring;
341    //WFD on proprietary stack
342    bool mVirtualonExtActive;
343    //Display in secure mode indicator
344    bool mSecureMode;
345    //Lock to prevent set from being called while blanking
346    mutable Locker mBlankLock;
347    //Lock to protect prepare & set when detaching external disp
348    mutable Locker mExtLock;
349    /*Lock to set both mSecureMode and mSecuring as part
350      of binder thread without context switch to composition
351      thread. This lock is needed only for A-family targets
352      since the state of mSecureMode and mSecuring variables
353      are not checked in B-family targets.
354    */
355    mutable Locker mSecureLock;
356    //Drawing round when we use GPU
357    bool isPaddingRound;
358    // External Orientation
359    int mExtOrientation;
360    //Flags the transition of a video session
361    bool mVideoTransFlag;
362    qhwc::LayerRotMap *mLayerRotMap[HWC_NUM_DISPLAY_TYPES];
363};
364
365namespace qhwc {
366static inline bool isSkipPresent (hwc_context_t *ctx, int dpy) {
367    return  ctx->listStats[dpy].skipCount;
368}
369
370static inline bool isYuvPresent (hwc_context_t *ctx, int dpy) {
371    return  ctx->listStats[dpy].yuvCount;
372}
373};
374
375#endif //HWC_UTILS_H
376