1# Copyright (c) 2015-2016 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# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Andreas Sandberg
37#          Glenn Bergmans
38
39from m5.SimObject import SimObject
40from m5.params import *
41from m5.proxy import *
42from m5.objects.Device import PioDevice
43from m5.objects.Platform import Platform
44
45class PciHost(PioDevice):
46    type = 'PciHost'
47    cxx_class = 'PciHost'
48    cxx_header = "dev/pci/host.hh"
49    abstract = True
50
51class GenericPciHost(PciHost):
52    type = 'GenericPciHost'
53    cxx_class = 'GenericPciHost'
54    cxx_header = "dev/pci/host.hh"
55
56    platform = Param.Platform(Parent.any, "Platform to use for interrupts")
57
58    conf_base = Param.Addr("Config space base address")
59    conf_size = Param.Addr("Config space base address")
60    conf_device_bits = Param.UInt8(8, "Number of bits used to as an "
61                                      "offset a devices address space")
62
63    pci_pio_base = Param.Addr(0, "Base address for PCI IO accesses")
64    pci_mem_base = Param.Addr(0, "Base address for PCI memory accesses")
65    pci_dma_base = Param.Addr(0, "Base address for DMA memory accesses")
66
67    def pciFdtAddr(self, bus=0, device=0, function=0, register=0, space=0,
68                   aliased=0, prefetchable=0, relocatable=0, addr=0):
69
70        busf = bus & 0xff
71        devicef = device & 0x1f
72        functionf = function & 0x7
73        registerf = register & 0xff
74        spacef = space & 0x3
75        aliasedf = aliased & 0x1
76        prefetchablef = prefetchable & 0x1
77        relocatablef = relocatable & 0x1
78
79        if  busf != bus or \
80            devicef != device or \
81            functionf != function or \
82            registerf != register or \
83            spacef != space or \
84            aliasedf != aliased or \
85            prefetchablef != prefetchable or \
86            relocatablef != relocatable:
87            fatal("One of the fields for the PCI address is out of bounds")
88
89        address = registerf | (functionf << 8) | (devicef << 11) | \
90                (busf << 16) | (spacef << 24) | (aliasedf << 29) | \
91                (prefetchablef << 30) | (relocatablef << 31)
92
93        low_addr = addr & 0xffffffff
94        high_addr = (addr >> 32) & 0xffffffff
95
96        return [address, high_addr, low_addr]
97