1 /*
2  * Copyright (c) 2014-2020, The Linux Foundation. All rights reserved.
3  * Not a Contribution.
4  *
5  * Copyright 2015 The Android Open Source Project
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 #ifndef __HWC_LAYERS_H__
21 #define __HWC_LAYERS_H__
22 
23 /* This class translates HWC2 Layer functions to the SDM LayerStack
24  */
25 
26 #include <gralloc_priv.h>
27 #include <qdMetaData.h>
28 #include <core/layer_stack.h>
29 #include <core/layer_buffer.h>
30 #include <utils/utils.h>
31 #define HWC2_INCLUDE_STRINGIFICATION
32 #define HWC2_USE_CPP11
33 #include <hardware/hwcomposer2.h>
34 #undef HWC2_INCLUDE_STRINGIFICATION
35 #undef HWC2_USE_CPP11
36 #include <android/hardware/graphics/composer/2.3/IComposerClient.h>
37 #include <vendor/qti/hardware/display/composer/3.0/IQtiComposerClient.h>
38 
39 #include <deque>
40 #include <map>
41 #include <set>
42 
43 #include "core/buffer_allocator.h"
44 #include "hwc_buffer_allocator.h"
45 
46 using PerFrameMetadataKey =
47     android::hardware::graphics::composer::V2_3::IComposerClient::PerFrameMetadataKey;
48 using vendor::qti::hardware::display::composer::V3_0::IQtiComposerClient;
49 
50 namespace sdm {
51 
52 DisplayError SetCSC(const private_handle_t *pvt_handle, ColorMetaData *color_metadata);
53 bool GetColorPrimary(const int32_t &dataspace, ColorPrimaries *color_primary);
54 bool GetTransfer(const int32_t &dataspace, GammaTransfer *gamma_transfer);
55 bool GetRange(const int32_t &dataspace, ColorRange *color_range);
56 bool GetSDMColorSpace(const int32_t &dataspace, ColorMetaData *color_metadata);
57 bool IsBT2020(const ColorPrimaries &color_primary);
58 int32_t TranslateFromLegacyDataspace(const int32_t &legacy_ds);
59 
60 enum GeometryChanges {
61   kNone         = 0x000,
62   kBlendMode    = 0x001,
63   kDataspace    = 0x002,
64   kDisplayFrame = 0x004,
65   kPlaneAlpha   = 0x008,
66   kSourceCrop   = 0x010,
67   kTransform    = 0x020,
68   kZOrder       = 0x040,
69   kAdded        = 0x080,
70   kRemoved      = 0x100,
71   kBufferGeometry = 0x200,
72 };
73 
74 enum LayerTypes {
75   kLayerUnknown = 0,
76   kLayerApp = 1,
77   kLayerGame = 2,
78   kLayerBrowser = 3,
79 };
80 
81 class HWCLayer {
82  public:
83   explicit HWCLayer(hwc2_display_t display_id, HWCBufferAllocator *buf_allocator);
84   ~HWCLayer();
GetZ()85   uint32_t GetZ() const { return z_; }
GetId()86   hwc2_layer_t GetId() const { return id_; }
GetType()87   LayerTypes GetType() const { return type_; }
GetSDMLayer()88   Layer *GetSDMLayer() { return layer_; }
89   void ResetPerFrameData();
90 
91   HWC2::Error SetLayerBlendMode(HWC2::BlendMode mode);
92   HWC2::Error SetLayerBuffer(buffer_handle_t buffer, shared_ptr<Fence> acquire_fence);
93   HWC2::Error SetLayerColor(hwc_color_t color);
94   HWC2::Error SetLayerCompositionType(HWC2::Composition type);
95   HWC2::Error SetLayerDataspace(int32_t dataspace);
96   HWC2::Error SetLayerDisplayFrame(hwc_rect_t frame);
97   HWC2::Error SetCursorPosition(int32_t x, int32_t y);
98   HWC2::Error SetLayerPlaneAlpha(float alpha);
99   HWC2::Error SetLayerSourceCrop(hwc_frect_t crop);
100   HWC2::Error SetLayerSurfaceDamage(hwc_region_t damage);
101   HWC2::Error SetLayerTransform(HWC2::Transform transform);
102   HWC2::Error SetLayerVisibleRegion(hwc_region_t visible);
103   HWC2::Error SetLayerPerFrameMetadata(uint32_t num_elements, const PerFrameMetadataKey *keys,
104                                        const float *metadata);
105   HWC2::Error SetLayerPerFrameMetadataBlobs(uint32_t num_elements, const PerFrameMetadataKey *keys,
106                                             const uint32_t *sizes, const uint8_t* metadata);
107   HWC2::Error SetLayerZOrder(uint32_t z);
108   HWC2::Error SetLayerType(IQtiComposerClient::LayerType type);
109   HWC2::Error SetLayerColorTransform(const float *matrix);
110   void SetComposition(const LayerComposition &sdm_composition);
GetClientRequestedCompositionType()111   HWC2::Composition GetClientRequestedCompositionType() { return client_requested_; }
UpdateClientCompositionType(HWC2::Composition type)112   void UpdateClientCompositionType(HWC2::Composition type) { client_requested_ = type; }
GetDeviceSelectedCompositionType()113   HWC2::Composition GetDeviceSelectedCompositionType() { return device_selected_; }
GetLayerDataspace()114   int32_t GetLayerDataspace() { return dataspace_; }
GetGeometryChanges()115   uint32_t GetGeometryChanges() { return geometry_changes_; }
ResetGeometryChanges()116   void ResetGeometryChanges() { geometry_changes_ = GeometryChanges::kNone; }
117   void PushBackReleaseFence(const shared_ptr<Fence> &fence);
118   void PopBackReleaseFence(shared_ptr<Fence> *fence);
119   void PopFrontReleaseFence(shared_ptr<Fence> *fence);
ResetValidation()120   void ResetValidation() { layer_->update_mask.reset(); }
NeedsValidation()121   bool NeedsValidation() { return (geometry_changes_ || layer_->update_mask.any()); }
IsSingleBuffered()122   bool IsSingleBuffered() { return single_buffer_; }
123   bool IsScalingPresent();
124   bool IsRotationPresent();
125   bool IsDataSpaceSupported();
IsProtected()126   bool IsProtected() { return secure_; }
127   static LayerBufferFormat GetSDMFormat(const int32_t &source, const int flags);
IsSurfaceUpdated()128   bool IsSurfaceUpdated() { return surface_updated_; }
SetPartialUpdate(bool enabled)129   void SetPartialUpdate(bool enabled) { partial_update_enabled_ = enabled; }
IsNonIntegralSourceCrop()130   bool IsNonIntegralSourceCrop() { return non_integral_source_crop_; }
HasMetaDataRefreshRate()131   bool HasMetaDataRefreshRate() { return has_metadata_refresh_rate_; }
IsColorTransformSet()132   bool IsColorTransformSet() { return color_transform_matrix_set_; }
133   void SetLayerAsMask();
BufferLatched()134   bool BufferLatched() { return buffer_flipped_; }
ResetBufferFlip()135   void ResetBufferFlip() { buffer_flipped_ = false; }
136 
137  private:
138   Layer *layer_ = nullptr;
139   LayerTypes type_ = kLayerUnknown;
140   uint32_t z_ = 0;
141   const hwc2_layer_t id_;
142   const hwc2_display_t display_id_;
143   static std::atomic<hwc2_layer_t> next_id_;
144   std::deque<shared_ptr<Fence>> release_fences_;
145   HWCBufferAllocator *buffer_allocator_ = NULL;
146   int32_t dataspace_ =  HAL_DATASPACE_UNKNOWN;
147   LayerTransform layer_transform_ = {};
148   LayerRect dst_rect_ = {};
149   bool single_buffer_ = false;
150   int buffer_fd_ = -1;
151   bool dataspace_supported_ = false;
152   bool partial_update_enabled_ = false;
153   bool surface_updated_ = true;
154   bool non_integral_source_crop_ = false;
155   bool has_metadata_refresh_rate_ = false;
156   bool color_transform_matrix_set_ = false;
157   bool buffer_flipped_ = false;
158   bool secure_ = false;
159 
160   // Composition requested by client(SF)
161   HWC2::Composition client_requested_ = HWC2::Composition::Device;
162   // Composition selected by SDM
163   HWC2::Composition device_selected_ = HWC2::Composition::Device;
164   uint32_t geometry_changes_ = GeometryChanges::kNone;
165 
166   void SetRect(const hwc_rect_t &source, LayerRect *target);
167   void SetRect(const hwc_frect_t &source, LayerRect *target);
168   uint32_t GetUint32Color(const hwc_color_t &source);
169   void GetUBWCStatsFromMetaData(UBWCStats *cr_stats, UbwcCrStatsVector *cr_vec);
170   DisplayError SetMetaData(const private_handle_t *pvt_handle, Layer *layer);
171   uint32_t RoundToStandardFPS(float fps);
172   void ValidateAndSetCSC(const private_handle_t *handle);
173   void SetDirtyRegions(hwc_region_t surface_damage);
174 };
175 
176 struct SortLayersByZ {
operatorSortLayersByZ177   bool operator()(const HWCLayer *lhs, const HWCLayer *rhs) const {
178     return lhs->GetZ() < rhs->GetZ();
179   }
180 };
181 
182 }  // namespace sdm
183 #endif  // __HWC_LAYERS_H__
184