flash_v2: packages/kernel/current/include/clock.hxx annotate

annotate packages/kernel/current/include/clock.hxx @ 210:d2c90368aeef

Merge from eCos master repository on 2002-05-23-21:39:14-BST

author	jlarmour
date	Thu, 23 May 2002 22:59:51 +0000
parents	e0c0827131d1
children	4c13726203c5

rev	line source
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	1 #ifndef CYGONCE_KERNEL_CLOCK_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	2 #define CYGONCE_KERNEL_CLOCK_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	3
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	4 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	5 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	6 // clock.hxx
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	7 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	8 // Clock and Alarm class declaration(s)
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	9 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	10 //==========================================================================
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	11 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	12 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	13 // This file is part of eCos, the Embedded Configurable Operating System.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	15 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	16 // eCos is free software; you can redistribute it and/or modify it under
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	17 // the terms of the GNU General Public License as published by the Free
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	18 // Software Foundation; either version 2 or (at your option) any later version.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	19 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	20 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	21 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	22 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	23 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	24 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	25 // You should have received a copy of the GNU General Public License along
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	26 // with eCos; if not, write to the Free Software Foundation, Inc.,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	27 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	28 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	29 // As a special exception, if other files instantiate templates or use macros
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	30 // or inline functions from this file, or you compile this file and link it
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	31 // with other works to produce a work based on this file, this file does not
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	32 // by itself cause the resulting work to be covered by the GNU General Public
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	33 // License. However the source code for this file must still be made available
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	34 // in accordance with section (3) of the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	35 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	36 // This exception does not invalidate any other reasons why a work based on
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	37 // this file might be covered by the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	38 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	39 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
210 d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST jlarmour parents: 208 diff changeset	40 // at http://sources.redhat.com/ecos/ecos-license/
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	41 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 148 diff changeset	42 //####ECOSGPLCOPYRIGHTEND####
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	43 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	44 //#####DESCRIPTIONBEGIN####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	45 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	46 // Author(s): nickg
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	47 // Contributors: nickg
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	48 // Date: 1997-09-09
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	49 // Purpose: Define Clock and Alarm class interfaces
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	50 // Description: The classes defined here collectively implement the
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	51 // internal API used to create, configure and manage Counters,
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	52 // Clocks and Alarms.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	53 // Usage: #include <cyg/kernel/clock.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	54 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	55 //####DESCRIPTIONEND####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	56 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	57 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	58
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	59 #include <cyg/kernel/ktypes.h>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	60 #include <cyg/infra/cyg_ass.h> // assertion macros
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	61
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	62 #include <cyg/infra/clist.hxx>
8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	63
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	64 // -------------------------------------------------------------------------
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	65 // Forward definitions and typedefs.
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	66
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	67 class Cyg_Alarm;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	68
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	69 typedef void cyg_alarm_fn(Cyg_Alarm *alarm, CYG_ADDRWORD data);
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	70
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	71 typedef Cyg_CList_T<Cyg_Alarm> Cyg_Alarm_List;
8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	72
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	73 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	74 // Counter object.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	75
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	76 class Cyg_Counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	77 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	78
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	79 friend class Cyg_Alarm;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	80
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	81 #if defined(CYGIMP_KERNEL_COUNTERS_SINGLE_LIST)
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	82
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	83 Cyg_Alarm_List alarm_list; // Linear list of Alarms
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	84
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	85 #elif defined(CYGIMP_KERNEL_COUNTERS_MULTI_LIST)
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	86
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	87 Cyg_Alarm_List alarm_list[CYGNUM_KERNEL_COUNTERS_MULTI_LIST_SIZE];
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	88
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	89 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	90
62 7a6ac9edc838 Merge from eCos master repository on 2000-01-24-19:43:49-GMT jlarmour parents: 2 diff changeset	91 volatile cyg_tick_count counter; // counter value
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	92
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	93 cyg_uint32 increment; // increment per tick
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	94
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	95 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	96
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	97 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	98
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	99 Cyg_Counter(
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	100 cyg_uint32 increment = 1
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	101 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	102
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	103 ~Cyg_Counter();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	104
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	105 // Return current value of counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	106 cyg_tick_count current_value();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	107
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	108 // Return low and high halves of the
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	109 // counter value.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	110 cyg_uint32 current_value_lo();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	111 cyg_uint32 current_value_hi();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	112
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	113 // Set the counter's current value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	114 void set_value( cyg_tick_count new_value);
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	115
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	116 // Advance counter by some number of ticks
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	117 void tick( cyg_uint32 ticks = 1);
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	118
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	119 // Add an alarm to this counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	120 void add_alarm( Cyg_Alarm *alarm );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	121
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	122 // Remove an alarm from this counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	123 void rem_alarm( Cyg_Alarm *alarm );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	124
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	125 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	126
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	127 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	128 // Clock class. This is derived from a Counter and defines extra
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	129 // features to support clock-like behaviour.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	130
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	131 class Cyg_Clock
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	132 : public Cyg_Counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	133 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	134
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	135 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	136
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	137 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	138
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	139 // This structure allows a more accurate representation
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	140 // of the resolution than a single integer would allow.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	141 // The resolution is defined as dividend/divisor nanoseconds
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	142 // per tick.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	143 struct cyg_resolution {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	144 cyg_uint32 dividend;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	145 cyg_uint32 divisor;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	146 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	147
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	148 private:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	149
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	150 cyg_resolution resolution; // Current clock resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	151
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	152 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	153
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	154 Cyg_Clock( // Create clock with given resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	155 cyg_resolution resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	156 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	157
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	158 ~Cyg_Clock(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	159
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	160 cyg_resolution get_resolution(); // Return current resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	161
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	162 void set_resolution( // Set new resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	163 cyg_resolution resolution
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	164 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	165
64 c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	166 // There is a need for converting from "other" ticks to clock ticks.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	167 // We will construct 4 numbers to do the conversion as:
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	168 // clock_ticks = (((otherticksmul1)/div1)mul2/div2)
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	169 // with the values chosen to minimize the possibility of overflow.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	170 // Do the arithmetic in cyg_uint64s throughout.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	171 struct converter {
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	172 cyg_uint64 mul1, div1, mul2, div2;
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	173 };
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	174
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	175 // There are two of these because the 4 numbers are different depending
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	176 // on the direction of the conversion, to prevent loss of significance.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	177 // NB these relate to the resolution of the clock object they are
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	178 // called against, not necessarily "the" system real time clock.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	179 void get_other_to_clock_converter( cyg_uint64 ns_per_other_tick,
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	180 struct converter *pcc );
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	181
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	182 void get_clock_to_other_converter( cyg_uint64 ns_per_other_tick,
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	183 struct converter *pcc );
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	184
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	185 // A utility to perform the conversion in the obvious way, with
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	186 // rounding to nearest at each stage. Static because it uses a
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	187 // previously acquired converter.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	188 static cyg_tick_count convert( cyg_tick_count value,
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	189 struct converter *pcc );
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT jlarmour parents: 62 diff changeset	190
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	191 #ifdef CYGVAR_KERNEL_COUNTERS_CLOCK
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	192
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	193 // There is a system supplied real time clock...
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	194
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	195 static Cyg_Clock *real_time_clock;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	196
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	197 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	198
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	199 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	200
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	201 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	202 // Alarm class. An alarm may be attached to a counter (or a clock) to be
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	203 // called when the trigger value is reached.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	204
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	205 class Cyg_Alarm
148 8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	206 #if defined(CYGIMP_KERNEL_COUNTERS_SINGLE_LIST) \|\| defined(CYGIMP_KERNEL_COUNTERS_MULTI_LIST)
8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	207 : public Cyg_DNode_T<Cyg_Alarm>
8f2f7615e727 Merge from eCos master repository on 2001-01-12-06:43:03-GMT jlarmour parents: 115 diff changeset	208 #endif
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	209 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	210 friend class Cyg_Counter;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	211
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	212 protected:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	213 Cyg_Counter *counter; // Attached to this counter/clock
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	214
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	215 cyg_alarm_fn *alarm; // Call-back function
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	216
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	217 CYG_ADDRWORD data; // Call-back data
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	218
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	219 cyg_tick_count trigger; // Absolute trigger time
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	220
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	221 cyg_tick_count interval; // Retrigger interval
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	222
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	223 cyg_bool enabled; // True if enabled
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	224
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	225 Cyg_Alarm();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	226
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	227 void synchronize( void ); // deal with times in the past,
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	228 // make next alarm in synch.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	229
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	230 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	231
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	232 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	233
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	234 Cyg_Alarm // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	235 (
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	236 Cyg_Counter *counter, // Attached to this counter
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	237 cyg_alarm_fn *alarm, // Call-back function
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	238 CYG_ADDRWORD data // Call-back data
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	239 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	240
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	241 ~Cyg_Alarm(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	242
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	243 void initialize( // Initialize Alarm
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	244 cyg_tick_count trigger, // Absolute trigger time
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	245 cyg_tick_count interval = 0 // Relative retrigger interval
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	246 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	247
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	248 void enable(); // Ensure alarm enabled
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	249
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	250 void disable(); // Ensure alarm disabled
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	251
115 6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	252 void get_times(
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	253 cyg_tick_count *trigger, // Next trigger time
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	254 cyg_tick_count *interval // Current interval
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	255 );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	256 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	257
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	258 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	259
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	260 #endif // ifndef CYGONCE_KERNEL_CLOCK_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	261 // EOF clock.hxx

Mercurial > flash_v2

annotate packages/kernel/current/include/clock.hxx @ 210:d2c90368aeef