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 /** USBX Component                                                        */
17 /**                                                                       */
18 /**   Utility                                                             */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 
24 /* Include necessary system files.  */
25 
26 #define UX_SOURCE_CODE
27 
28 #include "ux_api.h"
29 
30 
31 #if !defined(UX_STANDALONE)
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _ux_utility_mutex_create                            PORTABLE C      */
37 /*                                                           6.1.11       */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Chaoqiong Xiao, Microsoft Corporation                               */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function creates a protection mutex.                           */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    mutex                                 Pointer to mutex              */
49 /*    mutex_name                            Name of mutex                 */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    Completion Status                                                   */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    tx_mutex_create                       ThreadX mutex create          */
58 /*                                                                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    USBX Components                                                     */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
68 /*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
69 /*                                            used UX prefix to refer to  */
70 /*                                            TX symbols instead of using */
71 /*                                            them directly,              */
72 /*                                            resulting in version 6.1    */
73 /*  04-25-2022     Chaoqiong Xiao           Modified comment(s),          */
74 /*                                            off in standalone build,    */
75 /*                                            resulting in version 6.1.11 */
76 /*                                                                        */
77 /**************************************************************************/
_ux_utility_mutex_create(UX_MUTEX * mutex,CHAR * mutex_name)78 UINT  _ux_utility_mutex_create(UX_MUTEX *mutex, CHAR *mutex_name)
79 {
80 
81 UINT    status;
82 
83 
84     /* Call ThreadX to create the Mutex object.  */
85     status =  tx_mutex_create(mutex, (CHAR *) mutex_name, TX_NO_INHERIT);
86 
87     /* Check for status.  */
88     if (status != UX_SUCCESS)
89     {
90 
91         /* Error trap. */
92         _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_UTILITY, status);
93 
94         /* If trace is enabled, insert this event into the trace buffer.  */
95         UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MUTEX_ERROR, mutex, 0, 0, UX_TRACE_ERRORS, 0, 0)
96 
97     }
98     /* Return completion status.  */
99     return(status);
100 }
101 #endif
102