Allow selecting cpu to disassemble for

Currently only the esp32 is implemented (esp32s2 soon to follow).

This commit adds the -c command line option to the disassembler, as
well as updates the integration tests to supply the cpu parameter,
and test fixtures are renamed to include the cpu type in their name,
so that we can have separate fixture files for other cpus.

Author: wnienhaus

tests/03_disassembler_tests.sh

@@ -3,8 +3,9 @@
 set -e
 
 test_disassembling_a_file() {
+    local cpu=$1
     local verbose
-    if [ "$1" == verbose ]; then
+    if [ "$2" == verbose ]; then
         verbose=-v
         echo -e "Testing disassembling a file in VERBOSE mode"
     else
@@ -13,16 +14,16 @@ test_disassembling_a_file() {
 
     testname=all_opcodes
     fixture=fixtures/${testname}.S
-    echo -e "\tBuilding $fixture using micropython-esp32-ulp"
+    echo -e "\tBuilding $fixture using micropython-esp32-ulp ($cpu)"
 
     log_file="${testname}.log"
     ulp_file="fixtures/${testname}.ulp"
-    micropython -m esp32_ulp $fixture 1>$log_file   # generates $ulp_file
+    micropython -m esp32_ulp -c $cpu $fixture 1>$log_file   # generates $ulp_file
 
-    lst_file="${testname}.lst"
-    lst_file_fixture=fixtures/${testname}${verbose}.lst
-    echo -e "\tDisassembling $ulp_file using micropython-esp32-ulp disassembler"
-    micropython -m tools.disassemble $verbose $ulp_file > $lst_file
+    lst_file="${testname}.$cpu.lst"
+    lst_file_fixture=fixtures/${testname}${verbose}.$cpu.lst
+    echo -e "\tDisassembling $ulp_file using micropython-esp32-ulp disassembler ($cpu)"
+    micropython -m tools.disassemble -c $cpu $verbose $ulp_file > $lst_file
 
     if ! diff $lst_file_fixture $lst_file 1>/dev/null; then
         echo -e "\tDisassembled output differs from expected output!"
@@ -36,8 +37,9 @@ test_disassembling_a_file() {
 }
 
 test_disassembling_a_manual_sequence() {
+    local cpu=$1
     local verbose
-    if [ "$1" == verbose ]; then
+    if [ "$2" == verbose ]; then
         verbose=-v
         echo -e "Testing disassembling a manual byte sequence in VERBOSE mode"
     else
@@ -46,10 +48,10 @@ test_disassembling_a_manual_sequence() {
 
     sequence="e1af 8c72 0100 0068 2705 cc19 0005 681d 0000 00a0 0000 0074"
 
-    lst_file="manual_bytes.lst"
-    lst_file_fixture=fixtures/manual_bytes${verbose}.lst
-    echo -e "\tDisassembling manual byte sequence using micropython-esp32-ulp disassembler"
-    micropython -m tools.disassemble $verbose -m $sequence > $lst_file
+    lst_file="manual_bytes.$cpu.lst"
+    lst_file_fixture=fixtures/manual_bytes${verbose}.$cpu.lst
+    echo -e "\tDisassembling manual byte sequence using micropython-esp32-ulp disassembler ($cpu)"
+    micropython -m tools.disassemble -c $cpu $verbose -m $sequence> $lst_file
 
     if ! diff $lst_file_fixture $lst_file 1>/dev/null; then
         echo -e "\tDisassembled output differs from expected output!"
@@ -60,8 +62,10 @@ test_disassembling_a_manual_sequence() {
     fi
 }
 
-test_disassembling_a_file
-test_disassembling_a_file verbose
+# esp32
+echo "Testing for CPU: esp32"
+test_disassembling_a_file esp32
+test_disassembling_a_file esp32 verbose
 
-test_disassembling_a_manual_sequence
-test_disassembling_a_manual_sequence verbose
+test_disassembling_a_manual_sequence esp32
+test_disassembling_a_manual_sequence esp32 verbose

tests/fixtures/all_opcodes-v.lst renamed to tests/fixtures/all_opcodes-v.esp32.lst

@@ -1,9 +1,27 @@
 from uctypes import struct, addressof, LITTLE_ENDIAN, UINT16, UINT32
-from .decode import decode_instruction, get_instruction_fields
 import ubinascii
 import sys
 
 
+# placeholders:
+# these functions will be dynamically loaded later based on the chosen cpu
+decode_instruction, get_instruction_fields = None, None
+
+
+def load_decoder(cpu):
+    if cpu == 'esp32':
+        mod = 'decode'
+    else:
+        raise ValueError('Invalid cpu')
+
+    relative_import = 1 if '/' in __file__ else 0
+    decode = __import__(mod, globals(), locals(), [], relative_import)
+
+    global decode_instruction, get_instruction_fields
+    decode_instruction = decode.decode_instruction
+    get_instruction_fields = decode.get_instruction_fields
+
+
 def chunk_into_words(code, bytes_per_word, byteorder):
     chunks = [
         ubinascii.hexlify(code[i:i + bytes_per_word])
@@ -65,7 +83,9 @@ def print_data_section(data_offset, code):
         print_code_line(data_offset + (idx << 2), i, asm)
 
 
-def disassemble_manually(byte_sequence_string, verbose=False):
+def disassemble_manually(byte_sequence_string, cpu, verbose=False):
+    load_decoder(cpu)
+
     sequence = byte_sequence_string.strip().replace(' ','')
     chars_per_instruction = 8
     list = [
@@ -79,7 +99,9 @@ def disassemble_manually(byte_sequence_string, verbose=False):
         decode_instruction_and_print(idx << 2, i, verbose)
 
 
-def disassemble_file(filename, verbose=False):
+def disassemble_file(filename, cpu, verbose=False):
+    load_decoder(cpu)
+
     with open(filename, 'rb') as f:
         data = f.read()
 
@@ -114,6 +136,7 @@ def print_help():
     print('Usage: disassemble.py [<options>] [-m <byte_sequence> | <filename>]')
     print('')
     print('Options:')
+    print('  -c                  Choose ULP variant: only esp32 supported for now')
     print('  -h                  Show this help text')
     print('  -m <byte_sequence>  Sequence of hex bytes (8 per instruction)')
     print('  -v                  Verbose mode. Show ULP header and fields of each instruction')
@@ -122,6 +145,7 @@ def print_help():
 
 
 def handle_cmdline(params):
+    cpu = 'esp32'
     verbose = False
     filename = None
     byte_sequence = None
@@ -130,6 +154,9 @@ def handle_cmdline(params):
         if params[0] == '-h':
             print_help()
             sys.exit(0)
+        elif params[0] == '-c':
+            cpu = params[1]
+            params = params[1:]  # remove first param from list
         elif params[0] == '-m':
             if len(params) == 1:
                 print_help()
@@ -159,10 +186,11 @@ def handle_cmdline(params):
 
         params = params[1:]  # remove first param from list
 
+
     if byte_sequence:
-        disassemble_manually(byte_sequence, verbose)
+        disassemble_manually(byte_sequence, cpu, verbose)
     elif filename:
-        disassemble_file(filename, verbose)
+        disassemble_file(filename, cpu, verbose)
 
 
 if sys.argv: # if run from cmdline