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 /** Thread */
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_thread.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _txe_thread_suspend 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 thread suspend function */
45 /* call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* thread_ptr Pointer to thread to suspend */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* TX_THREAD_ERROR Invalid thread pointer */
54 /* TX_CALLER_ERROR Invalid caller of function */
55 /* status Actual completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _tx_thread_suspend Actual thread suspension */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
70 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_txe_thread_suspend(TX_THREAD * thread_ptr)74 UINT _txe_thread_suspend(TX_THREAD *thread_ptr)
75 {
76
77 UINT status;
78
79
80 /* Check for an invalid thread pointer. */
81 if (thread_ptr == TX_NULL)
82 {
83
84 /* Thread pointer is invalid, return appropriate error code. */
85 status = TX_THREAD_ERROR;
86 }
87
88 /* Now check for invalid thread ID. */
89 else if (thread_ptr -> tx_thread_id != TX_THREAD_ID)
90 {
91
92 /* Thread pointer is invalid, return appropriate error code. */
93 status = TX_THREAD_ERROR;
94 }
95 else
96 {
97
98 /* Call actual thread suspend function. */
99 status = _tx_thread_suspend(thread_ptr);
100 }
101
102 /* Return completion status. */
103 return(status);
104 }
105
106
