Merge pull request #21 from sifive/add_freedom_sim_targets

Add freedom sim targets

diff --combined debug/gdbserver.py
index 2558a6cc2d3f6c65bcf724b037c61bc611d0886f,f3c111a78aeac3ac5bc3953ec9ed2901ee36b73c..8a6e87439a124f9835ba8b81f8cea43ee505276f
--- 1/debug/gdbserver.py
--- 2/debug/gdbserver.py
+++ b/debug/gdbserver.py
@@@ -10,6 -10,7 +10,7 @@@ import tim
  import random
  import binascii
  
+ 
  MSTATUS_UIE = 0x00000001
  MSTATUS_SIE = 0x00000002
  MSTATUS_HIE = 0x00000004
@@@ -30,12 -31,29 +31,29 @@@ MSTATUS_VM = 0x1F00000
  MSTATUS32_SD = 0x80000000
  MSTATUS64_SD = 0x8000000000000000
  
- def gdb():
+ def gdb(
+         target=None,
+         port=None,
+         binary=None
+         ):
+ 
+     gdb = None
      if parsed.gdb:
-         return testlib.Gdb(parsed.gdb)
+         gdb = testlib.Gdb(parsed.gdb)
      else:
-         return testlib.Gdb()
+         gdb =  testlib.Gdb()
+ 
+     if (binary):
+         gdb.command("file %s" % self.binary)
+     if (target):
+         gdb.command("set arch riscv:rv%d" % target.xlen)
+         gdb.command("set remotetimeout %d" % target.timeout_sec)
+     if (port):
+         gdb.command("target extended-remote localhost:%d" % port)
+ 
+     return gdb
  
+         
  def ihex_line(address, record_type, data):
      assert len(data) < 128
      line = ":%02X%04X%02X" % (len(data), address, record_type)
@@@ -61,9 -79,6 +79,9 @@@ def ihex_parse(line)
          data += "%c" % int(line[8+2*i:10+2*i], 16)
      return record_type, address, data
  
 +def readable_binary_string(s):
 +    return "".join("%02x" % ord(c) for c in s)
 +
  class DeleteServer(unittest.TestCase):
      def tearDown(self):
          del self.server
@@@ -71,12 -86,7 +89,7 @@@
  class SimpleRegisterTest(DeleteServer):
      def setUp(self):
          self.server = target.server()
-         self.gdb = gdb()
-         # For now gdb has to be told what the architecture is when it's not
-         # given an ELF file.
-         self.gdb.command("set arch riscv:rv%d" % target.xlen)
- 
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port)
  
          # 0x13 is nop
          self.gdb.command("p *((int*) 0x%x)=0x13" % target.ram)
@@@ -113,9 -123,7 +126,7 @@@
  class SimpleMemoryTest(DeleteServer):
      def setUp(self):
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("set arch riscv:rv%d" % target.xlen)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port)
  
      def access_test(self, size, data_type):
          self.assertEqual(self.gdb.p("sizeof(%s)" % data_type),
@@@ -165,16 -173,13 +176,14 @@@
          for line in b:
              record_type, address, line_data = ihex_parse(line)
              if (record_type == 0):
 -                self.assertEqual(line_data, data[address:address+len(line_data)])
 +                self.assertEqual(readable_binary_string(line_data),
 +                        readable_binary_string(data[address:address+len(line_data)]))
  
  class InstantHaltTest(DeleteServer):
      def setUp(self):
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("set arch riscv:rv%d" % target.xlen)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
- 
+         self.gdb = gdb(target, self.server.port)
+          
      def test_instant_halt(self):
          self.assertEqual(target.reset_vector, self.gdb.p("$pc"))
          # mcycle and minstret have no defined reset value.
@@@ -202,9 -207,7 +211,7 @@@ class DebugTest(DeleteServer)
          self.binary = target.compile("programs/debug.c", "programs/checksum.c",
                  "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port, self.binary)
          self.gdb.load()
          self.gdb.b("_exit")
  
@@@ -355,9 -358,7 +362,7 @@@ class StepTest(DeleteServer)
      def setUp(self):
          self.binary = target.compile("programs/step.S")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port, self.binary)
          self.gdb.load()
          self.gdb.b("main")
          self.gdb.c()
@@@ -373,9 -374,7 +378,7 @@@ class RegsTest(DeleteServer)
      def setUp(self):
          self.binary = target.compile("programs/regs.S")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port, self.binary)
          self.gdb.load()
          self.gdb.b("main")
          self.gdb.b("handle_trap")
