FpgaManager_Config.h

#pragma once

// ================================================================================
// PUBLIC INCLUDES
// ================================================================================

#include "FpgaManager_Types.h"

#include <cstdio>
#include <string>
#include <ostream>
#include <iomanip>
#include <stdint.h>


// ================================================================================
// NAMESPACE
// ================================================================================

namespace enclustra {
namespace fpgamanager {
namespace config {

// ================================================================================
// TYPES
// ================================================================================

enum class Profile
{
  Unspecified,
  MaximumPerformance,
  MinimumResources,
};

enum class CallbackOperationMode_t
{
  Continuous = 0,
  Synchronous = 1,
};

enum class Fx3FifoMode_t
{
  Half_16bit = 0,
  Full_32bit = 1,
};

// ================================================================================
// PROPERTY
// ================================================================================

template<typename T>
struct Property
{
  Property()
    : _isprovisioned(false)
  {
  }

  explicit Property(const T& value)
    : _value(value)
    , _isprovisioned(true)
  {
  }

  Property& operator=(const T& value)
  {
    _value = value;
    _isprovisioned = true;
    return *this;
  }

  bool provisioned() const
  {
    return _isprovisioned;
  }

  const T& get() const
  {
    return _value;
  }

  void set(const T& value)
  {
    _value = value;
    _isprovisioned = true;
  }

private:
  T _value;
  bool _isprovisioned;
};

// ================================================================================
// SETTINGS
// ================================================================================

struct ConfigSettings
{
  Property<uint32_t> UniScpVendorId;
  Property<uint32_t> UniScpProductId;
  Property<unsigned> UniScpMaxPacketSize;
  Property<unsigned> UniScpMaxPendingPackets;
  Property<unsigned> UniScpUpPktRate;
  Property<types::Duration> UniScpKeepAliveTimeout;

  Property<unsigned> UniMmBufferDivider;

  Property<Fx3FifoMode_t> Fx3FifoMode;
  Property<unsigned> Fx3PacketSizeMultiplier;
  Property<unsigned> Fx3OpenTransfers;

  Property<CallbackOperationMode_t> CallbackOperationMode;

  static ConfigSettings From(types::ApiUrl::Protocol protocol, Profile profile);
};

// ================================================================================
// PREDEFINED
// ================================================================================

ConfigSettings UdpMaxPerformance();
ConfigSettings UdpMinResources();
ConfigSettings Fx3MaxPerformance();
ConfigSettings Fx3MinResources();
ConfigSettings FtdiMaxPerformance();
ConfigSettings FtdiMinResources();
ConfigSettings PCIeMaxPerformance();
ConfigSettings PCIeMinResources();

// ================================================================================
// TRAILER
// ================================================================================

}
}
}