[qemu.git] / hw / i8254_common.c

/*
 * QEMU 8253/8254 - common bits of emulated and KVM kernel model
 *
 * Copyright (c) 2003-2004 Fabrice Bellard
 * Copyright (c) 2012      Jan Kiszka, Siemens AG
 *
 * 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/hw.h"
#include "hw/pc.h"
#include "hw/isa.h"
#include "qemu/timer.h"
#include "hw/i8254.h"
#include "hw/i8254_internal.h"

/* val must be 0 or 1 */
void pit_set_gate(ISADevice *dev, int channel, int val)
{
    PITCommonState *pit = PIT_COMMON(dev);
    PITChannelState *s = &pit->channels[channel];
    PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);

    c->set_channel_gate(pit, s, val);
}

/* get pit output bit */
int pit_get_out(PITChannelState *s, int64_t current_time)
{
    uint64_t d;
    int out;

    d = muldiv64(current_time - s->count_load_time, PIT_FREQ,
                 get_ticks_per_sec());
    switch (s->mode) {
    default:
    case 0:
        out = (d >= s->count);
        break;
    case 1:
        out = (d < s->count);
        break;
    case 2:
        if ((d % s->count) == 0 && d != 0) {
            out = 1;
        } else {
            out = 0;
        }
        break;
    case 3:
        out = (d % s->count) < ((s->count + 1) >> 1);
        break;
    case 4:
    case 5:
        out = (d == s->count);
        break;
    }
    return out;
}

/* return -1 if no transition will occur.  */
int64_t pit_get_next_transition_time(PITChannelState *s, int64_t current_time)
{
    uint64_t d, next_time, base;
    int period2;

    d = muldiv64(current_time - s->count_load_time, PIT_FREQ,
                 get_ticks_per_sec());
    switch (s->mode) {
    default:
    case 0:
    case 1:
        if (d < s->count) {
            next_time = s->count;
        } else {
            return -1;
        }
        break;
    case 2:
        base = (d / s->count) * s->count;
        if ((d - base) == 0 && d != 0) {
            next_time = base + s->count;
        } else {
            next_time = base + s->count + 1;
        }
        break;
    case 3:
        base = (d / s->count) * s->count;
        period2 = ((s->count + 1) >> 1);
        if ((d - base) < period2) {
            next_time = base + period2;
        } else {
            next_time = base + s->count;
        }
        break;
    case 4:
    case 5:
        if (d < s->count) {
            next_time = s->count;
        } else if (d == s->count) {
            next_time = s->count + 1;
        } else {
            return -1;
        }
        break;
    }
    /* convert to timer units */
    next_time = s->count_load_time + muldiv64(next_time, get_ticks_per_sec(),
                                              PIT_FREQ);
    /* fix potential rounding problems */
    /* XXX: better solution: use a clock at PIT_FREQ Hz */
    if (next_time <= current_time) {
        next_time = current_time + 1;
    }
    return next_time;
}

void pit_get_channel_info_common(PITCommonState *s, PITChannelState *sc,
                                 PITChannelInfo *info)
{
    info->gate = sc->gate;
    info->mode = sc->mode;
    info->initial_count = sc->count;
    info->out = pit_get_out(sc, qemu_get_clock_ns(vm_clock));
}

void pit_get_channel_info(ISADevice *dev, int channel, PITChannelInfo *info)
{
    PITCommonState *pit = PIT_COMMON(dev);
    PITChannelState *s = &pit->channels[channel];
    PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);

    c->get_channel_info(pit, s, info);
}

void pit_reset_common(PITCommonState *pit)
{
    PITChannelState *s;
    int i;

    for (i = 0; i < 3; i++) {
        s = &pit->channels[i];
        s->mode = 3;
        s->gate = (i != 2);
        s->count_load_time = qemu_get_clock_ns(vm_clock);
        s->count = 0x10000;
        if (i == 0 && !s->irq_disabled) {
            s->next_transition_time =
                pit_get_next_transition_time(s, s->count_load_time);
        }
    }
}

