1 |
/* |
2 |
* Copyright (C) 2003-2006 Anders Gavare. All rights reserved. |
3 |
* |
4 |
* Redistribution and use in source and binary forms, with or without |
5 |
* modification, are permitted provided that the following conditions are met: |
6 |
* |
7 |
* 1. Redistributions of source code must retain the above copyright |
8 |
* notice, this list of conditions and the following disclaimer. |
9 |
* 2. Redistributions in binary form must reproduce the above copyright |
10 |
* notice, this list of conditions and the following disclaimer in the |
11 |
* documentation and/or other materials provided with the distribution. |
12 |
* 3. The name of the author may not be used to endorse or promote products |
13 |
* derived from this software without specific prior written permission. |
14 |
* |
15 |
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
16 |
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
17 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
18 |
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
19 |
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
20 |
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
21 |
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
22 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
23 |
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
24 |
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
25 |
* SUCH DAMAGE. |
26 |
* |
27 |
* |
28 |
* $Id: dev_scc.c,v 1.33 2006/03/04 12:38:48 debug Exp $ |
29 |
* |
30 |
* Serial controller on some DECsystems and SGI machines. (Z8530 ?) |
31 |
* Most of the code in here is written for DECsystem emulation, though. |
32 |
* |
33 |
* NOTE: |
34 |
* Each scc device is responsible for two lines; the first scc device |
35 |
* controls mouse (0) and keyboard (1), and the second device controls |
36 |
* serial ports (2 and 3). |
37 |
* |
38 |
* TODO: |
39 |
* Mouse support!!! (scc0 and scc1 need to cooperate, in order to |
40 |
* emulate the same lk201 behaviour as when using the dc device) |
41 |
* DMA |
42 |
* More correct interrupt support. |
43 |
* |
44 |
****************************************************************************** |
45 |
* _____ ___ ____ ___ _ |
46 |
* |_ _/ _ \| _ \ / _ \| | |
47 |
* | || | | | | | | | | | | |
48 |
* | || |_| | |_| | |_| |_| |
49 |
* |_| \___/|____/ \___/(_) |
50 |
* |
51 |
* Since this is actually a Z8530, it should be merged with dev_z8530.c! |
52 |
*/ |
53 |
|
54 |
#include <stdio.h> |
55 |
#include <stdlib.h> |
56 |
#include <string.h> |
57 |
|
58 |
#include "console.h" |
59 |
#include "cpu.h" |
60 |
#include "devices.h" |
61 |
#include "machine.h" |
62 |
#include "memory.h" |
63 |
#include "misc.h" |
64 |
|
65 |
#include "sccreg.h" |
66 |
|
67 |
|
68 |
#define SCC_TICK_SHIFT 14 |
69 |
|
70 |
#define N_SCC_PORTS 2 |
71 |
#define N_SCC_REGS 16 |
72 |
#define MAX_QUEUE_LEN 1024 |
73 |
|
74 |
/* #define SCC_DEBUG */ |
75 |
|
76 |
|
77 |
struct scc_data { |
78 |
int irq_nr; |
79 |
int use_fb; |
80 |
int console_handle; |
81 |
|
82 |
int scc_nr; |
83 |
int addrmul; |
84 |
|
85 |
int register_select_in_progress[N_SCC_PORTS]; |
86 |
int register_selected[N_SCC_PORTS]; |
87 |
|
88 |
unsigned char scc_register_r[N_SCC_PORTS * N_SCC_REGS]; |
89 |
unsigned char scc_register_w[N_SCC_PORTS * N_SCC_REGS]; |
90 |
|
91 |
unsigned char rx_queue_char[N_SCC_PORTS * MAX_QUEUE_LEN]; |
92 |
int cur_rx_queue_pos_write[N_SCC_PORTS]; |
93 |
int cur_rx_queue_pos_read[N_SCC_PORTS]; |
94 |
|
95 |
struct lk201_data lk201; |
96 |
}; |
97 |
|
98 |
|
99 |
/* |
100 |
* dev_scc_add_to_rx_queue(): |
101 |
* |
102 |
* Add a character to the receive queue. |
103 |
*/ |
104 |
void dev_scc_add_to_rx_queue(void *e, int ch, int portnr) |
105 |
{ |
106 |
struct scc_data *d = (struct scc_data *) e; |
107 |
int scc_nr; |
108 |
|
109 |
/* DC's keyboard port ==> SCC keyboard port */ |
110 |
if (portnr == 0) |
111 |
portnr = 3; |
112 |
|
113 |
scc_nr = portnr / N_SCC_PORTS; |
114 |
if (scc_nr != d->scc_nr) |
115 |
return; |
116 |
|
117 |
portnr &= (N_SCC_PORTS - 1); |
118 |
|
119 |
d->rx_queue_char[portnr * MAX_QUEUE_LEN + |
120 |
d->cur_rx_queue_pos_write[portnr]] = ch; |
121 |
d->cur_rx_queue_pos_write[portnr] ++; |
122 |
if (d->cur_rx_queue_pos_write[portnr] == MAX_QUEUE_LEN) |
123 |
d->cur_rx_queue_pos_write[portnr] = 0; |
124 |
|
125 |
if (d->cur_rx_queue_pos_write[portnr] == |
126 |
d->cur_rx_queue_pos_read[portnr]) |
127 |
fatal("warning: add_to_rx_queue(): rx_queue overrun!\n"); |
128 |
} |
129 |
|
130 |
|
131 |
static int rx_avail(struct scc_data *d, int portnr) |
132 |
{ |
133 |
return d->cur_rx_queue_pos_write[portnr] != |
134 |
d->cur_rx_queue_pos_read[portnr]; |
135 |
} |
136 |
|
137 |
|
138 |
static unsigned char rx_nextchar(struct scc_data *d, int portnr) |
139 |
{ |
140 |
unsigned char ch; |
141 |
ch = d->rx_queue_char[portnr * MAX_QUEUE_LEN + |
142 |
d->cur_rx_queue_pos_read[portnr]]; |
143 |
d->cur_rx_queue_pos_read[portnr]++; |
144 |
if (d->cur_rx_queue_pos_read[portnr] == MAX_QUEUE_LEN) |
145 |
d->cur_rx_queue_pos_read[portnr] = 0; |
146 |
return ch; |
147 |
} |
148 |
|
149 |
|
150 |
/* |
151 |
* dev_scc_tick(): |
152 |
*/ |
153 |
void dev_scc_tick(struct cpu *cpu, void *extra) |
154 |
{ |
155 |
int i; |
156 |
struct scc_data *d = (struct scc_data *) extra; |
157 |
|
158 |
/* Add keystrokes to the rx queue: */ |
159 |
if (d->use_fb == 0 && d->scc_nr == 1) { |
160 |
if (console_charavail(d->console_handle)) |
161 |
dev_scc_add_to_rx_queue(extra, console_readchar( |
162 |
d->console_handle), 2); |
163 |
} |
164 |
if (d->use_fb == 1 && d->scc_nr == 1) |
165 |
lk201_tick(&d->lk201); |
166 |
|
167 |
for (i=0; i<N_SCC_PORTS; i++) { |
168 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR0] |= SCC_RR0_TX_EMPTY; |
169 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR1] = 0; |
170 |
/* No receive errors */ |
171 |
|
172 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR0] &= |
173 |
~SCC_RR0_RX_AVAIL; |
174 |
if (rx_avail(d, i)) |
175 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR0] |= |
176 |
SCC_RR0_RX_AVAIL; |
177 |
|
178 |
/* |
179 |
* Interrupts: |
180 |
* (NOTE: Interrupt enables are always at channel A) |
181 |
*/ |
182 |
if (d->scc_register_w[N_SCC_REGS + SCC_WR9] & |
183 |
SCC_WR9_MASTER_IE) { |
184 |
/* TX interrupts? */ |
185 |
if (d->scc_register_w[i * N_SCC_REGS + SCC_WR1] & |
186 |
SCC_WR1_TX_IE) { |
187 |
if (d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
188 |
& SCC_RR3_TX_IP_A || |
189 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
190 |
& SCC_RR3_TX_IP_B) |
191 |
cpu_interrupt(cpu, d->irq_nr); |
192 |
} |
193 |
|
194 |
/* RX interrupts? */ |
195 |
if (d->scc_register_w[N_SCC_REGS + SCC_WR1] & |
196 |
(SCC_WR1_RXI_FIRST_CHAR | SCC_WR1_RXI_ALL_CHAR)) { |
197 |
if (d->scc_register_r[i * N_SCC_REGS + SCC_RR0] |
198 |
& SCC_RR0_RX_AVAIL) { |
199 |
if (i == SCC_CHANNEL_A) |
200 |
d->scc_register_r[N_SCC_REGS + |
201 |
SCC_RR3] |= SCC_RR3_RX_IP_A; |
202 |
else |
203 |
d->scc_register_r[N_SCC_REGS + |
204 |
SCC_RR3] |= SCC_RR3_RX_IP_B; |
205 |
} |
206 |
|
207 |
if (d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
208 |
& SCC_RR3_RX_IP_A || |
209 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
210 |
& SCC_RR3_RX_IP_B) |
211 |
cpu_interrupt(cpu, d->irq_nr); |
212 |
} |
213 |
|
214 |
if (d->scc_register_w[N_SCC_REGS + SCC_WR1] & |
215 |
SCC_WR1_DMA_MODE) { |
216 |
if (d->scc_register_r[i * N_SCC_REGS + SCC_RR0] |
217 |
& SCC_RR0_RX_AVAIL) { |
218 |
if (i == SCC_CHANNEL_A) |
219 |
d->scc_register_r[N_SCC_REGS + |
220 |
SCC_RR3] |= |
221 |
SCC_RR3_EXT_IP_A; |
222 |
else |
223 |
d->scc_register_r[N_SCC_REGS + |
224 |
SCC_RR3] |= |
225 |
SCC_RR3_EXT_IP_B; |
226 |
} |
227 |
|
228 |
if (d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
229 |
& SCC_RR3_EXT_IP_A || |
230 |
d->scc_register_r[i * N_SCC_REGS + SCC_RR3] |
231 |
& SCC_RR3_EXT_IP_B) |
232 |
{ |
233 |
cpu_interrupt(cpu, d->irq_nr); |
234 |
/* TODO: huh? */ |
235 |
cpu_interrupt(cpu, 8 + 0x02000000); |
236 |
} |
237 |
} |
238 |
} |
239 |
} |
240 |
} |
241 |
|
242 |
|
243 |
/* |
244 |
* dev_scc_dma_func(): |
245 |
*/ |
246 |
int dev_scc_dma_func(struct cpu *cpu, void *extra, uint64_t addr, |
247 |
size_t dma_len, int tx) |
248 |
{ |
249 |
/* printf("dev_scc_dma_func(): addr = %08x, len = %i\n", |
250 |
(int)addr, (int)dma_len); */ |
251 |
unsigned char word[4]; |
252 |
struct scc_data *d = (struct scc_data *) extra; |
253 |
int n; |
254 |
|
255 |
int port = SCC_CHANNEL_A; /* TODO */ |
256 |
|
257 |
if (tx) { |
258 |
do { |
259 |
cpu->memory_rw(cpu, cpu->mem, addr, &word[0], |
260 |
sizeof(word), MEM_READ, NO_EXCEPTIONS | PHYSICAL); |
261 |
|
262 |
lk201_tx_data(&d->lk201, d->scc_nr * 2 + port, word[1]); |
263 |
/* Loopback: */ |
264 |
if (d->scc_register_w[port * N_SCC_REGS + SCC_WR14] |
265 |
& SCC_WR14_LOCAL_LOOPB) |
266 |
dev_scc_add_to_rx_queue(d, word[1], |
267 |
d->scc_nr * 2 + port); |
268 |
|
269 |
addr += sizeof(word); |
270 |
} while ((addr & 0xffc) != 0); |
271 |
|
272 |
dev_scc_tick(cpu, extra); |
273 |
return 1; |
274 |
} else { |
275 |
printf("dev_scc_dma_func(): addr = %08x, len = %i\n", |
276 |
(int)addr, (int)dma_len); |
277 |
|
278 |
|
279 |
/* TODO: all this is just nonsense */ |
280 |
|
281 |
n = 0; |
282 |
while (rx_avail(d, port)) { |
283 |
word[0] = word[1] = word[2] = word[3] = 0; |
284 |
word[0] = word[1] = word[2] = word[3] = |
285 |
rx_nextchar(d, port); |
286 |
n++; |
287 |
cpu->memory_rw(cpu, cpu->mem, addr, &word[0], |
288 |
sizeof(word), MEM_WRITE, NO_EXCEPTIONS | PHYSICAL); |
289 |
|
290 |
addr += sizeof(word); |
291 |
/* Half-page? */ |
292 |
if ((addr & 0x7fc) == 0) |
293 |
break; |
294 |
} |
295 |
dev_scc_tick(cpu, extra); |
296 |
return n*4; |
297 |
} |
298 |
} |
299 |
|
300 |
|
301 |
/* |
302 |
* dev_scc_access(): |
303 |
*/ |
304 |
DEVICE_ACCESS(scc) |
305 |
{ |
306 |
struct scc_data *d = (struct scc_data *) extra; |
307 |
uint64_t idata = 0, odata = 0; |
308 |
int port; |
309 |
int ultrix_mode = 0; |
310 |
|
311 |
if (writeflag == MEM_WRITE) |
312 |
idata = memory_readmax64(cpu, data, len); |
313 |
|
314 |
/* relative_addr /= d->addrmul; */ |
315 |
/* See SGI comment below instead. */ |
316 |
/* |
317 |
* SGI writes command to 0x0f, and data to 0x1f. |
318 |
* (TODO: This works for port nr 0, how about port nr 1?) |
319 |
*/ |
320 |
if ((relative_addr & 0x0f) == 0xf) { |
321 |
if (relative_addr == 0x0f) |
322 |
relative_addr = 1; |
323 |
else |
324 |
relative_addr = 5; |
325 |
} |
326 |
|
327 |
port = relative_addr / 8; |
328 |
relative_addr &= 7; |
329 |
|
330 |
dev_scc_tick(cpu, extra); |
331 |
|
332 |
/* |
333 |
* Ultrix writes words such as 0x1200 to relative address 0, |
334 |
* instead of writing the byte 0x12 directly to address 1. |
335 |
*/ |
336 |
if ((relative_addr == 0 || relative_addr == 4) && (idata & 0xff) == 0) { |
337 |
ultrix_mode = 1; |
338 |
relative_addr ++; |
339 |
idata >>= 8; |
340 |
} |
341 |
|
342 |
switch (relative_addr) { |
343 |
case 1: /* command */ |
344 |
if (writeflag==MEM_READ) { |
345 |
odata = d->scc_register_r[port * N_SCC_REGS + |
346 |
d->register_selected[port]]; |
347 |
|
348 |
if (d->register_selected[port] == SCC_RR3) { |
349 |
if (port == SCC_CHANNEL_B) |
350 |
fatal("WARNING! scc channel B has " |
351 |
"no RR3\n"); |
352 |
|
353 |
d->scc_register_r[port * N_SCC_REGS + |
354 |
SCC_RR3] = 0; |
355 |
cpu_interrupt_ack(cpu, d->irq_nr); |
356 |
} |
357 |
|
358 |
#ifdef SCC_DEBUG |
359 |
fatal("[ scc: port %i, register %i, read value " |
360 |
"0x%02x ]\n", port, d->register_selected[port], |
361 |
(int)odata); |
362 |
#endif |
363 |
d->register_select_in_progress[port] = 0; |
364 |
d->register_selected[port] = 0; |
365 |
/* debug("[ scc: (port %i) read from 0x%08lx ]\n", |
366 |
port, (long)relative_addr); */ |
367 |
} else { |
368 |
/* If no register is selected, then select one. |
369 |
Otherwise, write to the selected register. */ |
370 |
if (d->register_select_in_progress[port] == 0) { |
371 |
d->register_select_in_progress[port] = 1; |
372 |
d->register_selected[port] = idata; |
373 |
d->register_selected[port] &= (N_SCC_REGS-1); |
374 |
} else { |
375 |
d->scc_register_w[port * N_SCC_REGS + |
376 |
d->register_selected[port]] = idata; |
377 |
#ifdef SCC_DEBUG |
378 |
fatal("[ scc: port %i, register %i, write " |
379 |
"value 0x%02x ]\n", port, |
380 |
d->register_selected[port], idata); |
381 |
#endif |
382 |
|
383 |
d->scc_register_r[port * N_SCC_REGS + |
384 |
SCC_RR12] = d->scc_register_w[port * |
385 |
N_SCC_REGS + SCC_WR12]; |
386 |
d->scc_register_r[port * N_SCC_REGS + |
387 |
SCC_RR13] = d->scc_register_w[port * |
388 |
N_SCC_REGS + SCC_WR13]; |
389 |
|
390 |
d->register_select_in_progress[port] = 0; |
391 |
d->register_selected[port] = 0; |
392 |
} |
393 |
} |
394 |
break; |
395 |
case 5: /* data */ |
396 |
if (writeflag==MEM_READ) { |
397 |
if (rx_avail(d, port)) |
398 |
odata = rx_nextchar(d, port); |
399 |
|
400 |
/* TODO: perhaps only clear the RX part of RR3? */ |
401 |
d->scc_register_r[N_SCC_REGS + SCC_RR3] = 0; |
402 |
cpu_interrupt_ack(cpu, d->irq_nr); |
403 |
|
404 |
debug("[ scc: (port %i) read from 0x%08lx: 0x%02x ]\n", |
405 |
port, (long)relative_addr, (int)odata); |
406 |
} else { |
407 |
/* debug("[ scc: (port %i) write to 0x%08lx: " |
408 |
"0x%08x ]\n", port, (long)relative_addr, |
409 |
(int)idata); */ |
410 |
|
411 |
/* Send the character: */ |
412 |
lk201_tx_data(&d->lk201, d->scc_nr * 2 + port, idata); |
413 |
|
414 |
/* Loopback: */ |
415 |
if (d->scc_register_w[port * N_SCC_REGS + SCC_WR14] |
416 |
& SCC_WR14_LOCAL_LOOPB) |
417 |
dev_scc_add_to_rx_queue(d, idata, d->scc_nr |
418 |
* 2 + port); |
419 |
|
420 |
/* TX interrupt: */ |
421 |
if (d->scc_register_w[port * N_SCC_REGS + SCC_WR9] & |
422 |
SCC_WR9_MASTER_IE && |
423 |
d->scc_register_w[port * N_SCC_REGS + SCC_WR1] & |
424 |
SCC_WR1_TX_IE) { |
425 |
if (port == SCC_CHANNEL_A) |
426 |
d->scc_register_r[N_SCC_REGS + SCC_RR3] |
427 |
|= SCC_RR3_TX_IP_A; |
428 |
else |
429 |
d->scc_register_r[N_SCC_REGS + SCC_RR3] |
430 |
|= SCC_RR3_TX_IP_B; |
431 |
} |
432 |
|
433 |
dev_scc_tick(cpu, extra); |
434 |
} |
435 |
break; |
436 |
default: |
437 |
if (writeflag==MEM_READ) { |
438 |
debug("[ scc: (port %i) read from 0x%08lx ]\n", |
439 |
port, (long)relative_addr); |
440 |
} else { |
441 |
debug("[ scc: (port %i) write to 0x%08lx: 0x%08x ]\n", |
442 |
port, (long)relative_addr, (int)idata); |
443 |
} |
444 |
} |
445 |
|
446 |
if (ultrix_mode && writeflag == MEM_READ) { |
447 |
odata <<= 8; |
448 |
} |
449 |
|
450 |
if (writeflag == MEM_READ) |
451 |
memory_writemax64(cpu, data, len, odata); |
452 |
|
453 |
return 1; |
454 |
} |
455 |
|
456 |
|
457 |
/* |
458 |
* dev_scc_init(): |
459 |
* |
460 |
* use_fb = non-zero when using graphical console + keyboard |
461 |
* scc_nr = 0 or 1 |
462 |
* addmul = 1 in most cases, 8 on SGI? |
463 |
*/ |
464 |
void *dev_scc_init(struct machine *machine, struct memory *mem, |
465 |
uint64_t baseaddr, int irq_nr, int use_fb, int scc_nr, int addrmul) |
466 |
{ |
467 |
struct scc_data *d; |
468 |
|
469 |
d = malloc(sizeof(struct scc_data)); |
470 |
if (d == NULL) { |
471 |
fprintf(stderr, "out of memory\n"); |
472 |
exit(1); |
473 |
} |
474 |
memset(d, 0, sizeof(struct scc_data)); |
475 |
d->irq_nr = irq_nr; |
476 |
d->scc_nr = scc_nr; |
477 |
d->use_fb = use_fb; |
478 |
d->addrmul = addrmul; |
479 |
d->console_handle = console_start_slave(machine, "SCC", 1); |
480 |
|
481 |
lk201_init(&d->lk201, use_fb, dev_scc_add_to_rx_queue, |
482 |
d->console_handle, d); |
483 |
|
484 |
memory_device_register(mem, "scc", baseaddr, DEV_SCC_LENGTH, |
485 |
dev_scc_access, d, DM_DEFAULT, NULL); |
486 |
machine_add_tickfunction(machine, dev_scc_tick, d, SCC_TICK_SHIFT, 0.0); |
487 |
|
488 |
return (void *) d; |
489 |
} |
490 |
|