xref: /aosp_15_r20/external/drm_hwcomposer/hwc3/Utils.h (revision 0a9764fe0a15e71ebbeb85e87e10990c23aab47f)
1 /*
2  * Copyright (C) 2024 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 <aidl/android/hardware/graphics/composer3/IComposerClient.h>
20 #include <hardware/hwcomposer2.h>
21 #include <log/log.h>
22 
23 #include <cstdint>
24 
25 // NOLINTNEXTLINE
26 #define DEBUG_FUNC() ALOGV("%s", __func__)
27 
28 namespace aidl::android::hardware::graphics::composer3 {
29 
30 namespace hwc3 {
31 enum class Error : int32_t {
32   kNone = 0,
33   kBadConfig = IComposerClient::EX_BAD_CONFIG,
34   kBadDisplay = IComposerClient::EX_BAD_DISPLAY,
35   kBadLayer = IComposerClient::EX_BAD_LAYER,
36   kBadParameter = IComposerClient::EX_BAD_PARAMETER,
37   kNoResources = IComposerClient::EX_NO_RESOURCES,
38   kNotValidated = IComposerClient::EX_NOT_VALIDATED,
39   kUnsupported = IComposerClient::EX_UNSUPPORTED,
40   kSeamlessNotAllowed = IComposerClient::EX_SEAMLESS_NOT_ALLOWED,
41   kSeamlessNotPossible = IComposerClient::EX_SEAMLESS_NOT_POSSIBLE,
42 };
43 }  // namespace hwc3
44 
45 hwc3::Error Hwc2toHwc3Error(HWC2::Error error);
46 
ToBinderStatus(hwc3::Error error)47 inline ndk::ScopedAStatus ToBinderStatus(hwc3::Error error) {
48   if (error != hwc3::Error::kNone) {
49     return ndk::ScopedAStatus::fromServiceSpecificError(
50         static_cast<int32_t>(error));
51   }
52   return ndk::ScopedAStatus::ok();
53 }
54 
ToBinderStatus(HWC2::Error error)55 inline ndk::ScopedAStatus ToBinderStatus(HWC2::Error error) {
56   return ToBinderStatus(Hwc2toHwc3Error(error));
57 }
58 
59 // ID conversion. HWC2 uses typedef'd unsigned integer types while HWC3 uses
60 // signed integer types. static_cast in between these.
Hwc2LayerToHwc3(hwc2_layer_t layer)61 inline int64_t Hwc2LayerToHwc3(hwc2_layer_t layer) {
62   return static_cast<int64_t>(layer);
63 }
64 
Hwc2DisplayToHwc3(hwc2_display_t display)65 inline int64_t Hwc2DisplayToHwc3(hwc2_display_t display) {
66   return static_cast<int64_t>(display);
67 }
68 
Hwc2ConfigIdToHwc3(hwc2_config_t config_id)69 inline int32_t Hwc2ConfigIdToHwc3(hwc2_config_t config_id) {
70   return static_cast<int32_t>(config_id);
71 }
72 
Hwc3LayerToHwc2(int64_t layer)73 inline hwc2_layer_t Hwc3LayerToHwc2(int64_t layer) {
74   return static_cast<hwc2_layer_t>(layer);
75 }
76 
Hwc3DisplayToHwc2(int64_t display)77 inline hwc2_display_t Hwc3DisplayToHwc2(int64_t display) {
78   return static_cast<hwc2_display_t>(display);
79 }
80 
Hwc3ConfigIdToHwc2(int32_t config_id)81 inline hwc2_config_t Hwc3ConfigIdToHwc2(int32_t config_id) {
82   return static_cast<hwc2_config_t>(config_id);
83 }
84 
85 // Values match up to HWC2_COMPOSITION_SIDEBAND, with HWC2 not supporting
86 // newer values. static_cast in between shared values.
87 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/Composition.aidl
88 // https://cs.android.com/android/platform/superproject/main/+/main:hardware/libhardware/include_all/hardware/hwcomposer2.h;drc=d783cabd4d9bddb4b83f2dd38300b7598bb58b24;l=826
Hwc2CompositionTypeToHwc3(int32_t composition_type)89 inline Composition Hwc2CompositionTypeToHwc3(int32_t composition_type) {
90   if (composition_type < HWC2_COMPOSITION_INVALID ||
91       composition_type > HWC2_COMPOSITION_SIDEBAND) {
92     return Composition::INVALID;
93   }
94   return static_cast<Composition>(composition_type);
95 }
96 
97 // Values for color modes match across HWC versions, so static cast is safe:
98 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/ColorMode.aidl
99 // https://cs.android.com/android/platform/superproject/main/+/main:system/core/libsystem/include/system/graphics-base-v1.0.h;drc=7d940ae4afa450696afa25e07982f3a95e17e9b2;l=118
100 // https://cs.android.com/android/platform/superproject/main/+/main:system/core/libsystem/include/system/graphics-base-v1.1.h;drc=7d940ae4afa450696afa25e07982f3a95e17e9b2;l=35
Hwc2ColorModeToHwc3(int32_t color_mode)101 inline ColorMode Hwc2ColorModeToHwc3(int32_t color_mode) {
102   return static_cast<ColorMode>(color_mode);
103 }
104 
Hwc3ColorModeToHwc2(ColorMode color_mode)105 inline int32_t Hwc3ColorModeToHwc2(ColorMode color_mode) {
106   return static_cast<int32_t>(color_mode);
107 }
108 
109 // Capabilities match up to DisplayCapability::AUTO_LOW_LATENCY_MODE, with hwc2
110 // not defining capabilities beyond that.
111 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/DisplayCapability.aidl#28
112 // https://cs.android.com/android/platform/superproject/main/+/main:hardware/libhardware/include_all/hardware/hwcomposer2.h;drc=1a0e4a1698c7b080d6763cef9e16592bce75967e;l=418
Hwc2DisplayCapabilityToHwc3(uint32_t display_capability)113 inline DisplayCapability Hwc2DisplayCapabilityToHwc3(
114     uint32_t display_capability) {
115   if (display_capability > HWC2_DISPLAY_CAPABILITY_AUTO_LOW_LATENCY_MODE) {
116     return DisplayCapability::INVALID;
117   }
118   return static_cast<DisplayCapability>(display_capability);
119 }
120 
121 // Values match between hwc versions, so static cast is safe.
122 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/DisplayConnectionType.aidl
123 // https://cs.android.com/android/platform/superproject/main/+/main:hardware/libhardware/include_all/hardware/hwcomposer2.h;l=216;drc=d783cabd4d9bddb4b83f2dd38300b7598bb58b24;bpv=0;bpt=1
Hwc2DisplayConnectionTypeToHwc3(uint32_t type)124 inline DisplayConnectionType Hwc2DisplayConnectionTypeToHwc3(uint32_t type) {
125   if (type > HWC2_DISPLAY_CONNECTION_TYPE_EXTERNAL) {
126     // Arbitrarily return EXTERNAL in this case, which shouldn't happen.
127     // TODO: This will be cleaned up once hwc2<->hwc3 conversion is removed.
128     ALOGE("Unknown HWC2 connection type. Could not translate: %d", type);
129     return DisplayConnectionType::EXTERNAL;
130   }
131   return static_cast<DisplayConnectionType>(type);
132 }
133 
134 // Values match, so static_cast is safe.
135 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/RenderIntent.aidl
136 // https://cs.android.com/android/platform/superproject/main/+/main:system/core/libsystem/include/system/graphics-base-v1.1.h;drc=7d940ae4afa450696afa25e07982f3a95e17e9b2;l=37
Hwc2RenderIntentToHwc3(int32_t intent)137 inline RenderIntent Hwc2RenderIntentToHwc3(int32_t intent) {
138   if (intent < HAL_RENDER_INTENT_COLORIMETRIC ||
139       intent > HAL_RENDER_INTENT_TONE_MAP_ENHANCE) {
140     ALOGE("Unknown HWC2 render intent. Could not translate: %d", intent);
141     return RenderIntent::COLORIMETRIC;
142   }
143   return static_cast<RenderIntent>(intent);
144 }
Hwc3RenderIntentToHwc2(RenderIntent render_intent)145 inline int32_t Hwc3RenderIntentToHwc2(RenderIntent render_intent) {
146   return static_cast<int32_t>(render_intent);
147 }
148 
149 // Values match up to DOZE_SUSPEND.
150 // https://android.googlesource.com/platform/hardware/interfaces/+/refs/heads/main/graphics/composer/aidl/android/hardware/graphics/composer3/PowerMode.aidl
151 // https://cs.android.com/android/platform/superproject/main/+/main:hardware/libhardware/include_all/hardware/hwcomposer2.h;l=348;drc=d783cabd4d9bddb4b83f2dd38300b7598bb58b24
Hwc3PowerModeToHwc2(PowerMode power_mode)152 inline int32_t Hwc3PowerModeToHwc2(PowerMode power_mode) {
153   if (power_mode > PowerMode::DOZE_SUSPEND) {
154     ALOGE("Unsupported HWC2 power mode. Could not translate: %d", power_mode);
155     return HWC2_POWER_MODE_ON;
156   }
157   return static_cast<int32_t>(power_mode);
158 }
159 
160 // Values appear to match.
161 // https://cs.android.com/android/platform/superproject/main/+/main:hardware/interfaces/graphics/common/aidl/android/hardware/graphics/common/Dataspace.aidl
162 // https://cs.android.com/android/platform/superproject/main/+/main:system/core/libsystem/include/system/graphics-base-v1.0.h;l=43
163 // https://cs.android.com/android/platform/superproject/main/+/main:system/core/libsystem/include/system/graphics-base-v1.1.h;l=22;drc=7d940ae4afa450696afa25e07982f3a95e17e9b2
Hwc3DataspaceToHwc2(common::Dataspace dataspace)164 inline int32_t Hwc3DataspaceToHwc2(common::Dataspace dataspace) {
165   return static_cast<int32_t>(dataspace);
166 }
167 
168 };  // namespace aidl::android::hardware::graphics::composer3