mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_ARM_BEETLE_SOC/TOOLCHAIN_ARM_STD/wsf_timer.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 2 /*!
AnnaBridge 171:3a7713b1edbc 3 * \file wsf_timer.h
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * \brief Timer service.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * $Date: 2015-09-11 14:14:44 -0700 (Fri, 11 Sep 2015) $
AnnaBridge 171:3a7713b1edbc 8 * $Revision: 3856 $
AnnaBridge 171:3a7713b1edbc 9 *
AnnaBridge 171:3a7713b1edbc 10 * Copyright (c) 2009 Wicentric, Inc., all rights reserved.
AnnaBridge 171:3a7713b1edbc 11 * Wicentric confidential and proprietary.
AnnaBridge 171:3a7713b1edbc 12 *
AnnaBridge 171:3a7713b1edbc 13 * IMPORTANT. Your use of this file is governed by a Software License Agreement
AnnaBridge 171:3a7713b1edbc 14 * ("Agreement") that must be accepted in order to download or otherwise receive a
AnnaBridge 171:3a7713b1edbc 15 * copy of this file. You may not use or copy this file for any purpose other than
AnnaBridge 171:3a7713b1edbc 16 * as described in the Agreement. If you do not agree to all of the terms of the
AnnaBridge 171:3a7713b1edbc 17 * Agreement do not use this file and delete all copies in your possession or control;
AnnaBridge 171:3a7713b1edbc 18 * if you do not have a copy of the Agreement, you must contact Wicentric, Inc. prior
AnnaBridge 171:3a7713b1edbc 19 * to any use, copying or further distribution of this software.
AnnaBridge 171:3a7713b1edbc 20 */
AnnaBridge 171:3a7713b1edbc 21 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 22 #ifndef WSF_TIMER_H
AnnaBridge 171:3a7713b1edbc 23 #define WSF_TIMER_H
AnnaBridge 171:3a7713b1edbc 24
AnnaBridge 171:3a7713b1edbc 25 #include "wsf_os.h"
AnnaBridge 171:3a7713b1edbc 26
AnnaBridge 171:3a7713b1edbc 27 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 28 extern "C" {
AnnaBridge 171:3a7713b1edbc 29 #endif
AnnaBridge 171:3a7713b1edbc 30
AnnaBridge 171:3a7713b1edbc 31 /**************************************************************************************************
AnnaBridge 171:3a7713b1edbc 32 Macros
AnnaBridge 171:3a7713b1edbc 33 **************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 34
AnnaBridge 171:3a7713b1edbc 35 #ifndef WSF_MS_PER_TICK
AnnaBridge 171:3a7713b1edbc 36 /*! Default milliseconds per tick rate */
AnnaBridge 171:3a7713b1edbc 37 #define WSF_MS_PER_TICK 10
AnnaBridge 171:3a7713b1edbc 38 #endif
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /**************************************************************************************************
AnnaBridge 171:3a7713b1edbc 41 Data Types
AnnaBridge 171:3a7713b1edbc 42 **************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 /*! Timer ticks data type */
AnnaBridge 171:3a7713b1edbc 45 typedef uint32_t wsfTimerTicks_t;
AnnaBridge 171:3a7713b1edbc 46
AnnaBridge 171:3a7713b1edbc 47 /*! Timer structure */
AnnaBridge 171:3a7713b1edbc 48 typedef struct wsfTimer_tag
AnnaBridge 171:3a7713b1edbc 49 {
AnnaBridge 171:3a7713b1edbc 50 struct wsfTimer_tag *pNext; /*! pointer to next timer in queue */
AnnaBridge 171:3a7713b1edbc 51 wsfTimerTicks_t ticks; /*! number of ticks until expiration */
AnnaBridge 171:3a7713b1edbc 52 wsfHandlerId_t handlerId; /*! event handler for this timer */
AnnaBridge 171:3a7713b1edbc 53 bool_t isStarted; /*! TRUE if timer has been started */
AnnaBridge 171:3a7713b1edbc 54 wsfMsgHdr_t msg; /*! application-defined timer event parameters */
AnnaBridge 171:3a7713b1edbc 55 } wsfTimer_t;
AnnaBridge 171:3a7713b1edbc 56
AnnaBridge 171:3a7713b1edbc 57
AnnaBridge 171:3a7713b1edbc 58 /**************************************************************************************************
AnnaBridge 171:3a7713b1edbc 59 Function Declarations
AnnaBridge 171:3a7713b1edbc 60 **************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 61
AnnaBridge 171:3a7713b1edbc 62 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 63 /*!
AnnaBridge 171:3a7713b1edbc 64 * \fn WsfTimerInit
AnnaBridge 171:3a7713b1edbc 65 *
AnnaBridge 171:3a7713b1edbc 66 * \brief Initialize the timer service. This function should only be called once
AnnaBridge 171:3a7713b1edbc 67 * upon system initialization.
AnnaBridge 171:3a7713b1edbc 68 *
AnnaBridge 171:3a7713b1edbc 69 * \return None.
AnnaBridge 171:3a7713b1edbc 70 */
AnnaBridge 171:3a7713b1edbc 71 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 72 void WsfTimerInit(void);
AnnaBridge 171:3a7713b1edbc 73
AnnaBridge 171:3a7713b1edbc 74 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 75 /*!
AnnaBridge 171:3a7713b1edbc 76 * \fn WsfTimerStartSec
AnnaBridge 171:3a7713b1edbc 77 *
AnnaBridge 171:3a7713b1edbc 78 * \brief Start a timer in units of seconds. Before this function is called parameter
AnnaBridge 171:3a7713b1edbc 79 * pTimer->handlerId must be set to the event handler for this timer and parameter
AnnaBridge 171:3a7713b1edbc 80 * pTimer->msg must be set to any application-defined timer event parameters.
AnnaBridge 171:3a7713b1edbc 81 *
AnnaBridge 171:3a7713b1edbc 82 * \param pTimer Pointer to timer.
AnnaBridge 171:3a7713b1edbc 83 * \param sec Seconds until expiration.
AnnaBridge 171:3a7713b1edbc 84 *
AnnaBridge 171:3a7713b1edbc 85 * \return None.
AnnaBridge 171:3a7713b1edbc 86 */
AnnaBridge 171:3a7713b1edbc 87 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 88 void WsfTimerStartSec(wsfTimer_t *pTimer, wsfTimerTicks_t sec);
AnnaBridge 171:3a7713b1edbc 89
AnnaBridge 171:3a7713b1edbc 90 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 91 /*!
AnnaBridge 171:3a7713b1edbc 92 * \fn WsfTimerStartMs
AnnaBridge 171:3a7713b1edbc 93 *
AnnaBridge 171:3a7713b1edbc 94 * \brief Start a timer in units of milliseconds.
AnnaBridge 171:3a7713b1edbc 95 *
AnnaBridge 171:3a7713b1edbc 96 * \param pTimer Pointer to timer.
AnnaBridge 171:3a7713b1edbc 97 * \param ms Milliseconds until expiration.
AnnaBridge 171:3a7713b1edbc 98 *
AnnaBridge 171:3a7713b1edbc 99 * \return None.
AnnaBridge 171:3a7713b1edbc 100 */
AnnaBridge 171:3a7713b1edbc 101 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 102 void WsfTimerStartMs(wsfTimer_t *pTimer, wsfTimerTicks_t ms);
AnnaBridge 171:3a7713b1edbc 103
AnnaBridge 171:3a7713b1edbc 104 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 105 /*!
AnnaBridge 171:3a7713b1edbc 106 * \fn WsfTimerStop
AnnaBridge 171:3a7713b1edbc 107 *
AnnaBridge 171:3a7713b1edbc 108 * \brief Stop a timer.
AnnaBridge 171:3a7713b1edbc 109 *
AnnaBridge 171:3a7713b1edbc 110 * \param pTimer Pointer to timer.
AnnaBridge 171:3a7713b1edbc 111 *
AnnaBridge 171:3a7713b1edbc 112 * \return None.
AnnaBridge 171:3a7713b1edbc 113 */
AnnaBridge 171:3a7713b1edbc 114 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 115 void WsfTimerStop(wsfTimer_t *pTimer);
AnnaBridge 171:3a7713b1edbc 116
AnnaBridge 171:3a7713b1edbc 117 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 118 /*!
AnnaBridge 171:3a7713b1edbc 119 * \fn WsfTimerUpdate
AnnaBridge 171:3a7713b1edbc 120 *
AnnaBridge 171:3a7713b1edbc 121 * \brief Update the timer service with the number of elapsed ticks. This function is
AnnaBridge 171:3a7713b1edbc 122 * typically called only from timer porting code.
AnnaBridge 171:3a7713b1edbc 123 *
AnnaBridge 171:3a7713b1edbc 124 * \param ticks Number of ticks since last update.
AnnaBridge 171:3a7713b1edbc 125 *
AnnaBridge 171:3a7713b1edbc 126 * \return None.
AnnaBridge 171:3a7713b1edbc 127 */
AnnaBridge 171:3a7713b1edbc 128 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 129 void WsfTimerUpdate(wsfTimerTicks_t ticks);
AnnaBridge 171:3a7713b1edbc 130
AnnaBridge 171:3a7713b1edbc 131 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 132 /*!
AnnaBridge 171:3a7713b1edbc 133 * \fn WsfTimerNextExpiration
AnnaBridge 171:3a7713b1edbc 134 *
AnnaBridge 171:3a7713b1edbc 135 * \brief Return the number of ticks until the next timer expiration. Note that this
AnnaBridge 171:3a7713b1edbc 136 * function can return zero even if a timer is running, indicating the timer
AnnaBridge 171:3a7713b1edbc 137 * has expired but has not yet been serviced.
AnnaBridge 171:3a7713b1edbc 138 *
AnnaBridge 171:3a7713b1edbc 139 * \param pTimerRunning Returns TRUE if a timer is running, FALSE if no timers running.
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * \return The number of ticks until the next timer expiration.
AnnaBridge 171:3a7713b1edbc 142 */
AnnaBridge 171:3a7713b1edbc 143 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 144 wsfTimerTicks_t WsfTimerNextExpiration(bool_t *pTimerRunning);
AnnaBridge 171:3a7713b1edbc 145
AnnaBridge 171:3a7713b1edbc 146 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 147 /*!
AnnaBridge 171:3a7713b1edbc 148 * \fn WsfTimerServiceExpired
AnnaBridge 171:3a7713b1edbc 149 *
AnnaBridge 171:3a7713b1edbc 150 * \brief Service expired timers for the given task. This function is typically called only
AnnaBridge 171:3a7713b1edbc 151 * WSF OS porting code.
AnnaBridge 171:3a7713b1edbc 152 *
AnnaBridge 171:3a7713b1edbc 153 * \param taskId OS Task ID of task servicing timers.
AnnaBridge 171:3a7713b1edbc 154 *
AnnaBridge 171:3a7713b1edbc 155 * \return Pointer to next expired timer or NULL if there are no expired timers.
AnnaBridge 171:3a7713b1edbc 156 */
AnnaBridge 171:3a7713b1edbc 157 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 158 wsfTimer_t *WsfTimerServiceExpired(wsfTaskId_t taskId);
AnnaBridge 171:3a7713b1edbc 159
AnnaBridge 171:3a7713b1edbc 160 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 161 };
AnnaBridge 171:3a7713b1edbc 162 #endif
AnnaBridge 171:3a7713b1edbc 163
AnnaBridge 171:3a7713b1edbc 164 #endif /* WSF_TIMER_H */