summaryrefslogtreecommitdiff
path: root/common/src/txe_queue_send_notify.c
diff options
context:
space:
mode:
Diffstat (limited to 'common/src/txe_queue_send_notify.c')
-rw-r--r--common/src/txe_queue_send_notify.c103
1 files changed, 103 insertions, 0 deletions
diff --git a/common/src/txe_queue_send_notify.c b/common/src/txe_queue_send_notify.c
new file mode 100644
index 00000000..a6c0d746
--- /dev/null
+++ b/common/src/txe_queue_send_notify.c
@@ -0,0 +1,103 @@
+/**************************************************************************/
+/* */
+/* Copyright (c) Microsoft Corporation. All rights reserved. */
+/* */
+/* This software is licensed under the Microsoft Software License */
+/* Terms for Microsoft Azure RTOS. Full text of the license can be */
+/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
+/* and in the root directory of this software. */
+/* */
+/**************************************************************************/
+
+
+/**************************************************************************/
+/**************************************************************************/
+/** */
+/** ThreadX Component */
+/** */
+/** Queue */
+/** */
+/**************************************************************************/
+/**************************************************************************/
+
+#define TX_SOURCE_CODE
+
+
+/* Include necessary system files. */
+
+#include "tx_api.h"
+#include "tx_queue.h"
+
+
+/**************************************************************************/
+/* */
+/* FUNCTION RELEASE */
+/* */
+/* _txe_queue_send_notify PORTABLE C */
+/* 6.0 */
+/* AUTHOR */
+/* */
+/* William E. Lamie, Microsoft Corporation */
+/* */
+/* DESCRIPTION */
+/* */
+/* This function checks for errors in the queue send notify */
+/* callback function call. */
+/* */
+/* INPUT */
+/* */
+/* queue_ptr Pointer to queue control block*/
+/* queue_send_notify Application callback function */
+/* (TX_NULL disables notify) */
+/* */
+/* OUTPUT */
+/* */
+/* status Completion status */
+/* */
+/* CALLS */
+/* */
+/* _tx_queue_send_notify Actual queue send notify call */
+/* */
+/* CALLED BY */
+/* */
+/* Application Code */
+/* */
+/* RELEASE HISTORY */
+/* */
+/* DATE NAME DESCRIPTION */
+/* */
+/* 05-19-2020 William E. Lamie Initial Version 6.0 */
+/* */
+/**************************************************************************/
+UINT _txe_queue_send_notify(TX_QUEUE *queue_ptr, VOID (*queue_send_notify)(TX_QUEUE *notify_queue_ptr))
+{
+
+UINT status;
+
+
+ /* Check for an invalid queue pointer. */
+ if (queue_ptr == TX_NULL)
+ {
+
+ /* Queue pointer is invalid, return appropriate error code. */
+ status = TX_QUEUE_ERROR;
+ }
+
+ /* Now check for a valid queue ID. */
+ else if (queue_ptr -> tx_queue_id != TX_QUEUE_ID)
+ {
+
+ /* Queue pointer is invalid, return appropriate error code. */
+ status = TX_QUEUE_ERROR;
+ }
+ else
+ {
+
+ /* Call actual queue send notify function. */
+ status = _tx_queue_send_notify(queue_ptr, queue_send_notify);
+ }
+
+ /* Return completion status. */
+ return(status);
+}
+