1/*	$OpenBSD: clock.h,v 1.2 2008/06/26 05:42:12 ray Exp $	*/
2/*	$NetBSD: clock.h,v 1.2 2002/04/28 17:10:33 uch Exp $	*/
3
4/*-
5 * Copyright (c) 2002 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by UCHIYAMA Yasushi.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * void sh_clock_init(int flags, struct rtc_ops *):
35 *   flags:
36 *	SH_CLOCK_NORTC		... If SH RTC module is disabled, set this.
37 *				    internal module don't use RTCCLK.
38 *	SH_CLOCK_NOINITTODR	... Don't initialize RTC time.
39 *   rtc_ops:
40 *	Machine dependent RTC ops pointer. If NULL is specified, use SH
41 *	internal RTC.
42 *
43 * void machine_clock_init(void):
44 *	Implement machine specific part of clock routines.
45 *	must call sh_clock_init() at exit.
46 *
47 * int sh_clock_get_cpuclock(void):
48 *	returns CPU clock estimated by sh_clock_init().
49 *
50 * int sh_clock_get_pclock(void):
51 *	returns PCLOCK. when PCLOCK is not specified by kernel configuration
52 *	file, this value is estimated by sh_clock_init().
53 *
54 */
55struct rtc_ops;
56struct clock_ymdhms;
57
58void sh_clock_init(int, struct rtc_ops *);
59#define	SH_CLOCK_NORTC			0x00000001
60#define	SH_CLOCK_NOINITTODR		0x00000002
61void machine_clock_init(void);
62
63int sh_clock_get_cpuclock(void);
64int sh_clock_get_pclock(void);
65
66/*
67 * SH RTC module interface.
68 */
69void sh_rtc_init(void *);
70void sh_rtc_get(void *, time_t, struct clock_ymdhms *);
71void sh_rtc_set(void *, struct clock_ymdhms *);
72
73/*
74 * machine specific RTC ops
75 */
76struct clock_ymdhms;
77struct rtc_ops {
78	void *_cookie;
79	void (*init)(void *);
80	void (*get)(void *, time_t, struct clock_ymdhms *);
81	void (*set)(void *, struct clock_ymdhms *);
82};
83
84