src/devices/clock/drivers/as370-clk/as370-clk.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_CLOCK_DRIVERS_AS370_CLK_AS370_CLK_H_
#define SRC_DEVICES_CLOCK_DRIVERS_AS370_CLK_AS370_CLK_H_

#include <fuchsia/hardware/clockimpl/cpp/banjo.h>
#include <lib/mmio/mmio.h>
#include <lib/zircon-internal/thread_annotations.h>

#include <ddktl/device.h>
#include <fbl/mutex.h>
#include <soc/as370/as370-clk.h>

namespace clk {

class As370Clk;
using DeviceType = ddk::Device<As370Clk, ddk::Unbindable>;

class As370Clk : public DeviceType, public ddk::ClockImplProtocol<As370Clk, ddk::base_protocol> {
 public:
  static zx_status_t Create(void* ctx, zx_device_t* parent);

  // Clock Protocol Implementation
  zx_status_t ClockImplEnable(uint32_t index);
  zx_status_t ClockImplDisable(uint32_t index);
  zx_status_t ClockImplIsEnabled(uint32_t id, bool* out_enabled);

  zx_status_t ClockImplSetRate(uint32_t id, uint64_t hz);
  zx_status_t ClockImplQuerySupportedRate(uint32_t id, uint64_t max_rate, uint64_t* out_best_rate);
  zx_status_t ClockImplGetRate(uint32_t id, uint64_t* out_current_rate);

  zx_status_t ClockImplSetInput(uint32_t id, uint32_t idx);
  zx_status_t ClockImplGetNumInputs(uint32_t id, uint32_t* out);
  zx_status_t ClockImplGetInput(uint32_t id, uint32_t* out);

  // Device Protocol Implementation.
  void DdkUnbind(ddk::UnbindTxn txn);
  void DdkRelease();

  // Protected for unit tests.
 protected:
  As370Clk(zx_device_t* parent, ddk::MmioBuffer global_mmio, ddk::MmioBuffer avio_mmio,
           ddk::MmioBuffer cpu_mmio)
      : DeviceType(parent),
        global_mmio_(std::move(global_mmio)),
        avio_mmio_(std::move(avio_mmio)),
        cpu_mmio_(std::move(cpu_mmio)) {}

 private:
  zx_status_t AvpllClkEnable(bool avpll0, bool enable);
  zx_status_t AvpllSetRate(bool avpll0, uint64_t rate);
  zx_status_t CpuSetRate(uint64_t rate);

  fbl::Mutex lock_;
  ddk::MmioBuffer global_mmio_ TA_GUARDED(lock_);
  ddk::MmioBuffer avio_mmio_ TA_GUARDED(lock_);
  ddk::MmioBuffer cpu_mmio_ TA_GUARDED(lock_);
};

}  // namespace clk

#endif  // SRC_DEVICES_CLOCK_DRIVERS_AS370_CLK_AS370_CLK_H_