annotate packages/io/wallclock/current/src/wallclock.cxx @ 208:e0c0827131d1 ecos

Merge from eCos master repository on 2002-05-20-20:11:54-BST
author jlarmour
date Mon, 20 May 2002 22:19:26 +0000
parents 289bf90c6a9b
children d2c90368aeef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
1 //==========================================================================
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
2 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
3 // devs/wallclock/wallclock.cxx
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
4 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
5 // Wallclock base
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
6 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
7 //==========================================================================
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
8 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
9 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
10 // 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: 138
diff changeset
11 // 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: 138
diff changeset
12 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
13 // 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: 138
diff changeset
14 // 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: 138
diff changeset
15 // 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: 138
diff changeset
16 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
17 // 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: 138
diff changeset
18 // 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: 138
diff changeset
19 // 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: 138
diff changeset
20 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
21 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
22 // 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: 138
diff changeset
23 // 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: 138
diff changeset
24 // 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: 138
diff changeset
25 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
26 // 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: 138
diff changeset
27 // 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: 138
diff changeset
28 // 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: 138
diff changeset
29 // 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: 138
diff changeset
30 // 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: 138
diff changeset
31 // 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: 138
diff changeset
32 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
33 // 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: 138
diff changeset
34 // 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: 138
diff changeset
35 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
37 // at http://sources.redhat.com/ecos/ecos-license
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
38 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 138
diff changeset
39 //####ECOSGPLCOPYRIGHTEND####
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
40 //==========================================================================
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
41 //#####DESCRIPTIONBEGIN####
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
42 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
43 // Author(s): jskov
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
44 // Contributors: jskov
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
45 // Date: 2000-03-28
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
46 // Purpose: Wallclock base driver
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
47 // Description: This provides a generic wallclock base driver which
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
48 // relies on sub-drivers to provide the interface functions
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
49 // to the hardware device (see wallclock.hxx for details).
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
50 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
51 // The driver can be configured to run in one of two modes:
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
52 // init-get mode:
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
53 // In this mode, the hardware driver only needs to
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
54 // implement a function to read the hardware clock
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
55 // and a (possibly empty) init function which makes
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
56 // sure the hardware clock is properly initialized.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
57 // While the driver in this mode has a smaller memory
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
58 // foot-print, it does not support battery-backed up
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
59 // clocks.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
60 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
61 // set-get mode:
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
62 // Requires both set and get functions for the hardware
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
63 // device. While bigger, it allows support of
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
64 // battery-backed up clocks.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
65 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
66 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
67 //####DESCRIPTIONEND####
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
68 //
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
69 //==========================================================================
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
70
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
71 #include <pkgconf/wallclock.h> // Wallclock device config
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
72
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
73 #include <cyg/infra/cyg_type.h> // Common type definitions and support
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
74
138
289bf90c6a9b Merge from eCos master repository on 2000-11-24-06:43:05-GMT
jlarmour
parents: 94
diff changeset
75 #include <cyg/hal/drv_api.h> // Driver API
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
76
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
77 #include <cyg/io/wallclock.hxx> // The WallClock API
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
78
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
79
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
80 //-----------------------------------------------------------------------------
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
81 // Local static variables
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
82
84
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 80
diff changeset
83 static Cyg_WallClock wallclock_instance CYGBLD_ATTRIB_INIT_AFTER( CYG_INIT_CLOCK );
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
84
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
85 #ifndef CYGSEM_WALLCLOCK_SET_GET_MODE
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
86 static cyg_uint32 epoch_ticks;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
87 static cyg_uint32 epoch_time_stamp;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
88 #endif
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
89
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
90 Cyg_WallClock *Cyg_WallClock::wallclock;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
91
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
92 //-----------------------------------------------------------------------------
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
93 // Constructor
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
94
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
95 Cyg_WallClock::Cyg_WallClock()
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
96 {
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
97 // install instance pointer
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
98 wallclock = &wallclock_instance;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
99
94
4642a6d35749 Merge from eCos master repository on 2000-06-02-07:47:04-BST
jlarmour
parents: 84
diff changeset
100 // Always allow low-level driver to initialize clock, even though it
4642a6d35749 Merge from eCos master repository on 2000-06-02-07:47:04-BST
jlarmour
parents: 84
diff changeset
101 // may not be necessary for set-get mode.
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
102 init_hw_seconds();
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
103 }
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
104
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
105 //-----------------------------------------------------------------------------
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
106 // Returns the number of seconds elapsed since 1970-01-01 00:00:00.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
107 // This may involve reading the hardware, so it may take anything up to
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
108 // a second to complete.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
109
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
110 cyg_uint32 Cyg_WallClock::get_current_time()
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
111 {
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
112 cyg_uint32 res;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
113
138
289bf90c6a9b Merge from eCos master repository on 2000-11-24-06:43:05-GMT
jlarmour
parents: 94
diff changeset
114 cyg_drv_dsr_lock();
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
115
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
116 #ifdef CYGSEM_WALLCLOCK_SET_GET_MODE
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
117 res = get_hw_seconds();
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
118 #else
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
119 res = epoch_time_stamp + get_hw_seconds() - epoch_ticks;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
120 #endif
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
121
138
289bf90c6a9b Merge from eCos master repository on 2000-11-24-06:43:05-GMT
jlarmour
parents: 94
diff changeset
122 cyg_drv_dsr_unlock();
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
123
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
124 return res;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
125 }
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
126
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
127 //-----------------------------------------------------------------------------
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
128 // Sets the clock. Argument is seconds elapsed since 1970-01-01 00:00:00.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
129 // This may involve reading or writing to the hardware, so it may take
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
130 // anything up to a second to complete.
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
131 void Cyg_WallClock::set_current_time( cyg_uint32 time_stamp )
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
132 {
138
289bf90c6a9b Merge from eCos master repository on 2000-11-24-06:43:05-GMT
jlarmour
parents: 94
diff changeset
133 cyg_drv_dsr_lock();
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
134
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
135 #ifdef CYGSEM_WALLCLOCK_SET_GET_MODE
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
136 set_hw_seconds(time_stamp);
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
137 #else
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
138 epoch_time_stamp = time_stamp;
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
139 epoch_ticks = get_hw_seconds();
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
140 #endif
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
141
138
289bf90c6a9b Merge from eCos master repository on 2000-11-24-06:43:05-GMT
jlarmour
parents: 94
diff changeset
142 cyg_drv_dsr_unlock();
80
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
143 }
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
144
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
145 //-----------------------------------------------------------------------------
2085233a121a Merge from eCos master repository on 2000-04-07-07:52:29-BST
jlarmour
parents:
diff changeset
146 // End of devs/wallclock/wallclock.cxx