src/devices/dev_openpic.c

/*
 *  Copyright (C) 2005-2007  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_openpic.c,v 1.14 2007/09/11 21:42:52 debug Exp $
 *  
 *  COMMENT: OpenPIC Interrupt controller (used by sandpoint ppc)
 *  based on dev_gc.c
 */

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

#include "cpu.h"
#include "device.h"
#include "machine.h"
#include "memory.h"
#include "misc.h"


#define DEV_OPENPIC_LENGTH              0x40000

struct openpic_data {
        struct interrupt cpu_irq;

        uint32_t        status_hi;
        uint32_t        status_lo;
        uint32_t        enable_hi;
        uint32_t        enable_lo;
};


void openpic_hi_interrupt_assert(struct interrupt *interrupt)
{
        struct openpic_data *d = interrupt->extra;
        d->status_hi |= interrupt->line;
        if (d->status_lo & d->enable_lo || d->status_hi & d->enable_hi)
                INTERRUPT_ASSERT(d->cpu_irq);
}
void openpic_hi_interrupt_deassert(struct interrupt *interrupt)
{
        struct openpic_data *d = interrupt->extra;
        d->status_hi &= ~interrupt->line;
        if (!(d->status_lo & d->enable_lo || d->status_hi & d->enable_hi))
                INTERRUPT_DEASSERT(d->cpu_irq);
}
void openpic_lo_interrupt_assert(struct interrupt *interrupt)
{
        struct openpic_data *d = interrupt->extra;
        d->status_lo |= interrupt->line;
        if (d->status_lo & d->enable_lo || d->status_hi & d->enable_hi)
                INTERRUPT_ASSERT(d->cpu_irq);
}
void openpic_lo_interrupt_deassert(struct interrupt *interrupt)
{
        struct openpic_data *d = interrupt->extra;
        d->status_lo &= ~interrupt->line;
        if (!(d->status_lo & d->enable_lo || d->status_hi & d->enable_hi))
                INTERRUPT_DEASSERT(d->cpu_irq);
}

#define OPENPIC_MASK                            0x80000000
#define OPENPIC_ACTIVITY                        0x40000000      /* Read Only */
#define OPENPIC_PRIORITY_MASK                   0x000f0000
#define OPENPIC_PRIORITY_SHIFT                  16
#define OPENPIC_VECTOR_MASK                     0x000000ff

#define OPENPIC_VEC_TIMER       64      /* and up */
#define OPENPIC_VEC_IPI         72      /* and up */
#define OPENPIC_VEC_SPURIOUS    127

#define OPENPIC_NUM_TIMERS      4
#define OPENPIC_NUM_IPI         4
#define OPENPIC_NUM_PRI         16
#define OPENPIC_NUM_VECTORS     256

