xref: /netbsd-src/sys/arch/sh3/include/clock.h (revision f420183a0ebea8496b4e82857ec1eb1fccb1c28a)
1 /*	$NetBSD: clock.h,v 1.5 2020/07/11 03:53:32 uwe Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by UCHIYAMA Yasushi.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
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.
18  *
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.
30  */
31 
32 /*
33  * void sh_clock_init(int flags):
34  *   flags:
35  *	SH_CLOCK_NORTC		... If SH RTC module is disabled, set this.
36  *				    internal module don't use RTCCLK.
37  *	SH_CLOCK_NOINITTODR	... Don't initialize RTC time.
38  *
39  * void machine_clock_init(void):
40  *	Implement machine specific part of clock routines.
41  *	must call sh_clock_init() at exit.
42  *
43  * int sh_clock_get_cpuclock(void):
44  *	returns CPU clock estimated by sh_clock_init().
45  *
46  * int sh_clock_get_pclock(void):
47  *	returns PCLOCK. when PCLOCK is not specified by kernel configuration
48  *	file, this value is estimated by sh_clock_init().
49  *
50  */
51 #ifndef _SH3_CLOCK_H_
52 #define _SH3_CLOCK_H_
53 
54 void machine_clock_init(void);
55 
56 void sh_clock_init(int);
57 #define	SH_CLOCK_NORTC			0x00000001
58 #define	SH_CLOCK_NOINITTODR		0x00000002
59 
60 int sh_clock_get_cpuclock(void);
61 int sh_clock_get_pclock(void);
62 
63 #endif /* _SH3_CLOCK_H_ */
64