docs: Update HAL API documentation - remove legacy API docs

docs/po4a.cfg

@@ -252,23 +252,43 @@
 [type: AsciiDoc_def] src/man/man1/xyzac-trt-gui.1.adoc $lang:build/adoc/$lang/man/man1/xyzac-trt-gui.1.adoc
 [type: AsciiDoc_def] src/man/man1/xyzbc-trt-gui.1.adoc $lang:build/adoc/$lang/man/man1/xyzbc-trt-gui.1.adoc
 [type: AsciiDoc_def] src/man/man3/PM_ROTATION_VECTOR.3.adoc $lang:build/adoc/$lang/man/man3/PM_ROTATION_VECTOR.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal.3.adoc $lang:build/adoc/$lang/man/man3/hal.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_add_funct_to_thread.3.adoc $lang:build/adoc/$lang/man/man3/hal_add_funct_to_thread.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_comp_by_name.3.adoc $lang:build/adoc/$lang/man/man3/hal_comp_by_name.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_create_thread.3.adoc $lang:build/adoc/$lang/man/man3/hal_create_thread.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_exit.3.adoc $lang:build/adoc/$lang/man/man3/hal_exit.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_export_funct.3.adoc $lang:build/adoc/$lang/man/man3/hal_export_funct.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_get_p.3.adoc $lang:build/adoc/$lang/man/man3/hal_get_p.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_get_realtime_type.3.adoc $lang:build/adoc/$lang/man/man3/hal_get_realtime_type.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_get_s.3.adoc $lang:build/adoc/$lang/man/man3/hal_get_s.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_getter.3.adoc $lang:build/adoc/$lang/man/man3/hal_getter.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_init.3.adoc $lang:build/adoc/$lang/man/man3/hal_init.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_init_funct_to_thread.3.adoc $lang:build/adoc/$lang/man/man3/hal_init_funct_to_thread.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_comp.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_comp.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_funct.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_funct.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_p.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_p.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_p_s.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_p_s.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_s.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_s.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_list_thread.3.adoc $lang:build/adoc/$lang/man/man3/hal_list_thread.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_malloc.3.adoc $lang:build/adoc/$lang/man/man3/hal_malloc.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_param_alias.3.adoc $lang:build/adoc/$lang/man/man3/hal_param_alias.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_param_new.3.adoc $lang:build/adoc/$lang/man/man3/hal_param_new.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_parport.3.adoc $lang:build/adoc/$lang/man/man3/hal_parport.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_pdir_t.3.adoc $lang:build/adoc/$lang/man/man3/hal_pdir_t.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_pin_alias.3.adoc $lang:build/adoc/$lang/man/man3/hal_pin_alias.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_pin_new.3.adoc $lang:build/adoc/$lang/man/man3/hal_pin_new.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_port.3.adoc $lang:build/adoc/$lang/man/man3/hal_port.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_query_t.3.adoc $lang:build/adoc/$lang/man/man3/hal_query_t.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_ready.3.adoc $lang:build/adoc/$lang/man/man3/hal_ready.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_refs_u.3.adoc $lang:build/adoc/$lang/man/man3/hal_refs_u.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_set_constructor.3.adoc $lang:build/adoc/$lang/man/man3/hal_set_constructor.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_set_lock.3.adoc $lang:build/adoc/$lang/man/man3/hal_set_lock.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_set_p.3.adoc $lang:build/adoc/$lang/man/man3/hal_set_p.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_set_s.3.adoc $lang:build/adoc/$lang/man/man3/hal_set_s.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_setter.3.adoc $lang:build/adoc/$lang/man/man3/hal_setter.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_signal_new.3.adoc $lang:build/adoc/$lang/man/man3/hal_signal_new.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_start_threads.3.adoc $lang:build/adoc/$lang/man/man3/hal_start_threads.3.adoc
+[type: AsciiDoc_def] src/man/man3/hal_statistics.3.adoc $lang:build/adoc/$lang/man/man3/hal_statistics.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_stream.3.adoc $lang:build/adoc/$lang/man/man3/hal_stream.3.adoc
 [type: AsciiDoc_def] src/man/man3/hal_type_t.3.adoc $lang:build/adoc/$lang/man/man3/hal_type_t.3.adoc
 [type: AsciiDoc_def] src/man/man3/hm2_allocate_bspi_tram.3.adoc $lang:build/adoc/$lang/man/man3/hm2_allocate_bspi_tram.3.adoc
@@ -283,7 +303,6 @@
 [type: AsciiDoc_def] src/man/man3/hm2_uart_read.3.adoc $lang:build/adoc/$lang/man/man3/hm2_uart_read.3.adoc
 [type: AsciiDoc_def] src/man/man3/hm2_uart_send.3.adoc $lang:build/adoc/$lang/man/man3/hm2_uart_send.3.adoc
 [type: AsciiDoc_def] src/man/man3/hm2_uart_setup.3.adoc $lang:build/adoc/$lang/man/man3/hm2_uart_setup.3.adoc
