2 * QEMU Parallel PORT emulation
4 * Copyright (c) 2003-2005 Fabrice Bellard
5 * Copyright (c) 2007 Marko Kohtala
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
28 #include "sysemu/char.h"
29 #include "hw/isa/isa.h"
30 #include "hw/i386/pc.h"
31 #include "sysemu/sysemu.h"
33 //#define DEBUG_PARALLEL
36 #define pdebug(fmt, ...) printf("pp: " fmt, ## __VA_ARGS__)
38 #define pdebug(fmt, ...) ((void)0)
41 #define PARA_REG_DATA 0
42 #define PARA_REG_STS 1
43 #define PARA_REG_CTR 2
44 #define PARA_REG_EPP_ADDR 3
45 #define PARA_REG_EPP_DATA 4
48 * These are the definitions for the Printer Status Register
50 #define PARA_STS_BUSY 0x80 /* Busy complement */
51 #define PARA_STS_ACK 0x40 /* Acknowledge */
52 #define PARA_STS_PAPER 0x20 /* Out of paper */
53 #define PARA_STS_ONLINE 0x10 /* Online */
54 #define PARA_STS_ERROR 0x08 /* Error complement */
55 #define PARA_STS_TMOUT 0x01 /* EPP timeout */
58 * These are the definitions for the Printer Control Register
60 #define PARA_CTR_DIR 0x20 /* Direction (1=read, 0=write) */
61 #define PARA_CTR_INTEN 0x10 /* IRQ Enable */
62 #define PARA_CTR_SELECT 0x08 /* Select In complement */
63 #define PARA_CTR_INIT 0x04 /* Initialize Printer complement */
64 #define PARA_CTR_AUTOLF 0x02 /* Auto linefeed complement */
65 #define PARA_CTR_STROBE 0x01 /* Strobe complement */
67 #define PARA_CTR_SIGNAL (PARA_CTR_SELECT|PARA_CTR_INIT|PARA_CTR_AUTOLF|PARA_CTR_STROBE)
69 typedef struct ParallelState
{
80 uint32_t last_read_offset
; /* For debugging */
81 /* Memory-mapped interface */
83 PortioList portio_list
;
86 #define TYPE_ISA_PARALLEL "isa-parallel"
87 #define ISA_PARALLEL(obj) \
88 OBJECT_CHECK(ISAParallelState, (obj), TYPE_ISA_PARALLEL)
90 typedef struct ISAParallelState
{
99 static void parallel_update_irq(ParallelState
*s
)
102 qemu_irq_raise(s
->irq
);
104 qemu_irq_lower(s
->irq
);
108 parallel_ioport_write_sw(void *opaque
, uint32_t addr
, uint32_t val
)
110 ParallelState
*s
= opaque
;
112 pdebug("write addr=0x%02x val=0x%02x\n", addr
, val
);
118 parallel_update_irq(s
);
122 if ((val
& PARA_CTR_INIT
) == 0 ) {
123 s
->status
= PARA_STS_BUSY
;
124 s
->status
|= PARA_STS_ACK
;
125 s
->status
|= PARA_STS_ONLINE
;
126 s
->status
|= PARA_STS_ERROR
;
128 else if (val
& PARA_CTR_SELECT
) {
129 if (val
& PARA_CTR_STROBE
) {
130 s
->status
&= ~PARA_STS_BUSY
;
131 if ((s
->control
& PARA_CTR_STROBE
) == 0)
132 /* XXX this blocks entire thread. Rewrite to use
133 * qemu_chr_fe_write and background I/O callbacks */
134 qemu_chr_fe_write_all(s
->chr
, &s
->dataw
, 1);
136 if (s
->control
& PARA_CTR_INTEN
) {
141 parallel_update_irq(s
);
147 static void parallel_ioport_write_hw(void *opaque
, uint32_t addr
, uint32_t val
)
149 ParallelState
*s
= opaque
;
153 /* Sometimes programs do several writes for timing purposes on old
154 HW. Take care not to waste time on writes that do nothing. */
156 s
->last_read_offset
= ~0U;
163 pdebug("wd%02x\n", val
);
164 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_WRITE_DATA
, &parm
);
168 pdebug("ws%02x\n", val
);
169 if (val
& PARA_STS_TMOUT
)
174 if (s
->control
== val
)
176 pdebug("wc%02x\n", val
);
178 if ((val
& PARA_CTR_DIR
) != (s
->control
& PARA_CTR_DIR
)) {
179 if (val
& PARA_CTR_DIR
) {
184 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_DATA_DIR
, &dir
);
185 parm
&= ~PARA_CTR_DIR
;
188 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_WRITE_CONTROL
, &parm
);
191 case PARA_REG_EPP_ADDR
:
192 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != PARA_CTR_INIT
)
193 /* Controls not correct for EPP address cycle, so do nothing */
194 pdebug("wa%02x s\n", val
);
196 struct ParallelIOArg ioarg
= { .buffer
= &parm
, .count
= 1 };
197 if (qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_WRITE_ADDR
, &ioarg
)) {
199 pdebug("wa%02x t\n", val
);
202 pdebug("wa%02x\n", val
);
205 case PARA_REG_EPP_DATA
:
206 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != PARA_CTR_INIT
)
207 /* Controls not correct for EPP data cycle, so do nothing */
208 pdebug("we%02x s\n", val
);
210 struct ParallelIOArg ioarg
= { .buffer
= &parm
, .count
= 1 };
211 if (qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_WRITE
, &ioarg
)) {
213 pdebug("we%02x t\n", val
);
216 pdebug("we%02x\n", val
);
223 parallel_ioport_eppdata_write_hw2(void *opaque
, uint32_t addr
, uint32_t val
)
225 ParallelState
*s
= opaque
;
226 uint16_t eppdata
= cpu_to_le16(val
);
228 struct ParallelIOArg ioarg
= {
229 .buffer
= &eppdata
, .count
= sizeof(eppdata
)
231 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != PARA_CTR_INIT
) {
232 /* Controls not correct for EPP data cycle, so do nothing */
233 pdebug("we%04x s\n", val
);
236 err
= qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_WRITE
, &ioarg
);
239 pdebug("we%04x t\n", val
);
242 pdebug("we%04x\n", val
);
246 parallel_ioport_eppdata_write_hw4(void *opaque
, uint32_t addr
, uint32_t val
)
248 ParallelState
*s
= opaque
;
249 uint32_t eppdata
= cpu_to_le32(val
);
251 struct ParallelIOArg ioarg
= {
252 .buffer
= &eppdata
, .count
= sizeof(eppdata
)
254 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != PARA_CTR_INIT
) {
255 /* Controls not correct for EPP data cycle, so do nothing */
256 pdebug("we%08x s\n", val
);
259 err
= qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_WRITE
, &ioarg
);
262 pdebug("we%08x t\n", val
);
265 pdebug("we%08x\n", val
);
268 static uint32_t parallel_ioport_read_sw(void *opaque
, uint32_t addr
)
270 ParallelState
*s
= opaque
;
276 if (s
->control
& PARA_CTR_DIR
)
284 if ((s
->status
& PARA_STS_BUSY
) == 0 && (s
->control
& PARA_CTR_STROBE
) == 0) {
285 /* XXX Fixme: wait 5 microseconds */
286 if (s
->status
& PARA_STS_ACK
)
287 s
->status
&= ~PARA_STS_ACK
;
289 /* XXX Fixme: wait 5 microseconds */
290 s
->status
|= PARA_STS_ACK
;
291 s
->status
|= PARA_STS_BUSY
;
294 parallel_update_irq(s
);
300 pdebug("read addr=0x%02x val=0x%02x\n", addr
, ret
);
304 static uint32_t parallel_ioport_read_hw(void *opaque
, uint32_t addr
)
306 ParallelState
*s
= opaque
;
311 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_READ_DATA
, &ret
);
312 if (s
->last_read_offset
!= addr
|| s
->datar
!= ret
)
313 pdebug("rd%02x\n", ret
);
317 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_READ_STATUS
, &ret
);
318 ret
&= ~PARA_STS_TMOUT
;
320 ret
|= PARA_STS_TMOUT
;
321 if (s
->last_read_offset
!= addr
|| s
->status
!= ret
)
322 pdebug("rs%02x\n", ret
);
326 /* s->control has some bits fixed to 1. It is zero only when
327 it has not been yet written to. */
328 if (s
->control
== 0) {
329 qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_READ_CONTROL
, &ret
);
330 if (s
->last_read_offset
!= addr
)
331 pdebug("rc%02x\n", ret
);
336 if (s
->last_read_offset
!= addr
)
337 pdebug("rc%02x\n", ret
);
340 case PARA_REG_EPP_ADDR
:
341 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != (PARA_CTR_DIR
|PARA_CTR_INIT
))
342 /* Controls not correct for EPP addr cycle, so do nothing */
343 pdebug("ra%02x s\n", ret
);
345 struct ParallelIOArg ioarg
= { .buffer
= &ret
, .count
= 1 };
346 if (qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_READ_ADDR
, &ioarg
)) {
348 pdebug("ra%02x t\n", ret
);
351 pdebug("ra%02x\n", ret
);
354 case PARA_REG_EPP_DATA
:
355 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != (PARA_CTR_DIR
|PARA_CTR_INIT
))
356 /* Controls not correct for EPP data cycle, so do nothing */
357 pdebug("re%02x s\n", ret
);
359 struct ParallelIOArg ioarg
= { .buffer
= &ret
, .count
= 1 };
360 if (qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_READ
, &ioarg
)) {
362 pdebug("re%02x t\n", ret
);
365 pdebug("re%02x\n", ret
);
369 s
->last_read_offset
= addr
;
374 parallel_ioport_eppdata_read_hw2(void *opaque
, uint32_t addr
)
376 ParallelState
*s
= opaque
;
378 uint16_t eppdata
= ~0;
380 struct ParallelIOArg ioarg
= {
381 .buffer
= &eppdata
, .count
= sizeof(eppdata
)
383 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != (PARA_CTR_DIR
|PARA_CTR_INIT
)) {
384 /* Controls not correct for EPP data cycle, so do nothing */
385 pdebug("re%04x s\n", eppdata
);
388 err
= qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_READ
, &ioarg
);
389 ret
= le16_to_cpu(eppdata
);
393 pdebug("re%04x t\n", ret
);
396 pdebug("re%04x\n", ret
);
401 parallel_ioport_eppdata_read_hw4(void *opaque
, uint32_t addr
)
403 ParallelState
*s
= opaque
;
405 uint32_t eppdata
= ~0U;
407 struct ParallelIOArg ioarg
= {
408 .buffer
= &eppdata
, .count
= sizeof(eppdata
)
410 if ((s
->control
& (PARA_CTR_DIR
|PARA_CTR_SIGNAL
)) != (PARA_CTR_DIR
|PARA_CTR_INIT
)) {
411 /* Controls not correct for EPP data cycle, so do nothing */
412 pdebug("re%08x s\n", eppdata
);
415 err
= qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_EPP_READ
, &ioarg
);
416 ret
= le32_to_cpu(eppdata
);
420 pdebug("re%08x t\n", ret
);
423 pdebug("re%08x\n", ret
);
427 static void parallel_ioport_ecp_write(void *opaque
, uint32_t addr
, uint32_t val
)
429 pdebug("wecp%d=%02x\n", addr
& 7, val
);
432 static uint32_t parallel_ioport_ecp_read(void *opaque
, uint32_t addr
)
436 pdebug("recp%d:%02x\n", addr
& 7, ret
);
440 static void parallel_reset(void *opaque
)
442 ParallelState
*s
= opaque
;
446 s
->status
= PARA_STS_BUSY
;
447 s
->status
|= PARA_STS_ACK
;
448 s
->status
|= PARA_STS_ONLINE
;
449 s
->status
|= PARA_STS_ERROR
;
450 s
->status
|= PARA_STS_TMOUT
;
451 s
->control
= PARA_CTR_SELECT
;
452 s
->control
|= PARA_CTR_INIT
;
457 s
->last_read_offset
= ~0U;
460 static const int isa_parallel_io
[MAX_PARALLEL_PORTS
] = { 0x378, 0x278, 0x3bc };
462 static const MemoryRegionPortio isa_parallel_portio_hw_list
[] = {
464 .read
= parallel_ioport_read_hw
,
465 .write
= parallel_ioport_write_hw
},
467 .read
= parallel_ioport_eppdata_read_hw2
,
468 .write
= parallel_ioport_eppdata_write_hw2
},
470 .read
= parallel_ioport_eppdata_read_hw4
,
471 .write
= parallel_ioport_eppdata_write_hw4
},
473 .read
= parallel_ioport_ecp_read
,
474 .write
= parallel_ioport_ecp_write
},
475 PORTIO_END_OF_LIST(),
478 static const MemoryRegionPortio isa_parallel_portio_sw_list
[] = {
480 .read
= parallel_ioport_read_sw
,
481 .write
= parallel_ioport_write_sw
},
482 PORTIO_END_OF_LIST(),
486 static const VMStateDescription vmstate_parallel_isa
= {
487 .name
= "parallel_isa",
489 .minimum_version_id
= 1,
490 .fields
= (VMStateField
[]) {
491 VMSTATE_UINT8(state
.dataw
, ISAParallelState
),
492 VMSTATE_UINT8(state
.datar
, ISAParallelState
),
493 VMSTATE_UINT8(state
.status
, ISAParallelState
),
494 VMSTATE_UINT8(state
.control
, ISAParallelState
),
495 VMSTATE_INT32(state
.irq_pending
, ISAParallelState
),
496 VMSTATE_INT32(state
.epp_timeout
, ISAParallelState
),
497 VMSTATE_END_OF_LIST()
502 static void parallel_isa_realizefn(DeviceState
*dev
, Error
**errp
)
505 ISADevice
*isadev
= ISA_DEVICE(dev
);
506 ISAParallelState
*isa
= ISA_PARALLEL(dev
);
507 ParallelState
*s
= &isa
->state
;
512 error_setg(errp
, "Can't create parallel device, empty char device");
516 if (isa
->index
== -1) {
519 if (isa
->index
>= MAX_PARALLEL_PORTS
) {
520 error_setg(errp
, "Max. supported number of parallel ports is %d.",
524 if (isa
->iobase
== -1) {
525 isa
->iobase
= isa_parallel_io
[isa
->index
];
530 isa_init_irq(isadev
, &s
->irq
, isa
->isairq
);
531 qemu_register_reset(parallel_reset
, s
);
533 if (qemu_chr_fe_ioctl(s
->chr
, CHR_IOCTL_PP_READ_STATUS
, &dummy
) == 0) {
538 isa_register_portio_list(isadev
, &s
->portio_list
, base
,
540 ? &isa_parallel_portio_hw_list
[0]
541 : &isa_parallel_portio_sw_list
[0]),
545 /* Memory mapped interface */
546 static uint32_t parallel_mm_readb (void *opaque
, hwaddr addr
)
548 ParallelState
*s
= opaque
;
550 return parallel_ioport_read_sw(s
, addr
>> s
->it_shift
) & 0xFF;
553 static void parallel_mm_writeb (void *opaque
,
554 hwaddr addr
, uint32_t value
)
556 ParallelState
*s
= opaque
;
558 parallel_ioport_write_sw(s
, addr
>> s
->it_shift
, value
& 0xFF);
561 static uint32_t parallel_mm_readw (void *opaque
, hwaddr addr
)
563 ParallelState
*s
= opaque
;
565 return parallel_ioport_read_sw(s
, addr
>> s
->it_shift
) & 0xFFFF;
568 static void parallel_mm_writew (void *opaque
,
569 hwaddr addr
, uint32_t value
)
571 ParallelState
*s
= opaque
;
573 parallel_ioport_write_sw(s
, addr
>> s
->it_shift
, value
& 0xFFFF);
576 static uint32_t parallel_mm_readl (void *opaque
, hwaddr addr
)
578 ParallelState
*s
= opaque
;
580 return parallel_ioport_read_sw(s
, addr
>> s
->it_shift
);
583 static void parallel_mm_writel (void *opaque
,
584 hwaddr addr
, uint32_t value
)
586 ParallelState
*s
= opaque
;
588 parallel_ioport_write_sw(s
, addr
>> s
->it_shift
, value
);
591 static const MemoryRegionOps parallel_mm_ops
= {
593 .read
= { parallel_mm_readb
, parallel_mm_readw
, parallel_mm_readl
},
594 .write
= { parallel_mm_writeb
, parallel_mm_writew
, parallel_mm_writel
},
596 .endianness
= DEVICE_NATIVE_ENDIAN
,
599 /* If fd is zero, it means that the parallel device uses the console */
600 bool parallel_mm_init(MemoryRegion
*address_space
,
601 hwaddr base
, int it_shift
, qemu_irq irq
,
602 CharDriverState
*chr
)
606 s
= g_malloc0(sizeof(ParallelState
));
609 s
->it_shift
= it_shift
;
610 qemu_register_reset(parallel_reset
, s
);
612 memory_region_init_io(&s
->iomem
, NULL
, ¶llel_mm_ops
, s
,
613 "parallel", 8 << it_shift
);
614 memory_region_add_subregion(address_space
, base
, &s
->iomem
);
618 static Property parallel_isa_properties
[] = {
619 DEFINE_PROP_UINT32("index", ISAParallelState
, index
, -1),
620 DEFINE_PROP_UINT32("iobase", ISAParallelState
, iobase
, -1),
621 DEFINE_PROP_UINT32("irq", ISAParallelState
, isairq
, 7),
622 DEFINE_PROP_CHR("chardev", ISAParallelState
, state
.chr
),
623 DEFINE_PROP_END_OF_LIST(),
626 static void parallel_isa_class_initfn(ObjectClass
*klass
, void *data
)
628 DeviceClass
*dc
= DEVICE_CLASS(klass
);
630 dc
->realize
= parallel_isa_realizefn
;
631 dc
->vmsd
= &vmstate_parallel_isa
;
632 dc
->props
= parallel_isa_properties
;
633 set_bit(DEVICE_CATEGORY_INPUT
, dc
->categories
);
636 static const TypeInfo parallel_isa_info
= {
637 .name
= TYPE_ISA_PARALLEL
,
638 .parent
= TYPE_ISA_DEVICE
,
639 .instance_size
= sizeof(ISAParallelState
),
640 .class_init
= parallel_isa_class_initfn
,
643 static void parallel_register_types(void)
645 type_register_static(¶llel_isa_info
);
648 type_init(parallel_register_types
)