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 <map>
  35
  36 #include "base/bitunion.hh"
  37 #include "dev/x86/intdev.hh"
  38 #include "dev/intpin.hh"
  39 #include "dev/io_device.hh"
  40 #include "params/I82094AA.hh"
  41
  42 namespace X86ISA
  43 {
  44
  45 class I8259;
  46 class Interrupts;
  47
  48 class I82094AA : public BasicPioDevice, public IntDevice
  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     I8259 * extIntPic;
  69
  70     uint8_t regSel;
  71     uint8_t initialApicId;
  72     uint8_t id;
  73     uint8_t arbId;
  74
  75     uint64_t lowestPriorityOffset;
  76
  77     static const uint8_t TableSize = 24;
  78     // This implementation is based on version 0x11, but 0x14 avoids having
  79     // to deal with the arbitration and APIC bus guck.
  80     static const uint8_t APICVersion = 0x14;
  81
  82     RedirTableEntry redirTable[TableSize];
  83     bool pinStates[TableSize];
  84
  85     std::vector<IntSinkPin<I82094AA> *> inputs;
  86
  87   public:
  88     typedef I82094AAParams Params;
  89
  90     const Params *
  91     params() const
  92     {
  93         return dynamic_cast<const Params *>(_params);
  94     }
  95
  96     I82094AA(Params *p);
  97
  98     void init() override;
  99
 100     Tick read(PacketPtr pkt) override;
 101     Tick write(PacketPtr pkt) override;
 102
 103     void writeReg(uint8_t offset, uint32_t value);
 104     uint32_t readReg(uint8_t offset);
 105
 106     Port &getPort(const std::string &if_name,
 107                   PortID idx=InvalidPortID) override;
 108
 109     bool recvResponse(PacketPtr pkt) override;
 110
 111     void signalInterrupt(int line);
 112     void raiseInterruptPin(int number);
 113     void lowerInterruptPin(int number);
 114
 115     void serialize(CheckpointOut &cp) const override;
 116     void unserialize(CheckpointIn &cp) override;
 117 };
 118
 119 } // namespace X86ISA
 120
 121 #endif //__DEV_X86_SOUTH_BRIDGE_I8254_HH__