IntPin.py revision 14270 
1# Copyright 2019 Google, Inc.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met: redistributions of source code must retain the above copyright
6# notice, this list of conditions and the following disclaimer;
7# redistributions in binary form must reproduce the above copyright
8# notice, this list of conditions and the following disclaimer in the
9# documentation and/or other materials provided with the distribution;
10# neither the name of the copyright holders nor the names of its
11# contributors may be used to endorse or promote products derived from
12# this software without specific prior written permission.
13#
14# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25#
26# Authors: Gabe Black
27
28from m5.params import Port, VectorPort
29
30INT_SOURCE_ROLE = 'Int Source Pin'
31INT_SINK_ROLE = 'Int Sink Pin'
32Port.compat(INT_SOURCE_ROLE, INT_SINK_ROLE)
33
34# A source pin generally represents a single pin which might connect to
35# multiple sinks.
36class IntSourcePin(VectorPort):
37    def __init__(self, desc):
38        super(IntSourcePin, self).__init__(
39                INT_SOURCE_ROLE, desc, is_source=True)
40
41# Each "physical" pin can be driven by a single source pin since there are no
42# provisions for resolving competing signals running to the same pin.
43class IntSinkPin(Port):
44    def __init__(self, desc):
45        super(IntSinkPin, self).__init__(INT_SINK_ROLE, desc)
46
47# A vector of sink pins represents a bank of physical pins. For instance, an
48# interrupt controller with many numbered input interrupts could represent them
49# as a VectorIntSinkPin.
50class VectorIntSinkPin(VectorPort):
51    def __init__(self, desc):
52        super(VectorIntSinkPin, self).__init__(INT_SINK_ROLE, desc)
53