2 * Driver/API for AMD Geode Multi-Function General Purpose Timers (MFGPT)
4 * Copyright (C) 2006, Advanced Micro Devices, Inc.
5 * Copyright (C) 2007, Andres Salomon <dilinger@debian.org>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of version 2 of the GNU General Public License
9 * as published by the Free Software Foundation.
11 * The MFGPTs are documented in AMD Geode CS5536 Companion Device Data Book.
15 * We are using the 32.768kHz input clock - it's the only one that has the
16 * ranges we find desirable. The following table lists the suitable
17 * divisors and the associated Hz, minimum interval and the maximum interval:
19 * Divisor Hz Min Delta (s) Max Delta (s)
20 * 1 32768 .00048828125 2.000
21 * 2 16384 .0009765625 4.000
22 * 4 8192 .001953125 8.000
23 * 8 4096 .00390625 16.000
24 * 16 2048 .0078125 32.000
25 * 32 1024 .015625 64.000
26 * 64 512 .03125 128.000
27 * 128 256 .0625 256.000
28 * 256 128 .125 512.000
31 #include <linux/kernel.h>
32 #include <linux/interrupt.h>
33 #include <linux/module.h>
34 #include <asm/geode.h>
36 static struct mfgpt_timer_t {
38 } mfgpt_timers[MFGPT_MAX_TIMERS];
40 /* Selected from the table above */
42 #define MFGPT_DIVISOR 16
43 #define MFGPT_SCALE 4 /* divisor = 2^(scale) */
44 #define MFGPT_HZ (32768 / MFGPT_DIVISOR)
45 #define MFGPT_PERIODIC (MFGPT_HZ / HZ)
47 /* Allow for disabling of MFGPTs */
49 static int __init mfgpt_disable(char *s)
54 __setup("nomfgpt", mfgpt_disable);
56 /* Reset the MFGPT timers. This is required by some broken BIOSes which already
57 * do the same and leave the system in an unstable state. TinyBIOS 0.98 is
58 * affected at least (0.99 is OK with MFGPT workaround left to off).
60 static int __init mfgpt_fix(char *s)
64 /* The following udocumented bit resets the MFGPT timers */
65 val = 0xFF; dummy = 0;
66 wrmsr(MSR_MFGPT_SETUP, val, dummy);
69 __setup("mfgptfix", mfgpt_fix);
72 * Check whether any MFGPTs are available for the kernel to use. In most
73 * cases, firmware that uses AMD's VSA code will claim all timers during
74 * bootup; we certainly don't want to take them if they're already in use.
75 * In other cases (such as with VSAless OpenFirmware), the system firmware
76 * leaves timers available for us to use.
80 static int timers = -1;
82 static void geode_mfgpt_detect(void)
90 printk(KERN_INFO "geode-mfgpt: MFGPT support is disabled\n");
94 if (!geode_get_dev_base(GEODE_DEV_MFGPT)) {
95 printk(KERN_INFO "geode-mfgpt: MFGPT LBAR is not set up\n");
99 for (i = 0; i < MFGPT_MAX_TIMERS; i++) {
100 val = geode_mfgpt_read(i, MFGPT_REG_SETUP);
101 if (!(val & MFGPT_SETUP_SETUP)) {
102 mfgpt_timers[i].avail = 1;
108 printk(KERN_INFO "geode-mfgpt: %d MFGPT timers available.\n", timers);
111 int geode_mfgpt_toggle_event(int timer, int cmp, int event, int enable)
113 u32 msr, mask, value, dummy;
114 int shift = (cmp == MFGPT_CMP1) ? 0 : 8;
116 if (timer < 0 || timer >= MFGPT_MAX_TIMERS)
120 * The register maps for these are described in sections 6.17.1.x of
121 * the AMD Geode CS5536 Companion Device Data Book.
124 case MFGPT_EVENT_RESET:
126 * XXX: According to the docs, we cannot reset timers above
127 * 6; that is, resets for 7 and 8 will be ignored. Is this
128 * a problem? -dilinger
131 mask = 1 << (timer + 24);
134 case MFGPT_EVENT_NMI:
136 mask = 1 << (timer + shift);
139 case MFGPT_EVENT_IRQ:
141 mask = 1 << (timer + shift);
148 rdmsr(msr, value, dummy);
155 wrmsr(msr, value, dummy);
158 EXPORT_SYMBOL_GPL(geode_mfgpt_toggle_event);
160 int geode_mfgpt_set_irq(int timer, int cmp, int irq, int enable)
165 if (timer < 0 || timer >= MFGPT_MAX_TIMERS)
168 if (geode_mfgpt_toggle_event(timer, cmp, MFGPT_EVENT_IRQ, enable))
171 rdmsr(MSR_PIC_ZSEL_LOW, val, dummy);
173 offset = (timer % 4) * 4;
175 val &= ~((0xF << offset) | (0xF << (offset + 16)));
178 val |= (irq & 0x0F) << (offset);
179 val |= (irq & 0x0F) << (offset + 16);
182 wrmsr(MSR_PIC_ZSEL_LOW, val, dummy);
186 static int mfgpt_get(int timer)
188 mfgpt_timers[timer].avail = 0;
189 printk(KERN_INFO "geode-mfgpt: Registered timer %d\n", timer);
193 int geode_mfgpt_alloc_timer(int timer, int domain)
198 /* timers haven't been detected yet */
199 geode_mfgpt_detect();
205 if (timer >= MFGPT_MAX_TIMERS)
209 /* Try to find an available timer */
210 for (i = 0; i < MFGPT_MAX_TIMERS; i++) {
211 if (mfgpt_timers[i].avail)
214 if (i == 5 && domain == MFGPT_DOMAIN_WORKING)
218 /* If they requested a specific timer, try to honor that */
219 if (mfgpt_timers[timer].avail)
220 return mfgpt_get(timer);
223 /* No timers available - too bad */
226 EXPORT_SYMBOL_GPL(geode_mfgpt_alloc_timer);
229 #ifdef CONFIG_GEODE_MFGPT_TIMER
232 * The MFPGT timers on the CS5536 provide us with suitable timers to use
233 * as clock event sources - not as good as a HPET or APIC, but certainly
234 * better then the PIT. This isn't a general purpose MFGPT driver, but
235 * a simplified one designed specifically to act as a clock event source.
236 * For full details about the MFGPT, please consult the CS5536 data sheet.
239 #include <linux/clocksource.h>
240 #include <linux/clockchips.h>
242 static unsigned int mfgpt_tick_mode = CLOCK_EVT_MODE_SHUTDOWN;
243 static u16 mfgpt_event_clock;
246 static int __init mfgpt_setup(char *str)
248 get_option(&str, &irq);
251 __setup("mfgpt_irq=", mfgpt_setup);
253 static void mfgpt_disable_timer(u16 clock)
255 /* avoid races by clearing CMP1 and CMP2 unconditionally */
256 geode_mfgpt_write(clock, MFGPT_REG_SETUP, (u16) ~MFGPT_SETUP_CNTEN |
257 MFGPT_SETUP_CMP1 | MFGPT_SETUP_CMP2);
260 static int mfgpt_next_event(unsigned long, struct clock_event_device *);
261 static void mfgpt_set_mode(enum clock_event_mode, struct clock_event_device *);
263 static struct clock_event_device mfgpt_clockevent = {
264 .name = "mfgpt-timer",
265 .features = CLOCK_EVT_FEAT_PERIODIC | CLOCK_EVT_FEAT_ONESHOT,
266 .set_mode = mfgpt_set_mode,
267 .set_next_event = mfgpt_next_event,
269 .cpumask = CPU_MASK_ALL,
273 static void mfgpt_start_timer(u16 delta)
275 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_CMP2, (u16) delta);
276 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_COUNTER, 0);
278 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_SETUP,
279 MFGPT_SETUP_CNTEN | MFGPT_SETUP_CMP2);
282 static void mfgpt_set_mode(enum clock_event_mode mode,
283 struct clock_event_device *evt)
285 mfgpt_disable_timer(mfgpt_event_clock);
287 if (mode == CLOCK_EVT_MODE_PERIODIC)
288 mfgpt_start_timer(MFGPT_PERIODIC);
290 mfgpt_tick_mode = mode;
293 static int mfgpt_next_event(unsigned long delta, struct clock_event_device *evt)
295 mfgpt_start_timer(delta);
299 static irqreturn_t mfgpt_tick(int irq, void *dev_id)
301 u16 val = geode_mfgpt_read(mfgpt_event_clock, MFGPT_REG_SETUP);
303 /* See if the interrupt was for us */
304 if (!(val & (MFGPT_SETUP_SETUP | MFGPT_SETUP_CMP2 | MFGPT_SETUP_CMP1)))
307 /* Turn off the clock (and clear the event) */
308 mfgpt_disable_timer(mfgpt_event_clock);
310 if (mfgpt_tick_mode == CLOCK_EVT_MODE_SHUTDOWN)
313 /* Clear the counter */
314 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_COUNTER, 0);
316 /* Restart the clock in periodic mode */
318 if (mfgpt_tick_mode == CLOCK_EVT_MODE_PERIODIC) {
319 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_SETUP,
320 MFGPT_SETUP_CNTEN | MFGPT_SETUP_CMP2);
323 mfgpt_clockevent.event_handler(&mfgpt_clockevent);
327 static struct irqaction mfgptirq = {
328 .handler = mfgpt_tick,
329 .flags = IRQF_DISABLED | IRQF_NOBALANCING,
330 .mask = CPU_MASK_NONE,
331 .name = "mfgpt-timer"
334 int __init mfgpt_timer_setup(void)
339 timer = geode_mfgpt_alloc_timer(MFGPT_TIMER_ANY, MFGPT_DOMAIN_WORKING);
342 "mfgpt-timer: Could not allocate a MFPGT timer\n");
346 mfgpt_event_clock = timer;
348 /* Set up the IRQ on the MFGPT side */
349 if (geode_mfgpt_setup_irq(mfgpt_event_clock, MFGPT_CMP2, irq)) {
350 printk(KERN_ERR "mfgpt-timer: Could not set up IRQ %d\n", irq);
354 /* And register it with the kernel */
355 ret = setup_irq(irq, &mfgptirq);
359 "mfgpt-timer: Unable to set up the interrupt.\n");
363 /* Set the clock scale and enable the event mode for CMP2 */
364 val = MFGPT_SCALE | (3 << 8);
366 geode_mfgpt_write(mfgpt_event_clock, MFGPT_REG_SETUP, val);
368 /* Set up the clock event */
369 mfgpt_clockevent.mult = div_sc(MFGPT_HZ, NSEC_PER_SEC,
370 mfgpt_clockevent.shift);
371 mfgpt_clockevent.min_delta_ns = clockevent_delta2ns(0xF,
373 mfgpt_clockevent.max_delta_ns = clockevent_delta2ns(0xFFFE,
377 "mfgpt-timer: registering the MFGPT timer as a clock event.\n");
378 clockevents_register_device(&mfgpt_clockevent);
383 geode_mfgpt_release_irq(mfgpt_event_clock, MFGPT_CMP2, irq);
385 "mfgpt-timer: Unable to set up the MFGPT clock source\n");