const (
ReadOnly = iota
WriteOnly
ReadWrite
)
Constants for opening RAM on the FGPA
type Kernel struct {
// contains filtered or unexported fields
}
Type kernel is a a function that runs on an FGPA.
func (kernel *Kernel) Release()
Release a previously acquired Kernel
func (kernel *Kernel) Run(x, y, z uint)
Run will start execution of the Kernel with the number of dimensions. Most uses of this should be called as
kernel.Run(1,1,1)
func (kernel *Kernel) SetArg(index uint, val uint32)
SetArg passes the uint32 as an argument to the Kernel. The resulting type on the kernel will be a uint32.
func (kernel *Kernel) SetMemoryArg(index uint, mem *Memory)
SetMemoryArg passes the pointer to Memory as an argument to the Kernel. The resulting type on the kernel will be a uintptr.
type Memory struct {
// contains filtered or unexported fields
}
Type Memory represents a segment of RAM on the FGPA
func (mem *Memory) Free()
Free a previously allocated Memory.
func (mem *Memory) Reader() *MemoryReader
Reader constructs a one-time use reader for a Memory. This has the standard io.Reader interface. For example, to copy from the FPGA with the binary package:
var input [256]uint32 err := binary.Read(buff.Reader(), binary.LittleEndian, &input)
func (mem *Memory) Writer() *MemoryWriter
Writer constructs a one-time use writer for a Memory. This has the standard io.Writer interface. For example, to copy data to the FPGA with the binary package:
var input [256]uint32 err := binary.Write(buff.Writer(), binary.LittleEndian, &input)
type MemoryReader struct {
// contains filtered or unexported fields
}
Type MemoryReader is an io.Reader to RAM on the FPGA
func (reader *MemoryReader) Read(bytes []byte) (n int, err error)
type MemoryWriter struct {
// contains filtered or unexported fields
}
Type MemoryWriter is an io.Writer to RAM on the FPGA
func (writer *MemoryWriter) Write(bytes []byte) (n int, err error)
type Program struct {
// contains filtered or unexported fields
}
Type Program ways to lookup kernels
func (program *Program) GetKernel(kernelName string) *Kernel
GetKernel will return the specific Kernel from the Program. The input argument is the name of the Kernel in the Program (typically "reconfigure_io_sdaccel_builder_stub_0_1").
This needs to be released when done.
kernel := program.GetKernel("reconfigure_io_sdaccel_builder_stub_0_1")
defer kernel.Release()
func (program *Program) Release()
Release a previously acquired Program.
type World struct {
// contains filtered or unexported fields
}
Type World is an opaque structure that allows communication with FPGAs.
func NewWorld() World
NewWorld creates a new World. This needs to be released when done. This can be done using `defer`
world := xcl.NewWorld() defer world.Release()
func (world World) Import(program string) *Program
Import will search for an appropriate xclbin and load their contents, either in a simulator for hardware simulation, or onto an FPGA for actual hardware. The input argument is the name of the program from the build procedure (typically "kernel_test"). The returned value is the program used for interacting with the loaded xclbin.
This needs to be released when done. This can be done using defer.
program := world.Import("kernel_test")
defer program.Release()
func (world *World) Malloc(flags uint, size uint) *Memory
Malloc allocates a number of bytes on the FPGA. The resulting structure represents a pointer to Memory on the FGPA.
This needs to be freed when done.
buff := world.Malloc(xcl.WriteOnly, 512) defer buff.Free()
func (world *World) Release()
Release cleans up a previously created World.