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