src/devices/bus/drivers/pci/test/driver/protocol_test_driver.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_BUS_DRIVERS_PCI_TEST_DRIVER_PROTOCOL_TEST_DRIVER_H_
#define SRC_DEVICES_BUS_DRIVERS_PCI_TEST_DRIVER_PROTOCOL_TEST_DRIVER_H_

#include <fuchsia/device/test/c/fidl.h>

#include <ddk/device.h>
#include <ddktl/device.h>
#include <ddktl/protocol/pci.h>
#include <pretty/hexdump.h>
#include <zxtest/base/observer.h>
#include <zxtest/zxtest.h>

#include "driver_tests.h"

class TestObserver : public zxtest::LifecycleObserver {
 public:
  void OnTestStart(const zxtest::TestCase&, const zxtest::TestInfo&) final { report_.test_count++; }
  void OnTestSuccess(const zxtest::TestCase&, const zxtest::TestInfo&) final {
    report_.success_count++;
  }
  void OnTestFailure(const zxtest::TestCase&, const zxtest::TestInfo&) final {
    report_.failure_count++;
  }
  const fuchsia_device_test_TestReport& report() { return report_; }

 protected:
  fuchsia_device_test_TestReport report_ = {};
};

class ProtocolTestDriver;
using ProtocolTestDriverType = ddk::Device<ProtocolTestDriver, ddk::Messageable>;
class ProtocolTestDriver : public ProtocolTestDriverType, public TestObserver {
 public:
  // A singleton instance is used so that the test fixture has no issues working
  // with the PCI protocol.
  static zx_status_t Create(zx_device_t* parent) {
    instance_ = new ProtocolTestDriver(parent);
    if (!instance_->pci().is_valid()) {
      return ZX_ERR_INTERNAL;
    }

    return instance_->DdkAdd(kProtocolTestDriverName);
  }

  static ProtocolTestDriver* GetInstance() { return instance_; }
  const ddk::PciProtocolClient& pci() { return pci_; }

  zx_status_t DdkMessage(fidl_incoming_msg_t* msg, fidl_txn_t* txn);
  void DdkRelease() { delete this; }

 private:
  ProtocolTestDriver(zx_device_t* parent) : ProtocolTestDriverType(parent), pci_(parent) {}

  static ProtocolTestDriver* instance_;
  ddk::PciProtocolClient pci_;
};

class PciProtocolTests : public zxtest::Test {
 public:
  const ddk::PciProtocolClient& pci() { return drv_->pci(); }

 protected:
  PciProtocolTests() : drv_(ProtocolTestDriver::GetInstance()) {}

  ProtocolTestDriver* drv_;
};

#endif  // SRC_DEVICES_BUS_DRIVERS_PCI_TEST_DRIVER_PROTOCOL_TEST_DRIVER_H_