From fb145dacedbd76235792b056140a4f9885eba534 Mon Sep 17 00:00:00 2001
From: Sean Cross <sean@xobs.io>
Date: Fri, 27 Jul 2018 15:21:19 +0800
Subject: [PATCH] tools: remove vexriscv_debug

This program is no longer needed.

The `openocd_vexriscv` package natively supports `etherbone`, and now
that the vexriscv debug module is available on Wishbone instead of as a
CSR, this module no longer works.

This change simplifies both tooling (because there is one fewer program
to run) and integration (because you don't need to modify your CSRs
anymore, just `register_mem()`.)

Signed-off-by: Sean Cross <sean@xobs.io>
---
 litex/soc/tools/vexriscv_debug.py | 108 ------------------------------
 setup.py                          |   3 +-
 2 files changed, 1 insertion(+), 110 deletions(-)
 delete mode 100644 litex/soc/tools/vexriscv_debug.py

diff --git a/litex/soc/tools/vexriscv_debug.py b/litex/soc/tools/vexriscv_debug.py
deleted file mode 100644
index 11276861e..000000000
--- a/litex/soc/tools/vexriscv_debug.py
+++ /dev/null
@@ -1,108 +0,0 @@
-#!/usr/bin/env python3
-
-import sys
-import os
-import time
-import threading
-import argparse
-import socket
-import struct
-from litex.soc.tools.remote import RemoteClient
-
-class ConnectionClosed(Exception):
-    pass
-
-# struct vexriscv_req {
-#	uint8_t readwrite;
-#	uint8_t size;
-#	uint32_t address;
-#	uint32_t data;
-#} __attribute__((packed));
-class VexRiscvDebugPacket():
-    def __init__(self, data):
-        self.is_write, self.size, self.address, self.value = struct.unpack("=?BII", data)
-
-class VexRiscvDebugBridge():
-    def __init__(self):
-        self._get_args()
-
-    def open(self):
-        if not hasattr(self, "debugger_socket"):
-            self.debugger_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-            self.debugger_socket.bind(('',7893))
-            self.debugger_socket.listen(0)
-
-        if not hasattr(self, "rc"):
-            self.rc = RemoteClient(csr_csv=self.args.csr)
-            self.rc.open()
-            self.core_reg = self.rc.regs.cpu_or_bridge_debug_core
-            self.data_reg = self.rc.regs.cpu_or_bridge_debug_data
-            self.refresh_reg = self.rc.regs.cpu_or_bridge_debug_refresh
-
-    def _get_args(self):
-        parser = argparse.ArgumentParser()
-        parser.add_argument("--csr", default="test/csr.csv", help="csr mapping file")
-        self.args = parser.parse_args()
-
-    def accept(self):
-        if hasattr(self, "debugger"):
-            return
-        print("Waiting for connection from debugger...")
-        self.debugger, address = self.debugger_socket.accept()
-        print("Accepted debugger connection from {}".format(address[0]))
-
-    def _refresh_reg(self, reg):
-        self.refresh_reg.write(reg)
-
-    def read_core(self):
-        self._refresh_reg(0)
-        self.write_to_debugger(self.core_reg.read())
-
-    def read_data(self):
-        self._refresh_reg(4)
-        self.write_to_debugger(self.data_reg.read())
-
-    def write_core(self, value):
-        self.core_reg.write(value)
-
-    def write_data(self, value):
-        self.data_reg.write(value)
-
-    def read_from_debugger(self):
-        data = self.debugger.recv(10)
-        if len(data) != 10:
-            self.debugger.close()
-            del self.debugger
-            raise ConnectionClosed()
-        return VexRiscvDebugPacket(data)
-
-    def write_to_debugger(self, data):
-        self.debugger.send(struct.pack("=I", data))
-
-def main():
-    vrvb = VexRiscvDebugBridge()
-    vrvb.open()
-
-    while True:
-        vrvb.accept()
-        try:
-            pkt = vrvb.read_from_debugger()
-            if pkt.is_write == True:
-                if pkt.address == 0xf00f0000:
-                    vrvb.write_core(pkt.value)
-                elif pkt.address == 0xf00f0004:
-                    vrvb.write_data(pkt.value)
-                else:
-                    raise "Unrecognized address"
-            else:
-                if pkt.address == 0xf00f0000:
-                    vrvb.read_core()
-                elif pkt.address == 0xf00f0004:
-                    vrvb.read_data()
-                else:
-                    raise "Unrecognized address"
-        except ConnectionClosed:
-            print("Debugger connection closed")
-
-if __name__ == "__main__":
-    main()
diff --git a/setup.py b/setup.py
index e16e193f6..d129bde0d 100755
--- a/setup.py
+++ b/setup.py
@@ -38,8 +38,7 @@ setup(
         "console_scripts": [
             "litex_term=litex.soc.tools.litex_term:main",
             "mkmscimg=litex.soc.tools.mkmscimg:main",
-            "litex_server=litex.soc.tools.remote.litex_server:main",
-            "vexriscv_bridge=litex.soc.tools.vexriscv_debug:main"
+            "litex_server=litex.soc.tools.remote.litex_server:main"
         ],
     },
 )