xref: /openbmc/qemu/include/hw/timer/i8254.h (revision db1015e9)
1 /*
2  * QEMU 8253/8254 interval timer emulation
3  *
4  * Copyright (c) 2003-2004 Fabrice Bellard
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 
25 #ifndef HW_I8254_H
26 #define HW_I8254_H
27 
28 #include "hw/qdev-properties.h"
29 #include "hw/isa/isa.h"
30 #include "qapi/error.h"
31 #include "qom/object.h"
32 
33 #define PIT_FREQ 1193182
34 
35 typedef struct PITChannelInfo {
36     int gate;
37     int mode;
38     int initial_count;
39     int out;
40 } PITChannelInfo;
41 
42 #define TYPE_PIT_COMMON "pit-common"
43 typedef struct PITCommonState PITCommonState;
44 typedef struct PITCommonClass PITCommonClass;
45 #define PIT_COMMON(obj) \
46      OBJECT_CHECK(PITCommonState, (obj), TYPE_PIT_COMMON)
47 #define PIT_COMMON_CLASS(klass) \
48      OBJECT_CLASS_CHECK(PITCommonClass, (klass), TYPE_PIT_COMMON)
49 #define PIT_COMMON_GET_CLASS(obj) \
50      OBJECT_GET_CLASS(PITCommonClass, (obj), TYPE_PIT_COMMON)
51 
52 #define TYPE_I8254 "isa-pit"
53 #define TYPE_KVM_I8254 "kvm-pit"
54 
55 static inline ISADevice *i8254_pit_init(ISABus *bus, int base, int isa_irq,
56                                         qemu_irq alt_irq)
57 {
58     DeviceState *dev;
59     ISADevice *d;
60 
61     d = isa_new(TYPE_I8254);
62     dev = DEVICE(d);
63     qdev_prop_set_uint32(dev, "iobase", base);
64     isa_realize_and_unref(d, bus, &error_fatal);
65     qdev_connect_gpio_out(dev, 0,
66                           isa_irq >= 0 ? isa_get_irq(d, isa_irq) : alt_irq);
67 
68     return d;
69 }
70 
71 static inline ISADevice *kvm_pit_init(ISABus *bus, int base)
72 {
73     DeviceState *dev;
74     ISADevice *d;
75 
76     d = isa_new(TYPE_KVM_I8254);
77     dev = DEVICE(d);
78     qdev_prop_set_uint32(dev, "iobase", base);
79     isa_realize_and_unref(d, bus, &error_fatal);
80 
81     return d;
82 }
83 
84 void pit_set_gate(ISADevice *dev, int channel, int val);
85 void pit_get_channel_info(ISADevice *dev, int channel, PITChannelInfo *info);
86 
87 #endif /* HW_I8254_H */
88