Gic.py revision 13996
19796Sprakash.ramrakhyani@arm.com# Copyright (c) 2012-2013, 2017-2019 ARM Limited 29796Sprakash.ramrakhyani@arm.com# All rights reserved. 39796Sprakash.ramrakhyani@arm.com# 49796Sprakash.ramrakhyani@arm.com# The license below extends only to copyright in the software and shall 59796Sprakash.ramrakhyani@arm.com# not be construed as granting a license to any other intellectual 69796Sprakash.ramrakhyani@arm.com# property including but not limited to intellectual property relating 79796Sprakash.ramrakhyani@arm.com# to a hardware implementation of the functionality of the software 89796Sprakash.ramrakhyani@arm.com# licensed hereunder. You may use the software subject to the license 99796Sprakash.ramrakhyani@arm.com# terms below provided that you ensure that this notice is replicated 109796Sprakash.ramrakhyani@arm.com# unmodified and in its entirety in all distributions of the software, 119796Sprakash.ramrakhyani@arm.com# modified or unmodified, in source code or in binary form. 129796Sprakash.ramrakhyani@arm.com# 139796Sprakash.ramrakhyani@arm.com# Redistribution and use in source and binary forms, with or without 149796Sprakash.ramrakhyani@arm.com# modification, are permitted provided that the following conditions are 159796Sprakash.ramrakhyani@arm.com# met: redistributions of source code must retain the above copyright 169796Sprakash.ramrakhyani@arm.com# notice, this list of conditions and the following disclaimer; 179796Sprakash.ramrakhyani@arm.com# redistributions in binary form must reproduce the above copyright 189796Sprakash.ramrakhyani@arm.com# notice, this list of conditions and the following disclaimer in the 199796Sprakash.ramrakhyani@arm.com# documentation and/or other materials provided with the distribution; 209796Sprakash.ramrakhyani@arm.com# neither the name of the copyright holders nor the names of its 219796Sprakash.ramrakhyani@arm.com# contributors may be used to endorse or promote products derived from 229796Sprakash.ramrakhyani@arm.com# this software without specific prior written permission. 239796Sprakash.ramrakhyani@arm.com# 249796Sprakash.ramrakhyani@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 259796Sprakash.ramrakhyani@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 269796Sprakash.ramrakhyani@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 279796Sprakash.ramrakhyani@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 289796Sprakash.ramrakhyani@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 299796Sprakash.ramrakhyani@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 309796Sprakash.ramrakhyani@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 319796Sprakash.ramrakhyani@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 329796Sprakash.ramrakhyani@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 339796Sprakash.ramrakhyani@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 349796Sprakash.ramrakhyani@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 359796Sprakash.ramrakhyani@arm.com# 369796Sprakash.ramrakhyani@arm.com# Authors: Andreas Sandberg 379796Sprakash.ramrakhyani@arm.com 389796Sprakash.ramrakhyani@arm.comfrom m5.params import * 399796Sprakash.ramrakhyani@arm.comfrom m5.proxy import * 409796Sprakash.ramrakhyani@arm.comfrom m5.util.fdthelper import * 419796Sprakash.ramrakhyani@arm.comfrom m5.SimObject import SimObject 429796Sprakash.ramrakhyani@arm.com 439796Sprakash.ramrakhyani@arm.comfrom m5.objects.Device import PioDevice, BasicPioDevice 449796Sprakash.ramrakhyani@arm.comfrom m5.objects.Platform import Platform 459796Sprakash.ramrakhyani@arm.com 469796Sprakash.ramrakhyani@arm.comclass BaseGic(PioDevice): 479796Sprakash.ramrakhyani@arm.com type = 'BaseGic' 489796Sprakash.ramrakhyani@arm.com abstract = True 499814Sandreas.hansson@arm.com cxx_header = "dev/arm/base_gic.hh" 509814Sandreas.hansson@arm.com 519796Sprakash.ramrakhyani@arm.com platform = Param.Platform(Parent.any, "Platform this device is part of.") 529796Sprakash.ramrakhyani@arm.com 539796Sprakash.ramrakhyani@arm.com gicd_iidr = Param.UInt32(0, 549796Sprakash.ramrakhyani@arm.com "Distributor Implementer Identification Register") 559796Sprakash.ramrakhyani@arm.com gicd_pidr = Param.UInt32(0, 5610263Satgutier@umich.edu "Peripheral Identification Register") 5710263Satgutier@umich.edu gicc_iidr = Param.UInt32(0, 5810263Satgutier@umich.edu "CPU Interface Identification Register") 5910263Satgutier@umich.edu gicv_iidr = Param.UInt32(0, 6010263Satgutier@umich.edu "VM CPU Interface Identification Register") 6110263Satgutier@umich.edu 6210263Satgutier@umich.educlass ArmInterruptPin(SimObject): 6310263Satgutier@umich.edu type = 'ArmInterruptPin' 6410263Satgutier@umich.edu cxx_header = "dev/arm/base_gic.hh" 659796Sprakash.ramrakhyani@arm.com cxx_class = "ArmInterruptPinGen" 669796Sprakash.ramrakhyani@arm.com abstract = True 679796Sprakash.ramrakhyani@arm.com 6810263Satgutier@umich.edu platform = Param.Platform(Parent.any, "Platform with interrupt controller") 6910263Satgutier@umich.edu num = Param.UInt32("Interrupt number in GIC") 7010263Satgutier@umich.edu 7110263Satgutier@umich.educlass ArmSPI(ArmInterruptPin): 7210263Satgutier@umich.edu type = 'ArmSPI' 739796Sprakash.ramrakhyani@arm.com cxx_header = "dev/arm/base_gic.hh" 749796Sprakash.ramrakhyani@arm.com cxx_class = "ArmSPIGen" 759796Sprakash.ramrakhyani@arm.com 769796Sprakash.ramrakhyani@arm.comclass ArmPPI(ArmInterruptPin): 779796Sprakash.ramrakhyani@arm.com type = 'ArmPPI' 78 cxx_header = "dev/arm/base_gic.hh" 79 cxx_class = "ArmPPIGen" 80 81class GicV2(BaseGic): 82 type = 'GicV2' 83 cxx_header = "dev/arm/gic_v2.hh" 84 85 dist_addr = Param.Addr("Address for distributor") 86 cpu_addr = Param.Addr("Address for cpu") 87 cpu_size = Param.Addr(0x2000, "Size of cpu register bank") 88 dist_pio_delay = Param.Latency('10ns', "Delay for PIO r/w to distributor") 89 cpu_pio_delay = Param.Latency('10ns', "Delay for PIO r/w to cpu interface") 90 int_latency = Param.Latency('10ns', "Delay for interrupt to get to CPU") 91 it_lines = Param.UInt32(128, "Number of interrupt lines supported (max = 1020)") 92 gem5_extensions = Param.Bool(False, "Enable gem5 extensions") 93 94class Gic400(GicV2): 95 """ 96 As defined in: 97 "ARM Generic Interrupt Controller Architecture" version 2.0 98 "CoreLink GIC-400 Generic Interrupt Controller" revision r0p1 99 """ 100 gicd_pidr = 0x002bb490 101 gicd_iidr = 0x0200143B 102 gicc_iidr = 0x0202143B 103 104 # gicv_iidr same as gicc_idr 105 gicv_iidr = gicc_iidr 106 107class Gicv2mFrame(SimObject): 108 type = 'Gicv2mFrame' 109 cxx_header = "dev/arm/gic_v2m.hh" 110 spi_base = Param.UInt32(0x0, "Frame SPI base number"); 111 spi_len = Param.UInt32(0x0, "Frame SPI total number"); 112 addr = Param.Addr("Address for frame PIO") 113 114class Gicv2m(PioDevice): 115 type = 'Gicv2m' 116 cxx_header = "dev/arm/gic_v2m.hh" 117 118 pio_delay = Param.Latency('10ns', "Delay for PIO r/w") 119 gic = Param.BaseGic(Parent.any, "Gic on which to trigger interrupts") 120 frames = VectorParam.Gicv2mFrame([], "Power of two number of frames") 121 122class VGic(PioDevice): 123 type = 'VGic' 124 cxx_header = "dev/arm/vgic.hh" 125 gic = Param.BaseGic(Parent.any, "Gic to use for interrupting") 126 platform = Param.Platform(Parent.any, "Platform this device is part of.") 127 vcpu_addr = Param.Addr(0, "Address for vcpu interfaces") 128 hv_addr = Param.Addr(0, "Address for hv control") 129 pio_delay = Param.Latency('10ns', "Delay for PIO r/w") 130 # The number of list registers is not currently configurable at runtime. 131 maint_int = Param.UInt32("HV maintenance interrupt number") 132 133 # gicv_iidr same as gicc_idr 134 gicv_iidr = Param.UInt32(Self.gic.gicc_iidr, 135 "VM CPU Interface Identification Register") 136 137 def generateDeviceTree(self, state): 138 gic = self.gic.unproxy(self) 139 140 node = FdtNode("interrupt-controller") 141 node.appendCompatible(["gem5,gic", "arm,cortex-a15-gic", 142 "arm,cortex-a9-gic"]) 143 node.append(FdtPropertyWords("#interrupt-cells", [3])) 144 node.append(FdtPropertyWords("#address-cells", [0])) 145 node.append(FdtProperty("interrupt-controller")) 146 147 regs = ( 148 state.addrCells(gic.dist_addr) + 149 state.sizeCells(0x1000) + 150 state.addrCells(gic.cpu_addr) + 151 state.sizeCells(0x1000) + 152 state.addrCells(self.hv_addr) + 153 state.sizeCells(0x2000) + 154 state.addrCells(self.vcpu_addr) + 155 state.sizeCells(0x2000) ) 156 157 node.append(FdtPropertyWords("reg", regs)) 158 node.append(FdtPropertyWords("interrupts", 159 [1, int(self.maint_int)-16, 0xf04])) 160 161 node.appendPhandle(gic) 162 163 yield node 164 165class Gicv3Its(BasicPioDevice): 166 type = 'Gicv3Its' 167 cxx_header = "dev/arm/gic_v3_its.hh" 168 169 dma = MasterPort("DMA port") 170 pio_size = Param.Unsigned(0x20000, "Gicv3Its pio size") 171 172 # CIL [36] = 0: ITS supports 16-bit CollectionID 173 # Devbits [17:13] = 0b100011: ITS supports 23 DeviceID bits 174 # ID_bits [12:8] = 0b11111: ITS supports 31 EventID bits 175 gits_typer = Param.UInt64(0x30023F01, "GITS_TYPER RO value") 176 177class Gicv3(BaseGic): 178 type = 'Gicv3' 179 cxx_header = "dev/arm/gic_v3.hh" 180 181 its = Param.Gicv3Its(Gicv3Its(), "GICv3 Interrupt Translation Service") 182 183 dist_addr = Param.Addr("Address for distributor") 184 dist_pio_delay = Param.Latency('10ns', "Delay for PIO r/w to distributor") 185 redist_addr = Param.Addr("Address for redistributors") 186 redist_pio_delay = Param.Latency('10ns', 187 "Delay for PIO r/w to redistributors") 188 it_lines = Param.UInt32(1020, 189 "Number of interrupt lines supported (max = 1020)") 190 191 maint_int = Param.ArmInterruptPin( 192 "HV maintenance interrupt." 193 "ARM strongly recommends that maintenance interrupts " 194 "are configured to use INTID 25 (PPI Interrupt).") 195 196 cpu_max = Param.Unsigned(256, 197 "Maximum number of PE. This is affecting the maximum number of " 198 "redistributors") 199 200 gicv4 = Param.Bool(True, "GICv4 extension available") 201