HWComposer.h revision 80e0a397a4712666661ecc629a64ec26e7f6aac3
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 Region; 51class String8; 52class SurfaceFlinger; 53 54class HWComposer 55{ 56public: 57 class EventHandler { 58 friend class HWComposer; 59 virtual void onVSyncReceived(int disp, nsecs_t timestamp) = 0; 60 virtual void onHotplugReceived(int disp, bool connected) = 0; 61 protected: 62 virtual ~EventHandler() {} 63 }; 64 65 enum { 66 MAX_DISPLAYS = HWC_NUM_DISPLAY_TYPES + 1 67 }; 68 69 HWComposer( 70 const sp<SurfaceFlinger>& flinger, 71 EventHandler& handler); 72 73 ~HWComposer(); 74 75 status_t initCheck() const; 76 77 // returns a display ID starting at MAX_DISPLAYS, this ID 78 // is to be used with createWorkList (and all other 79 // methods requiring an ID below). 80 // IDs below MAX_DISPLAY are pre-defined and therefore are always valid. 81 // returns a negative error code if an ID cannot be allocated 82 int32_t allocateDisplayId(); 83 84 // recycles the given ID and frees the associated worklist. 85 // IDs below MAX_DISPLAYS are not recycled 86 status_t freeDisplayId(int32_t id); 87 88 89 // Asks the HAL what it can do 90 status_t prepare(); 91 92 // commits the list 93 status_t commit(); 94 95 // release hardware resources and blank screen 96 status_t release(int disp); 97 98 // acquire hardware resources and unblank screen 99 status_t acquire(int disp); 100 101 // reset state when an external, non-virtual display is disconnected 102 void disconnectDisplay(int disp); 103 104 // create a work list for numLayers layer. sets HWC_GEOMETRY_CHANGED. 105 status_t createWorkList(int32_t id, size_t numLayers); 106 107 bool supportsFramebufferTarget() const; 108 109 // does this display have layers handled by HWC 110 bool hasHwcComposition(int32_t id) const; 111 112 // does this display have layers handled by GLES 113 bool hasGlesComposition(int32_t id) const; 114 115 // get the releaseFence file descriptor for a display's framebuffer layer. 116 // the release fence is only valid after commit() 117 int getAndResetReleaseFenceFd(int32_t id); 118 119 // needed forward declarations 120 class LayerListIterator; 121 122 // return the visual id to be used to find a suitable EGLConfig for 123 // *ALL* displays. 124 int getVisualID() const; 125 126 // Forwarding to FB HAL for pre-HWC-1.1 code (see FramebufferSurface). 127 int fbPost(int32_t id, const sp<Fence>& acquireFence, const sp<GraphicBuffer>& buf); 128 int fbCompositionComplete(); 129 void fbDump(String8& result); 130 131 /* 132 * Interface to hardware composer's layers functionality. 133 * This abstracts the HAL interface to layers which can evolve in 134 * incompatible ways from one release to another. 135 * The idea is that we could extend this interface as we add 136 * features to h/w composer. 137 */ 138 class HWCLayerInterface { 139 protected: 140 virtual ~HWCLayerInterface() { } 141 public: 142 virtual int32_t getCompositionType() const = 0; 143 virtual uint32_t getHints() const = 0; 144 virtual int getAndResetReleaseFenceFd() = 0; 145 virtual void setDefaultState() = 0; 146 virtual void setSkip(bool skip) = 0; 147 virtual void setBlending(uint32_t blending) = 0; 148 virtual void setTransform(uint32_t transform) = 0; 149 virtual void setFrame(const Rect& frame) = 0; 150 virtual void setCrop(const Rect& crop) = 0; 151 virtual void setVisibleRegionScreen(const Region& reg) = 0; 152 virtual void setBuffer(const sp<GraphicBuffer>& buffer) = 0; 153 virtual void setAcquireFenceFd(int fenceFd) = 0; 154 virtual void setPlaneAlpha(uint8_t alpha) = 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(); 292 ~DisplayData(); 293 uint32_t width; 294 uint32_t height; 295 uint32_t format; // pixel format from FB hal, for pre-hwc-1.1 296 float xdpi; 297 float ydpi; 298 nsecs_t refresh; 299 bool connected; 300 bool hasFbComp; 301 bool hasOvComp; 302 size_t capacity; 303 hwc_display_contents_1* list; 304 hwc_layer_1* framebufferTarget; 305 buffer_handle_t fbTargetHandle; 306 sp<Fence> lastRetireFence; // signals when the last set op retires 307 sp<Fence> lastDisplayFence; // signals when the last set op takes 308 // effect on screen 309 310 // protected by mEventControlLock 311 int32_t events; 312 }; 313 314 sp<SurfaceFlinger> mFlinger; 315 framebuffer_device_t* mFbDev; 316 struct hwc_composer_device_1* mHwc; 317 // invariant: mLists[0] != NULL iff mHwc != NULL 318 // mLists[i>0] can be NULL. that display is to be ignored 319 struct hwc_display_contents_1* mLists[MAX_DISPLAYS]; 320 DisplayData mDisplayData[MAX_DISPLAYS]; 321 size_t mNumDisplays; 322 323 cb_context* mCBContext; 324 EventHandler& mEventHandler; 325 size_t mVSyncCount; 326 sp<VSyncThread> mVSyncThread; 327 bool mDebugForceFakeVSync; 328 BitSet32 mAllocatedDisplayIDs; 329 330 // protected by mLock 331 mutable Mutex mLock; 332 mutable nsecs_t mLastHwVSync; 333 334 // thread-safe 335 mutable Mutex mEventControlLock; 336}; 337 338// --------------------------------------------------------------------------- 339}; // namespace android 340 341#endif // ANDROID_SF_HWCOMPOSER_H 342