src/devices/cpu/drivers/aml-cpu/aml-cpu.h

// Copyright 2019 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_DEVICES_CPU_DRIVERS_AML_CPU_AML_CPU_H_
#define SRC_DEVICES_CPU_DRIVERS_AML_CPU_AML_CPU_H_

#include <fuchsia/device/llcpp/fidl.h>
#include <fuchsia/hardware/cpu/ctrl/llcpp/fidl.h>
#include <lib/inspect/cpp/inspector.h>

#include <vector>

#include <ddktl/device.h>
#include <ddktl/protocol/clock.h>
#include <ddktl/protocol/empty-protocol.h>
#include <ddktl/protocol/power.h>
#include <soc/aml-common/aml-cpu-metadata.h>

namespace amlogic_cpu {

namespace fuchsia_cpuctrl = ::llcpp::fuchsia::hardware::cpu::ctrl;

class AmlCpu;
using DeviceType =
    ddk::Device<AmlCpu, ddk::Messageable, ddk::PerformanceTunable, ddk::AutoSuspendable>;

class AmlCpu : public DeviceType,
               public ddk::EmptyProtocol<ZX_PROTOCOL_CPU_CTRL>,
               fuchsia_cpuctrl::Device::Interface {
 public:
  DISALLOW_COPY_AND_ASSIGN_ALLOW_MOVE(AmlCpu);
  explicit AmlCpu(zx_device_t* parent, const ddk::ClockProtocolClient& plldiv16,
                  const ddk::ClockProtocolClient& cpudiv16,
                  const ddk::ClockProtocolClient& cpuscaler, const ddk::PowerProtocolClient& pwr,
                  const std::vector<operating_point_t>& operating_points)
      : DeviceType(parent),
        plldiv16_(plldiv16),
        cpudiv16_(cpudiv16),
        cpuscaler_(cpuscaler),
        pwr_(pwr),
        current_pstate_(operating_points.size() -
                        1)  // Assume the core is running at the slowest clock to begin.
        ,
        operating_points_(operating_points) {}

  static zx_status_t Create(void* context, zx_device_t* device);

  zx_status_t Init();

  // Implements ddk::Messageable
  zx_status_t DdkMessage(fidl_incoming_msg_t* msg, fidl_txn_t* txn);

  // Implements DDK Device Ops
  void DdkRelease();

  // Implements ddk::PerformanceTunable.
  zx_status_t DdkSetPerformanceState(uint32_t requested_state, uint32_t* out_state);
  zx_status_t DdkConfigureAutoSuspend(bool enable, uint8_t requested_sleep_state);

  // Fidl server interface implementation.
  void GetPerformanceStateInfo(uint32_t state, GetPerformanceStateInfoCompleter::Sync& completer);
  void GetNumLogicalCores(GetNumLogicalCoresCompleter::Sync& completer);
  void GetLogicalCoreId(uint64_t index, GetLogicalCoreIdCompleter::Sync& completer);

  // Set CpuInfo in inspect.
  void SetCpuInfo(uint32_t cpu_version_packed);

 protected:
  inspect::Inspector inspector_;
  inspect::Node cpu_info_ = inspector_.GetRoot().CreateChild("cpu_info_service");

 private:
  const ddk::ClockProtocolClient plldiv16_;
  const ddk::ClockProtocolClient cpudiv16_;
  const ddk::ClockProtocolClient cpuscaler_;
  const ddk::PowerProtocolClient pwr_;

  size_t current_pstate_;
  const std::vector<operating_point_t> operating_points_;
};

}  // namespace amlogic_cpu

#endif  // SRC_DEVICES_CPU_DRIVERS_AML_CPU_AML_CPU_H_