src/dev/x86/i82094aa.hh

   1 /*
   2  * Copyright (c) 2008 The Regents of The University of Michigan
   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 are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * 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  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Gabe Black
  29  */
  30
  31 #ifndef __DEV_X86_I82094AA_HH__
  32 #define __DEV_X86_I82094AA_HH__
  33
  34 #include "base/bitunion.hh"
  35 #include "base/range_map.hh"
  36 #include "dev/io_device.hh"
  37 #include "dev/x86/intdev.hh"
  38 #include "params/I82094AA.hh"
  39
  40 #include <map>
  41
  42 namespace X86ISA
  43 {
  44
  45 class I8259;
  46 class Interrupts;
  47
  48 class I82094AA : public PioDevice, public IntDev
  49 {
  50   public:
  51     BitUnion64(RedirTableEntry)
  52         Bitfield<63, 32> topDW;
  53         Bitfield<55, 32> topReserved;
  54         Bitfield<31, 0> bottomDW;
  55         Bitfield<31, 17> bottomReserved;
  56         Bitfield<63, 56> dest;
  57         Bitfield<16> mask;
  58         Bitfield<15> trigger;
  59         Bitfield<14> remoteIRR;
  60         Bitfield<13> polarity;
  61         Bitfield<12> deliveryStatus;
  62         Bitfield<11> destMode;
  63         Bitfield<10, 8> deliveryMode;
  64         Bitfield<7, 0> vector;
  65     EndBitUnion(RedirTableEntry)
  66
  67   protected:
  68     Tick latency;
  69     Addr pioAddr;
  70
  71     I8259 * extIntPic;
  72
  73     std::map<int, Interrupts *> localApics;
  74
  75     uint8_t regSel;
  76     uint8_t initialApicId;
  77     uint8_t id;
  78     uint8_t arbId;
  79
  80     uint64_t lowestPriorityOffset;
  81
  82     static const uint8_t TableSize = 24;
  83     // This implementation is based on version 0x11, but 0x14 avoids having
  84     // to deal with the arbitration and APIC bus guck.
  85     static const uint8_t APICVersion = 0x14;
  86
  87     RedirTableEntry redirTable[TableSize];
  88     bool pinStates[TableSize];
  89
  90   public:
  91     typedef I82094AAParams Params;
  92
  93     const Params *
  94     params() const
  95     {
  96         return dynamic_cast<const Params *>(_params);
  97     }
  98
  99     I82094AA(Params *p);
 100
 101     Tick read(PacketPtr pkt);
 102     Tick write(PacketPtr pkt);
 103
 104     void addressRanges(AddrRangeList &range_list)
 105     {
 106         range_list.clear();
 107         range_list.push_back(RangeEx(pioAddr, pioAddr + 4));
 108         range_list.push_back(RangeEx(pioAddr + 16, pioAddr + 20));
 109     }
 110
 111     void getIntAddrRange(AddrRangeList &range_list)
 112     {
 113         range_list.clear();
 114         range_list.push_back(RangeEx(x86InterruptAddress(initialApicId, 0),
 115                     x86InterruptAddress(initialApicId, 0) +
 116                     PhysAddrAPICRangeSize));
 117     }
 118
 119     void writeReg(uint8_t offset, uint32_t value);
 120     uint32_t readReg(uint8_t offset);
 121
 122     Port *getPort(const std::string &if_name, int idx = -1)
 123     {
 124         if (if_name == "int_port")
 125             return intPort;
 126         return PioDevice::getPort(if_name, idx);
 127     }
 128
 129     void signalInterrupt(int line);
 130     void raiseInterruptPin(int number);
 131     void lowerInterruptPin(int number);
 132     void registerLocalApic(int id, Interrupts *localApic);
 133 };
 134
 135 }; // namespace X86ISA
 136
 137 #endif //__DEV_X86_SOUTH_BRIDGE_I8254_HH__