David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1 | /* |
| 2 | * RTC class driver for "CMOS RTC": PCs, ACPI, etc |
| 3 | * |
| 4 | * Copyright (C) 1996 Paul Gortmaker (drivers/char/rtc.c) |
| 5 | * Copyright (C) 2006 David Brownell (convert to new framework) |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU General Public License |
| 9 | * as published by the Free Software Foundation; either version |
| 10 | * 2 of the License, or (at your option) any later version. |
| 11 | */ |
| 12 | |
| 13 | /* |
| 14 | * The original "cmos clock" chip was an MC146818 chip, now obsolete. |
| 15 | * That defined the register interface now provided by all PCs, some |
| 16 | * non-PC systems, and incorporated into ACPI. Modern PC chipsets |
| 17 | * integrate an MC146818 clone in their southbridge, and boards use |
| 18 | * that instead of discrete clones like the DS12887 or M48T86. There |
| 19 | * are also clones that connect using the LPC bus. |
| 20 | * |
| 21 | * That register API is also used directly by various other drivers |
| 22 | * (notably for integrated NVRAM), infrastructure (x86 has code to |
| 23 | * bypass the RTC framework, directly reading the RTC during boot |
| 24 | * and updating minutes/seconds for systems using NTP synch) and |
| 25 | * utilities (like userspace 'hwclock', if no /dev node exists). |
| 26 | * |
| 27 | * So **ALL** calls to CMOS_READ and CMOS_WRITE must be done with |
| 28 | * interrupts disabled, holding the global rtc_lock, to exclude those |
| 29 | * other drivers and utilities on correctly configured systems. |
| 30 | */ |
| 31 | #include <linux/kernel.h> |
| 32 | #include <linux/module.h> |
| 33 | #include <linux/init.h> |
| 34 | #include <linux/interrupt.h> |
| 35 | #include <linux/spinlock.h> |
| 36 | #include <linux/platform_device.h> |
| 37 | #include <linux/mod_devicetable.h> |
| 38 | |
| 39 | /* this is for "generic access to PC-style RTC" using CMOS_READ/CMOS_WRITE */ |
| 40 | #include <asm-generic/rtc.h> |
| 41 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 42 | struct cmos_rtc { |
| 43 | struct rtc_device *rtc; |
| 44 | struct device *dev; |
| 45 | int irq; |
| 46 | struct resource *iomem; |
| 47 | |
David Brownell | 87ac84f | 2007-05-08 00:34:00 -0700 | [diff] [blame] | 48 | void (*wake_on)(struct device *); |
| 49 | void (*wake_off)(struct device *); |
| 50 | |
| 51 | u8 enabled_wake; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 52 | u8 suspend_ctrl; |
| 53 | |
| 54 | /* newer hardware extends the original register set */ |
| 55 | u8 day_alrm; |
| 56 | u8 mon_alrm; |
| 57 | u8 century; |
| 58 | }; |
| 59 | |
| 60 | /* both platform and pnp busses use negative numbers for invalid irqs */ |
| 61 | #define is_valid_irq(n) ((n) >= 0) |
| 62 | |
| 63 | static const char driver_name[] = "rtc_cmos"; |
| 64 | |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 65 | /* The RTC_INTR register may have e.g. RTC_PF set even if RTC_PIE is clear; |
| 66 | * always mask it against the irq enable bits in RTC_CONTROL. Bit values |
| 67 | * are the same: PF==PIE, AF=AIE, UF=UIE; so RTC_IRQMASK works with both. |
| 68 | */ |
| 69 | #define RTC_IRQMASK (RTC_PF | RTC_AF | RTC_UF) |
| 70 | |
| 71 | static inline int is_intr(u8 rtc_intr) |
| 72 | { |
| 73 | if (!(rtc_intr & RTC_IRQF)) |
| 74 | return 0; |
| 75 | return rtc_intr & RTC_IRQMASK; |
| 76 | } |
| 77 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 78 | /*----------------------------------------------------------------*/ |
| 79 | |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 80 | /* Much modern x86 hardware has HPETs (10+ MHz timers) which, because |
| 81 | * many BIOS programmers don't set up "sane mode" IRQ routing, are mostly |
| 82 | * used in a broken "legacy replacement" mode. The breakage includes |
| 83 | * HPET #1 hijacking the IRQ for this RTC, and being unavailable for |
| 84 | * other (better) use. |
| 85 | * |
| 86 | * When that broken mode is in use, platform glue provides a partial |
| 87 | * emulation of hardware RTC IRQ facilities using HPET #1. We don't |
| 88 | * want to use HPET for anything except those IRQs though... |
| 89 | */ |
| 90 | #ifdef CONFIG_HPET_EMULATE_RTC |
| 91 | #include <asm/hpet.h> |
| 92 | #else |
| 93 | |
| 94 | static inline int is_hpet_enabled(void) |
| 95 | { |
| 96 | return 0; |
| 97 | } |
| 98 | |
| 99 | static inline int hpet_mask_rtc_irq_bit(unsigned long mask) |
| 100 | { |
| 101 | return 0; |
| 102 | } |
| 103 | |
| 104 | static inline int hpet_set_rtc_irq_bit(unsigned long mask) |
| 105 | { |
| 106 | return 0; |
| 107 | } |
| 108 | |
| 109 | static inline int |
| 110 | hpet_set_alarm_time(unsigned char hrs, unsigned char min, unsigned char sec) |
| 111 | { |
| 112 | return 0; |
| 113 | } |
| 114 | |
| 115 | static inline int hpet_set_periodic_freq(unsigned long freq) |
| 116 | { |
| 117 | return 0; |
| 118 | } |
| 119 | |
| 120 | static inline int hpet_rtc_dropped_irq(void) |
| 121 | { |
| 122 | return 0; |
| 123 | } |
| 124 | |
| 125 | static inline int hpet_rtc_timer_init(void) |
| 126 | { |
| 127 | return 0; |
| 128 | } |
| 129 | |
| 130 | extern irq_handler_t hpet_rtc_interrupt; |
| 131 | |
| 132 | static inline int hpet_register_irq_handler(irq_handler_t handler) |
| 133 | { |
| 134 | return 0; |
| 135 | } |
| 136 | |
| 137 | static inline int hpet_unregister_irq_handler(irq_handler_t handler) |
| 138 | { |
| 139 | return 0; |
| 140 | } |
| 141 | |
| 142 | #endif |
| 143 | |
| 144 | /*----------------------------------------------------------------*/ |
| 145 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 146 | static int cmos_read_time(struct device *dev, struct rtc_time *t) |
| 147 | { |
| 148 | /* REVISIT: if the clock has a "century" register, use |
| 149 | * that instead of the heuristic in get_rtc_time(). |
| 150 | * That'll make Y3K compatility (year > 2070) easy! |
| 151 | */ |
| 152 | get_rtc_time(t); |
| 153 | return 0; |
| 154 | } |
| 155 | |
| 156 | static int cmos_set_time(struct device *dev, struct rtc_time *t) |
| 157 | { |
| 158 | /* REVISIT: set the "century" register if available |
| 159 | * |
| 160 | * NOTE: this ignores the issue whereby updating the seconds |
| 161 | * takes effect exactly 500ms after we write the register. |
| 162 | * (Also queueing and other delays before we get this far.) |
| 163 | */ |
| 164 | return set_rtc_time(t); |
| 165 | } |
| 166 | |
| 167 | static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t) |
| 168 | { |
| 169 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
| 170 | unsigned char rtc_control; |
| 171 | |
| 172 | if (!is_valid_irq(cmos->irq)) |
| 173 | return -EIO; |
| 174 | |
| 175 | /* Basic alarms only support hour, minute, and seconds fields. |
| 176 | * Some also support day and month, for alarms up to a year in |
| 177 | * the future. |
| 178 | */ |
| 179 | t->time.tm_mday = -1; |
| 180 | t->time.tm_mon = -1; |
| 181 | |
| 182 | spin_lock_irq(&rtc_lock); |
| 183 | t->time.tm_sec = CMOS_READ(RTC_SECONDS_ALARM); |
| 184 | t->time.tm_min = CMOS_READ(RTC_MINUTES_ALARM); |
| 185 | t->time.tm_hour = CMOS_READ(RTC_HOURS_ALARM); |
| 186 | |
| 187 | if (cmos->day_alrm) { |
Mark Lord | 615bb29 | 2007-11-03 22:04:03 -0400 | [diff] [blame] | 188 | /* ignore upper bits on readback per ACPI spec */ |
| 189 | t->time.tm_mday = CMOS_READ(cmos->day_alrm) & 0x3f; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 190 | if (!t->time.tm_mday) |
| 191 | t->time.tm_mday = -1; |
| 192 | |
| 193 | if (cmos->mon_alrm) { |
| 194 | t->time.tm_mon = CMOS_READ(cmos->mon_alrm); |
| 195 | if (!t->time.tm_mon) |
| 196 | t->time.tm_mon = -1; |
| 197 | } |
| 198 | } |
| 199 | |
| 200 | rtc_control = CMOS_READ(RTC_CONTROL); |
| 201 | spin_unlock_irq(&rtc_lock); |
| 202 | |
| 203 | /* REVISIT this assumes PC style usage: always BCD */ |
| 204 | |
| 205 | if (((unsigned)t->time.tm_sec) < 0x60) |
| 206 | t->time.tm_sec = BCD2BIN(t->time.tm_sec); |
| 207 | else |
| 208 | t->time.tm_sec = -1; |
| 209 | if (((unsigned)t->time.tm_min) < 0x60) |
| 210 | t->time.tm_min = BCD2BIN(t->time.tm_min); |
| 211 | else |
| 212 | t->time.tm_min = -1; |
| 213 | if (((unsigned)t->time.tm_hour) < 0x24) |
| 214 | t->time.tm_hour = BCD2BIN(t->time.tm_hour); |
| 215 | else |
| 216 | t->time.tm_hour = -1; |
| 217 | |
| 218 | if (cmos->day_alrm) { |
| 219 | if (((unsigned)t->time.tm_mday) <= 0x31) |
| 220 | t->time.tm_mday = BCD2BIN(t->time.tm_mday); |
| 221 | else |
| 222 | t->time.tm_mday = -1; |
| 223 | if (cmos->mon_alrm) { |
| 224 | if (((unsigned)t->time.tm_mon) <= 0x12) |
| 225 | t->time.tm_mon = BCD2BIN(t->time.tm_mon) - 1; |
| 226 | else |
| 227 | t->time.tm_mon = -1; |
| 228 | } |
| 229 | } |
| 230 | t->time.tm_year = -1; |
| 231 | |
| 232 | t->enabled = !!(rtc_control & RTC_AIE); |
| 233 | t->pending = 0; |
| 234 | |
| 235 | return 0; |
| 236 | } |
| 237 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 238 | static void cmos_checkintr(struct cmos_rtc *cmos, unsigned char rtc_control) |
| 239 | { |
| 240 | unsigned char rtc_intr; |
| 241 | |
| 242 | /* NOTE after changing RTC_xIE bits we always read INTR_FLAGS; |
| 243 | * allegedly some older rtcs need that to handle irqs properly |
| 244 | */ |
| 245 | rtc_intr = CMOS_READ(RTC_INTR_FLAGS); |
| 246 | |
| 247 | if (is_hpet_enabled()) |
| 248 | return; |
| 249 | |
| 250 | rtc_intr &= (rtc_control & RTC_IRQMASK) | RTC_IRQF; |
| 251 | if (is_intr(rtc_intr)) |
| 252 | rtc_update_irq(cmos->rtc, 1, rtc_intr); |
| 253 | } |
| 254 | |
| 255 | static void cmos_irq_enable(struct cmos_rtc *cmos, unsigned char mask) |
| 256 | { |
| 257 | unsigned char rtc_control; |
| 258 | |
| 259 | /* flush any pending IRQ status, notably for update irqs, |
| 260 | * before we enable new IRQs |
| 261 | */ |
| 262 | rtc_control = CMOS_READ(RTC_CONTROL); |
| 263 | cmos_checkintr(cmos, rtc_control); |
| 264 | |
| 265 | rtc_control |= mask; |
| 266 | CMOS_WRITE(rtc_control, RTC_CONTROL); |
| 267 | hpet_set_rtc_irq_bit(mask); |
| 268 | |
| 269 | cmos_checkintr(cmos, rtc_control); |
| 270 | } |
| 271 | |
| 272 | static void cmos_irq_disable(struct cmos_rtc *cmos, unsigned char mask) |
| 273 | { |
| 274 | unsigned char rtc_control; |
| 275 | |
| 276 | rtc_control = CMOS_READ(RTC_CONTROL); |
| 277 | rtc_control &= ~mask; |
| 278 | CMOS_WRITE(rtc_control, RTC_CONTROL); |
| 279 | hpet_mask_rtc_irq_bit(mask); |
| 280 | |
| 281 | cmos_checkintr(cmos, rtc_control); |
| 282 | } |
| 283 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 284 | static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t) |
| 285 | { |
| 286 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
| 287 | unsigned char mon, mday, hrs, min, sec; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 288 | |
| 289 | if (!is_valid_irq(cmos->irq)) |
| 290 | return -EIO; |
| 291 | |
| 292 | /* REVISIT this assumes PC style usage: always BCD */ |
| 293 | |
| 294 | /* Writing 0xff means "don't care" or "match all". */ |
| 295 | |
Zhao Yakui | 2b653e0 | 2008-04-15 14:34:29 -0700 | [diff] [blame] | 296 | mon = t->time.tm_mon + 1; |
| 297 | mon = (mon <= 12) ? BIN2BCD(mon) : 0xff; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 298 | |
| 299 | mday = t->time.tm_mday; |
| 300 | mday = (mday >= 1 && mday <= 31) ? BIN2BCD(mday) : 0xff; |
| 301 | |
| 302 | hrs = t->time.tm_hour; |
| 303 | hrs = (hrs < 24) ? BIN2BCD(hrs) : 0xff; |
| 304 | |
| 305 | min = t->time.tm_min; |
| 306 | min = (min < 60) ? BIN2BCD(min) : 0xff; |
| 307 | |
| 308 | sec = t->time.tm_sec; |
| 309 | sec = (sec < 60) ? BIN2BCD(sec) : 0xff; |
| 310 | |
| 311 | spin_lock_irq(&rtc_lock); |
| 312 | |
| 313 | /* next rtc irq must not be from previous alarm setting */ |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 314 | cmos_irq_disable(cmos, RTC_AIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 315 | |
| 316 | /* update alarm */ |
| 317 | CMOS_WRITE(hrs, RTC_HOURS_ALARM); |
| 318 | CMOS_WRITE(min, RTC_MINUTES_ALARM); |
| 319 | CMOS_WRITE(sec, RTC_SECONDS_ALARM); |
| 320 | |
| 321 | /* the system may support an "enhanced" alarm */ |
| 322 | if (cmos->day_alrm) { |
| 323 | CMOS_WRITE(mday, cmos->day_alrm); |
| 324 | if (cmos->mon_alrm) |
| 325 | CMOS_WRITE(mon, cmos->mon_alrm); |
| 326 | } |
| 327 | |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 328 | /* FIXME the HPET alarm glue currently ignores day_alrm |
| 329 | * and mon_alrm ... |
| 330 | */ |
| 331 | hpet_set_alarm_time(t->time.tm_hour, t->time.tm_min, t->time.tm_sec); |
| 332 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 333 | if (t->enabled) |
| 334 | cmos_irq_enable(cmos, RTC_AIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 335 | |
| 336 | spin_unlock_irq(&rtc_lock); |
| 337 | |
| 338 | return 0; |
| 339 | } |
| 340 | |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 341 | static int cmos_irq_set_freq(struct device *dev, int freq) |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 342 | { |
| 343 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
| 344 | int f; |
| 345 | unsigned long flags; |
| 346 | |
| 347 | if (!is_valid_irq(cmos->irq)) |
| 348 | return -ENXIO; |
| 349 | |
| 350 | /* 0 = no irqs; 1 = 2^15 Hz ... 15 = 2^0 Hz */ |
| 351 | f = ffs(freq); |
David Brownell | 97144c6 | 2007-10-16 01:28:16 -0700 | [diff] [blame] | 352 | if (f-- > 16) |
| 353 | return -EINVAL; |
| 354 | f = 16 - f; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 355 | |
| 356 | spin_lock_irqsave(&rtc_lock, flags); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 357 | hpet_set_periodic_freq(freq); |
| 358 | CMOS_WRITE(RTC_REF_CLCK_32KHZ | f, RTC_FREQ_SELECT); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 359 | spin_unlock_irqrestore(&rtc_lock, flags); |
| 360 | |
| 361 | return 0; |
| 362 | } |
| 363 | |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 364 | static int cmos_irq_set_state(struct device *dev, int enabled) |
| 365 | { |
| 366 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 367 | unsigned long flags; |
| 368 | |
| 369 | if (!is_valid_irq(cmos->irq)) |
| 370 | return -ENXIO; |
| 371 | |
| 372 | spin_lock_irqsave(&rtc_lock, flags); |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 373 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 374 | if (enabled) |
| 375 | cmos_irq_enable(cmos, RTC_PIE); |
| 376 | else |
| 377 | cmos_irq_disable(cmos, RTC_PIE); |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 378 | |
| 379 | spin_unlock_irqrestore(&rtc_lock, flags); |
| 380 | return 0; |
| 381 | } |
| 382 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 383 | #if defined(CONFIG_RTC_INTF_DEV) || defined(CONFIG_RTC_INTF_DEV_MODULE) |
| 384 | |
| 385 | static int |
| 386 | cmos_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg) |
| 387 | { |
| 388 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 389 | unsigned long flags; |
| 390 | |
| 391 | switch (cmd) { |
| 392 | case RTC_AIE_OFF: |
| 393 | case RTC_AIE_ON: |
| 394 | case RTC_UIE_OFF: |
| 395 | case RTC_UIE_ON: |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 396 | if (!is_valid_irq(cmos->irq)) |
| 397 | return -EINVAL; |
| 398 | break; |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 399 | /* PIE ON/OFF is handled by cmos_irq_set_state() */ |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 400 | default: |
| 401 | return -ENOIOCTLCMD; |
| 402 | } |
| 403 | |
| 404 | spin_lock_irqsave(&rtc_lock, flags); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 405 | switch (cmd) { |
| 406 | case RTC_AIE_OFF: /* alarm off */ |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 407 | cmos_irq_disable(cmos, RTC_AIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 408 | break; |
| 409 | case RTC_AIE_ON: /* alarm on */ |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 410 | cmos_irq_enable(cmos, RTC_AIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 411 | break; |
| 412 | case RTC_UIE_OFF: /* update off */ |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 413 | cmos_irq_disable(cmos, RTC_UIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 414 | break; |
| 415 | case RTC_UIE_ON: /* update on */ |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 416 | cmos_irq_enable(cmos, RTC_UIE); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 417 | break; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 418 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 419 | spin_unlock_irqrestore(&rtc_lock, flags); |
| 420 | return 0; |
| 421 | } |
| 422 | |
| 423 | #else |
| 424 | #define cmos_rtc_ioctl NULL |
| 425 | #endif |
| 426 | |
| 427 | #if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE) |
| 428 | |
| 429 | static int cmos_procfs(struct device *dev, struct seq_file *seq) |
| 430 | { |
| 431 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
| 432 | unsigned char rtc_control, valid; |
| 433 | |
| 434 | spin_lock_irq(&rtc_lock); |
| 435 | rtc_control = CMOS_READ(RTC_CONTROL); |
| 436 | valid = CMOS_READ(RTC_VALID); |
| 437 | spin_unlock_irq(&rtc_lock); |
| 438 | |
| 439 | /* NOTE: at least ICH6 reports battery status using a different |
| 440 | * (non-RTC) bit; and SQWE is ignored on many current systems. |
| 441 | */ |
| 442 | return seq_printf(seq, |
| 443 | "periodic_IRQ\t: %s\n" |
| 444 | "update_IRQ\t: %s\n" |
David Brownell | c8626a1 | 2008-02-23 15:23:44 -0800 | [diff] [blame] | 445 | "HPET_emulated\t: %s\n" |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 446 | // "square_wave\t: %s\n" |
| 447 | // "BCD\t\t: %s\n" |
| 448 | "DST_enable\t: %s\n" |
| 449 | "periodic_freq\t: %d\n" |
| 450 | "batt_status\t: %s\n", |
| 451 | (rtc_control & RTC_PIE) ? "yes" : "no", |
| 452 | (rtc_control & RTC_UIE) ? "yes" : "no", |
David Brownell | c8626a1 | 2008-02-23 15:23:44 -0800 | [diff] [blame] | 453 | is_hpet_enabled() ? "yes" : "no", |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 454 | // (rtc_control & RTC_SQWE) ? "yes" : "no", |
| 455 | // (rtc_control & RTC_DM_BINARY) ? "no" : "yes", |
| 456 | (rtc_control & RTC_DST_EN) ? "yes" : "no", |
| 457 | cmos->rtc->irq_freq, |
| 458 | (valid & RTC_VRT) ? "okay" : "dead"); |
| 459 | } |
| 460 | |
| 461 | #else |
| 462 | #define cmos_procfs NULL |
| 463 | #endif |
| 464 | |
| 465 | static const struct rtc_class_ops cmos_rtc_ops = { |
| 466 | .ioctl = cmos_rtc_ioctl, |
| 467 | .read_time = cmos_read_time, |
| 468 | .set_time = cmos_set_time, |
| 469 | .read_alarm = cmos_read_alarm, |
| 470 | .set_alarm = cmos_set_alarm, |
| 471 | .proc = cmos_procfs, |
Alessandro Zummo | 57deb52 | 2007-07-19 01:49:21 -0700 | [diff] [blame] | 472 | .irq_set_freq = cmos_irq_set_freq, |
| 473 | .irq_set_state = cmos_irq_set_state, |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 474 | }; |
| 475 | |
| 476 | /*----------------------------------------------------------------*/ |
| 477 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 478 | /* |
| 479 | * All these chips have at least 64 bytes of address space, shared by |
| 480 | * RTC registers and NVRAM. Most of those bytes of NVRAM are used |
| 481 | * by boot firmware. Modern chips have 128 or 256 bytes. |
| 482 | */ |
| 483 | |
| 484 | #define NVRAM_OFFSET (RTC_REG_D + 1) |
| 485 | |
| 486 | static ssize_t |
| 487 | cmos_nvram_read(struct kobject *kobj, struct bin_attribute *attr, |
| 488 | char *buf, loff_t off, size_t count) |
| 489 | { |
| 490 | int retval; |
| 491 | |
| 492 | if (unlikely(off >= attr->size)) |
| 493 | return 0; |
| 494 | if ((off + count) > attr->size) |
| 495 | count = attr->size - off; |
| 496 | |
| 497 | spin_lock_irq(&rtc_lock); |
| 498 | for (retval = 0, off += NVRAM_OFFSET; count--; retval++, off++) |
| 499 | *buf++ = CMOS_READ(off); |
| 500 | spin_unlock_irq(&rtc_lock); |
| 501 | |
| 502 | return retval; |
| 503 | } |
| 504 | |
| 505 | static ssize_t |
| 506 | cmos_nvram_write(struct kobject *kobj, struct bin_attribute *attr, |
| 507 | char *buf, loff_t off, size_t count) |
| 508 | { |
| 509 | struct cmos_rtc *cmos; |
| 510 | int retval; |
| 511 | |
| 512 | cmos = dev_get_drvdata(container_of(kobj, struct device, kobj)); |
| 513 | if (unlikely(off >= attr->size)) |
| 514 | return -EFBIG; |
| 515 | if ((off + count) > attr->size) |
| 516 | count = attr->size - off; |
| 517 | |
| 518 | /* NOTE: on at least PCs and Ataris, the boot firmware uses a |
| 519 | * checksum on part of the NVRAM data. That's currently ignored |
| 520 | * here. If userspace is smart enough to know what fields of |
| 521 | * NVRAM to update, updating checksums is also part of its job. |
| 522 | */ |
| 523 | spin_lock_irq(&rtc_lock); |
| 524 | for (retval = 0, off += NVRAM_OFFSET; count--; retval++, off++) { |
| 525 | /* don't trash RTC registers */ |
| 526 | if (off == cmos->day_alrm |
| 527 | || off == cmos->mon_alrm |
| 528 | || off == cmos->century) |
| 529 | buf++; |
| 530 | else |
| 531 | CMOS_WRITE(*buf++, off); |
| 532 | } |
| 533 | spin_unlock_irq(&rtc_lock); |
| 534 | |
| 535 | return retval; |
| 536 | } |
| 537 | |
| 538 | static struct bin_attribute nvram = { |
| 539 | .attr = { |
| 540 | .name = "nvram", |
| 541 | .mode = S_IRUGO | S_IWUSR, |
| 542 | .owner = THIS_MODULE, |
| 543 | }, |
| 544 | |
| 545 | .read = cmos_nvram_read, |
| 546 | .write = cmos_nvram_write, |
| 547 | /* size gets set up later */ |
| 548 | }; |
| 549 | |
| 550 | /*----------------------------------------------------------------*/ |
| 551 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 552 | static struct cmos_rtc cmos_rtc; |
| 553 | |
| 554 | static irqreturn_t cmos_interrupt(int irq, void *p) |
| 555 | { |
| 556 | u8 irqstat; |
David Brownell | 8a0bdfd | 2008-02-06 01:38:45 -0800 | [diff] [blame] | 557 | u8 rtc_control; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 558 | |
| 559 | spin_lock(&rtc_lock); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 560 | |
| 561 | /* When the HPET interrupt handler calls us, the interrupt |
| 562 | * status is passed as arg1 instead of the irq number. But |
| 563 | * always clear irq status, even when HPET is in the way. |
| 564 | * |
| 565 | * Note that HPET and RTC are almost certainly out of phase, |
| 566 | * giving different IRQ status ... |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 567 | */ |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 568 | irqstat = CMOS_READ(RTC_INTR_FLAGS); |
| 569 | rtc_control = CMOS_READ(RTC_CONTROL); |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 570 | if (is_hpet_enabled()) |
| 571 | irqstat = (unsigned long)irq & 0xF0; |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 572 | irqstat &= (rtc_control & RTC_IRQMASK) | RTC_IRQF; |
David Brownell | 8a0bdfd | 2008-02-06 01:38:45 -0800 | [diff] [blame] | 573 | |
| 574 | /* All Linux RTC alarms should be treated as if they were oneshot. |
| 575 | * Similar code may be needed in system wakeup paths, in case the |
| 576 | * alarm woke the system. |
| 577 | */ |
| 578 | if (irqstat & RTC_AIE) { |
| 579 | rtc_control &= ~RTC_AIE; |
| 580 | CMOS_WRITE(rtc_control, RTC_CONTROL); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 581 | hpet_mask_rtc_irq_bit(RTC_AIE); |
| 582 | |
David Brownell | 8a0bdfd | 2008-02-06 01:38:45 -0800 | [diff] [blame] | 583 | CMOS_READ(RTC_INTR_FLAGS); |
| 584 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 585 | spin_unlock(&rtc_lock); |
| 586 | |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 587 | if (is_intr(irqstat)) { |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 588 | rtc_update_irq(p, 1, irqstat); |
| 589 | return IRQ_HANDLED; |
| 590 | } else |
| 591 | return IRQ_NONE; |
| 592 | } |
| 593 | |
Marko Vrh | 41ac8df | 2007-05-08 00:34:09 -0700 | [diff] [blame] | 594 | #ifdef CONFIG_PNP |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 595 | #define INITSECTION |
| 596 | |
| 597 | #else |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 598 | #define INITSECTION __init |
| 599 | #endif |
| 600 | |
| 601 | static int INITSECTION |
| 602 | cmos_do_probe(struct device *dev, struct resource *ports, int rtc_irq) |
| 603 | { |
| 604 | struct cmos_rtc_board_info *info = dev->platform_data; |
| 605 | int retval = 0; |
| 606 | unsigned char rtc_control; |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 607 | unsigned address_space; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 608 | |
| 609 | /* there can be only one ... */ |
| 610 | if (cmos_rtc.dev) |
| 611 | return -EBUSY; |
| 612 | |
| 613 | if (!ports) |
| 614 | return -ENODEV; |
| 615 | |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 616 | /* Claim I/O ports ASAP, minimizing conflict with legacy driver. |
| 617 | * |
| 618 | * REVISIT non-x86 systems may instead use memory space resources |
| 619 | * (needing ioremap etc), not i/o space resources like this ... |
| 620 | */ |
| 621 | ports = request_region(ports->start, |
| 622 | ports->end + 1 - ports->start, |
| 623 | driver_name); |
| 624 | if (!ports) { |
| 625 | dev_dbg(dev, "i/o registers already in use\n"); |
| 626 | return -EBUSY; |
| 627 | } |
| 628 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 629 | cmos_rtc.irq = rtc_irq; |
| 630 | cmos_rtc.iomem = ports; |
| 631 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 632 | /* Heuristic to deduce NVRAM size ... do what the legacy NVRAM |
| 633 | * driver did, but don't reject unknown configs. Old hardware |
| 634 | * won't address 128 bytes, and for now we ignore the way newer |
| 635 | * chips can address 256 bytes (using two more i/o ports). |
| 636 | */ |
| 637 | #if defined(CONFIG_ATARI) |
| 638 | address_space = 64; |
David S. Miller | 582defd | 2008-08-28 19:54:17 -0700 | [diff] [blame] | 639 | #elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) || defined(__sparc__) |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 640 | address_space = 128; |
| 641 | #else |
| 642 | #warning Assuming 128 bytes of RTC+NVRAM address space, not 64 bytes. |
| 643 | address_space = 128; |
| 644 | #endif |
| 645 | |
David Brownell | 87ac84f | 2007-05-08 00:34:00 -0700 | [diff] [blame] | 646 | /* For ACPI systems extension info comes from the FADT. On others, |
| 647 | * board specific setup provides it as appropriate. Systems where |
| 648 | * the alarm IRQ isn't automatically a wakeup IRQ (like ACPI, and |
| 649 | * some almost-clones) can provide hooks to make that behave. |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 650 | * |
| 651 | * Note that ACPI doesn't preclude putting these registers into |
| 652 | * "extended" areas of the chip, including some that we won't yet |
| 653 | * expect CMOS_READ and friends to handle. |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 654 | */ |
| 655 | if (info) { |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 656 | if (info->rtc_day_alarm && info->rtc_day_alarm < 128) |
| 657 | cmos_rtc.day_alrm = info->rtc_day_alarm; |
| 658 | if (info->rtc_mon_alarm && info->rtc_mon_alarm < 128) |
| 659 | cmos_rtc.mon_alrm = info->rtc_mon_alarm; |
| 660 | if (info->rtc_century && info->rtc_century < 128) |
| 661 | cmos_rtc.century = info->rtc_century; |
David Brownell | 87ac84f | 2007-05-08 00:34:00 -0700 | [diff] [blame] | 662 | |
| 663 | if (info->wake_on && info->wake_off) { |
| 664 | cmos_rtc.wake_on = info->wake_on; |
| 665 | cmos_rtc.wake_off = info->wake_off; |
| 666 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 667 | } |
| 668 | |
| 669 | cmos_rtc.rtc = rtc_device_register(driver_name, dev, |
| 670 | &cmos_rtc_ops, THIS_MODULE); |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 671 | if (IS_ERR(cmos_rtc.rtc)) { |
| 672 | retval = PTR_ERR(cmos_rtc.rtc); |
| 673 | goto cleanup0; |
| 674 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 675 | |
| 676 | cmos_rtc.dev = dev; |
| 677 | dev_set_drvdata(dev, &cmos_rtc); |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 678 | rename_region(ports, cmos_rtc.rtc->dev.bus_id); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 679 | |
| 680 | spin_lock_irq(&rtc_lock); |
| 681 | |
| 682 | /* force periodic irq to CMOS reset default of 1024Hz; |
| 683 | * |
| 684 | * REVISIT it's been reported that at least one x86_64 ALI mobo |
| 685 | * doesn't use 32KHz here ... for portability we might need to |
| 686 | * do something about other clock frequencies. |
| 687 | */ |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 688 | cmos_rtc.rtc->irq_freq = 1024; |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 689 | hpet_set_periodic_freq(cmos_rtc.rtc->irq_freq); |
| 690 | CMOS_WRITE(RTC_REF_CLCK_32KHZ | 0x06, RTC_FREQ_SELECT); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 691 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 692 | /* disable irqs */ |
| 693 | cmos_irq_disable(&cmos_rtc, RTC_PIE | RTC_AIE | RTC_UIE); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 694 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 695 | rtc_control = CMOS_READ(RTC_CONTROL); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 696 | |
| 697 | spin_unlock_irq(&rtc_lock); |
| 698 | |
| 699 | /* FIXME teach the alarm code how to handle binary mode; |
| 700 | * <asm-generic/rtc.h> doesn't know 12-hour mode either. |
| 701 | */ |
David S. Miller | 582defd | 2008-08-28 19:54:17 -0700 | [diff] [blame] | 702 | if (is_valid_irq(rtc_irq) && |
| 703 | (!(rtc_control & RTC_24H) || (rtc_control & (RTC_DM_BINARY)))) { |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 704 | dev_dbg(dev, "only 24-hr BCD mode supported\n"); |
| 705 | retval = -ENXIO; |
| 706 | goto cleanup1; |
| 707 | } |
| 708 | |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 709 | if (is_valid_irq(rtc_irq)) { |
| 710 | irq_handler_t rtc_cmos_int_handler; |
| 711 | |
| 712 | if (is_hpet_enabled()) { |
| 713 | int err; |
| 714 | |
| 715 | rtc_cmos_int_handler = hpet_rtc_interrupt; |
| 716 | err = hpet_register_irq_handler(cmos_interrupt); |
| 717 | if (err != 0) { |
| 718 | printk(KERN_WARNING "hpet_register_irq_handler " |
| 719 | " failed in rtc_init()."); |
| 720 | goto cleanup1; |
| 721 | } |
| 722 | } else |
| 723 | rtc_cmos_int_handler = cmos_interrupt; |
| 724 | |
| 725 | retval = request_irq(rtc_irq, rtc_cmos_int_handler, |
| 726 | IRQF_DISABLED, cmos_rtc.rtc->dev.bus_id, |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 727 | cmos_rtc.rtc); |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 728 | if (retval < 0) { |
| 729 | dev_dbg(dev, "IRQ %d is already in use\n", rtc_irq); |
| 730 | goto cleanup1; |
| 731 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 732 | } |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 733 | hpet_rtc_timer_init(); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 734 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 735 | /* export at least the first block of NVRAM */ |
| 736 | nvram.size = address_space - NVRAM_OFFSET; |
| 737 | retval = sysfs_create_bin_file(&dev->kobj, &nvram); |
| 738 | if (retval < 0) { |
| 739 | dev_dbg(dev, "can't create nvram file? %d\n", retval); |
| 740 | goto cleanup2; |
| 741 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 742 | |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 743 | pr_info("%s: alarms up to one %s%s%s\n", |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 744 | cmos_rtc.rtc->dev.bus_id, |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 745 | is_valid_irq(rtc_irq) |
| 746 | ? (cmos_rtc.mon_alrm |
| 747 | ? "year" |
| 748 | : (cmos_rtc.day_alrm |
| 749 | ? "month" : "day")) |
| 750 | : "no", |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 751 | cmos_rtc.century ? ", y3k" : "", |
| 752 | is_hpet_enabled() ? ", hpet irqs" : ""); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 753 | |
| 754 | return 0; |
| 755 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 756 | cleanup2: |
| 757 | if (is_valid_irq(rtc_irq)) |
| 758 | free_irq(rtc_irq, cmos_rtc.rtc); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 759 | cleanup1: |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 760 | cmos_rtc.dev = NULL; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 761 | rtc_device_unregister(cmos_rtc.rtc); |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 762 | cleanup0: |
| 763 | release_region(ports->start, ports->end + 1 - ports->start); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 764 | return retval; |
| 765 | } |
| 766 | |
| 767 | static void cmos_do_shutdown(void) |
| 768 | { |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 769 | spin_lock_irq(&rtc_lock); |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 770 | cmos_irq_disable(&cmos_rtc, RTC_IRQMASK); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 771 | spin_unlock_irq(&rtc_lock); |
| 772 | } |
| 773 | |
| 774 | static void __exit cmos_do_remove(struct device *dev) |
| 775 | { |
| 776 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 777 | struct resource *ports; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 778 | |
| 779 | cmos_do_shutdown(); |
| 780 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 781 | sysfs_remove_bin_file(&dev->kobj, &nvram); |
| 782 | |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 783 | if (is_valid_irq(cmos->irq)) { |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 784 | free_irq(cmos->irq, cmos->rtc); |
Bernhard Walle | 9d8af78 | 2008-02-06 01:38:52 -0800 | [diff] [blame] | 785 | hpet_unregister_irq_handler(cmos_interrupt); |
| 786 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 787 | |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 788 | rtc_device_unregister(cmos->rtc); |
| 789 | cmos->rtc = NULL; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 790 | |
David Brownell | 05440df | 2007-10-16 01:28:21 -0700 | [diff] [blame] | 791 | ports = cmos->iomem; |
| 792 | release_region(ports->start, ports->end + 1 - ports->start); |
| 793 | cmos->iomem = NULL; |
| 794 | |
| 795 | cmos->dev = NULL; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 796 | dev_set_drvdata(dev, NULL); |
| 797 | } |
| 798 | |
| 799 | #ifdef CONFIG_PM |
| 800 | |
| 801 | static int cmos_suspend(struct device *dev, pm_message_t mesg) |
| 802 | { |
| 803 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 804 | unsigned char tmp; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 805 | |
| 806 | /* only the alarm might be a wakeup event source */ |
| 807 | spin_lock_irq(&rtc_lock); |
| 808 | cmos->suspend_ctrl = tmp = CMOS_READ(RTC_CONTROL); |
| 809 | if (tmp & (RTC_PIE|RTC_AIE|RTC_UIE)) { |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 810 | unsigned char mask; |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 811 | |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 812 | if (device_may_wakeup(dev)) |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 813 | mask = RTC_IRQMASK & ~RTC_AIE; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 814 | else |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 815 | mask = RTC_IRQMASK; |
| 816 | tmp &= ~mask; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 817 | CMOS_WRITE(tmp, RTC_CONTROL); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 818 | hpet_mask_rtc_irq_bit(mask); |
| 819 | |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 820 | cmos_checkintr(cmos, tmp); |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 821 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 822 | spin_unlock_irq(&rtc_lock); |
| 823 | |
David Brownell | 87ac84f | 2007-05-08 00:34:00 -0700 | [diff] [blame] | 824 | if (tmp & RTC_AIE) { |
| 825 | cmos->enabled_wake = 1; |
| 826 | if (cmos->wake_on) |
| 827 | cmos->wake_on(dev); |
| 828 | else |
| 829 | enable_irq_wake(cmos->irq); |
| 830 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 831 | |
| 832 | pr_debug("%s: suspend%s, ctrl %02x\n", |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 833 | cmos_rtc.rtc->dev.bus_id, |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 834 | (tmp & RTC_AIE) ? ", alarm may wake" : "", |
| 835 | tmp); |
| 836 | |
| 837 | return 0; |
| 838 | } |
| 839 | |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 840 | /* We want RTC alarms to wake us from e.g. ACPI G2/S5 "soft off", even |
| 841 | * after a detour through G3 "mechanical off", although the ACPI spec |
| 842 | * says wakeup should only work from G1/S4 "hibernate". To most users, |
| 843 | * distinctions between S4 and S5 are pointless. So when the hardware |
| 844 | * allows, don't draw that distinction. |
| 845 | */ |
| 846 | static inline int cmos_poweroff(struct device *dev) |
| 847 | { |
| 848 | return cmos_suspend(dev, PMSG_HIBERNATE); |
| 849 | } |
| 850 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 851 | static int cmos_resume(struct device *dev) |
| 852 | { |
| 853 | struct cmos_rtc *cmos = dev_get_drvdata(dev); |
| 854 | unsigned char tmp = cmos->suspend_ctrl; |
| 855 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 856 | /* re-enable any irqs previously active */ |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 857 | if (tmp & RTC_IRQMASK) { |
| 858 | unsigned char mask; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 859 | |
David Brownell | 87ac84f | 2007-05-08 00:34:00 -0700 | [diff] [blame] | 860 | if (cmos->enabled_wake) { |
| 861 | if (cmos->wake_off) |
| 862 | cmos->wake_off(dev); |
| 863 | else |
| 864 | disable_irq_wake(cmos->irq); |
| 865 | cmos->enabled_wake = 0; |
| 866 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 867 | |
| 868 | spin_lock_irq(&rtc_lock); |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 869 | do { |
| 870 | CMOS_WRITE(tmp, RTC_CONTROL); |
| 871 | hpet_set_rtc_irq_bit(tmp & RTC_IRQMASK); |
| 872 | |
| 873 | mask = CMOS_READ(RTC_INTR_FLAGS); |
| 874 | mask &= (tmp & RTC_IRQMASK) | RTC_IRQF; |
David Brownell | 7e2a31d | 2008-07-23 21:30:47 -0700 | [diff] [blame] | 875 | if (!is_hpet_enabled() || !is_intr(mask)) |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 876 | break; |
| 877 | |
| 878 | /* force one-shot behavior if HPET blocked |
| 879 | * the wake alarm's irq |
| 880 | */ |
| 881 | rtc_update_irq(cmos->rtc, 1, mask); |
| 882 | tmp &= ~RTC_AIE; |
| 883 | hpet_mask_rtc_irq_bit(RTC_AIE); |
| 884 | } while (mask & RTC_AIE); |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 885 | spin_unlock_irq(&rtc_lock); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 886 | } |
| 887 | |
| 888 | pr_debug("%s: resume, ctrl %02x\n", |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 889 | cmos_rtc.rtc->dev.bus_id, |
David Brownell | 35d3fdd | 2008-07-23 21:30:43 -0700 | [diff] [blame] | 890 | tmp); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 891 | |
| 892 | return 0; |
| 893 | } |
| 894 | |
| 895 | #else |
| 896 | #define cmos_suspend NULL |
| 897 | #define cmos_resume NULL |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 898 | |
| 899 | static inline int cmos_poweroff(struct device *dev) |
| 900 | { |
| 901 | return -ENOSYS; |
| 902 | } |
| 903 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 904 | #endif |
| 905 | |
| 906 | /*----------------------------------------------------------------*/ |
| 907 | |
David Brownell | e07e232 | 2008-02-06 01:38:43 -0800 | [diff] [blame] | 908 | /* On non-x86 systems, a "CMOS" RTC lives most naturally on platform_bus. |
| 909 | * ACPI systems always list these as PNPACPI devices, and pre-ACPI PCs |
| 910 | * probably list them in similar PNPBIOS tables; so PNP is more common. |
| 911 | * |
| 912 | * We don't use legacy "poke at the hardware" probing. Ancient PCs that |
| 913 | * predate even PNPBIOS should set up platform_bus devices. |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 914 | */ |
| 915 | |
Bjorn Helgaas | a474aae | 2008-10-14 13:50:21 -0600 | [diff] [blame] | 916 | #ifdef CONFIG_ACPI |
| 917 | |
| 918 | #include <linux/acpi.h> |
| 919 | |
| 920 | #ifdef CONFIG_PM |
| 921 | static u32 rtc_handler(void *context) |
| 922 | { |
| 923 | acpi_clear_event(ACPI_EVENT_RTC); |
| 924 | acpi_disable_event(ACPI_EVENT_RTC, 0); |
| 925 | return ACPI_INTERRUPT_HANDLED; |
| 926 | } |
| 927 | |
| 928 | static inline void rtc_wake_setup(void) |
| 929 | { |
| 930 | acpi_install_fixed_event_handler(ACPI_EVENT_RTC, rtc_handler, NULL); |
| 931 | /* |
| 932 | * After the RTC handler is installed, the Fixed_RTC event should |
| 933 | * be disabled. Only when the RTC alarm is set will it be enabled. |
| 934 | */ |
| 935 | acpi_clear_event(ACPI_EVENT_RTC); |
| 936 | acpi_disable_event(ACPI_EVENT_RTC, 0); |
| 937 | } |
| 938 | |
| 939 | static void rtc_wake_on(struct device *dev) |
| 940 | { |
| 941 | acpi_clear_event(ACPI_EVENT_RTC); |
| 942 | acpi_enable_event(ACPI_EVENT_RTC, 0); |
| 943 | } |
| 944 | |
| 945 | static void rtc_wake_off(struct device *dev) |
| 946 | { |
| 947 | acpi_disable_event(ACPI_EVENT_RTC, 0); |
| 948 | } |
| 949 | #else |
| 950 | #define rtc_wake_setup() do{}while(0) |
| 951 | #define rtc_wake_on NULL |
| 952 | #define rtc_wake_off NULL |
| 953 | #endif |
| 954 | |
| 955 | /* Every ACPI platform has a mc146818 compatible "cmos rtc". Here we find |
| 956 | * its device node and pass extra config data. This helps its driver use |
| 957 | * capabilities that the now-obsolete mc146818 didn't have, and informs it |
| 958 | * that this board's RTC is wakeup-capable (per ACPI spec). |
| 959 | */ |
| 960 | static struct cmos_rtc_board_info acpi_rtc_info; |
| 961 | |
| 962 | static void __devinit |
| 963 | cmos_wake_setup(struct device *dev) |
| 964 | { |
| 965 | if (acpi_disabled) |
| 966 | return; |
| 967 | |
| 968 | rtc_wake_setup(); |
| 969 | acpi_rtc_info.wake_on = rtc_wake_on; |
| 970 | acpi_rtc_info.wake_off = rtc_wake_off; |
| 971 | |
| 972 | /* workaround bug in some ACPI tables */ |
| 973 | if (acpi_gbl_FADT.month_alarm && !acpi_gbl_FADT.day_alarm) { |
| 974 | dev_dbg(dev, "bogus FADT month_alarm (%d)\n", |
| 975 | acpi_gbl_FADT.month_alarm); |
| 976 | acpi_gbl_FADT.month_alarm = 0; |
| 977 | } |
| 978 | |
| 979 | acpi_rtc_info.rtc_day_alarm = acpi_gbl_FADT.day_alarm; |
| 980 | acpi_rtc_info.rtc_mon_alarm = acpi_gbl_FADT.month_alarm; |
| 981 | acpi_rtc_info.rtc_century = acpi_gbl_FADT.century; |
| 982 | |
| 983 | /* NOTE: S4_RTC_WAKE is NOT currently useful to Linux */ |
| 984 | if (acpi_gbl_FADT.flags & ACPI_FADT_S4_RTC_WAKE) |
| 985 | dev_info(dev, "RTC can wake from S4\n"); |
| 986 | |
| 987 | dev->platform_data = &acpi_rtc_info; |
| 988 | |
| 989 | /* RTC always wakes from S1/S2/S3, and often S4/STD */ |
| 990 | device_init_wakeup(dev, 1); |
| 991 | } |
| 992 | |
| 993 | #else |
| 994 | |
| 995 | static void __devinit |
| 996 | cmos_wake_setup(struct device *dev) |
| 997 | { |
| 998 | } |
| 999 | |
| 1000 | #endif |
| 1001 | |
Marko Vrh | 41ac8df | 2007-05-08 00:34:09 -0700 | [diff] [blame] | 1002 | #ifdef CONFIG_PNP |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1003 | |
| 1004 | #include <linux/pnp.h> |
| 1005 | |
| 1006 | static int __devinit |
| 1007 | cmos_pnp_probe(struct pnp_dev *pnp, const struct pnp_device_id *id) |
| 1008 | { |
Bjorn Helgaas | a474aae | 2008-10-14 13:50:21 -0600 | [diff] [blame] | 1009 | cmos_wake_setup(&pnp->dev); |
| 1010 | |
Matthew Garrett | 6cd8fa8 | 2007-06-01 00:46:51 -0700 | [diff] [blame] | 1011 | if (pnp_port_start(pnp,0) == 0x70 && !pnp_irq_valid(pnp,0)) |
| 1012 | /* Some machines contain a PNP entry for the RTC, but |
| 1013 | * don't define the IRQ. It should always be safe to |
| 1014 | * hardcode it in these cases |
| 1015 | */ |
Bjorn Helgaas | 8766ad0 | 2008-04-28 16:34:27 -0600 | [diff] [blame] | 1016 | return cmos_do_probe(&pnp->dev, |
| 1017 | pnp_get_resource(pnp, IORESOURCE_IO, 0), 8); |
Matthew Garrett | 6cd8fa8 | 2007-06-01 00:46:51 -0700 | [diff] [blame] | 1018 | else |
| 1019 | return cmos_do_probe(&pnp->dev, |
Bjorn Helgaas | 8766ad0 | 2008-04-28 16:34:27 -0600 | [diff] [blame] | 1020 | pnp_get_resource(pnp, IORESOURCE_IO, 0), |
| 1021 | pnp_irq(pnp, 0)); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1022 | } |
| 1023 | |
| 1024 | static void __exit cmos_pnp_remove(struct pnp_dev *pnp) |
| 1025 | { |
| 1026 | cmos_do_remove(&pnp->dev); |
| 1027 | } |
| 1028 | |
| 1029 | #ifdef CONFIG_PM |
| 1030 | |
| 1031 | static int cmos_pnp_suspend(struct pnp_dev *pnp, pm_message_t mesg) |
| 1032 | { |
| 1033 | return cmos_suspend(&pnp->dev, mesg); |
| 1034 | } |
| 1035 | |
| 1036 | static int cmos_pnp_resume(struct pnp_dev *pnp) |
| 1037 | { |
| 1038 | return cmos_resume(&pnp->dev); |
| 1039 | } |
| 1040 | |
| 1041 | #else |
| 1042 | #define cmos_pnp_suspend NULL |
| 1043 | #define cmos_pnp_resume NULL |
| 1044 | #endif |
| 1045 | |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 1046 | static void cmos_pnp_shutdown(struct device *pdev) |
| 1047 | { |
| 1048 | if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(pdev)) |
| 1049 | return; |
| 1050 | |
| 1051 | cmos_do_shutdown(); |
| 1052 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1053 | |
| 1054 | static const struct pnp_device_id rtc_ids[] = { |
| 1055 | { .id = "PNP0b00", }, |
| 1056 | { .id = "PNP0b01", }, |
| 1057 | { .id = "PNP0b02", }, |
| 1058 | { }, |
| 1059 | }; |
| 1060 | MODULE_DEVICE_TABLE(pnp, rtc_ids); |
| 1061 | |
| 1062 | static struct pnp_driver cmos_pnp_driver = { |
| 1063 | .name = (char *) driver_name, |
| 1064 | .id_table = rtc_ids, |
| 1065 | .probe = cmos_pnp_probe, |
| 1066 | .remove = __exit_p(cmos_pnp_remove), |
| 1067 | |
| 1068 | /* flag ensures resume() gets called, and stops syslog spam */ |
| 1069 | .flags = PNP_DRIVER_RES_DO_NOT_CHANGE, |
| 1070 | .suspend = cmos_pnp_suspend, |
| 1071 | .resume = cmos_pnp_resume, |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 1072 | .driver = { |
| 1073 | .name = (char *)driver_name, |
| 1074 | .shutdown = cmos_pnp_shutdown, |
| 1075 | } |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1076 | }; |
| 1077 | |
Stas Sergeev | 1da2e3d | 2008-06-12 15:21:54 -0700 | [diff] [blame] | 1078 | #endif /* CONFIG_PNP */ |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1079 | |
| 1080 | /*----------------------------------------------------------------*/ |
| 1081 | |
Marko Vrh | 41ac8df | 2007-05-08 00:34:09 -0700 | [diff] [blame] | 1082 | /* Platform setup should have set up an RTC device, when PNP is |
David Brownell | bcd9b89 | 2007-04-01 23:49:47 -0700 | [diff] [blame] | 1083 | * unavailable ... this could happen even on (older) PCs. |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1084 | */ |
| 1085 | |
| 1086 | static int __init cmos_platform_probe(struct platform_device *pdev) |
| 1087 | { |
Bjorn Helgaas | a474aae | 2008-10-14 13:50:21 -0600 | [diff] [blame] | 1088 | cmos_wake_setup(&pdev->dev); |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1089 | return cmos_do_probe(&pdev->dev, |
| 1090 | platform_get_resource(pdev, IORESOURCE_IO, 0), |
| 1091 | platform_get_irq(pdev, 0)); |
| 1092 | } |
| 1093 | |
| 1094 | static int __exit cmos_platform_remove(struct platform_device *pdev) |
| 1095 | { |
| 1096 | cmos_do_remove(&pdev->dev); |
| 1097 | return 0; |
| 1098 | } |
| 1099 | |
| 1100 | static void cmos_platform_shutdown(struct platform_device *pdev) |
| 1101 | { |
Rafael J. Wysocki | 74c4633 | 2008-09-02 14:36:11 -0700 | [diff] [blame] | 1102 | if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(&pdev->dev)) |
| 1103 | return; |
| 1104 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1105 | cmos_do_shutdown(); |
| 1106 | } |
| 1107 | |
Kay Sievers | ad28a07 | 2008-04-10 21:29:25 -0700 | [diff] [blame] | 1108 | /* work with hotplug and coldplug */ |
| 1109 | MODULE_ALIAS("platform:rtc_cmos"); |
| 1110 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1111 | static struct platform_driver cmos_platform_driver = { |
| 1112 | .remove = __exit_p(cmos_platform_remove), |
| 1113 | .shutdown = cmos_platform_shutdown, |
| 1114 | .driver = { |
| 1115 | .name = (char *) driver_name, |
| 1116 | .suspend = cmos_suspend, |
| 1117 | .resume = cmos_resume, |
| 1118 | } |
| 1119 | }; |
| 1120 | |
| 1121 | static int __init cmos_init(void) |
| 1122 | { |
Bjorn Helgaas | 72f22b1 | 2008-10-14 17:01:59 -0600 | [diff] [blame] | 1123 | int retval = 0; |
| 1124 | |
Stas Sergeev | 1da2e3d | 2008-06-12 15:21:54 -0700 | [diff] [blame] | 1125 | #ifdef CONFIG_PNP |
Bjorn Helgaas | 72f22b1 | 2008-10-14 17:01:59 -0600 | [diff] [blame] | 1126 | pnp_register_driver(&cmos_pnp_driver); |
| 1127 | #endif |
| 1128 | |
| 1129 | if (!cmos_rtc.dev) |
| 1130 | retval = platform_driver_probe(&cmos_platform_driver, |
| 1131 | cmos_platform_probe); |
| 1132 | |
| 1133 | if (retval == 0) |
| 1134 | return 0; |
| 1135 | |
| 1136 | #ifdef CONFIG_PNP |
| 1137 | pnp_unregister_driver(&cmos_pnp_driver); |
| 1138 | #endif |
| 1139 | return retval; |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1140 | } |
| 1141 | module_init(cmos_init); |
| 1142 | |
| 1143 | static void __exit cmos_exit(void) |
| 1144 | { |
Stas Sergeev | 1da2e3d | 2008-06-12 15:21:54 -0700 | [diff] [blame] | 1145 | #ifdef CONFIG_PNP |
Bjorn Helgaas | 72f22b1 | 2008-10-14 17:01:59 -0600 | [diff] [blame] | 1146 | pnp_unregister_driver(&cmos_pnp_driver); |
| 1147 | #endif |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1148 | platform_driver_unregister(&cmos_platform_driver); |
| 1149 | } |
| 1150 | module_exit(cmos_exit); |
| 1151 | |
| 1152 | |
David Brownell | 7be2c7c | 2007-02-10 01:46:02 -0800 | [diff] [blame] | 1153 | MODULE_AUTHOR("David Brownell"); |
| 1154 | MODULE_DESCRIPTION("Driver for PC-style 'CMOS' RTCs"); |
| 1155 | MODULE_LICENSE("GPL"); |