Home | History | Annotate | Line # | Download | only in include
clock.h revision 1.2 
      1 /*	$NetBSD: clock.h,v 1.2 2002/04/28 17:10:33 uch 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  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * void sh_clock_init(int flags, struct rtc_ops *):
     41  *   flags:
     42  *	SH_CLOCK_NORTC		... If SH RTC module is disabled, set this.
     43  *				    internal module don't use RTCCLK.
     44  *	SH_CLOCK_NOINITTODR	... Don't initialize RTC time.
     45  *   rtc_ops:
     46  *	Machine dependent RTC ops pointer. If NULL is specified, use SH
     47  *	internal RTC.
     48  *
     49  * void machine_clock_init(void):
     50  *	Implement machine specific part of clock routines.
     51  *	must call sh_clock_init() at exit.
     52  *
     53  * int sh_clock_get_cpuclock(void):
     54  *	returns CPU clock estimated by sh_clock_init().
     55  *
     56  * int sh_clock_get_pclock(void):
     57  *	returns PCLOCK. when PCLOCK is not specified by kernel configuration
     58  *	file, this value is estimated by sh_clock_init().
     59  *
     60  */
     61 struct rtc_ops;
     62 struct clock_ymdhms;
     63 
     64 void sh_clock_init(int, struct rtc_ops *);
     65 #define	SH_CLOCK_NORTC			0x00000001
     66 #define	SH_CLOCK_NOINITTODR		0x00000002
     67 void machine_clock_init(void);
     68 
     69 int sh_clock_get_cpuclock(void);
     70 int sh_clock_get_pclock(void);
     71 
     72 /*
     73  * SH RTC module interface.
     74  */
     75 void sh_rtc_init(void *);
     76 void sh_rtc_get(void *, time_t, struct clock_ymdhms *);
     77 void sh_rtc_set(void *, struct clock_ymdhms *);
     78 
     79 /*
     80  * machine specific RTC ops
     81  */
     82 struct clock_ymdhms;
     83 struct rtc_ops {
     84 	void *_cookie;
     85 	void (*init)(void *);
     86 	void (*get)(void *, time_t, struct clock_ymdhms *);
     87 	void (*set)(void *, struct clock_ymdhms *);
     88 };
     89 
     90