blob: 43564d4cbf1694ef98e6a884eda6fb4643df8fed [file] [log] [blame]
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#define LOG_TAG "drmhwc"
#define ATRACE_TAG ATRACE_TAG_GRAPHICS
#include "HwcDisplay.h"
#include <cinttypes>
#include <hardware/gralloc.h>
#include <ui/GraphicBufferAllocator.h>
#include <ui/GraphicBufferMapper.h>
#include <ui/PixelFormat.h>
#include "backend/Backend.h"
#include "backend/BackendManager.h"
#include "bufferinfo/BufferInfoGetter.h"
#include "compositor/DisplayInfo.h"
#include "drm/DrmConnector.h"
#include "drm/DrmDisplayPipeline.h"
#include "drm/DrmHwc.h"
#include "utils/log.h"
#include "utils/properties.h"
using ::android::DrmDisplayPipeline;
namespace android {
namespace {
// Allocate a black buffer that can be used for an initial modeset when there.
// is no appropriate client buffer available to be used.
// Caller must free the returned buffer with GraphicBufferAllocator::free.
auto GetModesetBuffer(uint32_t width, uint32_t height) -> buffer_handle_t {
constexpr PixelFormat format = PIXEL_FORMAT_RGBA_8888;
constexpr uint64_t usage = GRALLOC_USAGE_SW_READ_OFTEN |
GRALLOC_USAGE_SW_WRITE_OFTEN |
GRALLOC_USAGE_HW_COMPOSER | GRALLOC_USAGE_HW_FB;
constexpr uint32_t layer_count = 1;
const std::string name = "drm-hwcomposer";
buffer_handle_t handle = nullptr;
uint32_t stride = 0;
status_t status = GraphicBufferAllocator::get().allocate(width, height,
format, layer_count,
usage, &handle,
&stride, name);
if (status != OK) {
ALOGE("Failed to allocate modeset buffer.");
return nullptr;
}
void *data = nullptr;
Rect bounds = {0, 0, static_cast<int32_t>(width),
static_cast<int32_t>(height)};
status = GraphicBufferMapper::get().lock(handle, usage, bounds, &data);
if (status != OK) {
ALOGE("Failed to map modeset buffer.");
GraphicBufferAllocator::get().free(handle);
return nullptr;
}
// Cast one of the multiplicands to ensure that the multiplication happens
// in a wider type (size_t).
const size_t buffer_size = static_cast<size_t>(height) * stride *
bytesPerPixel(format);
memset(data, 0, buffer_size);
status = GraphicBufferMapper::get().unlock(handle);
ALOGW_IF(status != OK, "Failed to unmap buffer.");
return handle;
}
auto GetModesetLayerProperties(buffer_handle_t buffer, uint32_t width,
uint32_t height) -> HwcLayer::LayerProperties {
HwcLayer::LayerProperties properties;
properties.buffer = {.buffer_handle = buffer, .acquire_fence = {}};
properties.display_frame = {
.left = 0,
.top = 0,
.right = int(width),
.bottom = int(height),
};
properties.source_crop = (hwc_frect_t){
.left = 0.0F,
.top = 0.0F,
.right = static_cast<float>(width),
.bottom = static_cast<float>(height),
};
properties.blend_mode = BufferBlendMode::kNone;
return properties;
}
} // namespace
std::string HwcDisplay::DumpDelta(HwcDisplay::Stats delta) {
if (delta.total_pixops_ == 0)
return "No stats yet";
auto ratio = 1.0 - double(delta.gpu_pixops_) / double(delta.total_pixops_);
std::stringstream ss;
ss << " Total frames count: " << delta.total_frames_ << "\n"
<< " Failed to test commit frames: " << delta.failed_kms_validate_ << "\n"
<< " Failed to commit frames: " << delta.failed_kms_present_ << "\n"
<< ((delta.failed_kms_present_ > 0)
? " !!! Internal failure, FIX it please\n"
: "")
<< " Flattened frames: " << delta.frames_flattened_ << "\n"
<< " Pixel operations (free units)"
<< " : [TOTAL: " << delta.total_pixops_ << " / GPU: " << delta.gpu_pixops_
<< "]\n"
<< " Composition efficiency: " << ratio;
return ss.str();
}
std::string HwcDisplay::Dump() {
auto connector_name = IsInHeadlessMode()
? std::string("NULL-DISPLAY")
: GetPipe().connector->Get()->GetName();
std::stringstream ss;
ss << "- Display on: " << connector_name << "\n"
<< "Statistics since system boot:\n"
<< DumpDelta(total_stats_) << "\n\n"
<< "Statistics since last dumpsys request:\n"
<< DumpDelta(total_stats_.minus(prev_stats_)) << "\n\n";
memcpy(&prev_stats_, &total_stats_, sizeof(Stats));
return ss.str();
}
HwcDisplay::HwcDisplay(hwc2_display_t handle, HWC2::DisplayType type,
DrmHwc *hwc)
: hwc_(hwc), handle_(handle), type_(type), client_layer_(this) {
if (type_ == HWC2::DisplayType::Virtual) {
writeback_layer_ = std::make_unique<HwcLayer>(this);
}
}
void HwcDisplay::SetColorMatrixToIdentity() {
color_matrix_ = std::make_shared<drm_color_ctm>();
for (int i = 0; i < kCtmCols; i++) {
for (int j = 0; j < kCtmRows; j++) {
constexpr uint64_t kOne = (1ULL << 32); /* 1.0 in s31.32 format */
color_matrix_->matrix[i * kCtmRows + j] = (i == j) ? kOne : 0;
}
}
color_transform_hint_ = HAL_COLOR_TRANSFORM_IDENTITY;
}
HwcDisplay::~HwcDisplay() {
Deinit();
};
auto HwcDisplay::GetConfig(hwc2_config_t config_id) const
-> const HwcDisplayConfig * {
auto config_iter = configs_.hwc_configs.find(config_id);
if (config_iter == configs_.hwc_configs.end()) {
return nullptr;
}
return &config_iter->second;
}
auto HwcDisplay::GetCurrentConfig() const -> const HwcDisplayConfig * {
return GetConfig(configs_.active_config_id);
}
auto HwcDisplay::GetLastRequestedConfig() const -> const HwcDisplayConfig * {
return GetConfig(staged_mode_config_id_.value_or(configs_.active_config_id));
}
HwcDisplay::ConfigError HwcDisplay::SetConfig(hwc2_config_t config) {
const HwcDisplayConfig *new_config = GetConfig(config);
if (new_config == nullptr) {
ALOGE("Could not find active mode for %u", config);
return ConfigError::kBadConfig;
}
const HwcDisplayConfig *current_config = GetCurrentConfig();
const uint32_t width = new_config->mode.GetRawMode().hdisplay;
const uint32_t height = new_config->mode.GetRawMode().hdisplay;
std::optional<LayerData> modeset_layer_data;
// If a client layer has already been provided, and its size matches the
// new config, use it for the modeset.
if (client_layer_.IsLayerUsableAsDevice() && current_config &&
current_config->mode.GetRawMode().hdisplay == width &&
current_config->mode.GetRawMode().vdisplay == height) {
ALOGV("Use existing client_layer for blocking config.");
modeset_layer_data = client_layer_.GetLayerData();
} else {
ALOGV("Allocate modeset buffer.");
buffer_handle_t modeset_buffer = GetModesetBuffer(width, height);
if (modeset_buffer != nullptr) {
auto modeset_layer = std::make_unique<HwcLayer>(this);
modeset_layer->SetLayerProperties(
GetModesetLayerProperties(modeset_buffer, width, height));
modeset_layer->PopulateLayerData();
modeset_layer_data = modeset_layer->GetLayerData();
GraphicBufferAllocator::get().free(modeset_buffer);
}
}
ALOGV("Create modeset commit.");
// Create atomic commit args for a blocking modeset. There's no need to do a
// separate test commit, since the commit does a test anyways.
AtomicCommitArgs commit_args = CreateModesetCommit(new_config,
modeset_layer_data);
commit_args.blocking = true;
int ret = GetPipe().atomic_state_manager->ExecuteAtomicCommit(commit_args);
if (ret) {
ALOGE("Blocking config failed: %d", ret);
return HwcDisplay::ConfigError::kBadConfig;
}
ALOGV("Blocking config succeeded.");
configs_.active_config_id = config;
return ConfigError::kNone;
}
auto HwcDisplay::QueueConfig(hwc2_config_t config, int64_t desired_time,
bool seamless, QueuedConfigTiming *out_timing)
-> ConfigError {
if (configs_.hwc_configs.count(config) == 0) {
ALOGE("Could not find active mode for %u", config);
return ConfigError::kBadConfig;
}
// TODO: Add support for seamless configuration changes.
if (seamless) {
return ConfigError::kSeamlessNotAllowed;
}
// Request a refresh from the client one vsync period before the desired
// time, or simply at the desired time if there is no active configuration.
const HwcDisplayConfig *current_config = GetCurrentConfig();
out_timing->refresh_time_ns = desired_time -
(current_config
? current_config->mode.GetVSyncPeriodNs()
: 0);
out_timing->new_vsync_time_ns = desired_time;
// Queue the config change timing to be consistent with the requested
// refresh time.
staged_mode_change_time_ = out_timing->refresh_time_ns;
staged_mode_config_id_ = config;
// Enable vsync events until the mode has been applied.
last_vsync_ts_ = 0;
vsync_tracking_en_ = true;
vsync_worker_->VSyncControl(true);
return ConfigError::kNone;
}
void HwcDisplay::SetPipeline(std::shared_ptr<DrmDisplayPipeline> pipeline) {
Deinit();
pipeline_ = std::move(pipeline);
if (pipeline_ != nullptr || handle_ == kPrimaryDisplay) {
Init();
hwc_->ScheduleHotplugEvent(handle_, DrmHwc::kConnected);
} else {
hwc_->ScheduleHotplugEvent(handle_, DrmHwc::kDisconnected);
}
}
void HwcDisplay::Deinit() {
if (pipeline_ != nullptr) {
AtomicCommitArgs a_args{};
a_args.composition = std::make_shared<DrmKmsPlan>();
GetPipe().atomic_state_manager->ExecuteAtomicCommit(a_args);
a_args.composition = {};
a_args.active = false;
GetPipe().atomic_state_manager->ExecuteAtomicCommit(a_args);
current_plan_.reset();
backend_.reset();
if (flatcon_) {
flatcon_->StopThread();
flatcon_.reset();
}
}
if (vsync_worker_) {
// TODO: There should be a mechanism to wait for this worker to complete,
// otherwise there is a race condition while destructing the HwcDisplay.
vsync_worker_->StopThread();
vsync_worker_ = {};
}
SetClientTarget(nullptr, -1, 0, {});
}
HWC2::Error HwcDisplay::Init() {
ChosePreferredConfig();
auto vsw_callbacks = (VSyncWorkerCallbacks){
.out_event =
[this](int64_t timestamp) {
const std::unique_lock lock(hwc_->GetResMan().GetMainLock());
if (vsync_event_en_) {
uint32_t period_ns{};
GetDisplayVsyncPeriod(&period_ns);
hwc_->SendVsyncEventToClient(handle_, timestamp, period_ns);
}
if (vsync_tracking_en_) {
last_vsync_ts_ = timestamp;
}
if (!vsync_event_en_ && !vsync_tracking_en_) {
vsync_worker_->VSyncControl(false);
}
},
.get_vperiod_ns = [this]() -> uint32_t {
uint32_t outVsyncPeriod = 0;
GetDisplayVsyncPeriod(&outVsyncPeriod);
return outVsyncPeriod;
},
};
if (type_ != HWC2::DisplayType::Virtual) {
vsync_worker_ = VSyncWorker::CreateInstance(pipeline_, vsw_callbacks);
if (!vsync_worker_) {
ALOGE("Failed to create event worker for d=%d\n", int(handle_));
return HWC2::Error::BadDisplay;
}
}
if (!IsInHeadlessMode()) {
auto ret = BackendManager::GetInstance().SetBackendForDisplay(this);
if (ret) {
ALOGE("Failed to set backend for d=%d %d\n", int(handle_), ret);
return HWC2::Error::BadDisplay;
}
auto flatcbk = (struct FlatConCallbacks){
.trigger = [this]() { hwc_->SendRefreshEventToClient(handle_); }};
flatcon_ = FlatteningController::CreateInstance(flatcbk);
}
client_layer_.SetLayerBlendMode(HWC2_BLEND_MODE_PREMULTIPLIED);
SetColorMatrixToIdentity();
return HWC2::Error::None;
}
std::optional<PanelOrientation> HwcDisplay::getDisplayPhysicalOrientation() {
if (IsInHeadlessMode()) {
// The pipeline can be nullptr in headless mode, so return the default
// "normal" mode.
return PanelOrientation::kModePanelOrientationNormal;
}
DrmDisplayPipeline &pipeline = GetPipe();
if (pipeline.connector == nullptr || pipeline.connector->Get() == nullptr) {
ALOGW(
"No display pipeline present to query the panel orientation property.");
return {};
}
return pipeline.connector->Get()->GetPanelOrientation();
}
HWC2::Error HwcDisplay::ChosePreferredConfig() {
HWC2::Error err{};
if (type_ == HWC2::DisplayType::Virtual) {
configs_.GenFakeMode(virtual_disp_width_, virtual_disp_height_);
} else if (!IsInHeadlessMode()) {
err = configs_.Update(*pipeline_->connector->Get());
} else {
configs_.GenFakeMode(0, 0);
}
if (!IsInHeadlessMode() && err != HWC2::Error::None) {
return HWC2::Error::BadDisplay;
}
return SetActiveConfig(configs_.preferred_config_id);
}
HWC2::Error HwcDisplay::AcceptDisplayChanges() {
for (std::pair<const hwc2_layer_t, HwcLayer> &l : layers_)
l.second.AcceptTypeChange();
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::CreateLayer(hwc2_layer_t *layer) {
layers_.emplace(static_cast<hwc2_layer_t>(layer_idx_), HwcLayer(this));
*layer = static_cast<hwc2_layer_t>(layer_idx_);
++layer_idx_;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::DestroyLayer(hwc2_layer_t layer) {
if (!get_layer(layer)) {
return HWC2::Error::BadLayer;
}
layers_.erase(layer);
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetActiveConfig(hwc2_config_t *config) const {
// If a config has been queued, it is considered the "active" config.
const HwcDisplayConfig *hwc_config = GetLastRequestedConfig();
if (hwc_config == nullptr)
return HWC2::Error::BadConfig;
*config = hwc_config->id;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetChangedCompositionTypes(uint32_t *num_elements,
hwc2_layer_t *layers,
int32_t *types) {
if (IsInHeadlessMode()) {
*num_elements = 0;
return HWC2::Error::None;
}
uint32_t num_changes = 0;
for (auto &l : layers_) {
if (l.second.IsTypeChanged()) {
if (layers && num_changes < *num_elements)
layers[num_changes] = l.first;
if (types && num_changes < *num_elements)
types[num_changes] = static_cast<int32_t>(l.second.GetValidatedType());
++num_changes;
}
}
if (!layers && !types)
*num_elements = num_changes;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetClientTargetSupport(uint32_t width, uint32_t height,
int32_t /*format*/,
int32_t dataspace) {
if (IsInHeadlessMode()) {
return HWC2::Error::None;
}
auto min = pipeline_->device->GetMinResolution();
auto max = pipeline_->device->GetMaxResolution();
if (width < min.first || height < min.second)
return HWC2::Error::Unsupported;
if (width > max.first || height > max.second)
return HWC2::Error::Unsupported;
if (dataspace != HAL_DATASPACE_UNKNOWN)
return HWC2::Error::Unsupported;
// TODO(nobody): Validate format can be handled by either GL or planes
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetColorModes(uint32_t *num_modes, int32_t *modes) {
if (!modes)
*num_modes = 1;
if (modes)
*modes = HAL_COLOR_MODE_NATIVE;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayAttribute(hwc2_config_t config,
int32_t attribute_in,
int32_t *value) {
int conf = static_cast<int>(config);
if (configs_.hwc_configs.count(conf) == 0) {
ALOGE("Could not find mode #%d", conf);
return HWC2::Error::BadConfig;
}
auto &hwc_config = configs_.hwc_configs[conf];
static const int32_t kUmPerInch = 25400;
auto mm_width = configs_.mm_width;
auto attribute = static_cast<HWC2::Attribute>(attribute_in);
switch (attribute) {
case HWC2::Attribute::Width:
*value = static_cast<int>(hwc_config.mode.GetRawMode().hdisplay);
break;
case HWC2::Attribute::Height:
*value = static_cast<int>(hwc_config.mode.GetRawMode().vdisplay);
break;
case HWC2::Attribute::VsyncPeriod:
// in nanoseconds
*value = hwc_config.mode.GetVSyncPeriodNs();
break;
case HWC2::Attribute::DpiY:
// ideally this should be vdisplay/mm_heigth, however mm_height
// comes from edid parsing and is highly unreliable. Viewing the
// rarity of anisotropic displays, falling back to a single value
// for dpi yield more correct output.
case HWC2::Attribute::DpiX:
// Dots per 1000 inches
*value = mm_width ? int(hwc_config.mode.GetRawMode().hdisplay *
kUmPerInch / mm_width)
: -1;
break;
#if __ANDROID_API__ > 29
case HWC2::Attribute::ConfigGroup:
/* Dispite ConfigGroup is a part of HWC2.4 API, framework
* able to request it even if service @2.1 is used */
*value = int(hwc_config.group_id);
break;
#endif
default:
*value = -1;
return HWC2::Error::BadConfig;
}
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::LegacyGetDisplayConfigs(uint32_t *num_configs,
hwc2_config_t *configs) {
uint32_t idx = 0;
for (auto &hwc_config : configs_.hwc_configs) {
if (hwc_config.second.disabled) {
continue;
}
if (configs != nullptr) {
if (idx >= *num_configs) {
break;
}
configs[idx] = hwc_config.second.id;
}
idx++;
}
*num_configs = idx;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayName(uint32_t *size, char *name) {
std::ostringstream stream;
if (IsInHeadlessMode()) {
stream << "null-display";
} else {
stream << "display-" << GetPipe().connector->Get()->GetId();
}
auto string = stream.str();
auto length = string.length();
if (!name) {
*size = length;
return HWC2::Error::None;
}
*size = std::min<uint32_t>(static_cast<uint32_t>(length - 1), *size);
strncpy(name, string.c_str(), *size);
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayRequests(int32_t * /*display_requests*/,
uint32_t *num_elements,
hwc2_layer_t * /*layers*/,
int32_t * /*layer_requests*/) {
// TODO(nobody): I think virtual display should request
// HWC2_DISPLAY_REQUEST_WRITE_CLIENT_TARGET_TO_OUTPUT here
*num_elements = 0;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayType(int32_t *type) {
*type = static_cast<int32_t>(type_);
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDozeSupport(int32_t *support) {
*support = 0;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetHdrCapabilities(uint32_t *num_types,
int32_t * /*types*/,
float * /*max_luminance*/,
float * /*max_average_luminance*/,
float * /*min_luminance*/) {
*num_types = 0;
return HWC2::Error::None;
}
/* Find API details at:
* https://cs.android.com/android/platform/superproject/+/android-11.0.0_r3:hardware/libhardware/include/hardware/hwcomposer2.h;l=1767
*
* Called after PresentDisplay(), CLIENT is expecting release fence for the
* prior buffer (not the one assigned to the layer at the moment).
*/
HWC2::Error HwcDisplay::GetReleaseFences(uint32_t *num_elements,
hwc2_layer_t *layers,
int32_t *fences) {
if (IsInHeadlessMode()) {
*num_elements = 0;
return HWC2::Error::None;
}
uint32_t num_layers = 0;
for (auto &l : layers_) {
if (!l.second.GetPriorBufferScanOutFlag() || !present_fence_) {
continue;
}
++num_layers;
if (layers == nullptr || fences == nullptr)
continue;
if (num_layers > *num_elements) {
ALOGW("Overflow num_elements %d/%d", num_layers, *num_elements);
return HWC2::Error::None;
}
layers[num_layers - 1] = l.first;
fences[num_layers - 1] = DupFd(present_fence_);
}
*num_elements = num_layers;
return HWC2::Error::None;
}
AtomicCommitArgs HwcDisplay::CreateModesetCommit(
const HwcDisplayConfig *config,
const std::optional<LayerData> &modeset_layer) {
AtomicCommitArgs args{};
args.color_matrix = color_matrix_;
args.content_type = content_type_;
args.colorspace = colorspace_;
std::vector<LayerData> composition_layers;
if (modeset_layer) {
composition_layers.emplace_back(modeset_layer.value());
}
if (composition_layers.empty()) {
ALOGW("Attempting to create a modeset commit without a layer.");
}
args.display_mode = config->mode;
args.active = true;
args.composition = DrmKmsPlan::CreateDrmKmsPlan(GetPipe(),
std::move(
composition_layers));
ALOGW_IF(!args.composition, "No composition for blocking modeset");
return args;
}
HWC2::Error HwcDisplay::CreateComposition(AtomicCommitArgs &a_args) {
if (IsInHeadlessMode()) {
ALOGE("%s: Display is in headless mode, should never reach here", __func__);
return HWC2::Error::None;
}
a_args.color_matrix = color_matrix_;
a_args.content_type = content_type_;
a_args.colorspace = colorspace_;
uint32_t prev_vperiod_ns = 0;
GetDisplayVsyncPeriod(&prev_vperiod_ns);
auto mode_update_commited_ = false;
if (staged_mode_config_id_ &&
staged_mode_change_time_ <= ResourceManager::GetTimeMonotonicNs()) {
const HwcDisplayConfig *staged_config = GetConfig(
staged_mode_config_id_.value());
if (staged_config == nullptr) {
return HWC2::Error::BadConfig;
}
client_layer_.SetLayerDisplayFrame(
(hwc_rect_t){.left = 0,
.top = 0,
.right = int(staged_config->mode.GetRawMode().hdisplay),
.bottom = int(staged_config->mode.GetRawMode().vdisplay)});
configs_.active_config_id = staged_mode_config_id_.value();
a_args.display_mode = staged_config->mode;
if (!a_args.test_only) {
mode_update_commited_ = true;
}
}
// order the layers by z-order
bool use_client_layer = false;
uint32_t client_z_order = UINT32_MAX;
std::map<uint32_t, HwcLayer *> z_map;
for (std::pair<const hwc2_layer_t, HwcLayer> &l : layers_) {
switch (l.second.GetValidatedType()) {
case HWC2::Composition::Device:
z_map.emplace(l.second.GetZOrder(), &l.second);
break;
case HWC2::Composition::Client:
// Place it at the z_order of the lowest client layer
use_client_layer = true;
client_z_order = std::min(client_z_order, l.second.GetZOrder());
break;
default:
continue;
}
}
if (use_client_layer)
z_map.emplace(client_z_order, &client_layer_);
if (z_map.empty())
return HWC2::Error::BadLayer;
std::vector<LayerData> composition_layers;
/* Import & populate */
for (std::pair<const uint32_t, HwcLayer *> &l : z_map) {
l.second->PopulateLayerData();
}
// now that they're ordered by z, add them to the composition
for (std::pair<const uint32_t, HwcLayer *> &l : z_map) {
if (!l.second->IsLayerUsableAsDevice()) {
/* This will be normally triggered on validation of the first frame
* containing CLIENT layer. At this moment client buffer is not yet
* provided by the CLIENT.
* This may be triggered once in HwcLayer lifecycle in case FB can't be
* imported. For example when non-contiguous buffer is imported into
* contiguous-only DRM/KMS driver.
*/
return HWC2::Error::BadLayer;
}
composition_layers.emplace_back(l.second->GetLayerData());
}
/* Store plan to ensure shared planes won't be stolen by other display
* in between of ValidateDisplay() and PresentDisplay() calls
*/
current_plan_ = DrmKmsPlan::CreateDrmKmsPlan(GetPipe(),
std::move(composition_layers));
if (type_ == HWC2::DisplayType::Virtual) {
a_args.writeback_fb = writeback_layer_->GetLayerData().fb;
a_args.writeback_release_fence = writeback_layer_->GetLayerData()
.acquire_fence;
}
if (!current_plan_) {
ALOGE_IF(!a_args.test_only, "Failed to create DrmKmsPlan");
return HWC2::Error::BadConfig;
}
a_args.composition = current_plan_;
auto ret = GetPipe().atomic_state_manager->ExecuteAtomicCommit(a_args);
if (ret) {
ALOGE_IF(!a_args.test_only, "Failed to apply the frame composition ret=%d", ret);
return HWC2::Error::BadParameter;
}
if (mode_update_commited_) {
staged_mode_config_id_.reset();
vsync_tracking_en_ = false;
if (last_vsync_ts_ != 0) {
hwc_->SendVsyncPeriodTimingChangedEventToClient(handle_,
last_vsync_ts_ +
prev_vperiod_ns);
}
}
return HWC2::Error::None;
}
/* Find API details at:
* https://cs.android.com/android/platform/superproject/+/android-11.0.0_r3:hardware/libhardware/include/hardware/hwcomposer2.h;l=1805
*/
HWC2::Error HwcDisplay::PresentDisplay(int32_t *out_present_fence) {
if (IsInHeadlessMode()) {
*out_present_fence = -1;
return HWC2::Error::None;
}
HWC2::Error ret{};
++total_stats_.total_frames_;
AtomicCommitArgs a_args{};
ret = CreateComposition(a_args);
if (ret != HWC2::Error::None)
++total_stats_.failed_kms_present_;
if (ret == HWC2::Error::BadLayer) {
// Can we really have no client or device layers?
*out_present_fence = -1;
return HWC2::Error::None;
}
if (ret != HWC2::Error::None)
return ret;
this->present_fence_ = a_args.out_fence;
*out_present_fence = DupFd(a_args.out_fence);
// Reset the color matrix so we don't apply it over and over again.
color_matrix_ = {};
++frame_no_;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetActiveConfigInternal(uint32_t config,
int64_t change_time) {
if (configs_.hwc_configs.count(config) == 0) {
ALOGE("Could not find active mode for %u", config);
return HWC2::Error::BadConfig;
}
staged_mode_change_time_ = change_time;
staged_mode_config_id_ = config;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetActiveConfig(hwc2_config_t config) {
return SetActiveConfigInternal(config, ResourceManager::GetTimeMonotonicNs());
}
/* Find API details at:
* https://cs.android.com/android/platform/superproject/+/android-11.0.0_r3:hardware/libhardware/include/hardware/hwcomposer2.h;l=1861
*/
HWC2::Error HwcDisplay::SetClientTarget(buffer_handle_t target,
int32_t acquire_fence,
int32_t dataspace,
hwc_region_t /*damage*/) {
client_layer_.SetLayerBuffer(target, acquire_fence);
client_layer_.SetLayerDataspace(dataspace);
/*
* target can be nullptr, this does mean the Composer Service is calling
* cleanDisplayResources() on after receiving HOTPLUG event. See more at:
* https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/graphics/composer/2.1/utils/hal/include/composer-hal/2.1/ComposerClient.h;l=350;drc=944b68180b008456ed2eb4d4d329e33b19bd5166
*/
if (target == nullptr) {
client_layer_.SwChainClearCache();
return HWC2::Error::None;
}
if (IsInHeadlessMode()) {
return HWC2::Error::None;
}
client_layer_.PopulateLayerData();
if (!client_layer_.IsLayerUsableAsDevice()) {
ALOGE("Client layer must be always usable by DRM/KMS");
return HWC2::Error::BadLayer;
}
auto &bi = client_layer_.GetLayerData().bi;
if (!bi) {
ALOGE("%s: Invalid state", __func__);
return HWC2::Error::BadLayer;
}
auto source_crop = (hwc_frect_t){.left = 0.0F,
.top = 0.0F,
.right = static_cast<float>(bi->width),
.bottom = static_cast<float>(bi->height)};
client_layer_.SetLayerSourceCrop(source_crop);
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetColorMode(int32_t mode) {
/* Maps to the Colorspace DRM connector property:
* https://elixir.bootlin.com/linux/v6.11/source/include/drm/drm_connector.h#L538
*/
if (mode < HAL_COLOR_MODE_NATIVE || mode > HAL_COLOR_MODE_DISPLAY_P3)
return HWC2::Error::BadParameter;
switch (mode) {
case HAL_COLOR_MODE_NATIVE:
colorspace_ = Colorspace::kDefault;
break;
case HAL_COLOR_MODE_STANDARD_BT601_625:
case HAL_COLOR_MODE_STANDARD_BT601_625_UNADJUSTED:
case HAL_COLOR_MODE_STANDARD_BT601_525:
case HAL_COLOR_MODE_STANDARD_BT601_525_UNADJUSTED:
// The DP spec does not say whether this is the 525 or the 625 line version.
colorspace_ = Colorspace::kBt601Ycc;
break;
case HAL_COLOR_MODE_STANDARD_BT709:
case HAL_COLOR_MODE_SRGB:
colorspace_ = Colorspace::kBt709Ycc;
break;
case HAL_COLOR_MODE_DCI_P3:
case HAL_COLOR_MODE_DISPLAY_P3:
colorspace_ = Colorspace::kDciP3RgbD65;
break;
case HAL_COLOR_MODE_ADOBE_RGB:
default:
return HWC2::Error::Unsupported;
}
color_mode_ = mode;
return HWC2::Error::None;
}
#include <xf86drmMode.h>
static uint64_t To3132FixPt(float in) {
constexpr uint64_t kSignMask = (1ULL << 63);
constexpr uint64_t kValueMask = ~(1ULL << 63);
constexpr auto kValueScale = static_cast<float>(1ULL << 32);
if (in < 0)
return (static_cast<uint64_t>(-in * kValueScale) & kValueMask) | kSignMask;
return static_cast<uint64_t>(in * kValueScale) & kValueMask;
}
HWC2::Error HwcDisplay::SetColorTransform(const float *matrix, int32_t hint) {
if (hint < HAL_COLOR_TRANSFORM_IDENTITY ||
hint > HAL_COLOR_TRANSFORM_CORRECT_TRITANOPIA)
return HWC2::Error::BadParameter;
if (!matrix && hint == HAL_COLOR_TRANSFORM_ARBITRARY_MATRIX)
return HWC2::Error::BadParameter;
color_transform_hint_ = static_cast<android_color_transform_t>(hint);
if (IsInHeadlessMode())
return HWC2::Error::None;
if (!GetPipe().crtc->Get()->GetCtmProperty())
return HWC2::Error::None;
switch (color_transform_hint_) {
case HAL_COLOR_TRANSFORM_IDENTITY:
SetColorMatrixToIdentity();
break;
case HAL_COLOR_TRANSFORM_ARBITRARY_MATRIX:
// Without HW support, we cannot correctly process matrices with an offset.
for (int i = 12; i < 14; i++) {
if (matrix[i] != 0.F)
return HWC2::Error::Unsupported;
}
/* HAL provides a 4x4 float type matrix:
* | 0 1 2 3|
* | 4 5 6 7|
* | 8 9 10 11|
* |12 13 14 15|
*
* R_out = R*0 + G*4 + B*8 + 12
* G_out = R*1 + G*5 + B*9 + 13
* B_out = R*2 + G*6 + B*10 + 14
*
* DRM expects a 3x3 s31.32 fixed point matrix:
* out matrix in
* |R| |0 1 2| |R|
* |G| = |3 4 5| x |G|
* |B| |6 7 8| |B|
*
* R_out = R*0 + G*1 + B*2
* G_out = R*3 + G*4 + B*5
* B_out = R*6 + G*7 + B*8
*/
color_matrix_ = std::make_shared<drm_color_ctm>();
for (int i = 0; i < kCtmCols; i++) {
for (int j = 0; j < kCtmRows; j++) {
constexpr int kInCtmRows = 4;
color_matrix_->matrix[i * kCtmRows + j] = To3132FixPt(matrix[j * kInCtmRows + i]);
}
}
break;
default:
return HWC2::Error::Unsupported;
}
return HWC2::Error::None;
}
bool HwcDisplay::CtmByGpu() {
if (color_transform_hint_ == HAL_COLOR_TRANSFORM_IDENTITY)
return false;
if (GetPipe().crtc->Get()->GetCtmProperty())
return false;
if (GetHwc()->GetResMan().GetCtmHandling() == CtmHandling::kDrmOrIgnore)
return false;
return true;
}
HWC2::Error HwcDisplay::SetOutputBuffer(buffer_handle_t buffer,
int32_t release_fence) {
writeback_layer_->SetLayerBuffer(buffer, release_fence);
writeback_layer_->PopulateLayerData();
if (!writeback_layer_->IsLayerUsableAsDevice()) {
ALOGE("Output layer must be always usable by DRM/KMS");
return HWC2::Error::BadLayer;
}
/* TODO: Check if format is supported by writeback connector */
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetPowerMode(int32_t mode_in) {
auto mode = static_cast<HWC2::PowerMode>(mode_in);
AtomicCommitArgs a_args{};
switch (mode) {
case HWC2::PowerMode::Off:
a_args.active = false;
break;
case HWC2::PowerMode::On:
a_args.active = true;
break;
case HWC2::PowerMode::Doze:
case HWC2::PowerMode::DozeSuspend:
return HWC2::Error::Unsupported;
default:
ALOGE("Incorrect power mode value (%d)\n", mode_in);
return HWC2::Error::BadParameter;
}
if (IsInHeadlessMode()) {
return HWC2::Error::None;
}
if (a_args.active && *a_args.active) {
/*
* Setting the display to active before we have a composition
* can break some drivers, so skip setting a_args.active to
* true, as the next composition frame will implicitly activate
* the display
*/
return GetPipe().atomic_state_manager->ActivateDisplayUsingDPMS() == 0
? HWC2::Error::None
: HWC2::Error::BadParameter;
};
auto err = GetPipe().atomic_state_manager->ExecuteAtomicCommit(a_args);
if (err) {
ALOGE("Failed to apply the dpms composition err=%d", err);
return HWC2::Error::BadParameter;
}
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetVsyncEnabled(int32_t enabled) {
if (type_ == HWC2::DisplayType::Virtual) {
return HWC2::Error::None;
}
vsync_event_en_ = HWC2_VSYNC_ENABLE == enabled;
if (vsync_event_en_) {
vsync_worker_->VSyncControl(true);
}
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::ValidateDisplay(uint32_t *num_types,
uint32_t *num_requests) {
if (IsInHeadlessMode()) {
*num_types = *num_requests = 0;
return HWC2::Error::None;
}
/* In current drm_hwc design in case previous frame layer was not validated as
* a CLIENT, it is used by display controller (Front buffer). We have to store
* this state to provide the CLIENT with the release fences for such buffers.
*/
for (auto &l : layers_) {
l.second.SetPriorBufferScanOutFlag(l.second.GetValidatedType() !=
HWC2::Composition::Client);
}
return backend_->ValidateDisplay(this, num_types, num_requests);
}
std::vector<HwcLayer *> HwcDisplay::GetOrderLayersByZPos() {
std::vector<HwcLayer *> ordered_layers;
ordered_layers.reserve(layers_.size());
for (auto &[handle, layer] : layers_) {
ordered_layers.emplace_back(&layer);
}
std::sort(std::begin(ordered_layers), std::end(ordered_layers),
[](const HwcLayer *lhs, const HwcLayer *rhs) {
return lhs->GetZOrder() < rhs->GetZOrder();
});
return ordered_layers;
}
HWC2::Error HwcDisplay::GetDisplayVsyncPeriod(
uint32_t *outVsyncPeriod /* ns */) {
return GetDisplayAttribute(configs_.active_config_id,
HWC2_ATTRIBUTE_VSYNC_PERIOD,
(int32_t *)(outVsyncPeriod));
}
#if __ANDROID_API__ > 29
HWC2::Error HwcDisplay::GetDisplayConnectionType(uint32_t *outType) {
if (IsInHeadlessMode()) {
*outType = static_cast<uint32_t>(HWC2::DisplayConnectionType::Internal);
return HWC2::Error::None;
}
/* Primary display should be always internal,
* otherwise SF will be unhappy and will crash
*/
if (GetPipe().connector->Get()->IsInternal() || handle_ == kPrimaryDisplay)
*outType = static_cast<uint32_t>(HWC2::DisplayConnectionType::Internal);
else if (GetPipe().connector->Get()->IsExternal())
*outType = static_cast<uint32_t>(HWC2::DisplayConnectionType::External);
else
return HWC2::Error::BadConfig;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetActiveConfigWithConstraints(
hwc2_config_t config,
hwc_vsync_period_change_constraints_t *vsyncPeriodChangeConstraints,
hwc_vsync_period_change_timeline_t *outTimeline) {
if (type_ == HWC2::DisplayType::Virtual) {
return HWC2::Error::None;
}
if (vsyncPeriodChangeConstraints == nullptr || outTimeline == nullptr) {
return HWC2::Error::BadParameter;
}
uint32_t current_vsync_period{};
GetDisplayVsyncPeriod(&current_vsync_period);
if (vsyncPeriodChangeConstraints->seamlessRequired) {
return HWC2::Error::SeamlessNotAllowed;
}
outTimeline->refreshTimeNanos = vsyncPeriodChangeConstraints
->desiredTimeNanos -
current_vsync_period;
auto ret = SetActiveConfigInternal(config, outTimeline->refreshTimeNanos);
if (ret != HWC2::Error::None) {
return ret;
}
outTimeline->refreshRequired = true;
outTimeline->newVsyncAppliedTimeNanos = vsyncPeriodChangeConstraints
->desiredTimeNanos;
last_vsync_ts_ = 0;
vsync_tracking_en_ = true;
vsync_worker_->VSyncControl(true);
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetAutoLowLatencyMode(bool /*on*/) {
return HWC2::Error::Unsupported;
}
HWC2::Error HwcDisplay::GetSupportedContentTypes(
uint32_t *outNumSupportedContentTypes,
const uint32_t *outSupportedContentTypes) {
if (outSupportedContentTypes == nullptr)
*outNumSupportedContentTypes = 0;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetContentType(int32_t contentType) {
/* Maps exactly to the content_type DRM connector property:
* https://elixir.bootlin.com/linux/v6.11/source/include/uapi/drm/drm_mode.h#L107
*/
if (contentType < HWC2_CONTENT_TYPE_NONE || contentType > HWC2_CONTENT_TYPE_GAME)
return HWC2::Error::BadParameter;
content_type_ = contentType;
return HWC2::Error::None;
}
#endif
#if __ANDROID_API__ > 28
HWC2::Error HwcDisplay::GetDisplayIdentificationData(uint8_t *outPort,
uint32_t *outDataSize,
uint8_t *outData) {
if (IsInHeadlessMode()) {
return HWC2::Error::Unsupported;
}
auto blob = GetPipe().connector->Get()->GetEdidBlob();
if (!blob) {
return HWC2::Error::Unsupported;
}
*outPort = handle_; /* TDOD(nobody): What should be here? */
if (outData) {
*outDataSize = std::min(*outDataSize, blob->length);
memcpy(outData, blob->data, *outDataSize);
} else {
*outDataSize = blob->length;
}
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayCapabilities(uint32_t *outNumCapabilities,
uint32_t *outCapabilities) {
if (outNumCapabilities == nullptr) {
return HWC2::Error::BadParameter;
}
bool skip_ctm = false;
// Skip client CTM if user requested DRM_OR_IGNORE
if (GetHwc()->GetResMan().GetCtmHandling() == CtmHandling::kDrmOrIgnore)
skip_ctm = true;
// Skip client CTM if DRM can handle it
if (!skip_ctm && !IsInHeadlessMode() &&
GetPipe().crtc->Get()->GetCtmProperty())
skip_ctm = true;
if (!skip_ctm) {
*outNumCapabilities = 0;
return HWC2::Error::None;
}
*outNumCapabilities = 1;
if (outCapabilities) {
outCapabilities[0] = HWC2_DISPLAY_CAPABILITY_SKIP_CLIENT_COLOR_TRANSFORM;
}
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::GetDisplayBrightnessSupport(bool *supported) {
*supported = false;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetDisplayBrightness(float /* brightness */) {
return HWC2::Error::Unsupported;
}
#endif /* __ANDROID_API__ > 28 */
#if __ANDROID_API__ > 27
HWC2::Error HwcDisplay::GetRenderIntents(
int32_t mode, uint32_t *outNumIntents,
int32_t * /*android_render_intent_v1_1_t*/ outIntents) {
if (mode != HAL_COLOR_MODE_NATIVE) {
return HWC2::Error::BadParameter;
}
if (outIntents == nullptr) {
*outNumIntents = 1;
return HWC2::Error::None;
}
*outNumIntents = 1;
outIntents[0] = HAL_RENDER_INTENT_COLORIMETRIC;
return HWC2::Error::None;
}
HWC2::Error HwcDisplay::SetColorModeWithIntent(int32_t mode, int32_t intent) {
if (intent < HAL_RENDER_INTENT_COLORIMETRIC ||
intent > HAL_RENDER_INTENT_TONE_MAP_ENHANCE)
return HWC2::Error::BadParameter;
if (intent != HAL_RENDER_INTENT_COLORIMETRIC)
return HWC2::Error::Unsupported;
auto err = SetColorMode(mode);
if (err != HWC2::Error::None) return err;
return HWC2::Error::None;
}
#endif /* __ANDROID_API__ > 27 */
const Backend *HwcDisplay::backend() const {
return backend_.get();
}
void HwcDisplay::set_backend(std::unique_ptr<Backend> backend) {
backend_ = std::move(backend);
}
} // namespace android