1 /* 2 * Copyright 2016 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 #pragma once 18 19 #include "ComposerHal.h" 20 21 #include <optional> 22 #include <string> 23 #include <unordered_map> 24 #include <utility> 25 #include <vector> 26 27 // TODO(b/129481165): remove the #pragma below and fix conversion issues 28 #pragma clang diagnostic push 29 #pragma clang diagnostic ignored "-Wconversion" 30 #pragma clang diagnostic ignored "-Wextra" 31 32 #include <composer-command-buffer/2.4/ComposerCommandBuffer.h> 33 #include <gui/BufferQueue.h> 34 #include <gui/HdrMetadata.h> 35 #include <math/mat4.h> 36 #include <ui/DisplayedFrameStats.h> 37 #include <ui/GraphicBuffer.h> 38 #include <utils/StrongPointer.h> 39 40 #include <aidl/android/hardware/graphics/composer3/Composition.h> 41 42 // TODO(b/129481165): remove the #pragma below and fix conversion issues 43 #pragma clang diagnostic pop // ignored "-Wconversion -Wextra" 44 45 namespace android::Hwc2 { 46 47 namespace types = hardware::graphics::common; 48 49 namespace V2_1 = hardware::graphics::composer::V2_1; 50 namespace V2_2 = hardware::graphics::composer::V2_2; 51 namespace V2_3 = hardware::graphics::composer::V2_3; 52 namespace V2_4 = hardware::graphics::composer::V2_4; 53 54 using types::V1_0::ColorTransform; 55 using types::V1_0::Transform; 56 using types::V1_1::RenderIntent; 57 using types::V1_2::ColorMode; 58 using types::V1_2::Dataspace; 59 using types::V1_2::PixelFormat; 60 61 using V2_1::Config; 62 using V2_1::Display; 63 using V2_1::Error; 64 using V2_1::Layer; 65 using V2_4::CommandReaderBase; 66 using V2_4::CommandWriterBase; 67 using V2_4::IComposer; 68 using V2_4::IComposerCallback; 69 using V2_4::IComposerClient; 70 using V2_4::VsyncPeriodChangeTimeline; 71 using V2_4::VsyncPeriodNanos; 72 using PerFrameMetadata = IComposerClient::PerFrameMetadata; 73 using PerFrameMetadataKey = IComposerClient::PerFrameMetadataKey; 74 using PerFrameMetadataBlob = IComposerClient::PerFrameMetadataBlob; 75 76 class CommandReader : public CommandReaderBase { 77 public: 78 ~CommandReader(); 79 80 // Parse and execute commands from the command queue. The commands are 81 // actually return values from the server and will be saved in ReturnData. 82 Error parse(); 83 84 // Get and clear saved errors. 85 struct CommandError { 86 uint32_t location; 87 Error error; 88 }; 89 std::vector<CommandError> takeErrors(); 90 91 bool hasChanges(Display display, uint32_t* outNumChangedCompositionTypes, 92 uint32_t* outNumLayerRequestMasks) const; 93 94 // Get and clear saved changed composition types. 95 void takeChangedCompositionTypes( 96 Display display, std::vector<Layer>* outLayers, 97 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes); 98 99 // Get and clear saved display requests. 100 void takeDisplayRequests(Display display, uint32_t* outDisplayRequestMask, 101 std::vector<Layer>* outLayers, 102 std::vector<uint32_t>* outLayerRequestMasks); 103 104 // Get and clear saved release fences. 105 void takeReleaseFences(Display display, std::vector<Layer>* outLayers, 106 std::vector<int>* outReleaseFences); 107 108 // Get and clear saved present fence. 109 void takePresentFence(Display display, int* outPresentFence); 110 111 // Get what stage succeeded during PresentOrValidate: Present or Validate 112 void takePresentOrValidateStage(Display display, uint32_t* state); 113 114 // Get the client target properties requested by hardware composer. 115 void takeClientTargetProperty(Display display, 116 IComposerClient::ClientTargetProperty* outClientTargetProperty); 117 118 private: 119 void resetData(); 120 121 bool parseSelectDisplay(uint16_t length); 122 bool parseSetError(uint16_t length); 123 bool parseSetChangedCompositionTypes(uint16_t length); 124 bool parseSetDisplayRequests(uint16_t length); 125 bool parseSetPresentFence(uint16_t length); 126 bool parseSetReleaseFences(uint16_t length); 127 bool parseSetPresentOrValidateDisplayResult(uint16_t length); 128 bool parseSetClientTargetProperty(uint16_t length); 129 130 struct ReturnData { 131 uint32_t displayRequests = 0; 132 133 std::vector<Layer> changedLayers; 134 std::vector<aidl::android::hardware::graphics::composer3::Composition> compositionTypes; 135 136 std::vector<Layer> requestedLayers; 137 std::vector<uint32_t> requestMasks; 138 139 int presentFence = -1; 140 141 std::vector<Layer> releasedLayers; 142 std::vector<int> releaseFences; 143 144 uint32_t presentOrValidateState; 145 146 // Composer 2.4 implementation can return a client target property 147 // structure to indicate the client target properties that hardware 148 // composer requests. The composer client must change the client target 149 // properties to match this request. 150 IComposerClient::ClientTargetProperty clientTargetProperty{PixelFormat::RGBA_8888, 151 Dataspace::UNKNOWN}; 152 }; 153 154 std::vector<CommandError> mErrors; 155 std::unordered_map<Display, ReturnData> mReturnData; 156 157 // When SELECT_DISPLAY is parsed, this is updated to point to the 158 // display's return data in mReturnData. We use it to avoid repeated 159 // map lookups. 160 ReturnData* mCurrentReturnData; 161 }; 162 163 // Composer is a wrapper to IComposer, a proxy to server-side composer. 164 class HidlComposer final : public Composer { 165 public: 166 explicit HidlComposer(const std::string& serviceName); 167 ~HidlComposer() override; 168 169 bool isSupported(OptionalFeature) const; 170 171 std::vector<aidl::android::hardware::graphics::composer3::Capability> getCapabilities() 172 override; 173 std::string dumpDebugInfo() override; 174 175 void registerCallback(HWC2::ComposerCallback& callback) override; 176 177 // Explicitly flush all pending commands in the command buffer. 178 Error executeCommands(Display) override; 179 180 uint32_t getMaxVirtualDisplayCount() override; 181 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format, 182 Display* outDisplay) override; 183 Error destroyVirtualDisplay(Display display) override; 184 185 Error acceptDisplayChanges(Display display) override; 186 187 Error createLayer(Display display, Layer* outLayer) override; 188 Error destroyLayer(Display display, Layer layer) override; 189 190 Error getActiveConfig(Display display, Config* outConfig) override; 191 Error getChangedCompositionTypes( 192 Display display, std::vector<Layer>* outLayers, 193 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes) 194 override; 195 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override; 196 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute, 197 int32_t* outValue) override; 198 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs); 199 Error getDisplayName(Display display, std::string* outName) override; 200 201 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask, 202 std::vector<Layer>* outLayers, 203 std::vector<uint32_t>* outLayerRequestMasks) override; 204 205 Error getDozeSupport(Display display, bool* outSupport) override; 206 Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) override; 207 Error getHdrCapabilities(Display display, std::vector<Hdr>* outHdrTypes, float* outMaxLuminance, 208 float* outMaxAverageLuminance, float* outMinLuminance) override; 209 Error getOverlaySupport(aidl::android::hardware::graphics::composer3::OverlayProperties* 210 outProperties) override; 211 212 Error getReleaseFences(Display display, std::vector<Layer>* outLayers, 213 std::vector<int>* outReleaseFences) override; 214 215 Error presentDisplay(Display display, int* outPresentFence) override; 216 217 Error setActiveConfig(Display display, Config config) override; 218 219 /* 220 * The composer caches client targets internally. When target is nullptr, 221 * the composer uses slot to look up the client target from its cache. 222 * When target is not nullptr, the cache is updated with the new target. 223 */ 224 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target, 225 int acquireFence, Dataspace dataspace, 226 const std::vector<IComposerClient::Rect>& damage) override; 227 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override; 228 Error setColorTransform(Display display, const float* matrix) override; 229 Error setOutputBuffer(Display display, const native_handle_t* buffer, 230 int releaseFence) override; 231 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override; 232 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override; 233 234 Error setClientTargetSlotCount(Display display) override; 235 236 Error validateDisplay(Display display, nsecs_t expectedPresentTime, uint32_t* outNumTypes, 237 uint32_t* outNumRequests) override; 238 239 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime, 240 uint32_t* outNumTypes, uint32_t* outNumRequests, 241 int* outPresentFence, uint32_t* state) override; 242 243 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override; 244 /* see setClientTarget for the purpose of slot */ 245 Error setLayerBuffer(Display display, Layer layer, uint32_t slot, 246 const sp<GraphicBuffer>& buffer, int acquireFence) override; 247 Error setLayerBufferSlotsToClear(Display display, Layer layer, 248 const std::vector<uint32_t>& slotsToClear, 249 uint32_t activeBufferSlot) override; 250 Error setLayerSurfaceDamage(Display display, Layer layer, 251 const std::vector<IComposerClient::Rect>& damage) override; 252 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override; 253 Error setLayerColor(Display display, Layer layer, 254 const aidl::android::hardware::graphics::composer3::Color& color) override; 255 Error setLayerCompositionType( 256 Display display, Layer layer, 257 aidl::android::hardware::graphics::composer3::Composition type) override; 258 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override; 259 Error setLayerDisplayFrame(Display display, Layer layer, 260 const IComposerClient::Rect& frame) override; 261 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override; 262 Error setLayerSidebandStream(Display display, Layer layer, 263 const native_handle_t* stream) override; 264 Error setLayerSourceCrop(Display display, Layer layer, 265 const IComposerClient::FRect& crop) override; 266 Error setLayerTransform(Display display, Layer layer, Transform transform) override; 267 Error setLayerVisibleRegion(Display display, Layer layer, 268 const std::vector<IComposerClient::Rect>& visible) override; 269 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override; 270 271 // Composer HAL 2.2 272 Error setLayerPerFrameMetadata( 273 Display display, Layer layer, 274 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override; 275 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys( 276 Display display) override; 277 Error getRenderIntents(Display display, ColorMode colorMode, 278 std::vector<RenderIntent>* outRenderIntents) override; 279 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override; 280 281 // Composer HAL 2.3 282 Error getDisplayIdentificationData(Display display, uint8_t* outPort, 283 std::vector<uint8_t>* outData) override; 284 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override; 285 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat, 286 Dataspace* outDataspace, 287 uint8_t* outComponentMask) override; 288 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask, 289 uint64_t maxFrames) override; 290 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp, 291 DisplayedFrameStats* outStats) override; 292 Error setLayerPerFrameMetadataBlobs( 293 Display display, Layer layer, 294 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override; 295 Error setDisplayBrightness(Display display, float brightness, float brightnessNits, 296 const DisplayBrightnessOptions& options) override; 297 298 // Composer HAL 2.4 299 Error getDisplayCapabilities( 300 Display display, 301 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>* 302 outCapabilities) override; 303 V2_4::Error getDisplayConnectionType(Display display, 304 IComposerClient::DisplayConnectionType* outType) override; 305 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override; 306 V2_4::Error setActiveConfigWithConstraints( 307 Display display, Config config, 308 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints, 309 VsyncPeriodChangeTimeline* outTimeline) override; 310 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override; 311 V2_4::Error getSupportedContentTypes( 312 Display displayId, 313 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override; 314 V2_4::Error setContentType(Display displayId, 315 IComposerClient::ContentType contentType) override; 316 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key, 317 bool mandatory, const std::vector<uint8_t>& value) override; 318 V2_4::Error getLayerGenericMetadataKeys( 319 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override; 320 Error getClientTargetProperty( 321 Display display, 322 aidl::android::hardware::graphics::composer3::ClientTargetPropertyWithBrightness* 323 outClientTargetProperty) override; 324 325 // AIDL Composer HAL 326 Error setLayerBrightness(Display display, Layer layer, float brightness) override; 327 Error setLayerBlockingRegion(Display display, Layer layer, 328 const std::vector<IComposerClient::Rect>& blocking) override; 329 Error setBootDisplayConfig(Display displayId, Config) override; 330 Error clearBootDisplayConfig(Display displayId) override; 331 Error getPreferredBootDisplayConfig(Display displayId, Config*) override; 332 Error getDisplayDecorationSupport( 333 Display display, 334 std::optional<aidl::android::hardware::graphics::common::DisplayDecorationSupport>* 335 support) override; 336 Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) override; 337 338 Error getPhysicalDisplayOrientation(Display displayId, 339 AidlTransform* outDisplayOrientation) override; 340 void onHotplugConnect(Display) override; 341 void onHotplugDisconnect(Display) override; 342 Error getHdrConversionCapabilities( 343 std::vector<aidl::android::hardware::graphics::common::HdrConversionCapability>*) 344 override; 345 Error setHdrConversionStrategy(aidl::android::hardware::graphics::common::HdrConversionStrategy, 346 Hdr*) override; 347 Error setRefreshRateChangedCallbackDebugEnabled(Display, bool) override; 348 349 private: 350 class CommandWriter : public CommandWriterBase { 351 public: CommandWriter(uint32_t initialMaxSize)352 explicit CommandWriter(uint32_t initialMaxSize) : CommandWriterBase(initialMaxSize) {} ~CommandWriter()353 ~CommandWriter() override {} 354 }; 355 356 void registerCallback(const sp<IComposerCallback>& callback); 357 358 // Many public functions above simply write a command into the command 359 // queue to batch the calls. validateDisplay and presentDisplay will call 360 // this function to execute the command queue. 361 Error execute(); 362 363 sp<V2_1::IComposer> mComposer; 364 365 sp<V2_1::IComposerClient> mClient; 366 sp<V2_2::IComposerClient> mClient_2_2; 367 sp<V2_3::IComposerClient> mClient_2_3; 368 sp<IComposerClient> mClient_2_4; 369 370 // Buffer slots for layers are cleared by setting the slot buffer to this buffer. 371 sp<GraphicBuffer> mClearSlotBuffer; 372 373 // 64KiB minus a small space for metadata such as read/write pointers 374 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16; 375 // Max number of buffers that may be cached for a given layer 376 // We obtain this number by: 377 // 1. Tightly coupling this cache to the max size of BufferQueue 378 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h) 379 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1; 380 CommandWriter mWriter; 381 CommandReader mReader; 382 }; 383 384 } // namespace android::Hwc2 385