src/devices/bus/drivers/platform/test/test/power.cc

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

#include <fuchsia/hardware/platform/bus/c/banjo.h>
#include <fuchsia/hardware/platform/device/c/banjo.h>
#include <fuchsia/hardware/power/c/banjo.h>
#include <fuchsia/hardware/powerimpl/cpp/banjo.h>
#include <lib/ddk/debug.h>
#include <lib/ddk/driver.h>
#include <zircon/errors.h>

#include <memory>

#include <ddktl/device.h>

#include "src/devices/bus/drivers/platform/test/test-power-bind.h"

#define DRIVER_NAME "test-power"

namespace power {

class TestPowerDevice;
using DeviceType = ddk::Device<TestPowerDevice>;

class TestPowerDevice : public DeviceType,
                        public ddk::PowerImplProtocol<TestPowerDevice, ddk::base_protocol> {
 public:
  static zx_status_t Create(zx_device_t* parent);

  explicit TestPowerDevice(zx_device_t* parent) : DeviceType(parent) {}

  zx_status_t Create(std::unique_ptr<TestPowerDevice>* out);
  zx_status_t Init();

  // Methods required by the ddk mixins
  void DdkRelease();

  zx_status_t PowerImplEnablePowerDomain(uint32_t index);
  zx_status_t PowerImplDisablePowerDomain(uint32_t index);
  zx_status_t PowerImplGetPowerDomainStatus(uint32_t index, power_domain_status_t* out_status);
  zx_status_t PowerImplGetSupportedVoltageRange(uint32_t index, uint32_t* min_voltage,
                                                uint32_t* max_voltage);

  zx_status_t PowerImplRequestVoltage(uint32_t index, uint32_t voltage, uint32_t* actual_voltage);
  zx_status_t PowerImplGetCurrentVoltage(uint32_t index, uint32_t* current_voltage);
  zx_status_t PowerImplReadPmicCtrlReg(uint32_t index, uint32_t addr, uint32_t* value);
  zx_status_t PowerImplWritePmicCtrlReg(uint32_t index, uint32_t addr, uint32_t value);

 private:
  // For testing PMIC register read/write
  uint32_t last_index_ = 0;
  uint32_t last_addr_ = 0;
  uint32_t last_value_ = 0;

  // Values for domains with indexes 0 - 3
  uint32_t min_voltage_[4] = {10, 10, 10, 10};
  uint32_t max_voltage_[4] = {1000, 1000, 1000, 1000};
  uint32_t cur_voltage_[4] = {0, 0, 0, 0};
  bool enabled_[4] = {false, false, false, false};
};

zx_status_t TestPowerDevice::Init() {
  pbus_protocol_t pbus;
  auto status = device_get_protocol(parent(), ZX_PROTOCOL_PBUS, &pbus);
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s: ZX_PROTOCOL_PBUS not available %d", __func__, status);
    return status;
  }
  power_impl_protocol_t power_proto = {
      .ops = &power_impl_protocol_ops_,
      .ctx = this,
  };
  status = pbus_register_protocol(&pbus, ZX_PROTOCOL_POWER_IMPL,
                                  reinterpret_cast<uint8_t*>(&power_proto), sizeof(power_proto));
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s pbus_register_protocol failed %d", __func__, status);
    return status;
  }
  return ZX_OK;
}

zx_status_t TestPowerDevice::Create(zx_device_t* parent) {
  auto dev = std::make_unique<TestPowerDevice>(parent);
  pdev_protocol_t pdev;
  zx_status_t status;

  zxlogf(INFO, "TestPowerDevice::Create: %s ", DRIVER_NAME);

  status = device_get_protocol(parent, ZX_PROTOCOL_PDEV, &pdev);
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s: could not get ZX_PROTOCOL_PDEV", __func__);
    return status;
  }

  status = dev->DdkAdd("test-power", DEVICE_ADD_ALLOW_MULTI_COMPOSITE);
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s: DdkAdd failed: %d", __func__, status);
    return status;
  }
  // devmgr is now in charge of dev.
  auto ptr = dev.release();

  return ptr->Init();
}

void TestPowerDevice::DdkRelease() { delete this; }

zx_status_t TestPowerDevice::PowerImplEnablePowerDomain(uint32_t index) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  enabled_[index] = true;
  zxlogf(INFO, "%s: Enabling power domain for index:%d", __func__, index);
  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplDisablePowerDomain(uint32_t index) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  if (!enabled_[index]) {
    zxlogf(ERROR, "%s: Power domain is not enabled: index:%d", __func__, index);
    return ZX_ERR_UNAVAILABLE;
  }
  enabled_[index] = false;
  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplGetPowerDomainStatus(uint32_t index,
                                                           power_domain_status_t* out_status) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  *out_status = POWER_DOMAIN_STATUS_DISABLED;
  if (enabled_[index]) {
    *out_status = POWER_DOMAIN_STATUS_ENABLED;
  }
  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplGetSupportedVoltageRange(uint32_t index,
                                                               uint32_t* min_voltage,
                                                               uint32_t* max_voltage) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  *min_voltage = min_voltage_[index];
  *max_voltage = max_voltage_[index];
  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplRequestVoltage(uint32_t index, uint32_t voltage,
                                                     uint32_t* actual_voltage) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  if (voltage >= min_voltage_[index] && voltage <= max_voltage_[index]) {
    *actual_voltage = voltage;
    cur_voltage_[index] = voltage;
    return ZX_OK;
  }
  return ZX_ERR_INVALID_ARGS;
}

zx_status_t TestPowerDevice::PowerImplGetCurrentVoltage(uint32_t index, uint32_t* current_voltage) {
  if (index >= 4) {
    return ZX_ERR_INVALID_ARGS;
  }
  *current_voltage = cur_voltage_[index];
  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplWritePmicCtrlReg(uint32_t index, uint32_t addr,
                                                       uint32_t value) {
  // Save most recent write for read.
  last_index_ = index;
  last_addr_ = addr;
  last_value_ = value;

  return ZX_OK;
}

zx_status_t TestPowerDevice::PowerImplReadPmicCtrlReg(uint32_t index, uint32_t addr,
                                                      uint32_t* value) {
  if (index == last_index_ && addr == last_addr_) {
    *value = last_value_;
    return ZX_OK;
  }
  return ZX_ERR_NOT_SUPPORTED;
}

zx_status_t test_power_bind(void* ctx, zx_device_t* parent) {
  return TestPowerDevice::Create(parent);
}

constexpr zx_driver_ops_t driver_ops = []() {
  zx_driver_ops_t driver_ops = {};
  driver_ops.version = DRIVER_OPS_VERSION;
  driver_ops.bind = test_power_bind;
  return driver_ops;
}();

}  // namespace power

ZIRCON_DRIVER(test_power, power::driver_ops, "zircon", "0.1");