src/devices/tests/ddk-firmware-test/test-driver.cc

// Copyright 2020 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/device/firmware/test/llcpp/fidl.h>
#include <zircon/assert.h>
#include <zircon/errors.h>

#include <ddk/debug.h>
#include <ddk/device.h>
#include <ddk/driver.h>
#include <ddk/platform-defs.h>
#include <ddktl/device.h>
#include <ddktl/fidl.h>
#include <fbl/alloc_checker.h>

#include "src/devices/tests/ddk-firmware-test/test-driver-bind.h"

namespace {

// Keep in sync with test-firmware.txt
constexpr const char TEST_FIRMWARE_CONTENTS[] = "this is some firmware\n";

using llcpp::fuchsia::device::firmware::test::TestDevice;

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

class TestFirmwareDriver : public DeviceType, public TestDevice::Interface {
 public:
  explicit TestFirmwareDriver(zx_device_t* parent) : DeviceType(parent) {}

  zx_status_t Bind() { return DdkAdd("ddk-firmware-test"); }

  // Device protocol implementation.
  void DdkUnbind(ddk::UnbindTxn txn) { txn.Reply(); }
  void DdkRelease() { delete this; }

  // Device message ops implementation.
  void LoadFirmware(fidl::StringView path, LoadFirmwareCompleter::Sync& completer) override;
  void LoadFirmwareAsync(fidl::StringView path,
                         LoadFirmwareAsyncCompleter::Sync& completer) override;

  zx_status_t DdkMessage(fidl_incoming_msg_t* msg, fidl_txn_t* txn) {
    DdkTransaction transaction(txn);
    TestDevice::Dispatch(this, msg, &transaction);
    return transaction.Status();
  }

 private:
  static zx_status_t CheckFirmware(zx_handle_t fw, size_t size);
};

void TestFirmwareDriver::LoadFirmware(fidl::StringView path,
                                      LoadFirmwareCompleter::Sync& completer) {
  zx_handle_t fw;
  size_t size;
  std::string str_path(path.begin(), path.size());
  auto status = load_firmware(zxdev(), str_path.c_str(), &fw, &size);
  if (status != ZX_OK) {
    ZX_DEBUG_ASSERT(completer.ReplyError(status).status() == ZX_OK);
    return;
  }

  TestFirmwareDriver::CheckFirmware(fw, size);
  completer.ReplySuccess();
}

void TestFirmwareDriver::LoadFirmwareAsync(fidl::StringView path,
                                           LoadFirmwareAsyncCompleter::Sync& completer) {
  struct FwCtx {
    LoadFirmwareAsyncCompleter::Async completer;
  };

  auto ctx = std::make_unique<FwCtx>(FwCtx{
      .completer = completer.ToAsync(),
  });
  std::string str_path(path.begin(), path.size());

  load_firmware_async(
      zxdev(), str_path.c_str(),
      [](void* ctx, zx_status_t result, zx_handle_t fw, size_t size) {
        std::unique_ptr<FwCtx> context(reinterpret_cast<FwCtx*>(ctx));

        if (result != ZX_OK) {
          context->completer.ReplyError(result);
          return;
        }

        result = TestFirmwareDriver::CheckFirmware(fw, size);
        if (result != ZX_OK) {
          context->completer.ReplyError(result);
          return;
        }
        context->completer.ReplySuccess();
      },
      ctx.release());
}

zx_status_t TestFirmwareDriver::CheckFirmware(zx_handle_t fw, size_t size) {
  zx::vmo vmo(fw);
  if (!vmo) {
    return ZX_ERR_INVALID_ARGS;
  }

  if (size != strlen(TEST_FIRMWARE_CONTENTS)) {
    return ZX_ERR_FILE_BIG;
  }
  auto buf = std::make_unique<char[]>(size);
  vmo.read(buf.get(), 0, size);

  if (memcmp(buf.get(), TEST_FIRMWARE_CONTENTS, size) != 0) {
    return ZX_ERR_IO;
  }
  return ZX_OK;
}

zx_status_t TestFirmwareBind(void* ctx, zx_device_t* device) {
  fbl::AllocChecker ac;
  auto dev = fbl::make_unique_checked<TestFirmwareDriver>(&ac, device);
  if (!ac.check()) {
    return ZX_ERR_NO_MEMORY;
  }
  auto status = dev->Bind();
  if (status == ZX_OK) {
    // devmgr is now in charge of the memory for dev
    __UNUSED auto ptr = dev.release();
  }
  return status;
}

zx_driver_ops_t driver_ops = []() -> zx_driver_ops_t {
  zx_driver_ops_t ops = {};
  ops.version = DRIVER_OPS_VERSION;
  ops.bind = TestFirmwareBind;
  return ops;
}();

}  // namespace

ZIRCON_DRIVER(TestFirmware, driver_ops, "zircon", "0.1");