Class vitisHls

constructor

• new vitisHls(topFunction, clock?, platform?, disableWeaving?): vitisHls

• Parameters

  • topFunction: string
  • clock: number = 10
  • platform: string = "xcvu5p-flva2104-1-e"
  • disableWeaving: boolean = false

  Returns vitisHls

clock

flowTarget

platform

sourceFiles

topFunction

vitisDir

vitisProjName

addSource

• addSource(file): vitisHls

• Parameters

  • file: string

  Returns vitisHls

clean

• clean(): void

• Returns void

getSynthesisReport

• getSynthesisReport(): {
      availBRAM: number;
      availDSP: number;
      availFF: number;
      availLUT: number;
      BRAM: number;
      clockEstim: number;
      clockTarget: number;
      DSP: number;
      execTimeAvg: number;
      execTimeBest: number;
      execTimeWorst: number;
      FF: number;
      fmax: number;
      hasFixedLatency: boolean;
      latencyAvg: number;
      latencyBest: number;
      latencyWorst: number;
      LUT: number;
      perBRAM: number;
      perDSP: number;
      perFF: number;
      perLUT: number;
      platform: string;
      topFun: string;
  }

• Returns {
      availBRAM: number;
      availDSP: number;
      availFF: number;
      availLUT: number;
      BRAM: number;
      clockEstim: number;
      clockTarget: number;
      DSP: number;
      execTimeAvg: number;
      execTimeBest: number;
      execTimeWorst: number;
      FF: number;
      fmax: number;
      hasFixedLatency: boolean;
      latencyAvg: number;
      latencyBest: number;
      latencyWorst: number;
      LUT: number;
      perBRAM: number;
      perDSP: number;
      perFF: number;
      perLUT: number;
      platform: string;
      topFun: string;
  }

  • availBRAM: number

  • availDSP: number

  • availFF: number

  • availLUT: number

  • BRAM: number

  • clockEstim: number

  • clockTarget: number

  • DSP: number

  • execTimeAvg: number

  • execTimeBest: number

  • execTimeWorst: number

  • FF: number

  • fmax: number

  • hasFixedLatency: boolean

  • latencyAvg: number

  • latencyBest: number

  • latencyWorst: number

  • LUT: number

  • perBRAM: number

  • perDSP: number

  • perFF: number

  • perLUT: number

  • platform: string

  • topFun: string

preciseStr

• preciseStr(n, decimalPlaces?): string

• Parameters

  • n: number
  • OptionaldecimalPlaces: number

  Returns string

prettyPrintReport

• prettyPrintReport(report): void

• Parameters

  • report: {
        availBRAM: number;
        availDSP: number;
        availFF: number;
        availLUT: number;
        BRAM: number;
        clockEstim: number;
        clockTarget: number;
        DSP: number;
        execTimeAvg: number;
        execTimeBest: number;
        execTimeWorst: number;
        FF: number;
        fmax: number;
        hasFixedLatency: boolean;
        latencyAvg: number;
        latencyBest: number;
        latencyWorst: number;
        LUT: number;
        perBRAM: number;
        perDSP: number;
        perFF: number;
        perLUT: number;
        platform: string;
        topFun: string;
    }

    • availBRAM: number

    • availDSP: number

    • availFF: number

    • availLUT: number

    • BRAM: number

    • clockEstim: number

    • clockTarget: number

    • DSP: number

    • execTimeAvg: number

    • execTimeBest: number

    • execTimeWorst: number

    • FF: number

    • fmax: number

    • hasFixedLatency: boolean

    • latencyAvg: number

    • latencyBest: number

    • latencyWorst: number

    • LUT: number

    • perBRAM: number

    • perDSP: number

    • perFF: number

    • perLUT: number

    • platform: string

    • topFun: string

  Returns void

setClock

• setClock(clock): vitisHls

• Parameters

  • clock: number

  Returns vitisHls

setFlowTarget

• setFlowTarget(target): vitisHls

• Parameters

  • target: "vitis" | "vivado"

  Returns vitisHls

setPlatform

• setPlatform(platform): vitisHls

• Parameters

  • platform: string

  Returns vitisHls

setTopFunction

• setTopFunction(topFunction): vitisHls

• Parameters

  • topFunction: string

  Returns vitisHls

synthesize

• synthesize(verbose?): boolean

• Parameters

  • verbose: boolean = true

  Returns boolean