Edit on GitHub

Module _XRTInternal

All functions specified in this module are for internal usage and should in general not be called directly!

Index

References

XRT._XRTInternal.State — Type
mutable struct State

State is a singleton object that stores global parameters, like devices and emulation mode.

source
XRT._XRTInternal.XilinxDeviceArray — Type
struct XilinxDeviceArray

A XilinxDeviceArray behaves like a normal Julia Vector{XRT.XilinxDevice}. The difference is, that it always points to the first element, when emulation mode is set.

source
XRT._XRTInternal.get_info — Method
get_info(
    device::XRT.XRTWrap.Device,
    param::XRT.XRTWrap.DeviceInformationParameters.Type
) -> Any

Fetches the device information based on the given parameter. It returns a value of the corresponding type or nothing if the parameter is not available.

source
XRT._XRTInternal.get_info — Method
get_info(
    device::XRT.XilinxDevice,
    param::XRT.XRTWrap.DeviceInformationParameters.Type
) -> Any

Fetches the device information based on the given parameter.

source
XRT._XRTInternal.call_utility — Method
call_utility(
    args::AbstractString...;
    ignorestatus
) -> String

Function used to call an XRT command-line tool from Julia. It detects whether xrt_jll or a native installation is used.

source
XRT._XRTInternal.draw_box! — Method
draw_box!(
    graph::Matrix{Char},
    x::Int64,
    y::Int64,
    width::Int64,
    title::AbstractString,
    input::AbstractString
)

Internal function that draws a five rows high box with a title and an input string to given coordinates of a char matrix. The function throws an exception if the box does not fit the matrix. The output looks like following:

┌──────────────┐
│    title     │
│              │
│ input string │
└──────────────┘
source
XRT._XRTInternal.draw_kernel_cu_connection! — Method
draw_kernel_cu_connection!(
    graph::Matrix{Char},
    x::Int64,
    y::Int64,
    kernel_width::Int64,
    cu_connection_width::Int64,
    required_cu_height::Int64
) -> Union{Nothing, Char}

Internal function that draws connecting arrows from the kernel box to its corresponding cu boxes.

source

Prettyprinting

XRT._XRTInternal.convert_bytes — Method
convert_bytes(
    bytes::Union{AbstractString, Integer}
) -> String

This functions parses a (hexadecimal) string to an integer and transforms it to a human-readable format with Byte units.

julia> _XRTInternal._XRTInternal.convert_bytes("0x10000040")
"256 MB"
source
XRT._XRTInternal.highlight_offline_kwargs! — Method
highlight_offline_kwargs!(
    kwargs::Dict
) -> PrettyTables.TextFormat

Takes a dict of keyword arguments for the use with pretty_table function. Makes the table outline dotted and greys the complete table.

source
XRT._XRTInternal.transform_header — Method
transform_header(header::AbstractString) -> String

Takes a string or header obtained from JSON object that is in format "foo_bar". Transforms it to a string as "Foo Bar" and applies some hardcoded exceptions for units and abbreviations.

source