HWComposer.h revision 51d22007386f171e1c696786ddce957e78fc4a03 
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#ifndef ANDROID_SF_HWCOMPOSER_H
18#define ANDROID_SF_HWCOMPOSER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <hardware/hwcomposer_defs.h>
24
25#include <ui/Fence.h>
26
27#include <utils/BitSet.h>
28#include <utils/Condition.h>
29#include <utils/Mutex.h>
30#include <utils/StrongPointer.h>
31#include <utils/Thread.h>
32#include <utils/Timers.h>
33#include <utils/Vector.h>
34
35extern "C" int clock_nanosleep(clockid_t clock_id, int flags,
36                           const struct timespec *request,
37                           struct timespec *remain);
38
39struct hwc_composer_device_1;
40struct hwc_display_contents_1;
41struct hwc_layer_1;
42struct hwc_procs;
43struct framebuffer_device_t;
44
45namespace android {
46// ---------------------------------------------------------------------------
47
48class GraphicBuffer;
49class Fence;
50class LayerBase;
51class Region;
52class String8;
53class SurfaceFlinger;
54
55class HWComposer
56{
57public:
58    class EventHandler {
59        friend class HWComposer;
60        virtual void onVSyncReceived(int disp, nsecs_t timestamp) = 0;
61        virtual void onHotplugReceived(int disp, bool connected) = 0;
62    protected:
63        virtual ~EventHandler() {}
64    };
65
66    enum {
67        MAX_DISPLAYS = HWC_NUM_DISPLAY_TYPES + 1
68    };
69
70    HWComposer(
71            const sp<SurfaceFlinger>& flinger,
72            EventHandler& handler);
73
74    ~HWComposer();
75
76    status_t initCheck() const;
77
78    // returns a display ID starting at MAX_DISPLAYS, this ID
79    // is to be used with createWorkList (and all other
80    // methods requiring an ID below).
81    // IDs below MAX_DISPLAY are pre-defined and therefore are always valid.
82    // returns a negative error code if an ID cannot be allocated
83    int32_t allocateDisplayId();
84
85    // recycles the given ID and frees the associated worklist.
86    // IDs below MAX_DISPLAYS are not recycled
87    status_t freeDisplayId(int32_t id);
88
89
90    // Asks the HAL what it can do
91    status_t prepare();
92
93    // commits the list
94    status_t commit();
95
96    // release hardware resources and blank screen
97    status_t release(int disp);
98
99    // acquire hardware resources and unblank screen
100    status_t acquire(int disp);
101
102    // reset state when an external, non-virtual display is disconnected
103    void disconnectDisplay(int disp);
104
105    // create a work list for numLayers layer. sets HWC_GEOMETRY_CHANGED.
106    status_t createWorkList(int32_t id, size_t numLayers);
107
108    bool supportsFramebufferTarget() const;
109
110    // does this display have layers handled by HWC
111    bool hasHwcComposition(int32_t id) const;
112
113    // does this display have layers handled by GLES
114    bool hasGlesComposition(int32_t id) const;
115
116    // get the releaseFence file descriptor for the given display
117    // the release fence is only valid after commit()
118    int getAndResetReleaseFenceFd(int32_t id);
119
120    // needed forward declarations
121    class LayerListIterator;
122
123    // return the visual id to be used to find a suitable EGLConfig for
124    // *ALL* displays.
125    int getVisualID() const;
126
127    // Forwarding to FB HAL for pre-HWC-1.1 code (see FramebufferSurface).
128    int fbPost(int32_t id, const sp<Fence>& acquireFence, const sp<GraphicBuffer>& buf);
129    int fbCompositionComplete();
130    void fbDump(String8& result);
131
132    /*
133     * Interface to hardware composer's layers functionality.
134     * This abstracts the HAL interface to layers which can evolve in
135     * incompatible ways from one release to another.
136     * The idea is that we could extend this interface as we add
137     * features to h/w composer.
138     */
139    class HWCLayerInterface {
140    protected:
141        virtual ~HWCLayerInterface() { }
142    public:
143        virtual int32_t getCompositionType() const = 0;
144        virtual uint32_t getHints() const = 0;
145        virtual int getAndResetReleaseFenceFd() = 0;
146        virtual void setDefaultState() = 0;
147        virtual void setSkip(bool skip) = 0;
148        virtual void setBlending(uint32_t blending) = 0;
149        virtual void setTransform(uint32_t transform) = 0;
150        virtual void setFrame(const Rect& frame) = 0;
151        virtual void setCrop(const Rect& crop) = 0;
152        virtual void setVisibleRegionScreen(const Region& reg) = 0;
153        virtual void setBuffer(const sp<GraphicBuffer>& buffer) = 0;
154        virtual void setAcquireFenceFd(int fenceFd) = 0;
155        virtual void onDisplayed() = 0;
156    };
157
158    /*
159     * Interface used to implement an iterator to a list
160     * of HWCLayer.
161     */
162    class HWCLayer : public HWCLayerInterface {
163        friend class LayerListIterator;
164        // select the layer at the given index
165        virtual status_t setLayer(size_t index) = 0;
166        virtual HWCLayer* dup() = 0;
167        static HWCLayer* copy(HWCLayer *rhs) {
168            return rhs ? rhs->dup() : NULL;
169        }
170    protected:
171        virtual ~HWCLayer() { }
172    };
173
174    /*
175     * Iterator through a HWCLayer list.
176     * This behaves more or less like a forward iterator.
177     */
178    class LayerListIterator {
179        friend struct HWComposer;
180        HWCLayer* const mLayerList;
181        size_t mIndex;
182
183        LayerListIterator() : mLayerList(NULL), mIndex(0) { }
184
185        LayerListIterator(HWCLayer* layer, size_t index)
186            : mLayerList(layer), mIndex(index) { }
187
188        // we don't allow assignment, because we don't need it for now
189        LayerListIterator& operator = (const LayerListIterator& rhs);
190
191    public:
192        // copy operators
193        LayerListIterator(const LayerListIterator& rhs)
194            : mLayerList(HWCLayer::copy(rhs.mLayerList)), mIndex(rhs.mIndex) {
195        }
196
197        ~LayerListIterator() { delete mLayerList; }
198
199        // pre-increment
200        LayerListIterator& operator++() {
201            mLayerList->setLayer(++mIndex);
202            return *this;
203        }
204
205        // dereference
206        HWCLayerInterface& operator * () { return *mLayerList; }
207        HWCLayerInterface* operator -> () { return mLayerList; }
208
209        // comparison
210        bool operator == (const LayerListIterator& rhs) const {
211            return mIndex == rhs.mIndex;
212        }
213        bool operator != (const LayerListIterator& rhs) const {
214            return !operator==(rhs);
215        }
216    };
217
218    // Returns an iterator to the beginning of the layer list
219    LayerListIterator begin(int32_t id);
220
221    // Returns an iterator to the end of the layer list
222    LayerListIterator end(int32_t id);
223
224
225    // Events handling ---------------------------------------------------------
226
227    enum {
228        EVENT_VSYNC = HWC_EVENT_VSYNC
229    };
230
231    void eventControl(int disp, int event, int enabled);
232
233    // Query display parameters.  Pass in a display index (e.g.
234    // HWC_DISPLAY_PRIMARY).
235    nsecs_t getRefreshPeriod(int disp) const;
236    nsecs_t getRefreshTimestamp(int disp) const;
237    sp<Fence> getDisplayFence(int disp) const;
238    uint32_t getWidth(int disp) const;
239    uint32_t getHeight(int disp) const;
240    uint32_t getFormat(int disp) const;
241    float getDpiX(int disp) const;
242    float getDpiY(int disp) const;
243    bool isConnected(int disp) const;
244
245    // this class is only used to fake the VSync event on systems that don't
246    // have it.
247    class VSyncThread : public Thread {
248        HWComposer& mHwc;
249        mutable Mutex mLock;
250        Condition mCondition;
251        bool mEnabled;
252        mutable nsecs_t mNextFakeVSync;
253        nsecs_t mRefreshPeriod;
254        virtual void onFirstRef();
255        virtual bool threadLoop();
256    public:
257        VSyncThread(HWComposer& hwc);
258        void setEnabled(bool enabled);
259    };
260
261    friend class VSyncThread;
262
263    // for debugging ----------------------------------------------------------
264    void dump(String8& out, char* scratch, size_t SIZE) const;
265
266private:
267    void loadHwcModule();
268    void loadFbHalModule();
269
270    LayerListIterator getLayerIterator(int32_t id, size_t index);
271
272    struct cb_context;
273
274    static void hook_invalidate(const struct hwc_procs* procs);
275    static void hook_vsync(const struct hwc_procs* procs, int disp,
276            int64_t timestamp);
277    static void hook_hotplug(const struct hwc_procs* procs, int disp,
278            int connected);
279
280    inline void invalidate();
281    inline void vsync(int disp, int64_t timestamp);
282    inline void hotplug(int disp, int connected);
283
284    status_t queryDisplayProperties(int disp);
285
286    status_t setFramebufferTarget(int32_t id,
287            const sp<Fence>& acquireFence, const sp<GraphicBuffer>& buf);
288
289
290    struct DisplayData {
291        DisplayData() : xdpi(0), ydpi(0), refresh(0),
292            connected(false), hasFbComp(false), hasOvComp(false),
293            capacity(0), list(NULL),
294            framebufferTarget(NULL), fbTargetHandle(NULL), events(0) { }
295        ~DisplayData() {
296            free(list);
297        }
298        uint32_t width;
299        uint32_t height;
300        uint32_t format;    // pixel format from FB hal, for pre-hwc-1.1
301        float xdpi;
302        float ydpi;
303        nsecs_t refresh;
304        bool connected;
305        bool hasFbComp;
306        bool hasOvComp;
307        size_t capacity;
308        hwc_display_contents_1* list;
309        hwc_layer_1* framebufferTarget;
310        buffer_handle_t fbTargetHandle;
311        sp<Fence> lastRetireFence;  // signals when the last set op retires
312        sp<Fence> lastDisplayFence; // signals when the last set op takes
313                                    // effect on screen
314
315        // protected by mEventControlLock
316        int32_t events;
317    };
318
319    sp<SurfaceFlinger>              mFlinger;
320    framebuffer_device_t*           mFbDev;
321    struct hwc_composer_device_1*   mHwc;
322    // invariant: mLists[0] != NULL iff mHwc != NULL
323    // mLists[i>0] can be NULL. that display is to be ignored
324    struct hwc_display_contents_1*  mLists[MAX_DISPLAYS];
325    DisplayData                     mDisplayData[MAX_DISPLAYS];
326    size_t                          mNumDisplays;
327
328    cb_context*                     mCBContext;
329    EventHandler&                   mEventHandler;
330    size_t                          mVSyncCount;
331    sp<VSyncThread>                 mVSyncThread;
332    bool                            mDebugForceFakeVSync;
333    BitSet32                        mAllocatedDisplayIDs;
334
335    // protected by mLock
336    mutable Mutex mLock;
337    mutable nsecs_t mLastHwVSync;
338
339    // thread-safe
340    mutable Mutex mEventControlLock;
341};
342
343// ---------------------------------------------------------------------------
344}; // namespace android
345
346#endif // ANDROID_SF_HWCOMPOSER_H
347