[mirror_ubuntu-artful-kernel.git] / drivers / clocksource / cs5535-clockevt.c

/*
 * Clock event driver for the CS5535/CS5536
 *
 * Copyright (C) 2006, Advanced Micro Devices, Inc.
 * Copyright (C) 2007  Andres Salomon <dilinger@debian.org>
 * Copyright (C) 2009  Andres Salomon <dilinger@collabora.co.uk>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public License
 * as published by the Free Software Foundation.
 *
 * The MFGPTs are documented in AMD Geode CS5536 Companion Device Data Book.
 */

#include <linux/kernel.h>
#include <linux/irq.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/cs5535.h>
#include <linux/clockchips.h>

#define DRV_NAME "cs5535-clockevt"

static int timer_irq;
module_param_named(irq, timer_irq, int, 0644);
MODULE_PARM_DESC(irq, "Which IRQ to use for the clock source MFGPT ticks.");

/*
 * We are using the 32.768kHz input clock - it's the only one that has the
 * ranges we find desirable.  The following table lists the suitable
 * divisors and the associated Hz, minimum interval and the maximum interval:
 *
 *  Divisor   Hz      Min Delta (s)  Max Delta (s)
 *   1        32768   .00048828125      2.000
 *   2        16384   .0009765625       4.000
 *   4         8192   .001953125        8.000
 *   8         4096   .00390625        16.000
 *   16        2048   .0078125         32.000
 *   32        1024   .015625          64.000
 *   64         512   .03125          128.000
 *  128         256   .0625           256.000
 *  256         128   .125            512.000
 */

static struct cs5535_mfgpt_timer *cs5535_event_clock;

/* Selected from the table above */

#define MFGPT_DIVISOR 16
#define MFGPT_SCALE  4     /* divisor = 2^(scale) */
#define MFGPT_HZ  (32768 / MFGPT_DIVISOR)
#define MFGPT_PERIODIC (MFGPT_HZ / HZ)

/*
 * The MFGPT timers on the CS5536 provide us with suitable timers to use
 * as clock event sources - not as good as a HPET or APIC, but certainly
 * better than the PIT.  This isn't a general purpose MFGPT driver, but
 * a simplified one designed specifically to act as a clock event source.
 * For full details about the MFGPT, please consult the CS5536 data sheet.
 */

static void disable_timer(struct cs5535_mfgpt_timer *timer)
{
	/* avoid races by clearing CMP1 and CMP2 unconditionally */
	cs5535_mfgpt_write(timer, MFGPT_REG_SETUP,
			(uint16_t) ~MFGPT_SETUP_CNTEN | MFGPT_SETUP_CMP1 |
				MFGPT_SETUP_CMP2);
}

static void start_timer(struct cs5535_mfgpt_timer *timer, uint16_t delta)
{
	cs5535_mfgpt_write(timer, MFGPT_REG_CMP2, delta);
	cs5535_mfgpt_write(timer, MFGPT_REG_COUNTER, 0);

	cs5535_mfgpt_write(timer, MFGPT_REG_SETUP,
			MFGPT_SETUP_CNTEN | MFGPT_SETUP_CMP2);
}

static int mfgpt_shutdown(struct clock_event_device *evt)
{
	disable_timer(cs5535_event_clock);
	return 0;
}

static int mfgpt_set_periodic(struct clock_event_device *evt)
{
	disable_timer(cs5535_event_clock);
	start_timer(cs5535_event_clock, MFGPT_PERIODIC);
	return 0;
}

static int mfgpt_next_event(unsigned long delta, struct clock_event_device *evt)
{
	start_timer(cs5535_event_clock, delta);
	return 0;
}

static struct clock_event_device cs5535_clockevent = {
	.name = DRV_NAME,
	.features = CLOCK_EVT_FEAT_PERIODIC | CLOCK_EVT_FEAT_ONESHOT,
	.set_state_shutdown = mfgpt_shutdown,
	.set_state_periodic = mfgpt_set_periodic,
	.set_state_oneshot = mfgpt_shutdown,
	.tick_resume = mfgpt_shutdown,
	.set_next_event = mfgpt_next_event,
	.rating = 250,
};

static irqreturn_t mfgpt_tick(int irq, void *dev_id)
{
	uint16_t val = cs5535_mfgpt_read(cs5535_event_clock, MFGPT_REG_SETUP);

	/* See if the interrupt was for us */
	if (!(val & (MFGPT_SETUP_SETUP | MFGPT_SETUP_CMP2 | MFGPT_SETUP_CMP1)))
		return IRQ_NONE;

	/* Turn off the clock (and clear the event) */
	disable_timer(cs5535_event_clock);

	if (clockevent_state_shutdown(&cs5535_clockevent))
		return IRQ_HANDLED;

	/* Clear the counter */
	cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_COUNTER, 0);

	/* Restart the clock in periodic mode */

	if (clockevent_state_periodic(&cs5535_clockevent))
		cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_SETUP,
				MFGPT_SETUP_CNTEN | MFGPT_SETUP_CMP2);

	cs5535_clockevent.event_handler(&cs5535_clockevent);
	return IRQ_HANDLED;
}

static struct irqaction mfgptirq  = {
	.handler = mfgpt_tick,
	.flags = IRQF_NOBALANCING | IRQF_TIMER | IRQF_SHARED,
	.name = DRV_NAME,
};

static int __init cs5535_mfgpt_init(void)
{
	struct cs5535_mfgpt_timer *timer;
	int ret;
	uint16_t val;

	timer = cs5535_mfgpt_alloc_timer(MFGPT_TIMER_ANY, MFGPT_DOMAIN_WORKING);
	if (!timer) {
		printk(KERN_ERR DRV_NAME ": Could not allocate MFGPT timer\n");
		return -ENODEV;
	}
	cs5535_event_clock = timer;

	/* Set up the IRQ on the MFGPT side */
	if (cs5535_mfgpt_setup_irq(timer, MFGPT_CMP2, &timer_irq)) {
		printk(KERN_ERR DRV_NAME ": Could not set up IRQ %d\n",
				timer_irq);
		goto err_timer;
	}

	/* And register it with the kernel */
	ret = setup_irq(timer_irq, &mfgptirq);
	if (ret) {
		printk(KERN_ERR DRV_NAME ": Unable to set up the interrupt.\n");
		goto err_irq;
	}

	/* Set the clock scale and enable the event mode for CMP2 */
	val = MFGPT_SCALE | (3 << 8);

	cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_SETUP, val);

	/* Set up the clock event */
	printk(KERN_INFO DRV_NAME
		": Registering MFGPT timer as a clock event, using IRQ %d\n",
		timer_irq);
	clockevents_config_and_register(&cs5535_clockevent, MFGPT_HZ,
					0xF, 0xFFFE);

	return 0;

err_irq:
	cs5535_mfgpt_release_irq(cs5535_event_clock, MFGPT_CMP2, &timer_irq);
err_timer:
	cs5535_mfgpt_free_timer(cs5535_event_clock);
	printk(KERN_ERR DRV_NAME ": Unable to set up the MFGPT clock source\n");
	return -EIO;
}

module_init(cs5535_mfgpt_init);

