blob: 9d1f7d1083dc05f04bc403c38f3a684047b6dabe [file]
// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef SRC_GRAPHICS_DISPLAY_LIB_FRAMEBUFFER_DISPLAY_FRAMEBUFFER_DISPLAY_DRIVER_H_
#define SRC_GRAPHICS_DISPLAY_LIB_FRAMEBUFFER_DISPLAY_FRAMEBUFFER_DISPLAY_DRIVER_H_
#include <lib/driver/component/cpp/driver_base2.h>
#include <lib/driver/mmio/cpp/mmio-buffer.h>
#include <lib/fdf/cpp/dispatcher.h>
#include <memory>
#include "src/graphics/display/lib/api-protocols/cpp/display-engine-events-fidl.h"
#include "src/graphics/display/lib/api-protocols/cpp/display-engine-fidl-adapter.h"
#include "src/graphics/display/lib/framebuffer-display/framebuffer-display.h"
namespace framebuffer_display {
// Integration between display drivers and the Driver Framework (v1).
class FramebufferDisplayDriver : public fdf::DriverBase2 {
public:
explicit FramebufferDisplayDriver(std::string_view device_name);
FramebufferDisplayDriver(const FramebufferDisplayDriver&) = delete;
FramebufferDisplayDriver(FramebufferDisplayDriver&&) = delete;
FramebufferDisplayDriver& operator=(const FramebufferDisplayDriver&) = delete;
FramebufferDisplayDriver& operator=(FramebufferDisplayDriver&&) = delete;
virtual ~FramebufferDisplayDriver();
// fdf::DriverBase:
zx::result<> Start(fdf::DriverContext context) override;
void Stop(fdf::StopCompleter completer) override;
// Called exactly once before the driver acquires any resource.
virtual zx::result<> ConfigureHardware() = 0;
virtual zx::result<fdf::MmioBuffer> GetFrameBufferMmioBuffer() = 0;
virtual zx::result<DisplayProperties> GetDisplayProperties() = 0;
protected:
const fdf::Namespace& incoming() const { return *incoming_; }
fdf::Namespace& incoming() { return *incoming_; }
private:
std::unique_ptr<fdf::Namespace> incoming_;
zx::result<std::unique_ptr<FramebufferDisplay>> CreateAndInitializeFramebufferDisplay(
const fdf::Namespace& incoming);
// Must be called after `framebuffer_display_` is initialized.
zx::result<> InitializeFidlServiceNode();
// Must outlive `framebuffer_display_` and `engine_fidl_adapter_`.
std::unique_ptr<display::DisplayEngineEventsFidl> engine_events_;
fdf::SynchronizedDispatcher framebuffer_display_dispatcher_;
std::unique_ptr<FramebufferDisplay> framebuffer_display_;
std::unique_ptr<display::DisplayEngineFidlAdapter> engine_fidl_adapter_;
fidl::WireSyncClient<fuchsia_driver_framework::NodeController> node_controller_;
};
} // namespace framebuffer_display
#endif // SRC_GRAPHICS_DISPLAY_LIB_FRAMEBUFFER_DISPLAY_FRAMEBUFFER_DISPLAY_DRIVER_H_