Merge pull request #3885 from BsAtHome/fix_hal-streamer

hal: fix bugs in the hal-streamer interface and implementation

Author: andypugh

docs/src/man/man3/hal_stream.3.adoc

@@ -21,10 +21,10 @@ int hal_stream_maxdepth(hal_stream_t* stream);
 int hal_stream_num_underruns(hal_stream_t* stream);
 int hal_stream_num_overruns(hal_stream_t* stream);
 
-int hal_stream_read(hal_stream_t* stream, union hal_stream_data* buf, unsigned* sampleno);
+int hal_stream_read(hal_stream_t* stream, hal_stream_data_u *buf, unsigned* sampleno);
 bool hal_stream_readable(hal_stream_t* stream);
 
-int hal_stream_write(hal_stream_t* stream, union hal_stream_data* buf);
+int hal_stream_write(hal_stream_t* stream, hal_stream_data_u *buf);
 bool hal_stream_writable(hal_stream_t* stream);
 
 #ifdef ULAPI
@@ -115,16 +115,16 @@ depth::
   The number of samples that can be unread before any samples are lost
   (overrun)
 typestring::
-  A typestring is a case-insensitive string which consists of one or
-  more of the following type characters:
+  A typestring is limited to 20 characters. A typestring is a
+  case-insensitive string which consists of one or more of the
+  following type characters:
   +
-  [upperalpha, start=2]
-  . for bool / hal_bit_t
-  . for int32_t / hal_s32_t
-  . for uint32_t / hal_u32_t
-  . for real_t / hal_float_t
-  +
-  A typestring is limited to 16 characters.
+  * B for bool / hal_bit_t
+  * S for rtapi_s32 / hal_s32_t
+  * U for rtapi_u32 / hal_u32_t
+  * F for real_t / hal_float_t
+  * L for rtapi_s64 / hal_s64_t
+  * K for rtapi_u64 / hal_u64_t
 
 buf::
   A buffer big enough to hold all the data in one sample.

src/hal/hal.h

@@ -927,30 +927,32 @@ extern void hal_port_wait_writable(hal_port_t** port, unsigned count, sig_atomic
 #endif
 
 
-
-
-
-
-union hal_stream_data {
-    real_t f;
-    bool b;
-    int32_t s;
-    uint32_t u;
-};
-
-struct hal_stream_shm; // Forward declaration. Only relevant in hal_lib.c.
-typedef struct {
-    int comp_id, shmem_id;
-    struct hal_stream_shm *fifo;
-} hal_stream_t;
-
 /**
  * HAL streams are modeled after sampler/stream and will hopefully replace
  * the independent implementations there.
  *
  * There may only be one reader and one writer but this is not enforced
  */
 
+typedef union hal_stream_data {
+    real_t f;
+    bool b;
+    rtapi_s32 s;
+    rtapi_u32 u;
+    rtapi_s64 l;
+    rtapi_u64 k;
+} hal_stream_data_u;
+typedef hal_stream_data_u *hal_stream_data_ptr_u;
+
+struct __hal_stream_shm_t;  // Forward declaration. Only relevant in hal_lib.c.
+
+typedef struct __hal_stream_t {
+    int comp_id;
+    int shmem_id;
+    struct __hal_stream_shm_t *fifo;
+} hal_stream_t;
+typedef hal_stream_t *hal_stream_ptr_t;
+
 #define HAL_STREAM_MAX_PINS (21)
 /** create and attach a stream */
 extern int hal_stream_create(hal_stream_t *stream, int comp, int key, unsigned depth, const char *typestring);
@@ -967,7 +969,7 @@ extern int hal_stream_element_count(hal_stream_t *stream);
 extern hal_type_t hal_stream_element_type(hal_stream_t *stream, int idx);
 
 // only one reader and one writer is allowed.
-extern int hal_stream_read(hal_stream_t *stream, union hal_stream_data *buf, unsigned *sampleno);
+extern int hal_stream_read(hal_stream_t *stream, hal_stream_data_u *buf, unsigned *sampleno);
 extern bool hal_stream_readable(hal_stream_t *stream);
 extern int hal_stream_depth(hal_stream_t *stream);
 extern unsigned hal_stream_maxdepth(hal_stream_t *stream);
@@ -977,7 +979,7 @@ extern int hal_stream_num_overruns(hal_stream_t *stream);
 extern void hal_stream_wait_readable(hal_stream_t *stream, sig_atomic_t *stop);
 #endif
 
-extern int hal_stream_write(hal_stream_t *stream, union hal_stream_data *buf);
+extern int hal_stream_write(hal_stream_t *stream, hal_stream_data_u *buf);
 extern bool hal_stream_writable(hal_stream_t *stream);
 #ifdef ULAPI
 extern void hal_stream_wait_writable(hal_stream_t *stream, sig_atomic_t *stop);