2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1996 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
31 * $NetBSD: clock_subr.h,v 1.7 2000/10/03 13:41:07 tsutsui Exp $
34 * This file is the central clearing-house for calendrical issues.
36 * In general the kernel does not know about minutes, hours, days, timezones,
37 * daylight savings time, leap-years and such. All that is theoretically a
38 * matter for userland only.
40 * Parts of kernel code does however care: badly designed filesystems store
41 * timestamps in local time and RTC chips sometimes track time in a local
42 * timezone instead of UTC and so on.
44 * All that code should go here for service.
52 #ifdef _KERNEL /* No user serviceable parts */
55 * Timezone info from settimeofday(2), usually not used
57 extern int tz_minuteswest;
58 extern int tz_dsttime;
63 * Structure to hold the values typically reported by time-of-day clocks.
64 * This can be passed to the generic conversion functions to be converted
65 * to a struct timespec.
68 int year; /* year (4 digit year) */
69 int mon; /* month (1 - 12) */
70 int day; /* day (1 - 31) */
71 int hour; /* hour (0 - 23) */
72 int min; /* minute (0 - 59) */
73 int sec; /* second (0 - 59) */
74 int dow; /* day of week (0 - 6; 0 = Sunday) */
75 long nsec; /* nano seconds */
78 int clock_ct_to_ts(struct clocktime *, struct timespec *);
79 void clock_ts_to_ct(struct timespec *, struct clocktime *);
82 * Time-of-day clock functions and flags. These functions might sleep.
84 * clock_register and clock_unregister() do what they say. Upon return from
85 * unregister, the clock's methods are not running and will not be called again.
87 * clock_schedule() requests that a registered clock's clock_settime() calls
88 * happen at the given offset into the second. The default is 0, meaning no
89 * specific scheduling. To schedule the call as soon after top-of-second as
90 * possible, specify 1. Each clock has its own schedule, but taskqueue_thread
91 * is shared by many tasks; the timing of the call is not guaranteed.
95 * CLOCKF_SETTIME_NO_TS
96 * Do not pass a timespec to clock_settime(), the driver obtains its own time
97 * and applies its own adjustments (this flag implies CLOCKF_SETTIME_NO_ADJ).
99 * CLOCKF_SETTIME_NO_ADJ
100 * Do not apply utc offset and resolution/accuracy adjustments to the value
101 * passed to clock_settime(), the driver applies them itself.
103 * CLOCKF_GETTIME_NO_ADJ
104 * Do not apply utc offset and resolution/accuracy adjustments to the value
105 * returned from clock_gettime(), the driver has already applied them.
108 #define CLOCKF_SETTIME_NO_TS 0x00000001
109 #define CLOCKF_SETTIME_NO_ADJ 0x00000002
110 #define CLOCKF_GETTIME_NO_ADJ 0x00000004
112 void clock_register(device_t _clockdev, long _resolution_us);
113 void clock_register_flags(device_t _clockdev, long _resolution_us, int _flags);
114 void clock_schedule(device_t clockdev, u_int _offsetns);
115 void clock_unregister(device_t _clockdev);
118 * BCD to decimal and decimal to BCD.
120 #define FROMBCD(x) bcd2bin(x)
121 #define TOBCD(x) bin2bcd(x)
123 /* Some handy constants. */
124 #define SECDAY (24 * 60 * 60)
125 #define SECYR (SECDAY * 365)
127 /* Traditional POSIX base year */
128 #define POSIX_BASE_YEAR 1970
130 void timespec2fattime(struct timespec *tsp, int utc, u_int16_t *ddp, u_int16_t *dtp, u_int8_t *dhp);
131 void fattime2timespec(unsigned dd, unsigned dt, unsigned dh, int utc, struct timespec *tsp);
135 #endif /* !_SYS_CLOCK_H_ */