📦 linuxcnc-uspace-dev

116 pages

E

EXPORT_FUNCTION(3rtapi)Specifying module parameters✨

H

hal_add_funct_to_thread(3hal)cause a function to be executed at regular intervals✨
hal_bit_t(3hal)typedefs for HAL datatypes✨
hal_bool(3hal)typedefs for HAL datatypes✨
hal_create_thread(3hal)Create a HAL thread✨
hal_del_funct_from_thread(3hal)cause a function to be executed at regular intervals✨
hal_exit(3hal)Shut down HAL✨
hal_export_funct(3hal)create a realtime function callable from a thread✨
hal_float_t(3hal)typedefs for HAL datatypes✨
hal_get_lock(3hal)Set or get the HAL lock level✨
hal_init(3hal)Sets up HAL and RTAPI✨
hal_link(3hal)Manipulate HAL signals✨
hal_malloc(3hal)Allocate space in the HAL shared memory area✨
hal_param_alias(3hal)create an alternate name for a param✨
hal_param_bit_new(3hal)creates a HAL parameter✨
hal_param_bit_newf(3hal)creates a HAL parameter✨
hal_param_float_new(3hal)creates a HAL parameter✨
hal_param_float_newf(3hal)creates a HAL parameter✨
hal_param_new(3hal)creates a HAL parameter✨
hal_param_s32_new(3hal)creates a HAL parameter✨
hal_param_s32_newf(3hal)creates a HAL parameter✨
hal_param_u32_new(3hal)creates a HAL parameter✨
hal_param_u32_newf(3hal)creates a HAL parameter✨
hal_parport(3hal)portable access to PC-style parallel ports✨
hal_pin_alias(3hal)creates an alternate name for a pin✨
hal_pin_bit_new(3hal)creates a HAL pin✨
hal_pin_bit_newf(3hal)creates a HAL pin✨
hal_pin_float_new(3hal)creates a HAL pin✨
hal_pin_float_newf(3hal)creates a HAL pin✨
hal_pin_new(3hal)creates a HAL pin✨
hal_pin_port_new(3hal)creates a HAL pin✨
hal_pin_port_newf(3hal)creates a HAL pin✨
hal_pin_s32_new(3hal)creates a HAL pin✨
hal_pin_s32_newf(3hal)creates a HAL pin✨
hal_pin_u32_new(3hal)creates a HAL pin✨
hal_pin_u32_newf(3hal)creates a HAL pin✨
hal_port(3hal)a HAL pin type that acts as an asynchronous one way byte stream✨
hal_ready(3hal)indicates that this component is ready✨
hal_s32_t(3hal)typedefs for HAL datatypes✨
hal_set_constructor(3hal)sets the constructor function for this component✨
hal_set_lock(3hal)Set or get the HAL lock level✨
hal_signal_delete(3hal)Manipulate HAL signals✨
hal_signal_new(3hal)Manipulate HAL signals✨
hal_start_threads(3hal)Allow HAL threads to begin executing✨
hal_stream(3hal)non-blocking realtime streams✨
hal_type_t(3hal)typedefs for HAL datatypes✨
hal_u32_t(3hal)typedefs for HAL datatypes✨
hal_unlink(3hal)Manipulate HAL signals✨
halcompile(1)Build, compile and install LinuxCNC HAL components✨

I

intro(3hal)Introduction to the HAL API✨
intro(3rtapi)Introduction to the RTAPI API✨

M

MODULE_AUTHOR(3rtapi)Specifying module parameters✨
MODULE_DESCRIPTION(3rtapi)Specifying module parameters✨
MODULE_LICENSE(3rtapi)Specifying module parameters✨

R

rtapi_app_exit(3rtapi)User-provided function to shut down a component✨
rtapi_app_main(3rtapi)User-provided function to initialize a component✨
rtapi_atomic(3rtapi)subset of C11 <stdatomic.h>✨
rtapi_bool(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_byteorder(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_clock_set_period(3rtapi)set the basic time interval for realtime tasks✨
rtapi_delay(3rtapi)Busy-loop for short delays✨
rtapi_delay_max(3rtapi)Busy-loop for short delays✨
rtapi_device(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_div_u64(3rtapi)unsigned division of a 64-bit number by a 32-bit number✨
rtapi_div_u64_rem(3rtapi)unsigned division of a 64-bit number by a 32-bit number✨
rtapi_exit(3rtapi)Shut down RTAPI✨
rtapi_firmware(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_get_clocks(3rtapi)get the current time✨
rtapi_get_msg_level(3rtapi)Get or set the logging level✨
rtapi_get_time(3rtapi)get the current time✨
rtapi_gfp(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_inb(3rtapi)Perform hardware I/O✨
rtapi_init(3rtapi)Sets up RTAPI✨
rtapi_io(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_is(3rtapi)details of rtapi configuration✨
rtapi_list(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_module_param(3rtapi)Specifying module parameters✨
RTAPI_MP_ARRAY_INT(3rtapi)Specifying module parameters✨
RTAPI_MP_ARRAY_LONG(3rtapi)Specifying module parameters✨
RTAPI_MP_ARRAY_STRING(3rtapi)Specifying module parameters✨
RTAPI_MP_INT(3rtapi)Specifying module parameters✨
RTAPI_MP_LONG(3rtapi)Specifying module parameters✨
RTAPI_MP_STRING(3rtapi)Specifying module parameters✨
rtapi_mutex(3rtapi)Mutex-related functions✨
rtapi_open_as_root(3rtapi)Open a file with "root" privilege✨
rtapi_outb(3rtapi)Perform hardware I/O✨
rtapi_parport(3rtapi)portable access to PC-style parallel ports✨
rtapi_pci(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_print(3rtapi)print diagnostic messages✨
rtapi_prio(3rtapi)thread priority functions✨
rtapi_prio_highest(3rtapi)thread priority functions✨
rtapi_prio_lowest(3rtapi)thread priority functions✨
rtapi_prio_next_higher(3rtapi)thread priority functions✨
rtapi_prio_next_lower(3rtapi)thread priority functions✨
rtapi_region(3rtapi)functions to manage I/O memory regions✨
rtapi_release_region(3rtapi)functions to manage I/O memory regions✨
rtapi_request_region(3rtapi)functions to manage I/O memory regions✨
rtapi_set_msg_level(3rtapi)Get or set the logging level✨
rtapi_shmem(3rtapi)Functions for managing shared memory blocks✨
rtapi_shmem_delete(3rtapi)Functions for managing shared memory blocks✨
rtapi_shmem_getptr(3rtapi)Functions for managing shared memory blocks✨
rtapi_shmem_new(3rtapi)Functions for managing shared memory blocks✨
rtapi_slab(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_snprintf(3rtapi)Perform snprintf-like string formatting✨
rtapi_stdint(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_string(3rtapi)RTAPI wrappers for linux kernel functionality✨
rtapi_strlcpy(3rtapi)RTAPI string manipulation functions✨
rtapi_task_delete(3rtapi)create a realtime task✨
rtapi_task_new(3rtapi)create a realtime task✨
rtapi_task_pause(3rtapi)pause and resume real-time tasks✨
rtapi_task_resume(3rtapi)pause and resume real-time tasks✨
rtapi_task_self(3rtapi)Retrieve ID of current task✨
rtapi_task_start(3rtapi)start a realtime task in periodic mode✨
rtapi_task_wait(3rtapi)suspend execution of this periodic task✨

U

undocumented(3hal)undocumented functions in HAL✨
undocumented(3rtapi)undocumented functions in RTAPI✨