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 /** Queue */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define TX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "tx_api.h"
29 #include "tx_queue.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _txe_queue_flush PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* William E. Lamie, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in the queue flush function call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* queue_ptr Pointer to queue control block */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* TX_QUEUE_ERROR Invalid queue pointer */
53 /* TX_CALLER_ERROR Invalid caller of this function */
54 /* status Actual completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _tx_queue_flush Actual queue flush function */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Application Code */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
69 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
70 /* resulting in version 6.1 */
71 /* */
72 /**************************************************************************/
_txe_queue_flush(TX_QUEUE * queue_ptr)73 UINT _txe_queue_flush(TX_QUEUE *queue_ptr)
74 {
75
76 UINT status;
77
78
79 /* Check for an invalid queue pointer. */
80 if (queue_ptr == TX_NULL)
81 {
82
83 /* Queue pointer is invalid, return appropriate error code. */
84 status = TX_QUEUE_ERROR;
85 }
86
87 /* Now check for invalid queue ID. */
88 else if (queue_ptr -> tx_queue_id != TX_QUEUE_ID)
89 {
90
91 /* Queue pointer is invalid, return appropriate error code. */
92 status = TX_QUEUE_ERROR;
93 }
94 else
95 {
96
97 /* Call actual queue flush function. */
98 status = _tx_queue_flush(queue_ptr);
99 }
100
101 /* Return completion status. */
102 return(status);
103 }
104
105
