RealView.py revision 9707:1305bec2733f
1# Copyright (c) 2009-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) 2006-2007 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: Ali Saidi
40#          Gabe Black
41#          William Wang
42
43from m5.params import *
44from m5.proxy import *
45from Device import BasicPioDevice, PioDevice, IsaFake, BadAddr, DmaDevice
46from Pci import PciConfigAll
47from Ethernet import NSGigE, IGbE_e1000, IGbE_igb
48from Ide import *
49from Platform import Platform
50from Terminal import Terminal
51from Uart import Uart
52from SimpleMemory import SimpleMemory
53from Gic import *
54
55class AmbaDevice(BasicPioDevice):
56    type = 'AmbaDevice'
57    abstract = True
58    cxx_header = "dev/arm/amba_device.hh"
59    amba_id = Param.UInt32("ID of AMBA device for kernel detection")
60
61class AmbaIntDevice(AmbaDevice):
62    type = 'AmbaIntDevice'
63    abstract = True
64    cxx_header = "dev/arm/amba_device.hh"
65    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
66    int_num = Param.UInt32("Interrupt number that connects to GIC")
67    int_delay = Param.Latency("100ns",
68            "Time between action and interrupt generation by device")
69
70class AmbaDmaDevice(DmaDevice):
71    type = 'AmbaDmaDevice'
72    abstract = True
73    cxx_header = "dev/arm/amba_device.hh"
74    pio_addr = Param.Addr("Address for AMBA slave interface")
75    pio_latency = Param.Latency("10ns", "Time between action and write/read result by AMBA DMA Device")
76    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
77    int_num = Param.UInt32("Interrupt number that connects to GIC")
78    amba_id = Param.UInt32("ID of AMBA device for kernel detection")
79
80class A9SCU(BasicPioDevice):
81    type = 'A9SCU'
82    cxx_header = "dev/arm/a9scu.hh"
83
84class RealViewCtrl(BasicPioDevice):
85    type = 'RealViewCtrl'
86    cxx_header = "dev/arm/rv_ctrl.hh"
87    proc_id0 = Param.UInt32(0x0C000000, "Processor ID, SYS_PROCID")
88    proc_id1 = Param.UInt32(0x0C000222, "Processor ID, SYS_PROCID1")
89    idreg = Param.UInt32(0x00000000, "ID Register, SYS_ID")
90
91class AmbaFake(AmbaDevice):
92    type = 'AmbaFake'
93    cxx_header = "dev/arm/amba_fake.hh"
94    ignore_access = Param.Bool(False, "Ignore reads/writes to this device, (e.g. IsaFake + AMBA)")
95    amba_id = 0;
96
97class Pl011(Uart):
98    type = 'Pl011'
99    cxx_header = "dev/arm/pl011.hh"
100    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
101    int_num = Param.UInt32("Interrupt number that connects to GIC")
102    end_on_eot = Param.Bool(False, "End the simulation when a EOT is received on the UART")
103    int_delay = Param.Latency("100ns", "Time between action and interrupt generation by UART")
104
105class Sp804(AmbaDevice):
106    type = 'Sp804'
107    cxx_header = "dev/arm/timer_sp804.hh"
108    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
109    int_num0 = Param.UInt32("Interrupt number that connects to GIC")
110    clock0 = Param.Clock('1MHz', "Clock speed of the input")
111    int_num1 = Param.UInt32("Interrupt number that connects to GIC")
112    clock1 = Param.Clock('1MHz', "Clock speed of the input")
113    amba_id = 0x00141804
114
115class CpuLocalTimer(BasicPioDevice):
116    type = 'CpuLocalTimer'
117    cxx_header = "dev/arm/timer_cpulocal.hh"
118    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
119    int_num_timer = Param.UInt32("Interrrupt number used per-cpu to GIC")
120    int_num_watchdog = Param.UInt32("Interrupt number for per-cpu watchdog to GIC")
121    # Override the default clock
122    clock = '1GHz'
123
124class PL031(AmbaIntDevice):
125    type = 'PL031'
126    cxx_header = "dev/arm/rtc_pl031.hh"
127    time = Param.Time('01/01/2009', "System time to use ('Now' for actual time)")
128    amba_id = 0x00341031
129
130class Pl050(AmbaIntDevice):
131    type = 'Pl050'
132    cxx_header = "dev/arm/kmi.hh"
133    vnc = Param.VncInput(Parent.any, "Vnc server for remote frame buffer display")
134    is_mouse = Param.Bool(False, "Is this interface a mouse, if not a keyboard")
135    int_delay = '1us'
136    amba_id = 0x00141050
137
138class Pl111(AmbaDmaDevice):
139    type = 'Pl111'
140    cxx_header = "dev/arm/pl111.hh"
141    pixel_clock = Param.Clock('24MHz', "Pixel clock")
142    vnc   = Param.VncInput(Parent.any, "Vnc server for remote frame buffer display")
143    amba_id = 0x00141111
144
145class HDLcd(AmbaDmaDevice):
146    type = 'HDLcd'
147    cxx_header = "dev/arm/hdlcd.hh"
148    pixel_clock = Param.Clock('65MHz', "Clock frequency of the pixel clock "
149                                       "(i.e. PXLREFCLK / OSCCLK 5; 23.75MHz "
150                                       "default up to 165MHz)")
151    vnc = Param.VncInput(Parent.any, "Vnc server for remote frame buffer "
152                                     "display")
153    amba_id = 0x00141000
154
155class RealView(Platform):
156    type = 'RealView'
157    cxx_header = "dev/arm/realview.hh"
158    system = Param.System(Parent.any, "system")
159    pci_cfg_base = Param.Addr(0, "Base address of PCI Configuraiton Space")
160    mem_start_addr = Param.Addr(0, "Start address of main memory")
161    max_mem_size = Param.Addr('256MB', "Maximum amount of RAM supported by platform")
162
163    def setupBootLoader(self, mem_bus, cur_sys, loc):
164        self.nvmem = SimpleMemory(range = AddrRange(Addr('2GB'),
165                                                    size = '64MB'))
166        self.nvmem.port = mem_bus.master
167        cur_sys.boot_loader = loc('boot.arm')
168
169
170# Reference for memory map and interrupt number
171# RealView Platform Baseboard Explore for Cortex-A9 User Guide(ARM DUI 0440A)
172# Chapter 4: Programmer's Reference
173class RealViewPBX(RealView):
174    uart = Pl011(pio_addr=0x10009000, int_num=44)
175    realview_io = RealViewCtrl(pio_addr=0x10000000)
176    gic = Pl390()
177    timer0 = Sp804(int_num0=36, int_num1=36, pio_addr=0x10011000)
178    timer1 = Sp804(int_num0=37, int_num1=37, pio_addr=0x10012000)
179    local_cpu_timer = CpuLocalTimer(int_num_timer=29, int_num_watchdog=30, pio_addr=0x1f000600)
180    clcd = Pl111(pio_addr=0x10020000, int_num=55)
181    kmi0   = Pl050(pio_addr=0x10006000, int_num=52)
182    kmi1   = Pl050(pio_addr=0x10007000, int_num=53, is_mouse=True)
183    a9scu  = A9SCU(pio_addr=0x1f000000)
184    cf_ctrl = IdeController(disks=[], pci_func=0, pci_dev=7, pci_bus=2,
185                            io_shift = 1, ctrl_offset = 2, Command = 0x1,
186                            BAR0 = 0x18000000, BAR0Size = '16B',
187                            BAR1 = 0x18000100, BAR1Size = '1B',
188                            BAR0LegacyIO = True, BAR1LegacyIO = True)
189
190
191    l2x0_fake     = IsaFake(pio_addr=0x1f002000, pio_size=0xfff)
192    flash_fake    = IsaFake(pio_addr=0x40000000, pio_size=0x20000000,
193                            fake_mem=True)
194    dmac_fake     = AmbaFake(pio_addr=0x10030000)
195    uart1_fake    = AmbaFake(pio_addr=0x1000a000)
196    uart2_fake    = AmbaFake(pio_addr=0x1000b000)
197    uart3_fake    = AmbaFake(pio_addr=0x1000c000)
198    smc_fake      = AmbaFake(pio_addr=0x100e1000)
199    sp810_fake    = AmbaFake(pio_addr=0x10001000, ignore_access=True)
200    watchdog_fake = AmbaFake(pio_addr=0x10010000)
201    gpio0_fake    = AmbaFake(pio_addr=0x10013000)
202    gpio1_fake    = AmbaFake(pio_addr=0x10014000)
203    gpio2_fake    = AmbaFake(pio_addr=0x10015000)
204    ssp_fake      = AmbaFake(pio_addr=0x1000d000)
205    sci_fake      = AmbaFake(pio_addr=0x1000e000)
206    aaci_fake     = AmbaFake(pio_addr=0x10004000)
207    mmc_fake      = AmbaFake(pio_addr=0x10005000)
208    rtc           = PL031(pio_addr=0x10017000, int_num=42)
209
210
211    # Attach I/O devices that are on chip and also set the appropriate
212    # ranges for the bridge
213    def attachOnChipIO(self, bus, bridge):
214       self.gic.pio = bus.master
215       self.l2x0_fake.pio = bus.master
216       self.a9scu.pio = bus.master
217       self.local_cpu_timer.pio = bus.master
218       # Bridge ranges based on excluding what is part of on-chip I/O
219       # (gic, l2x0, a9scu, local_cpu_timer)
220       bridge.ranges = [AddrRange(self.realview_io.pio_addr,
221                                  self.a9scu.pio_addr - 1),
222                        AddrRange(self.flash_fake.pio_addr,
223                                  self.flash_fake.pio_addr + \
224                                  self.flash_fake.pio_size - 1)]
225
226    # Attach I/O devices to specified bus object.  Can't do this
227    # earlier, since the bus object itself is typically defined at the
228    # System level.
229    def attachIO(self, bus):
230       self.uart.pio          = bus.master
231       self.realview_io.pio   = bus.master
232       self.timer0.pio        = bus.master
233       self.timer1.pio        = bus.master
234       self.clcd.pio          = bus.master
235       self.clcd.dma          = bus.slave
236       self.kmi0.pio          = bus.master
237       self.kmi1.pio          = bus.master
238       self.cf_ctrl.pio       = bus.master
239       self.cf_ctrl.config    = bus.master
240       self.cf_ctrl.dma       = bus.slave
241       self.dmac_fake.pio     = bus.master
242       self.uart1_fake.pio    = bus.master
243       self.uart2_fake.pio    = bus.master
244       self.uart3_fake.pio    = bus.master
245       self.smc_fake.pio      = bus.master
246       self.sp810_fake.pio    = bus.master
247       self.watchdog_fake.pio = bus.master
248       self.gpio0_fake.pio    = bus.master
249       self.gpio1_fake.pio    = bus.master
250       self.gpio2_fake.pio    = bus.master
251       self.ssp_fake.pio      = bus.master
252       self.sci_fake.pio      = bus.master
253       self.aaci_fake.pio     = bus.master
254       self.mmc_fake.pio      = bus.master
255       self.rtc.pio           = bus.master
256       self.flash_fake.pio    = bus.master
257
258# Reference for memory map and interrupt number
259# RealView Emulation Baseboard User Guide (ARM DUI 0143B)
260# Chapter 4: Programmer's Reference
261class RealViewEB(RealView):
262    uart = Pl011(pio_addr=0x10009000, int_num=44)
263    realview_io = RealViewCtrl(pio_addr=0x10000000)
264    gic = Pl390(dist_addr=0x10041000, cpu_addr=0x10040000)
265    timer0 = Sp804(int_num0=36, int_num1=36, pio_addr=0x10011000)
266    timer1 = Sp804(int_num0=37, int_num1=37, pio_addr=0x10012000)
267    clcd   = Pl111(pio_addr=0x10020000, int_num=23)
268    kmi0   = Pl050(pio_addr=0x10006000, int_num=20)
269    kmi1   = Pl050(pio_addr=0x10007000, int_num=21, is_mouse=True)
270
271    l2x0_fake     = IsaFake(pio_addr=0x1f002000, pio_size=0xfff, warn_access="1")
272    flash_fake    = IsaFake(pio_addr=0x40000000, pio_size=0x20000000-1,
273                            fake_mem=True)
274    dmac_fake     = AmbaFake(pio_addr=0x10030000)
275    uart1_fake    = AmbaFake(pio_addr=0x1000a000)
276    uart2_fake    = AmbaFake(pio_addr=0x1000b000)
277    uart3_fake    = AmbaFake(pio_addr=0x1000c000)
278    smcreg_fake   = IsaFake(pio_addr=0x10080000, pio_size=0x10000-1)
279    smc_fake      = AmbaFake(pio_addr=0x100e1000)
280    sp810_fake    = AmbaFake(pio_addr=0x10001000, ignore_access=True)
281    watchdog_fake = AmbaFake(pio_addr=0x10010000)
282    gpio0_fake    = AmbaFake(pio_addr=0x10013000)
283    gpio1_fake    = AmbaFake(pio_addr=0x10014000)
284    gpio2_fake    = AmbaFake(pio_addr=0x10015000)
285    ssp_fake      = AmbaFake(pio_addr=0x1000d000)
286    sci_fake      = AmbaFake(pio_addr=0x1000e000)
287    aaci_fake     = AmbaFake(pio_addr=0x10004000)
288    mmc_fake      = AmbaFake(pio_addr=0x10005000)
289    rtc_fake      = AmbaFake(pio_addr=0x10017000, amba_id=0x41031)
290
291
292
293    # Attach I/O devices that are on chip and also set the appropriate
294    # ranges for the bridge
295    def attachOnChipIO(self, bus, bridge):
296       self.gic.pio = bus.master
297       self.l2x0_fake.pio = bus.master
298       # Bridge ranges based on excluding what is part of on-chip I/O
299       # (gic, l2x0)
300       bridge.ranges = [AddrRange(self.realview_io.pio_addr,
301                                  self.gic.cpu_addr - 1),
302                        AddrRange(self.flash_fake.pio_addr, Addr.max)]
303
304    # Attach I/O devices to specified bus object.  Can't do this
305    # earlier, since the bus object itself is typically defined at the
306    # System level.
307    def attachIO(self, bus):
308       self.uart.pio          = bus.master
309       self.realview_io.pio   = bus.master
310       self.timer0.pio        = bus.master
311       self.timer1.pio        = bus.master
312       self.clcd.pio          = bus.master
313       self.clcd.dma          = bus.slave
314       self.kmi0.pio          = bus.master
315       self.kmi1.pio          = bus.master
316       self.dmac_fake.pio     = bus.master
317       self.uart1_fake.pio    = bus.master
318       self.uart2_fake.pio    = bus.master
319       self.uart3_fake.pio    = bus.master
320       self.smc_fake.pio      = bus.master
321       self.sp810_fake.pio    = bus.master
322       self.watchdog_fake.pio = bus.master
323       self.gpio0_fake.pio    = bus.master
324       self.gpio1_fake.pio    = bus.master
325       self.gpio2_fake.pio    = bus.master
326       self.ssp_fake.pio      = bus.master
327       self.sci_fake.pio      = bus.master
328       self.aaci_fake.pio     = bus.master
329       self.mmc_fake.pio      = bus.master
330       self.rtc_fake.pio      = bus.master
331       self.flash_fake.pio    = bus.master
332       self.smcreg_fake.pio   = bus.master
333
334class VExpress_EMM(RealView):
335    mem_start_addr = '2GB'
336    max_mem_size = '2GB'
337    pci_cfg_base = 0x30000000
338    uart = Pl011(pio_addr=0x1c090000, int_num=37)
339    realview_io = RealViewCtrl(proc_id0=0x14000000, proc_id1=0x14000000, pio_addr=0x1C010000)
340    gic = Pl390(dist_addr=0x2C001000, cpu_addr=0x2C002000)
341    local_cpu_timer = CpuLocalTimer(int_num_timer=29, int_num_watchdog=30, pio_addr=0x2C080000)
342    timer0 = Sp804(int_num0=34, int_num1=34, pio_addr=0x1C110000, clock0='1MHz', clock1='1MHz')
343    timer1 = Sp804(int_num0=35, int_num1=35, pio_addr=0x1C120000, clock0='1MHz', clock1='1MHz')
344    clcd   = Pl111(pio_addr=0x1c1f0000, int_num=46)
345    hdlcd  = HDLcd(pio_addr=0x2b000000, int_num=117)
346    kmi0   = Pl050(pio_addr=0x1c060000, int_num=44)
347    kmi1   = Pl050(pio_addr=0x1c070000, int_num=45, is_mouse=True)
348    cf_ctrl = IdeController(disks=[], pci_func=0, pci_dev=0, pci_bus=2,
349                            io_shift = 2, ctrl_offset = 2, Command = 0x1,
350                            BAR0 = 0x1C1A0000, BAR0Size = '256B',
351                            BAR1 = 0x1C1A0100, BAR1Size = '4096B',
352                            BAR0LegacyIO = True, BAR1LegacyIO = True)
353
354    pciconfig = PciConfigAll(size='256MB')
355    ethernet = IGbE_e1000(pci_bus=0, pci_dev=0, pci_func=0,
356                          InterruptLine=1, InterruptPin=1)
357
358    ide = IdeController(disks = [], pci_bus=0, pci_dev=1, pci_func=0,
359                        InterruptLine=2, InterruptPin=2)
360
361
362    vram           = SimpleMemory(range = AddrRange(0x18000000, size='32MB'))
363    rtc            = PL031(pio_addr=0x1C170000, int_num=36)
364
365    l2x0_fake      = IsaFake(pio_addr=0x2C100000, pio_size=0xfff)
366    uart1_fake     = AmbaFake(pio_addr=0x1C0A0000)
367    uart2_fake     = AmbaFake(pio_addr=0x1C0B0000)
368    uart3_fake     = AmbaFake(pio_addr=0x1C0C0000)
369    sp810_fake     = AmbaFake(pio_addr=0x1C020000, ignore_access=True)
370    watchdog_fake  = AmbaFake(pio_addr=0x1C0F0000)
371    aaci_fake      = AmbaFake(pio_addr=0x1C040000)
372    lan_fake       = IsaFake(pio_addr=0x1A000000, pio_size=0xffff)
373    usb_fake       = IsaFake(pio_addr=0x1B000000, pio_size=0x1ffff)
374    mmc_fake       = AmbaFake(pio_addr=0x1c050000)
375
376    def setupBootLoader(self, mem_bus, cur_sys, loc):
377        self.nvmem = SimpleMemory(range = AddrRange(0, size = '64MB'))
378        self.nvmem.port = mem_bus.master
379        cur_sys.boot_loader = loc('boot_emm.arm')
380        cur_sys.atags_addr = 0x80000100
381
382    # Attach I/O devices that are on chip and also set the appropriate
383    # ranges for the bridge
384    def attachOnChipIO(self, bus, bridge):
385       self.gic.pio = bus.master
386       self.local_cpu_timer.pio = bus.master
387       self.hdlcd.dma           = bus.slave
388       # Bridge ranges based on excluding what is part of on-chip I/O
389       # (gic, a9scu)
390       bridge.ranges = [AddrRange(0x2F000000, size='16MB'),
391                        AddrRange(0x2B000000, size='4MB'),
392                        AddrRange(0x30000000, size='256MB'),
393                        AddrRange(0x40000000, size='512MB'),
394                        AddrRange(0x18000000, size='64MB'),
395                        AddrRange(0x1C000000, size='64MB')]
396
397    # Attach I/O devices to specified bus object.  Can't do this
398    # earlier, since the bus object itself is typically defined at the
399    # System level.
400    def attachIO(self, bus):
401       self.uart.pio            = bus.master
402       self.realview_io.pio     = bus.master
403       self.timer0.pio          = bus.master
404       self.timer1.pio          = bus.master
405       self.clcd.pio            = bus.master
406       self.clcd.dma            = bus.slave
407       self.hdlcd.pio           = bus.master
408       self.kmi0.pio            = bus.master
409       self.kmi1.pio            = bus.master
410       self.cf_ctrl.pio         = bus.master
411       self.cf_ctrl.dma         = bus.slave
412       self.cf_ctrl.config      = bus.master
413       self.rtc.pio             = bus.master
414       bus.use_default_range    = True
415       self.vram.port           = bus.master
416       self.ide.pio             = bus.master
417       self.ide.config          = bus.master
418       self.ide.dma             = bus.slave
419       self.ethernet.pio        = bus.master
420       self.ethernet.config     = bus.master
421       self.ethernet.dma        = bus.slave
422       self.pciconfig.pio       = bus.default
423
424       self.l2x0_fake.pio       = bus.master
425       self.uart1_fake.pio      = bus.master
426       self.uart2_fake.pio      = bus.master
427       self.uart3_fake.pio      = bus.master
428       self.sp810_fake.pio      = bus.master
429       self.watchdog_fake.pio   = bus.master
430       self.aaci_fake.pio       = bus.master
431       self.lan_fake.pio        = bus.master
432       self.usb_fake.pio        = bus.master
433       self.mmc_fake.pio        = bus.master
434
435