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