xref: /linux/arch/x86/kernel/rtc.c (revision b8bb76713ec50df2f11efee386e16f93d51e1076)
1 /*
2  * RTC related functions
3  */
4 #include <linux/platform_device.h>
5 #include <linux/mc146818rtc.h>
6 #include <linux/acpi.h>
7 #include <linux/bcd.h>
8 #include <linux/pnp.h>
9 
10 #include <asm/vsyscall.h>
11 #include <asm/time.h>
12 
13 #ifdef CONFIG_X86_32
14 /*
15  * This is a special lock that is owned by the CPU and holds the index
16  * register we are working with.  It is required for NMI access to the
17  * CMOS/RTC registers.  See include/asm-i386/mc146818rtc.h for details.
18  */
19 volatile unsigned long cmos_lock;
20 EXPORT_SYMBOL(cmos_lock);
21 #endif /* CONFIG_X86_32 */
22 
23 /* For two digit years assume time is always after that */
24 #define CMOS_YEARS_OFFS 2000
25 
26 DEFINE_SPINLOCK(rtc_lock);
27 EXPORT_SYMBOL(rtc_lock);
28 
29 /*
30  * In order to set the CMOS clock precisely, set_rtc_mmss has to be
31  * called 500 ms after the second nowtime has started, because when
32  * nowtime is written into the registers of the CMOS clock, it will
33  * jump to the next second precisely 500 ms later. Check the Motorola
34  * MC146818A or Dallas DS12887 data sheet for details.
35  *
36  * BUG: This routine does not handle hour overflow properly; it just
37  *      sets the minutes. Usually you'll only notice that after reboot!
38  */
39 int mach_set_rtc_mmss(unsigned long nowtime)
40 {
41 	int real_seconds, real_minutes, cmos_minutes;
42 	unsigned char save_control, save_freq_select;
43 	int retval = 0;
44 
45 	 /* tell the clock it's being set */
46 	save_control = CMOS_READ(RTC_CONTROL);
47 	CMOS_WRITE((save_control|RTC_SET), RTC_CONTROL);
48 
49 	/* stop and reset prescaler */
50 	save_freq_select = CMOS_READ(RTC_FREQ_SELECT);
51 	CMOS_WRITE((save_freq_select|RTC_DIV_RESET2), RTC_FREQ_SELECT);
52 
53 	cmos_minutes = CMOS_READ(RTC_MINUTES);
54 	if (!(save_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
55 		cmos_minutes = bcd2bin(cmos_minutes);
56 
57 	/*
58 	 * since we're only adjusting minutes and seconds,
59 	 * don't interfere with hour overflow. This avoids
60 	 * messing with unknown time zones but requires your
61 	 * RTC not to be off by more than 15 minutes
62 	 */
63 	real_seconds = nowtime % 60;
64 	real_minutes = nowtime / 60;
65 	/* correct for half hour time zone */
66 	if (((abs(real_minutes - cmos_minutes) + 15)/30) & 1)
67 		real_minutes += 30;
68 	real_minutes %= 60;
69 
70 	if (abs(real_minutes - cmos_minutes) < 30) {
71 		if (!(save_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
72 			real_seconds = bin2bcd(real_seconds);
73 			real_minutes = bin2bcd(real_minutes);
74 		}
75 		CMOS_WRITE(real_seconds, RTC_SECONDS);
76 		CMOS_WRITE(real_minutes, RTC_MINUTES);
77 	} else {
78 		printk(KERN_WARNING
79 		       "set_rtc_mmss: can't update from %d to %d\n",
80 		       cmos_minutes, real_minutes);
81 		retval = -1;
82 	}
83 
84 	/* The following flags have to be released exactly in this order,
85 	 * otherwise the DS12887 (popular MC146818A clone with integrated
86 	 * battery and quartz) will not reset the oscillator and will not
87 	 * update precisely 500 ms later. You won't find this mentioned in
88 	 * the Dallas Semiconductor data sheets, but who believes data
89 	 * sheets anyway ...                           -- Markus Kuhn
90 	 */
91 	CMOS_WRITE(save_control, RTC_CONTROL);
92 	CMOS_WRITE(save_freq_select, RTC_FREQ_SELECT);
93 
94 	return retval;
95 }
96 
97 unsigned long mach_get_cmos_time(void)
98 {
99 	unsigned int status, year, mon, day, hour, min, sec, century = 0;
100 
101 	/*
102 	 * If UIP is clear, then we have >= 244 microseconds before
103 	 * RTC registers will be updated.  Spec sheet says that this
104 	 * is the reliable way to read RTC - registers. If UIP is set
105 	 * then the register access might be invalid.
106 	 */
107 	while ((CMOS_READ(RTC_FREQ_SELECT) & RTC_UIP))
108 		cpu_relax();
109 
110 	sec = CMOS_READ(RTC_SECONDS);
111 	min = CMOS_READ(RTC_MINUTES);
112 	hour = CMOS_READ(RTC_HOURS);
113 	day = CMOS_READ(RTC_DAY_OF_MONTH);
114 	mon = CMOS_READ(RTC_MONTH);
115 	year = CMOS_READ(RTC_YEAR);
116 
117 #ifdef CONFIG_ACPI
118 	if (acpi_gbl_FADT.header.revision >= FADT2_REVISION_ID &&
119 	    acpi_gbl_FADT.century)
120 		century = CMOS_READ(acpi_gbl_FADT.century);
121 #endif
122 
123 	status = CMOS_READ(RTC_CONTROL);
124 	WARN_ON_ONCE(RTC_ALWAYS_BCD && (status & RTC_DM_BINARY));
125 
126 	if (RTC_ALWAYS_BCD || !(status & RTC_DM_BINARY)) {
127 		sec = bcd2bin(sec);
128 		min = bcd2bin(min);
129 		hour = bcd2bin(hour);
130 		day = bcd2bin(day);
131 		mon = bcd2bin(mon);
132 		year = bcd2bin(year);
133 	}
134 
135 	if (century) {
136 		century = bcd2bin(century);
137 		year += century * 100;
138 		printk(KERN_INFO "Extended CMOS year: %d\n", century * 100);
139 	} else
140 		year += CMOS_YEARS_OFFS;
141 
142 	return mktime(year, mon, day, hour, min, sec);
143 }
144 
145 /* Routines for accessing the CMOS RAM/RTC. */
146 unsigned char rtc_cmos_read(unsigned char addr)
147 {
148 	unsigned char val;
149 
150 	lock_cmos_prefix(addr);
151 	outb(addr, RTC_PORT(0));
152 	val = inb(RTC_PORT(1));
153 	lock_cmos_suffix(addr);
154 
155 	return val;
156 }
157 EXPORT_SYMBOL(rtc_cmos_read);
158 
159 void rtc_cmos_write(unsigned char val, unsigned char addr)
160 {
161 	lock_cmos_prefix(addr);
162 	outb(addr, RTC_PORT(0));
163 	outb(val, RTC_PORT(1));
164 	lock_cmos_suffix(addr);
165 }
166 EXPORT_SYMBOL(rtc_cmos_write);
167 
168 static int set_rtc_mmss(unsigned long nowtime)
169 {
170 	unsigned long flags;
171 	int retval;
172 
173 	spin_lock_irqsave(&rtc_lock, flags);
174 	retval = set_wallclock(nowtime);
175 	spin_unlock_irqrestore(&rtc_lock, flags);
176 
177 	return retval;
178 }
179 
180 /* not static: needed by APM */
181 unsigned long read_persistent_clock(void)
182 {
183 	unsigned long retval, flags;
184 
185 	spin_lock_irqsave(&rtc_lock, flags);
186 	retval = get_wallclock();
187 	spin_unlock_irqrestore(&rtc_lock, flags);
188 
189 	return retval;
190 }
191 
192 int update_persistent_clock(struct timespec now)
193 {
194 	return set_rtc_mmss(now.tv_sec);
195 }
196 
197 unsigned long long native_read_tsc(void)
198 {
199 	return __native_read_tsc();
200 }
201 EXPORT_SYMBOL(native_read_tsc);
202 
203 
204 static struct resource rtc_resources[] = {
205 	[0] = {
206 		.start	= RTC_PORT(0),
207 		.end	= RTC_PORT(1),
208 		.flags	= IORESOURCE_IO,
209 	},
210 	[1] = {
211 		.start	= RTC_IRQ,
212 		.end	= RTC_IRQ,
213 		.flags	= IORESOURCE_IRQ,
214 	}
215 };
216 
217 static struct platform_device rtc_device = {
218 	.name		= "rtc_cmos",
219 	.id		= -1,
220 	.resource	= rtc_resources,
221 	.num_resources	= ARRAY_SIZE(rtc_resources),
222 };
223 
224 static __init int add_rtc_cmos(void)
225 {
226 #ifdef CONFIG_PNP
227 	static const char *ids[] __initconst =
228 	    { "PNP0b00", "PNP0b01", "PNP0b02", };
229 	struct pnp_dev *dev;
230 	struct pnp_id *id;
231 	int i;
232 
233 	pnp_for_each_dev(dev) {
234 		for (id = dev->id; id; id = id->next) {
235 			for (i = 0; i < ARRAY_SIZE(ids); i++) {
236 				if (compare_pnp_id(id, ids[i]) != 0)
237 					return 0;
238 			}
239 		}
240 	}
241 #endif
242 
243 	platform_device_register(&rtc_device);
244 	dev_info(&rtc_device.dev,
245 		 "registered platform RTC device (no PNP device found)\n");
246 
247 	return 0;
248 }
249 device_initcall(add_rtc_cmos);
250