src/devices/dev_cons.c

/*
 *  Copyright (C) 2003-2005  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *   
 *
 *  $Id: dev_cons.c,v 1.25 2005/06/11 21:04:31 debug Exp $
 *  
 *  A console device.  (Fake, only useful for simple tests.)
 *  It is hardwared to the lowest available MIPS hardware IRQ, and only
 *  interrupts CPU 0.
 *
 *  This device provides memory mapped I/O for a simple console supporting
 *  putchar (writing to memory) and getchar (reading from memory), and
 *  support for halting the emulator.  (This is useful for regression tests,
 *  Hello World-style test programs, and other simple experiments.)
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "console.h"
#include "cpu.h"
#include "devices.h"
#include "machine.h"
#include "memory.h"
#include "misc.h"


#define CONS_TICK_SHIFT         14

struct cons_data {
        int             console_handle;
        int             irq_nr;
};


/*
 *  dev_cons_tick():
 */
void dev_cons_tick(struct cpu *cpu, void *extra)
{
        struct cpu *c = cpu->machine->cpus[0];
        struct cons_data *d = extra;

        cpu_interrupt_ack(c, d->irq_nr);

        if (console_charavail(d->console_handle))
                cpu_interrupt(c, d->irq_nr);
}


/*
 *  dev_cons_access():
 */
int dev_cons_access(struct cpu *cpu, struct memory *mem,
        uint64_t relative_addr, unsigned char *data, size_t len,
        int writeflag, void *extra)
{
        struct cons_data *d = extra;
        int i;

        /*  Exit the emulator:  */
        if (relative_addr == DEV_CONS_HALT) {
                cpu->running = 0;
                cpu->machine->exit_without_entering_debugger = 1;
                return 1;
        }

        if (writeflag == MEM_WRITE) {
                for (i=0; i<len; i++) {
                        if (data[i] != 0) {
                                if (cpu->machine->register_dump ||
                                    cpu->machine->instruction_trace)
                                        debug("putchar '");

                                console_putchar(d->console_handle, data[i]);

                                if (cpu->machine->register_dump ||
                                    cpu->machine->instruction_trace)
                                        debug("'\n");
                                fflush(stdout);
                        }
                }
        } else {
                int ch = console_readchar(d->console_handle);
                if (ch < 0)
                        ch = 0;
                for (i=0; i<len; i++)
                        data[i] = ch;
        }

        dev_cons_tick(cpu, extra);

        return 1;
}


/*
 *  dev_cons_init():
 */
int dev_cons_init(struct machine *machine, struct memory *mem,
        uint64_t baseaddr, char *name, int irq_nr)
{
        struct cons_data *d;
        char *name2;

        d = malloc(sizeof(struct cons_data));
        if (d == NULL) {
                fprintf(stderr, "out of memory\n");
                exit(1);
        }
        memset(d, 0, sizeof(struct cons_data));
        d->irq_nr = irq_nr;
        d->console_handle = console_start_slave(machine, name);

        name2 = malloc(strlen(name) + 20);
        if (name2 == NULL) {
                fprintf(stderr, "out of memory in dev_cons_init()\n");
                exit(1);
        }
        if (name != NULL && name[0])
                sprintf(name2, "cons [%s]", name);
        else
                sprintf(name2, "cons");

        memory_device_register(mem, name2, baseaddr, DEV_CONS_LENGTH,
            dev_cons_access, d, MEM_DEFAULT, NULL);
        machine_add_tickfunction(machine, dev_cons_tick, d, CONS_TICK_SHIFT);

        return d->console_handle;
}

1	/*
2	* Copyright (C) 2003-2005 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_cons.c,v 1.25 2005/06/11 21:04:31 debug Exp $
29	*
30	* A console device. (Fake, only useful for simple tests.)
31	* It is hardwared to the lowest available MIPS hardware IRQ, and only
32	* interrupts CPU 0.
33	*
34	* This device provides memory mapped I/O for a simple console supporting
35	* putchar (writing to memory) and getchar (reading from memory), and
36	* support for halting the emulator. (This is useful for regression tests,
37	* Hello World-style test programs, and other simple experiments.)
38	*/
39
40	#include <stdio.h>
41	#include <stdlib.h>
42	#include <string.h>
43
44	#include "console.h"
45	#include "cpu.h"
46	#include "devices.h"
47	#include "machine.h"
48	#include "memory.h"
49	#include "misc.h"
50
51
52	#define CONS_TICK_SHIFT 14
53
54	struct cons_data {
55	int console_handle;
56	int irq_nr;
57	};
58
59
60	/*
61	* dev_cons_tick():
62	*/
63	void dev_cons_tick(struct cpu cpu, void extra)
64	{
65	struct cpu *c = cpu->machine->cpus[0];
66	struct cons_data *d = extra;
67
68	cpu_interrupt_ack(c, d->irq_nr);
69
70	if (console_charavail(d->console_handle))
71	cpu_interrupt(c, d->irq_nr);
72	}
73
74
75	/*
76	* dev_cons_access():
77	*/
78	int dev_cons_access(struct cpu cpu, struct memory mem,
79	uint64_t relative_addr, unsigned char *data, size_t len,
80	int writeflag, void *extra)
81	{
82	struct cons_data *d = extra;
83	int i;
84
85	/* Exit the emulator: */
86	if (relative_addr == DEV_CONS_HALT) {
87	cpu->running = 0;
88	cpu->machine->exit_without_entering_debugger = 1;
89	return 1;
90	}
91
92	if (writeflag == MEM_WRITE) {
93	for (i=0; i<len; i++) {
94	if (data[i] != 0) {
95	if (cpu->machine->register_dump \|\|
96	cpu->machine->instruction_trace)
97	debug("putchar '");
98
99	console_putchar(d->console_handle, data[i]);
100
101	if (cpu->machine->register_dump \|\|
102	cpu->machine->instruction_trace)
103	debug("'\n");
104	fflush(stdout);
105	}
106	}
107	} else {
108	int ch = console_readchar(d->console_handle);
109	if (ch < 0)
110	ch = 0;
111	for (i=0; i<len; i++)
112	data[i] = ch;
113	}
114
115	dev_cons_tick(cpu, extra);
116
117	return 1;
118	}
119
120
121	/*
122	* dev_cons_init():
123	*/
124	int dev_cons_init(struct machine machine, struct memory mem,
125	uint64_t baseaddr, char *name, int irq_nr)
126	{
127	struct cons_data *d;
128	char *name2;
129
130	d = malloc(sizeof(struct cons_data));
131	if (d == NULL) {
132	fprintf(stderr, "out of memory\n");
133	exit(1);
134	}
135	memset(d, 0, sizeof(struct cons_data));
136	d->irq_nr = irq_nr;
137	d->console_handle = console_start_slave(machine, name);
138
139	name2 = malloc(strlen(name) + 20);
140	if (name2 == NULL) {
141	fprintf(stderr, "out of memory in dev_cons_init()\n");
142	exit(1);
143	}
144	if (name != NULL && name[0])
145	sprintf(name2, "cons [%s]", name);
146	else
147	sprintf(name2, "cons");
148
149	memory_device_register(mem, name2, baseaddr, DEV_CONS_LENGTH,
150	dev_cons_access, d, MEM_DEFAULT, NULL);
151	machine_add_tickfunction(machine, dev_cons_tick, d, CONS_TICK_SHIFT);
152
153	return d->console_handle;
154	}
155