Merge pull request #53 from wnienhaus/fixes-for-v1

Last fixes for v1

Author: ThomasWaldmann

esp32_ulp/opcodes.py

@@ -358,9 +358,7 @@ def get_cond(arg):
 
 def _soc_reg_to_ulp_periph_sel(reg):
     # Map SoC peripheral register to periph_sel field of RD_REG and WR_REG instructions.
-    if reg < DR_REG_MAX_DIRECT:
-        ret = RD_REG_PERIPH_RTC_CNTL
-    elif reg < DR_REG_RTCCNTL_BASE:
+    if reg < DR_REG_RTCCNTL_BASE:
         raise ValueError("invalid register base")
     elif reg < DR_REG_RTCIO_BASE:
         ret = RD_REG_PERIPH_RTC_CNTL
@@ -377,11 +375,12 @@ def _soc_reg_to_ulp_periph_sel(reg):
 
 def i_reg_wr(reg, high_bit, low_bit, val):
     reg = get_imm(reg)
-    if reg < DR_REG_MAX_DIRECT:  # see https://github.com/espressif/binutils-esp32ulp/blob/master/gas/config/tc-esp32ulp_esp32.c
-        _wr_reg.addr = reg
+    if reg <= DR_REG_MAX_DIRECT:  # see https://github.com/espressif/binutils-esp32ulp/blob/master/gas/config/tc-esp32ulp_esp32.c
+        _wr_reg.addr = reg & 0xff
+        _wr_reg.periph_sel = (reg & 0x300) >> 8
     else:
         _wr_reg.addr = (reg & 0xff) >> 2
-    _wr_reg.periph_sel = _soc_reg_to_ulp_periph_sel(reg)
+        _wr_reg.periph_sel = _soc_reg_to_ulp_periph_sel(reg)
     _wr_reg.data = get_imm(val)
     _wr_reg.low = get_imm(low_bit)
     _wr_reg.high = get_imm(high_bit)
@@ -391,11 +390,12 @@ def i_reg_wr(reg, high_bit, low_bit, val):
 
 def i_reg_rd(reg, high_bit, low_bit):
     reg = get_imm(reg)
-    if reg < DR_REG_MAX_DIRECT: # see https://github.com/espressif/binutils-esp32ulp/blob/master/gas/config/tc-esp32ulp_esp32.c
-        _rd_reg.addr = reg
+    if reg <= DR_REG_MAX_DIRECT:  # see https://github.com/espressif/binutils-esp32ulp/blob/master/gas/config/tc-esp32ulp_esp32.c
+        _rd_reg.addr = reg & 0xff
+        _rd_reg.periph_sel = (reg & 0x300) >> 8
     else:
         _rd_reg.addr = (reg & 0xff) >> 2
-    _rd_reg.periph_sel = _soc_reg_to_ulp_periph_sel(reg)
+        _rd_reg.periph_sel = _soc_reg_to_ulp_periph_sel(reg)
     _rd_reg.unused = 0
     _rd_reg.low = get_imm(low_bit)
     _rd_reg.high = get_imm(high_bit)

tests/02_compat_rtc_tests.sh

@@ -51,6 +51,42 @@ build_defines_db() {
         esp-idf/components/esp_common/include/*.h 1>$log_file
 }
 
+patch_test() {
+    local test_name=$1
+    local out_file="${test_name}.tmp"
+
+    if [ "${test_name}" = esp32ulp_jumpr ]; then
+        (
+            cd binutils-esp32ulp/gas/testsuite/gas/esp32ulp/esp32
+            cp ${test_name}.s ${out_file}
+            echo -e "\tPatching test to work around binutils-esp32ulp .global bug"
+            cat >> ${out_file} <<EOF
+                .global check_jump1
+EOF
+        )
+        return 0
+
+    elif [ "${test_name}" = esp32ulp_ranges ]; then
+        (
+            cd binutils-esp32ulp/gas/testsuite/gas/esp32ulp/esp32
+            # merge 2 files: https://github.com/espressif/binutils-esp32ulp/blob/249ec34/gas/testsuite/gas/esp32ulp/esp32/check_as_ld.sh#L31
+            echo -e "\t${test_name} requires esp32ulp_globals. Merging both files into ${out_file}"
+            cat esp32ulp_globals.s ${test_name}.s > ${out_file}
+            echo -e "\tPatching test to work around binutils-esp32ulp .global bug"
+            cat >> ${out_file} <<EOF
+                .global min_add
+                .global min_jump1
+                .global max_jump1
+                .global min_jumpr1
+                .global max_jumpr1
+EOF
+        )
+        return 0
+    fi
+
+    return 1  # nothing was patched
+}
+
 make_log_dir
 fetch_esp_idf
 fetch_ulptool_examples
@@ -60,21 +96,12 @@ build_defines_db $1
 for src_file in ulptool/src/ulp_examples/*/*.s binutils-esp32ulp/gas/testsuite/gas/esp32ulp/esp32/*.s; do
 
     src_name="${src_file%.s}"
+    src_dir="${src_name%/*}"
 
     echo "Testing $src_file"
 
     test_name="${src_name##*/}"
 
