DrmHwcTwo.h

   1 /*
   2  * Copyright (C) 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 #ifndef ANDROID_DRM_HWC_TWO_H_
  18 #define ANDROID_DRM_HWC_TWO_H_
  19
  20 #include <hardware/hwcomposer2.h>
  21 #include <math.h>
  22
  23 #include <array>
  24 #include <map>
  25
  26 #include "compositor/DrmDisplayCompositor.h"
  27 #include "drm/ResourceManager.h"
  28 #include "drm/VSyncWorker.h"
  29 #include "drmhwcomposer.h"
  30 #include "platform/platform.h"
  31
  32 namespace android {
  33
  34 class Backend;
  35
  36 class DrmHwcTwo : public hwc2_device_t {
  37  public:
  38   static int HookDevOpen(const struct hw_module_t *module, const char *name,
  39                          struct hw_device_t **dev);
  40
  41   DrmHwcTwo();
  42
  43   HWC2::Error Init();
  44
  45   hwc2_callback_data_t hotplug_callback_data_ = NULL;
  46   HWC2_PFN_HOTPLUG hotplug_callback_hook_ = NULL;
  47   std::mutex hotplug_callback_lock;
  48
  49   void SetHotplugCallback(hwc2_callback_data_t data,
  50                           hwc2_function_pointer_t hook) {
  51     const std::lock_guard<std::mutex> lock(hotplug_callback_lock);
  52     hotplug_callback_data_ = data;
  53     hotplug_callback_hook_ = reinterpret_cast<HWC2_PFN_HOTPLUG>(hook);
  54   }
  55
  56   class HwcLayer {
  57    public:
  58     HWC2::Composition sf_type() const {
  59       return sf_type_;
  60     }
  61     HWC2::Composition validated_type() const {
  62       return validated_type_;
  63     }
  64     void accept_type_change() {
  65       sf_type_ = validated_type_;
  66     }
  67     void set_validated_type(HWC2::Composition type) {
  68       validated_type_ = type;
  69     }
  70     bool type_changed() const {
  71       return sf_type_ != validated_type_;
  72     }
  73
  74     uint32_t z_order() const {
  75       return z_order_;
  76     }
  77
  78     buffer_handle_t buffer() {
  79       return buffer_;
  80     }
  81     void set_buffer(buffer_handle_t buffer) {
  82       buffer_ = buffer;
  83     }
  84
  85     int take_acquire_fence() {
  86       return acquire_fence_.Release();
  87     }
  88     void set_acquire_fence(int acquire_fence) {
  89       acquire_fence_.Set(dup(acquire_fence));
  90     }
  91
  92     int release_fence() {
  93       return release_fence_.get();
  94     }
  95     int take_release_fence() {
  96       return release_fence_.Release();
  97     }
  98     void manage_release_fence() {
  99       release_fence_.Set(release_fence_raw_);
 100       release_fence_raw_ = -1;
 101     }
 102     OutputFd release_fence_output() {
 103       return OutputFd(&release_fence_raw_);
 104     }
 105
 106     hwc_rect_t display_frame() {
 107       return display_frame_;
 108     }
 109
 110     void PopulateDrmLayer(DrmHwcLayer *layer);
 111
 112     bool RequireScalingOrPhasing() {
 113       float src_width = source_crop_.right - source_crop_.left;
 114       float src_height = source_crop_.bottom - source_crop_.top;
 115
 116       float dest_width = display_frame_.right - display_frame_.left;
 117       float dest_height = display_frame_.bottom - display_frame_.top;
 118
 119       bool scaling = src_width != dest_width || src_height != dest_height;
 120       bool phasing = (source_crop_.left - floor(source_crop_.left) != 0) ||
 121                      (source_crop_.top - floor(source_crop_.top) != 0);
 122       return scaling || phasing;
 123     }
 124
 125     // Layer hooks
 126     HWC2::Error SetCursorPosition(int32_t x, int32_t y);
 127     HWC2::Error SetLayerBlendMode(int32_t mode);
 128     HWC2::Error SetLayerBuffer(buffer_handle_t buffer, int32_t acquire_fence);
 129     HWC2::Error SetLayerColor(hwc_color_t color);
 130     HWC2::Error SetLayerCompositionType(int32_t type);
 131     HWC2::Error SetLayerDataspace(int32_t dataspace);
 132     HWC2::Error SetLayerDisplayFrame(hwc_rect_t frame);
 133     HWC2::Error SetLayerPlaneAlpha(float alpha);
 134     HWC2::Error SetLayerSidebandStream(const native_handle_t *stream);
 135     HWC2::Error SetLayerSourceCrop(hwc_frect_t crop);
 136     HWC2::Error SetLayerSurfaceDamage(hwc_region_t damage);
 137     HWC2::Error SetLayerTransform(int32_t transform);
 138     HWC2::Error SetLayerVisibleRegion(hwc_region_t visible);
 139     HWC2::Error SetLayerZOrder(uint32_t z);
 140
 141    private:
 142     // sf_type_ stores the initial type given to us by surfaceflinger,
 143     // validated_type_ stores the type after running ValidateDisplay
 144     HWC2::Composition sf_type_ = HWC2::Composition::Invalid;
 145     HWC2::Composition validated_type_ = HWC2::Composition::Invalid;
 146
 147     HWC2::BlendMode blending_ = HWC2::BlendMode::None;
 148     buffer_handle_t buffer_ = NULL;
 149     UniqueFd acquire_fence_;
 150     int release_fence_raw_ = -1;
 151     UniqueFd release_fence_;
 152     hwc_rect_t display_frame_;
 153     float alpha_ = 1.0f;
 154     hwc_frect_t source_crop_;
 155     int32_t cursor_x_;
 156     int32_t cursor_y_;
 157     hwc_color_t layer_color_;
 158     HWC2::Transform transform_ = HWC2::Transform::None;
 159     uint32_t z_order_ = 0;
 160     android_dataspace_t dataspace_ = HAL_DATASPACE_UNKNOWN;
 161   };
 162
 163   class HwcDisplay {
 164    public:
 165     HwcDisplay(ResourceManager *resource_manager, DrmDevice *drm,
 166                std::shared_ptr<Importer> importer, hwc2_display_t handle,
 167                HWC2::DisplayType type);
 168     HwcDisplay(const HwcDisplay &) = delete;
 169     HWC2::Error Init(std::vector<DrmPlane *> *planes);
 170
 171     void RegisterVsyncCallback(hwc2_callback_data_t data,
 172                                hwc2_function_pointer_t func);
 173     void RegisterRefreshCallback(hwc2_callback_data_t data,
 174                                  hwc2_function_pointer_t func);
 175     HWC2::Error CreateComposition(bool test);
 176     bool HardwareSupportsLayerType(HWC2::Composition comp_type);
 177     uint32_t CalcPixOps(std::map<uint32_t, DrmHwcTwo::HwcLayer *> &z_map,
 178                         size_t first_z, size_t size);
 179     void MarkValidated(std::map<uint32_t, DrmHwcTwo::HwcLayer *> &z_map,
 180                        size_t client_first_z, size_t client_size);
 181
 182     void ClearDisplay();
 183
 184     std::string Dump();
 185
 186     // HWC Hooks
 187     HWC2::Error AcceptDisplayChanges();
 188     HWC2::Error CreateLayer(hwc2_layer_t *layer);
 189     HWC2::Error DestroyLayer(hwc2_layer_t layer);
 190     HWC2::Error GetActiveConfig(hwc2_config_t *config);
 191     HWC2::Error GetChangedCompositionTypes(uint32_t *num_elements,
 192                                            hwc2_layer_t *layers,
 193                                            int32_t *types);
 194     HWC2::Error GetClientTargetSupport(uint32_t width, uint32_t height,
 195                                        int32_t format, int32_t dataspace);
 196     HWC2::Error GetColorModes(uint32_t *num_modes, int32_t *modes);
 197     HWC2::Error GetDisplayAttribute(hwc2_config_t config, int32_t attribute,
 198                                     int32_t *value);
 199     HWC2::Error GetDisplayConfigs(uint32_t *num_configs,
 200                                   hwc2_config_t *configs);
 201     HWC2::Error GetDisplayName(uint32_t *size, char *name);
 202     HWC2::Error GetDisplayRequests(int32_t *display_requests,
 203                                    uint32_t *num_elements, hwc2_layer_t *layers,
 204                                    int32_t *layer_requests);
 205     HWC2::Error GetDisplayType(int32_t *type);
 206 #if PLATFORM_SDK_VERSION > 27
 207     HWC2::Error GetRenderIntents(int32_t mode, uint32_t *outNumIntents,
 208                                  int32_t *outIntents);
 209     HWC2::Error SetColorModeWithIntent(int32_t mode, int32_t intent);
 210 #endif
 211 #if PLATFORM_SDK_VERSION > 28
 212     HWC2::Error GetDisplayIdentificationData(uint8_t *outPort,
 213                                              uint32_t *outDataSize,
 214                                              uint8_t *outData);
 215     HWC2::Error GetDisplayCapabilities(uint32_t *outNumCapabilities,
 216                                        uint32_t *outCapabilities);
 217     HWC2::Error GetDisplayBrightnessSupport(bool *supported);
 218     HWC2::Error SetDisplayBrightness(float);
 219 #endif
 220     HWC2::Error GetDozeSupport(int32_t *support);
 221     HWC2::Error GetHdrCapabilities(uint32_t *num_types, int32_t *types,
 222                                    float *max_luminance,
 223                                    float *max_average_luminance,
 224                                    float *min_luminance);
 225     HWC2::Error GetReleaseFences(uint32_t *num_elements, hwc2_layer_t *layers,
 226                                  int32_t *fences);
 227     HWC2::Error PresentDisplay(int32_t *present_fence);
 228     HWC2::Error SetActiveConfig(hwc2_config_t config);
 229     HWC2::Error ChosePreferredConfig();
 230     HWC2::Error SetClientTarget(buffer_handle_t target, int32_t acquire_fence,
 231                                 int32_t dataspace, hwc_region_t damage);
 232     HWC2::Error SetColorMode(int32_t mode);
 233     HWC2::Error SetColorTransform(const float *matrix, int32_t hint);
 234     HWC2::Error SetOutputBuffer(buffer_handle_t buffer, int32_t release_fence);
 235     HWC2::Error SetPowerMode(int32_t mode);
 236     HWC2::Error SetVsyncEnabled(int32_t enabled);
 237     HWC2::Error ValidateDisplay(uint32_t *num_types, uint32_t *num_requests);
 238     HwcLayer *get_layer(hwc2_layer_t layer) {
 239       auto it = layers_.find(layer);
 240       if (it == layers_.end())
 241         return nullptr;
 242       return &it->second;
 243     }
 244
 245     /* Statistics */
 246     struct Stats {
 247       Stats minus(Stats b) {
 248         return {total_frames_ - b.total_frames_,
 249                 total_pixops_ - b.total_pixops_,
 250                 gpu_pixops_ - b.gpu_pixops_,
 251                 failed_kms_validate_ - b.failed_kms_validate_,
 252                 failed_kms_present_ - b.failed_kms_present_,
 253                 frames_flattened_ - b.frames_flattened_};
 254       }
 255
 256       uint32_t total_frames_ = 0;
 257       uint64_t total_pixops_ = 0;
 258       uint64_t gpu_pixops_ = 0;
 259       uint32_t failed_kms_validate_ = 0;
 260       uint32_t failed_kms_present_ = 0;
 261       uint32_t frames_flattened_ = 0;
 262     };
 263
 264     const Backend *backend() const {
 265       return backend_.get();
 266     }
 267     void set_backend(std::unique_ptr<Backend> backend) {
 268       backend_ = std::move(backend);
 269     }
 270
 271     const std::vector<DrmPlane *> &primary_planes() const {
 272       return primary_planes_;
 273     }
 274
 275     const std::vector<DrmPlane *> &overlay_planes() const {
 276       return overlay_planes_;
 277     }
 278
 279     std::map<hwc2_layer_t, HwcLayer> &layers() {
 280       return layers_;
 281     }
 282
 283     const DrmDisplayCompositor &compositor() const {
 284       return compositor_;
 285     }
 286
 287     const DrmDevice *drm() const {
 288       return drm_;
 289     }
 290
 291     const DrmConnector *connector() const {
 292       return connector_;
 293     }
 294
 295     const std::shared_ptr<Importer> &importer() const {
 296       return importer_;
 297     }
 298
 299     ResourceManager *resource_manager() const {
 300       return resource_manager_;
 301     }
 302
 303     android_color_transform_t &color_transform_hint() {
 304       return color_transform_hint_;
 305     }
 306
 307     Stats &total_stats() {
 308       return total_stats_;
 309     }
 310
 311    private:
 312     void AddFenceToPresentFence(int fd);
 313
 314     constexpr static size_t MATRIX_SIZE = 16;
 315
 316     ResourceManager *resource_manager_;
 317     DrmDevice *drm_;
 318     DrmDisplayCompositor compositor_;
 319     std::shared_ptr<Importer> importer_;
 320     std::unique_ptr<Planner> planner_;
 321
 322     std::vector<DrmPlane *> primary_planes_;
 323     std::vector<DrmPlane *> overlay_planes_;
 324
 325     std::unique_ptr<Backend> backend_;
 326
 327     VSyncWorker vsync_worker_;
 328     DrmConnector *connector_ = NULL;
 329     DrmCrtc *crtc_ = NULL;
 330     hwc2_display_t handle_;
 331     HWC2::DisplayType type_;
 332     uint32_t layer_idx_ = 0;
 333     std::map<hwc2_layer_t, HwcLayer> layers_;
 334     HwcLayer client_layer_;
 335     UniqueFd present_fence_;
 336     int32_t color_mode_;
 337     std::array<float, MATRIX_SIZE> color_transform_matrix_;
 338     android_color_transform_t color_transform_hint_;
 339
 340     uint32_t frame_no_ = 0;
 341     Stats total_stats_;
 342     Stats prev_stats_;
 343     std::string DumpDelta(DrmHwcTwo::HwcDisplay::Stats delta);
 344   };
 345
 346   class DrmHotplugHandler : public DrmEventHandler {
 347    public:
 348     DrmHotplugHandler(DrmHwcTwo *hwc2, DrmDevice *drm)
 349         : hwc2_(hwc2), drm_(drm) {
 350     }
 351     void HandleEvent(uint64_t timestamp_us);
 352
 353    private:
 354     DrmHwcTwo *hwc2_;
 355     DrmDevice *drm_;
 356   };
 357
 358  private:
 359   static DrmHwcTwo *toDrmHwcTwo(hwc2_device_t *dev) {
 360     return static_cast<DrmHwcTwo *>(dev);
 361   }
 362
 363   template <typename PFN, typename T>
 364   static hwc2_function_pointer_t ToHook(T function) {
 365     static_assert(std::is_same<PFN, T>::value, "Incompatible fn pointer");
 366     return reinterpret_cast<hwc2_function_pointer_t>(function);
 367   }
 368
 369   template <typename T, typename HookType, HookType func, typename... Args>
 370   static T DeviceHook(hwc2_device_t *dev, Args... args) {
 371     DrmHwcTwo *hwc = toDrmHwcTwo(dev);
 372     return static_cast<T>(((*hwc).*func)(std::forward<Args>(args)...));
 373   }
 374
 375   static HwcDisplay *GetDisplay(DrmHwcTwo *hwc, hwc2_display_t display_handle) {
 376     auto it = hwc->displays_.find(display_handle);
 377     if (it == hwc->displays_.end())
 378       return nullptr;
 379
 380     return &it->second;
 381   }
 382
 383   template <typename HookType, HookType func, typename... Args>
 384   static int32_t DisplayHook(hwc2_device_t *dev, hwc2_display_t display_handle,
 385                              Args... args) {
 386     HwcDisplay *display = GetDisplay(toDrmHwcTwo(dev), display_handle);
 387     if (!display)
 388       return static_cast<int32_t>(HWC2::Error::BadDisplay);
 389
 390     return static_cast<int32_t>((display->*func)(std::forward<Args>(args)...));
 391   }
 392
 393   template <typename HookType, HookType func, typename... Args>
 394   static int32_t LayerHook(hwc2_device_t *dev, hwc2_display_t display_handle,
 395                            hwc2_layer_t layer_handle, Args... args) {
 396     HwcDisplay *display = GetDisplay(toDrmHwcTwo(dev), display_handle);
 397     if (!display)
 398       return static_cast<int32_t>(HWC2::Error::BadDisplay);
 399
 400     HwcLayer *layer = display->get_layer(layer_handle);
 401     if (!layer)
 402       return static_cast<int32_t>(HWC2::Error::BadLayer);
 403
 404     return static_cast<int32_t>((layer->*func)(std::forward<Args>(args)...));
 405   }
 406
 407   // hwc2_device_t hooks
 408   static int HookDevClose(hw_device_t *dev);
 409   static void HookDevGetCapabilities(hwc2_device_t *dev, uint32_t *out_count,
 410                                      int32_t *out_capabilities);
 411   static hwc2_function_pointer_t HookDevGetFunction(struct hwc2_device *device,
 412                                                     int32_t descriptor);
 413
 414   // Device functions
 415   HWC2::Error CreateVirtualDisplay(uint32_t width, uint32_t height,
 416                                    int32_t *format, hwc2_display_t *display);
 417   HWC2::Error DestroyVirtualDisplay(hwc2_display_t display);
 418   void Dump(uint32_t *outSize, char *outBuffer);
 419   uint32_t GetMaxVirtualDisplayCount();
 420   HWC2::Error RegisterCallback(int32_t descriptor, hwc2_callback_data_t data,
 421                                hwc2_function_pointer_t function);
 422   HWC2::Error CreateDisplay(hwc2_display_t displ, HWC2::DisplayType type);
 423   void HandleDisplayHotplug(hwc2_display_t displayid, int state);
 424   void HandleInitialHotplugState(DrmDevice *drmDevice);
 425
 426   ResourceManager resource_manager_;
 427   std::map<hwc2_display_t, HwcDisplay> displays_;
 428
 429   std::string mDumpString;
 430 };
 431 }  // namespace android
 432
 433 #endif