hal_init(3hal)

hal_init3hal

Sets up hal and rtapi

Usage

int hal_init(const char *modname)

Arguments

modname

The name of this HAL module

Overview

hal_init sets up HAL and RTAPI. It must be called by any module that intends to use the API, before any other RTAPI calls.

modname must point to a string that identifies the module. The string may be no longer than HAL_NAME_LEN characters.

Realtime considerations

Call only from within non-realtime or init/cleanup code, not from realtime tasks.

Return value

On success, returns a positive integer module ID, which is used for subsequent calls to HAL and rtapi APIs. On failure, returns a HAL error code.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

From linuxcnc-uspace-dev 1:2.9.4-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.