Interface IFPGAConfiguration

Interface that provides the methods that may be used to configure the FPGA on a device.

interface IFPGAConfiguration {
    clearConfiguration(): Promise<void>;
    getInfo(): Promise<IDeviceFPGAInfo>;
    getResetProfile(method): Promise<IFrontPanelResetProfile>;
    loadConfigurationFromFile(filename, progressCallback?): Promise<void>;
    loadConfigurationFromFileWithReset(filename, resetProfile, progressCallback?): Promise<void>;
    loadConfigurationFromMemory(data, length, progressCallback?): Promise<void>;
    loadConfigurationFromMemoryWithReset(data, length, resetProfile, progressCallback?): Promise<void>;
    setResetProfile(method, resetProfile): Promise<void>;
}

Methods

clearConfiguration getInfo getResetProfile loadConfigurationFromFile loadConfigurationFromFileWithReset loadConfigurationFromMemory loadConfigurationFromMemoryWithReset setResetProfile

Methods

clearConfiguration

  • clearConfiguration(): Promise<void>

  • Clears the FPGA configuration.

    Returns Promise<void>

    • A promise that resolves when the configuration has been cleared.

getInfo

  • getInfo(): Promise<IDeviceFPGAInfo>

  • Retrieves the FPGA information.

    Returns Promise<IDeviceFPGAInfo>

    • Promise that resolves to a Device FPGA information interface.

getResetProfile

loadConfigurationFromFile

  • loadConfigurationFromFile(filename, progressCallback?): Promise<void>

  • Configures the FPGA with the specified data in file.

    Parameters

    • filename: string

      The full path to the file containing the configuration data.

    • Optional progressCallback: DataProgressCallback

      Optional callback that reports the progress of the configuration.

    Returns Promise<void>

    • A promise that resolves when the configuration is complete.

loadConfigurationFromFileWithReset

  • loadConfigurationFromFileWithReset(filename, resetProfile, progressCallback?): Promise<void>

  • Configures the FPGA with the specified data in file and a reset profile.

    Parameters

    • filename: string

      The full path to the file containing the configuration data.

    • resetProfile: IFrontPanelResetProfile

      Reset Profile to perform after configuration.

    • Optional progressCallback: DataProgressCallback

      Optional callback that reports the progress of the configuration.

    Returns Promise<void>

    • A promise that resolves when the configuration is complete.

loadConfigurationFromMemory

  • loadConfigurationFromMemory(data, length, progressCallback?): Promise<void>

  • Configures the FPGA with the specified data in memory.

    Parameters

    • data: ArrayBuffer

      The buffer containing the configuration data.

    • length: number

      The length of the configuration data in bytes.

    • Optional progressCallback: DataProgressCallback

      Optional callback that reports the progress of the configuration.

    Returns Promise<void>

    • A promise that resolves when the configuration is complete.

loadConfigurationFromMemoryWithReset

  • loadConfigurationFromMemoryWithReset(data, length, resetProfile, progressCallback?): Promise<void>

  • Configures the FPGA with the specified data in memory and a reset profile.

    Parameters

    • data: ArrayBuffer

      The buffer containing the configuration data.

    • length: number

      The length of the configuration data in bytes.

    • resetProfile: IFrontPanelResetProfile

      Reset Profile to perform after configuration.

    • Optional progressCallback: DataProgressCallback

      Optional callback that reports the progress of the configuration.

    Returns Promise<void>

    • A promise that resolves when the configuration is complete.

setResetProfile

  • setResetProfile(method, resetProfile): Promise<void>

  • Sets the FPGA Boot or JTAG Reset Profile.

    Parameters

    Returns Promise<void>

    • A promise that resolves when the reset profile is set.

Settings

Member Visibility

Theme

On This Page

clearConfigurationgetInfogetResetProfileloadConfigurationFromFileloadConfigurationFromFileWithResetloadConfigurationFromMemoryloadConfigurationFromMemoryWithResetsetResetProfile