HWComposer.cpp revision 74d211ae26a0257c6075a823812e40b55aa1e653 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define ATRACE_TAG ATRACE_TAG_GRAPHICS
18
19// Uncomment this to remove support for HWC_DEVICE_API_VERSION_0_3 and older
20#define HWC_REMOVE_DEPRECATED_VERSIONS 1
21
22#include <stdint.h>
23#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <sys/types.h>
27
28#include <utils/CallStack.h>
29#include <utils/Errors.h>
30#include <utils/misc.h>
31#include <utils/String8.h>
32#include <utils/Thread.h>
33#include <utils/Trace.h>
34#include <utils/Vector.h>
35
36#include <ui/GraphicBuffer.h>
37
38#include <hardware/hardware.h>
39#include <hardware/hwcomposer.h>
40
41#include <android/configuration.h>
42
43#include <cutils/log.h>
44#include <cutils/properties.h>
45
46#include "HWComposer.h"
47
48#include "../Layer.h"           // needed only for debugging
49#include "../SurfaceFlinger.h"
50
51namespace android {
52
53#define MIN_HWC_HEADER_VERSION HWC_HEADER_VERSION
54
55#define NUM_PHYSICAL_DISPLAYS HWC_NUM_DISPLAY_TYPES
56#define VIRTUAL_DISPLAY_ID_BASE HWC_NUM_DISPLAY_TYPES
57
58static uint32_t hwcApiVersion(const hwc_composer_device_1_t* hwc) {
59    uint32_t hwcVersion = hwc->common.version;
60    return hwcVersion & HARDWARE_API_VERSION_2_MAJ_MIN_MASK;
61}
62
63static uint32_t hwcHeaderVersion(const hwc_composer_device_1_t* hwc) {
64    uint32_t hwcVersion = hwc->common.version;
65    return hwcVersion & HARDWARE_API_VERSION_2_HEADER_MASK;
66}
67
68static bool hwcHasApiVersion(const hwc_composer_device_1_t* hwc,
69        uint32_t version) {
70    return hwcApiVersion(hwc) >= (version & HARDWARE_API_VERSION_2_MAJ_MIN_MASK);
71}
72
73// ---------------------------------------------------------------------------
74
75struct HWComposer::cb_context {
76    struct callbacks : public hwc_procs_t {
77        // these are here to facilitate the transition when adding
78        // new callbacks (an implementation can check for NULL before
79        // calling a new callback).
80        void (*zero[4])(void);
81    };
82    callbacks procs;
83    HWComposer* hwc;
84};
85
86// ---------------------------------------------------------------------------
87
88HWComposer::HWComposer(
89        const sp<SurfaceFlinger>& flinger,
90        EventHandler& handler)
91    : mFlinger(flinger),
92      mFbDev(0), mHwc(0), mNumDisplays(1),
93      mCBContext(new cb_context),
94      mEventHandler(handler),
95      mVSyncCount(0), mDebugForceFakeVSync(false)
96{
97    for (size_t i =0 ; i<MAX_DISPLAYS ; i++) {
98        mLists[i] = 0;
99    }
100
101    char value[PROPERTY_VALUE_MAX];
102    property_get("debug.sf.no_hw_vsync", value, "0");
103    mDebugForceFakeVSync = atoi(value);
104
105    bool needVSyncThread = true;
106
107    // Note: some devices may insist that the FB HAL be opened before HWC.
108    int fberr = loadFbHalModule();
109    loadHwcModule();
110
111    if (mFbDev && mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
112        // close FB HAL if we don't needed it.
113        // FIXME: this is temporary until we're not forced to open FB HAL
114        // before HWC.
115        framebuffer_close(mFbDev);
116        mFbDev = NULL;
117    }
118
119    // If we have no HWC, or a pre-1.1 HWC, an FB dev is mandatory.
120    if ((!mHwc || !hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1))
121            && !mFbDev) {
122        ALOGE("ERROR: failed to open framebuffer (%s), aborting",
123                strerror(-fberr));
124        abort();
125    }
126
127    // these display IDs are always reserved
128    for (size_t i=0 ; i<NUM_PHYSICAL_DISPLAYS ; i++) {
129        mAllocatedDisplayIDs.markBit(i);
130    }
131
132    if (mHwc) {
133        ALOGI("Using %s version %u.%u", HWC_HARDWARE_COMPOSER,
134              (hwcApiVersion(mHwc) >> 24) & 0xff,
135              (hwcApiVersion(mHwc) >> 16) & 0xff);
136        if (mHwc->registerProcs) {
137            mCBContext->hwc = this;
138            mCBContext->procs.invalidate = &hook_invalidate;
139            mCBContext->procs.vsync = &hook_vsync;
140            if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1))
141                mCBContext->procs.hotplug = &hook_hotplug;
142            else
143                mCBContext->procs.hotplug = NULL;
144            memset(mCBContext->procs.zero, 0, sizeof(mCBContext->procs.zero));
145            mHwc->registerProcs(mHwc, &mCBContext->procs);
146        }
147
148        // don't need a vsync thread if we have a hardware composer
149        needVSyncThread = false;
150        // always turn vsync off when we start
151        eventControl(HWC_DISPLAY_PRIMARY, HWC_EVENT_VSYNC, 0);
152
153        // the number of displays we actually have depends on the
154        // hw composer version
155        if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_2)) {
156            // 1.2 adds support for virtual displays
157            mNumDisplays = MAX_DISPLAYS;
158        } else if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
159            // 1.1 adds support for multiple displays
160            mNumDisplays = NUM_PHYSICAL_DISPLAYS;
161        } else {
162            mNumDisplays = 1;
163        }
164    }
165
166    if (mFbDev) {
167        ALOG_ASSERT(!(mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)),
168                "should only have fbdev if no hwc or hwc is 1.0");
169
170        DisplayData& disp(mDisplayData[HWC_DISPLAY_PRIMARY]);
171        disp.connected = true;
172        disp.width = mFbDev->width;
173        disp.height = mFbDev->height;
174        disp.format = mFbDev->format;
175        disp.xdpi = mFbDev->xdpi;
176        disp.ydpi = mFbDev->ydpi;
177        if (disp.refresh == 0) {
178            disp.refresh = nsecs_t(1e9 / mFbDev->fps);
179            ALOGW("getting VSYNC period from fb HAL: %lld", disp.refresh);
180        }
181        if (disp.refresh == 0) {
182            disp.refresh = nsecs_t(1e9 / 60.0);
183            ALOGW("getting VSYNC period from thin air: %lld",
184                    mDisplayData[HWC_DISPLAY_PRIMARY].refresh);
185        }
186    } else if (mHwc) {
187        // here we're guaranteed to have at least HWC 1.1
188        for (size_t i =0 ; i<NUM_PHYSICAL_DISPLAYS ; i++) {
189            queryDisplayProperties(i);
190        }
191    }
192
193    if (needVSyncThread) {
194        // we don't have VSYNC support, we need to fake it
195        mVSyncThread = new VSyncThread(*this);
196    }
197}
198
199HWComposer::~HWComposer() {
200    if (mHwc) {
201        eventControl(HWC_DISPLAY_PRIMARY, HWC_EVENT_VSYNC, 0);
202    }
203    if (mVSyncThread != NULL) {
204        mVSyncThread->requestExitAndWait();
205    }
206    if (mHwc) {
207        hwc_close_1(mHwc);
208    }
209    if (mFbDev) {
210        framebuffer_close(mFbDev);
211    }
212    delete mCBContext;
213}
214
215// Load and prepare the hardware composer module.  Sets mHwc.
216void HWComposer::loadHwcModule()
217{
218    hw_module_t const* module;
219
220    if (hw_get_module(HWC_HARDWARE_MODULE_ID, &module) != 0) {
221        ALOGE("%s module not found", HWC_HARDWARE_MODULE_ID);
222        return;
223    }
224
225    int err = hwc_open_1(module, &mHwc);
226    if (err) {
227        ALOGE("%s device failed to initialize (%s)",
228              HWC_HARDWARE_COMPOSER, strerror(-err));
229        return;
230    }
231
232    if (!hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_0) ||
233            hwcHeaderVersion(mHwc) < MIN_HWC_HEADER_VERSION ||
234            hwcHeaderVersion(mHwc) > HWC_HEADER_VERSION) {
235        ALOGE("%s device version %#x unsupported, will not be used",
236              HWC_HARDWARE_COMPOSER, mHwc->common.version);
237        hwc_close_1(mHwc);
238        mHwc = NULL;
239        return;
240    }
241}
242
243// Load and prepare the FB HAL, which uses the gralloc module.  Sets mFbDev.
244int HWComposer::loadFbHalModule()
245{
246    hw_module_t const* module;
247
248    int err = hw_get_module(GRALLOC_HARDWARE_MODULE_ID, &module);
249    if (err != 0) {
250        ALOGE("%s module not found", GRALLOC_HARDWARE_MODULE_ID);
251        return err;
252    }
253
254    return framebuffer_open(module, &mFbDev);
255}
256
257status_t HWComposer::initCheck() const {
258    return mHwc ? NO_ERROR : NO_INIT;
259}
260
261void HWComposer::hook_invalidate(const struct hwc_procs* procs) {
262    cb_context* ctx = reinterpret_cast<cb_context*>(
263            const_cast<hwc_procs_t*>(procs));
264    ctx->hwc->invalidate();
265}
266
267void HWComposer::hook_vsync(const struct hwc_procs* procs, int disp,
268        int64_t timestamp) {
269    cb_context* ctx = reinterpret_cast<cb_context*>(
270            const_cast<hwc_procs_t*>(procs));
271    ctx->hwc->vsync(disp, timestamp);
272}
273
274void HWComposer::hook_hotplug(const struct hwc_procs* procs, int disp,
275        int connected) {
276    cb_context* ctx = reinterpret_cast<cb_context*>(
277            const_cast<hwc_procs_t*>(procs));
278    ctx->hwc->hotplug(disp, connected);
279}
280
281void HWComposer::invalidate() {
282    mFlinger->repaintEverything();
283}
284
285void HWComposer::vsync(int disp, int64_t timestamp) {
286    ATRACE_INT("VSYNC", ++mVSyncCount&1);
287    mEventHandler.onVSyncReceived(disp, timestamp);
288    Mutex::Autolock _l(mLock);
289    mLastHwVSync = timestamp;
290}
291
292void HWComposer::hotplug(int disp, int connected) {
293    if (disp == HWC_DISPLAY_PRIMARY || disp >= VIRTUAL_DISPLAY_ID_BASE) {
294        ALOGE("hotplug event received for invalid display: disp=%d connected=%d",
295                disp, connected);
296        return;
297    }
298    queryDisplayProperties(disp);
299    mEventHandler.onHotplugReceived(disp, bool(connected));
300}
301
302static float getDefaultDensity(uint32_t height) {
303    if (height >= 1080) return ACONFIGURATION_DENSITY_XHIGH;
304    else                return ACONFIGURATION_DENSITY_TV;
305}
306
307static const uint32_t DISPLAY_ATTRIBUTES[] = {
308    HWC_DISPLAY_VSYNC_PERIOD,
309    HWC_DISPLAY_WIDTH,
310    HWC_DISPLAY_HEIGHT,
311    HWC_DISPLAY_DPI_X,
312    HWC_DISPLAY_DPI_Y,
313    HWC_DISPLAY_NO_ATTRIBUTE,
314};
315#define NUM_DISPLAY_ATTRIBUTES (sizeof(DISPLAY_ATTRIBUTES) / sizeof(DISPLAY_ATTRIBUTES)[0])
316
317status_t HWComposer::queryDisplayProperties(int disp) {
318
319    LOG_ALWAYS_FATAL_IF(!mHwc || !hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1));
320
321    // use zero as default value for unspecified attributes
322    int32_t values[NUM_DISPLAY_ATTRIBUTES - 1];
323    memset(values, 0, sizeof(values));
324
325    uint32_t config;
326    size_t numConfigs = 1;
327    status_t err = mHwc->getDisplayConfigs(mHwc, disp, &config, &numConfigs);
328    if (err != NO_ERROR) {
329        // this can happen if an unpluggable display is not connected
330        mDisplayData[disp].connected = false;
331        return err;
332    }
333
334    err = mHwc->getDisplayAttributes(mHwc, disp, config, DISPLAY_ATTRIBUTES, values);
335    if (err != NO_ERROR) {
336        // we can't get this display's info. turn it off.
337        mDisplayData[disp].connected = false;
338        return err;
339    }
340
341    int32_t w = 0, h = 0;
342    for (size_t i = 0; i < NUM_DISPLAY_ATTRIBUTES - 1; i++) {
343        switch (DISPLAY_ATTRIBUTES[i]) {
344        case HWC_DISPLAY_VSYNC_PERIOD:
345            mDisplayData[disp].refresh = nsecs_t(values[i]);
346            break;
347        case HWC_DISPLAY_WIDTH:
348            mDisplayData[disp].width = values[i];
349            break;
350        case HWC_DISPLAY_HEIGHT:
351            mDisplayData[disp].height = values[i];
352            break;
353        case HWC_DISPLAY_DPI_X:
354            mDisplayData[disp].xdpi = values[i] / 1000.0f;
355            break;
356        case HWC_DISPLAY_DPI_Y:
357            mDisplayData[disp].ydpi = values[i] / 1000.0f;
358            break;
359        default:
360            ALOG_ASSERT(false, "unknown display attribute[%d] %#x",
361                    i, DISPLAY_ATTRIBUTES[i]);
362            break;
363        }
364    }
365
366    // FIXME: what should we set the format to?
367    mDisplayData[disp].format = HAL_PIXEL_FORMAT_RGBA_8888;
368    mDisplayData[disp].connected = true;
369    if (mDisplayData[disp].xdpi == 0.0f || mDisplayData[disp].ydpi == 0.0f) {
370        float dpi = getDefaultDensity(h);
371        mDisplayData[disp].xdpi = dpi;
372        mDisplayData[disp].ydpi = dpi;
373    }
374    return NO_ERROR;
375}
376
377status_t HWComposer::setVirtualDisplayProperties(int32_t id,
378        uint32_t w, uint32_t h, uint32_t format) {
379    if (id < VIRTUAL_DISPLAY_ID_BASE || id >= int32_t(mNumDisplays) ||
380            !mAllocatedDisplayIDs.hasBit(id)) {
381        return BAD_INDEX;
382    }
383    mDisplayData[id].width = w;
384    mDisplayData[id].height = h;
385    mDisplayData[id].format = format;
386    mDisplayData[id].xdpi = mDisplayData[id].ydpi = getDefaultDensity(h);
387    return NO_ERROR;
388}
389
390int32_t HWComposer::allocateDisplayId() {
391    if (mAllocatedDisplayIDs.count() >= mNumDisplays) {
392        return NO_MEMORY;
393    }
394    int32_t id = mAllocatedDisplayIDs.firstUnmarkedBit();
395    mAllocatedDisplayIDs.markBit(id);
396    mDisplayData[id].connected = true;
397    return id;
398}
399
400status_t HWComposer::freeDisplayId(int32_t id) {
401    if (id < NUM_PHYSICAL_DISPLAYS) {
402        // cannot free the reserved IDs
403        return BAD_VALUE;
404    }
405    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id)) {
406        return BAD_INDEX;
407    }
408    mAllocatedDisplayIDs.clearBit(id);
409    mDisplayData[id].connected = false;
410    return NO_ERROR;
411}
412
413nsecs_t HWComposer::getRefreshPeriod(int disp) const {
414    return mDisplayData[disp].refresh;
415}
416
417nsecs_t HWComposer::getRefreshTimestamp(int disp) const {
418    // this returns the last refresh timestamp.
419    // if the last one is not available, we estimate it based on
420    // the refresh period and whatever closest timestamp we have.
421    Mutex::Autolock _l(mLock);
422    nsecs_t now = systemTime(CLOCK_MONOTONIC);
423    return now - ((now - mLastHwVSync) %  mDisplayData[disp].refresh);
424}
425
426sp<Fence> HWComposer::getDisplayFence(int disp) const {
427    return mDisplayData[disp].lastDisplayFence;
428}
429
430uint32_t HWComposer::getWidth(int disp) const {
431    return mDisplayData[disp].width;
432}
433
434uint32_t HWComposer::getHeight(int disp) const {
435    return mDisplayData[disp].height;
436}
437
438uint32_t HWComposer::getFormat(int disp) const {
439    return mDisplayData[disp].format;
440}
441
442float HWComposer::getDpiX(int disp) const {
443    return mDisplayData[disp].xdpi;
444}
445
446float HWComposer::getDpiY(int disp) const {
447    return mDisplayData[disp].ydpi;
448}
449
450bool HWComposer::isConnected(int disp) const {
451    return mDisplayData[disp].connected;
452}
453
454void HWComposer::eventControl(int disp, int event, int enabled) {
455    if (uint32_t(disp)>31 || !mAllocatedDisplayIDs.hasBit(disp)) {
456        ALOGD("eventControl ignoring event %d on unallocated disp %d (en=%d)",
457              event, disp, enabled);
458        return;
459    }
460    if (event != EVENT_VSYNC) {
461        ALOGW("eventControl got unexpected event %d (disp=%d en=%d)",
462              event, disp, enabled);
463        return;
464    }
465    status_t err = NO_ERROR;
466    if (mHwc && !mDebugForceFakeVSync) {
467        // NOTE: we use our own internal lock here because we have to call
468        // into the HWC with the lock held, and we want to make sure
469        // that even if HWC blocks (which it shouldn't), it won't
470        // affect other threads.
471        Mutex::Autolock _l(mEventControlLock);
472        const int32_t eventBit = 1UL << event;
473        const int32_t newValue = enabled ? eventBit : 0;
474        const int32_t oldValue = mDisplayData[disp].events & eventBit;
475        if (newValue != oldValue) {
476            ATRACE_CALL();
477            err = mHwc->eventControl(mHwc, disp, event, enabled);
478            if (!err) {
479                int32_t& events(mDisplayData[disp].events);
480                events = (events & ~eventBit) | newValue;
481            }
482        }
483        // error here should not happen -- not sure what we should
484        // do if it does.
485        ALOGE_IF(err, "eventControl(%d, %d) failed %s",
486                event, enabled, strerror(-err));
487    }
488
489    if (err == NO_ERROR && mVSyncThread != NULL) {
490        mVSyncThread->setEnabled(enabled);
491    }
492}
493
494status_t HWComposer::createWorkList(int32_t id, size_t numLayers) {
495    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id)) {
496        return BAD_INDEX;
497    }
498
499    if (mHwc) {
500        DisplayData& disp(mDisplayData[id]);
501        if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
502            // we need space for the HWC_FRAMEBUFFER_TARGET
503            numLayers++;
504        }
505        if (disp.capacity < numLayers || disp.list == NULL) {
506            size_t size = sizeof(hwc_display_contents_1_t)
507                    + numLayers * sizeof(hwc_layer_1_t);
508            free(disp.list);
509            disp.list = (hwc_display_contents_1_t*)malloc(size);
510            disp.capacity = numLayers;
511        }
512        if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
513            disp.framebufferTarget = &disp.list->hwLayers[numLayers - 1];
514            memset(disp.framebufferTarget, 0, sizeof(hwc_layer_1_t));
515            const hwc_rect_t r = { 0, 0, (int) disp.width, (int) disp.height };
516            disp.framebufferTarget->compositionType = HWC_FRAMEBUFFER_TARGET;
517            disp.framebufferTarget->hints = 0;
518            disp.framebufferTarget->flags = 0;
519            disp.framebufferTarget->handle = disp.fbTargetHandle;
520            disp.framebufferTarget->transform = 0;
521            disp.framebufferTarget->blending = HWC_BLENDING_PREMULT;
522            disp.framebufferTarget->sourceCrop = r;
523            disp.framebufferTarget->displayFrame = r;
524            disp.framebufferTarget->visibleRegionScreen.numRects = 1;
525            disp.framebufferTarget->visibleRegionScreen.rects =
526                &disp.framebufferTarget->displayFrame;
527            disp.framebufferTarget->acquireFenceFd = -1;
528            disp.framebufferTarget->releaseFenceFd = -1;
529            disp.framebufferTarget->planeAlpha = 0xFF;
530        }
531        disp.list->retireFenceFd = -1;
532        disp.list->flags = HWC_GEOMETRY_CHANGED;
533        disp.list->numHwLayers = numLayers;
534    }
535    return NO_ERROR;
536}
537
538status_t HWComposer::setFramebufferTarget(int32_t id,
539        const sp<Fence>& acquireFence, const sp<GraphicBuffer>& buf) {
540    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id)) {
541        return BAD_INDEX;
542    }
543    DisplayData& disp(mDisplayData[id]);
544    if (!disp.framebufferTarget) {
545        // this should never happen, but apparently eglCreateWindowSurface()
546        // triggers a Surface::queueBuffer()  on some
547        // devices (!?) -- log and ignore.
548        ALOGE("HWComposer: framebufferTarget is null");
549        return NO_ERROR;
550    }
551
552    int acquireFenceFd = -1;
553    if (acquireFence->isValid()) {
554        acquireFenceFd = acquireFence->dup();
555    }
556
557    // ALOGD("fbPost: handle=%p, fence=%d", buf->handle, acquireFenceFd);
558    disp.fbTargetHandle = buf->handle;
559    disp.framebufferTarget->handle = disp.fbTargetHandle;
560    disp.framebufferTarget->acquireFenceFd = acquireFenceFd;
561    return NO_ERROR;
562}
563
564status_t HWComposer::prepare() {
565    for (size_t i=0 ; i<mNumDisplays ; i++) {
566        DisplayData& disp(mDisplayData[i]);
567        if (disp.framebufferTarget) {
568            // make sure to reset the type to HWC_FRAMEBUFFER_TARGET
569            // DO NOT reset the handle field to NULL, because it's possible
570            // that we have nothing to redraw (eg: eglSwapBuffers() not called)
571            // in which case, we should continue to use the same buffer.
572            LOG_FATAL_IF(disp.list == NULL);
573            disp.framebufferTarget->compositionType = HWC_FRAMEBUFFER_TARGET;
574        }
575        if (!disp.connected && disp.list != NULL) {
576            ALOGW("WARNING: disp %d: connected, non-null list, layers=%d",
577                  i, disp.list->numHwLayers);
578        }
579        mLists[i] = disp.list;
580        if (mLists[i]) {
581            if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_2)) {
582                mLists[i]->outbuf = NULL;
583                mLists[i]->outbufAcquireFenceFd = -1;
584            } else if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
585                // garbage data to catch improper use
586                mLists[i]->dpy = (hwc_display_t)0xDEADBEEF;
587                mLists[i]->sur = (hwc_surface_t)0xDEADBEEF;
588            } else {
589                mLists[i]->dpy = EGL_NO_DISPLAY;
590                mLists[i]->sur = EGL_NO_SURFACE;
591            }
592        }
593    }
594
595    int err = mHwc->prepare(mHwc, mNumDisplays, mLists);
596    ALOGE_IF(err, "HWComposer: prepare failed (%s)", strerror(-err));
597
598    if (err == NO_ERROR) {
599        // here we're just making sure that "skip" layers are set
600        // to HWC_FRAMEBUFFER and we're also counting how many layers
601        // we have of each type.
602        for (size_t i=0 ; i<mNumDisplays ; i++) {
603            DisplayData& disp(mDisplayData[i]);
604            disp.hasFbComp = false;
605            disp.hasOvComp = false;
606            if (disp.list) {
607                for (size_t i=0 ; i<disp.list->numHwLayers ; i++) {
608                    hwc_layer_1_t& l = disp.list->hwLayers[i];
609
610                    //ALOGD("prepare: %d, type=%d, handle=%p",
611                    //        i, l.compositionType, l.handle);
612
613                    if (l.flags & HWC_SKIP_LAYER) {
614                        l.compositionType = HWC_FRAMEBUFFER;
615                    }
616                    if (l.compositionType == HWC_FRAMEBUFFER) {
617                        disp.hasFbComp = true;
618                    }
619                    if (l.compositionType == HWC_OVERLAY) {
620                        disp.hasOvComp = true;
621                    }
622                }
623            }
624        }
625    }
626    return (status_t)err;
627}
628
629bool HWComposer::hasHwcComposition(int32_t id) const {
630    if (!mHwc || uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id))
631        return false;
632    return mDisplayData[id].hasOvComp;
633}
634
635bool HWComposer::hasGlesComposition(int32_t id) const {
636    if (!mHwc || uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id))
637        return true;
638    return mDisplayData[id].hasFbComp;
639}
640
641sp<Fence> HWComposer::getAndResetReleaseFence(int32_t id) {
642    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id))
643        return Fence::NO_FENCE;
644
645    int fd = INVALID_OPERATION;
646    if (mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
647        const DisplayData& disp(mDisplayData[id]);
648        if (disp.framebufferTarget) {
649            fd = disp.framebufferTarget->releaseFenceFd;
650            disp.framebufferTarget->acquireFenceFd = -1;
651            disp.framebufferTarget->releaseFenceFd = -1;
652        }
653    }
654    return fd >= 0 ? new Fence(fd) : Fence::NO_FENCE;
655}
656
657status_t HWComposer::commit() {
658    int err = NO_ERROR;
659    if (mHwc) {
660        if (!hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
661            // On version 1.0, the OpenGL ES target surface is communicated
662            // by the (dpy, sur) fields and we are guaranteed to have only
663            // a single display.
664            mLists[0]->dpy = eglGetCurrentDisplay();
665            mLists[0]->sur = eglGetCurrentSurface(EGL_DRAW);
666        }
667
668        for (size_t i=VIRTUAL_DISPLAY_ID_BASE; i<mNumDisplays; i++) {
669            DisplayData& disp(mDisplayData[i]);
670            if (disp.outbufHandle) {
671                mLists[i]->outbuf = disp.outbufHandle;
672                mLists[i]->outbufAcquireFenceFd =
673                        disp.outbufAcquireFence->dup();
674            }
675        }
676
677        err = mHwc->set(mHwc, mNumDisplays, mLists);
678
679        for (size_t i=0 ; i<mNumDisplays ; i++) {
680            DisplayData& disp(mDisplayData[i]);
681            disp.lastDisplayFence = disp.lastRetireFence;
682            disp.lastRetireFence = Fence::NO_FENCE;
683            if (disp.list) {
684                if (disp.list->retireFenceFd != -1) {
685                    disp.lastRetireFence = new Fence(disp.list->retireFenceFd);
686                    disp.list->retireFenceFd = -1;
687                }
688                disp.list->flags &= ~HWC_GEOMETRY_CHANGED;
689            }
690        }
691    }
692    return (status_t)err;
693}
694
695status_t HWComposer::release(int disp) {
696    LOG_FATAL_IF(disp >= VIRTUAL_DISPLAY_ID_BASE);
697    if (mHwc) {
698        eventControl(disp, HWC_EVENT_VSYNC, 0);
699        return (status_t)mHwc->blank(mHwc, disp, 1);
700    }
701    return NO_ERROR;
702}
703
704status_t HWComposer::acquire(int disp) {
705    LOG_FATAL_IF(disp >= VIRTUAL_DISPLAY_ID_BASE);
706    if (mHwc) {
707        return (status_t)mHwc->blank(mHwc, disp, 0);
708    }
709    return NO_ERROR;
710}
711
712void HWComposer::disconnectDisplay(int disp) {
713    LOG_ALWAYS_FATAL_IF(disp < 0 || disp == HWC_DISPLAY_PRIMARY);
714    DisplayData& dd(mDisplayData[disp]);
715    free(dd.list);
716    dd.list = NULL;
717    dd.framebufferTarget = NULL;    // points into dd.list
718    dd.fbTargetHandle = NULL;
719    dd.outbufHandle = NULL;
720    dd.lastRetireFence = Fence::NO_FENCE;
721    dd.lastDisplayFence = Fence::NO_FENCE;
722    dd.outbufAcquireFence = Fence::NO_FENCE;
723}
724
725int HWComposer::getVisualID() const {
726    if (mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
727        // FIXME: temporary hack until HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED
728        // is supported by the implementation. we can only be in this case
729        // if we have HWC 1.1
730        return HAL_PIXEL_FORMAT_RGBA_8888;
731        //return HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED;
732    } else {
733        return mFbDev->format;
734    }
735}
736
737bool HWComposer::supportsFramebufferTarget() const {
738    return (mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1));
739}
740
741int HWComposer::fbPost(int32_t id,
742        const sp<Fence>& acquireFence, const sp<GraphicBuffer>& buffer) {
743    if (mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
744        return setFramebufferTarget(id, acquireFence, buffer);
745    } else {
746        acquireFence->waitForever(1000, "HWComposer::fbPost");
747        return mFbDev->post(mFbDev, buffer->handle);
748    }
749}
750
751int HWComposer::fbCompositionComplete() {
752    if (mHwc && hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1))
753        return NO_ERROR;
754
755    if (mFbDev->compositionComplete) {
756        return mFbDev->compositionComplete(mFbDev);
757    } else {
758        return INVALID_OPERATION;
759    }
760}
761
762void HWComposer::fbDump(String8& result) {
763    if (mFbDev && mFbDev->common.version >= 1 && mFbDev->dump) {
764        const size_t SIZE = 4096;
765        char buffer[SIZE];
766        mFbDev->dump(mFbDev, buffer, SIZE);
767        result.append(buffer);
768    }
769}
770
771status_t HWComposer::setOutputBuffer(int32_t id, const sp<Fence>& acquireFence,
772        const sp<GraphicBuffer>& buf) {
773    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id))
774        return BAD_INDEX;
775    if (id < VIRTUAL_DISPLAY_ID_BASE)
776        return INVALID_OPERATION;
777
778    DisplayData& disp(mDisplayData[id]);
779    disp.outbufHandle = buf->handle;
780    disp.outbufAcquireFence = acquireFence;
781    return NO_ERROR;
782}
783
784sp<Fence> HWComposer::getLastRetireFence(int32_t id) {
785    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id))
786        return Fence::NO_FENCE;
787    return mDisplayData[id].lastRetireFence;
788}
789
790/*
791 * Helper template to implement a concrete HWCLayer
792 * This holds the pointer to the concrete hwc layer type
793 * and implements the "iterable" side of HWCLayer.
794 */
795template<typename CONCRETE, typename HWCTYPE>
796class Iterable : public HWComposer::HWCLayer {
797protected:
798    HWCTYPE* const mLayerList;
799    HWCTYPE* mCurrentLayer;
800    Iterable(HWCTYPE* layer) : mLayerList(layer), mCurrentLayer(layer) { }
801    inline HWCTYPE const * getLayer() const { return mCurrentLayer; }
802    inline HWCTYPE* getLayer() { return mCurrentLayer; }
803    virtual ~Iterable() { }
804private:
805    // returns a copy of ourselves
806    virtual HWComposer::HWCLayer* dup() {
807        return new CONCRETE( static_cast<const CONCRETE&>(*this) );
808    }
809    virtual status_t setLayer(size_t index) {
810        mCurrentLayer = &mLayerList[index];
811        return NO_ERROR;
812    }
813};
814
815/*
816 * Concrete implementation of HWCLayer for HWC_DEVICE_API_VERSION_1_0.
817 * This implements the HWCLayer side of HWCIterableLayer.
818 */
819class HWCLayerVersion1 : public Iterable<HWCLayerVersion1, hwc_layer_1_t> {
820    struct hwc_composer_device_1* mHwc;
821public:
822    HWCLayerVersion1(struct hwc_composer_device_1* hwc, hwc_layer_1_t* layer)
823        : Iterable<HWCLayerVersion1, hwc_layer_1_t>(layer), mHwc(hwc) { }
824
825    virtual int32_t getCompositionType() const {
826        return getLayer()->compositionType;
827    }
828    virtual uint32_t getHints() const {
829        return getLayer()->hints;
830    }
831    virtual sp<Fence> getAndResetReleaseFence() {
832        int fd = getLayer()->releaseFenceFd;
833        getLayer()->releaseFenceFd = -1;
834        return fd >= 0 ? new Fence(fd) : Fence::NO_FENCE;
835    }
836    virtual void setAcquireFenceFd(int fenceFd) {
837        getLayer()->acquireFenceFd = fenceFd;
838    }
839    virtual void setPerFrameDefaultState() {
840        //getLayer()->compositionType = HWC_FRAMEBUFFER;
841    }
842    virtual void setPlaneAlpha(uint8_t alpha) {
843        if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_2)) {
844            getLayer()->planeAlpha = alpha;
845        } else {
846            if (alpha < 0xFF) {
847                getLayer()->flags |= HWC_SKIP_LAYER;
848            }
849        }
850    }
851    virtual void setDefaultState() {
852        hwc_layer_1_t* const l = getLayer();
853        l->compositionType = HWC_FRAMEBUFFER;
854        l->hints = 0;
855        l->flags = HWC_SKIP_LAYER;
856        l->handle = 0;
857        l->transform = 0;
858        l->blending = HWC_BLENDING_NONE;
859        l->visibleRegionScreen.numRects = 0;
860        l->visibleRegionScreen.rects = NULL;
861        l->acquireFenceFd = -1;
862        l->releaseFenceFd = -1;
863        l->planeAlpha = 0xFF;
864    }
865    virtual void setSkip(bool skip) {
866        if (skip) {
867            getLayer()->flags |= HWC_SKIP_LAYER;
868        } else {
869            getLayer()->flags &= ~HWC_SKIP_LAYER;
870        }
871    }
872    virtual void setBlending(uint32_t blending) {
873        getLayer()->blending = blending;
874    }
875    virtual void setTransform(uint32_t transform) {
876        getLayer()->transform = transform;
877    }
878    virtual void setFrame(const Rect& frame) {
879        reinterpret_cast<Rect&>(getLayer()->displayFrame) = frame;
880    }
881    virtual void setCrop(const Rect& crop) {
882        reinterpret_cast<Rect&>(getLayer()->sourceCrop) = crop;
883    }
884    virtual void setVisibleRegionScreen(const Region& reg) {
885        // Region::getSharedBuffer creates a reference to the underlying
886        // SharedBuffer of this Region, this reference is freed
887        // in onDisplayed()
888        hwc_region_t& visibleRegion = getLayer()->visibleRegionScreen;
889        SharedBuffer const* sb = reg.getSharedBuffer(&visibleRegion.numRects);
890        visibleRegion.rects = reinterpret_cast<hwc_rect_t const *>(sb->data());
891    }
892    virtual void setBuffer(const sp<GraphicBuffer>& buffer) {
893        if (buffer == 0 || buffer->handle == 0) {
894            getLayer()->compositionType = HWC_FRAMEBUFFER;
895            getLayer()->flags |= HWC_SKIP_LAYER;
896            getLayer()->handle = 0;
897        } else {
898            getLayer()->handle = buffer->handle;
899        }
900    }
901    virtual void onDisplayed() {
902        hwc_region_t& visibleRegion = getLayer()->visibleRegionScreen;
903        SharedBuffer const* sb = SharedBuffer::bufferFromData(visibleRegion.rects);
904        if (sb) {
905            sb->release();
906            // not technically needed but safer
907            visibleRegion.numRects = 0;
908            visibleRegion.rects = NULL;
909        }
910
911        getLayer()->acquireFenceFd = -1;
912    }
913};
914
915/*
916 * returns an iterator initialized at a given index in the layer list
917 */
918HWComposer::LayerListIterator HWComposer::getLayerIterator(int32_t id, size_t index) {
919    if (uint32_t(id)>31 || !mAllocatedDisplayIDs.hasBit(id)) {
920        return LayerListIterator();
921    }
922    const DisplayData& disp(mDisplayData[id]);
923    if (!mHwc || !disp.list || index > disp.list->numHwLayers) {
924        return LayerListIterator();
925    }
926    return LayerListIterator(new HWCLayerVersion1(mHwc, disp.list->hwLayers), index);
927}
928
929/*
930 * returns an iterator on the beginning of the layer list
931 */
932HWComposer::LayerListIterator HWComposer::begin(int32_t id) {
933    return getLayerIterator(id, 0);
934}
935
936/*
937 * returns an iterator on the end of the layer list
938 */
939HWComposer::LayerListIterator HWComposer::end(int32_t id) {
940    size_t numLayers = 0;
941    if (uint32_t(id) <= 31 && mAllocatedDisplayIDs.hasBit(id)) {
942        const DisplayData& disp(mDisplayData[id]);
943        if (mHwc && disp.list) {
944            numLayers = disp.list->numHwLayers;
945            if (hwcHasApiVersion(mHwc, HWC_DEVICE_API_VERSION_1_1)) {
946                // with HWC 1.1, the last layer is always the HWC_FRAMEBUFFER_TARGET,
947                // which we ignore when iterating through the layer list.
948                ALOGE_IF(!numLayers, "mDisplayData[%d].list->numHwLayers is 0", id);
949                if (numLayers) {
950                    numLayers--;
951                }
952            }
953        }
954    }
955    return getLayerIterator(id, numLayers);
956}
957
958void HWComposer::dump(String8& result) const {
959    if (mHwc) {
960        result.appendFormat("Hardware Composer state (version %8x):\n", hwcApiVersion(mHwc));
961        result.appendFormat("  mDebugForceFakeVSync=%d\n", mDebugForceFakeVSync);
962        for (size_t i=0 ; i<mNumDisplays ; i++) {
963            const DisplayData& disp(mDisplayData[i]);
964            if (!disp.connected)
965                continue;
966
967            const Vector< sp<Layer> >& visibleLayersSortedByZ =
968                    mFlinger->getLayerSortedByZForHwcDisplay(i);
969
970            result.appendFormat(
971                    "  Display[%d] : %ux%u, xdpi=%f, ydpi=%f, refresh=%lld\n",
972                    i, disp.width, disp.height, disp.xdpi, disp.ydpi, disp.refresh);
973
974            if (disp.list) {
975                result.appendFormat(
976                        "  numHwLayers=%u, flags=%08x\n",
977                        disp.list->numHwLayers, disp.list->flags);
978
979                result.append(
980                        "    type    |  handle  |   hints  |   flags  | tr | blend |  format  |       source crop         |           frame           name \n"
981                        "------------+----------+----------+----------+----+-------+----------+---------------------------+--------------------------------\n");
982                //      " __________ | ________ | ________ | ________ | __ | _____ | ________ | [_____,_____,_____,_____] | [_____,_____,_____,_____]
983                for (size_t i=0 ; i<disp.list->numHwLayers ; i++) {
984                    const hwc_layer_1_t&l = disp.list->hwLayers[i];
985                    int32_t format = -1;
986                    String8 name("unknown");
987
988                    if (i < visibleLayersSortedByZ.size()) {
989                        const sp<Layer>& layer(visibleLayersSortedByZ[i]);
990                        const sp<GraphicBuffer>& buffer(
991                                layer->getActiveBuffer());
992                        if (buffer != NULL) {
993                            format = buffer->getPixelFormat();
994                        }
995                        name = layer->getName();
996                    }
997
998                    int type = l.compositionType;
999                    if (type == HWC_FRAMEBUFFER_TARGET) {
1000                        name = "HWC_FRAMEBUFFER_TARGET";
1001                        format = disp.format;
1002                    }
1003
1004                    static char const* compositionTypeName[] = {
1005                            "GLES",
1006                            "HWC",
1007                            "BACKGROUND",
1008                            "FB TARGET",
1009                            "UNKNOWN"};
1010                    if (type >= NELEM(compositionTypeName))
1011                        type = NELEM(compositionTypeName) - 1;
1012
1013                    result.appendFormat(
1014                            " %10s | %08x | %08x | %08x | %02x | %05x | %08x | [%5d,%5d,%5d,%5d] | [%5d,%5d,%5d,%5d] %s\n",
1015                                    compositionTypeName[type],
1016                                    intptr_t(l.handle), l.hints, l.flags, l.transform, l.blending, format,
1017                                    l.sourceCrop.left, l.sourceCrop.top, l.sourceCrop.right, l.sourceCrop.bottom,
1018                                    l.displayFrame.left, l.displayFrame.top, l.displayFrame.right, l.displayFrame.bottom,
1019                                    name.string());
1020                }
1021            }
1022        }
1023    }
1024
1025    if (mHwc && mHwc->dump) {
1026        const size_t SIZE = 4096;
1027        char buffer[SIZE];
1028        mHwc->dump(mHwc, buffer, SIZE);
1029        result.append(buffer);
1030    }
1031}
1032
1033// ---------------------------------------------------------------------------
1034
1035HWComposer::VSyncThread::VSyncThread(HWComposer& hwc)
1036    : mHwc(hwc), mEnabled(false),
1037      mNextFakeVSync(0),
1038      mRefreshPeriod(hwc.getRefreshPeriod(HWC_DISPLAY_PRIMARY))
1039{
1040}
1041
1042void HWComposer::VSyncThread::setEnabled(bool enabled) {
1043    Mutex::Autolock _l(mLock);
1044    if (mEnabled != enabled) {
1045        mEnabled = enabled;
1046        mCondition.signal();
1047    }
1048}
1049
1050void HWComposer::VSyncThread::onFirstRef() {
1051    run("VSyncThread", PRIORITY_URGENT_DISPLAY + PRIORITY_MORE_FAVORABLE);
1052}
1053
1054bool HWComposer::VSyncThread::threadLoop() {
1055    { // scope for lock
1056        Mutex::Autolock _l(mLock);
1057        while (!mEnabled) {
1058            mCondition.wait(mLock);
1059        }
1060    }
1061
1062    const nsecs_t period = mRefreshPeriod;
1063    const nsecs_t now = systemTime(CLOCK_MONOTONIC);
1064    nsecs_t next_vsync = mNextFakeVSync;
1065    nsecs_t sleep = next_vsync - now;
1066    if (sleep < 0) {
1067        // we missed, find where the next vsync should be
1068        sleep = (period - ((now - next_vsync) % period));
1069        next_vsync = now + sleep;
1070    }
1071    mNextFakeVSync = next_vsync + period;
1072
1073    struct timespec spec;
1074    spec.tv_sec  = next_vsync / 1000000000;
1075    spec.tv_nsec = next_vsync % 1000000000;
1076
1077    int err;
1078    do {
1079        err = clock_nanosleep(CLOCK_MONOTONIC, TIMER_ABSTIME, &spec, NULL);
1080    } while (err<0 && errno == EINTR);
1081
1082    if (err == 0) {
1083        mHwc.mEventHandler.onVSyncReceived(0, next_vsync);
1084    }
1085
1086    return true;
1087}
1088
1089HWComposer::DisplayData::DisplayData()
1090:   width(0), height(0), format(0),
1091    xdpi(0.0f), ydpi(0.0f),
1092    refresh(0),
1093    connected(false),
1094    hasFbComp(false), hasOvComp(false),
1095    capacity(0), list(NULL),
1096    framebufferTarget(NULL), fbTargetHandle(0),
1097    lastRetireFence(Fence::NO_FENCE), lastDisplayFence(Fence::NO_FENCE),
1098    outbufHandle(NULL), outbufAcquireFence(Fence::NO_FENCE),
1099    events(0)
1100{}
1101
1102HWComposer::DisplayData::~DisplayData() {
1103    free(list);
1104}
1105
1106// ---------------------------------------------------------------------------
1107}; // namespace android
1108