static int pit_init_common(ISADevice *dev)
{
    PITCommonState *pit = PIT_COMMON(dev);
    PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
    int ret;

    ret = c->init(pit);
    if (ret < 0) {
        return ret;
    }

    isa_register_ioport(dev, &pit->ioports, pit->iobase);

    qdev_set_legacy_instance_id(&dev->qdev, pit->iobase, 2);

    return 0;
}

static const VMStateDescription vmstate_pit_channel = {
    .name = "pit channel",
    .version_id = 2,
    .minimum_version_id = 2,
    .minimum_version_id_old = 2,
    .fields = (VMStateField[]) {
        VMSTATE_INT32(count, PITChannelState),
        VMSTATE_UINT16(latched_count, PITChannelState),
        VMSTATE_UINT8(count_latched, PITChannelState),
        VMSTATE_UINT8(status_latched, PITChannelState),
        VMSTATE_UINT8(status, PITChannelState),
        VMSTATE_UINT8(read_state, PITChannelState),
        VMSTATE_UINT8(write_state, PITChannelState),
        VMSTATE_UINT8(write_latch, PITChannelState),
        VMSTATE_UINT8(rw_mode, PITChannelState),
        VMSTATE_UINT8(mode, PITChannelState),
        VMSTATE_UINT8(bcd, PITChannelState),
        VMSTATE_UINT8(gate, PITChannelState),
        VMSTATE_INT64(count_load_time, PITChannelState),
        VMSTATE_INT64(next_transition_time, PITChannelState),
        VMSTATE_END_OF_LIST()
    }
};

static int pit_load_old(QEMUFile *f, void *opaque, int version_id)
{
    PITCommonState *pit = opaque;
    PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
    PITChannelState *s;
    int i;

    if (version_id != 1) {
        return -EINVAL;
    }

    for (i = 0; i < 3; i++) {
        s = &pit->channels[i];
        s->count = qemu_get_be32(f);
        qemu_get_be16s(f, &s->latched_count);
        qemu_get_8s(f, &s->count_latched);
        qemu_get_8s(f, &s->status_latched);
        qemu_get_8s(f, &s->status);
        qemu_get_8s(f, &s->read_state);
        qemu_get_8s(f, &s->write_state);
        qemu_get_8s(f, &s->write_latch);
        qemu_get_8s(f, &s->rw_mode);
        qemu_get_8s(f, &s->mode);
        qemu_get_8s(f, &s->bcd);
        qemu_get_8s(f, &s->gate);
        s->count_load_time = qemu_get_be64(f);
        s->irq_disabled = 0;
        if (i == 0) {
            s->next_transition_time = qemu_get_be64(f);
        }
    }
    if (c->post_load) {
        c->post_load(pit);
    }
    return 0;
}

static void pit_dispatch_pre_save(void *opaque)
{
    PITCommonState *s = opaque;
    PITCommonClass *c = PIT_COMMON_GET_CLASS(s);

    if (c->pre_save) {
        c->pre_save(s);
    }
}

static int pit_dispatch_post_load(void *opaque, int version_id)
{
    PITCommonState *s = opaque;
    PITCommonClass *c = PIT_COMMON_GET_CLASS(s);

    if (c->post_load) {
        c->post_load(s);
    }
    return 0;
}

static const VMStateDescription vmstate_pit_common = {
    .name = "i8254",
    .version_id = 3,
    .minimum_version_id = 2,
    .minimum_version_id_old = 1,
    .load_state_old = pit_load_old,
    .pre_save = pit_dispatch_pre_save,
    .post_load = pit_dispatch_post_load,
    .fields = (VMStateField[]) {
        VMSTATE_UINT32_V(channels[0].irq_disabled, PITCommonState, 3),
        VMSTATE_STRUCT_ARRAY(channels, PITCommonState, 3, 2,
                             vmstate_pit_channel, PITChannelState),
        VMSTATE_INT64(channels[0].next_transition_time,
                      PITCommonState), /* formerly irq_timer */
        VMSTATE_END_OF_LIST()
    }
};

