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_timer_create                            PORTABLE C      */
37 /*                                                           6.1.11       */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Chaoqiong Xiao, Microsoft Corporation                               */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function creates a timer.                                      */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    timer                                 Pointer to timer              */
49 /*    timer_name                            Name of timer                 */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    Completion Status                                                   */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    tx_timer_create                       ThreadX timer 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 /*                                            resulting in version 6.1    */
70 /*  04-25-2022     Chaoqiong Xiao           Modified comment(s),          */
71 /*                                            off in standalone build,    */
72 /*                                            resulting in version 6.1.11 */
73 /*                                                                        */
74 /**************************************************************************/
_ux_utility_timer_create(TX_TIMER * timer,CHAR * timer_name,VOID (* expiration_function)(ULONG),ULONG expiration_input,ULONG initial_ticks,ULONG reschedule_ticks,UINT activation_flag)75 UINT  _ux_utility_timer_create(TX_TIMER *timer, CHAR *timer_name, VOID (*expiration_function) (ULONG),
76                                 ULONG expiration_input, ULONG initial_ticks, ULONG reschedule_ticks,
77                                 UINT activation_flag)
78 {
79 
80 UINT    status;
81 
82 
83     /* Call ThreadX to create the timer object.  */
84     status =  tx_timer_create(timer, (CHAR *) timer_name, expiration_function, expiration_input,
85                                 initial_ticks, reschedule_ticks, activation_flag);
86 
87     /* Check status.  */
88     if (status != UX_SUCCESS)
89 
90         /* Error trap. */
91         _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_UTILITY, status);
92 
93     /* Return completion status.  */
94     return(status);
95 }
96 #endif
97