Added Configurable Queue Wait Time (#346)

Author: bjackson312006

threadX/inc/u_tx_queues.h

@@ -5,14 +5,13 @@
 #include "u_tx_debug.h"
 #include <stdint.h>
 
-/*
-*   Basically just a wrapper for ThreadX stuff. Lets you create/configure queues.
-*   
-*   Author: Blake Jackson
-*/
+// clang-format off
 
-/* Queue Config Macros */
-#define QUEUE_WAIT_TIME TX_NO_WAIT
+/*
+ *   Basically just a wrapper for ThreadX stuff. Lets you create/configure queues.
+ *
+ *   Author: Blake Jackson
+ */
 
 typedef struct {
 	/* PUBLIC: Queue Configuration Settings */
@@ -29,12 +28,32 @@ typedef struct {
 	size_t _words; /* Size of each queue message, in 32-bit words. */
 } queue_t;
 
-/* API */
+/**
+ * @brief Initializes a ThreadX queue configured in a 'queue_t' instance.
+ * 
+ * @param byte_pool Pointer to the ThreadX application byte pool.
+ * @param queue Pointer to the queue instance to initialize.
+ */
 uint8_t create_queue(TX_BYTE_POOL *byte_pool, queue_t *queue);
-uint8_t queue_send(queue_t *queue,
-		   void *message); // Sends a message to the specified queue.
-uint8_t
-queue_receive(queue_t *queue,
-	      void *message); // Receives a message from the specified queue
+
+/**
+ * @brief Adds a message to the back of a ThreadX queue.
+ * 
+ * @param queue Pointer to queue to add to.
+ * @param message Pointer to the message to add. The size of the message should match the queue's 'message_size' setting.
+ * @param wait_time The amount of time (in ticks) to wait before timing out. Can either be 'TX_NO_WAIT', 'TX_WAIT_FOREVER', or a numeric value of ticks.
+ */
+uint8_t queue_send(queue_t *queue, void *message, uint32_t wait_time);
+
+/**
+ * @brief Removes the frontmost message in a ThreadX queue, and places it in a buffer provided in the 'message' parameter.
+ * 
+ * @param queue Pointer to queue to get from.
+ * @param message Pointer to a buffer to store the removed message. The size of the buffer should match the queue's 'message_size' setting.
+ * @param wait_time The amount of time (in ticks) to wait before timing out. Can either be 'TX_NO_WAIT', 'TX_WAIT_FOREVER', or a numeric value of ticks.
+ */
+uint8_t queue_receive(queue_t *queue, void *message, uint32_t wait_time);
+
+// clang-format on
 
 #endif

threadX/src/u_tx_queues.c

@@ -42,7 +42,7 @@ uint8_t create_queue(TX_BYTE_POOL *byte_pool, queue_t *queue)
 	return U_SUCCESS;
 }
 
-uint8_t queue_send(queue_t *queue, void *message)
+uint8_t queue_send(queue_t *queue, void *message, uint32_t wait_time)
 {
 	UINT status;
 
@@ -54,7 +54,7 @@ uint8_t queue_send(queue_t *queue, void *message)
 	memcpy(buffer, message, queue->_bytes);
 
 	/* Send message (buffer) to the queue. */
-	status = tx_queue_send(&queue->_TX_QUEUE, buffer, QUEUE_WAIT_TIME);
+	status = tx_queue_send(&queue->_TX_QUEUE, buffer, (ULONG)wait_time);
 	if (status != TX_SUCCESS) {
 		PRINTLN_ERROR("Failed to send message to queue (Status: %d/%s, Queue: %s).", status, tx_status_toString(status), queue->_TX_QUEUE.tx_queue_name);
 		return U_ERROR;
@@ -63,7 +63,7 @@ uint8_t queue_send(queue_t *queue, void *message)
 	return U_SUCCESS;
 }
 
-uint8_t queue_receive(queue_t *queue, void *message)
+uint8_t queue_receive(queue_t *queue, void *message, uint32_t wait_time)
 {
 	UINT status;
 
@@ -72,7 +72,7 @@ uint8_t queue_receive(queue_t *queue, void *message)
 	memset(buffer, 0, sizeof(buffer)); // Initialize buffer to zero
 
 	/* Receive message from the queue. */
-	status = tx_queue_receive(&queue->_TX_QUEUE, buffer, QUEUE_WAIT_TIME);
+	status = tx_queue_receive(&queue->_TX_QUEUE, buffer, (ULONG)wait_time);
 	if (status == TX_QUEUE_EMPTY) {
 		return U_QUEUE_EMPTY;
 	}