static void pit_common_class_init(ObjectClass *klass, void *data)
{
    ISADeviceClass *ic = ISA_DEVICE_CLASS(klass);
    DeviceClass *dc = DEVICE_CLASS(klass);

    ic->init = pit_init_common;
    dc->vmsd = &vmstate_pit_common;
    dc->no_user = 1;
}

static const TypeInfo pit_common_type = {
    .name          = TYPE_PIT_COMMON,
    .parent        = TYPE_ISA_DEVICE,
    .instance_size = sizeof(PITCommonState),
    .class_size    = sizeof(PITCommonClass),
    .class_init    = pit_common_class_init,
    .abstract      = true,
};

static void register_devices(void)
{
    type_register_static(&pit_common_type);
}

type_init(register_devices);
Commit	Line	Data
d11e859e JK	1	/*
	2	* QEMU 8253/8254 - common bits of emulated and KVM kernel model
	3	*
	4	* Copyright (c) 2003-2004 Fabrice Bellard
	5	* Copyright (c) 2012 Jan Kiszka, Siemens AG
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	20	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	23	* THE SOFTWARE.
	24	*/
83c9f4ca PB	25	#include "hw/hw.h"
	26	#include "hw/pc.h"
	27	#include "hw/isa.h"
1de7afc9	28	#include "qemu/timer.h"
83c9f4ca PB	29	#include "hw/i8254.h"
83c9f4ca PB	30	#include "hw/i8254_internal.h"
d11e859e JK	31
	32	/* val must be 0 or 1 */
	33	void pit_set_gate(ISADevice *dev, int channel, int val)
	34	{
	35	PITCommonState *pit = PIT_COMMON(dev);
	36	PITChannelState *s = &pit->channels[channel];
	37	PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
	38
	39	c->set_channel_gate(pit, s, val);
	40	}
	41
	42	/* get pit output bit */
	43	int pit_get_out(PITChannelState *s, int64_t current_time)
	44	{
	45	uint64_t d;
	46	int out;
	47
	48	d = muldiv64(current_time - s->count_load_time, PIT_FREQ,
	49	get_ticks_per_sec());
	50	switch (s->mode) {
	51	default:
	52	case 0:
	53	out = (d >= s->count);
	54	break;
	55	case 1:
	56	out = (d < s->count);
	57	break;
	58	case 2:
	59	if ((d % s->count) == 0 && d != 0) {
	60	out = 1;
	61	} else {
	62	out = 0;
	63	}
	64	break;
	65	case 3:
	66	out = (d % s->count) < ((s->count + 1) >> 1);
	67	break;
	68	case 4:
	69	case 5:
	70	out = (d == s->count);
	71	break;
	72	}
	73	return out;
	74	}
	75
	76	/* return -1 if no transition will occur. */
	77	int64_t pit_get_next_transition_time(PITChannelState *s, int64_t current_time)
	78	{
	79	uint64_t d, next_time, base;
	80	int period2;
	81
	82	d = muldiv64(current_time - s->count_load_time, PIT_FREQ,
	83	get_ticks_per_sec());
	84	switch (s->mode) {
	85	default:
	86	case 0:
	87	case 1:
	88	if (d < s->count) {
	89	next_time = s->count;
	90	} else {
	91	return -1;
	92	}
	93	break;
	94	case 2:
95	base = (d / s->count) * s->count;
96	if ((d - base) == 0 && d != 0) {
97	next_time = base + s->count;
98	} else {
99	next_time = base + s->count + 1;
100	}
101	break;
102	case 3:
103	base = (d / s->count) * s->count;
104	period2 = ((s->count + 1) >> 1);
105	if ((d - base) < period2) {
106	next_time = base + period2;
107	} else {
108	next_time = base + s->count;
109	}
110	break;
111	case 4:
112	case 5:
113	if (d < s->count) {
114	next_time = s->count;
115	} else if (d == s->count) {
116	next_time = s->count + 1;
117	} else {
118	return -1;
119	}
120	break;
121	}
122	/* convert to timer units */
123	next_time = s->count_load_time + muldiv64(next_time, get_ticks_per_sec(),
124	PIT_FREQ);
125	/* fix potential rounding problems */
126	/* XXX: better solution: use a clock at PIT_FREQ Hz */
127	if (next_time <= current_time) {
128	next_time = current_time + 1;
129	}
130	return next_time;
131	}
132
133	void pit_get_channel_info_common(PITCommonState s, PITChannelState sc,
134	PITChannelInfo *info)
135	{
136	info->gate = sc->gate;
137	info->mode = sc->mode;
138	info->initial_count = sc->count;
139	info->out = pit_get_out(sc, qemu_get_clock_ns(vm_clock));
140	}
141
142	void pit_get_channel_info(ISADevice dev, int channel, PITChannelInfo info)
143	{
144	PITCommonState *pit = PIT_COMMON(dev);
145	PITChannelState *s = &pit->channels[channel];
146	PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
147
148	c->get_channel_info(pit, s, info);
149	}
150
151	void pit_reset_common(PITCommonState *pit)
152	{
153	PITChannelState *s;
154	int i;
155
156	for (i = 0; i < 3; i++) {
157	s = &pit->channels[i];
158	s->mode = 3;
159	s->gate = (i != 2);
160	s->count_load_time = qemu_get_clock_ns(vm_clock);
161	s->count = 0x10000;
162	if (i == 0 && !s->irq_disabled) {
163	s->next_transition_time =
164	pit_get_next_transition_time(s, s->count_load_time);
165	}
166	}
167	}
168
169	static int pit_init_common(ISADevice *dev)
170	{
171	PITCommonState *pit = PIT_COMMON(dev);
172	PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
173	int ret;
174
175	ret = c->init(pit);
176	if (ret < 0) {
177	return ret;
178	}
179
180	isa_register_ioport(dev, &pit->ioports, pit->iobase);
181
182	qdev_set_legacy_instance_id(&dev->qdev, pit->iobase, 2);
183
184	return 0;
185	}
186
187	static const VMStateDescription vmstate_pit_channel = {
188	.name = "pit channel",
189	.version_id = 2,
190	.minimum_version_id = 2,
191	.minimum_version_id_old = 2,
192	.fields = (VMStateField[]) {
193	VMSTATE_INT32(count, PITChannelState),
194	VMSTATE_UINT16(latched_count, PITChannelState),
195	VMSTATE_UINT8(count_latched, PITChannelState),
196	VMSTATE_UINT8(status_latched, PITChannelState),
197	VMSTATE_UINT8(status, PITChannelState),
198	VMSTATE_UINT8(read_state, PITChannelState),
199	VMSTATE_UINT8(write_state, PITChannelState),
200	VMSTATE_UINT8(write_latch, PITChannelState),
201	VMSTATE_UINT8(rw_mode, PITChannelState),
202	VMSTATE_UINT8(mode, PITChannelState),
203	VMSTATE_UINT8(bcd, PITChannelState),
204	VMSTATE_UINT8(gate, PITChannelState),
205	VMSTATE_INT64(count_load_time, PITChannelState),
206	VMSTATE_INT64(next_transition_time, PITChannelState),
207	VMSTATE_END_OF_LIST()
208	}
209	};
210
211	static int pit_load_old(QEMUFile f, void opaque, int version_id)
212	{
213	PITCommonState *pit = opaque;
3fbc1c0c	214	PITCommonClass *c = PIT_COMMON_GET_CLASS(pit);
d11e859e JK	215	PITChannelState *s;
	216	int i;
	217
	218	if (version_id != 1) {
	219	return -EINVAL;
	220	}
	221
	222	for (i = 0; i < 3; i++) {
	223	s = &pit->channels[i];
	224	s->count = qemu_get_be32(f);
	225	qemu_get_be16s(f, &s->latched_count);
	226	qemu_get_8s(f, &s->count_latched);
	227	qemu_get_8s(f, &s->status_latched);
	228	qemu_get_8s(f, &s->status);
	229	qemu_get_8s(f, &s->read_state);
	230	qemu_get_8s(f, &s->write_state);
	231	qemu_get_8s(f, &s->write_latch);
	232	qemu_get_8s(f, &s->rw_mode);
	233	qemu_get_8s(f, &s->mode);
	234	qemu_get_8s(f, &s->bcd);
	235	qemu_get_8s(f, &s->gate);
	236	s->count_load_time = qemu_get_be64(f);
	237	s->irq_disabled = 0;
3fbc1c0c	238	if (i == 0) {
d11e859e	239	s->next_transition_time = qemu_get_be64(f);
d11e859e JK	240	}
d11e859e JK	241	}
3fbc1c0c JK	242	if (c->post_load) {
	243	c->post_load(pit);
	244	}
d11e859e JK	245	return 0;
	246	}
	247
	248	static void pit_dispatch_pre_save(void *opaque)
	249	{
	250	PITCommonState *s = opaque;
	251	PITCommonClass *c = PIT_COMMON_GET_CLASS(s);
	252
	253	if (c->pre_save) {
	254	c->pre_save(s);
	255	}
	256	}
	257
	258	static int pit_dispatch_post_load(void *opaque, int version_id)
	259	{
	260	PITCommonState *s = opaque;
	261	PITCommonClass *c = PIT_COMMON_GET_CLASS(s);
	262
	263	if (c->post_load) {
	264	c->post_load(s);
	265	}
	266	return 0;
	267	}
	268
	269	static const VMStateDescription vmstate_pit_common = {
	270	.name = "i8254",
	271	.version_id = 3,
	272	.minimum_version_id = 2,
	273	.minimum_version_id_old = 1,
	274	.load_state_old = pit_load_old,
	275	.pre_save = pit_dispatch_pre_save,
	276	.post_load = pit_dispatch_post_load,
	277	.fields = (VMStateField[]) {
	278	VMSTATE_UINT32_V(channels[0].irq_disabled, PITCommonState, 3),
	279	VMSTATE_STRUCT_ARRAY(channels, PITCommonState, 3, 2,
	280	vmstate_pit_channel, PITChannelState),
3fbc1c0c JK	281	VMSTATE_INT64(channels[0].next_transition_time,
3fbc1c0c JK	282	PITCommonState), /* formerly irq_timer */
d11e859e JK	283	VMSTATE_END_OF_LIST()
	284	}
	285	};
	286
	287	static void pit_common_class_init(ObjectClass klass, void data)
	288	{
	289	ISADeviceClass *ic = ISA_DEVICE_CLASS(klass);
	290	DeviceClass *dc = DEVICE_CLASS(klass);
	291
	292	ic->init = pit_init_common;
	293	dc->vmsd = &vmstate_pit_common;
	294	dc->no_user = 1;
	295	}
	296
8c43a6f0	297	static const TypeInfo pit_common_type = {
d11e859e JK	298	.name = TYPE_PIT_COMMON,
	299	.parent = TYPE_ISA_DEVICE,
	300	.instance_size = sizeof(PITCommonState),
	301	.class_size = sizeof(PITCommonClass),
	302	.class_init = pit_common_class_init,
	303	.abstract = true,
	304	};
	305
	306	static void register_devices(void)
	307	{
	308	type_register_static(&pit_common_type);
	309	}
	310
	311	type_init(register_devices);