summaryrefslogtreecommitdiff
path: root/usr/src/uts/sun4u/io/todstarcat.c
blob: a203ee27e6798cbc94d5fc42d26c1b04b04f4e5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident	"%Z%%M%	%I%	%E% SMI"

/*
 * tod driver module for Starcat
 * This module implements a soft tod since
 * starcat has no tod part.
 */

#include <sys/types.h>
#include <sys/param.h>
#include <sys/sysmacros.h>
#include <sys/systm.h>
#include <sys/errno.h>
#include <sys/modctl.h>
#include <sys/autoconf.h>
#include <sys/debug.h>
#include <sys/clock.h>
#include <sys/cmn_err.h>
#include <sys/promif.h>
#include <sys/cpuvar.h>
#include <sys/sunddi.h>
#include <sys/iosramio.h>
#include <sys/domaind.h>

#define	abs(x)	((x) < 0 ? -(x) : (x))

#define	TODSC_SET_THRESHOLD	30

static timestruc_t	todsc_get(void);
static void		todsc_set(timestruc_t);
static uint_t		todsc_set_watchdog_timer(uint_t);
static uint_t		todsc_clear_watchdog_timer(void);
static void		todsc_set_power_alarm(timestruc_t);
static void		todsc_clear_power_alarm(void);
static uint64_t		todsc_get_cpufrequency(void);

/*
 * Module linkage information for the kernel.
 */
static struct modlmisc modlmisc = {
	&mod_miscops, "Soft tod module for Sun Fire 15000"
};

static struct modlinkage modlinkage = {
	MODREV_1, (void *)&modlmisc, NULL
};

static uint32_t heartbeat = 0;

int
_init(void)
{
	if (strcmp(tod_module_name, "todstarcat") == 0) {
		uint32_t ssc_time32 = 0;
		char obp_string[40];

		/*
		 * To obtain the initial start of day time, we use an
		 * OBP callback; this is because the iosram is not yet
		 * accessible from the OS at this early stage of startup.
		 */

		/*
		 * Set the string to pass to OBP
		 * for now, we assume we always get a 32bit value
		 */
		(void) sprintf(obp_string, "h# %p unix-gettod",
			(void *) &ssc_time32);

		prom_interpret(obp_string, 0, 0, 0, 0, 0);

		hrestime.tv_sec = (time_t)ssc_time32;

		/*
		 * A date of zero causes the root filesystem driver
		 * to try to set the date from the last shutdown.
		 */

		/*
		 * Check for a zero date.
		 */
		if (ssc_time32 == 0) {
			cmn_err(CE_WARN, "Initial date is invalid.");
			cmn_err(CE_CONT, "Attempting to set the date and time "
				"based on the last shutdown.\n");
			cmn_err(CE_CONT, "Please inspect the date and time and "
				"correct if necessary.\n");
		}

		/*
		 * Check that the date has not overflowed a 32-bit integer.
		 */
		if (TIMESPEC_OVERFLOW(&hrestime)) {
			cmn_err(CE_WARN, "Date overflow detected.");
			cmn_err(CE_CONT, "Attempting to set the date and time "
				"based on the last shutdown.\n");
			cmn_err(CE_CONT, "Please inspect the date and time and "
				"correct if necessary.\n");

			hrestime.tv_sec = (time_t)0;
		}

		tod_ops.tod_get = todsc_get;
		tod_ops.tod_set = todsc_set;
		tod_ops.tod_set_watchdog_timer = todsc_set_watchdog_timer;
		tod_ops.tod_clear_watchdog_timer = todsc_clear_watchdog_timer;
		tod_ops.tod_set_power_alarm = todsc_set_power_alarm;
		tod_ops.tod_clear_power_alarm = todsc_clear_power_alarm;
		tod_ops.tod_get_cpufrequency = todsc_get_cpufrequency;

		/*
		 * Flag warning if user tried to use hardware watchdog
		 */
		if (watchdog_enable) {
			cmn_err(CE_WARN, "Hardware watchdog unavailable");
		}
	}

	return (mod_install(&modlinkage));
}

int
_fini(void)
{
	if (strcmp(tod_module_name, "todstarcat") == 0)
		return (EBUSY);
	else
		return (mod_remove(&modlinkage));
}

int
_info(struct modinfo *modinfop)
{
	return (mod_info(&modlinkage, modinfop));
}


/*
 * Starcat tod_get is simplified to return hrestime and to
 * update the domain heartbeat.
 * Must be called with tod_lock held.
 */
static timestruc_t
todsc_get(void)
{
	ASSERT(MUTEX_HELD(&tod_lock));

	heartbeat++;
	(void) iosram_wr(DOMD_MAGIC, DOMD_HEARTBEAT_OFFSET,
		sizeof (uint32_t), (caddr_t)&heartbeat);
	return (hrestime);
}

/*
 * Must be called with tod_lock held.
 *
 * When running NTP, tod_set is called at least once per second in order
 * to update the hardware clock - for Starcat, we don't want to sync
 * the non-existent hardware clock, and only want to record significant
 * time changes on the SC (i.e. when date(1M) is run).  So, we have a
 * threshold requirement before recording the time change.
 */
/* ARGSUSED */
static void
todsc_set(timestruc_t ts)
{
	char obp_string[40];

	ASSERT(MUTEX_HELD(&tod_lock));

	heartbeat++;
	(void) iosram_wr(DOMD_MAGIC, DOMD_HEARTBEAT_OFFSET,
		sizeof (uint32_t), (caddr_t)&heartbeat);

	if (abs(hrestime.tv_sec - ts.tv_sec) > TODSC_SET_THRESHOLD) {
		/*
		 * Update the SSC with the new UTC domain time
		 */
		(void) sprintf(obp_string, "h# %x unix-settod",
			(int)ts.tv_sec);

		prom_interpret(obp_string, 0, 0, 0, 0, 0);
#ifdef DEBUG
		cmn_err(CE_NOTE, "todsc_set: new domain time 0x%lx\n",
			ts.tv_sec);
#endif
	}
}

/*
 * No watchdog function.
 */
/* ARGSUSED */
static uint_t
todsc_set_watchdog_timer(uint_t timeoutval)
{
	ASSERT(MUTEX_HELD(&tod_lock));
	return (0);
}

/*
 * No watchdog function
 */
static uint_t
todsc_clear_watchdog_timer(void)
{
	ASSERT(MUTEX_HELD(&tod_lock));
	return (0);
}

/*
 * Null function.
 */
/* ARGSUSED */
static void
todsc_set_power_alarm(timestruc_t ts)
{
	ASSERT(MUTEX_HELD(&tod_lock));
}

/*
 * Null function
 */
static void
todsc_clear_power_alarm()
{
	ASSERT(MUTEX_HELD(&tod_lock));
}

/*
 * Get clock freq from the cpunode.  This function is only called
 * when use_stick = 0, otherwise, system_clock_freq gets used instead.
 */
uint64_t
todsc_get_cpufrequency(void)
{
	return (cpunodes[CPU->cpu_id].clock_freq);
}