1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
/*
* Copyright 2003 by Peter Grehan. 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 ``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 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.
*
* $FreeBSD$
*/
/*
* A driver for the PIC found in the Heathrow/Paddington MacIO chips.
* This was superseded by an OpenPIC in the Keylargo and beyond
* MacIO versions.
*
* The device is initially located in the Open Firmware device tree
* in the earliest stage of the nexus probe. However, no device registers
* are touched until the actual h/w is probed later on during the
* MacIO probe. At that point, any interrupt sources that were allocated
* prior to this are activated.
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/module.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/kernel.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/openfirm.h>
#include <machine/bus.h>
#include <machine/intr.h>
#include <machine/intr_machdep.h>
#include <machine/md_var.h>
#include <machine/nexusvar.h>
#include <machine/pio.h>
#include <machine/resource.h>
#include <vm/vm.h>
#include <vm/pmap.h>
#include <sys/rman.h>
#include <powerpc/powermac/hrowpicvar.h>
#include "pic_if.h"
/*
* Device interface.
*/
static void hrowpic_identify(driver_t *, device_t);
static int hrowpic_probe(device_t);
static int hrowpic_attach(device_t);
/*
* PIC interface.
*/
static struct resource *hrowpic_allocate_intr(device_t, device_t, int *,
u_long, u_int);
static int hrowpic_setup_intr(device_t, device_t,
struct resource *, int, driver_intr_t, void *,
void **);
static int hrowpic_teardown_intr(device_t, device_t,
struct resource *, void *);
static int hrowpic_release_intr(device_t dev, device_t, int,
struct resource *res);
/*
* MacIO interface
*/
static int hrowpic_macio_probe(device_t);
static int hrowpic_macio_attach(device_t);
/*
* Local routines
*/
static void hrowpic_intr(void);
static void hrowpic_ext_enable_irq(uintptr_t);
static void hrowpic_ext_disable_irq(uintptr_t);
static void hrowpic_toggle_irq(struct hrowpic_softc *sc, int, int);
/*
* Interrupt controller softc. There should only be one.
*/
static struct hrowpic_softc *hpicsoftc;
/*
* Driver methods.
*/
static device_method_t hrowpic_methods[] = {
/* Device interface */
DEVMETHOD(device_identify, hrowpic_identify),
DEVMETHOD(device_probe, hrowpic_probe),
DEVMETHOD(device_attach, hrowpic_attach),
/* PIC interface */
DEVMETHOD(pic_allocate_intr, hrowpic_allocate_intr),
DEVMETHOD(pic_setup_intr, hrowpic_setup_intr),
DEVMETHOD(pic_teardown_intr, hrowpic_teardown_intr),
DEVMETHOD(pic_release_intr, hrowpic_release_intr),
{ 0, 0 }
};
static driver_t hrowpic_driver = {
"hrowpic",
hrowpic_methods,
sizeof(struct hrowpic_softc)
};
static devclass_t hrowpic_devclass;
DRIVER_MODULE(hrowpic, nexus, hrowpic_driver, hrowpic_devclass, 0, 0);
static void
hrowpic_identify(driver_t *driver, device_t parent)
{
phandle_t chosen, pic;
char type[40];
chosen = OF_finddevice("/chosen");
if (chosen == -1)
return;
if (OF_getprop(chosen, "interrupt-controller", &pic, 4) != 4)
return;
OF_getprop(pic, "compatible", type, sizeof(type));
if (strcmp(type, "heathrow"))
return;
BUS_ADD_CHILD(parent, 0, "hrowpic", 0);
}
static int
hrowpic_probe(device_t dev)
{
char *name;
name = nexus_get_name(dev);
if (strcmp(name, "hrowpic"))
return (ENXIO);
device_set_desc(dev, "Heathrow interrupt controller");
return (0);
}
static int
hrowpic_attach(device_t dev)
{
struct hrowpic_softc *sc;
sc = device_get_softc(dev);
sc->sc_rman.rm_type = RMAN_ARRAY;
sc->sc_rman.rm_descr = device_get_nameunit(dev);
if (rman_init(&sc->sc_rman) != 0 ||
rman_manage_region(&sc->sc_rman, 0, HROWPIC_IRQMAX-1) != 0) {
device_printf(dev, "could not set up resource management");
return (ENXIO);
}
nexus_install_intcntlr(dev);
intr_init(hrowpic_intr, HROWPIC_IRQMAX, hrowpic_ext_enable_irq,
hrowpic_ext_disable_irq);
KASSERT(hpicsoftc == NULL, ("hrowpic: h/w already probed"));
hpicsoftc = sc;
return (0);
}
/*
* PIC interface
*/
static struct resource *
hrowpic_allocate_intr(device_t picdev, device_t child, int *rid, u_long intr,
u_int flags)
{
struct hrowpic_softc *sc;
struct resource *rv;
int needactivate;
sc = device_get_softc(picdev);
needactivate = flags & RF_ACTIVE;
flags &= ~RF_ACTIVE;
rv = rman_reserve_resource(&sc->sc_rman, intr, intr, 1, flags, child);
if (rv == NULL) {
device_printf(picdev, "interrupt reservation failed for %s\n",
device_get_nameunit(child));
return (NULL);
}
return (rv);
}
static int
hrowpic_setup_intr(device_t picdev, device_t child, struct resource *res,
int flags, driver_intr_t *intr, void *arg, void **cookiep)
{
struct hrowpic_softc *sc;
u_long start;
int error;
sc = device_get_softc(picdev);
start = rman_get_start(res);
if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
flags |= INTR_EXCL;
/*
* We depend here on rman_activate_resource() being idempotent.
*/
error = rman_activate_resource(res);
if (error)
return (error);
error = inthand_add(device_get_nameunit(child), start, intr, arg,
flags, cookiep);
if (!error) {
/*
* Record irq request, and enable if h/w has been probed
*/
sc->sc_irq[start] = 1;
if (sc->sc_memr) {
hrowpic_toggle_irq(sc, start, 1);
}
}
return (error);
}
static int
hrowpic_teardown_intr(device_t picdev, device_t child, struct resource *res,
void *ih)
{
int error;
error = rman_deactivate_resource(res);
if (error)
return (error);
error = inthand_remove(rman_get_start(res), ih);
return (error);
}
static int
hrowpic_release_intr(device_t picdev, device_t child, int rid,
struct resource *res)
{
int error;
if (rman_get_flags(res) & RF_ACTIVE) {
error = bus_deactivate_resource(child, SYS_RES_IRQ, rid, res);
if (error)
return (error);
}
return (rman_release_resource(res));
}
/*
* Interrupt interface
*/
static void
hrowpic_write_reg(struct hrowpic_softc *sc, u_int reg, u_int bank,
u_int32_t val)
{
if (bank == HPIC_PRIMARY)
reg += HPIC_1ST_OFFSET;
bus_space_write_4(sc->sc_bt, sc->sc_bh, reg, val);
/*
* XXX Issue a read to force the write to complete
*/
bus_space_read_4(sc->sc_bt, sc->sc_bh, reg);
}
static u_int32_t
hrowpic_read_reg(struct hrowpic_softc *sc, u_int reg, u_int bank)
{
if (bank == HPIC_PRIMARY)
reg += HPIC_1ST_OFFSET;
return (bus_space_read_4(sc->sc_bt, sc->sc_bh, reg));
}
static void
hrowpic_clear_all(struct hrowpic_softc *sc)
{
/*
* Disable all interrupt sources and clear outstanding interrupts
*/
hrowpic_write_reg(sc, HPIC_ENABLE, HPIC_PRIMARY, 0);
hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_PRIMARY, 0xffffffff);
hrowpic_write_reg(sc, HPIC_ENABLE, HPIC_SECONDARY, 0);
hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_SECONDARY, 0xffffffff);
}
static void
hrowpic_toggle_irq(struct hrowpic_softc *sc, int irq, int enable)
{
u_int roffset;
u_int rbit;
KASSERT((irq > 0) && (irq < HROWPIC_IRQMAX), ("en irq out of range"));
/*
* Calculate prim/sec register bank for the IRQ, update soft copy,
* and enable the IRQ as an interrupt source
*/
roffset = HPIC_INT_TO_BANK(irq);
rbit = HPIC_INT_TO_REGBIT(irq);
if (enable)
sc->sc_softreg[roffset] |= (1 << rbit);
else
sc->sc_softreg[roffset] &= ~(1 << rbit);
hrowpic_write_reg(sc, HPIC_ENABLE, roffset, sc->sc_softreg[roffset]);
}
static void
hrowpic_intr(void)
{
int irq_lo, irq_hi;
int i;
struct hrowpic_softc *sc;
sc = hpicsoftc;
/*
* Loop through both interrupt sources until they are empty.
* XXX simplistic code, far from optimal.
*/
do {
irq_lo = hrowpic_read_reg(sc, HPIC_STATUS, HPIC_PRIMARY);
if (irq_lo) {
hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_PRIMARY,
irq_lo);
for (i = 0; i < HROWPIC_IRQ_REGNUM; i++) {
if (irq_lo & (1 << i)) {
/*
* Disable IRQ and call handler
*/
hrowpic_toggle_irq(sc, i, 0);
intr_handle(i);
}
}
}
irq_hi = hrowpic_read_reg(sc, HPIC_STATUS, HPIC_SECONDARY);
if (irq_hi) {
hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_SECONDARY,
irq_hi);
for (i = 0; i < HROWPIC_IRQ_REGNUM; i++) {
if (irq_hi & (1 << i)) {
/*
* Disable IRQ and call handler
*/
hrowpic_toggle_irq(sc,
i + HROWPIC_IRQ_REGNUM, 0);
intr_handle(i + HROWPIC_IRQ_REGNUM);
}
}
}
} while (irq_lo && irq_hi);
}
static void
hrowpic_ext_enable_irq(uintptr_t irq)
{
hrowpic_toggle_irq(hpicsoftc, irq, 1);
}
static void
hrowpic_ext_disable_irq(uintptr_t irq)
{
hrowpic_toggle_irq(hpicsoftc, irq, 0);
}
/*
* MacIO interface
*/
static device_method_t hrowpic_macio_methods[] = {
/* Device interface */
DEVMETHOD(device_probe, hrowpic_macio_probe),
DEVMETHOD(device_attach, hrowpic_macio_attach),
{ 0, 0 },
};
static driver_t hrowpic_macio_driver = {
"hrowpicmacio",
hrowpic_macio_methods,
0
};
static devclass_t hrowpic_macio_devclass;
DRIVER_MODULE(hrowpicmacio, macio, hrowpic_macio_driver,
hrowpic_macio_devclass, 0, 0);
static int
hrowpic_macio_probe(device_t dev)
{
const char *type = ofw_bus_get_type(dev);
/*
* OpenPIC cells have a type of "open-pic", so this
* is sufficient to identify a Heathrow cell
*/
if (strcmp(type, "interrupt-controller") != 0)
return (ENXIO);
/*
* The description was already printed out in the nexus
* probe, so don't do it again here
*/
device_set_desc(dev, "Heathrow MacIO interrupt cell");
device_quiet(dev);
return (0);
}
static int
hrowpic_macio_attach(device_t dev)
{
struct hrowpic_softc *sc = hpicsoftc;
int rid;
int i;
KASSERT(sc != NULL, ("pic not nexus-probed\n"));
sc->sc_maciodev = dev;
rid = 0;
sc->sc_memr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
RF_ACTIVE);
if (sc->sc_memr == NULL) {
device_printf(dev, "Could not alloc mem resource!\n");
return (ENXIO);
}
sc->sc_bt = rman_get_bustag(sc->sc_memr);
sc->sc_bh = rman_get_bushandle(sc->sc_memr);
hrowpic_clear_all(sc);
/*
* Enable all IRQs that were requested before the h/w
* was probed
*/
for (i = 0; i < HROWPIC_IRQMAX; i++)
if (sc->sc_irq[i]) {
hrowpic_toggle_irq(sc, i, 1);
}
return (0);
}
|