-[type: AsciiDoc_def] src/man/man3/hal.3.adoc $lang:build/adoc/$lang/man/man3/hal.3.adoc
 [type: AsciiDoc_def] src/man/man3/rtapi.3.adoc $lang:build/adoc/$lang/man/man3/rtapi.3.adoc
 [type: AsciiDoc_def] src/man/man3/rtapi_app_exit.3.adoc $lang:build/adoc/$lang/man/man3/rtapi_app_exit.3.adoc
 [type: AsciiDoc_def] src/man/man3/rtapi_app_main.3.adoc $lang:build/adoc/$lang/man/man3/rtapi_app_main.3.adoc

docs/src/hal/components.adoc

@@ -448,104 +448,168 @@ Limit its slew rate to less than maxv per second. Limit its second derivative to
 include::components_gen.adoc[]
 
 == HAL API calls
-....
-hal_add_funct_to_thread.3
-hal_bit_t.3
-hal_create_thread.3
-hal_del_funct_from_thread.3
-hal_exit.3
-hal_export_funct.3
-hal_export_functf.3
-hal_float_t.3
-hal_get_lock.3
-hal_init.3
-hal_link.3
-hal_malloc.3
-hal_param_bit_new.3
-hal_param_bit_newf.3
-hal_param_float_new.3
-hal_param_float_newf.3
-hal_param_new.3
-hal_param_s32_new.3
-hal_param_s32_newf.3
-hal_param_u32_new.3
-hal_param_u32_newf.3
-hal_parport.3
-hal_pin_bit_new.3
-hal_pin_bit_newf.3
-hal_pin_float_new.3
-hal_pin_float_newf.3
-hal_pin_new.3
-hal_pin_s32_new.3
-hal_pin_s32_newf.3
-hal_pin_u32_new.3
-hal_pin_u32_newf.3
-hal_ready.3
-hal_s32_t.3
-hal_set_constructor.3
-hal_set_lock.3
-hal_signal_delete.3
-hal_signal_new.3
-hal_start_threads.3
-hal_type_t.3
-hal_u32_t.3
-hal_unlink.3
-hal.3
-....
+
+* hal(3)
+* hal_add_funct_to_thread(3)
+* hal_bool_t(3)
+* hal_comp_by_id(3)
+* hal_comp_by_name(3)
+* hal_create_thread(3)
+* hal_del_funct_from_thread(3)
+* hal_exit(3)
+* hal_export_funct(3)
+* hal_export_functf(3)
+* hal_get_bool(3)
+* hal_get_lock(3)
+* hal_get_p(3)
+* hal_get_real(3)
+* hal_get_realtime_type(3)
+* hal_getref_p(3)
+* hal_getref_s(3)
+* hal_get_s(3)
+* hal_get_si32(3)
+* hal_get_si32_clamped(3)
+* hal_get_sint(3)
+* hal_getter(3)
+* hal_get_ui32(3)
+* hal_get_ui32_clamped(3)
+* hal_get_uint(3)
+* hal_init(3)
+* hal_init_funct_to_thread(3)
+* hal_link(3)
+* hal_list_comp(3)
+* hal_list_funct(3)
+* hal_list_p(3)
+* hal_list_p_s(3)
+* hal_list_s(3)
+* hal_list_thread(3)
+* hal_malloc(3)
+* hal_param_alias(3)
+* hal_param_new(3)
+* hal_param_new_bool(3)
+* hal_param_new_fake(3)
+* hal_param_new_real(3)
+* hal_param_new_sint(3)
+* hal_param_new_uint(3)
+* hal_parport(3)
+* hal_pdir_t(3)
+* hal_pin_alias(3)
+* hal_pin_new(3)
+* hal_pin_new_bool(3)
+* hal_pin_new_port(3)
+* hal_pin_new_real(3)
+* hal_pin_new_sint(3)
+* hal_pin_new_uint(3)
+* hal_port(3)
+* hal_port_buffer_size(3)
+* hal_port_clear(3)
+* hal_port_peek(3)
+* hal_port_peek_commit(3)
+* hal_port_read(3)
+* hal_port_readable(3)
+* hal_port_t(3)
+* hal_port_writable(3)
+* hal_port_write(3)
+* hal_query_t(3)
+* hal_ready(3)
+* hal_real_t(3)
+* hal_refs_u(3)
+* hal_set_bool(3)
+* hal_set_constructor(3)
+* hal_set_lock(3)
+* hal_set_p(3)
+* hal_set_real(3)
+* hal_set_s(3)
+* hal_set_si32(3)
+* hal_set_sint(3)
+* hal_setter(3)
+* hal_set_ui32(3)
+* hal_set_uint(3)
+* hal_signal_delete(3)
+* hal_signal_new(3)
+* hal_sint_t(3)
+* hal_start_threads(3)
+* hal_statistics(3)
+* hal_stream(3)
+* hal_type_t(3)
+* hal_uint_t(3)
+* hal_unlink(3)
+* hal_unready(3)
 
 == RTAPI calls
