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 /** GUIX Component                                                        */
17 /**                                                                       */
18 /**   System Management (System)                                          */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "gx_api.h"
28 #include "gx_system.h"
29 
30 /* Bring in externs for caller checking code.  */
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_system_timer_stop                              PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function checks for errors in system timer stop call.          */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    owner                                 Pointer to widget control     */
50 /*                                            block                       */
51 /*    timer_id                              ID of timer                   */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_system_timer_stop                 Actual system timer stop call */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    GUIX Application                                                    */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
70 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
71 /*                                            resulting in version 6.1    */
72 /*                                                                        */
73 /**************************************************************************/
_gxe_system_timer_stop(GX_WIDGET * owner,UINT timer_id)74 UINT _gxe_system_timer_stop(GX_WIDGET *owner, UINT timer_id)
75 {
76 UINT      status;
77 GX_TIMER *next;
78 GX_BOOL   id_flag = GX_FALSE;
79 
80     /* Check for invalid caller.  */
81     GX_INIT_AND_THREADS_CALLER_CHECKING
82 
83     /* Check for timer ID not found.  */
84 
85     if (timer_id)
86     {
87         next = _gx_system_active_timer_list;
88         while (next)
89         {
90             if (next -> gx_timer_id == timer_id)
91             {
92                 id_flag = GX_TRUE;
93                 break;
94             }
95             next = next -> gx_timer_next;
96         }
97         if (id_flag == GX_FALSE)
98         {
99             return(GX_NOT_FOUND);
100         }
101     }
102 
103     /* Check for invalid pointer.  */
104     if (owner == GX_NULL)
105     {
106         return(GX_PTR_ERROR);
107     }
108 
109     /* Check for invalid widget.  */
110     if (owner -> gx_widget_type == 0)
111     {
112         return(GX_INVALID_WIDGET);
113     }
114 
115     /* Call actual system timer stop.  */
116     status = _gx_system_timer_stop(owner, timer_id);
117 
118     /* Return status.  */
119     return(status);
120 }
121 
122