@@@ -443,10 -442,8 +446,8 @@@ class DownloadTest(DeleteServer)
  
          self.binary = target.compile(download_c.name, "programs/checksum.c")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
- 
+         self.gdb = gdb(target, self.server.port, self.binary)
+         
      def test_download(self):
          output = self.gdb.load()
          self.gdb.command("b _exit")
@@@ -457,9 -454,7 +458,7 @@@ class MprvTest(DeleteServer)
      def setUp(self):
          self.binary = target.compile("programs/mprv.S")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port, self.binary)
          self.gdb.load()
  
      def test_mprv(self):
@@@ -474,9 -469,7 +473,7 @@@ class PrivTest(DeleteServer)
      def setUp(self):
          self.binary = target.compile("programs/priv.S")
          self.server = target.server()
-         self.gdb = gdb()
-         self.gdb.command("file %s" % self.binary)
-         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+         self.gdb = gdb(target, self.server.port, self.binary)
          self.gdb.load()
  
          misa = self.gdb.p("$misa")
@@@ -524,7 -517,8 +521,8 @@@
  
  class Target(object):
      directory = None
- 
+     timeout_sec = 2
+     
      def server(self):
          raise NotImplementedError
  
@@@ -578,23 -572,70 +576,70 @@@ class FreedomE300Target(Target)
          return testlib.Openocd(cmd=parsed.cmd,
                  config="targets/%s/openocd.cfg" % self.name)
  
+ class FreedomE300SimTarget(Target):
+     name = "freedom-e300-sim"
+     xlen = 32
+     timeout_sec = 240
+     ram = 0x80000000
+     ram_size = 256 * 1024 * 1024
+     instruction_hardware_breakpoint_count = 2
+        
+     def server(self):
+         sim = testlib.VcsSim(simv=parsed.run, debug=False)
+         openocd = testlib.Openocd(cmd=parsed.cmd,
+                             config="targets/%s/openocd.cfg" % self.name,
+                             otherProcess = sim)
+         time.sleep(20)
+         return openocd
+ 
+ class FreedomU500Target(Target):
+     name = "freedom-u500"
+     xlen = 64
+     ram = 0x80000000
+     ram_size = 16 * 1024
+     instruction_hardware_breakpoint_count = 2
+ 
+     def server(self):
+         return testlib.Openocd(cmd=parsed.cmd,
+                 config="targets/%s/openocd.cfg" % self.name)
+     
+ class FreedomU500SimTarget(Target):
+     name = "freedom-u500-sim"
+     xlen = 64
+     timeout_sec = 240
+     ram = 0x80000000
+     ram_size = 256 * 1024 * 1024
+     instruction_hardware_breakpoint_count = 2
+        
+     def server(self):
+         sim = testlib.VcsSim(simv=parsed.run, debug=False)
+         openocd = testlib.Openocd(cmd=parsed.cmd,
+                             config="targets/%s/openocd.cfg" % self.name,
+                             otherProcess = sim)
+         time.sleep(20)
+         return openocd
+ 
  targets = [
          Spike32Target,
          Spike64Target,
-         FreedomE300Target
-         ]
+         FreedomE300Target,
+         FreedomU500Target,
+         FreedomE300SimTarget,
+         FreedomU500SimTarget]
  
  def main():
      parser = argparse.ArgumentParser(
              epilog="""
              Example command line from the real world:
-             Run all RegsTest cases against a MicroSemi m2gl_m2s board, with custom openocd command:
-             ./gdbserver.py --m2gl_m2s --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" -- -vf RegsTest
+             Run all RegsTest cases against a physical FPGA, with custom openocd command:
+             ./gdbserver.py --freedom-e-300 --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" -- -vf RegsTest
              """)
      group = parser.add_mutually_exclusive_group(required=True)
      for t in targets:
          group.add_argument("--%s" % t.name, action="store_const", const=t,
                  dest="target")
+     parser.add_argument("--run",
+                         help="The command to use to start the actual target (e.g. simulation)")
      parser.add_argument("--cmd",
              help="The command to use to start the debug server.")
      parser.add_argument("--gdb",
@@@ -613,7 -654,7 +658,7 @@@
  
  # TROUBLESHOOTING TIPS
  # If a particular test fails, run just that one test, eg.:
- # ./tests/gdbserver.py MprvTest.test_mprv
+ # ./gdbserver.py MprvTest.test_mprv
  # Then inspect gdb.log and spike.log to see what happened in more detail.
  
  if __name__ == '__main__':