src/graphics/display/drivers/astro-display/vpu.h

// 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_DRIVERS_ASTRO_DISPLAY_VPU_H_
#define SRC_GRAPHICS_DISPLAY_DRIVERS_ASTRO_DISPLAY_VPU_H_

#include <lib/device-protocol/platform-device.h>
#include <lib/mmio/mmio.h>
#include <lib/zircon-internal/thread_annotations.h>
#include <zircon/compiler.h>

#include <optional>

#include <ddk/protocol/platform/device.h>
#include <fbl/auto_lock.h>
#include <fbl/mutex.h>

#include "common.h"
#include "vpu-regs.h"

namespace astro_display {

class Vpu {
 public:
  Vpu() {}
  zx_status_t Init(zx_device_t* parent);
  // This function powers on VPU related blocks. The function contains undocumented
  // register and/or power-on sequences.
  void PowerOn();
  // This function powers off VPU related blocks. The function contains undocumented
  // register and/or power-off sequences.
  void PowerOff();
  // This function sets up default video post processing unit. It contains undocumented
  // registers and/or initialization sequences
  void VppInit();
  // This function sets a flag to indicate the first time driver is loaded. Returns
  // false if driver was already loaded previously
  bool SetFirstTimeDriverLoad();

  zx_status_t CaptureInit(uint8_t canvas_idx, uint32_t height, uint32_t stride);
  zx_status_t CaptureStart();
  zx_status_t CaptureDone();
  void CapturePrintRegisters();

  CaptureState GetCaptureState() {
    fbl::AutoLock lock(&capture_lock_);
    return capture_state_;
  }

 private:
  // This function configures the VPU-related clocks. It contains undocumented registers
  // and/or clock initialization sequences
  void ConfigureClock();

  std::optional<ddk::MmioBuffer> vpu_mmio_;
  std::optional<ddk::MmioBuffer> hhi_mmio_;
  std::optional<ddk::MmioBuffer> aobus_mmio_;
  std::optional<ddk::MmioBuffer> cbus_mmio_;
  pdev_protocol_t pdev_ = {};

  bool initialized_ = false;

  uint32_t first_time_load_ = false;

  fbl::Mutex capture_lock_;
  CaptureState capture_state_ TA_GUARDED(capture_lock_);
};
}  // namespace astro_display

#endif  // SRC_GRAPHICS_DISPLAY_DRIVERS_ASTRO_DISPLAY_VPU_H_