1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** ThreadX Component */
16 /** */
17 /** Module */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define TXM_MODULE
23 #include "txm_module.h"
24 #ifndef TXM_QUEUE_SEND_CALL_NOT_USED
25 /**************************************************************************/
26 /* */
27 /* FUNCTION RELEASE */
28 /* */
29 /* _txe_queue_send PORTABLE C */
30 /* 6.1.10 */
31 /* AUTHOR */
32 /* */
33 /* Scott Larson, Microsoft Corporation */
34 /* */
35 /* DESCRIPTION */
36 /* */
37 /* This function checks for errors in the queue send function call. */
38 /* */
39 /* INPUT */
40 /* */
41 /* queue_ptr Pointer to queue control block */
42 /* source_ptr Pointer to message source */
43 /* wait_option Suspension option */
44 /* */
45 /* OUTPUT */
46 /* */
47 /* TX_QUEUE_ERROR Invalid queue pointer */
48 /* TX_PTR_ERROR Invalid source pointer - NULL */
49 /* TX_WAIT_ERROR Invalid wait option */
50 /* status Actual completion status */
51 /* */
52 /* CALLS */
53 /* */
54 /* _txm_module_kernel_call_dispatcher */
55 /* */
56 /* CALLED BY */
57 /* */
58 /* Module application code */
59 /* */
60 /* RELEASE HISTORY */
61 /* */
62 /* DATE NAME DESCRIPTION */
63 /* */
64 /* 09-30-2020 Scott Larson Initial Version 6.1 */
65 /* 01-31-2022 Scott Larson Modified comments and added */
66 /* CALL_NOT_USED option, */
67 /* resulting in version 6.1.10 */
68 /* */
69 /**************************************************************************/
_txe_queue_send(TX_QUEUE * queue_ptr,VOID * source_ptr,ULONG wait_option)70 UINT _txe_queue_send(TX_QUEUE *queue_ptr, VOID *source_ptr, ULONG wait_option)
71 {
72
73 UINT return_value;
74
75 /* Call module manager dispatcher. */
76 return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_QUEUE_SEND_CALL, (ALIGN_TYPE) queue_ptr, (ALIGN_TYPE) source_ptr, (ALIGN_TYPE) wait_option);
77
78 /* Return value to the caller. */
79 return(return_value);
80 }
81 #endif
82
