Initial commit

1 files changed, 248 insertions, 0 deletions

diff --git a/common/src/tx_timer_info_get.c b/common/src/tx_timer_info_get.c
new file mode 100644
index 00000000..d422910b
--- /dev/null
+++ b/common/src/tx_timer_info_get.c
@@ -0,0 +1,248 @@
+/**************************************************************************/
+/*                                                                        */
+/*       Copyright (c) Microsoft Corporation. All rights reserved.        */
+/*                                                                        */
+/*       This software is licensed under the Microsoft Software License   */
+/*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
+/*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
+/*       and in the root directory of this software.                      */
+/*                                                                        */
+/**************************************************************************/
+
+
+/**************************************************************************/
+/**************************************************************************/
+/**                                                                       */
+/** ThreadX Component                                                     */
+/**                                                                       */
+/**   Timer                                                               */
+/**                                                                       */
+/**************************************************************************/
+/**************************************************************************/
+
+#define TX_SOURCE_CODE
+
+
+/* Include necessary system files.  */
+
+#include "tx_api.h"
+#include "tx_trace.h"
+#include "tx_timer.h"
+
+
+/**************************************************************************/
+/*                                                                        */
+/*  FUNCTION                                               RELEASE        */
+/*                                                                        */
+/*    _tx_timer_info_get                                  PORTABLE C      */
+/*                                                           6.0          */
+/*  AUTHOR                                                                */
+/*                                                                        */
+/*    William E. Lamie, Microsoft Corporation                             */
+/*                                                                        */
+/*  DESCRIPTION                                                           */
+/*                                                                        */
+/*    This function retrieves information from the specified timer.       */
+/*                                                                        */
+/*  INPUT                                                                 */
+/*                                                                        */
+/*    timer_ptr                         Pointer to timer control block    */
+/*    name                              Destination for the timer name    */
+/*    active                            Destination for active flag       */
+/*    remaining_ticks                   Destination for remaining ticks   */
+/*                                        before expiration               */
+/*    reschedule_ticks                  Destination for reschedule ticks  */
+/*    next_timer                        Destination for next timer on the */
+/*                                        created list                    */
+/*                                                                        */
+/*  OUTPUT                                                                */
+/*                                                                        */
+/*    status                            Completion status                 */
+/*                                                                        */
+/*  CALLS                                                                 */
+/*                                                                        */
+/*    None                                                                */
+/*                                                                        */
+/*  CALLED BY                                                             */
+/*                                                                        */
+/*    Application Code                                                    */
+/*                                                                        */
+/*  RELEASE HISTORY                                                       */
+/*                                                                        */
+/*    DATE              NAME                      DESCRIPTION             */
+/*                                                                        */
+/*  05-19-2020     William E. Lamie         Initial Version 6.0           */
+/*                                                                        */
+/**************************************************************************/
+UINT  _tx_timer_info_get(TX_TIMER *timer_ptr, CHAR **name, UINT *active, ULONG *remaining_ticks, 
+                ULONG *reschedule_ticks, TX_TIMER **next_timer)
+{
+
+TX_INTERRUPT_SAVE_AREA
+
+TX_TIMER_INTERNAL   *internal_ptr;
+TX_TIMER_INTERNAL   **list_head;
+ULONG               ticks_left;
+UINT                timer_active;
+UINT                active_timer_list;
+
+
+    /* Disable interrupts.  */
+    TX_DISABLE
+
+    /* If trace is enabled, insert this event into the trace buffer.  */
+    TX_TRACE_IN_LINE_INSERT(TX_TRACE_TIMER_INFO_GET, timer_ptr, TX_POINTER_TO_ULONG_CONVERT(&ticks_left), 0, 0, TX_TRACE_TIMER_EVENTS)
+
+    /* Log this kernel call.  */
+    TX_EL_TIMER_INFO_GET_INSERT
+
+    /* Retrieve the name of the timer.  */
+    if (name != TX_NULL)
+    {
+    
+        *name =  timer_ptr -> tx_timer_name;
+    }
+    
+    /* Pickup address of internal timer structure.  */
+    internal_ptr =  &(timer_ptr -> tx_timer_internal);
+
+    /* Retrieve all the pertinent information and return it in the supplied
+       destinations.  */
+
+    /* Default active to false.  */
+    timer_active =  TX_FALSE;
+    
+    /* Default the ticks left to the remaining ticks.  */
+    ticks_left =  internal_ptr -> tx_timer_internal_remaining_ticks;
+
+    /* Determine if the timer is still active.  */
+    if (internal_ptr -> tx_timer_internal_list_head != TX_NULL)
+    {
+
+        /* Indicate this timer is active.  */
+        timer_active =  TX_TRUE;
+
+        /* Default the active timer list flag to false.  */
+        active_timer_list =  TX_FALSE;
+
+        /* Determine if the timer is still active.  */
+        if (internal_ptr -> tx_timer_internal_list_head >= _tx_timer_list_start)
+        {
+
+            /* Determine if the list head is before the end of the list.  */
+            if (internal_ptr -> tx_timer_internal_list_head < _tx_timer_list_end)
+            {
+
+                /* This timer is active and has not yet expired.  */
+                active_timer_list =  TX_TRUE;
+            }
+        }
+
+        /* Determine if the timer is on the active timer list.  */
+        if (active_timer_list == TX_TRUE)
+        {
+
+            /* Calculate the amount of time that has elapsed since the timer
+               was activated.  */
+          
+            /* Setup the list head pointer.  */
+            list_head =  internal_ptr -> tx_timer_internal_list_head;
+
+            /* Is this timer's entry after the current timer pointer?  */
+            if (internal_ptr -> tx_timer_internal_list_head >= _tx_timer_current_ptr)
+            {
+
+                /* Calculate ticks left to expiration - just the difference between this 
+                   timer's entry and the current timer pointer.  */
+                ticks_left =  ((TX_TIMER_POINTER_DIF(list_head, _tx_timer_current_ptr)) + ((ULONG) 1));
+            }
+            else
+            {
+
+                /* Calculate the ticks left with a wrapped list condition.  */
+                ticks_left =  ((TX_TIMER_POINTER_DIF(list_head, _tx_timer_list_start)));
+
+                ticks_left =  ticks_left + ((TX_TIMER_POINTER_DIF(_tx_timer_list_end, _tx_timer_current_ptr)) + ((ULONG) 1));
+            }
+
+            /* Adjust the remaining ticks accordingly.  */
+            if (internal_ptr -> tx_timer_internal_remaining_ticks > TX_TIMER_ENTRIES)
+            {
+            
+                /* Subtract off the last full pass through the timer list and add the
+                   time left.  */
+                ticks_left =  (internal_ptr -> tx_timer_internal_remaining_ticks - TX_TIMER_ENTRIES) + ticks_left;
+            }
+
+        }
+        else
+        {
+    
+            /* The timer is not on the actual timer list so it must either be being processed
+               or on a temporary list to be processed.   */
+
+            /* Check to see if this timer is the timer currently being processed.  */
+            if (_tx_timer_expired_timer_ptr == internal_ptr)
+            {
+            
+                /* Timer dispatch routine is executing, waiting to execute, or just finishing. No more remaining ticks for this expiration.  */
+                ticks_left =  ((ULONG) 0);
+            }
+            else
+            {
+
+                /* Timer is not the one being processed, which means it must be on the temporary expiration list
+                   waiting to be processed.  */
+            
+                /* Calculate the remaining ticks for a timer in the process of expiring.  */
+                if (ticks_left > TX_TIMER_ENTRIES)
+                {
+                    
+                    /* Calculate the number of ticks remaining.  */
+                    ticks_left =  internal_ptr -> tx_timer_internal_remaining_ticks - TX_TIMER_ENTRIES;
+                }
+                else
+                {
+                
+                    /* Timer dispatch routine is waiting to execute, no more remaining ticks for this expiration.  */
+                    ticks_left =  ((ULONG) 0);
+                }
+            }
+        }
+    }
+
+    /* Setup return values for an inactive timer.  */
+    if (active != TX_NULL)
+    {
+        
+       /* Setup the timer active indication.  */
+       *active =  timer_active;
+    }
+    if (remaining_ticks != TX_NULL)
+    {
+        
+        /* Setup the default remaining ticks value.  */
+        *remaining_ticks =  ticks_left;
+    }
+
+    /* Pickup the reschedule ticks value.  */
+    if (reschedule_ticks != TX_NULL)
+    {
+    
+        *reschedule_ticks =  internal_ptr -> tx_timer_internal_re_initialize_ticks;
+    }
+    
+    /* Pickup the next created application timer.  */
+    if (next_timer != TX_NULL)
+    {
+    
+        *next_timer =  timer_ptr -> tx_timer_created_next;
+    }
+    
+    /* Restore interrupts.  */
+    TX_RESTORE
+
+    /* Return completion status.  */
+    return(TX_SUCCESS);
+}
+