src/graphics/display/drivers/aml-canvas/aml-canvas-driver.h

// Copyright 2024 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_DRIVERS_AML_CANVAS_AML_CANVAS_DRIVER_H_
#define SRC_GRAPHICS_DISPLAY_DRIVERS_AML_CANVAS_AML_CANVAS_DRIVER_H_

#include <fidl/fuchsia.driver.framework/cpp/wire.h>
#include <lib/driver/compat/cpp/device_server.h>
#include <lib/driver/component/cpp/driver_base.h>
#include <lib/inspect/component/cpp/component.h>
#include <lib/zx/result.h>

#include <memory>

#include "src/graphics/display/drivers/aml-canvas/aml-canvas.h"

namespace aml_canvas {

// Driver instance that binds to the canvas board device.
//
// This class is responsible for interfacing with the Fuchsia Driver Framework.
class AmlCanvasDriver : public fdf::DriverBase {
 public:
  explicit AmlCanvasDriver(fdf::DriverStartArgs start_args,
                           fdf::UnownedSynchronizedDispatcher driver_dispatcher);
  ~AmlCanvasDriver() override = default;

  AmlCanvasDriver(const AmlCanvasDriver&) = delete;
  AmlCanvasDriver(AmlCanvasDriver&&) = delete;
  AmlCanvasDriver& operator=(const AmlCanvasDriver&) = delete;
  AmlCanvasDriver& operator=(AmlCanvasDriver&&) = delete;

  // `fdf::DriverBase` methods.
  zx::result<> Start() override;
  void Stop() override;

 private:
  // Creates a ComponentInspector that serves its Inspect data to the
  // driver component's Inspect sink.
  zx::result<std::unique_ptr<inspect::ComponentInspector>> CreateComponentInspector();

  // Creates an AmlCanvas using the resources provided by the driver component
  // and adds the [`fuchsia.hardware.amlogiccanvas/Service`] it serves to the
  // driver component's outgoing directory.
  zx::result<std::unique_ptr<AmlCanvas>> CreateAndServeCanvas(inspect::Inspector inspector);

  // Sets up the service offering of the child node, and adds the child node to
  // the node topology.
  //
  // If `compat_server` is not null, also configures the child node to provide
  // the node resources to descendant DFv1 drivers via the
  // [`fuchsia.driver.compat/Device`] interface using the provided
  // `compat_server`.
  //
  // On success, returns a client handle to the NodeController for the driver
  // to remove the node or manage the driver binding.
  zx::result<fidl::ClientEnd<fuchsia_driver_framework::NodeController>> AddChildNode(
      compat::SyncInitializedDeviceServer* compat_server);

  std::unique_ptr<inspect::ComponentInspector> component_inspector_;
  compat::SyncInitializedDeviceServer compat_server_;
  fidl::WireSyncClient<fuchsia_driver_framework::NodeController> controller_;

  std::unique_ptr<AmlCanvas> canvas_;
};

}  // namespace aml_canvas

#endif  // SRC_GRAPHICS_DISPLAY_DRIVERS_AML_CANVAS_AML_CANVAS_DRIVER_H_