Lindent on the new APIC/ACPI files
[akaros.git] / kern / arch / x86 / ioapic.c
1 /* 
2  * This file is part of the UCB release of Plan 9. It is subject to the license
3  * terms in the LICENSE file found in the top-level directory of this
4  * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
5  * part of the UCB release of Plan 9, including this file, may be copied,
6  * modified, propagated, or distributed except according to the terms contained
7  * in the LICENSE file.
8  */
9
10 #include <vfs.h>
11 #include <kfs.h>
12 #include <slab.h>
13 #include <kmalloc.h>
14 #include <kref.h>
15 #include <string.h>
16 #include <stdio.h>
17 #include <assert.h>
18 #include <error.h>
19 #include <cpio.h>
20 #include <pmap.h>
21 #include <smp.h>
22 #include <ip.h>
23 #include <arch/io.h>
24 #include <acpi.h>
25
26 struct Rbus {
27         struct Rbus *next;
28         int devno;
29         struct Rdt *rdt;
30 };
31
32 struct Rdt {
33         struct apic *apic;
34         int intin;
35         uint32_t lo;
36
37         int ref;                                        /* could map to multiple busses */
38         int enabled;                            /* times enabled */
39 };
40
41 enum {                                                  /* IOAPIC registers */
42         Ioregsel = 0x00,                        /* indirect register address */
43         Iowin = 0x04,   /* indirect register data */
44         Ioipa = 0x08,   /* IRQ Pin Assertion */
45         Ioeoi = 0x10,   /* EOI */
46
47         Ioapicid = 0x00,        /* Identification */
48         Ioapicver = 0x01,       /* Version */
49         Ioapicarb = 0x02,       /* Arbitration */
50         Ioabcfg = 0x03, /* Boot Coniguration */
51         Ioredtbl = 0x10,        /* Redirection Table */
52 };
53
54 static struct Rdt rdtarray[Nrdt];
55 static int nrdtarray;
56 static struct Rbus *rdtbus[Nbus];
57 static struct Rdt *rdtvecno[IdtMAX + 1];
58
59 static spinlock_t idtnolock;
60 static int idtno = IdtIOAPIC;
61
62 struct apic xioapic[Napic];
63 int apiceoi(int);
64 int apicisr(int);
65 static void rtblget(struct apic *apic, int sel, uint32_t * hi, uint32_t * lo)
66 {
67         sel = Ioredtbl + 2 * sel;
68
69         *(apic->addr + Ioregsel) = sel + 1;
70         *hi = *(apic->addr + Iowin);
71         *(apic->addr + Ioregsel) = sel;
72         *lo = *(apic->addr + Iowin);
73 }
74
75 static void rtblput(struct apic *apic, int sel, uint32_t hi, uint32_t lo)
76 {
77         sel = Ioredtbl + 2 * sel;
78
79         *(apic->addr + Ioregsel) = sel + 1;
80         *(apic->addr + Iowin) = hi;
81         *(apic->addr + Ioregsel) = sel;
82         *(apic->addr + Iowin) = lo;
83 }
84
85 struct Rdt *rdtlookup(struct apic *apic, int intin)
86 {
87         int i;
88         struct Rdt *r;
89
90         for (i = 0; i < nrdtarray; i++) {
91                 r = rdtarray + i;
92                 if (apic == r->apic && intin == r->intin)
93                         return r;
94         }
95         return NULL;
96 }
97
98 /* busno is the source bus
99  * apic is the destination apic
100  * intin is the INTIN pin on the destination apic
101  * devno is the device number in the style of a PCI Interrupt
102  * Assignment Entry. Which is devno << 2? 
103  * lo is the vector table entry. We need to figure out how
104  * to compute this from acpi. We used to get it from the
105  * mptable but we would like to avoid that.
106  */
107 void ioapicintrinit(int busno, int apicno, int intin, int devno, int lo)
108 {
109         struct Rbus *rbus;
110         struct Rdt *rdt;
111         struct apic *apic;
112         printk("%s: busno %d apicno %d intin %d devno %p lo %p\n", __func__,
113                    busno, apicno, intin, devno, lo);
114
115         if (busno >= Nbus || apicno >= Napic || nrdtarray >= Nrdt) {
116                 printk("FAIL 1\n");
117                 return;
118         }
119         apic = &xioapic[apicno];
120         if (!apic->useable || intin >= apic->nrdt) {
121                 printk("apic->usable %d intin %d apic->nrdt %d OOR\n", apic->useable,
122                            intin, apic->nrdt);
123                 return;
124         }
125
126         rdt = rdtlookup(apic, intin);
127         if (rdt == NULL) {
128                 printk("NO RDT, install it for apic %d intin %d lo %p\n", apicno, intin,
129                            lo);
130                 rdt = &rdtarray[nrdtarray++];
131                 rdt->apic = apic;
132                 rdt->intin = intin;
133                 rdt->lo = lo;
134         } else {
135                 if (lo != rdt->lo) {
136                         printd("mutiple irq botch bus %d %d/%d/%d lo %d vs %d\n",
137                                    busno, apicno, intin, devno, lo, rdt->lo);
138                         return;
139                 }
140                 printk("dup rdt %d %d %d %d %.8p\n", busno, apicno, intin, devno, lo);
141         }
142         rdt->ref++;
143         rbus = kzmalloc(sizeof *rbus, 0);
144         rbus->rdt = rdt;
145         rbus->devno = devno;
146         rbus->next = rdtbus[busno];
147         rdtbus[busno] = rbus;
148 }
149
150 static int map_polarity[4] = {
151         -1, IPhigh, -1, IPlow
152 };
153
154 static int map_edge_level[4] = {
155         -1, TMedge, -1, TMlevel
156 };
157
158 int ioapic_route_irq(int irq, int apicno, int devno)
159 {
160         extern struct Madt *apics;
161         struct Madt *a = apics;
162         struct Apicst *st;
163         uint32_t lo;
164         int pol, edge_level;
165         printk("%s(%d,%d);\n", __func__, irq, apicno);
166         /* find it. */
167         for (st = apics->st; st != NULL; st = st->next) {
168                 printk("Check %d, ", st->type);
169                 if (st->type == ASintovr) {
170                         printk("irq of st is %d\n", st->intovr.irq);
171                         if (st->intovr.irq == irq)
172                                 break;
173                 }
174         }
175         if (!st) {
176                 printk("IRQ %d not found in MADT\n", irq);
177                 return -1;
178         }
179
180         pol = map_polarity[st->intovr.flags & AFpmask];
181         if (pol < 0) {
182                 printk("BAD POLARITY\n");
183                 return -1;
184         }
185
186         edge_level = map_edge_level[(st->intovr.flags & AFlevel) >> 2];
187         if (edge_level < 0) {
188                 printk("BAD edge/level\n");
189                 return -1;
190         }
191         lo = pol | edge_level;
192         ioapicintrinit(0, 0, 0 /*st->intovr.intr */ , devno, lo);
193         printk("FOUND the MADT for %d\n", irq);
194         return 0;
195 }
196
197 void ioapicinit(int id, int ibase, uintptr_t pa)
198 {
199         struct apic *apic;
200         static int base;
201
202         /*
203          * Mark the IOAPIC useable if it has a good ID
204          * and the registers can be mapped.
205          */
206         if (id >= Napic)
207                 return;
208
209         apic = &xioapic[id];
210         apic->addr = IOAPIC_BASE;
211         if (apic->useable)
212                 return;
213         apic->useable = 1;
214         apic->paddr = pa;
215
216         /*
217          * Initialise the I/O APIC.
218          * The MultiProcessor Specification says it is the
219          * responsibility of the O/S to set the APIC ID.
220          */
221         spin_lock(&apic->lock);
222         *(apic->addr + Ioregsel) = Ioapicver;
223         apic->nrdt = ((*(apic->addr + Iowin) >> 16) & 0xff) + 1;
224         if (ibase != -1)
225                 apic->ibase = ibase;
226         else {
227                 apic->ibase = base;
228                 base += apic->nrdt;
229         }
230         *(apic->addr + Ioregsel) = Ioapicid;
231         *(apic->addr + Iowin) = id << 24;
232         spin_unlock(&apic->lock);
233 }
234
235 char *ioapicdump(char *start, char *end)
236 {
237         int i, n;
238         struct Rbus *rbus;
239         struct Rdt *rdt;
240         struct apic *apic;
241         uint32_t hi, lo;
242
243         if (!2)
244                 return start;
245         for (i = 0; i < Napic; i++) {
246                 apic = &xioapic[i];
247                 if (!apic->useable || apic->addr == 0)
248                         continue;
249                 start = seprintf(start, end, "ioapic %d addr %#p nrdt %d ibase %d\n",
250                                                  i, apic->addr, apic->nrdt, apic->ibase);
251                 for (n = 0; n < apic->nrdt; n++) {
252                         spin_lock(&apic->lock);
253                         rtblget(apic, n, &hi, &lo);
254                         spin_unlock(&apic->lock);
255                         start = seprintf(start, end, " rdt %2.2d %p %p\n", n, hi, lo);
256                 }
257         }
258         for (i = 0; i < Nbus; i++) {
259                 if ((rbus = rdtbus[i]) == NULL)
260                         continue;
261                 start = seprintf(start, end, "iointr bus %d:\n", i);
262                 for (; rbus != NULL; rbus = rbus->next) {
263                         rdt = rbus->rdt;
264                         start = seprintf(start, end,
265                                                          " apic %ld devno %#p (%d %d) intin %d lo %#p ref %d\n",
266                                                          rdt->apic - xioapic, rbus->devno, rbus->devno >> 2,
267                                                          rbus->devno & 0x03, rdt->intin, rdt->lo, rdt->ref);
268                 }
269         }
270         return start;
271 }
272
273 void ioapiconline(void)
274 {
275         int i;
276         struct apic *apic;
277
278         for (apic = xioapic; apic < &xioapic[Napic]; apic++) {
279                 if (!apic->useable || apic->addr == NULL)
280                         continue;
281                 for (i = 0; i < apic->nrdt; i++) {
282                         spin_lock(&apic->lock);
283                         rtblput(apic, i, 0, Im);
284                         spin_unlock(&apic->lock);
285                 }
286         }
287 }
288
289 static int dfpolicy = 0;
290
291 static void ioapicintrdd(uint32_t * hi, uint32_t * lo)
292 {
293         int i;
294         static int df;
295         static spinlock_t dflock;
296
297         /*
298          * Set delivery mode (lo) and destination field (hi),
299          * according to interrupt routing policy.
300          */
301         /*
302          * The bulk of this code was written ~1995, when there was
303          * one architecture and one generation of hardware, the number
304          * of CPUs was up to 4(8) and the choices for interrupt routing
305          * were physical, or flat logical (optionally with lowest
306          * priority interrupt). Logical mode hasn't scaled well with
307          * the increasing number of packages/cores/threads, so the
308          * fall-back is to physical mode, which works across all processor
309          * generations, both AMD and Intel, using the APIC and xAPIC.
310          *
311          * Interrupt routing policy can be set here.
312          */
313         switch (dfpolicy) {
314                 default:        /* noise core 0 */
315 #warning "sys->machptr[0]->apicno --- what is this in Akaros?"
316                         *hi = 0;        //sys->machptr[0]->apicno<<24;
317                         break;
318                 case 1: /* round-robin */
319                         /*
320                          * Assign each interrupt to a different CPU on a round-robin
321                          * Some idea of the packages/cores/thread topology would be
322                          * useful here, e.g. to not assign interrupts to more than one
323                          * thread in a core. But, as usual, Intel make that an onerous
324                          * task.
325                          */
326                         spin_lock(&dflock);
327                         for (;;) {
328 #if 0
329                                 i = df++;
330                                 if (df >= sys->nmach + 1)
331                                         df = 0;
332                                 if (sys->machptr[i] == NULL || !sys->machptr[i]->online)
333                                         continue;
334                                 i = sys->machptr[i]->apicno;
335 #endif
336 #warning "always picking acpino 0"
337                                 i = 0;
338                                 if (xlapic[i].useable && xlapic[i].addr == 0)
339                                         break;
340                         }
341                         spin_unlock(&dflock);
342
343                         *hi = i << 24;
344                         break;
345         }
346         *lo |= Pm | MTf;
347 }
348
349 int nextvec(void)
350 {
351         unsigned int vecno;
352
353         spin_lock(&idtnolock);
354         vecno = idtno;
355         idtno = (idtno + 8) % IdtMAX;
356         if (idtno < IdtIOAPIC)
357                 idtno += IdtIOAPIC;
358         spin_unlock(&idtnolock);
359
360         return vecno;
361 }
362
363 #warning "no msi mask yet"
364 static int msimask(struct Vkey *v, int mask)
365 {
366 #if 0
367         Pcidev *p;
368
369         p = pcimatchtbdf(v->tbdf);
370         if (p == NULL)
371                 return -1;
372         return pcimsimask(p, mask);
373 #else
374         return -1;
375 #endif
376 }
377
378 #warning "No msi yet"
379 #if 0
380 static int intrenablemsi(struct vctl *v, Pcidev * p)
381 {
382         unsigned int vno, lo, hi;
383         uint64_t msivec;
384
385         vno = nextvec();
386
387         lo = IPlow | TMedge | vno;
388         ioapicintrdd(&hi, &lo);
389
390         if (lo & Lm)
391                 lo |= MTlp;
392
393         msivec = (uint64_t) hi << 32 | lo;
394         if (pcimsienable(p, msivec) == -1)
395                 return -1;
396         v->isr = apicisr;
397         v->eoi = apiceoi;
398         v->vno = vno;
399         v->type = "msi";
400         v->mask = msimask;
401
402         printk("msiirq: %T: enabling %.16llp %s irq %d vno %d\n", p->tbdf, msivec,
403                    v->name, v->irq, vno);
404         return vno;
405 }
406 #endif
407 #warning "no disable msi yet"
408 #if 0
409 int disablemsi(Vctl *, Pcidev * p)
410 {
411         if (p == NULL)
412                 return -1;
413         return pcimsimask(p, 1);
414 }
415 #endif
416 int ioapicintrenable(Vctl * v)
417 {
418         struct Rbus *rbus;
419         struct Rdt *rdt;
420         uint32_t hi, lo;
421         int busno = 0, devno, vecno;
422
423 /*
424  * Bridge between old and unspecified new scheme,
425  * the work in progress...
426  */
427         if (v->tbdf == BUSUNKNOWN) {
428                 printk("%s; BUSUNKNOWN\n", __func__);
429                 if (v->irq >= IrqLINT0 && v->irq <= MaxIrqLAPIC) {
430                         if (v->irq != IrqSPURIOUS)
431                                 v->isr = apiceoi;
432                         v->type = "lapic";
433                         return v->irq;
434                 } else {
435                         printk("%s; legacy isa\n", __func__);
436
437                         /*
438                          * Legacy ISA.
439                          * Make a busno and devno using the
440                          * ISA bus number and the irq.
441                          */
442 #if 0
443                         extern int mpisabusno;
444
445                         if (mpisabusno == -1)
446                                 panic("no ISA bus allocated");
447                         busno = mpisabusno;
448 #endif
449                         busno = 0;
450                         devno = v->irq << 2;
451                 }
452         } else if (BUSTYPE(v->tbdf) == BusPCI) {
453                 printk("%s; BusPCI \n", __func__);
454                 /*
455                  * PCI.
456                  * Make a devno from BUSDNO(tbdf) and pcidev->intp.
457                  */
458                 /* we'll assume it's there. */
459 #if 0
460                 Pcidev *pcidev;
461
462                 busno = BUSBNO(v->tbdf);
463                 if ((pcidev = pcimatchtbdf(v->tbdf)) == NULL)
464                         panic("no PCI dev for tbdf %p", v->tbdf);
465                 if ((vecno = intrenablemsi(v, pcidev)) != -1)
466                         return vecno;
467                 disablemsi(v, pcidev);
468 #endif
469
470                 struct pci_device pcidev;
471
472                 explode_tbdf(v->tbdf);
473                 devno = pcidev_read8(&pcidev, PciINTP);
474                 printk("INTP is %d\n", devno);
475
476                 if (devno == 0)
477                         panic("no INTP for tbdf %p", v->tbdf);
478                 devno = BUSDNO(v->tbdf) << 2 | (devno - 1);
479                 printk("devno is %08lx\n", devno);
480                 printk("ioapicintrenable: tbdf %p busno %d devno %d\n",
481                            v->tbdf, busno, devno);
482         } else {
483                 //SET(busno, devno);
484                 busno = devno = 0;
485                 panic("unknown tbdf %px", v->tbdf);
486         }
487
488         rdt = NULL;
489         for (rbus = rdtbus[busno]; rbus != NULL; rbus = rbus->next) {
490                 printk("Check rbus->devno %p devno %p\n", rbus->devno, devno);
491                 if (rbus->devno == devno) {
492                         rdt = rbus->rdt;
493                         break;
494                 }
495         }
496         if (rdt == NULL) {
497                 // install it? Who knows?
498                 int ioapic_route_irq(int irq, int apicno, int devno);
499                 ioapic_route_irq(v->irq, 0, devno);
500                 extern int mpisabusno;
501                 printk("rdt is NULLLLLLLLLLLLLLLLLLLLLL\n");
502
503                 /*
504                  * First crack in the smooth exterior of the new code:
505                  * some BIOS make an MPS table where the PCI devices
506                  * are just defaulted to ISA.  Rewrite this to be
507                  * cleaner.
508                  * no MPS table in akaros.
509                  if((busno = mpisabusno) == -1)
510                  return -1;
511
512                  devno = v->irq<<2;
513                  */
514                 for (rbus = rdtbus[busno]; rbus != NULL; rbus = rbus->next)
515                         if (rbus->devno == devno) {
516                                 printk("rbus->devno = %p, devno %p\n", rbus->devno, devno);
517                                 rdt = rbus->rdt;
518                                 break;
519                         }
520                 printk("isa: tbdf %p busno %d devno %d %#p\n",
521                            v->tbdf, busno, devno, rdt);
522         }
523         if (rdt == NULL) {
524                 printk("RDT Is STILL NULL!\n");
525                 return -1;
526         }
527
528         printk("Second crack\n");
529         /*
530          * Second crack:
531          * what to do about devices that intrenable/intrdisable frequently?
532          * 1) there is no ioapicdisable yet;
533          * 2) it would be good to reuse freed vectors.
534          * Oh bugger.
535          */
536         /*
537          * This is a low-frequency event so just lock
538          * the whole IOAPIC to initialise the RDT entry
539          * rather than putting a Lock in each entry.
540          */
541         spin_lock(&rdt->apic->lock);
542         printk("%p: %ld/%d/%d (%d)\n", v->tbdf, rdt->apic - xioapic, rbus->devno,
543                    rdt->intin, devno);
544         if ((rdt->lo & 0xff) == 0) {
545                 vecno = nextvec();
546                 rdt->lo |= vecno;
547                 rdtvecno[vecno] = rdt;
548         } else
549                 printk("%p: mutiple irq bus %d dev %d\n", v->tbdf, busno, devno);
550
551         rdt->enabled++;
552         lo = (rdt->lo & ~Im);
553         ioapicintrdd(&hi, &lo);
554         rtblput(rdt->apic, rdt->intin, hi, lo);
555         vecno = lo & 0xff;
556         spin_unlock(&rdt->apic->lock);
557
558         printk("busno %d devno %d hi %p lo %p vecno %d\n",
559                    busno, devno, hi, lo, vecno);
560         v->isr = apicisr;
561         v->eoi = apiceoi;
562         v->vno = vecno;
563         v->type = "ioapic";
564
565         return vecno;
566 }
567
568 int ioapicintrdisable(int vecno)
569 {
570         struct Rdt *rdt;
571
572         /*
573          * FOV. Oh dear. This isn't very good.
574          * Fortunately rdtvecno[vecno] is static
575          * once assigned.
576          * Must do better.
577          *
578          * What about any pending interrupts?
579          */
580         if (vecno < 0 || vecno > MaxVectorAPIC) {
581                 panic("ioapicintrdisable: vecno %d out of range", vecno);
582                 return -1;
583         }
584         if ((rdt = rdtvecno[vecno]) == NULL) {
585                 panic("ioapicintrdisable: vecno %d has no rdt", vecno);
586                 return -1;
587         }
588
589         spin_lock(&rdt->apic->lock);
590         rdt->enabled--;
591         if (rdt->enabled == 0)
592                 rtblput(rdt->apic, rdt->intin, 0, rdt->lo);
593         spin_unlock(&rdt->apic->lock);
594
595         return 0;
596 }
597
598 spinlock_t vctllock;
599
600 void *intrenable(int irq, void (*f) (void *, void *), void *a, int tbdf)
601 {
602         int vno;
603         Vctl *v;
604         extern int ioapicintrenable(Vctl *);
605
606         if (f == NULL) {
607                 printk("intrenable: nil handler for %d, tbdf %p\n", irq, tbdf);
608                 return NULL;
609         }
610
611         v = kzmalloc(sizeof(Vctl), KMALLOC_WAIT);
612         v->isintr = 1;
613         v->irq = irq;
614         v->tbdf = tbdf;
615         v->f = f;
616         v->a = a;
617
618         //spilock(&vctllock);
619         vno = ioapicintrenable(v);
620         printk("INTRENABLE, vno is %d\n", vno);
621         if (vno == -1) {
622                 //iunlock(&vctllock);
623                 printk("intrenable: couldn't enable irq %d, tbdf %p for %s\n",
624                            irq, tbdf, v->name);
625                 kfree(v);
626                 return NULL;
627         }
628 #if 0
629         if (vctl[vno]) {
630                 if (vctl[v->vno]->isr != v->isr || vctl[v->vno]->eoi != v->eoi)
631                         panic("intrenable: handler: %s %s %#p %#p %#p %#p",
632                                   vctl[v->vno]->name, v->name,
633                                   vctl[v->vno]->isr, v->isr, vctl[v->vno]->eoi, v->eoi);
634         }
635
636         v->vno = vno;
637         v->next = vctl[vno];
638         vctl[vno] = v;
639 #endif
640         //iunlock(&vctllock);
641
642         if (v->mask)
643                 v->mask(v, 0);
644
645         /*
646          * Return the assigned vector so intrdisable can find
647          * the handler; the IRQ is useless in the wonderful world
648          * of the IOAPIC.
649          */
650         printk("INTRNABLE returns %d\n", v);
651         return v;
652 }