Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/**************************************************************************/
/* */
/* 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_timer.h"
#include "tx_thread.h"
#include "tx_queue.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _txe_queue_receive PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the queue receive function call. */
/* */
/* INPUT */
/* */
/* queue_ptr Pointer to queue control block */
/* destination_ptr Pointer to message destination */
/* **** MUST BE LARGE ENOUGH TO */
/* HOLD MESSAGE **** */
/* wait_option Suspension option */
/* */
/* OUTPUT */
/* */
/* TX_QUEUE_ERROR Invalid queue pointer */
/* TX_PTR_ERROR Invalid destination pointer (NULL)*/
/* TX_WAIT_ERROR Invalid wait option */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _tx_queue_receive Actual queue receive function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _txe_queue_receive(TX_QUEUE *queue_ptr, VOID *destination_ptr, ULONG wait_option)
{
UINT status;
#ifndef TX_TIMER_PROCESS_IN_ISR
TX_THREAD *current_thread;
#endif
/* Default status to success. */
status = TX_SUCCESS;
/* 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 invalid queue ID. */
else if (queue_ptr -> tx_queue_id != TX_QUEUE_ID)
{
/* Queue pointer is invalid, return appropriate error code. */
status = TX_QUEUE_ERROR;
}
/* Check for an invalid destination for message. */
else if (destination_ptr == TX_NULL)
{
/* Null destination pointer, return appropriate error. */
status = TX_PTR_ERROR;
}
else
{
/* Check for a wait option error. Only threads are allowed any form of
suspension. */
if (wait_option != TX_NO_WAIT)
{
/* Is the call from an ISR or Initialization? */
if (TX_THREAD_GET_SYSTEM_STATE() != ((ULONG) 0))
{
/* A non-thread is trying to suspend, return appropriate error code. */
status = TX_WAIT_ERROR;
}
#ifndef TX_TIMER_PROCESS_IN_ISR
else
{
/* Pickup thread pointer. */
TX_THREAD_GET_CURRENT(current_thread)
/* Is the current thread the timer thread? */
if (current_thread == &_tx_timer_thread)
{
/* A non-thread is trying to suspend, return appropriate error code. */
status = TX_WAIT_ERROR;
}
}
#endif
}
}
/* Determine if everything is okay. */
if (status == TX_SUCCESS)
{
/* Call actual queue receive function. */
status = _tx_queue_receive(queue_ptr, destination_ptr, wait_option);
}
/* Return completion status. */
return(status);
}