-....
-EXPORT_FUNCTION.3
-MODULE_AUTHOR.3
-MODULE_DESCRIPTION.3
-MODULE_LICENSE.3
-RTAPI_MP_ARRAY_INT.3
-RTAPI_MP_ARRAY_LONG.3
-RTAPI_MP_ARRAY_STRING.3
-RTAPI_MP_INT.3
-RTAPI_MP_LONG.3
-RTAPI_MP_STRING.3
-rtapi.3
-rtapi_app_exit.3
-rtapi_app_main.3
-rtapi_clock_set_period.3
-rtapi_delay.3
-rtapi_delay_max.3
-rtapi_exit.3
-rtapi_get_msg_level.3
-rtapi_get_time.3
-rtapi_inb.3
-rtapi_init.3
-rtapi_module_param.3
-RTAPI_MP_ARRAY_INT.3
-RTAPI_MP_ARRAY_LONG.3
-RTAPI_MP_ARRAY_STRING.3
-RTAPI_MP_INT.3
-RTAPI_MP_LONG.3
-RTAPI_MP_STRING.3
-rtapi_mutex.3
-rtapi_outb.3
-rtapi_print.3
-rtapi_prio.3
-rtapi_prio_highest.3
-rtapi_prio_lowest.3
-rtapi_prio_next_higher.3
-rtapi_prio_next_lower.3
-rtapi_region.3
-rtapi_release_region.3
-rtapi_request_region.3
-rtapi_set_msg_level.3
-rtapi_shmem.3
-rtapi_shmem_delete.3
-rtapi_shmem_getptr.3
-rtapi_shmem_new.3
-rtapi_snprintf.3
-rtapi_task_delete.3
-rtapi_task_new.3
-rtapi_task_pause.3
-rtapi_task_resume.3
-rtapi_task_start.3
-rtapi_task_wait.3
-....
+
+Helpers:
+
+* EXPORT_FUNCTION(3)
+* MODULE_AUTHOR(3)
+* MODULE_DESCRIPTION(3)
+* MODULE_LICENSE(3)
+* RTAPI_MP_ARRAY_INT(3)
+* RTAPI_MP_ARRAY_LONG(3)
+* RTAPI_MP_ARRAY_STRING(3)
+* RTAPI_MP_INT(3)
+* RTAPI_MP_LONG(3)
+* RTAPI_MP_STRING(3)
+
+API calls:
+
+* rtapi(3)
+* rtapi_app_exit(3)
+* rtapi_app_main(3)
+* rtapi_atomic(3)
+* rtapi_bool(3)
+* rtapi_byteorder(3)
+* rtapi_clock_set_period(3)
+* rtapi_delay(3)
+* rtapi_delay_max(3)
+* rtapi_device(3)
+* rtapi_div_s64(3)
+* rtapi_div_s64_rem(3)
+* rtapi_div_u64(3)
+* rtapi_div_u64_rem(3)
+* rtapi_exit(3)
+* rtapi_firmware(3)
+* rtapi_get_msg_level(3)
+* rtapi_get_time(3)
+* rtapi_gfp(3)
+* rtapi_inb(3)
+* rtapi_init(3)
+* rtapi_io(3)
+* rtapi_is(3)
+* rtapi_list(3)
+* rtapi_module_param(3)
+* rtapi_mutex(3)
+* rtapi_open_as_root(3)
+* rtapi_outb(3)
+* rtapi_parport(3)
+* rtapi_pci(3)
+* rtapi_print(3)
+* rtapi_print_msg(3)
+* rtapi_prio(3)
+* rtapi_prio_highest(3)
+* rtapi_prio_lowest(3)
+* rtapi_prio_next_higher(3)
+* rtapi_prio_next_lower(3)
+* rtapi_region(3)
+* rtapi_release_region(3)
+* rtapi_request_region(3)
+* rtapi_set_msg_level(3)
+* rtapi_shmem(3)
+* rtapi_shmem_delete(3)
+* rtapi_shmem_getptr(3)
+* rtapi_shmem_new(3)
+* rtapi_slab(3)
+* rtapi_snprintf(3)
+* rtapi_stdint(3)
+* rtapi_string(3)
+* rtapi_strlcpy(3)
+* rtapi_task_delete(3)
+* rtapi_task_new(3)
+* rtapi_task_pause(3)
+* rtapi_task_resume(3)
+* rtapi_task_self(3)
+* rtapi_task_start(3)
+* rtapi_task_wait(3)
+* rtapi_vsnprintf(3)
 
 // vim: set syntax=asciidoc: