[qemu.git] / hw / timer / xilinx_timer.c

/*
 * QEMU model of the Xilinx timer block.
 *
 * Copyright (c) 2009 Edgar E. Iglesias.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "hw/sysbus.h"
#include "hw/ptimer.h"
#include "qemu/log.h"
#include "qemu/main-loop.h"

#define D(x)

#define R_TCSR     0
#define R_TLR      1
#define R_TCR      2
#define R_MAX      4

#define TCSR_MDT        (1<<0)
#define TCSR_UDT        (1<<1)
#define TCSR_GENT       (1<<2)
#define TCSR_CAPT       (1<<3)
#define TCSR_ARHT       (1<<4)
#define TCSR_LOAD       (1<<5)
#define TCSR_ENIT       (1<<6)
#define TCSR_ENT        (1<<7)
#define TCSR_TINT       (1<<8)
#define TCSR_PWMA       (1<<9)
#define TCSR_ENALL      (1<<10)

struct xlx_timer
{
    QEMUBH *bh;
    ptimer_state *ptimer;
    void *parent;
    int nr; /* for debug.  */

    unsigned long timer_div;

    uint32_t regs[R_MAX];
};

#define TYPE_XILINX_TIMER "xlnx.xps-timer"
#define XILINX_TIMER(obj) \
    OBJECT_CHECK(struct timerblock, (obj), TYPE_XILINX_TIMER)

struct timerblock
{
    SysBusDevice parent_obj;

    MemoryRegion mmio;
    qemu_irq irq;
    uint8_t one_timer_only;
    uint32_t freq_hz;
    struct xlx_timer *timers;
};

static inline unsigned int num_timers(struct timerblock *t)
{
    return 2 - t->one_timer_only;
}

static inline unsigned int timer_from_addr(hwaddr addr)
{
    /* Timers get a 4x32bit control reg area each.  */
    return addr >> 2;
}

static void timer_update_irq(struct timerblock *t)
{
    unsigned int i, irq = 0;
    uint32_t csr;

    for (i = 0; i < num_timers(t); i++) {
        csr = t->timers[i].regs[R_TCSR];
        irq |= (csr & TCSR_TINT) && (csr & TCSR_ENIT);
    }

    /* All timers within the same slave share a single IRQ line.  */
    qemu_set_irq(t->irq, !!irq);
}

static uint64_t
timer_read(void *opaque, hwaddr addr, unsigned int size)
{
    struct timerblock *t = opaque;
    struct xlx_timer *xt;
    uint32_t r = 0;
    unsigned int timer;

    addr >>= 2;
    timer = timer_from_addr(addr);
    xt = &t->timers[timer];
    /* Further decoding to address a specific timers reg.  */
    addr &= 0x3;
    switch (addr)
    {
        case R_TCR:
                r = ptimer_get_count(xt->ptimer);
                if (!(xt->regs[R_TCSR] & TCSR_UDT))
                    r = ~r;
                D(qemu_log("xlx_timer t=%d read counter=%x udt=%d\n",
                         timer, r, xt->regs[R_TCSR] & TCSR_UDT));
            break;
        default:
            if (addr < ARRAY_SIZE(xt->regs))
                r = xt->regs[addr];
            break;

    }
    D(fprintf(stderr, "%s timer=%d %x=%x\n", __func__, timer, addr * 4, r));
    return r;
}

static void timer_enable(struct xlx_timer *xt)
{
    uint64_t count;

    D(fprintf(stderr, "%s timer=%d down=%d\n", __func__,
              xt->nr, xt->regs[R_TCSR] & TCSR_UDT));

    ptimer_stop(xt->ptimer);

    if (xt->regs[R_TCSR] & TCSR_UDT)
        count = xt->regs[R_TLR];
    else
        count = ~0 - xt->regs[R_TLR];
    ptimer_set_limit(xt->ptimer, count, 1);
    ptimer_run(xt->ptimer, 1);
}

static void
timer_write(void *opaque, hwaddr addr,
            uint64_t val64, unsigned int size)
{
    struct timerblock *t = opaque;
    struct xlx_timer *xt;
    unsigned int timer;
    uint32_t value = val64;

    addr >>= 2;
    timer = timer_from_addr(addr);
    xt = &t->timers[timer];
    D(fprintf(stderr, "%s addr=%x val=%x (timer=%d off=%d)\n",
             __func__, addr * 4, value, timer, addr & 3));
    /* Further decoding to address a specific timers reg.  */
    addr &= 3;
    switch (addr) 
    {
        case R_TCSR:
            if (value & TCSR_TINT)
                value &= ~TCSR_TINT;

            xt->regs[addr] = value & 0x7ff;
            if (value & TCSR_ENT)
                timer_enable(xt);
            break;
 
        default:
            if (addr < ARRAY_SIZE(xt->regs))
                xt->regs[addr] = value;
            break;
    }
    timer_update_irq(t);
}

static const MemoryRegionOps timer_ops = {
    .read = timer_read,
    .write = timer_write,
    .endianness = DEVICE_NATIVE_ENDIAN,
    .valid = {
        .min_access_size = 4,
        .max_access_size = 4
    }
};

static void timer_hit(void *opaque)
{
    struct xlx_timer *xt = opaque;
    struct timerblock *t = xt->parent;
    D(fprintf(stderr, "%s %d\n", __func__, xt->nr));
    xt->regs[R_TCSR] |= TCSR_TINT;

    if (xt->regs[R_TCSR] & TCSR_ARHT)
        timer_enable(xt);
    timer_update_irq(t);
}

static void xilinx_timer_realize(DeviceState *dev, Error **errp)
{
    struct timerblock *t = XILINX_TIMER(dev);
    unsigned int i;

    /* Init all the ptimers.  */
    t->timers = g_malloc0(sizeof t->timers[0] * num_timers(t));
    for (i = 0; i < num_timers(t); i++) {
        struct xlx_timer *xt = &t->timers[i];

        xt->parent = t;
        xt->nr = i;
        xt->bh = qemu_bh_new(timer_hit, xt);
        xt->ptimer = ptimer_init(xt->bh);
        ptimer_set_freq(xt->ptimer, t->freq_hz);
    }

    memory_region_init_io(&t->mmio, OBJECT(t), &timer_ops, t, "xlnx.xps-timer",
                          R_MAX * 4 * num_timers(t));
    sysbus_init_mmio(SYS_BUS_DEVICE(dev), &t->mmio);
}

static void xilinx_timer_init(Object *obj)
{
    struct timerblock *t = XILINX_TIMER(obj);

    /* All timers share a single irq line.  */
    sysbus_init_irq(SYS_BUS_DEVICE(obj), &t->irq);
}

static Property xilinx_timer_properties[] = {
    DEFINE_PROP_UINT32("clock-frequency", struct timerblock, freq_hz,
                                                                62 * 1000000),
    DEFINE_PROP_UINT8("one-timer-only", struct timerblock, one_timer_only, 0),
    DEFINE_PROP_END_OF_LIST(),
};

static void xilinx_timer_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);

    dc->realize = xilinx_timer_realize;
    dc->props = xilinx_timer_properties;
}

static const TypeInfo xilinx_timer_info = {
    .name          = TYPE_XILINX_TIMER,
    .parent        = TYPE_SYS_BUS_DEVICE,
    .instance_size = sizeof(struct timerblock),
    .instance_init = xilinx_timer_init,
    .class_init    = xilinx_timer_class_init,
};

static void xilinx_timer_register_types(void)
{
    type_register_static(&xilinx_timer_info);
}

type_init(xilinx_timer_register_types)
Commit	Line	Data
388f60b1 EI	1	/*
	2	* QEMU model of the Xilinx timer block.
	3	*
	4	* Copyright (c) 2009 Edgar E. Iglesias.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
83c9f4ca PB	25	#include "hw/sysbus.h"
83c9f4ca PB	26	#include "hw/ptimer.h"
1de7afc9	27	#include "qemu/log.h"
6a1751b7	28	#include "qemu/main-loop.h"
388f60b1 EI	29
	30	#define D(x)
	31
	32	#define R_TCSR 0
	33	#define R_TLR 1
	34	#define R_TCR 2
	35	#define R_MAX 4
	36
	37	#define TCSR_MDT (1<<0)
	38	#define TCSR_UDT (1<<1)
	39	#define TCSR_GENT (1<<2)
	40	#define TCSR_CAPT (1<<3)
	41	#define TCSR_ARHT (1<<4)
	42	#define TCSR_LOAD (1<<5)
	43	#define TCSR_ENIT (1<<6)
	44	#define TCSR_ENT (1<<7)
	45	#define TCSR_TINT (1<<8)
	46	#define TCSR_PWMA (1<<9)
	47	#define TCSR_ENALL (1<<10)
	48
	49	struct xlx_timer
	50	{
	51	QEMUBH *bh;
	52	ptimer_state *ptimer;
	53	void *parent;
	54	int nr; /* for debug. */
	55
	56	unsigned long timer_div;
	57
	58	uint32_t regs[R_MAX];
	59	};
	60
760d1d00 AF	61	#define TYPE_XILINX_TIMER "xlnx.xps-timer"
	62	#define XILINX_TIMER(obj) \
	63	OBJECT_CHECK(struct timerblock, (obj), TYPE_XILINX_TIMER)
	64
388f60b1 EI	65	struct timerblock
388f60b1 EI	66	{
760d1d00 AF	67	SysBusDevice parent_obj;
760d1d00 AF	68
010f3f5f	69	MemoryRegion mmio;
388f60b1	70	qemu_irq irq;
abe098e4	71	uint8_t one_timer_only;
ee6847d1	72	uint32_t freq_hz;
388f60b1 EI	73	struct xlx_timer *timers;
	74	};
	75
abe098e4 PC	76	static inline unsigned int num_timers(struct timerblock *t)
	77	{
	78	return 2 - t->one_timer_only;
	79	}
	80
a8170e5e	81	static inline unsigned int timer_from_addr(hwaddr addr)
388f60b1 EI	82	{
	83	/* Timers get a 4x32bit control reg area each. */
	84	return addr >> 2;
	85	}
	86
	87	static void timer_update_irq(struct timerblock *t)
	88	{
	89	unsigned int i, irq = 0;
	90	uint32_t csr;
	91
abe098e4	92	for (i = 0; i < num_timers(t); i++) {
388f60b1 EI	93	csr = t->timers[i].regs[R_TCSR];
	94	irq \|= (csr & TCSR_TINT) && (csr & TCSR_ENIT);
	95	}
	96
	97	/* All timers within the same slave share a single IRQ line. */
	98	qemu_set_irq(t->irq, !!irq);
	99	}
	100
010f3f5f	101	static uint64_t
a8170e5e	102	timer_read(void *opaque, hwaddr addr, unsigned int size)
388f60b1 EI	103	{
	104	struct timerblock *t = opaque;
	105	struct xlx_timer *xt;
	106	uint32_t r = 0;
	107	unsigned int timer;
	108
	109	addr >>= 2;
	110	timer = timer_from_addr(addr);
	111	xt = &t->timers[timer];
	112	/* Further decoding to address a specific timers reg. */
	113	addr &= 0x3;
	114	switch (addr)
	115	{
	116	case R_TCR:
	117	r = ptimer_get_count(xt->ptimer);
	118	if (!(xt->regs[R_TCSR] & TCSR_UDT))
	119	r = ~r;
	120	D(qemu_log("xlx_timer t=%d read counter=%x udt=%d\n",
	121	timer, r, xt->regs[R_TCSR] & TCSR_UDT));
	122	break;
	123	default:
	124	if (addr < ARRAY_SIZE(xt->regs))
	125	r = xt->regs[addr];
	126	break;
	127
	128	}
e03377ae	129	D(fprintf(stderr, "%s timer=%d %x=%x\n", __func__, timer, addr * 4, r));
388f60b1 EI	130	return r;
	131	}
	132
	133	static void timer_enable(struct xlx_timer *xt)
	134	{
	135	uint64_t count;
	136
e03377ae	137	D(fprintf(stderr, "%s timer=%d down=%d\n", __func__,
388f60b1 EI	138	xt->nr, xt->regs[R_TCSR] & TCSR_UDT));
	139
	140	ptimer_stop(xt->ptimer);
	141
	142	if (xt->regs[R_TCSR] & TCSR_UDT)
	143	count = xt->regs[R_TLR];
	144	else
	145	count = ~0 - xt->regs[R_TLR];
7798a882	146	ptimer_set_limit(xt->ptimer, count, 1);
388f60b1 EI	147	ptimer_run(xt->ptimer, 1);
	148	}
	149
	150	static void
a8170e5e	151	timer_write(void *opaque, hwaddr addr,
010f3f5f	152	uint64_t val64, unsigned int size)
388f60b1 EI	153	{
	154	struct timerblock *t = opaque;
	155	struct xlx_timer *xt;
	156	unsigned int timer;
010f3f5f	157	uint32_t value = val64;
388f60b1 EI	158
	159	addr >>= 2;
	160	timer = timer_from_addr(addr);
	161	xt = &t->timers[timer];
e03377ae	162	D(fprintf(stderr, "%s addr=%x val=%x (timer=%d off=%d)\n",
388f60b1 EI	163	__func__, addr * 4, value, timer, addr & 3));
	164	/* Further decoding to address a specific timers reg. */
	165	addr &= 3;
	166	switch (addr)
	167	{
	168	case R_TCSR:
	169	if (value & TCSR_TINT)
	170	value &= ~TCSR_TINT;
	171
7dfba6df	172	xt->regs[addr] = value & 0x7ff;
388f60b1 EI	173	if (value & TCSR_ENT)
	174	timer_enable(xt);
	175	break;
	176
	177	default:
	178	if (addr < ARRAY_SIZE(xt->regs))
	179	xt->regs[addr] = value;
	180	break;
	181	}
	182	timer_update_irq(t);
	183	}
	184