DEVICE_ACCESS(openpic)
{
//      struct openpic_data *d = extra;
        uint64_t idata = 0, odata = 0, decoded = 0;

        if (writeflag == MEM_WRITE) {
                idata = memory_readmax64(cpu, data, len);
                decoded =
                        ( idata & 0x000000ff ) << 24 |
                        ( idata & 0x0000ff00 ) << 8  |
                        ( idata & 0x00ff0000 ) >> 8  |
                        ( idata & 0xff000000 ) >> 24 ;

                uint64_t priority,vector, active;
                priority = ( decoded & OPENPIC_PRIORITY_MASK ) >> OPENPIC_PRIORITY_SHIFT;
                vector   = ( decoded & OPENPIC_VECTOR_MASK );
                active   = ( decoded & OPENPIC_ACTIVITY );

                debug("[ openpic: WRITE %05x | %08x => %08x | priority: %x vector: 0x%02x %d active: %x ]\n",
                        (int)relative_addr, (int)idata, (int)decoded, (int)priority, (int)vector, (int)vector, (int)active );
        }

        switch (relative_addr) {

        case 0x00:
                if (writeflag == MEM_READ) {
                        // version 1.2
                        odata = 0x02000000;
                        fatal("[ openpic: read from "
                            "offset 0x%x (OpenPIC version) = %x]\n", (int)
                            relative_addr, (int)odata);
                }
                fatal("[ openpic: unimplemented write to "
                    "offset 0x%x: data=0x%x (OpenPIC version) ]\n", (int)
                    relative_addr, (int)idata);
                break;

#if 0
#define INT_STATE_REG_H  (interrupt_reg + 0x00)
#define INT_ENABLE_REG_H (interrupt_reg + 0x04)
#define INT_CLEAR_REG_H  (interrupt_reg + 0x08)
#define INT_LEVEL_REG_H  (interrupt_reg + 0x0c)
#define INT_STATE_REG_L  (interrupt_reg + 0x10)
#define INT_ENABLE_REG_L (interrupt_reg + 0x14)
#define INT_CLEAR_REG_L  (interrupt_reg + 0x18)
#define INT_LEVEL_REG_L  (interrupt_reg + 0x1c)

        case 0x10:
                if (writeflag == MEM_READ)
                        odata = d->status_hi & d->enable_hi;
                break;

        case 0x14:
                if (writeflag == MEM_READ)
                        odata = d->enable_hi;
                else {
                        int old_assert = (d->status_lo & d->enable_lo
                            || d->status_hi & d->enable_hi);
                        int new_assert;
                        d->enable_hi = idata;

                        new_assert = (d->status_lo & d->enable_lo ||
                            d->status_hi & d->enable_hi);

                        if (old_assert && !new_assert)
                                INTERRUPT_DEASSERT(d->cpu_irq);
                        else if (!old_assert && new_assert)
                                INTERRUPT_ASSERT(d->cpu_irq);
                }
                break;

        case 0x18:
                if (writeflag == MEM_WRITE) {
                        int old_assert = (d->status_lo & d->enable_lo
                            || d->status_hi & d->enable_hi);
                        int new_assert;
                        d->status_hi &= ~idata;

                        new_assert = (d->status_lo & d->enable_lo ||
                            d->status_hi & d->enable_hi);

                        if (old_assert && !new_assert)
                                INTERRUPT_DEASSERT(d->cpu_irq);
                        else if (!old_assert && new_assert)
                                INTERRUPT_ASSERT(d->cpu_irq);
                }
                break;

        case 0x20:
                if (writeflag == MEM_READ)
                        odata = d->status_lo & d->enable_lo;
                break;

        case 0x24:
                if (writeflag == MEM_READ)
                        odata = d->enable_lo;
                else {
                        int old_assert = (d->status_lo & d->enable_lo
                            || d->status_hi & d->enable_hi);
                        int new_assert;
                        d->enable_lo = idata;

                        new_assert = (d->status_lo & d->enable_lo ||
                            d->status_hi & d->enable_hi);

                        if (old_assert && !new_assert)
                                INTERRUPT_DEASSERT(d->cpu_irq);
                        else if (!old_assert && new_assert)
                                INTERRUPT_ASSERT(d->cpu_irq);
                }
                break;

        case 0x28:
                if (writeflag == MEM_WRITE) {
                        int old_assert = (d->status_lo & d->enable_lo
                            || d->status_hi & d->enable_hi);
                        int new_assert;
                        d->status_lo &= ~idata;

                        new_assert = (d->status_lo & d->enable_lo ||
                            d->status_hi & d->enable_hi);

                        if (old_assert && !new_assert)
                                INTERRUPT_DEASSERT(d->cpu_irq);
                        else if (!old_assert && new_assert)
                                INTERRUPT_ASSERT(d->cpu_irq);
                }
                break;

        case 0x1c:
        case 0x2c:
                /*  Avoid a debug message.  */
                break;
#endif
        default:if (writeflag == MEM_WRITE) {
                        fatal("[ openpic: unimplemented write to "
                            "offset 0x%x: data=0x%x ]\n", (int)
                            relative_addr, (int)idata);
                } else {
                        fatal("[ openpic: unimplemented read from "
                            "offset 0x%x ]\n", (int)relative_addr);
                }
        }

        if (writeflag == MEM_READ)
                memory_writemax64(cpu, data, len, odata);

        return 1;
}


