virtualtimer.h

CNC.rar

//*****************************************************************************
//
// virtualtimer.h - Prototypes for the virtual timer driver.
//
// Copyright (c) 2006-2007 Luminary Micro, Inc.  All rights reserved.
//
// Software License Agreement
//
// Luminary Micro, Inc. (LMI) is supplying this software for use solely and
// exclusively on LMI's microcontroller products.
//
// The software is owned by LMI and/or its suppliers, and is protected under
// applicable copyright laws.  All rights are reserved.  Any use in violation
// of the foregoing restrictions may subject the user to criminal sanctions
// under applicable laws, as well as to civil liability for the breach of the
// terms and conditions of this license.
//
// THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
// OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
// LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
// CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
//
// This is part of revision 220 of sw01246.
//
//*****************************************************************************

#ifndef __VIRTUALTIMER_H__
#define __VIRTUALTIMER_H__

//*****************************************************************************
//
//! \addtogroup main_virtualtimer_api
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
//! This structure contains the parameters of a virtual timer.  Virtual timers
//! have expiration times specified in terms of absolute time; incrementing the
//! timeout value by 50,000 in the handler and re-activating the virtual timer
//! will cause the handler to be called every 50,000 processor clocks, give or
//! take some jitter based on other interrupts and/or other virtual timers.
//
//*****************************************************************************
typedef struct
{
    //
    //! This is the function to be called when the timer expires.
    //
    void (*pfnHandler)(void);

    //
    //! This is the absolute time at which the timer is to expire, expressed in
    //! terms of processor clocks.
    //
    unsigned long ulTimeOut;
}
tVirtualTimer;

//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************

//*****************************************************************************
//
// Prototypes for the virtual timer API.
//
//*****************************************************************************
extern void Timer2IntHandler(void);
extern unsigned long VirtualTimerAdd(tVirtualTimer *pTimer);
extern unsigned long VirtualTimeGet(void);
extern void VirtualTimerInit(void);

#endif // __VIRTUALTIMER_H__