src/graphics/display/drivers/amlogic-display/hdmitx-clk.cc

// Copyright 2021 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.

#include <unistd.h>
#include <zircon/assert.h>

#include <cinttypes>

#include "src/graphics/display/drivers/amlogic-display/clock-regs.h"
#include "src/graphics/display/drivers/amlogic-display/fixed-point-util.h"
#include "src/graphics/display/drivers/amlogic-display/hdmi-host.h"
#include "src/graphics/display/drivers/amlogic-display/hhi-regs.h"
#include "src/graphics/display/drivers/amlogic-display/vpu-regs.h"
#include "src/graphics/display/lib/driver-framework-migration-utils/logging/zxlogf.h"

namespace amlogic_display {

void HdmiHost::WaitForPllLocked() {
  bool err = false;
  do {
    unsigned int st = 0;
    int cnt = 10000;
    while (cnt--) {
      usleep(5);
      auto reg = HhiHdmiPllCntlReg::Get().ReadFrom(&hhi_mmio_);
      st = (reg.hdmi_dpll_lock() == 1) && (reg.hdmi_dpll_lock_a() == 1);
      if (st) {
        err = false;
        break;
      } else { /* reset hpll */
        HhiHdmiPllCntlReg::Get().ReadFrom(&hhi_mmio_).set_hdmi_dpll_reset(1).WriteTo(&hhi_mmio_);
        HhiHdmiPllCntlReg::Get().ReadFrom(&hhi_mmio_).set_hdmi_dpll_reset(0).WriteTo(&hhi_mmio_);
      }
    }
    zxlogf(ERROR, "pll[0x%x] reset %d times", HHI_HDMI_PLL_CNTL0, 10000 - cnt);
    if (cnt <= 0)
      err = true;
  } while (err);
}

namespace {

VideoInputUnitEncoderMuxControl::Encoder EncoderSelectionFromViuType(viu_type type) {
  switch (type) {
    case VIU_ENCL:
      return VideoInputUnitEncoderMuxControl::Encoder::kLcd;
    case VIU_ENCI:
      return VideoInputUnitEncoderMuxControl::Encoder::kInterlaced;
    case VIU_ENCP:
      return VideoInputUnitEncoderMuxControl::Encoder::kProgressive;
    case VIU_ENCT:
      return VideoInputUnitEncoderMuxControl::Encoder::kTvPanel;
  }
  zxlogf(ERROR, "Incorrect VIU type: %u", type);
  return VideoInputUnitEncoderMuxControl::Encoder::kLcd;
}

}  // namespace

void HdmiHost::ConfigurePll(const pll_param& pll_params) {
  // Set VIU Mux Ctrl
  if (pll_params.viu_channel == 1) {
    VideoInputUnitEncoderMuxControl::Get()
        .ReadFrom(&vpu_mmio_)
        .set_vsync_shared_by_viu_blocks(false)
        .set_viu1_encoder_selection(
            EncoderSelectionFromViuType(static_cast<viu_type>(pll_params.viu_type)))
        .WriteTo(&vpu_mmio_);
  } else {
    VideoInputUnitEncoderMuxControl::Get()
        .ReadFrom(&vpu_mmio_)
        .set_vsync_shared_by_viu_blocks(false)
        .set_viu2_encoder_selection(
            EncoderSelectionFromViuType(static_cast<viu_type>(pll_params.viu_type)))
        .WriteTo(&vpu_mmio_);
  }
  HdmiClockControl::Get()
      .ReadFrom(&hhi_mmio_)
      .set_hdmi_tx_system_clock_selection(
          HdmiClockControl::HdmiTxSystemClockSource::kExternalOscillator24Mhz)
      .SetHdmiTxSystemClockDivider(1)
      .set_hdmi_tx_system_clock_enabled(true)
      .WriteTo(&hhi_mmio_);

  ConfigureHpllClkOut(pll_params.hdmi_pll_vco_output_frequency_hz);

  HhiHdmiPllCntlReg::Get()
      .ReadFrom(&hhi_mmio_)
      .set_hdmi_dpll_od1(pll_params.output_divider1 >> 1)
      .set_hdmi_dpll_od2(pll_params.output_divider2 >> 1)
      .set_hdmi_dpll_od3(pll_params.output_divider3 >> 1)
      .WriteTo(&hhi_mmio_);

  ConfigureHdmiClockTree(pll_params.hdmi_clock_tree_vid_pll_divider);

  VideoClock1Control::Get()
      .ReadFrom(&hhi_mmio_)
      .set_mux_source(VideoClockMuxSource::kVideoPll)
      .WriteTo(&hhi_mmio_);
  VideoClock1Divider::Get()
      .ReadFrom(&hhi_mmio_)
      .SetDivider0((pll_params.video_clock1_divider == 0) ? 1 : (pll_params.video_clock1_divider))
      .WriteTo(&hhi_mmio_);
  VideoClock1Control::Get()
      .ReadFrom(&hhi_mmio_)
      .set_div4_enabled(true)
      .set_div2_enabled(true)
      .set_div1_enabled(true)
      .WriteTo(&hhi_mmio_);

  HdmiClockControl::Get()
      .ReadFrom(&hhi_mmio_)
      .set_hdmi_tx_pixel_clock_selection(HdmiClockControl::HdmiTxPixelClockSource::kVideoClock1)
      .WriteTo(&hhi_mmio_);

  VideoClockOutputControl::Get()
      .ReadFrom(&hhi_mmio_)
      .set_hdmi_tx_pixel_clock_enabled(true)
      .WriteTo(&hhi_mmio_);

  if (pll_params.encp_clock_divider != -1) {
    VideoClock1Divider::Get()
        .ReadFrom(&hhi_mmio_)
        .set_encp_clock_selection(EncoderClockSource::kVideoClock1)
        .WriteTo(&hhi_mmio_);
    VideoClockOutputControl::Get()
        .ReadFrom(&hhi_mmio_)
        .set_encoder_progressive_enabled(true)
        .WriteTo(&hhi_mmio_);
    VideoClock1Control::Get().ReadFrom(&hhi_mmio_).set_divider0_enabled(true).WriteTo(&hhi_mmio_);
  }
  if (pll_params.enci_clock_divider != -1) {
    VideoClock1Divider::Get()
        .ReadFrom(&hhi_mmio_)
        .set_enci_clock_selection(EncoderClockSource::kVideoClock1)
        .WriteTo(&hhi_mmio_);
    VideoClockOutputControl::Get()
        .ReadFrom(&hhi_mmio_)
        .set_encoder_interlaced_enabled(true)
        .WriteTo(&hhi_mmio_);
    VideoClock1Control::Get().ReadFrom(&hhi_mmio_).set_divider0_enabled(true).WriteTo(&hhi_mmio_);
  }
}

// TODO(https://fxbug.dev/328135383): Unify the PLL configuration logic for
// HDMI and MIPI-DSI output.
void HdmiHost::ConfigureHpllClkOut(int64_t expected_hdmi_pll_vco_output_frequency_hz) {
  static constexpr int64_t kExternalOscillatorFrequencyHz = 24'000'000;

  static constexpr int32_t kMinHdmiPllMultiplierInteger = 1;
  static constexpr int32_t kMaxHdmiPllMultiplierInteger = 255;

  // TODO(https://fxbug.dev/328177521): Instead of asserting, we should check
  // the validity of the expected VCO output frequency before configuring the
  // PLL.
  ZX_ASSERT(expected_hdmi_pll_vco_output_frequency_hz >=
            kExternalOscillatorFrequencyHz * kMinHdmiPllMultiplierInteger);
  ZX_ASSERT(expected_hdmi_pll_vco_output_frequency_hz <=
            kExternalOscillatorFrequencyHz * kMaxHdmiPllMultiplierInteger);

  // The assertion above guarantees that `pll_multiplier_integer` is always
  // >= kMinHdmiPllMultiplierInteger and <= kMaxHdmiPllMultiplierInteger, so
  // it can be stored as an int32_t value.
  const int32_t pll_multiplier_integer = static_cast<int32_t>(
      expected_hdmi_pll_vco_output_frequency_hz / kExternalOscillatorFrequencyHz);

  static constexpr int32_t kPllMultiplierFractionScalingRatio = 1 << 17;
  // The result is in range [0, 2^17), so it can be stored as an int32_t
  // value.
  const int32_t pll_multiplier_fraction = static_cast<int32_t>(
      (expected_hdmi_pll_vco_output_frequency_hz % kExternalOscillatorFrequencyHz) *
      kPllMultiplierFractionScalingRatio / kExternalOscillatorFrequencyHz);

  zxlogf(DEBUG,
         "HDMI PLL VCO configured: desired multiplier = %" PRId32 " + %" PRId32 " / %" PRId32,
         pll_multiplier_integer, pll_multiplier_fraction, kPllMultiplierFractionScalingRatio);
  zxlogf(DEBUG, "HDMI PLL VCO output frequency: %" PRId64 " Hz",
         expected_hdmi_pll_vco_output_frequency_hz);

  HhiHdmiPllCntlReg::Get()
      .FromValue(0x0b3a0400)
      .set_hdmi_dpll_M(pll_multiplier_integer)
      .WriteTo(&hhi_mmio_);

  /* Enable and reset */
  HhiHdmiPllCntlReg::Get()
      .ReadFrom(&hhi_mmio_)
      .set_hdmi_dpll_en(1)
      .set_hdmi_dpll_reset(1)
      .WriteTo(&hhi_mmio_);

  HhiHdmiPllCntl1Reg::Get().FromValue(pll_multiplier_fraction).WriteTo(&hhi_mmio_);
  HhiHdmiPllCntl2Reg::Get().FromValue(0x0).WriteTo(&hhi_mmio_);

  /* G12A HDMI PLL Needs specific parameters for 5.4GHz */
  if (pll_multiplier_integer >= 0xf7) {
    HhiHdmiPllCntl3Reg::Get().FromValue(0x6a685c00).WriteTo(&hhi_mmio_);
    HhiHdmiPllCntl4Reg::Get().FromValue(0x11551293).WriteTo(&hhi_mmio_);
    HhiHdmiPllCntl5Reg::Get().FromValue(0x39272000).WriteTo(&hhi_mmio_);
    HhiHdmiPllStsReg::Get().FromValue(0x55540000).WriteTo(&hhi_mmio_);
  } else {
    HhiHdmiPllCntl3Reg::Get().FromValue(0x0a691c00).WriteTo(&hhi_mmio_);
    HhiHdmiPllCntl4Reg::Get().FromValue(0x33771290).WriteTo(&hhi_mmio_);
    HhiHdmiPllCntl5Reg::Get().FromValue(0x39272000).WriteTo(&hhi_mmio_);
    HhiHdmiPllStsReg::Get().FromValue(0x50540000).WriteTo(&hhi_mmio_);
  }

  /* Reset PLL */
  HhiHdmiPllCntlReg::Get().ReadFrom(&hhi_mmio_).set_hdmi_dpll_reset(1).WriteTo(&hhi_mmio_);

  /* UN-Reset PLL */
  HhiHdmiPllCntlReg::Get().ReadFrom(&hhi_mmio_).set_hdmi_dpll_reset(0).WriteTo(&hhi_mmio_);

  /* Poll for lock bits */
  WaitForPllLocked();
}

void HdmiHost::ConfigureHdmiClockTree(int divider_ratio) {
  ZX_DEBUG_ASSERT_MSG(std::find(HdmiClockTreeControl::kSupportedFrequencyDividerRatios.begin(),
                                HdmiClockTreeControl::kSupportedFrequencyDividerRatios.end(),
                                ToU28_4(divider_ratio)) !=
                          HdmiClockTreeControl::kSupportedFrequencyDividerRatios.end(),
                      "HDMI clock tree divider ratio %d is not supported.", divider_ratio);

  // TODO(https://fxbug.dev/42086073): When the divider ratio is 6.25, some
  // Amlogic-provided code triggers a software reset of the `vid_pll_div` clock
  // before setting the HDMI clock tree, while some other Amlogic-provided code
  // doesn't do any reset.
  //
  // Currently fractional divider ratios are not supported; this needs to
  // be addressed once we add fraction divider ratio support.

  HdmiClockTreeControl hdmi_clock_tree_control = HdmiClockTreeControl::Get().ReadFrom(&hhi_mmio_);
  hdmi_clock_tree_control.set_clock_output_enabled(false).WriteTo(&hhi_mmio_);

  // This implementation deviates from the Amlogic-provided code.
  //
  // The Amlogic-provided code changes the pattern generator enablement, mode
  // selection and the state in different register writes, while the current
  // implementation changes all of them at the same time. Experiments on Khadas
  // VIM3 (A311D) show that our implementation works correctly.
  hdmi_clock_tree_control.ReadFrom(&hhi_mmio_)
      .SetFrequencyDividerRatio(ToU28_4(divider_ratio))
      .set_preset_pattern_update_enabled(true)
      .WriteTo(&hhi_mmio_);

  hdmi_clock_tree_control.ReadFrom(&hhi_mmio_)
      .set_preset_pattern_update_enabled(false)
      .WriteTo(&hhi_mmio_);

  hdmi_clock_tree_control.ReadFrom(&hhi_mmio_).set_clock_output_enabled(true).WriteTo(&hhi_mmio_);
}

}  // namespace amlogic_display