src/arch/x86/X86LocalApic.py

   1 # Copyright (c) 2012 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Copyright (c) 2008 The Regents of The University of Michigan
  14 # All rights reserved.
  15 #
  16 # Redistribution and use in source and binary forms, with or without
  17 # modification, are permitted provided that the following conditions are
  18 # met: redistributions of source code must retain the above copyright
  19 # notice, this list of conditions and the following disclaimer;
  20 # redistributions in binary form must reproduce the above copyright
  21 # notice, this list of conditions and the following disclaimer in the
  22 # documentation and/or other materials provided with the distribution;
  23 # neither the name of the copyright holders nor the names of its
  24 # contributors may be used to endorse or promote products derived from
  25 # this software without specific prior written permission.
  26 #
  27 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38 #
  39 # Authors: Gabe Black
  40
  41 from m5.defines import buildEnv
  42 from m5.params import *
  43 from m5.proxy import *
  44
  45 from m5.objects.BaseInterrupts import BaseInterrupts
  46 from m5.objects.ClockDomain import DerivedClockDomain
  47 from m5.SimObject import SimObject
  48
  49 class X86LocalApic(BaseInterrupts):
  50     type = 'X86LocalApic'
  51     cxx_class = 'X86ISA::Interrupts'
  52     cxx_header = 'arch/x86/interrupts.hh'
  53     int_master = MasterPort("Port for sending interrupt messages")
  54     int_slave = SlavePort("Port for receiving interrupt messages")
  55     int_latency = Param.Latency('1ns', \
  56             "Latency for an interrupt to propagate through this device.")
  57     pio = SlavePort("Programmed I/O port")
  58     system = Param.System(Parent.any, "System this device is part of")
  59
  60     pio_latency = Param.Latency('100ns', 'Programmed IO latency')
  61
  62     # The clock rate for the local APIC timer is supposed to be the "bus clock"
  63     # which we assume is 1/16th the rate of the CPU clock. I don't think this
  64     # is a hard rule, but seems to be true in practice. This can be overriden
  65     # in configs that use it.
  66     clk_domain = Param.DerivedClockDomain(
  67             DerivedClockDomain(clk_domain=Parent.clk_domain, clk_divider=16),
  68             "The clock for the local APIC. Should not be modified.")