1/*-
2 * Copyright (c) 1996 The NetBSD Foundation, Inc.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Gordon W. Ross
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 *
29 *	$NetBSD: clock_subr.h,v 1.7 2000/10/03 13:41:07 tsutsui Exp $
30 *
31 *
32 * This file is the central clearing-house for calendrical issues.
33 *
34 * In general the kernel does not know about minutes, hours, days, timezones,
35 * daylight savings time, leap-years and such.  All that is theoretically a
36 * matter for userland only.
37 *
38 * Parts of kernel code does however care: badly designed filesystems store
39 * timestamps in local time and RTC chips sometimes track time in a local
40 * timezone instead of UTC and so on.
41 *
42 * All that code should go here for service.
43 *
44 * $FreeBSD$
45 */
46
47#ifndef _SYS_CLOCK_H_
48#define _SYS_CLOCK_H_
49
50#ifdef _KERNEL		/* No user serviceable parts */
51
52/*
53 * Timezone info from settimeofday(2), usually not used
54 */
55extern int tz_minuteswest;
56extern int tz_dsttime;
57
58int utc_offset(void);
59
60/*
61 * Structure to hold the values typically reported by time-of-day clocks.
62 * This can be passed to the generic conversion functions to be converted
63 * to a struct timespec.
64 */
65struct clocktime {
66	int	year;			/* year (4 digit year) */
67	int	mon;			/* month (1 - 12) */
68	int	day;			/* day (1 - 31) */
69	int	hour;			/* hour (0 - 23) */
70	int	min;			/* minute (0 - 59) */
71	int	sec;			/* second (0 - 59) */
72	int	dow;			/* day of week (0 - 6; 0 = Sunday) */
73	long	nsec;			/* nano seconds */
74};
75
76int clock_ct_to_ts(struct clocktime *, struct timespec *);
77void clock_ts_to_ct(struct timespec *, struct clocktime *);
78void clock_register(device_t, long);
79
80/*
81 * BCD to decimal and decimal to BCD.
82 */
83#define	FROMBCD(x)	bcd2bin(x)
84#define	TOBCD(x)	bin2bcd(x)
85
86/* Some handy constants. */
87#define SECDAY		(24 * 60 * 60)
88#define SECYR		(SECDAY * 365)
89
90/* Traditional POSIX base year */
91#define	POSIX_BASE_YEAR	1970
92
93void timespec2fattime(struct timespec *tsp, int utc, u_int16_t *ddp, u_int16_t *dtp, u_int8_t *dhp);
94void fattime2timespec(unsigned dd, unsigned dt, unsigned dh, int utc, struct timespec *tsp);
95
96#endif /* _KERNEL */
97
98#endif /* !_SYS_CLOCK_H_ */
99