Interface IFPGADataPortAXIFull

Interface that provides the methods that may be used to interact with a FrontPanel device using AXI-Full.

interface IFPGADataPortAXIFull {
    get datapathWidthByteCount(): number;
    read(address: number | bigint, buffer: DataBuffer): Promise<number>;
    read(
        address: number | bigint,
        buffer: DataBuffer,
        burst: number,
    ): Promise<number>;
    read(
        address: number | bigint,
        buffer: DataBuffer,
        burst: number,
        timeoutMilliseconds: number,
    ): Promise<number>;
    reset(): Promise<void>;
    write(
        address: number | bigint,
        data: DataBuffer,
    ): Promise<AXIOperationStatistics>;
    write(
        address: number | bigint,
        data: DataBuffer,
        burst: number,
    ): Promise<AXIOperationStatistics>;
    write(
        address: number | bigint,
        data: DataBuffer,
        burst: number,
        timeoutMilliseconds: number,
    ): Promise<AXIOperationStatistics>;
}

Index

Accessors

datapathWidthByteCount

Methods

read reset write

Accessors

datapathWidthByteCount

get datapathWidthByteCount(): number
Returns number

Methods

read

read(address: number | bigint, buffer: DataBuffer): Promise<number>
Reads data with default burst (16) and timeout (10000ms).
Parameters
- address: number | bigint
  The address of the endpoint.
- buffer: DataBuffer
  The buffer to store the data that is read. The buffer must not be modified or detached until the returned Promise settles.
Returns Promise<number>
read(
    address: number | bigint,
    buffer: DataBuffer,
    burst: number,
): Promise<number>
Reads data with explicit burst and default timeout (10000ms).
Parameters
- address: number | bigint
  The address of the endpoint.
- buffer: DataBuffer
  The buffer to store the data that is read.
- burst: number
  The burst length.
Returns Promise<number>
read(
    address: number | bigint,
    buffer: DataBuffer,
    burst: number,
    timeoutMilliseconds: number,
): Promise<number>
Reads data with explicit burst and timeout.
Parameters
- address: number | bigint
  The address of the endpoint.
- buffer: DataBuffer
  The buffer to store the data that is read.
- burst: number
  The burst length.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<number>

reset

reset(): Promise<void>
Resets the AXI-Full interface.

Returns Promise<void>

write

write(
address: number | bigint,
data: DataBuffer,
): Promise<AXIOperationStatistics>
Writes data with default burst (16) and timeout (10000ms).
Parameters
- address: number | bigint
  The address of the endpoint.
- data: DataBuffer
  The data to write. The buffer must not be modified or detached until the returned Promise settles.
Returns Promise<AXIOperationStatistics>
write(
    address: number | bigint,
    data: DataBuffer,
    burst: number,
): Promise<AXIOperationStatistics>
Writes data with explicit burst and default timeout (10000ms).
Parameters
- address: number | bigint
  The address of the endpoint.
- data: DataBuffer
  The data to write.
- burst: number
  The burst length.
Returns Promise<AXIOperationStatistics>
write(
    address: number | bigint,
    data: DataBuffer,
    burst: number,
    timeoutMilliseconds: number,
): Promise<AXIOperationStatistics>
Writes data with explicit burst and timeout.
Parameters
- address: number | bigint
  The address of the endpoint.
- data: DataBuffer
  The data to write.
- burst: number
  The burst length.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<AXIOperationStatistics>

Interface IFPGADataPortAXIFull

Index

Accessors

Methods

Accessors

datapathWidthByteCount

Returns number

Methods

read

Parameters

Returns Promise<number>

Parameters

Returns Promise<number>

Parameters

Returns Promise<number>

reset

Returns Promise<void>

write

Parameters

Returns Promise<AXIOperationStatistics>

Parameters

Returns Promise<AXIOperationStatistics>

Parameters

Returns Promise<AXIOperationStatistics>

Settings

On This Page