summaryrefslogtreecommitdiffstats
path: root/c/src/exec/score/include/rtems/score/tod.h
blob: 6c1e9d0e57885e53bcb1fa7992259be18c228e7e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*  tod.h
 *
 *  This include file contains all the constants and structures associated
 *  with the Time of Day Handler.
 *
 *  COPYRIGHT (c) 1989-1997.
 *  On-Line Applications Research Corporation (OAR).
 *  Copyright assigned to U.S. Government, 1994.
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.OARcorp.com/rtems/license.html.
 *
 *  $Id$
 */

#ifndef __TIME_OF_DAY_h
#define __TIME_OF_DAY_h

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/score/object.h>
#include <rtems/score/watchdog.h>

/*
 *  The following constants are related to the time of day.
 */

#define TOD_SECONDS_PER_MINUTE 60
#define TOD_MINUTES_PER_HOUR   60
#define TOD_MONTHS_PER_YEAR    12
#define TOD_DAYS_PER_YEAR      365
#define TOD_HOURS_PER_DAY      24
#define TOD_SECONDS_PER_DAY    (TOD_SECONDS_PER_MINUTE * \
                                TOD_MINUTES_PER_HOUR   * \
                                TOD_HOURS_PER_DAY)

#define TOD_SECONDS_PER_NON_LEAP_YEAR (365 * TOD_SECONDS_PER_DAY)

#define TOD_MILLISECONDS_PER_SECOND     1000
#define TOD_MICROSECONDS_PER_SECOND     1000000
#define TOD_NANOSECONDS_PER_SECOND      1000000000
#define TOD_NANOSECONDS_PER_MICROSECOND 1000

/*
 *  The following constant define the earliest year to which an
 *  time of day can be initialized.  This is considered the
 *  epoch.
 */

#define TOD_BASE_YEAR 1988

/*
 *  The following record defines the time of control block.  This
 *  control block is used to maintain the current time of day.
 */

typedef struct {                   /* RTEID style time/date */
  unsigned32 year;                 /* year, A.D. */
  unsigned32 month;                /* month, 1 -> 12 */
  unsigned32 day;                  /* day, 1 -> 31 */
  unsigned32 hour;                 /* hour, 0 -> 23 */
  unsigned32 minute;               /* minute, 0 -> 59 */
  unsigned32 second;               /* second, 0 -> 59 */
  unsigned32 ticks;                /* elapsed ticks between secs */
}   TOD_Control;

/*
 *  The following is TRUE if the application has set the current
 *  time of day, and FALSE otherwise.
 */

SCORE_EXTERN boolean _TOD_Is_set;

/*
 *  The following contains the current time of day.
 */

SCORE_EXTERN TOD_Control _TOD_Current;

/*
 *  The following contains the number of seconds from 00:00:00
 *  January 1, TOD_BASE_YEAR until the current time of day.
 */

SCORE_EXTERN Watchdog_Interval _TOD_Seconds_since_epoch;

/*
 *  The following contains the number of microseconds per tick.
 */

SCORE_EXTERN unsigned32 _TOD_Microseconds_per_tick;

/*
 *  The following contains the number of clock ticks per second.
 *
 *  NOTE:
 *
 *  If one second is NOT evenly divisible by the number of microseconds
 *  per clock tick, this value will contain only the integer portion
 *  of the division.  This means that the interval between clock ticks
 *  can be a source of error in the current time of day.
 */

SCORE_EXTERN unsigned32 _TOD_Ticks_per_second;

/*
 *  This is the control structure for the watchdog timer which
 *  fires to service the seconds chain.
 */

SCORE_EXTERN Watchdog_Control _TOD_Seconds_watchdog;

#ifdef SCORE_INIT

/*
 *  The following array contains the number of days in all months.
 *  The first dimension should be 1 for leap years, and 0 otherwise.
 *  The second dimension should range from 1 to 12 for January to
 *  February, respectively.
 */

const unsigned32 _TOD_Days_per_month[ 2 ][ 13 ] = {
  { 0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 },
  { 0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
};

/*
 *  The following array contains the number of days in all months
 *  up to the month indicated by the index of the second dimension.
 *  The first dimension should be 1 for leap years, and 0 otherwise.
 */

const unsigned16 _TOD_Days_to_date[2][13] = {
  { 0, 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 },
  { 0, 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335 }
};

/*
 *  The following array contains the number of days in the years
 *  since the last leap year.  The index should be 0 for leap
 *  years, and the number of years since the beginning of a leap
 *  year otherwise.
 */

const unsigned16 _TOD_Days_since_last_leap_year[4] = { 0, 366, 761, 1126 };

#else

extern const unsigned16 _TOD_Days_to_date[2][13]; /* Julian days */
extern const unsigned16 _TOD_Days_since_last_leap_year[4];
extern const unsigned32 _TOD_Days_per_month[2][13];

#endif

/*
 *  _TOD_Handler_initialization
 *
 *  DESCRIPTION:
 *
 *  This routine performs the initialization necessary for this handler.
 */

void _TOD_Handler_initialization(
  unsigned32 microseconds_per_tick
);

/*
 *  _TOD_Set
 *
 *  DESCRIPTION:
 *
 *  This routine sets the current time of day to THE_TOD and
 *  the equivalent SECONDS_SINCE_EPOCH.
 */

void _TOD_Set(
  TOD_Control       *the_tod,
  Watchdog_Interval  seconds_since_epoch
);

/*
 *  _TOD_Validate
 *
 *  DESCRIPTION:
 *
 *  This function returns TRUE if THE_TOD contains
 *  a valid time of day, and FALSE otherwise.
 */

boolean _TOD_Validate(
  TOD_Control *the_tod
);

/*
 *  _TOD_To_seconds
 *
 *  DESCRIPTION:
 *
 *  This function returns the number seconds between the epoch and THE_TOD.
 */

Watchdog_Interval _TOD_To_seconds(
  TOD_Control *the_tod
);

/*
 *  _TOD_Tickle
 *
 *  DESCRIPTION:
 *
 *  This routine is scheduled as a watchdog function and is invoked at
 *  each second boundary.  It updates the current time of day to indicate
 *  that a second has passed and processes the seconds watchdog chain.
 */

void _TOD_Tickle(
  Objects_Id  id,
  void       *ignored
);

/*
 *  TOD_MILLISECONDS_TO_MICROSECONDS
 *
 *  DESCRIPTION:
 *
 *  This routine converts an interval expressed in milliseconds to microseconds.
 *
 *  NOTE:
 *
 *  This must be a macro so it can be used in "static" tables.
 */

#define TOD_MILLISECONDS_TO_MICROSECONDS(_ms) ((_ms) * 1000)

/*
 *  TOD_MICROSECONDS_TO_TICKS
 *
 *  DESCRIPTION:
 *
 *  This routine converts an interval expressed in microseconds to ticks.
 *
 *  NOTE:
 *
 *  This must be a macro so it can be used in "static" tables.
 */

#define TOD_MICROSECONDS_TO_TICKS(_us) \
    ((_us) / _TOD_Microseconds_per_tick)

/*
 *  TOD_MILLISECONDS_TO_TICKS
 *
 *  DESCRIPTION:
 *
 *  This routine converts an interval expressed in milliseconds to ticks.
 *
 *  NOTE:
 *
 *  This must be a macro so it can be used in "static" tables.
 */

#define TOD_MILLISECONDS_TO_TICKS(_ms) \
    (TOD_MILLISECONDS_TO_MICROSECONDS(_ms) / _TOD_Microseconds_per_tick)

#ifndef __RTEMS_APPLICATION__
#include <rtems/score/tod.inl>
#endif

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */