ioBuster framework v25.06.5 documentation

deviceManager

deviceManager

Collection of device management related functions

Methods

Disables PCIe link from the downstream port.

Enables PCIe link from the downstream port.

(static) getHardwareInfo() → {deviceManager.HardwareInfo}

Returns peripherals supported by the current tester

Returns:
Type
deviceManager.HardwareInfo

(static) getPortInfo() → {deviceManager.PortInfo}

Returns current port information

Returns:
Type
deviceManager.PortInfo

(static) getSupportedPeripherals() → {deviceManager.PeripheralsInfo}

Returns peripherals supported by the current tester

Returns:
Type
deviceManager.PeripheralsInfo

(static) loadNvmeDriver(forceUnloadopt)

Load NVMe Driver

Parameters:
Name Type Attributes Default Description
forceUnload Boolean <optional>
 false

Unloads NVMe driver if already loaded

(static) loadUioDriver(forceUnloadopt, optionsopt)

Load UIO driver

Parameters:
Name Type Attributes Default Description
forceUnload Boolean <optional>
 false

Unloads UIO driver if already loaded
options Object <optional>
Properties
Name Type Attributes Default Description
retry Boolean <optional>
 false
retryTimeoutMs Number <optional>
 30000

Type Definitions

HardwareInfo

Properties:
Name Type Description
platform String

Hardware platform name
Type:
  • Object

PeripheralsInfo

Properties:
Name Type Description
powerController PowerControllerInfo | null

Power controller information or null if not available
serialPort Array.<SerialPortInfo>

Array of serial port profiles
Type:
  • Object

PortInfo

Properties:
Name Type Description
parentBdf String

PCI BDF of the port
deviceBdf String

PCI BDF of the device attached to the port
node String

Numa node
primaryCore String

CPU ID assgined to the primary thread
secondaryCore String

CPU ID assigned to the secondary thread
driver String

Device driver loaded to this port
vendor String

PCI vendor name of the device attached to the port
product String

PCI device name of the device attached to the port
status String

PCI device status
Type:
  • Object

PowerControllerInfo

Properties:
Name Type Description
available boolean

Whether the power controller is available
manufacturer string

Manufacturer name (e.g., "qamaestro", "ardent")
source string

Source PMU module (e.g., "iobusterPmu", "ardentPmu")
options Object

Additional configuration options specific to the controller
Type:
  • Object

SerialPortInfo

Properties:
Name Type Description
id string

Unique identifier for the port (e.g., "debug0", "console0")
interface number

USB interface number
description string

Human-readable description
serial string

USB serial number
baudRate number

Default baud rate
Type:
  • Object