Interface IFPGADataPortAXILite

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

Single-register methods (read/write) operate on one 32-bit register. Bulk methods (readBulk/writeBulk) operate on multiple consecutive 32-bit registers using Uint32Array buffers.

interface IFPGADataPortAXILite {
    read(address: number | bigint): Promise<number>;
    read(
        address: number | bigint,
        timeoutMilliseconds: number,
    ): Promise<number>;
    readBulk(address: number | bigint, buffer: Uint32Array): Promise<number>;
    readBulk(
        address: number | bigint,
        buffer: Uint32Array,
        timeoutMilliseconds: number,
    ): Promise<number>;
    reset(): Promise<void>;
    write(address: number | bigint, data: number): Promise<void>;
    write(
        address: number | bigint,
        data: number,
        timeoutMilliseconds: number,
    ): Promise<void>;
    writeBulk(
        address: number | bigint,
        data: Uint32Array,
    ): Promise<AXIOperationStatistics>;
    writeBulk(
        address: number | bigint,
        data: Uint32Array,
        timeoutMilliseconds: number,
    ): Promise<AXIOperationStatistics>;
}

Index

Methods

read readBulk reset write writeBulk

Methods

read

read(address: number | bigint): Promise<number>
Reads a single 32-bit register value with default timeout (10000ms).
Parameters
- address: number | bigint
  The register address.
Returns Promise<number>
- The 32-bit register value.
read(address: number | bigint, timeoutMilliseconds: number): Promise<number>
Reads a single 32-bit register value with explicit timeout.
Parameters
- address: number | bigint
  The register address.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<number>
- The 32-bit register value.

readBulk

readBulk(address: number | bigint, buffer: Uint32Array): Promise<number>
Reads multiple consecutive 32-bit registers with default timeout (10000ms).
Parameters
- address: number | bigint
  The starting register address.
- buffer: Uint32Array
  The buffer to fill with register values.
Returns Promise<number>
- The number of bytes transferred.
readBulk(
    address: number | bigint,
    buffer: Uint32Array,
    timeoutMilliseconds: number,
): Promise<number>
Reads multiple consecutive 32-bit registers with explicit timeout.
Parameters
- address: number | bigint
  The starting register address.
- buffer: Uint32Array
  The buffer to fill with register values.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<number>
- The number of bytes transferred.

reset

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

Returns Promise<void>

write

write(address: number | bigint, data: number): Promise<void>
Writes a single 32-bit register value with default timeout (10000ms).
Parameters
- address: number | bigint
  The register address.
- data: number
  The 32-bit value to write.
Returns Promise<void>
write(
    address: number | bigint,
    data: number,
    timeoutMilliseconds: number,
): Promise<void>
Writes a single 32-bit register value with explicit timeout.
Parameters
- address: number | bigint
  The register address.
- data: number
  The 32-bit value to write.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<void>

writeBulk

writeBulk(
address: number | bigint,
data: Uint32Array,
): Promise<AXIOperationStatistics>
Writes multiple consecutive 32-bit registers with default timeout (10000ms).
Parameters
- address: number | bigint
  The starting register address.
- data: Uint32Array
  The register values to write.
Returns Promise<AXIOperationStatistics>
- Transfer and transaction counts.
writeBulk(
    address: number | bigint,
    data: Uint32Array,
    timeoutMilliseconds: number,
): Promise<AXIOperationStatistics>
Writes multiple consecutive 32-bit registers with explicit timeout.
Parameters
- address: number | bigint
  The starting register address.
- data: Uint32Array
  The register values to write.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<AXIOperationStatistics>
- Transfer and transaction counts.

Interface IFPGADataPortAXILite

Index

Methods

Methods

read

Parameters

Returns Promise<number>

Parameters

Returns Promise<number>

readBulk

Parameters

Returns Promise<number>

Parameters

Returns Promise<number>

reset

Returns Promise<void>

write

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

writeBulk

Parameters

Returns Promise<AXIOperationStatistics>

Parameters

Returns Promise<AXIOperationStatistics>

Settings

On This Page