From 259d5f8be21d62d46cc780a7da93d1de2f14929b Mon Sep 17 00:00:00 2001 From: Bertho Stultiens Date: Mon, 27 Jul 2026 17:06:44 +0200 Subject: [PATCH] hal: Several trivial man-page updates --- docs/src/man/man3/hm2_pktuart.3.adoc | 2 +- docs/src/man/man3/hm2_pktuart_read.3.adoc | 2 +- docs/src/man/man3/hm2_pktuart_send.3.adoc | 2 +- docs/src/man/man3/hm2_pktuart_setup.3.adoc | 2 +- docs/src/man/man3/rtapi_bool.3.adoc | 7 +++---- docs/src/man/man3/rtapi_stdint.3.adoc | 10 ++++++++++ 6 files changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/src/man/man3/hm2_pktuart.3.adoc b/docs/src/man/man3/hm2_pktuart.3.adoc index 489628c0a96..ce10b709dbc 100644 --- a/docs/src/man/man3/hm2_pktuart.3.adoc +++ b/docs/src/man/man3/hm2_pktuart.3.adoc @@ -176,7 +176,7 @@ I.e., the data is filled right-to-left and right-justified with consecutive pack Because the transactions are necessarily split over multiple reads, and some steps will have serial-port latency delays it is recommended to use a state machine in the realtime code where waiting on input is not possible. -[source, C] +[source,c] ---- int process(void *arg, long period) { static int state = START; diff --git a/docs/src/man/man3/hm2_pktuart_read.3.adoc b/docs/src/man/man3/hm2_pktuart_read.3.adoc index 0b629d44af5..3717c537a71 100644 --- a/docs/src/man/man3/hm2_pktuart_read.3.adoc +++ b/docs/src/man/man3/hm2_pktuart_read.3.adoc @@ -19,4 +19,4 @@ int hm2_pktuart_read(char* name, unsigned char data[], rtapi_u8* num_frames, DEPRECATED except in setup code. -Please see the combined document hm2_pktuart.3 +Please see the combined document hm2_pktuart(3) diff --git a/docs/src/man/man3/hm2_pktuart_send.3.adoc b/docs/src/man/man3/hm2_pktuart_send.3.adoc index 748bac7ef72..5ffa1680f7e 100644 --- a/docs/src/man/man3/hm2_pktuart_send.3.adoc +++ b/docs/src/man/man3/hm2_pktuart_send.3.adoc @@ -18,4 +18,4 @@ int hm2_uart_send(char* name, unsigned char data[], rtapi_u8* num_frames, *hm2_pktuart_send* writes "num_frames" of data to the PktUART "name" from the buffer "data" with frame sizes preset in "frame_sizes[]" array. -Please see the combined document hm2_pktuart.3 for how to use this function. +Please see the combined document hm2_pktuart(3) for how to use this function. diff --git a/docs/src/man/man3/hm2_pktuart_setup.3.adoc b/docs/src/man/man3/hm2_pktuart_setup.3.adoc index 1192e7cf289..7196b05a573 100644 --- a/docs/src/man/man3/hm2_pktuart_setup.3.adoc +++ b/docs/src/man/man3/hm2_pktuart_setup.3.adoc @@ -17,4 +17,4 @@ int hm2_pktuart_setup(char* name, int bitrate, rtapi_s32 tx_mode, *hm2_pktuart_setup* -Please see the combined document hm2_pktuart.3 for how to use this function. +Please see the combined document hm2_pktuart(3) for how to use this function. diff --git a/docs/src/man/man3/rtapi_bool.3.adoc b/docs/src/man/man3/rtapi_bool.3.adoc index 39d03115b1f..6133750e15e 100644 --- a/docs/src/man/man3/rtapi_bool.3.adoc +++ b/docs/src/man/man3/rtapi_bool.3.adoc @@ -9,6 +9,9 @@ rtapi_bool - RTAPI wrappers for linux kernel functionality [source,c] ---- #include + +// Specific abstraction for HAL +typedef bool rtapi_bool; ---- == DESCRIPTION @@ -19,7 +22,3 @@ to obtain suitable declarations of "bool", "true" and "false". == REALTIME CONSIDERATIONS None. - -== NOTES - -Also permitted in C++ programs, where including it has no effect. diff --git a/docs/src/man/man3/rtapi_stdint.3.adoc b/docs/src/man/man3/rtapi_stdint.3.adoc index f06791e7734..405a5690755 100644 --- a/docs/src/man/man3/rtapi_stdint.3.adoc +++ b/docs/src/man/man3/rtapi_stdint.3.adoc @@ -23,6 +23,16 @@ typedef ... rtapi_uintptr_t; #define RTAPI_INT__xx___MIN ... #define RTAPI_INT__xx___MAX ... #define RTAPI_UINT__xx___MAX ... + +// Specific abstractions for HAL +typedef ... rtapi_real; +typedef ... rtapi_sint; +typedef ... rtapi_uint; +typedef ... rtapi_port; + +#define RTAPI_SINT_MIN ... +#define RTAPI_SINT_MAX ... +#define RTAPI_UINT_MAX ... ---- == DESCRIPTION