MODULE_AUTHOR("Andres Salomon <dilinger@queued.net>");
MODULE_DESCRIPTION("CS5535/CS5536 MFGPT clock event driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
c30d7d2b AS	1	/*
	2	* Clock event driver for the CS5535/CS5536
	3	*
	4	* Copyright (C) 2006, Advanced Micro Devices, Inc.
	5	* Copyright (C) 2007 Andres Salomon <dilinger@debian.org>
	6	* Copyright (C) 2009 Andres Salomon <dilinger@collabora.co.uk>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of version 2 of the GNU General Public License
	10	* as published by the Free Software Foundation.
	11	*
	12	* The MFGPTs are documented in AMD Geode CS5536 Companion Device Data Book.
	13	*/
	14
	15	#include <linux/kernel.h>
	16	#include <linux/irq.h>
	17	#include <linux/interrupt.h>
	18	#include <linux/module.h>
	19	#include <linux/cs5535.h>
	20	#include <linux/clockchips.h>
	21
	22	#define DRV_NAME "cs5535-clockevt"
	23
115079aa	24	static int timer_irq;
c30d7d2b AS	25	module_param_named(irq, timer_irq, int, 0644);
	26	MODULE_PARM_DESC(irq, "Which IRQ to use for the clock source MFGPT ticks.");
	27
	28	/*
	29	* We are using the 32.768kHz input clock - it's the only one that has the
	30	* ranges we find desirable. The following table lists the suitable
	31	* divisors and the associated Hz, minimum interval and the maximum interval:
	32	*
	33	* Divisor Hz Min Delta (s) Max Delta (s)
	34	* 1 32768 .00048828125 2.000
	35	* 2 16384 .0009765625 4.000
	36	* 4 8192 .001953125 8.000
	37	* 8 4096 .00390625 16.000
	38	* 16 2048 .0078125 32.000
	39	* 32 1024 .015625 64.000
	40	* 64 512 .03125 128.000
	41	* 128 256 .0625 256.000
	42	* 256 128 .125 512.000
	43	*/
	44
c30d7d2b AS	45	static struct cs5535_mfgpt_timer *cs5535_event_clock;
	46
	47	/* Selected from the table above */
	48
	49	#define MFGPT_DIVISOR 16
	50	#define MFGPT_SCALE 4 /* divisor = 2^(scale) */
	51	#define MFGPT_HZ (32768 / MFGPT_DIVISOR)
	52	#define MFGPT_PERIODIC (MFGPT_HZ / HZ)
	53
	54	/*
61e01be2	55	* The MFGPT timers on the CS5536 provide us with suitable timers to use
c30d7d2b AS	56	* as clock event sources - not as good as a HPET or APIC, but certainly
	57	* better than the PIT. This isn't a general purpose MFGPT driver, but
	58	* a simplified one designed specifically to act as a clock event source.
	59	* For full details about the MFGPT, please consult the CS5536 data sheet.
	60	*/
	61
	62	static void disable_timer(struct cs5535_mfgpt_timer *timer)
	63	{
	64	/* avoid races by clearing CMP1 and CMP2 unconditionally */
	65	cs5535_mfgpt_write(timer, MFGPT_REG_SETUP,
	66	(uint16_t) ~MFGPT_SETUP_CNTEN \| MFGPT_SETUP_CMP1 \|
	67	MFGPT_SETUP_CMP2);
	68	}
	69
	70	static void start_timer(struct cs5535_mfgpt_timer *timer, uint16_t delta)
	71	{
	72	cs5535_mfgpt_write(timer, MFGPT_REG_CMP2, delta);
	73	cs5535_mfgpt_write(timer, MFGPT_REG_COUNTER, 0);
	74
	75	cs5535_mfgpt_write(timer, MFGPT_REG_SETUP,
	76	MFGPT_SETUP_CNTEN \| MFGPT_SETUP_CMP2);
	77	}
	78
8f9327cb	79	static int mfgpt_shutdown(struct clock_event_device *evt)
c30d7d2b AS	80	{
c30d7d2b AS	81	disable_timer(cs5535_event_clock);
8f9327cb VK	82	return 0;
8f9327cb VK	83	}
c30d7d2b	84
8f9327cb VK	85	static int mfgpt_set_periodic(struct clock_event_device *evt)
	86	{
	87	disable_timer(cs5535_event_clock);
	88	start_timer(cs5535_event_clock, MFGPT_PERIODIC);
	89	return 0;
c30d7d2b AS	90	}
	91
	92	static int mfgpt_next_event(unsigned long delta, struct clock_event_device *evt)
	93	{
	94	start_timer(cs5535_event_clock, delta);
	95	return 0;
	96	}
	97
	98	static struct clock_event_device cs5535_clockevent = {
	99	.name = DRV_NAME,
	100	.features = CLOCK_EVT_FEAT_PERIODIC \| CLOCK_EVT_FEAT_ONESHOT,
8f9327cb VK	101	.set_state_shutdown = mfgpt_shutdown,
	102	.set_state_periodic = mfgpt_set_periodic,
	103	.set_state_oneshot = mfgpt_shutdown,
	104	.tick_resume = mfgpt_shutdown,
c30d7d2b AS	105	.set_next_event = mfgpt_next_event,
c30d7d2b AS	106	.rating = 250,
c30d7d2b AS	107	};
	108
	109	static irqreturn_t mfgpt_tick(int irq, void *dev_id)
	110	{
	111	uint16_t val = cs5535_mfgpt_read(cs5535_event_clock, MFGPT_REG_SETUP);
	112
	113	/* See if the interrupt was for us */
	114	if (!(val & (MFGPT_SETUP_SETUP \| MFGPT_SETUP_CMP2 \| MFGPT_SETUP_CMP1)))
	115	return IRQ_NONE;
	116
	117	/* Turn off the clock (and clear the event) */
	118	disable_timer(cs5535_event_clock);
	119
8f9327cb	120	if (clockevent_state_shutdown(&cs5535_clockevent))
c30d7d2b AS	121	return IRQ_HANDLED;
	122
	123	/* Clear the counter */
	124	cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_COUNTER, 0);
	125
	126	/* Restart the clock in periodic mode */
	127
8f9327cb	128	if (clockevent_state_periodic(&cs5535_clockevent))
c30d7d2b AS	129	cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_SETUP,
	130	MFGPT_SETUP_CNTEN \| MFGPT_SETUP_CMP2);
	131
	132	cs5535_clockevent.event_handler(&cs5535_clockevent);
	133	return IRQ_HANDLED;
	134	}
	135
	136	static struct irqaction mfgptirq = {
	137	.handler = mfgpt_tick,
38c30a84	138	.flags = IRQF_NOBALANCING \| IRQF_TIMER \| IRQF_SHARED,
c30d7d2b AS	139	.name = DRV_NAME,
	140	};
	141
	142	static int __init cs5535_mfgpt_init(void)
	143	{
	144	struct cs5535_mfgpt_timer *timer;
	145	int ret;
	146	uint16_t val;
	147
	148	timer = cs5535_mfgpt_alloc_timer(MFGPT_TIMER_ANY, MFGPT_DOMAIN_WORKING);
	149	if (!timer) {
61e01be2	150	printk(KERN_ERR DRV_NAME ": Could not allocate MFGPT timer\n");
c30d7d2b AS	151	return -ENODEV;
	152	}
	153	cs5535_event_clock = timer;
	154
	155	/* Set up the IRQ on the MFGPT side */
	156	if (cs5535_mfgpt_setup_irq(timer, MFGPT_CMP2, &timer_irq)) {
	157	printk(KERN_ERR DRV_NAME ": Could not set up IRQ %d\n",
	158	timer_irq);
fdb19a6c	159	goto err_timer;
c30d7d2b AS	160	}
	161
	162	/* And register it with the kernel */
	163	ret = setup_irq(timer_irq, &mfgptirq);
	164	if (ret) {
	165	printk(KERN_ERR DRV_NAME ": Unable to set up the interrupt.\n");
fdb19a6c	166	goto err_irq;
c30d7d2b AS	167	}
	168
	169	/* Set the clock scale and enable the event mode for CMP2 */
	170	val = MFGPT_SCALE \| (3 << 8);
	171
	172	cs5535_mfgpt_write(cs5535_event_clock, MFGPT_REG_SETUP, val);
	173
	174	/* Set up the clock event */
c30d7d2b AS	175	printk(KERN_INFO DRV_NAME
	176	": Registering MFGPT timer as a clock event, using IRQ %d\n",
	177	timer_irq);
77cc982f SG	178	clockevents_config_and_register(&cs5535_clockevent, MFGPT_HZ,
77cc982f SG	179	0xF, 0xFFFE);
c30d7d2b AS	180
	181	return 0;
	182
fdb19a6c	183	err_irq:
c30d7d2b	184	cs5535_mfgpt_release_irq(cs5535_event_clock, MFGPT_CMP2, &timer_irq);
fdb19a6c JR	185	err_timer:
fdb19a6c JR	186	cs5535_mfgpt_free_timer(cs5535_event_clock);
c30d7d2b AS	187	printk(KERN_ERR DRV_NAME ": Unable to set up the MFGPT clock source\n");
	188	return -EIO;
	189	}
	190
	191	module_init(cs5535_mfgpt_init);
	192
d45840d9	193	MODULE_AUTHOR("Andres Salomon <dilinger@queued.net>");
c30d7d2b AS	194	MODULE_DESCRIPTION("CS5535/CS5536 MFGPT clock event driver");
c30d7d2b AS	195	MODULE_LICENSE("GPL");