2 * QEMU Sparc SLAVIO serial port emulation
4 * Copyright (c) 2003-2005 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
26 //#define DEBUG_SERIAL
35 * This is the serial port, mouse and keyboard part of chip STP2001
36 * (Slave I/O), also produced as NCR89C105. See
37 * http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR89C105.txt
39 * The serial ports implement full AMD AM8530 or Zilog Z8530 chips,
40 * mouse and keyboard ports don't implement all functions and they are
41 * only asynchronous. There is no DMA.
47 * 2006-Aug-10 Igor Kovalenko : Renamed KBDQueue to SERIOQueue, implemented
49 * Implemented serial mouse protocol.
53 #define SER_DPRINTF(fmt, args...) \
54 do { printf("SER: " fmt , ##args); } while (0)
56 #define SER_DPRINTF(fmt, args...)
59 #define KBD_DPRINTF(fmt, args...) \
60 do { printf("KBD: " fmt , ##args); } while (0)
62 #define KBD_DPRINTF(fmt, args...)
65 #define MS_DPRINTF(fmt, args...) \
66 do { printf("MSC: " fmt , ##args); } while (0)
68 #define MS_DPRINTF(fmt, args...)
75 #define CHN_C(s) ((s)->chn == chn_b? 'b' : 'a')
81 #define SERIO_QUEUE_SIZE 256
84 uint8_t data
[SERIO_QUEUE_SIZE
];
85 int rptr
, wptr
, count
;
88 typedef struct ChannelState
{
91 int rxint
, txint
, rxint_under_svc
, txint_under_svc
;
92 chn_id_t chn
; // this channel, A (base+4) or B (base+0)
94 struct ChannelState
*otherchn
;
95 uint8_t rx
, tx
, wregs
[16], rregs
[16];
101 struct ChannelState chn
[2];
104 #define SERIAL_MAXADDR 7
106 static void handle_kbd_command(ChannelState
*s
, int val
);
107 static int serial_can_receive(void *opaque
);
108 static void serial_receive_byte(ChannelState
*s
, int ch
);
109 static inline void set_txint(ChannelState
*s
);
111 static void put_queue(void *opaque
, int b
)
113 ChannelState
*s
= opaque
;
114 SERIOQueue
*q
= &s
->queue
;
116 SER_DPRINTF("channel %c put: 0x%02x\n", CHN_C(s
), b
);
117 if (q
->count
>= SERIO_QUEUE_SIZE
)
119 q
->data
[q
->wptr
] = b
;
120 if (++q
->wptr
== SERIO_QUEUE_SIZE
)
123 serial_receive_byte(s
, 0);
126 static uint32_t get_queue(void *opaque
)
128 ChannelState
*s
= opaque
;
129 SERIOQueue
*q
= &s
->queue
;
135 val
= q
->data
[q
->rptr
];
136 if (++q
->rptr
== SERIO_QUEUE_SIZE
)
140 KBD_DPRINTF("channel %c get 0x%02x\n", CHN_C(s
), val
);
142 serial_receive_byte(s
, 0);
146 static int slavio_serial_update_irq_chn(ChannelState
*s
)
148 if ((s
->wregs
[1] & 1) && // interrupts enabled
149 (((s
->wregs
[1] & 2) && s
->txint
== 1) || // tx ints enabled, pending
150 ((((s
->wregs
[1] & 0x18) == 8) || ((s
->wregs
[1] & 0x18) == 0x10)) &&
151 s
->rxint
== 1) || // rx ints enabled, pending
152 ((s
->wregs
[15] & 0x80) && (s
->rregs
[0] & 0x80)))) { // break int e&p
158 static void slavio_serial_update_irq(ChannelState
*s
)
162 irq
= slavio_serial_update_irq_chn(s
);
163 irq
|= slavio_serial_update_irq_chn(s
->otherchn
);
165 SER_DPRINTF("IRQ = %d\n", irq
);
166 qemu_set_irq(s
->irq
, irq
);
169 static void slavio_serial_reset_chn(ChannelState
*s
)
174 for (i
= 0; i
< SERIAL_MAXADDR
; i
++) {
187 s
->rxint
= s
->txint
= 0;
188 s
->rxint_under_svc
= s
->txint_under_svc
= 0;
191 static void slavio_serial_reset(void *opaque
)
193 SerialState
*s
= opaque
;
194 slavio_serial_reset_chn(&s
->chn
[0]);
195 slavio_serial_reset_chn(&s
->chn
[1]);
198 static inline void clr_rxint(ChannelState
*s
)
201 s
->rxint_under_svc
= 0;
203 s
->rregs
[3] &= ~0x20;
205 s
->otherchn
->rregs
[3] &= ~4;
210 slavio_serial_update_irq(s
);
213 static inline void set_rxint(ChannelState
*s
)
216 if (!s
->txint_under_svc
) {
217 s
->rxint_under_svc
= 1;
221 s
->otherchn
->rregs
[3] |= 4;
223 slavio_serial_update_irq(s
);
227 static inline void clr_txint(ChannelState
*s
)
230 s
->txint_under_svc
= 0;
232 s
->rregs
[3] &= ~0x10;
234 s
->otherchn
->rregs
[3] &= ~2;
239 slavio_serial_update_irq(s
);
242 static inline void set_txint(ChannelState
*s
)
245 if (!s
->rxint_under_svc
) {
246 s
->txint_under_svc
= 1;
250 s
->otherchn
->rregs
[3] |= 2;
252 slavio_serial_update_irq(s
);
256 static void slavio_serial_update_parameters(ChannelState
*s
)
258 int speed
, parity
, data_bits
, stop_bits
;
259 QEMUSerialSetParams ssp
;
261 if (!s
->chr
|| s
->type
!= ser
)
264 if (s
->wregs
[4] & 1) {
272 if ((s
->wregs
[4] & 0x0c) == 0x0c)
276 switch (s
->wregs
[5] & 0x60) {
291 speed
= 2457600 / ((s
->wregs
[12] | (s
->wregs
[13] << 8)) + 2);
292 switch (s
->wregs
[4] & 0xc0) {
308 ssp
.data_bits
= data_bits
;
309 ssp
.stop_bits
= stop_bits
;
310 SER_DPRINTF("channel %c: speed=%d parity=%c data=%d stop=%d\n", CHN_C(s
),
311 speed
, parity
, data_bits
, stop_bits
);
312 qemu_chr_ioctl(s
->chr
, CHR_IOCTL_SERIAL_SET_PARAMS
, &ssp
);
315 static void slavio_serial_mem_writeb(void *opaque
, target_phys_addr_t addr
, uint32_t val
)
317 SerialState
*ser
= opaque
;
323 saddr
= (addr
& 3) >> 1;
324 channel
= (addr
& SERIAL_MAXADDR
) >> 2;
325 s
= &ser
->chn
[channel
];
328 SER_DPRINTF("Write channel %c, reg[%d] = %2.2x\n", CHN_C(s
), s
->reg
, val
& 0xff);
342 if (s
->rxint_under_svc
)
344 else if (s
->txint_under_svc
)
355 s
->wregs
[s
->reg
] = val
;
361 s
->wregs
[s
->reg
] = val
;
362 slavio_serial_update_parameters(s
);
365 switch (val
& 0xc0) {
370 slavio_serial_reset_chn(&ser
->chn
[1]);
373 slavio_serial_reset_chn(&ser
->chn
[0]);
376 slavio_serial_reset(ser
);
389 SER_DPRINTF("Write channel %c, ch %d\n", CHN_C(s
), val
);
390 if (s
->wregs
[5] & 8) { // tx enabled
393 qemu_chr_write(s
->chr
, &s
->tx
, 1);
394 else if (s
->type
== kbd
) {
395 handle_kbd_command(s
, val
);
397 s
->rregs
[0] |= 4; // Tx buffer empty
398 s
->rregs
[1] |= 1; // All sent
407 static uint32_t slavio_serial_mem_readb(void *opaque
, target_phys_addr_t addr
)
409 SerialState
*ser
= opaque
;
415 saddr
= (addr
& 3) >> 1;
416 channel
= (addr
& SERIAL_MAXADDR
) >> 2;
417 s
= &ser
->chn
[channel
];
420 SER_DPRINTF("Read channel %c, reg[%d] = %2.2x\n", CHN_C(s
), s
->reg
, s
->rregs
[s
->reg
]);
421 ret
= s
->rregs
[s
->reg
];
427 if (s
->type
== kbd
|| s
->type
== mouse
)
431 SER_DPRINTF("Read channel %c, ch %d\n", CHN_C(s
), ret
);
439 static int serial_can_receive(void *opaque
)
441 ChannelState
*s
= opaque
;
444 if (((s
->wregs
[3] & 1) == 0) // Rx not enabled
445 || ((s
->rregs
[0] & 1) == 1)) // char already available
449 //SER_DPRINTF("channel %c can receive %d\n", CHN_C(s), ret);
453 static void serial_receive_byte(ChannelState
*s
, int ch
)
455 SER_DPRINTF("channel %c put ch %d\n", CHN_C(s
), ch
);
461 static void serial_receive_break(ChannelState
*s
)
464 slavio_serial_update_irq(s
);
467 static void serial_receive1(void *opaque
, const uint8_t *buf
, int size
)
469 ChannelState
*s
= opaque
;
470 serial_receive_byte(s
, buf
[0]);
473 static void serial_event(void *opaque
, int event
)
475 ChannelState
*s
= opaque
;
476 if (event
== CHR_EVENT_BREAK
)
477 serial_receive_break(s
);
480 static CPUReadMemoryFunc
*slavio_serial_mem_read
[3] = {
481 slavio_serial_mem_readb
,
482 slavio_serial_mem_readb
,
483 slavio_serial_mem_readb
,
486 static CPUWriteMemoryFunc
*slavio_serial_mem_write
[3] = {
487 slavio_serial_mem_writeb
,
488 slavio_serial_mem_writeb
,
489 slavio_serial_mem_writeb
,
492 static void slavio_serial_save_chn(QEMUFile
*f
, ChannelState
*s
)
496 qemu_put_be32s(f
, &tmp
); /* unused, was IRQ. */
497 qemu_put_be32s(f
, &s
->reg
);
498 qemu_put_be32s(f
, &s
->rxint
);
499 qemu_put_be32s(f
, &s
->txint
);
500 qemu_put_be32s(f
, &s
->rxint_under_svc
);
501 qemu_put_be32s(f
, &s
->txint_under_svc
);
502 qemu_put_8s(f
, &s
->rx
);
503 qemu_put_8s(f
, &s
->tx
);
504 qemu_put_buffer(f
, s
->wregs
, 16);
505 qemu_put_buffer(f
, s
->rregs
, 16);
508 static void slavio_serial_save(QEMUFile
*f
, void *opaque
)
510 SerialState
*s
= opaque
;
512 slavio_serial_save_chn(f
, &s
->chn
[0]);
513 slavio_serial_save_chn(f
, &s
->chn
[1]);
516 static int slavio_serial_load_chn(QEMUFile
*f
, ChannelState
*s
, int version_id
)
523 qemu_get_be32s(f
, &tmp
); /* unused */
524 qemu_get_be32s(f
, &s
->reg
);
525 qemu_get_be32s(f
, &s
->rxint
);
526 qemu_get_be32s(f
, &s
->txint
);
527 if (version_id
>= 2) {
528 qemu_get_be32s(f
, &s
->rxint_under_svc
);
529 qemu_get_be32s(f
, &s
->txint_under_svc
);
531 qemu_get_8s(f
, &s
->rx
);
532 qemu_get_8s(f
, &s
->tx
);
533 qemu_get_buffer(f
, s
->wregs
, 16);
534 qemu_get_buffer(f
, s
->rregs
, 16);
538 static int slavio_serial_load(QEMUFile
*f
, void *opaque
, int version_id
)
540 SerialState
*s
= opaque
;
543 ret
= slavio_serial_load_chn(f
, &s
->chn
[0], version_id
);
546 ret
= slavio_serial_load_chn(f
, &s
->chn
[1], version_id
);
551 SerialState
*slavio_serial_init(int base
, qemu_irq irq
, CharDriverState
*chr1
,
552 CharDriverState
*chr2
)
554 int slavio_serial_io_memory
, i
;
557 s
= qemu_mallocz(sizeof(SerialState
));
561 slavio_serial_io_memory
= cpu_register_io_memory(0, slavio_serial_mem_read
, slavio_serial_mem_write
, s
);
562 cpu_register_physical_memory(base
, SERIAL_MAXADDR
, slavio_serial_io_memory
);
564 s
->chn
[0].chr
= chr1
;
565 s
->chn
[1].chr
= chr2
;
567 for (i
= 0; i
< 2; i
++) {
569 s
->chn
[i
].chn
= 1 - i
;
570 s
->chn
[i
].type
= ser
;
572 qemu_chr_add_handlers(s
->chn
[i
].chr
, serial_can_receive
,
573 serial_receive1
, serial_event
, &s
->chn
[i
]);
576 s
->chn
[0].otherchn
= &s
->chn
[1];
577 s
->chn
[1].otherchn
= &s
->chn
[0];
578 register_savevm("slavio_serial", base
, 2, slavio_serial_save
, slavio_serial_load
, s
);
579 qemu_register_reset(slavio_serial_reset
, s
);
580 slavio_serial_reset(s
);
584 static const uint8_t keycodes
[128] = {
585 127, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 43, 53,
586 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 89, 76, 77, 78,
587 79, 80, 81, 82, 83, 84, 85, 86, 87, 42, 99, 88, 100, 101, 102, 103,
588 104, 105, 106, 107, 108, 109, 110, 47, 19, 121, 119, 5, 6, 8, 10, 12,
589 14, 16, 17, 18, 7, 98, 23, 68, 69, 70, 71, 91, 92, 93, 125, 112,
590 113, 114, 94, 50, 0, 0, 124, 9, 11, 0, 0, 0, 0, 0, 0, 0,
591 90, 0, 46, 22, 13, 111, 52, 20, 96, 24, 28, 74, 27, 123, 44, 66,
592 0, 45, 2, 4, 48, 0, 0, 21, 0, 0, 0, 0, 0, 120, 122, 67,
595 static void sunkbd_event(void *opaque
, int ch
)
597 ChannelState
*s
= opaque
;
598 int release
= ch
& 0x80;
600 ch
= keycodes
[ch
& 0x7f];
601 KBD_DPRINTF("Keycode %d (%s)\n", ch
, release
? "release" : "press");
602 put_queue(s
, ch
| release
);
605 static void handle_kbd_command(ChannelState
*s
, int val
)
607 KBD_DPRINTF("Command %d\n", val
);
609 case 1: // Reset, return type code
611 put_queue(s
, 5); // Type 5
613 case 7: // Query layout
615 put_queue(s
, 0x20); // XXX, layout?
622 static void sunmouse_event(void *opaque
,
623 int dx
, int dy
, int dz
, int buttons_state
)
625 ChannelState
*s
= opaque
;
628 /* XXX: SDL sometimes generates nul events: we delete them */
629 if (dx
== 0 && dy
== 0 && dz
== 0 && buttons_state
== 0)
631 MS_DPRINTF("dx=%d dy=%d buttons=%01x\n", dx
, dy
, buttons_state
);
633 ch
= 0x80 | 0x7; /* protocol start byte, no buttons pressed */
635 if (buttons_state
& MOUSE_EVENT_LBUTTON
)
637 if (buttons_state
& MOUSE_EVENT_MBUTTON
)
639 if (buttons_state
& MOUSE_EVENT_RBUTTON
)
651 put_queue(s
, ch
& 0xff);
660 put_queue(s
, ch
& 0xff);
662 // MSC protocol specify two extra motion bytes
668 void slavio_serial_ms_kbd_init(int base
, qemu_irq irq
)
670 int slavio_serial_io_memory
, i
;
673 s
= qemu_mallocz(sizeof(SerialState
));
676 for (i
= 0; i
< 2; i
++) {
678 s
->chn
[i
].chn
= 1 - i
;
679 s
->chn
[i
].chr
= NULL
;
681 s
->chn
[0].otherchn
= &s
->chn
[1];
682 s
->chn
[1].otherchn
= &s
->chn
[0];
683 s
->chn
[0].type
= mouse
;
684 s
->chn
[1].type
= kbd
;
686 slavio_serial_io_memory
= cpu_register_io_memory(0, slavio_serial_mem_read
, slavio_serial_mem_write
, s
);
687 cpu_register_physical_memory(base
, SERIAL_MAXADDR
, slavio_serial_io_memory
);
689 qemu_add_mouse_event_handler(sunmouse_event
, &s
->chn
[0], 0, "QEMU Sun Mouse");
690 qemu_add_kbd_event_handler(sunkbd_event
, &s
->chn
[1]);
691 qemu_register_reset(slavio_serial_reset
, s
);
692 slavio_serial_reset(s
);