src/virtualization/bin/vmm/device/guest_ethernet.h

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

#ifndef SRC_VIRTUALIZATION_BIN_VMM_DEVICE_GUEST_ETHERNET_H_
#define SRC_VIRTUALIZATION_BIN_VMM_DEVICE_GUEST_ETHERNET_H_

#include <fuchsia/hardware/ethernet/cpp/fidl.h>
#include <lib/async/cpp/wait.h>
#include <lib/fit/function.h>
#include <zircon/device/ethernet.h>

// Interface for GuestEthernet to send a packet to the guest.
struct GuestEthernetDevice {
  virtual void Receive(uintptr_t addr, size_t length, const eth_fifo_entry_t& entry) = 0;
  virtual void ReadyToSend() = 0;
  virtual fuchsia::hardware::ethernet::MacAddress GetMacAddress() = 0;
};

class GuestEthernet : public fuchsia::hardware::ethernet::Device {
 public:
  using QueueTxFn =
      fit::function<zx_status_t(uintptr_t addr, size_t length, const eth_fifo_entry_t& entry)>;

  explicit GuestEthernet(GuestEthernetDevice* device)
      : tx_fifo_wait_(this), rx_fifo_wait_(this), device_(device) {}

  // Interface for the virtio-net device to send a received packet to the host
  // netstack.
  zx_status_t Send(void* offset, size_t length);

  // Interface for the virtio-net device to inform the netstack that a packet
  // has finished being transmitted.
  void Complete(const eth_fifo_entry_t& entry);

  void OnTxFifoReadable(async_dispatcher_t* dispatcher, async::WaitBase* wait, zx_status_t status,
                        const zx_packet_signal_t* signal);

  void OnRxFifoReadable(async_dispatcher_t* dispatcher, async::WaitBase* wait, zx_status_t status,
                        const zx_packet_signal_t* signal);

  // |fuchsia::hardware::ethernet::Device|
  void GetInfo(GetInfoCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void GetFifos(GetFifosCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void SetIOBuffer(zx::vmo h, SetIOBufferCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void Start(StartCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void Stop(StopCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ListenStart(ListenStartCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ListenStop(ListenStopCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void SetClientName(std::string name, SetClientNameCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void GetStatus(GetStatusCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void SetPromiscuousMode(bool enabled, SetPromiscuousModeCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ConfigMulticastAddMac(fuchsia::hardware::ethernet::MacAddress addr,
                             ConfigMulticastAddMacCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ConfigMulticastDeleteMac(fuchsia::hardware::ethernet::MacAddress addr,
                                ConfigMulticastDeleteMacCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ConfigMulticastSetPromiscuousMode(
      bool enabled, ConfigMulticastSetPromiscuousModeCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void ConfigMulticastTestFilter(ConfigMulticastTestFilterCallback callback) override;

  // |fuchsia::hardware::ethernet::Device|
  void DumpRegisters(DumpRegistersCallback callback) override;

 private:
  static constexpr uint16_t kVirtioNetQueueSize = 256;
  zx::fifo tx_fifo_;
  zx::fifo rx_fifo_;

  zx::vmo io_vmo_;
  uintptr_t io_addr_;
  size_t io_size_;

  std::vector<eth_fifo_entry_t> rx_entries_ = std::vector<eth_fifo_entry_t>(kVirtioNetQueueSize);
  size_t rx_entries_count_ = 0;

  async::WaitMethod<GuestEthernet, &GuestEthernet::OnTxFifoReadable> tx_fifo_wait_;
  async::WaitMethod<GuestEthernet, &GuestEthernet::OnRxFifoReadable> rx_fifo_wait_;

  GuestEthernetDevice* device_;
};

#endif  // SRC_VIRTUALIZATION_BIN_VMM_DEVICE_GUEST_ETHERNET_H_