summaryrefslogtreecommitdiff
path: root/common/src/txe_timer_delete.c
diff options
context:
space:
mode:
authorPProvost <[email protected]>2020-05-11 08:55:07 -0600
committerPProvost <[email protected]>2020-05-11 08:55:07 -0600
commit852421fda03a7722d7adb45b187235cd66fa264e (patch)
treeb117e1339a047347a3d7ebf3eeb1891168cc9b9b /common/src/txe_timer_delete.c
Initial commit
Diffstat (limited to 'common/src/txe_timer_delete.c')
-rw-r--r--common/src/txe_timer_delete.c143
1 files changed, 143 insertions, 0 deletions
diff --git a/common/src/txe_timer_delete.c b/common/src/txe_timer_delete.c
new file mode 100644
index 00000000..21debdf1
--- /dev/null
+++ b/common/src/txe_timer_delete.c
@@ -0,0 +1,143 @@
+/**************************************************************************/
+/* */
+/* 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_thread.h"
+#include "tx_timer.h"
+
+
+/**************************************************************************/
+/* */
+/* FUNCTION RELEASE */
+/* */
+/* _txe_timer_delete PORTABLE C */
+/* 6.0 */
+/* AUTHOR */
+/* */
+/* William E. Lamie, Microsoft Corporation */
+/* */
+/* DESCRIPTION */
+/* */
+/* This function checks for errors in the delete application timer */
+/* function call. */
+/* */
+/* INPUT */
+/* */
+/* timer_ptr Pointer to timer control block */
+/* */
+/* OUTPUT */
+/* */
+/* TX_TIMER_ERROR Invalid application timer pointer */
+/* TX_CALLER_ERROR Invalid caller of this function */
+/* status Actual completion status */
+/* */
+/* CALLS */
+/* */
+/* _tx_timer_delete Actual timer delete function */
+/* */
+/* CALLED BY */
+/* */
+/* Application Code */
+/* */
+/* RELEASE HISTORY */
+/* */
+/* DATE NAME DESCRIPTION */
+/* */
+/* 05-19-2020 William E. Lamie Initial Version 6.0 */
+/* */
+/**************************************************************************/
+UINT _txe_timer_delete(TX_TIMER *timer_ptr)
+{
+
+UINT status;
+#ifndef TX_TIMER_PROCESS_IN_ISR
+TX_THREAD *thread_ptr;
+#endif
+
+
+#ifndef TX_TIMER_PROCESS_IN_ISR
+
+ /* Default status to success. */
+ status = TX_SUCCESS;
+#endif
+
+ /* Check for an invalid timer pointer. */
+ if (timer_ptr == TX_NULL)
+ {
+ /* Timer pointer is invalid, return appropriate error code. */
+ status = TX_TIMER_ERROR;
+ }
+
+ /* Now check for invalid timer ID. */
+ else if (timer_ptr -> tx_timer_id != TX_TIMER_ID)
+ {
+ /* Timer pointer is invalid, return appropriate error code. */
+ status = TX_TIMER_ERROR;
+ }
+
+ /* Check for invalid caller of this function. */
+
+ /* Is the caller an ISR or Initialization? */
+ else if (TX_THREAD_GET_SYSTEM_STATE() != ((ULONG) 0))
+ {
+
+ /* Invalid caller of this function, return appropriate error code. */
+ status = TX_CALLER_ERROR;
+ }
+ else
+ {
+
+#ifndef TX_TIMER_PROCESS_IN_ISR
+
+ /* Pickup thread pointer. */
+ TX_THREAD_GET_CURRENT(thread_ptr)
+
+ /* Is the caller the system timer thread? */
+ if (thread_ptr == &_tx_timer_thread)
+ {
+
+ /* Invalid caller of this function, return appropriate error code. */
+ status = TX_CALLER_ERROR;
+ }
+
+ /* Determine if everything is okay. */
+ if (status == TX_SUCCESS)
+ {
+#endif
+
+ /* Call actual application timer delete function. */
+ status = _tx_timer_delete(timer_ptr);
+
+#ifndef TX_TIMER_PROCESS_IN_ISR
+ }
+#endif
+ }
+
+ /* Return completion status. */
+ return(status);
+}
+