clock.h revision 163646 
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 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *        This product includes software developed by the NetBSD
19 *        Foundation, Inc. and its contributors.
20 * 4. Neither the name of The NetBSD Foundation nor the names of its
21 *    contributors may be used to endorse or promote products derived
22 *    from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
25 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
28 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 *
36 *	$NetBSD: clock_subr.h,v 1.7 2000/10/03 13:41:07 tsutsui Exp $
37 *
38 * $FreeBSD: head/sys/sys/clock.h 163646 2006-10-24 10:27:23Z phk $
39 */
40
41#ifndef _SYS_CLOCK_H_
42#define _SYS_CLOCK_H_
43
44#ifdef _KERNEL		/* No user serviceable parts */
45
46/*
47 * Kernel to clock driver interface.
48 */
49void	inittodr(time_t base);
50void	resettodr(void);
51void	startrtclock(void);
52
53extern int	disable_rtc_set;
54
55/*
56 * Timezone info from settimeofday(2), usually not used
57 */
58extern int tz_minuteswest;
59extern int tz_dsttime;
60
61int utc_offset(void);
62
63/*
64 * Structure to hold the values typically reported by time-of-day clocks.
65 * This can be passed to the generic conversion functions to be converted
66 * to a struct timespec.
67 */
68struct clocktime {
69	int	year;			/* year (4 digit year) */
70	int	mon;			/* month (1 - 12) */
71	int	day;			/* day (1 - 31) */
72	int	hour;			/* hour (0 - 23) */
73	int	min;			/* minute (0 - 59) */
74	int	sec;			/* second (0 - 59) */
75	int	dow;			/* day of week (0 - 6; 0 = Sunday) */
76	long	nsec;			/* nano seconds */
77};
78
79int clock_ct_to_ts(struct clocktime *, struct timespec *);
80void clock_ts_to_ct(struct timespec *, struct clocktime *);
81void clock_register(device_t, long);
82
83/*
84 * BCD to decimal and decimal to BCD.
85 */
86#define	FROMBCD(x)	bcd2bin(x)
87#define	TOBCD(x)	bin2bcd(x)
88
89/* Some handy constants. */
90#define SECDAY		(24 * 60 * 60)
91#define SECYR		(SECDAY * 365)
92
93/* Traditional POSIX base year */
94#define	POSIX_BASE_YEAR	1970
95
96void timespec2fattime(struct timespec *tsp, int utc, u_int16_t *ddp, u_int16_t *dtp, u_int8_t *dhp);
97void fattime2timespec(unsigned dd, unsigned dt, unsigned dh, int utc, struct timespec *tsp);
98
99#endif /* _KERNEL */
100
101#endif /* !_SYS_CLOCK_H_ */
102