SouthBridge.py revision 5831:ee307cca6d31 
1# Copyright (c) 2008 The Regents of The University of Michigan
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Gabe Black
28
29from m5.params import *
30from m5.proxy import *
31from Cmos import Cmos
32from I8042 import I8042
33from I82094AA import I82094AA
34from I8237 import I8237
35from I8254 import I8254
36from I8259 import I8259
37from PcSpeaker import PcSpeaker
38from X86IntPin import X86IntLine
39from m5.SimObject import SimObject
40
41def x86IOAddress(port):
42    IO_address_space_base = 0x8000000000000000
43    return IO_address_space_base + port;
44
45class SouthBridge(SimObject):
46    type = 'SouthBridge'
47    pio_latency = Param.Latency('1ns', "Programmed IO latency in simticks")
48    platform = Param.Platform(Parent.any, "Platform this device is part of")
49
50    _pic1 = I8259(pio_addr=x86IOAddress(0x20), mode='I8259Master')
51    _pic2 = I8259(pio_addr=x86IOAddress(0xA0), mode='I8259Slave')
52    _cmos = Cmos(pio_addr=x86IOAddress(0x70))
53    _dma1 = I8237(pio_addr=x86IOAddress(0x0))
54    _keyboard = I8042(data_port=x86IOAddress(0x60), \
55            command_port=x86IOAddress(0x64))
56    _pit = I8254(pio_addr=x86IOAddress(0x40))
57    _speaker = PcSpeaker(pio_addr=x86IOAddress(0x61))
58    _io_apic = I82094AA(pio_addr=0xFEC00000)
59    # This is to make sure the interrupt lines are instantiated. Don't use
60    # it for anything directly.
61    int_lines = VectorParam.X86IntLine([], "Interrupt lines")
62
63    pic1 = Param.I8259(_pic1, "Master PIC")
64    pic2 = Param.I8259(_pic2, "Slave PIC")
65    cmos = Param.Cmos(_cmos, "CMOS memory and real time clock device")
66    dma1 = Param.I8237(_dma1, "The first dma controller")
67    keyboard = Param.I8042(_keyboard, "The keyboard controller")
68    pit = Param.I8254(_pit, "Programmable interval timer")
69    speaker = Param.PcSpeaker(_speaker, "PC speaker")
70    io_apic = Param.I82094AA(_io_apic, "I/O APIC")
71
72    def connectPins(self, source, sink):
73        self.int_lines.append(X86IntLine(source=source, sink=sink))
74
75    def attachIO(self, bus):
76        # Route interupt signals
77        self.connectPins(self.pic1.output, self.io_apic.pin(0))
78        self.connectPins(self.pic2.output, self.pic1.pin(2))
79        self.connectPins(self.cmos.int_pin, self.pic2.pin(0))
80        self.connectPins(self.pit.int_pin, self.pic1.pin(0))
81        self.connectPins(self.pit.int_pin, self.io_apic.pin(2))
82#        self.connectPins(self.keyboard.keyboard_int_pin,
83#                         self.pic1.pin(1))
84        self.connectPins(self.keyboard.keyboard_int_pin,
85                         self.io_apic.pin(1))
86#        self.connectPins(self.keyboard.mouse_int_pin,
87#                         self.pic2.pin(4))
88        self.connectPins(self.keyboard.mouse_int_pin,
89                         self.io_apic.pin(12))
90        # Tell the devices about each other
91        self.pic1.slave = self.pic2
92        self.speaker.i8254 = self.pit
93        self.io_apic.external_int_pic = self.pic1
94        # Connect to the bus
95        self.cmos.pio = bus.port
96        self.dma1.pio = bus.port
97        self.keyboard.pio = bus.port
98        self.pic1.pio = bus.port
99        self.pic2.pio = bus.port
100        self.pit.pio = bus.port
101        self.speaker.pio = bus.port
102        self.io_apic.pio = bus.port
103        self.io_apic.int_port = bus.port
104