sys/platform/pc32/apic/ioapic.c

   1 /*
   2  * Copyright (c) 1996, by Steve Passe
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. The name of the developer may NOT be used to endorse or promote products
  11  *    derived from this software without specific prior written permission.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  *
  25  * $FreeBSD: src/sys/i386/i386/mpapic.c,v 1.37.2.7 2003/01/25 02:31:47 peter Exp $
  26  */
  27
  28 #include <sys/param.h>
  29 #include <sys/systm.h>
  30 #include <sys/kernel.h>
  31 #include <sys/bus.h>
  32 #include <sys/machintr.h>
  33 #include <vm/pmap.h>
  34 #include <machine/globaldata.h>
  35 #include <machine/smp.h>
  36 #include <machine/cputypes.h>
  37 #include <machine/md_var.h>
  38 #include <machine/pmap.h>
  39 #include <machine_base/apic/lapic.h>
  40 #include <machine_base/apic/ioapic.h>
  41 #include <machine_base/apic/ioapic_abi.h>
  42 #include <machine/segments.h>
  43 #include <sys/thread2.h>
  44
  45 #include <machine/intr_machdep.h>
  46
  47 #define IOAPIC_COUNT_MAX        16
  48 #define IOAPIC_ID_MASK          (IOAPIC_COUNT_MAX - 1)
  49
  50 /* XXX */
  51 extern pt_entry_t *SMPpt;
  52
  53 struct ioapic_info {
  54         int             io_idx;
  55         int             io_apic_id;
  56         void            *io_addr;
  57         int             io_npin;
  58         int             io_gsi_base;
  59
  60         TAILQ_ENTRY(ioapic_info) io_link;
  61 };
  62 TAILQ_HEAD(ioapic_info_list, ioapic_info);
  63
  64 struct ioapic_intsrc {
  65         int             int_gsi;
  66         enum intr_trigger int_trig;
  67         enum intr_polarity int_pola;
  68 };
  69
  70 struct ioapic_conf {
  71         struct ioapic_info_list ioc_list;
  72         struct ioapic_intsrc ioc_intsrc[16];    /* XXX magic number */
  73 };
  74
  75 static void     ioapic_setup(const struct ioapic_info *);
  76 static int      ioapic_alloc_apic_id(int);
  77 static void     ioapic_set_apic_id(const struct ioapic_info *);
  78 static void     ioapic_gsi_setup(int);
  79 static const struct ioapic_info *
  80                 ioapic_gsi_search(int);
  81 static void     ioapic_pin_prog(void *, int, int,
  82                     enum intr_trigger, enum intr_polarity, uint32_t);
  83
  84 static struct ioapic_conf       ioapic_conf;
  85
  86 static TAILQ_HEAD(, ioapic_enumerator) ioapic_enumerators =
  87         TAILQ_HEAD_INITIALIZER(ioapic_enumerators);
  88
  89 void
  90 ioapic_config(void)
  91 {
  92         struct ioapic_info *info;
  93         int start_apic_id = 0;
  94         struct ioapic_enumerator *e;
  95         int error, i;
  96         u_long ef = 0;
  97
  98         TAILQ_INIT(&ioapic_conf.ioc_list);
  99         /* XXX magic number */
 100         for (i = 0; i < 16; ++i)
 101                 ioapic_conf.ioc_intsrc[i].int_gsi = -1;
 102
 103         TAILQ_FOREACH(e, &ioapic_enumerators, ioapic_link) {
 104                 error = e->ioapic_probe(e);
 105                 if (!error)
 106                         break;
 107         }
 108         if (e == NULL) {
 109 #ifdef notyet
 110                 panic("can't config I/O APIC\n");
 111 #else
 112                 kprintf("no I/O APIC\n");
 113                 return;
 114 #endif
 115         }
 116
 117         crit_enter();
 118
 119         ef = read_eflags();
 120         cpu_disable_intr();
 121
 122         /*
 123          * Switch to I/O APIC MachIntrABI and reconfigure
 124          * the default IDT entries.
 125          */
 126         MachIntrABI = MachIntrABI_IOAPIC;
 127         MachIntrABI.setdefault();
 128
 129         e->ioapic_enumerate(e);
 130
 131         /*
 132          * Setup index
 133          */
 134         i = 0;
 135         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link)
 136                 info->io_idx = i++;
 137
 138         if (i > IOAPIC_COUNT_MAX) /* XXX magic number */
 139                 panic("ioapic_config: more than 16 I/O APIC\n");
 140
 141         /*
 142          * Setup APIC ID
 143          */
 144         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 145                 int apic_id;
 146
 147                 apic_id = ioapic_alloc_apic_id(start_apic_id);
 148                 if (apic_id == NAPICID) {
 149                         kprintf("IOAPIC: can't alloc APIC ID for "
 150                                 "%dth I/O APIC\n", info->io_idx);
 151                         break;
 152                 }
 153                 info->io_apic_id = apic_id;
 154
 155                 start_apic_id = apic_id + 1;
 156         }
 157         if (info != NULL) {
 158                 /*
 159                  * xAPIC allows I/O APIC's APIC ID to be same
 160                  * as the LAPIC's APIC ID
 161                  */
 162                 kprintf("IOAPIC: use xAPIC model to alloc APIC ID "
 163                         "for I/O APIC\n");
 164
 165                 TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link)
 166                         info->io_apic_id = info->io_idx;
 167         }
 168
 169         /*
 170          * Warning about any GSI holes
 171          */
 172         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 173                 const struct ioapic_info *prev_info;
 174
 175                 prev_info = TAILQ_PREV(info, ioapic_info_list, io_link);
 176                 if (prev_info != NULL) {
 177                         if (info->io_gsi_base !=
 178                         prev_info->io_gsi_base + prev_info->io_npin) {
 179                                 kprintf("IOAPIC: warning gsi hole "
 180                                         "[%d, %d]\n",
 181                                         prev_info->io_gsi_base +
 182                                         prev_info->io_npin,
 183                                         info->io_gsi_base - 1);
 184                         }
 185                 }
 186         }
 187
 188         if (bootverbose) {
 189                 TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 190                         kprintf("IOAPIC: idx %d, apic id %d, "
 191                                 "gsi base %d, npin %d\n",
 192                                 info->io_idx,
 193                                 info->io_apic_id,
 194                                 info->io_gsi_base,
 195                                 info->io_npin);
 196                 }
 197         }
 198
 199         /*
 200          * Setup all I/O APIC
 201          */
 202         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link)
 203                 ioapic_setup(info);
 204         ioapic_abi_fixup_irqmap();
 205
 206         write_eflags(ef);
 207
 208         MachIntrABI.cleanup();
 209
 210         crit_exit();
 211 }
 212
 213 void
 214 ioapic_enumerator_register(struct ioapic_enumerator *ne)
 215 {
 216         struct ioapic_enumerator *e;
 217
 218         TAILQ_FOREACH(e, &ioapic_enumerators, ioapic_link) {
 219                 if (e->ioapic_prio < ne->ioapic_prio) {
 220                         TAILQ_INSERT_BEFORE(e, ne, ioapic_link);
 221                         return;
 222                 }
 223         }
 224         TAILQ_INSERT_TAIL(&ioapic_enumerators, ne, ioapic_link);
 225 }
 226
 227 void
 228 ioapic_add(void *addr, int gsi_base, int npin)
 229 {
 230         struct ioapic_info *info, *ninfo;
 231         int gsi_end;
 232
 233         gsi_end = gsi_base + npin - 1;
 234         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 235                 if ((gsi_base >= info->io_gsi_base &&
 236                      gsi_base < info->io_gsi_base + info->io_npin) ||
 237                     (gsi_end >= info->io_gsi_base &&
 238                      gsi_end < info->io_gsi_base + info->io_npin)) {
 239                         panic("ioapic_add: overlapped gsi, base %d npin %d, "
 240                               "hit base %d, npin %d\n", gsi_base, npin,
 241                               info->io_gsi_base, info->io_npin);
 242                 }
 243                 if (info->io_addr == addr)
 244                         panic("ioapic_add: duplicated addr %p\n", addr);
 245         }
 246
 247         ninfo = kmalloc(sizeof(*ninfo), M_DEVBUF, M_WAITOK | M_ZERO);
 248         ninfo->io_addr = addr;
 249         ninfo->io_npin = npin;
 250         ninfo->io_gsi_base = gsi_base;
 251         ninfo->io_apic_id = -1;
 252
 253         /*
 254          * Create IOAPIC list in ascending order of GSI base
 255          */
 256         TAILQ_FOREACH_REVERSE(info, &ioapic_conf.ioc_list,
 257             ioapic_info_list, io_link) {
 258                 if (ninfo->io_gsi_base > info->io_gsi_base) {
 259                         TAILQ_INSERT_AFTER(&ioapic_conf.ioc_list,
 260                             info, ninfo, io_link);
 261                         break;
 262                 }
 263         }
 264         if (info == NULL)
 265                 TAILQ_INSERT_HEAD(&ioapic_conf.ioc_list, ninfo, io_link);
 266 }
 267
 268 void
 269 ioapic_intsrc(int irq, int gsi, enum intr_trigger trig, enum intr_polarity pola)
 270 {
 271         struct ioapic_intsrc *int_src;
 272
 273         KKASSERT(irq < 16);
 274         int_src = &ioapic_conf.ioc_intsrc[irq];
 275
 276         if (gsi == 0) {
 277                 /* Don't allow mixed mode */
 278                 kprintf("IOAPIC: warning intsrc irq %d -> gsi 0\n", irq);
 279                 return;
 280         }
 281
 282         if (int_src->int_gsi != -1) {
 283                 if (int_src->int_gsi != gsi) {
 284                         kprintf("IOAPIC: warning intsrc irq %d, gsi "
 285                                 "%d -> %d\n", irq, int_src->int_gsi, gsi);
 286                 }
 287                 if (int_src->int_trig != trig) {
 288                         kprintf("IOAPIC: warning intsrc irq %d, trig "
 289                                 "%s -> %s\n", irq,
 290                                 intr_str_trigger(int_src->int_trig),
 291                                 intr_str_trigger(trig));
 292                 }
 293                 if (int_src->int_pola != pola) {
 294                         kprintf("IOAPIC: warning intsrc irq %d, pola "
 295                                 "%s -> %s\n", irq,
 296                                 intr_str_polarity(int_src->int_pola),
 297                                 intr_str_polarity(pola));
 298                 }
 299         }
 300         int_src->int_gsi = gsi;
 301         int_src->int_trig = trig;
 302         int_src->int_pola = pola;
 303 }
 304
 305 static void
 306 ioapic_set_apic_id(const struct ioapic_info *info)
 307 {
 308         uint32_t id;
 309         int apic_id;
 310
 311         id = ioapic_read(info->io_addr, IOAPIC_ID);
 312
 313         id &= ~APIC_ID_MASK;
 314         id |= (info->io_apic_id << 24);
 315
 316         ioapic_write(info->io_addr, IOAPIC_ID, id);
 317
 318         /*
 319          * Re-read && test
 320          */
 321         id = ioapic_read(info->io_addr, IOAPIC_ID);
 322         apic_id = (id & APIC_ID_MASK) >> 24;
 323
 324         /*
 325          * I/O APIC ID is a 4bits field
 326          */
 327         if ((apic_id & IOAPIC_ID_MASK) !=
 328             (info->io_apic_id & IOAPIC_ID_MASK)) {
 329                 panic("ioapic_set_apic_id: can't set apic id to %d, "
 330                       "currently set to %d\n", info->io_apic_id, apic_id);
 331         }
 332 }
 333
 334 static void
 335 ioapic_gsi_setup(int gsi)
 336 {
 337         enum intr_trigger trig;
 338         enum intr_polarity pola;
 339         int irq;
 340
 341         if (gsi == 0) {
 342                 /* ExtINT */
 343                 imen_lock();
 344                 ioapic_extpin_setup(ioapic_gsi_ioaddr(gsi),
 345                     ioapic_gsi_pin(gsi), 0);
 346                 imen_unlock();
 347                 return;
 348         }
 349
 350         trig = 0;       /* silence older gcc's */
 351         pola = 0;       /* silence older gcc's */
 352
 353         for (irq = 0; irq < 16; ++irq) {
 354                 const struct ioapic_intsrc *int_src =
 355                     &ioapic_conf.ioc_intsrc[irq];
 356
 357                 if (gsi == int_src->int_gsi) {
 358                         trig = int_src->int_trig;
 359                         pola = int_src->int_pola;
 360                         break;
 361                 }
 362         }
 363
 364         if (irq == 16) {
 365                 if (gsi < 16) {
 366                         trig = INTR_TRIGGER_EDGE;
 367                         pola = INTR_POLARITY_HIGH;
 368                 } else {
 369                         trig = INTR_TRIGGER_LEVEL;
 370                         pola = INTR_POLARITY_LOW;
 371                 }
 372                 irq = gsi;
 373         }
 374
 375         ioapic_abi_set_irqmap(irq, gsi, trig, pola);
 376 }
 377
 378 void *
 379 ioapic_gsi_ioaddr(int gsi)
 380 {
 381         const struct ioapic_info *info;
 382
 383         info = ioapic_gsi_search(gsi);
 384         return info->io_addr;
 385 }
 386
 387 int
 388 ioapic_gsi_pin(int gsi)
 389 {
 390         const struct ioapic_info *info;
 391
 392         info = ioapic_gsi_search(gsi);
 393         return gsi - info->io_gsi_base;
 394 }
 395
 396 static const struct ioapic_info *
 397 ioapic_gsi_search(int gsi)
 398 {
 399         const struct ioapic_info *info;
 400
 401         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 402                 if (gsi >= info->io_gsi_base &&
 403                     gsi < info->io_gsi_base + info->io_npin)
 404                         return info;
 405         }
 406         panic("ioapic_gsi_search: no I/O APIC\n");
 407 }
 408
 409 int
 410 ioapic_gsi(int idx, int pin)
 411 {
 412         const struct ioapic_info *info;
 413
 414         TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 415                 if (info->io_idx == idx)
 416                         break;
 417         }
 418         if (info == NULL)
 419                 return -1;
 420         if (pin >= info->io_npin)
 421                 return -1;
 422         return info->io_gsi_base + pin;
 423 }
 424
 425 void
 426 ioapic_extpin_setup(void *addr, int pin, int vec)
 427 {
 428         ioapic_pin_prog(addr, pin, vec,
 429             INTR_TRIGGER_CONFORM, INTR_POLARITY_CONFORM, IOART_DELEXINT);
 430 }
 431
 432 int
 433 ioapic_extpin_gsi(void)
 434 {
 435         return 0;
 436 }
 437
 438 void
 439 ioapic_pin_setup(void *addr, int pin, int vec,
 440     enum intr_trigger trig, enum intr_polarity pola)
 441 {
 442         /*
 443          * Always clear an I/O APIC pin before [re]programming it.  This is
 444          * particularly important if the pin is set up for a level interrupt
 445          * as the IOART_REM_IRR bit might be set.   When we reprogram the
 446          * vector any EOI from pending ints on this pin could be lost and
 447          * IRR might never get reset.
 448          *
 449          * To fix this problem, clear the vector and make sure it is
 450          * programmed as an edge interrupt.  This should theoretically
 451          * clear IRR so we can later, safely program it as a level
 452          * interrupt.
 453          */
 454         ioapic_pin_prog(addr, pin, vec, INTR_TRIGGER_EDGE, INTR_POLARITY_HIGH,
 455             IOART_DELFIXED);
 456         ioapic_pin_prog(addr, pin, vec, trig, pola, IOART_DELFIXED);
 457 }
 458
 459 static void
 460 ioapic_pin_prog(void *addr, int pin, int vec,
 461     enum intr_trigger trig, enum intr_polarity pola, uint32_t del_mode)
 462 {
 463         uint32_t flags, target;
 464         int select;
 465
 466         KKASSERT(del_mode == IOART_DELEXINT || del_mode == IOART_DELFIXED);
 467
 468         select = IOAPIC_REDTBL0 + (2 * pin);
 469
 470         flags = ioapic_read(addr, select) & IOART_RESV;
 471         flags |= IOART_INTMSET | IOART_DESTPHY;
 472 #ifdef foo
 473         flags |= del_mode;
 474 #else
 475         /*
 476          * We only support limited I/O APIC mixed mode,
 477          * so even for ExtINT, we still use "fixed"
 478          * delivery mode.
 479          */
 480         flags |= IOART_DELFIXED;
 481 #endif
 482
 483         if (del_mode == IOART_DELEXINT) {
 484                 KKASSERT(trig == INTR_TRIGGER_CONFORM &&
 485                          pola == INTR_POLARITY_CONFORM);
 486                 flags |= IOART_TRGREDG | IOART_INTAHI;
 487         } else {
 488                 switch (trig) {
 489                 case INTR_TRIGGER_EDGE:
 490                         flags |= IOART_TRGREDG;
 491                         break;
 492
 493                 case INTR_TRIGGER_LEVEL:
 494                         flags |= IOART_TRGRLVL;
 495                         break;
 496
 497                 case INTR_TRIGGER_CONFORM:
 498                         panic("ioapic_pin_prog: trig conform is not "
 499                               "supported\n");
 500                 }
 501                 switch (pola) {
 502                 case INTR_POLARITY_HIGH:
 503                         flags |= IOART_INTAHI;
 504                         break;
 505
 506                 case INTR_POLARITY_LOW:
 507                         flags |= IOART_INTALO;
 508                         break;
 509
 510                 case INTR_POLARITY_CONFORM:
 511                         panic("ioapic_pin_prog: pola conform is not "
 512                               "supported\n");
 513                 }
 514         }
 515
 516         target = ioapic_read(addr, select + 1) & IOART_HI_DEST_RESV;
 517         target |= (CPUID_TO_APICID(0) << IOART_HI_DEST_SHIFT) &
 518                   IOART_HI_DEST_MASK;
 519
 520         ioapic_write(addr, select, flags | vec);
 521         ioapic_write(addr, select + 1, target);
 522 }
 523
 524 static void
 525 ioapic_setup(const struct ioapic_info *info)
 526 {
 527         int i;
 528
 529         ioapic_set_apic_id(info);
 530
 531         for (i = 0; i < info->io_npin; ++i)
 532                 ioapic_gsi_setup(info->io_gsi_base + i);
 533 }
 534
 535 static int
 536 ioapic_alloc_apic_id(int start)
 537 {
 538         for (;;) {
 539                 const struct ioapic_info *info;
 540                 int apic_id, apic_id16;
 541
 542                 apic_id = lapic_unused_apic_id(start);
 543                 if (apic_id == NAPICID) {
 544                         kprintf("IOAPIC: can't find unused APIC ID\n");
 545                         return apic_id;
 546                 }
 547                 apic_id16 = apic_id & IOAPIC_ID_MASK;
 548
 549                 /*
 550                  * Check against other I/O APIC's APIC ID's lower 4bits.
 551                  *
 552                  * The new APIC ID will have to be different from others
 553                  * in the lower 4bits, no matter whether xAPIC is used
 554                  * or not.
 555                  */
 556                 TAILQ_FOREACH(info, &ioapic_conf.ioc_list, io_link) {
 557                         if (info->io_apic_id == -1) {
 558                                 info = NULL;
 559                                 break;
 560                         }
 561                         if ((info->io_apic_id & IOAPIC_ID_MASK) == apic_id16)
 562                                 break;
 563                 }
 564                 if (info == NULL)
 565                         return apic_id;
 566
 567                 kprintf("IOAPIC: APIC ID %d has same lower 4bits as "
 568                         "%dth I/O APIC, keep searching...\n",
 569                         apic_id, info->io_idx);
 570
 571                 start = apic_id + 1;
 572         }
 573         panic("ioapic_unused_apic_id: never reached\n");
 574 }
 575
 576 void *
 577 ioapic_map(vm_paddr_t pa)
 578 {
 579         KKASSERT(pa < 0x100000000LL);
 580         return pmap_mapdev_uncacheable(pa, PAGE_SIZE);
 581 }