Hastlayer-SDK

using Hast.Transformer.SimpleMemory;
using Hast.Vitis.Interop.Enums;
using Hast.Vitis.Services;

namespace Hast.Vitis.Models;

/// <summary>
/// A configuration for the <see cref="OpenClCommunicationService"/>. The implementing class has sensible defaults that
/// should work out of the box, but if configuration is necessary, the appconfig.json file should be edited.
/// </summary>
/// <remarks>
/// <para>
/// An example for the appsettings file can be seen below or in the Hast.Samples.Consumer project. Everything omitted
/// will remain as default.
/// </para>
/// <code>
/// {
///   "HardwareGenerationConfiguration": {
///     "CustomConfiguration": {
///       "OpenClConfiguration": {
///         "BinaryFilePath": "HardwareFramework/rtl/xclbin/hastip.hw.xclbin",
///         "HeaderCellCount": 4
///       }
///     }
///   }
/// }
/// </code>
/// </remarks>
public interface IOpenClConfiguration
{
    /// <summary>
    /// Gets or sets a value indicating whether any <see cref="long"/> value in the header is considered big endian, if
    /// false then little endian.
    /// </summary>
    bool DeviceIsBigEndian { get; set; }

    /// <summary>
    /// Gets or sets the OpenCL <see cref="DeviceType"/>.
    /// </summary>
    DeviceTypes DeviceType { get; set; }

    /// <summary>
    /// Gets or sets the number of cells ( <see cref="SimpleMemory.MemoryCellSizeBytes"/> byte units) to be occupied in
    /// the <see cref="SimpleMemory"/> as <see cref="SimpleMemory.PrefixCellCount"/>.
    /// </summary>
    int HeaderCellCount { get; set; }

    /// <summary>
    /// Gets or sets the vendor name used in the device's hardware information detectable by OpenCL.
    /// </summary>
    string VendorName { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether the the binary is for real hardware or emulated.
    /// </summary>
    bool UseEmulation { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether cache (for accelerating access to the on-board DDR or HBM memory on the
    /// device) should be used. Default is <see langword="true"/>.
    /// </summary>
    bool UseCache { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether High Bandwidth Memory should be used when available in the device.
    /// Default is <see langword="true"/>.
    /// </summary>
    bool UseHbm { get; set; }
}