packages/kernel/v2_0/include/timer.hxx

   1 #ifndef CYGONCE_KERNEL_TIMER_HXX
   2 #define CYGONCE_KERNEL_TIMER_HXX
   3
   4 //==========================================================================
   5 //
   6 //      timer.hxx
   7 //
   8 //      Timer handler class declaration(s)
   9 //
  10 //==========================================================================
  11 //####ECOSGPLCOPYRIGHTBEGIN####
  12 // -------------------------------------------
  13 // This file is part of eCos, the Embedded Configurable Operating System.
  14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  15 //
  16 // eCos is free software; you can redistribute it and/or modify it under
  17 // the terms of the GNU General Public License as published by the Free
  18 // Software Foundation; either version 2 or (at your option) any later version.
  19 //
  20 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  21 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  22 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  23 // for more details.
  24 //
  25 // You should have received a copy of the GNU General Public License along
  26 // with eCos; if not, write to the Free Software Foundation, Inc.,
  27 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  28 //
  29 // As a special exception, if other files instantiate templates or use macros
  30 // or inline functions from this file, or you compile this file and link it
  31 // with other works to produce a work based on this file, this file does not
  32 // by itself cause the resulting work to be covered by the GNU General Public
  33 // License. However the source code for this file must still be made available
  34 // in accordance with section (3) of the GNU General Public License.
  35 //
  36 // This exception does not invalidate any other reasons why a work based on
  37 // this file might be covered by the GNU General Public License.
  38 //
  39 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  40 // at http://sources.redhat.com/ecos/ecos-license/
  41 // -------------------------------------------
  42 //####ECOSGPLCOPYRIGHTEND####
  43 //==========================================================================
  44 //#####DESCRIPTIONBEGIN####
  45 //
  46 // Author(s):   dsm
  47 // Contributors:        dsm
  48 // Date:        1998-06-10
  49 // Purpose:     Define Timer class interfaces
  50 // Description: This file defines the Timer class which is derived from
  51 //              the Alarm class to support uITRON type functionality
  52 // Usage:       #include <cyg/kernel/timer.hxx>
  53 //
  54 //####DESCRIPTIONEND####
  55 //
  56 //==========================================================================
  57
  58 #include <cyg/kernel/ktypes.h>
  59 #include <cyg/infra/cyg_ass.h>          // assertion macros
  60 #include <cyg/kernel/clock.hxx>         // Cyg_Alarm
  61
  62 // -------------------------------------------------------------------------
  63 // Timer handler class
  64
  65 class Cyg_Timer
  66     : public Cyg_Alarm
  67 {
  68 public:
  69
  70     CYGDBG_DEFINE_CHECK_THIS
  71
  72     Cyg_Timer();
  73
  74     ~Cyg_Timer();
  75
  76     enum {
  77         DISABLE = 0,
  78         ENABLE  = 1,
  79         RESET   = 2,
  80     };
  81
  82     void initialize(
  83         Cyg_Counter    *counter,
  84         cyg_alarm_fn   alarm_fn,
  85         CYG_ADDRWORD   data,
  86         cyg_tick_count trigger,         // absolute time
  87         cyg_tick_count interval,        // 0 => one shot, else repeating
  88         cyg_uint32     action           // (DISABLE | ENABLE)
  89         );
  90
  91     void activate(cyg_uint32 action);   // (DISABLE | ENABLE) [|RESET]
  92
  93     cyg_tick_count get_trigger();
  94     cyg_bool       is_enabled();
  95     cyg_bool       is_initialized();
  96     CYG_ADDRWORD   get_data();
  97 };
  98
  99 // -------------------------------------------------------------------------
 100 // Timer inlines
 101
 102 inline cyg_tick_count
 103 Cyg_Timer::get_trigger()
 104 {
 105     return trigger;
 106 }
 107
 108 inline cyg_bool
 109 Cyg_Timer::is_initialized()
 110 {
 111     return NULL != counter;
 112 }
 113
 114 inline cyg_bool
 115 Cyg_Timer::is_enabled()
 116 {
 117     return enabled;
 118 }
 119
 120 inline CYG_ADDRWORD
 121 Cyg_Timer::get_data()
 122 {
 123     return data;
 124 }
 125
 126 #endif // ifndef CYGONCE_KERNEL_TIMER_HXX
 127 // EOF timer.hxx