xref: /illumos-gate/usr/src/uts/i86pc/sys/machclock.h (revision 42b53e0fbc5c05289c3d334bb864b784fafe5ce4)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SYS_MACHCLOCK_H
28 #define	_SYS_MACHCLOCK_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /*
35  * tod module name and operations
36  */
37 
38 struct tod_ops;
39 typedef struct tod_ops tod_ops_t;
40 
41 /*
42  * TOD Ops.
43  * The only functions that _must_ be defined are the tod_get() and
44  * tod_set() functions.  All others may be unused, and need to be
45  * checked for NULL before using.
46  */
47 struct tod_ops {
48 	int		tod_version;
49 	timestruc_t	(*tod_get)(tod_ops_t *);
50 	void		(*tod_set)(tod_ops_t *, timestruc_t);
51 	uint_t		(*tod_set_watchdog_timer)(tod_ops_t *, int);
52 	uint_t		(*tod_clear_watchdog_timer)(tod_ops_t *);
53 	void		(*tod_set_wake_alarm)(tod_ops_t *, int);
54 	void		(*tod_clear_wake_alarm)(tod_ops_t *);
55 	struct tod_ops	*tod_next;
56 };
57 
58 #define	TOD_OPS_VERSION	1
59 
60 extern tod_ops_t	*tod_ops;
61 extern char		*tod_module_name;
62 
63 #define	TODOP_GET(top)		((top)->tod_get(top))
64 #define	TODOP_SET(top, ts)	((top)->tod_set(top, ts))
65 #define	TODOP_SETWD(top, nsec)	((top)->tod_set_watchdog_timer(top, nsec))
66 #define	TODOP_CLRWD(top)	((top)->tod_clear_watchdog_timer(top))
67 #define	TODOP_SETWAKE(top, nsec) ((top)->tod_set_wake_alarm(top, nsec))
68 #define	TODOP_CLRWAKE(top)	((top)->tod_clear_wake_alarm(top))
69 
70 #ifdef	__cplusplus
71 }
72 #endif
73 
74 #endif	/* _SYS_MACHCLOCK_H */
75