Skip to content

Commit

Permalink
tools/litex_client: Added --endianness argument to support little-end…
Browse files Browse the repository at this point in the history 
…ian and big-endian memory accesses.

Usage:
1. Read memory to a file with big-endian byte order:
   ./litex_cli --read 0x1000 --length 16 --file output.bin --endianness big

2. Write memory from a file with big-endian byte order:
   ./litex_cli --write 0x1000 --file input.bin --length 16 --endianness big

3. Read memory to console with little-endian byte order (default):
   ./litex_cli --read 0x1000 --length 16

4. Write memory from console with little-endian byte order (default):
   ./litex_cli --write 0x1000 0x12345678
  • Loading branch information
@enjoy-digital
enjoy-digital committed Jan 6, 2025
1 parent 95f37a8 commit 71e802a
Showing 1 changed file with 34 additions and 31 deletions.
65 changes: 34 additions & 31 deletions litex/tools/litex_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ def dump_registers(host, csr_csv, port, filter=None, binary=False):

bus.close()

def read_memory(host, csr_csv, port, addr, length, binary=False, file=None):
def read_memory(host, csr_csv, port, addr, length, binary=False, file=None, endianness="little"):
bus = RemoteClient(host=host, csr_csv=csr_csv, port=port)
bus.open()

Expand All @@ -179,7 +179,7 @@ def read_memory(host, csr_csv, port, addr, length, binary=False, file=None):
with open(file, 'wb') as f:
for offset in range(length // 4):
data = bus.read(addr + 4 * offset)
f.write(data.to_bytes(4, byteorder="little"))
f.write(data.to_bytes(4, byteorder=endianness))
else:
# Print to console
for offset in range(length // 4):
Expand All @@ -191,7 +191,7 @@ def read_memory(host, csr_csv, port, addr, length, binary=False, file=None):

bus.close()

def write_memory(host, csr_csv, port, addr, data, file=None, length=None):
def write_memory(host, csr_csv, port, addr, data, file=None, length=None, endianness="little"):
bus = RemoteClient(host=host, csr_csv=csr_csv, port=port)
bus.open()

Expand All @@ -204,7 +204,7 @@ def write_memory(host, csr_csv, port, addr, data, file=None, length=None):
data = f.read()
# Write data in 32-bit chunks
for i in range(0, len(data), 4):
word = int.from_bytes(data[i:i + 4], byteorder="little")
word = int.from_bytes(data[i:i + 4], byteorder=endianness)
bus.write(addr + i, word)
else:
# Write single data value to memory
Expand Down Expand Up @@ -466,26 +466,27 @@ def timer_callback(refresh=1e-1, xadc_points=100):
def main():
parser = argparse.ArgumentParser(description="LiteX Client utility.", formatter_class=argparse.ArgumentDefaultsHelpFormatter)
# Common.
parser.add_argument("--csr-csv", default="csr.csv", help="CSR configuration file")
parser.add_argument("--host", default="localhost", help="Host ip address")
parser.add_argument("--port", default="1234", help="Host bind port.")
parser.add_argument("--binary", action="store_true", help="Use binary format for displayed values.")
parser.add_argument("--file", default=None, help="File to read from or write to in binary mode.")
parser.add_argument("--csr-csv", default="csr.csv", help="CSR configuration file")
parser.add_argument("--host", default="localhost", help="Host ip address")
parser.add_argument("--port", default="1234", help="Host bind port.")
parser.add_argument("--binary", action="store_true", help="Use binary format for displayed values.")
parser.add_argument("--file", default=None, help="File to read from or write to in binary mode.")
parser.add_argument("--endianness", default="little", choices=["little", "big"], help="Endianness for memory accesses (little or big).")

# Identifier.
parser.add_argument("--ident", action="store_true", help="Dump SoC identifier.")
parser.add_argument("--ident", action="store_true", help="Dump SoC identifier.")

# Registers.
parser.add_argument("--regs", action="store_true", help="Dump SoC registers.")
parser.add_argument("--filter", default=None, help="Registers filter (to be used with --regs).")
parser.add_argument("--regs", action="store_true", help="Dump SoC registers.")
parser.add_argument("--filter", default=None, help="Registers filter (to be used with --regs).")

# Memory.
parser.add_argument("--read", default=None, help="Do a MMAP Read to SoC bus (--read addr/reg).")
parser.add_argument("--write", default=None, nargs="*", help="Do a MMAP Write to SoC bus (--write addr/reg [data]).")
parser.add_argument("--length", default="4", help="MMAP access length.")
parser.add_argument("--read", default=None, help="Do a MMAP Read to SoC bus (--read addr/reg).")
parser.add_argument("--write", default=None, nargs="*", help="Do a MMAP Write to SoC bus (--write addr/reg [data]).")
parser.add_argument("--length", default="4", help="MMAP access length.")

# GUI.
parser.add_argument("--gui", action="store_true", help="Run GUI.")
parser.add_argument("--gui", action="store_true", help="Run GUI.")

args = parser.parse_args()

Expand Down Expand Up @@ -519,13 +520,14 @@ def main():
except ValueError:
addr = reg2addr(host, csr_csv, args.read)
read_memory(
host = host,
csr_csv = csr_csv,
port = port,
addr = addr,
length = int(args.length, 0),
binary = args.binary,
file = args.file,
host = host,
csr_csv = csr_csv,
port = port,
addr = addr,
length = int(args.length, 0),
binary = args.binary,
file = args.file,
endianness = args.endianness,
)

# Memory Write.
Expand All @@ -544,13 +546,14 @@ def main():
data = int(args.write[1], 0)

write_memory(
host = host,
csr_csv = csr_csv,
port = port,
addr = addr,
data = data,
file = args.file,
length = int(args.length, 0) if args.length else None,
host = host,
csr_csv = csr_csv,
port = port,
addr = addr,
data = data,
file = args.file,
length = int(args.length, 0) if args.length else None,
endianness = args.endianness,
)

# GUI.
Expand All @@ -562,4 +565,4 @@ def main():
)

if __name__ == "__main__":
main()
main()

0 comments on commit 71e802a

Please sign in to comment.