DEVINIT(openpic)
{
        struct openpic_data *d;
        int i;

        CHECK_ALLOCATION(d = malloc(sizeof(struct openpic_data)));
        memset(d, 0, sizeof(struct openpic_data));

        /*  Connect to the CPU interrupt pin:  */
        INTERRUPT_CONNECT(devinit->interrupt_path, d->cpu_irq);

        /*
         *  Register the 126 OpenPIC interrupts
         */
        for (i=0; i<126; i++) {
                struct interrupt template;
                char n[300];
                snprintf(n, sizeof(n), "%s.openpic.%i",
                    devinit->interrupt_path, i);
                memset(&template, 0, sizeof(template));
                template.line = 1 << i;
                template.name = n;
                template.extra = d;
                template.interrupt_assert = openpic_lo_interrupt_assert;
                template.interrupt_deassert = openpic_lo_interrupt_deassert;
                interrupt_handler_register(&template);
        }

        memory_device_register(devinit->machine->memory, "openpic",
            devinit->addr, DEV_OPENPIC_LENGTH, dev_openpic_access, d, DM_DEFAULT, NULL);

        return 1;
}

1	dpavlin	22	/*
2	dpavlin	34	* Copyright (C) 2005-2007 Anders Gavare. All rights reserved.
3	dpavlin	22	*
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	dpavlin	63	* $Id: dev_openpic.c,v 1.14 2007/09/11 21:42:52 debug Exp $
28	dpavlin	22	*
29	dpavlin	63	* COMMENT: OpenPIC Interrupt controller (used by sandpoint ppc)
30	dpavlin	64	* based on dev_gc.c
31	dpavlin	22	*/
32
33			#include <stdio.h>
34			#include <stdlib.h>
35			#include <string.h>
36
37			#include "cpu.h"
38			#include "device.h"
39			#include "machine.h"
40			#include "memory.h"
41			#include "misc.h"
42
43
44	dpavlin	63	#define DEV_OPENPIC_LENGTH 0x40000
45	dpavlin	34
46	dpavlin	63	struct openpic_data {
47	dpavlin	34	struct interrupt cpu_irq;
48
49			uint32_t status_hi;
50			uint32_t status_lo;
51			uint32_t enable_hi;
52			uint32_t enable_lo;
53			};
54
55
56	dpavlin	63	void openpic_hi_interrupt_assert(struct interrupt *interrupt)
57	dpavlin	34	{
58	dpavlin	63	struct openpic_data *d = interrupt->extra;
59	dpavlin	34	d->status_hi \|= interrupt->line;
60			if (d->status_lo & d->enable_lo \|\| d->status_hi & d->enable_hi)
61			INTERRUPT_ASSERT(d->cpu_irq);
62			}
63	dpavlin	63	void openpic_hi_interrupt_deassert(struct interrupt *interrupt)
64	dpavlin	34	{
65	dpavlin	63	struct openpic_data *d = interrupt->extra;
66	dpavlin	34	d->status_hi &= ~interrupt->line;
67			if (!(d->status_lo & d->enable_lo \|\| d->status_hi & d->enable_hi))
68			INTERRUPT_DEASSERT(d->cpu_irq);
69			}
70	dpavlin	63	void openpic_lo_interrupt_assert(struct interrupt *interrupt)
71	dpavlin	34	{
72	dpavlin	63	struct openpic_data *d = interrupt->extra;
73	dpavlin	34	d->status_lo \|= interrupt->line;
74			if (d->status_lo & d->enable_lo \|\| d->status_hi & d->enable_hi)
75			INTERRUPT_ASSERT(d->cpu_irq);
76			}
77	dpavlin	63	void openpic_lo_interrupt_deassert(struct interrupt *interrupt)
78	dpavlin	34	{
79	dpavlin	63	struct openpic_data *d = interrupt->extra;
80	dpavlin	34	d->status_lo &= ~interrupt->line;
81			if (!(d->status_lo & d->enable_lo \|\| d->status_hi & d->enable_hi))
82			INTERRUPT_DEASSERT(d->cpu_irq);
83			}
84
85	dpavlin	66	#define OPENPIC_MASK 0x80000000
86			#define OPENPIC_ACTIVITY 0x40000000 /* Read Only */
87			#define OPENPIC_PRIORITY_MASK 0x000f0000
88			#define OPENPIC_PRIORITY_SHIFT 16
89			#define OPENPIC_VECTOR_MASK 0x000000ff
90	dpavlin	34
91	dpavlin	66	#define OPENPIC_VEC_TIMER 64 /* and up */
92			#define OPENPIC_VEC_IPI 72 /* and up */
93			#define OPENPIC_VEC_SPURIOUS 127
94
95	dpavlin	67	#define OPENPIC_NUM_TIMERS 4
96			#define OPENPIC_NUM_IPI 4
97			#define OPENPIC_NUM_PRI 16
98			#define OPENPIC_NUM_VECTORS 256
99
100	dpavlin	63	DEVICE_ACCESS(openpic)
101	dpavlin	22	{
102	dpavlin	64	// struct openpic_data *d = extra;
103	dpavlin	67	uint64_t idata = 0, odata = 0, decoded = 0;
104	dpavlin	22
105	dpavlin	67	if (writeflag == MEM_WRITE) {
106	dpavlin	22	idata = memory_readmax64(cpu, data, len);
107	dpavlin	67	decoded =
108			( idata & 0x000000ff ) << 24 \|
109			( idata & 0x0000ff00 ) << 8 \|
110			( idata & 0x00ff0000 ) >> 8 \|
111			( idata & 0xff000000 ) >> 24 ;
112	dpavlin	22
113	dpavlin	67	uint64_t priority,vector, active;
114			priority = ( decoded & OPENPIC_PRIORITY_MASK ) >> OPENPIC_PRIORITY_SHIFT;
115			vector = ( decoded & OPENPIC_VECTOR_MASK );
116			active = ( decoded & OPENPIC_ACTIVITY );
117	dpavlin	66
118	dpavlin	67	debug("[ openpic: WRITE %05x \| %08x => %08x \| priority: %x vector: 0x%02x %d active: %x ]\n",
119			(int)relative_addr, (int)idata, (int)decoded, (int)priority, (int)vector, (int)vector, (int)active );
120			}
121	dpavlin	66
122	dpavlin	22	switch (relative_addr) {
123
124	dpavlin	65	case 0x00:
125	dpavlin	66	if (writeflag == MEM_READ) {
126	dpavlin	65	// version 1.2
127			odata = 0x02000000;
128	dpavlin	66	fatal("[ openpic: read from "
129			"offset 0x%x (OpenPIC version) = %x]\n", (int)
130			relative_addr, (int)odata);
131			}
132			fatal("[ openpic: unimplemented write to "
133			"offset 0x%x: data=0x%x (OpenPIC version) ]\n", (int)
134			relative_addr, (int)idata);
135	dpavlin	65	break;
136
137	dpavlin	22	#if 0
138			#define INT_STATE_REG_H (interrupt_reg + 0x00)
139			#define INT_ENABLE_REG_H (interrupt_reg + 0x04)
140			#define INT_CLEAR_REG_H (interrupt_reg + 0x08)
141			#define INT_LEVEL_REG_H (interrupt_reg + 0x0c)
142			#define INT_STATE_REG_L (interrupt_reg + 0x10)
143			#define INT_ENABLE_REG_L (interrupt_reg + 0x14)
144			#define INT_CLEAR_REG_L (interrupt_reg + 0x18)
145			#define INT_LEVEL_REG_L (interrupt_reg + 0x1c)
146
147			case 0x10:
148			if (writeflag == MEM_READ)
149	dpavlin	24	odata = d->status_hi & d->enable_hi;
150	dpavlin	22	break;
151
152			case 0x14:
153			if (writeflag == MEM_READ)
154			odata = d->enable_hi;
155			else {
156	dpavlin	34	int old_assert = (d->status_lo & d->enable_lo
157			\|\| d->status_hi & d->enable_hi);
158			int new_assert;
159	dpavlin	22	d->enable_hi = idata;
160	dpavlin	34
161			new_assert = (d->status_lo & d->enable_lo \|\|
162			d->status_hi & d->enable_hi);
163
164			if (old_assert && !new_assert)
165			INTERRUPT_DEASSERT(d->cpu_irq);
166			else if (!old_assert && new_assert)
167			INTERRUPT_ASSERT(d->cpu_irq);
168	dpavlin	22	}
169			break;
170
171			case 0x18:
172			if (writeflag == MEM_WRITE) {
173	dpavlin	34	int old_assert = (d->status_lo & d->enable_lo
174			\|\| d->status_hi & d->enable_hi);
175			int new_assert;
176	dpavlin	22	d->status_hi &= ~idata;
177	dpavlin	34
178			new_assert = (d->status_lo & d->enable_lo \|\|
179			d->status_hi & d->enable_hi);
180
181			if (old_assert && !new_assert)
182			INTERRUPT_DEASSERT(d->cpu_irq);
183			else if (!old_assert && new_assert)
184			INTERRUPT_ASSERT(d->cpu_irq);
185	dpavlin	22	}
186			break;
187
188			case 0x20:
189			if (writeflag == MEM_READ)
190	dpavlin	24	odata = d->status_lo & d->enable_lo;
191	dpavlin	22	break;
192
193			case 0x24:
194			if (writeflag == MEM_READ)
195			odata = d->enable_lo;
196			else {
197	dpavlin	34	int old_assert = (d->status_lo & d->enable_lo
198			\|\| d->status_hi & d->enable_hi);
199			int new_assert;
200	dpavlin	22	d->enable_lo = idata;
201	dpavlin	34
202			new_assert = (d->status_lo & d->enable_lo \|\|
203			d->status_hi & d->enable_hi);
204
205			if (old_assert && !new_assert)
206			INTERRUPT_DEASSERT(d->cpu_irq);
207			else if (!old_assert && new_assert)
208			INTERRUPT_ASSERT(d->cpu_irq);
209	dpavlin	22	}
210			break;
211
212			case 0x28:
213			if (writeflag == MEM_WRITE) {
214	dpavlin	34	int old_assert = (d->status_lo & d->enable_lo
215			\|\| d->status_hi & d->enable_hi);
216			int new_assert;
217	dpavlin	22	d->status_lo &= ~idata;
218	dpavlin	34
219			new_assert = (d->status_lo & d->enable_lo \|\|
220			d->status_hi & d->enable_hi);
221
222			if (old_assert && !new_assert)
223			INTERRUPT_DEASSERT(d->cpu_irq);
224			else if (!old_assert && new_assert)
225			INTERRUPT_ASSERT(d->cpu_irq);
226	dpavlin	22	}
227			break;
228
229	dpavlin	44	case 0x1c:
230	dpavlin	24	case 0x2c:
231	dpavlin	34	/* Avoid a debug message. */
232	dpavlin	24	break;
233	dpavlin	64	#endif
234	dpavlin	22	default:if (writeflag == MEM_WRITE) {
235	dpavlin	63	fatal("[ openpic: unimplemented write to "
236	dpavlin	22	"offset 0x%x: data=0x%x ]\n", (int)
237			relative_addr, (int)idata);
238			} else {
239	dpavlin	63	fatal("[ openpic: unimplemented read from "
240	dpavlin	22	"offset 0x%x ]\n", (int)relative_addr);
241			}
242			}
243
244			if (writeflag == MEM_READ)
245			memory_writemax64(cpu, data, len, odata);
246
247			return 1;
248			}
249
250
251	dpavlin	63	DEVINIT(openpic)
252	dpavlin	22	{
253	dpavlin	63	struct openpic_data *d;
254	dpavlin	34	int i;
255	dpavlin	22
256	dpavlin	63	CHECK_ALLOCATION(d = malloc(sizeof(struct openpic_data)));
257			memset(d, 0, sizeof(struct openpic_data));
258	dpavlin	22
259	dpavlin	42	/* Connect to the CPU interrupt pin: */
260	dpavlin	34	INTERRUPT_CONNECT(devinit->interrupt_path, d->cpu_irq);
261	dpavlin	22
262	dpavlin	34	/*
263	dpavlin	64	* Register the 126 OpenPIC interrupts
264	dpavlin	34	*/
265	dpavlin	64	for (i=0; i<126; i++) {
266	dpavlin	34	struct interrupt template;
267			char n[300];
268	dpavlin	64	snprintf(n, sizeof(n), "%s.openpic.%i",
269	dpavlin	34	devinit->interrupt_path, i);
270			memset(&template, 0, sizeof(template));
271			template.line = 1 << i;
272			template.name = n;
273			template.extra = d;
274	dpavlin	63	template.interrupt_assert = openpic_lo_interrupt_assert;
275			template.interrupt_deassert = openpic_lo_interrupt_deassert;
276	dpavlin	34	interrupt_handler_register(&template);
277			}
278
279	dpavlin	63	memory_device_register(devinit->machine->memory, "openpic",
280			devinit->addr, DEV_OPENPIC_LENGTH, dev_openpic_access, d, DM_DEFAULT, NULL);
281	dpavlin	34
282			return 1;
283	dpavlin	22	}
284