1 # Copyright (c) 2009-2012 ARM Limited
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.
13 # Copyright (c) 2006-2007 The Regents of The University of Michigan
14 # All rights reserved.
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.
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.
43 from m5
.params
import *
44 from m5
.proxy
import *
45 from Device
import BasicPioDevice
, PioDevice
, IsaFake
, BadAddr
, DmaDevice
46 from Pci
import PciConfigAll
47 from Ethernet
import NSGigE
, IGbE_e1000
, IGbE_igb
49 from Platform
import Platform
50 from Terminal
import Terminal
52 from SimpleMemory
import SimpleMemory
54 class AmbaDevice(BasicPioDevice
):
57 amba_id
= Param
.UInt32("ID of AMBA device for kernel detection")
59 class AmbaIntDevice(AmbaDevice
):
60 type = 'AmbaIntDevice'
62 gic
= Param
.Gic(Parent
.any
, "Gic to use for interrupting")
63 int_num
= Param
.UInt32("Interrupt number that connects to GIC")
64 int_delay
= Param
.Latency("100ns",
65 "Time between action and interrupt generation by device")
67 class AmbaDmaDevice(DmaDevice
):
68 type = 'AmbaDmaDevice'
70 pio_addr
= Param
.Addr("Address for AMBA slave interface")
71 pio_latency
= Param
.Latency("10ns", "Time between action and write/read result by AMBA DMA Device")
72 gic
= Param
.Gic(Parent
.any
, "Gic to use for interrupting")
73 int_num
= Param
.UInt32("Interrupt number that connects to GIC")
74 amba_id
= Param
.UInt32("ID of AMBA device for kernel detection")
76 class A9SCU(BasicPioDevice
):
79 class RealViewCtrl(BasicPioDevice
):
81 proc_id0
= Param
.UInt32(0x0C000000, "Processor ID, SYS_PROCID")
82 proc_id1
= Param
.UInt32(0x0C000222, "Processor ID, SYS_PROCID1")
83 idreg
= Param
.UInt32(0x00000000, "ID Register, SYS_ID")
87 platform
= Param
.Platform(Parent
.any
, "Platform this device is part of.")
88 dist_addr
= Param
.Addr(0x1f001000, "Address for distributor")
89 cpu_addr
= Param
.Addr(0x1f000100, "Address for cpu")
90 dist_pio_delay
= Param
.Latency('10ns', "Delay for PIO r/w to distributor")
91 cpu_pio_delay
= Param
.Latency('10ns', "Delay for PIO r/w to cpu interface")
92 int_latency
= Param
.Latency('10ns', "Delay for interrupt to get to CPU")
93 it_lines
= Param
.UInt32(128, "Number of interrupt lines supported (max = 1020)")
95 class AmbaFake(AmbaDevice
):
97 ignore_access
= Param
.Bool(False, "Ignore reads/writes to this device, (e.g. IsaFake + AMBA)")
102 gic
= Param
.Gic(Parent
.any
, "Gic to use for interrupting")
103 int_num
= Param
.UInt32("Interrupt number that connects to GIC")
104 end_on_eot
= Param
.Bool(False, "End the simulation when a EOT is received on the UART")
105 int_delay
= Param
.Latency("100ns", "Time between action and interrupt generation by UART")
107 class Sp804(AmbaDevice
):
109 gic
= Param
.Gic(Parent
.any
, "Gic to use for interrupting")
110 int_num0
= Param
.UInt32("Interrupt number that connects to GIC")
111 clock0
= Param
.Clock('1MHz', "Clock speed of the input")
112 int_num1
= Param
.UInt32("Interrupt number that connects to GIC")
113 clock1
= Param
.Clock('1MHz', "Clock speed of the input")
116 class CpuLocalTimer(BasicPioDevice
):
117 type = 'CpuLocalTimer'
118 gic
= Param
.Gic(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
124 class PL031(AmbaIntDevice
):
126 time
= Param
.Time('01/01/2009', "System time to use ('Now' for actual time)")
129 class Pl050(AmbaIntDevice
):
131 vnc
= Param
.VncInput(Parent
.any
, "Vnc server for remote frame buffer display")
132 is_mouse
= Param
.Bool(False, "Is this interface a mouse, if not a keyboard")
136 class Pl111(AmbaDmaDevice
):
138 # Override the default clock
140 vnc
= Param
.VncInput(Parent
.any
, "Vnc server for remote frame buffer display")
143 class RealView(Platform
):
145 system
= Param
.System(Parent
.any
, "system")
146 pci_cfg_base
= Param
.Addr(0, "Base address of PCI Configuraiton Space")
147 mem_start_addr
= Param
.Addr(0, "Start address of main memory")
148 max_mem_size
= Param
.Addr('256MB', "Maximum amount of RAM supported by platform")
150 def setupBootLoader(self
, mem_bus
, cur_sys
, loc
):
151 self
.nvmem
= SimpleMemory(range = AddrRange(Addr('2GB'),
154 self
.nvmem
.port
= mem_bus
.master
155 cur_sys
.boot_loader
= loc('boot.arm')
158 # Reference for memory map and interrupt number
159 # RealView Platform Baseboard Explore for Cortex-A9 User Guide(ARM DUI 0440A)
160 # Chapter 4: Programmer's Reference
161 class RealViewPBX(RealView
):
162 uart
= Pl011(pio_addr
=0x10009000, int_num
=44)
163 realview_io
= RealViewCtrl(pio_addr
=0x10000000)
165 timer0
= Sp804(int_num0
=36, int_num1
=36, pio_addr
=0x10011000)
166 timer1
= Sp804(int_num0
=37, int_num1
=37, pio_addr
=0x10012000)
167 local_cpu_timer
= CpuLocalTimer(int_num_timer
=29, int_num_watchdog
=30, pio_addr
=0x1f000600)
168 clcd
= Pl111(pio_addr
=0x10020000, int_num
=55)
169 kmi0
= Pl050(pio_addr
=0x10006000, int_num
=52)
170 kmi1
= Pl050(pio_addr
=0x10007000, int_num
=53, is_mouse
=True)
171 a9scu
= A9SCU(pio_addr
=0x1f000000)
172 cf_ctrl
= IdeController(disks
=[], pci_func
=0, pci_dev
=7, pci_bus
=2,
173 io_shift
= 1, ctrl_offset
= 2, Command
= 0x1,
174 BAR0
= 0x18000000, BAR0Size
= '16B',
175 BAR1
= 0x18000100, BAR1Size
= '1B',
176 BAR0LegacyIO
= True, BAR1LegacyIO
= True)
179 l2x0_fake
= IsaFake(pio_addr
=0x1f002000, pio_size
=0xfff)
180 flash_fake
= IsaFake(pio_addr
=0x40000000, pio_size
=0x20000000,
182 dmac_fake
= AmbaFake(pio_addr
=0x10030000)
183 uart1_fake
= AmbaFake(pio_addr
=0x1000a000)
184 uart2_fake
= AmbaFake(pio_addr
=0x1000b000)
185 uart3_fake
= AmbaFake(pio_addr
=0x1000c000)
186 smc_fake
= AmbaFake(pio_addr
=0x100e1000)
187 sp810_fake
= AmbaFake(pio_addr
=0x10001000, ignore_access
=True)
188 watchdog_fake
= AmbaFake(pio_addr
=0x10010000)
189 gpio0_fake
= AmbaFake(pio_addr
=0x10013000)
190 gpio1_fake
= AmbaFake(pio_addr
=0x10014000)
191 gpio2_fake
= AmbaFake(pio_addr
=0x10015000)
192 ssp_fake
= AmbaFake(pio_addr
=0x1000d000)
193 sci_fake
= AmbaFake(pio_addr
=0x1000e000)
194 aaci_fake
= AmbaFake(pio_addr
=0x10004000)
195 mmc_fake
= AmbaFake(pio_addr
=0x10005000)
196 rtc
= PL031(pio_addr
=0x10017000, int_num
=42)
199 # Attach I/O devices that are on chip and also set the appropriate
200 # ranges for the bridge
201 def attachOnChipIO(self
, bus
, bridge
):
202 self
.gic
.pio
= bus
.master
203 self
.l2x0_fake
.pio
= bus
.master
204 self
.a9scu
.pio
= bus
.master
205 self
.local_cpu_timer
.pio
= bus
.master
206 # Bridge ranges based on excluding what is part of on-chip I/O
207 # (gic, l2x0, a9scu, local_cpu_timer)
208 bridge
.ranges
= [AddrRange(self
.realview_io
.pio_addr
,
209 self
.a9scu
.pio_addr
- 1),
210 AddrRange(self
.flash_fake
.pio_addr
,
211 self
.flash_fake
.pio_addr
+ \
212 self
.flash_fake
.pio_size
- 1)]
214 # Attach I/O devices to specified bus object. Can't do this
215 # earlier, since the bus object itself is typically defined at the
217 def attachIO(self
, bus
):
218 self
.uart
.pio
= bus
.master
219 self
.realview_io
.pio
= bus
.master
220 self
.timer0
.pio
= bus
.master
221 self
.timer1
.pio
= bus
.master
222 self
.clcd
.pio
= bus
.master
223 self
.clcd
.dma
= bus
.slave
224 self
.kmi0
.pio
= bus
.master
225 self
.kmi1
.pio
= bus
.master
226 self
.cf_ctrl
.pio
= bus
.master
227 self
.cf_ctrl
.config
= bus
.master
228 self
.cf_ctrl
.dma
= bus
.slave
229 self
.dmac_fake
.pio
= bus
.master
230 self
.uart1_fake
.pio
= bus
.master
231 self
.uart2_fake
.pio
= bus
.master
232 self
.uart3_fake
.pio
= bus
.master
233 self
.smc_fake
.pio
= bus
.master
234 self
.sp810_fake
.pio
= bus
.master
235 self
.watchdog_fake
.pio
= bus
.master
236 self
.gpio0_fake
.pio
= bus
.master
237 self
.gpio1_fake
.pio
= bus
.master
238 self
.gpio2_fake
.pio
= bus
.master
239 self
.ssp_fake
.pio
= bus
.master
240 self
.sci_fake
.pio
= bus
.master
241 self
.aaci_fake
.pio
= bus
.master
242 self
.mmc_fake
.pio
= bus
.master
243 self
.rtc
.pio
= bus
.master
244 self
.flash_fake
.pio
= bus
.master
246 # Reference for memory map and interrupt number
247 # RealView Emulation Baseboard User Guide (ARM DUI 0143B)
248 # Chapter 4: Programmer's Reference
249 class RealViewEB(RealView
):
250 uart
= Pl011(pio_addr
=0x10009000, int_num
=44)
251 realview_io
= RealViewCtrl(pio_addr
=0x10000000)
252 gic
= Gic(dist_addr
=0x10041000, cpu_addr
=0x10040000)
253 timer0
= Sp804(int_num0
=36, int_num1
=36, pio_addr
=0x10011000)
254 timer1
= Sp804(int_num0
=37, int_num1
=37, pio_addr
=0x10012000)
255 clcd
= Pl111(pio_addr
=0x10020000, int_num
=23)
256 kmi0
= Pl050(pio_addr
=0x10006000, int_num
=20)
257 kmi1
= Pl050(pio_addr
=0x10007000, int_num
=21, is_mouse
=True)
259 l2x0_fake
= IsaFake(pio_addr
=0x1f002000, pio_size
=0xfff, warn_access
="1")
260 flash_fake
= IsaFake(pio_addr
=0x40000000, pio_size
=0x20000000-1,
262 dmac_fake
= AmbaFake(pio_addr
=0x10030000)
263 uart1_fake
= AmbaFake(pio_addr
=0x1000a000)
264 uart2_fake
= AmbaFake(pio_addr
=0x1000b000)
265 uart3_fake
= AmbaFake(pio_addr
=0x1000c000)
266 smcreg_fake
= IsaFake(pio_addr
=0x10080000, pio_size
=0x10000-1)
267 smc_fake
= AmbaFake(pio_addr
=0x100e1000)
268 sp810_fake
= AmbaFake(pio_addr
=0x10001000, ignore_access
=True)
269 watchdog_fake
= AmbaFake(pio_addr
=0x10010000)
270 gpio0_fake
= AmbaFake(pio_addr
=0x10013000)
271 gpio1_fake
= AmbaFake(pio_addr
=0x10014000)
272 gpio2_fake
= AmbaFake(pio_addr
=0x10015000)
273 ssp_fake
= AmbaFake(pio_addr
=0x1000d000)
274 sci_fake
= AmbaFake(pio_addr
=0x1000e000)
275 aaci_fake
= AmbaFake(pio_addr
=0x10004000)
276 mmc_fake
= AmbaFake(pio_addr
=0x10005000)
277 rtc_fake
= AmbaFake(pio_addr
=0x10017000, amba_id
=0x41031)
281 # Attach I/O devices that are on chip and also set the appropriate
282 # ranges for the bridge
283 def attachOnChipIO(self
, bus
, bridge
):
284 self
.gic
.pio
= bus
.master
285 self
.l2x0_fake
.pio
= bus
.master
286 # Bridge ranges based on excluding what is part of on-chip I/O
288 bridge
.ranges
= [AddrRange(self
.realview_io
.pio_addr
,
289 self
.gic
.cpu_addr
- 1),
290 AddrRange(self
.flash_fake
.pio_addr
, Addr
.max)]
292 # Attach I/O devices to specified bus object. Can't do this
293 # earlier, since the bus object itself is typically defined at the
295 def attachIO(self
, bus
):
296 self
.uart
.pio
= bus
.master
297 self
.realview_io
.pio
= bus
.master
298 self
.timer0
.pio
= bus
.master
299 self
.timer1
.pio
= bus
.master
300 self
.clcd
.pio
= bus
.master
301 self
.clcd
.dma
= bus
.slave
302 self
.kmi0
.pio
= bus
.master
303 self
.kmi1
.pio
= bus
.master
304 self
.dmac_fake
.pio
= bus
.master
305 self
.uart1_fake
.pio
= bus
.master
306 self
.uart2_fake
.pio
= bus
.master
307 self
.uart3_fake
.pio
= bus
.master
308 self
.smc_fake
.pio
= bus
.master
309 self
.sp810_fake
.pio
= bus
.master
310 self
.watchdog_fake
.pio
= bus
.master
311 self
.gpio0_fake
.pio
= bus
.master
312 self
.gpio1_fake
.pio
= bus
.master
313 self
.gpio2_fake
.pio
= bus
.master
314 self
.ssp_fake
.pio
= bus
.master
315 self
.sci_fake
.pio
= bus
.master
316 self
.aaci_fake
.pio
= bus
.master
317 self
.mmc_fake
.pio
= bus
.master
318 self
.rtc_fake
.pio
= bus
.master
319 self
.flash_fake
.pio
= bus
.master
320 self
.smcreg_fake
.pio
= bus
.master
322 class VExpress_EMM(RealView
):
323 mem_start_addr
= '2GB'
325 pci_cfg_base
= 0x30000000
326 uart
= Pl011(pio_addr
=0x1c090000, int_num
=37)
327 realview_io
= RealViewCtrl(proc_id0
=0x14000000, proc_id1
=0x14000000, pio_addr
=0x1C010000)
328 gic
= Gic(dist_addr
=0x2C001000, cpu_addr
=0x2C002000)
329 local_cpu_timer
= CpuLocalTimer(int_num_timer
=29, int_num_watchdog
=30, pio_addr
=0x2C080000)
330 timer0
= Sp804(int_num0
=34, int_num1
=34, pio_addr
=0x1C110000, clock0
='1MHz', clock1
='1MHz')
331 timer1
= Sp804(int_num0
=35, int_num1
=35, pio_addr
=0x1C120000, clock0
='1MHz', clock1
='1MHz')
332 clcd
= Pl111(pio_addr
=0x1c1f0000, int_num
=46)
333 kmi0
= Pl050(pio_addr
=0x1c060000, int_num
=44)
334 kmi1
= Pl050(pio_addr
=0x1c070000, int_num
=45)
335 cf_ctrl
= IdeController(disks
=[], pci_func
=0, pci_dev
=0, pci_bus
=2,
336 io_shift
= 2, ctrl_offset
= 2, Command
= 0x1,
337 BAR0
= 0x1C1A0000, BAR0Size
= '256B',
338 BAR1
= 0x1C1A0100, BAR1Size
= '4096B',
339 BAR0LegacyIO
= True, BAR1LegacyIO
= True)
341 pciconfig
= PciConfigAll(size
='256MB')
342 ethernet
= IGbE_e1000(pci_bus
=0, pci_dev
=0, pci_func
=0,
343 InterruptLine
=1, InterruptPin
=1)
345 ide
= IdeController(disks
= [], pci_bus
=0, pci_dev
=1, pci_func
=0,
346 InterruptLine
=2, InterruptPin
=2)
349 vram
= SimpleMemory(range = AddrRange(0x18000000, size
='32MB'),
351 rtc
= PL031(pio_addr
=0x1C170000, int_num
=36)
353 l2x0_fake
= IsaFake(pio_addr
=0x2C100000, pio_size
=0xfff)
354 uart1_fake
= AmbaFake(pio_addr
=0x1C0A0000)
355 uart2_fake
= AmbaFake(pio_addr
=0x1C0B0000)
356 uart3_fake
= AmbaFake(pio_addr
=0x1C0C0000)
357 sp810_fake
= AmbaFake(pio_addr
=0x1C020000, ignore_access
=True)
358 watchdog_fake
= AmbaFake(pio_addr
=0x1C0F0000)
359 aaci_fake
= AmbaFake(pio_addr
=0x1C040000)
360 lan_fake
= IsaFake(pio_addr
=0x1A000000, pio_size
=0xffff)
361 usb_fake
= IsaFake(pio_addr
=0x1B000000, pio_size
=0x1ffff)
362 mmc_fake
= AmbaFake(pio_addr
=0x1c050000)
364 def setupBootLoader(self
, mem_bus
, cur_sys
, loc
):
365 self
.nvmem
= SimpleMemory(range = AddrRange(0, size
= '64MB'),
367 self
.nvmem
.port
= mem_bus
.master
368 cur_sys
.boot_loader
= loc('boot_emm.arm')
369 cur_sys
.atags_addr
= 0x80000100
371 # Attach I/O devices that are on chip and also set the appropriate
372 # ranges for the bridge
373 def attachOnChipIO(self
, bus
, bridge
):
374 self
.gic
.pio
= bus
.master
375 self
.local_cpu_timer
.pio
= bus
.master
376 # Bridge ranges based on excluding what is part of on-chip I/O
378 bridge
.ranges
= [AddrRange(0x2F000000, size
='16MB'),
379 AddrRange(0x30000000, size
='256MB'),
380 AddrRange(0x40000000, size
='512MB'),
381 AddrRange(0x18000000, size
='64MB'),
382 AddrRange(0x1C000000, size
='64MB')]
384 # Attach I/O devices to specified bus object. Can't do this
385 # earlier, since the bus object itself is typically defined at the
387 def attachIO(self
, bus
):
388 self
.uart
.pio
= bus
.master
389 self
.realview_io
.pio
= bus
.master
390 self
.timer0
.pio
= bus
.master
391 self
.timer1
.pio
= bus
.master
392 self
.clcd
.pio
= bus
.master
393 self
.clcd
.dma
= bus
.slave
394 self
.kmi0
.pio
= bus
.master
395 self
.kmi1
.pio
= bus
.master
396 self
.cf_ctrl
.pio
= bus
.master
397 self
.cf_ctrl
.dma
= bus
.slave
398 self
.cf_ctrl
.config
= bus
.master
399 self
.rtc
.pio
= bus
.master
400 bus
.use_default_range
= True
401 self
.vram
.port
= bus
.master
402 self
.ide
.pio
= bus
.master
403 self
.ide
.config
= bus
.master
404 self
.ide
.dma
= bus
.slave
405 self
.ethernet
.pio
= bus
.master
406 self
.ethernet
.config
= bus
.master
407 self
.ethernet
.dma
= bus
.slave
408 self
.pciconfig
.pio
= bus
.default
410 self
.l2x0_fake
.pio
= bus
.master
411 self
.uart1_fake
.pio
= bus
.master
412 self
.uart2_fake
.pio
= bus
.master
413 self
.uart3_fake
.pio
= bus
.master
414 self
.sp810_fake
.pio
= bus
.master
415 self
.watchdog_fake
.pio
= bus
.master
416 self
.aaci_fake
.pio
= bus
.master
417 self
.lan_fake
.pio
= bus
.master
418 self
.usb_fake
.pio
= bus
.master
419 self
.mmc_fake
.pio
= bus
.master