Enumerations

enum DvfsMode

enum class DvfsMode : int {
  kPerformance = 0,
  kOnDemand = 1,
};

enum class tcim::dev_ctrl::DvfsMode : int

Enumerated type indicating the DVFS (Dynamic Voltage and Frequency Scaling) mode used for the specified Houmo logical device.

DVFS controls the operating frequency of IPU cores to balance performance and power consumption.

Not all backends support the DVFS function. The unsupported operations return Status::UNSUPPORTED.

Values:

enumerator kPerformance = 0

IPU cores always run at maximum frequency. This is the default mode.

enumerator kOnDemand = 1

IPU core frequency is dynamically adjusted based on real-time utilization within the device's supported frequency range.

enum Status

enum Status : int {
  ERR_UNDEFINED = -1,
  OK = 0,
  UNINITIALIZED = 1,
  OUT_OF_RANGE = 2,
  UNSUPPORTED = 3,
  INVALID_ARGUMENT = 4,
  ALREADY_EXISTS = 5,
  PERMISSION_DENIED = 6,
  UNAVAILABLE = 7,
  UNAUTHENTICATED = 8,
  RESOURCE_EXHAUSTED = 9,
  TIMEOUT = 10,
  ERR_KERNEL = 11,
  ERR_FATAL = 12,
  SESSION_EXPIRED = 13,
  RECOVERING = 14,
};

enum tcim::Status

The return status of the functions.

Values:

enumerator ERR_UNDEFINED = -1

An undefined or unknown internal error has occurred.

enumerator OK = 0

This function returned with no errors.

enumerator UNINITIALIZED = 1

This object or the related resource is not initialized.

enumerator OUT_OF_RANGE = 2

The index or value passed to the function is out of range.

enumerator UNSUPPORTED = 3

This function is not yet supported.

enumerator INVALID_ARGUMENT = 4

One or more arguments passed to the function are invalid.

enumerator ALREADY_EXISTS = 5

This error occurs when attempting to create an item that already exists.

enumerator PERMISSION_DENIED = 6

Permission to perform the function denied.

enumerator UNAVAILABLE = 7

The requested service or resource is temporarily unavailable.

enumerator UNAUTHENTICATED = 8

Authentication is required to access the resource.

enumerator RESOURCE_EXHAUSTED = 9

This error occurs when the resource limit, such as memory or disk space, has been reached or exceeded. You can free up resources to accommodate the function.

enumerator TIMEOUT = 10

A timeout occurred while the function is waiting to be processed.

enumerator ERR_KERNEL = 11

Internal error.

enumerator ERR_FATAL = 12

A critical unrecoverable error occurred during model inference. The IPU core must be reset using the Houmo SMI Tool. See "Houmo SMI Tool User Guide" for details.

enumerator SESSION_EXPIRED = 13

The server session has expired, typically because the server restarted and its epoch has changed. All local handles (Models, Buffers, Streams) are stale and must be released before reconnecting.

enumerator RECOVERING = 14

The runtime is currently in a recovery/reset phase (between RpcServerResetBegin and RpcServerResetEnd). All regular operations are temporarily suspended. Retry after the reset completes.