xref: /qemu/hw/isa/pc87312.c (revision 63f01a74aeeb9c4fb39e2b4100beb084f5c10c95)
1 /*
2  * QEMU National Semiconductor PC87312 (Super I/O)
3  *
4  * Copyright (c) 2010-2012 Herve Poussineau
5  * Copyright (c) 2011-2012 Andreas Färber
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  */
25 
26 #include "qemu/osdep.h"
27 #include "hw/isa/pc87312.h"
28 #include "qapi/error.h"
29 #include "qemu/error-report.h"
30 #include "sysemu/block-backend.h"
31 #include "sysemu/blockdev.h"
32 #include "sysemu/sysemu.h"
33 #include "chardev/char.h"
34 #include "trace.h"
35 
36 
37 #define REG_FER 0
38 #define REG_FAR 1
39 #define REG_PTR 2
40 
41 #define FER_PARALLEL_EN   0x01
42 #define FER_UART1_EN      0x02
43 #define FER_UART2_EN      0x04
44 #define FER_FDC_EN        0x08
45 #define FER_FDC_4         0x10
46 #define FER_FDC_ADDR      0x20
47 #define FER_IDE_EN        0x40
48 #define FER_IDE_ADDR      0x80
49 
50 #define FAR_PARALLEL_ADDR 0x03
51 #define FAR_UART1_ADDR    0x0C
52 #define FAR_UART2_ADDR    0x30
53 #define FAR_UART_3_4      0xC0
54 
55 #define PTR_POWER_DOWN    0x01
56 #define PTR_CLOCK_DOWN    0x02
57 #define PTR_PWDN          0x04
58 #define PTR_IRQ_5_7       0x08
59 #define PTR_UART1_TEST    0x10
60 #define PTR_UART2_TEST    0x20
61 #define PTR_LOCK_CONF     0x40
62 #define PTR_EPP_MODE      0x80
63 
64 
65 /* Parallel port */
66 
67 static inline bool is_parallel_enabled(PC87312State *s)
68 {
69     return s->regs[REG_FER] & FER_PARALLEL_EN;
70 }
71 
72 static const uint16_t parallel_base[] = { 0x378, 0x3bc, 0x278, 0x00 };
73 
74 static inline uint16_t get_parallel_iobase(PC87312State *s)
75 {
76     return parallel_base[s->regs[REG_FAR] & FAR_PARALLEL_ADDR];
77 }
78 
79 static const unsigned int parallel_irq[] = { 5, 7, 5, 0 };
80 
81 static inline unsigned int get_parallel_irq(PC87312State *s)
82 {
83     int idx;
84     idx = (s->regs[REG_FAR] & FAR_PARALLEL_ADDR);
85     if (idx == 0) {
86         return (s->regs[REG_PTR] & PTR_IRQ_5_7) ? 7 : 5;
87     } else {
88         return parallel_irq[idx];
89     }
90 }
91 
92 
93 /* UARTs */
94 
95 static const uint16_t uart_base[2][4] = {
96     { 0x3e8, 0x338, 0x2e8, 0x220 },
97     { 0x2e8, 0x238, 0x2e0, 0x228 }
98 };
99 
100 static inline uint16_t get_uart_iobase(PC87312State *s, int i)
101 {
102     int idx;
103     idx = (s->regs[REG_FAR] >> (2 * i + 2)) & 0x3;
104     if (idx == 0) {
105         return 0x3f8;
106     } else if (idx == 1) {
107         return 0x2f8;
108     } else {
109         return uart_base[idx & 1][(s->regs[REG_FAR] & FAR_UART_3_4) >> 6];
110     }
111 }
112 
113 static inline unsigned int get_uart_irq(PC87312State *s, int i)
114 {
115     int idx;
116     idx = (s->regs[REG_FAR] >> (2 * i + 2)) & 0x3;
117     return (idx & 1) ? 3 : 4;
118 }
119 
120 static inline bool is_uart_enabled(PC87312State *s, int i)
121 {
122     return s->regs[REG_FER] & (FER_UART1_EN << i);
123 }
124 
125 
126 /* Floppy controller */
127 
128 static inline bool is_fdc_enabled(PC87312State *s)
129 {
130     return s->regs[REG_FER] & FER_FDC_EN;
131 }
132 
133 static inline uint16_t get_fdc_iobase(PC87312State *s)
134 {
135     return (s->regs[REG_FER] & FER_FDC_ADDR) ? 0x370 : 0x3f0;
136 }
137 
138 
139 /* IDE controller */
140 
141 static inline bool is_ide_enabled(PC87312State *s)
142 {
143     return s->regs[REG_FER] & FER_IDE_EN;
144 }
145 
146 static inline uint16_t get_ide_iobase(PC87312State *s)
147 {
148     return (s->regs[REG_FER] & FER_IDE_ADDR) ? 0x170 : 0x1f0;
149 }
150 
151 
152 static void reconfigure_devices(PC87312State *s)
153 {
154     error_report("pc87312: unsupported device reconfiguration (%02x %02x %02x)",
155                  s->regs[REG_FER], s->regs[REG_FAR], s->regs[REG_PTR]);
156 }
157 
158 static void pc87312_soft_reset(PC87312State *s)
159 {
160     static const uint8_t fer_init[] = {
161         0x4f, 0x4f, 0x4f, 0x4f, 0x4f, 0x4f, 0x4b, 0x4b,
162         0x4b, 0x4b, 0x4b, 0x4b, 0x0f, 0x0f, 0x0f, 0x0f,
163         0x49, 0x49, 0x49, 0x49, 0x07, 0x07, 0x07, 0x07,
164         0x47, 0x47, 0x47, 0x47, 0x47, 0x47, 0x08, 0x00,
165     };
166     static const uint8_t far_init[] = {
167         0x10, 0x11, 0x11, 0x39, 0x24, 0x38, 0x00, 0x01,
168         0x01, 0x09, 0x08, 0x08, 0x10, 0x11, 0x39, 0x24,
169         0x00, 0x01, 0x01, 0x00, 0x10, 0x11, 0x39, 0x24,
170         0x10, 0x11, 0x11, 0x39, 0x24, 0x38, 0x10, 0x10,
171     };
172     static const uint8_t ptr_init[] = {
173         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
174         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
175         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
176         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,
177     };
178 
179     s->read_id_step = 0;
180     s->selected_index = REG_FER;
181 
182     s->regs[REG_FER] = fer_init[s->config & 0x1f];
183     s->regs[REG_FAR] = far_init[s->config & 0x1f];
184     s->regs[REG_PTR] = ptr_init[s->config & 0x1f];
185 }
186 
187 static void pc87312_hard_reset(PC87312State *s)
188 {
189     pc87312_soft_reset(s);
190 }
191 
192 static void pc87312_io_write(void *opaque, hwaddr addr, uint64_t val,
193                              unsigned int size)
194 {
195     PC87312State *s = opaque;
196 
197     trace_pc87312_io_write(addr, val);
198 
199     if ((addr & 1) == 0) {
200         /* Index register */
201         s->read_id_step = 2;
202         s->selected_index = val;
203     } else {
204         /* Data register */
205         if (s->selected_index < 3) {
206             s->regs[s->selected_index] = val;
207             reconfigure_devices(s);
208         }
209     }
210 }
211 
212 static uint64_t pc87312_io_read(void *opaque, hwaddr addr, unsigned int size)
213 {
214     PC87312State *s = opaque;
215     uint32_t val;
216 
217     if ((addr & 1) == 0) {
218         /* Index register */
219         if (s->read_id_step++ == 0) {
220             val = 0x88;
221         } else if (s->read_id_step++ == 1) {
222             val = 0;
223         } else {
224             val = s->selected_index;
225         }
226     } else {
227         /* Data register */
228         if (s->selected_index < 3) {
229             val = s->regs[s->selected_index];
230         } else {
231             /* Invalid selected index */
232             val = 0;
233         }
234     }
235 
236     trace_pc87312_io_read(addr, val);
237     return val;
238 }
239 
240 static const MemoryRegionOps pc87312_io_ops = {
241     .read  = pc87312_io_read,
242     .write = pc87312_io_write,
243     .endianness = DEVICE_LITTLE_ENDIAN,
244     .valid = {
245         .min_access_size = 1,
246         .max_access_size = 1,
247     },
248 };
249 
250 static int pc87312_post_load(void *opaque, int version_id)
251 {
252     PC87312State *s = opaque;
253 
254     reconfigure_devices(s);
255     return 0;
256 }
257 
258 static void pc87312_reset(DeviceState *d)
259 {
260     PC87312State *s = PC87312(d);
261 
262     pc87312_soft_reset(s);
263 }
264 
265 static void pc87312_realize(DeviceState *dev, Error **errp)
266 {
267     PC87312State *s;
268     DeviceState *d;
269     ISADevice *isa;
270     ISABus *bus;
271     Chardev *chr;
272     DriveInfo *drive;
273     Error *local_err = NULL;
274     char name[5];
275     int i;
276 
277     s = PC87312(dev);
278     isa = ISA_DEVICE(dev);
279     bus = isa_bus_from_device(isa);
280     isa_register_ioport(isa, &s->io, s->iobase);
281     pc87312_hard_reset(s);
282 
283     ISA_SUPERIO_GET_CLASS(dev)->parent_realize(dev, &local_err);
284     if (local_err) {
285         error_propagate(errp, local_err);
286         return;
287     }
288 
289     if (is_parallel_enabled(s)) {
290         /* FIXME use a qdev chardev prop instead of parallel_hds[] */
291         chr = parallel_hds[0];
292         if (chr == NULL) {
293             chr = qemu_chr_new("par0", "null");
294         }
295         isa = isa_create(bus, "isa-parallel");
296         d = DEVICE(isa);
297         qdev_prop_set_uint32(d, "index", 0);
298         qdev_prop_set_uint32(d, "iobase", get_parallel_iobase(s));
299         qdev_prop_set_uint32(d, "irq", get_parallel_irq(s));
300         qdev_prop_set_chr(d, "chardev", chr);
301         qdev_init_nofail(d);
302         s->parallel.dev = isa;
303         trace_pc87312_info_parallel(get_parallel_iobase(s),
304                                     get_parallel_irq(s));
305     }
306 
307     for (i = 0; i < 2; i++) {
308         if (is_uart_enabled(s, i)) {
309             /* FIXME use a qdev chardev prop instead of serial_hds[] */
310             chr = serial_hds[i];
311             if (chr == NULL) {
312                 snprintf(name, sizeof(name), "ser%d", i);
313                 chr = qemu_chr_new(name, "null");
314             }
315             isa = isa_create(bus, "isa-serial");
316             d = DEVICE(isa);
317             qdev_prop_set_uint32(d, "index", i);
318             qdev_prop_set_uint32(d, "iobase", get_uart_iobase(s, i));
319             qdev_prop_set_uint32(d, "irq", get_uart_irq(s, i));
320             qdev_prop_set_chr(d, "chardev", chr);
321             qdev_init_nofail(d);
322             s->uart[i].dev = isa;
323             trace_pc87312_info_serial(i, get_uart_iobase(s, i),
324                                       get_uart_irq(s, i));
325         }
326     }
327 
328     if (is_fdc_enabled(s)) {
329         isa = isa_create(bus, "isa-fdc");
330         d = DEVICE(isa);
331         qdev_prop_set_uint32(d, "iobase", get_fdc_iobase(s));
332         qdev_prop_set_uint32(d, "irq", 6);
333         /* FIXME use a qdev drive property instead of drive_get() */
334         drive = drive_get(IF_FLOPPY, 0, 0);
335         if (drive != NULL) {
336             qdev_prop_set_drive(d, "driveA", blk_by_legacy_dinfo(drive),
337                                 &error_fatal);
338         }
339         /* FIXME use a qdev drive property instead of drive_get() */
340         drive = drive_get(IF_FLOPPY, 0, 1);
341         if (drive != NULL) {
342             qdev_prop_set_drive(d, "driveB", blk_by_legacy_dinfo(drive),
343                                 &error_fatal);
344         }
345         qdev_init_nofail(d);
346         s->fdc.dev = isa;
347         trace_pc87312_info_floppy(get_fdc_iobase(s));
348     }
349 
350     if (is_ide_enabled(s)) {
351         isa = isa_create(bus, "isa-ide");
352         d = DEVICE(isa);
353         qdev_prop_set_uint32(d, "iobase", get_ide_iobase(s));
354         qdev_prop_set_uint32(d, "iobase2", get_ide_iobase(s) + 0x206);
355         qdev_prop_set_uint32(d, "irq", 14);
356         qdev_init_nofail(d);
357         s->ide.dev = isa;
358         trace_pc87312_info_ide(get_ide_iobase(s));
359     }
360 }
361 
362 static void pc87312_initfn(Object *obj)
363 {
364     PC87312State *s = PC87312(obj);
365 
366     memory_region_init_io(&s->io, obj, &pc87312_io_ops, s, "pc87312", 2);
367 }
368 
369 static const VMStateDescription vmstate_pc87312 = {
370     .name = "pc87312",
371     .version_id = 1,
372     .minimum_version_id = 1,
373     .post_load = pc87312_post_load,
374     .fields = (VMStateField[]) {
375         VMSTATE_UINT8(read_id_step, PC87312State),
376         VMSTATE_UINT8(selected_index, PC87312State),
377         VMSTATE_UINT8_ARRAY(regs, PC87312State, 3),
378         VMSTATE_END_OF_LIST()
379     }
380 };
381 
382 static Property pc87312_properties[] = {
383     DEFINE_PROP_UINT16("iobase", PC87312State, iobase, 0x398),
384     DEFINE_PROP_UINT8("config", PC87312State, config, 1),
385     DEFINE_PROP_END_OF_LIST()
386 };
387 
388 static void pc87312_class_init(ObjectClass *klass, void *data)
389 {
390     DeviceClass *dc = DEVICE_CLASS(klass);
391     ISASuperIOClass *sc = ISA_SUPERIO_CLASS(klass);
392 
393     sc->parent_realize = dc->realize;
394     dc->realize = pc87312_realize;
395     dc->reset = pc87312_reset;
396     dc->vmsd = &vmstate_pc87312;
397     dc->props = pc87312_properties;
398     /* Reason: Uses parallel_hds[0] in realize(), so it can't be used twice */
399     dc->user_creatable = false;
400 }
401 
402 static const TypeInfo pc87312_type_info = {
403     .name          = TYPE_PC87312_SUPERIO,
404     .parent        = TYPE_ISA_SUPERIO,
405     .instance_size = sizeof(PC87312State),
406     .instance_init = pc87312_initfn,
407     .class_init    = pc87312_class_init,
408 };
409 
410 static void pc87312_register_types(void)
411 {
412     type_register_static(&pc87312_type_info);
413 }
414 
415 type_init(pc87312_register_types)
416