1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** ThreadX Component */
17 /** */
18 /** Module */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define TXM_MODULE
24 #include "txm_module.h"
25 #ifndef TXM_QUEUE_RECEIVE_CALL_NOT_USED
26 /**************************************************************************/
27 /* */
28 /* FUNCTION RELEASE */
29 /* */
30 /* _txe_queue_receive PORTABLE C */
31 /* 6.1.10 */
32 /* AUTHOR */
33 /* */
34 /* Scott Larson, Microsoft Corporation */
35 /* */
36 /* DESCRIPTION */
37 /* */
38 /* This function checks for errors in the queue receive function call. */
39 /* */
40 /* INPUT */
41 /* */
42 /* queue_ptr Pointer to queue control block */
43 /* destination_ptr Pointer to message destination */
44 /* **** MUST BE LARGE ENOUGH TO */
45 /* HOLD MESSAGE **** */
46 /* wait_option Suspension option */
47 /* */
48 /* OUTPUT */
49 /* */
50 /* TX_QUEUE_ERROR Invalid queue pointer */
51 /* TX_PTR_ERROR Invalid destination pointer (NULL)*/
52 /* TX_WAIT_ERROR Invalid wait option */
53 /* status Actual completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _txm_module_kernel_call_dispatcher */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* Module application code */
62 /* */
63 /* RELEASE HISTORY */
64 /* */
65 /* DATE NAME DESCRIPTION */
66 /* */
67 /* 09-30-2020 Scott Larson Initial Version 6.1 */
68 /* 01-31-2022 Scott Larson Modified comments and added */
69 /* CALL_NOT_USED option, */
70 /* resulting in version 6.1.10 */
71 /* */
72 /**************************************************************************/
_txe_queue_receive(TX_QUEUE * queue_ptr,VOID * destination_ptr,ULONG wait_option)73 UINT _txe_queue_receive(TX_QUEUE *queue_ptr, VOID *destination_ptr, ULONG wait_option)
74 {
75
76 UINT return_value;
77
78 /* Call module manager dispatcher. */
79 return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_QUEUE_RECEIVE_CALL, (ALIGN_TYPE) queue_ptr, (ALIGN_TYPE) destination_ptr, (ALIGN_TYPE) wait_option);
80
81 /* Return value to the caller. */
82 return(return_value);
83 }
84 #endif
85