-    # for now, skip files that contain known bugs in esp32_ulp (essentially a todo list of what to fix)
-    for I in esp32ulp_jumpr esp32ulp_ranges; do
-        if [ "${test_name}" = "$I" ]; then
-            # these are old bugs, and not related to the RTC macro handling functionality
-            # they will still be great to fix over time
-            echo -e "\tSkipping... known bugs in esp32_ulp"
-            continue 2
-        fi
-    done
-
     # for now, skip files that contain unsupported things (macros)
     for I in i2c i2c_dev stack i2c_wr test1 test_jumpr test_macro; do
         if [ "${test_name}" = "$I" ]; then
@@ -83,8 +110,18 @@ for src_file in ulptool/src/ulp_examples/*/*.s binutils-esp32ulp/gas/testsuite/g
         fi
     done
 
-    echo -e "\tBuilding using py-esp32-ulp"
+    # BEGIN: work around known issues with binutils-esp32ulp
     ulp_file="${src_name}.ulp"
+
+    if patch_test ${test_name}; then
+        # switch to the patched file instead of original one
+        src_file="${src_dir}/${test_name}.tmp"
+        src_name="${src_file%.tmp}"
+        ulp_file="${src_name}.tmp.ulp"  # when extension is not .s, py-esp32-ulp doesn't remove original extension
+    fi
+    # END: work around known issues with binutils-esp32ulp
+
+    echo -e "\tBuilding using py-esp32-ulp"
     log_file="${src_name}.log"
     micropython -m esp32_ulp $src_file 1>$log_file   # generates $ulp_file
 

tests/opcodes.py

@@ -108,10 +108,78 @@ def assert_raises(exception, func, *args):
     assert raised
 
 
+def test_reg_direct_ulp_addressing():
+    """
+    Test direct ULP addressing of peripheral registers
+    input must be <= 0x3ff (10 bits)
+    periph_sel == high 2 bits from input
+    addr == low 8 bits from input
+    """
+
+    ins = make_ins("""
+    addr : 8        # Address within either RTC_CNTL, RTC_IO, or SARADC
+    periph_sel : 2  # Select peripheral: RTC_CNTL (0), RTC_IO(1), SARADC(2)
+    unused : 8      # Unused
+    low : 5         # Low bit
+    high : 5        # High bit
+    opcode : 4      # Opcode (OPCODE_RD_REG)
+    """)
+
+    ins.all = opcodes.i_reg_rd("0x0", "0", "0")
+    assert ins.periph_sel == 0
+    assert ins.addr == 0x0
+
+    ins.all = opcodes.i_reg_rd("0x012", "0", "0")
+    assert ins.periph_sel == 0
+    assert ins.addr == 0x12
+
+    ins.all = opcodes.i_reg_rd("0x123", "0", "0")
+    assert ins.periph_sel == 1
+    assert ins.addr == 0x23
+
+    ins.all = opcodes.i_reg_rd("0x2ee", "0", "0")
+    assert ins.periph_sel == 2
+    assert ins.addr == 0xee
+
+    ins.all = opcodes.i_reg_rd("0x3ff", "0", "0")
+    assert ins.periph_sel == 3
+    assert ins.addr == 0xff
+
+    # anything bigger than 0x3ff must be a valid full address
+    assert_raises(ValueError, opcodes.i_reg_rd, "0x400", "0", "0")
+
+
+def test_reg_address_translations():
+    """
+    Test addressing of peripheral registers using full DPORT bus addresses
+    """
+
+    ins = make_ins("""
+    addr : 8        # Address within either RTC_CNTL, RTC_IO, or SARADC
+    periph_sel : 2  # Select peripheral: RTC_CNTL (0), RTC_IO(1), SARADC(2)
+    unused : 8      # Unused
+    low : 5         # Low bit
+    high : 5        # High bit
+    opcode : 4      # Opcode (OPCODE_RD_REG)
+    """)
+
+    # direct ULP address is derived from full address as follows:
+    # full:0x3ff484a8 == ulp:(0x3ff484a8-DR_REG_RTCCNTL_BASE) / 4
+    # full:0x3ff484a8 == ulp:(0x3ff484a8-0x3ff48000) / 4
+    # full:0x3ff484a8 == ulp:0x4a8 / 4
+    # full:0x3ff484a8 == ulp:0x12a
+    # see: https://github.com/espressif/binutils-esp32ulp/blob/249ec34/gas/config/tc-esp32ulp_esp32.c#L149
+    ins.all = opcodes.i_reg_rd("0x3ff484a8", "0", "0")
+    assert ins.periph_sel == 1  # high 2 bits of 0x12a
+    assert ins.addr == 0x2a  # low 8 bits of 0x12a
+
+
 test_make_ins_struct_def()
 test_make_ins()
 test_arg_qualify()
 test_get_reg()
 test_get_imm()
 test_get_cond()
-test_eval_arg()
+test_eval_arg()
+test_reg_direct_ulp_addressing()
+test_reg_address_translations()