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_terminate 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 terminate 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_terminate Actual thread terminate */
60 /* function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
71 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_txe_thread_terminate(TX_THREAD * thread_ptr)75 UINT _txe_thread_terminate(TX_THREAD *thread_ptr)
76 {
77
78 UINT status;
79
80
81 /* Check for an invalid thread pointer. */
82 if (thread_ptr == TX_NULL)
83 {
84
85 /* Thread pointer is invalid, return appropriate error code. */
86 status = TX_THREAD_ERROR;
87 }
88
89 /* Now check for invalid thread ID. */
90 else if (thread_ptr -> tx_thread_id != TX_THREAD_ID)
91 {
92
93 /* Thread pointer is invalid, return appropriate error code. */
94 status = TX_THREAD_ERROR;
95 }
96
97 /* Check for invalid caller of this function. */
98 else if (TX_THREAD_GET_SYSTEM_STATE() != ((ULONG) 0))
99 {
100
101 /* Invalid caller of this function, return appropriate error code. */
102 status = TX_CALLER_ERROR;
103 }
104 else
105 {
106
107 /* Call actual thread terminate function. */
108 status = _tx_thread_terminate(thread_ptr);
109 }
110
111 /* Return completion status. */
112 return(status);
113 }
114
115