010f3f5f EI	185	static const MemoryRegionOps timer_ops = {
	186	.read = timer_read,
	187	.write = timer_write,
	188	.endianness = DEVICE_NATIVE_ENDIAN,
	189	.valid = {
	190	.min_access_size = 4,
	191	.max_access_size = 4
	192	}
388f60b1 EI	193	};
	194
	195	static void timer_hit(void *opaque)
	196	{
	197	struct xlx_timer *xt = opaque;
	198	struct timerblock *t = xt->parent;
8354cd72	199	D(fprintf(stderr, "%s %d\n", __func__, xt->nr));
388f60b1 EI	200	xt->regs[R_TCSR] \|= TCSR_TINT;
	201
	202	if (xt->regs[R_TCSR] & TCSR_ARHT)
	203	timer_enable(xt);
	204	timer_update_irq(t);
	205	}
	206
04bb4d86	207	static void xilinx_timer_realize(DeviceState dev, Error *errp)
388f60b1	208	{
760d1d00	209	struct timerblock *t = XILINX_TIMER(dev);
388f60b1	210	unsigned int i;
388f60b1	211
388f60b1	212	/* Init all the ptimers. */
abe098e4 PC	213	t->timers = g_malloc0(sizeof t->timers[0] * num_timers(t));
abe098e4 PC	214	for (i = 0; i < num_timers(t); i++) {
388f60b1 EI	215	struct xlx_timer *xt = &t->timers[i];
	216
	217	xt->parent = t;
	218	xt->nr = i;
	219	xt->bh = qemu_bh_new(timer_hit, xt);
	220	xt->ptimer = ptimer_init(xt->bh);
ee6847d1	221	ptimer_set_freq(xt->ptimer, t->freq_hz);
388f60b1 EI	222	}
388f60b1 EI	223
853dca12	224	memory_region_init_io(&t->mmio, OBJECT(t), &timer_ops, t, "xlnx.xps-timer",
abe098e4	225	R_MAX * 4 * num_timers(t));
04bb4d86 PC	226	sysbus_init_mmio(SYS_BUS_DEVICE(dev), &t->mmio);
	227	}
	228
	229	static void xilinx_timer_init(Object *obj)
	230	{
	231	struct timerblock *t = XILINX_TIMER(obj);
	232
	233	/* All timers share a single irq line. */
	234	sysbus_init_irq(SYS_BUS_DEVICE(obj), &t->irq);
388f60b1 EI	235	}
388f60b1 EI	236
999e12bb	237	static Property xilinx_timer_properties[] = {
919f89f4 PC	238	DEFINE_PROP_UINT32("clock-frequency", struct timerblock, freq_hz,
919f89f4 PC	239	62 * 1000000),
abe098e4	240	DEFINE_PROP_UINT8("one-timer-only", struct timerblock, one_timer_only, 0),
999e12bb AL	241	DEFINE_PROP_END_OF_LIST(),
	242	};
	243
	244	static void xilinx_timer_class_init(ObjectClass klass, void data)
	245	{
39bffca2	246	DeviceClass *dc = DEVICE_CLASS(klass);
999e12bb	247
04bb4d86	248	dc->realize = xilinx_timer_realize;
39bffca2	249	dc->props = xilinx_timer_properties;
999e12bb AL	250	}
999e12bb AL	251
8c43a6f0	252	static const TypeInfo xilinx_timer_info = {
760d1d00	253	.name = TYPE_XILINX_TIMER,
39bffca2 AL	254	.parent = TYPE_SYS_BUS_DEVICE,
39bffca2 AL	255	.instance_size = sizeof(struct timerblock),
04bb4d86	256	.instance_init = xilinx_timer_init,
39bffca2	257	.class_init = xilinx_timer_class_init,
ee6847d1 GH	258	};
ee6847d1 GH	259
83f7d43a	260	static void xilinx_timer_register_types(void)
388f60b1	261	{
39bffca2	262	type_register_static(&xilinx_timer_info);
388f60b1 EI	263	}
388f60b1 EI	264
83f7d43a	265	type_init(xilinx_timer_register_types)