AVR support

CMakeLists.txt

@@ -86,7 +86,7 @@ option(UNICORN_FUZZ "Enable fuzzing" OFF)
 option(UNICORN_LOGGING "Enable logging" OFF)
 option(UNICORN_BUILD_TESTS "Build unicorn tests" ${PROJECT_IS_TOP_LEVEL})
 option(UNICORN_INSTALL "Enable unicorn installation" ${PROJECT_IS_TOP_LEVEL})
-set(UNICORN_ARCH "x86;arm;aarch64;riscv;mips;sparc;m68k;ppc;s390x;tricore" CACHE STRING "Enabled unicorn architectures")
+set(UNICORN_ARCH "x86;arm;aarch64;riscv;mips;sparc;m68k;ppc;s390x;tricore;avr" CACHE STRING "Enabled unicorn architectures")
 option(UNICORN_TRACER "Trace unicorn execution" OFF)
 
 foreach(ARCH_LOOP ${UNICORN_ARCH})
@@ -273,6 +273,11 @@ else()
                 set(UNICORN_TARGET_ARCH "tricore")
                 break()
             endif()
+            string(FIND ${UC_COMPILER_MACRO} "__AVR__" UC_RET)
+            if (${UC_RET} GREATER_EQUAL "0")
+                set(UNICORN_TARGET_ARCH "avr")
+                break()
+            endif()
             message(FATAL_ERROR "Unknown host compiler: ${CMAKE_C_COMPILER}.")
         endwhile(TRUE)
     endif()
@@ -308,6 +313,9 @@ else()
     if (UNICORN_HAS_TRICORE)
         set (EXTRA_CFLAGS "${EXTRA_CFLAGS}-DUNICORN_HAS_TRICORE ")
     endif()
+    if (UNICORN_HAS_AVR)
+        set (EXTRA_CFLAGS "${EXTRA_CFLAGS}-DUNICORN_HAS_AVR ")
+    endif()
 
     set(EXTRA_CFLAGS "${EXTRA_CFLAGS}-fPIC")
     if(ANDROID_ABI)
@@ -359,6 +367,9 @@ else()
     if (UNICORN_HAS_TRICORE)
         set (TARGET_LIST "${TARGET_LIST}tricore-softmmu, ")
     endif()
+    if (UNICORN_HAS_AVR)
+        set (TARGET_LIST "${TARGET_LIST}avr-softmmu, ")
+    endif()
     set(TARGET_LIST "${TARGET_LIST} ")
 
     # GEN config-host.mak & target directories
@@ -456,6 +467,12 @@ else()
             OUTPUT_FILE ${CMAKE_BINARY_DIR}/tricore-softmmu/config-target.h
         )
     endif()
+    if (UNICORN_HAS_AVR)
+        execute_process(COMMAND sh ${CMAKE_CURRENT_SOURCE_DIR}/qemu/scripts/create_config
+            INPUT_FILE ${CMAKE_BINARY_DIR}/avr-softmmu/config-target.mak
+            OUTPUT_FILE ${CMAKE_BINARY_DIR}/avr-softmmu/config-target.h
+        )
+    endif()
     add_compile_options(
         ${UNICORN_CFLAGS}
         -I${CMAKE_CURRENT_SOURCE_DIR}/qemu/tcg/${UNICORN_TARGET_ARCH}
@@ -1154,6 +1171,34 @@ endif()
 endif()
 
 
+if (UNICORN_HAS_AVR)
+add_library(avr-softmmu STATIC
+    ${UNICORN_ARCH_COMMON}
+
+    qemu/target/avr/cpu.c
+    qemu/target/avr/helper.c
+    qemu/target/avr/translate.c
+    qemu/target/avr/unicorn.c
+)
+
+if(MSVC)
+    target_compile_options(avr-softmmu PRIVATE
+        -DNEED_CPU_H
+        /FIavr.h
+        /I${CMAKE_CURRENT_SOURCE_DIR}/msvc/avr-softmmu
+        /I${CMAKE_CURRENT_SOURCE_DIR}/qemu/target/avr
+    )
+else()
+    target_compile_options(avr-softmmu PRIVATE
+        -DNEED_CPU_H
+        -include avr.h
+        -I${CMAKE_BINARY_DIR}/avr-softmmu
+        -I${CMAKE_CURRENT_SOURCE_DIR}/qemu/target/avr
+    )
+endif()
+endif()
+
+
 set(UNICORN_SRCS
     uc.c
 
@@ -1328,6 +1373,13 @@ if (UNICORN_HAS_TRICORE)
     target_link_libraries(tricore-softmmu unicorn-common)
     set(UNICORN_TEST_FILE ${UNICORN_TEST_FILE} test_tricore)
 endif()
+if (UNICORN_HAS_AVR)
+    set(UNICORN_COMPILE_OPTIONS ${UNICORN_COMPILE_OPTIONS} -DUNICORN_HAS_AVR)
+    set(UNICORN_LINK_LIBRARIES ${UNICORN_LINK_LIBRARIES} avr-softmmu)
+    set(UNICORN_SAMPLE_FILE ${UNICORN_SAMPLE_FILE} sample_avr)
+    target_link_libraries(avr-softmmu unicorn-common)
+    set(UNICORN_TEST_FILE ${UNICORN_TEST_FILE} test_avr)
+endif()
 
 # Extra tests
 set(UNICORN_TEST_FILE ${UNICORN_TEST_FILE} test_mem)

CREDITS.TXT

@@ -81,3 +81,4 @@ Ziqiao Kong (lazymio): uc_context_free() API and various bug fix & improvement.
 Sven Almgren (blindmatrix): bug fix
 Chenxu Wu (kabeor): Documentation
 Philipp Takacs: virtual tlb, memory snapshots
+Glenn Baker: AVR architecture support

Cargo.toml

@@ -42,7 +42,7 @@ pkg-config = { version = "0.3" }
 [features]
 default = ["arch_all"]
 dynamic_linkage = []
-arch_all = ["arch_x86", "arch_arm", "arch_aarch64", "arch_riscv", "arch_mips", "arch_sparc", "arch_m68k", "arch_ppc", "arch_s390x", "arch_tricore"]
+arch_all = ["arch_x86", "arch_arm", "arch_aarch64", "arch_riscv", "arch_mips", "arch_sparc", "arch_m68k", "arch_ppc", "arch_s390x", "arch_tricore", "arch_avr"]
 arch_x86 = []
 arch_arm = []
 # NOTE: unicorn-c only separates on top-level arch name,
@@ -55,3 +55,4 @@ arch_m68k = []
 arch_ppc = []
 arch_s390x = []
 arch_tricore = []
+arch_avr = []

README.md

@@ -13,7 +13,7 @@ Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framew
 
 Unicorn offers some unparalleled features:
 
-- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, PowerPC, RISCV, SPARC, S390X, TriCore and X86 (16, 32, 64-bit)
+- Multi-architecture: ARM, ARM64 (ARMv8), AVR, M68K, MIPS, PowerPC, RISCV, SPARC, S390X, TriCore and X86 (16, 32, 64-bit)
 - Clean/simple/lightweight/intuitive architecture-neutral API
 - Implemented in pure C language, with bindings for Crystal, Clojure, Visual Basic, Perl, Rust, Ruby, Python, Java, .NET, Go, Delphi/Free Pascal, Haskell, Pharo, Lua and Zig.
 - Native support for Windows & *nix (with Mac OSX, Linux, Android, *BSD & Solaris confirmed)

bindings/const_generator.py

@@ -6,7 +6,7 @@
 
 INCL_DIR = os.path.join('..', 'include', 'unicorn')
 
-include = [ 'arm.h', 'arm64.h', 'mips.h', 'x86.h', 'sparc.h', 'm68k.h', 'ppc.h', 'riscv.h', 's390x.h', 'tricore.h', 'unicorn.h' ]
+include = [ 'arm.h', 'arm64.h', 'avr.h', 'mips.h', 'x86.h', 'sparc.h', 'm68k.h', 'ppc.h', 'riscv.h', 's390x.h', 'tricore.h', 'unicorn.h' ]
 
 template = {
     'python': {
@@ -17,6 +17,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'arm',
             'arm64.h': 'arm64',
+            'avr.h': 'avr',
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
@@ -37,6 +38,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'arm',
             'arm64.h': 'arm64',
+            'avr.h': 'avr',
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
@@ -57,6 +59,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'arm',
             'arm64.h': 'arm64',
+            'avr.h': 'avr',
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
@@ -77,6 +80,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'Arm',
             'arm64.h': 'Arm64',
+            'avr.h': 'AVR',
             'mips.h': 'Mips',
             'x86.h': 'X86',
             'sparc.h': 'Sparc',
@@ -97,6 +101,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'Arm',
             'arm64.h': 'Arm64',
+            'avr.h': 'AVR',
             'mips.h': 'Mips',
             'x86.h': 'X86',
             'sparc.h': 'Sparc',
@@ -117,6 +122,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'Arm',
             'arm64.h': 'Arm64',
+            'avr.h': 'AVR',
             'mips.h': 'Mips',
             'x86.h': 'X86',
             'sparc.h': 'Sparc',
@@ -137,6 +143,7 @@
             # prefixes for constant filenames of all archs - case sensitive
             'arm.h': 'arm',
             'arm64.h': 'arm64',
+            'avr.h': 'AVR',
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',

bindings/dotnet/UnicornEngine/Const/AVR.fs

@@ -0,0 +1,155 @@
+// For Unicorn Engine. AUTO-GENERATED FILE, DO NOT EDIT
+
+namespace UnicornEngine.Const
+
+open System
+
+[<AutoOpen>]
+module AVR =
+
+    // AVR architectures
+    let UC_AVR_ARCH_AVR1 = 10
+    let UC_AVR_ARCH_AVR2 = 20
+    let UC_AVR_ARCH_AVR25 = 25
+    let UC_AVR_ARCH_AVR3 = 30
+    let UC_AVR_ARCH_AVR4 = 40
+    let UC_AVR_ARCH_AVR5 = 50
+    let UC_AVR_ARCH_AVR51 = 51
+    let UC_AVR_ARCH_AVR6 = 60
+    let UC_CPU_AVR_ARCH = 1000
+
+    // AVR CPU
+    let UC_CPU_AVR_ATMEGA16 = 50016
+    let UC_CPU_AVR_ATMEGA32 = 50032
+    let UC_CPU_AVR_ATMEGA64 = 50064
+    let UC_CPU_AVR_ATMEGA128 = 51128
+    let UC_CPU_AVR_ATMEGA128RFR2 = 51129
+    let UC_CPU_AVR_ATMEGA1280 = 51130
+    let UC_CPU_AVR_ATMEGA256 = 60256
+    let UC_CPU_AVR_ATMEGA256RFR2 = 60257
+    let UC_CPU_AVR_ATMEGA2560 = 60258
+
+    // AVR memory
+    let UC_AVR_MEM_FLASH = 134217728
+
+    // AVR registers
+
+    let UC_AVR_REG_INVALID = 0
+    let UC_AVR_REG_R0 = 1
+    let UC_AVR_REG_R1 = 2
+    let UC_AVR_REG_R2 = 3
+    let UC_AVR_REG_R3 = 4
+    let UC_AVR_REG_R4 = 5
+    let UC_AVR_REG_R5 = 6
+    let UC_AVR_REG_R6 = 7
+    let UC_AVR_REG_R7 = 8
+    let UC_AVR_REG_R8 = 9
+    let UC_AVR_REG_R9 = 10
+    let UC_AVR_REG_R10 = 11
+    let UC_AVR_REG_R11 = 12
+    let UC_AVR_REG_R12 = 13
+    let UC_AVR_REG_R13 = 14
+    let UC_AVR_REG_R14 = 15
+    let UC_AVR_REG_R15 = 16
+    let UC_AVR_REG_R16 = 17
+    let UC_AVR_REG_R17 = 18
+    let UC_AVR_REG_R18 = 19
+    let UC_AVR_REG_R19 = 20
+    let UC_AVR_REG_R20 = 21
+    let UC_AVR_REG_R21 = 22
+    let UC_AVR_REG_R22 = 23
+    let UC_AVR_REG_R23 = 24
+    let UC_AVR_REG_R24 = 25
+    let UC_AVR_REG_R25 = 26
+    let UC_AVR_REG_R26 = 27
+    let UC_AVR_REG_R27 = 28
+    let UC_AVR_REG_R28 = 29
+    let UC_AVR_REG_R29 = 30
+    let UC_AVR_REG_R30 = 31
+    let UC_AVR_REG_R31 = 32
+    let UC_AVR_REG_PC = 33
+    let UC_AVR_REG_SP = 34
+    let UC_AVR_REG_RAMPD = 57
+    let UC_AVR_REG_RAMPX = 58
+    let UC_AVR_REG_RAMPY = 59
+    let UC_AVR_REG_RAMPZ = 60
+    let UC_AVR_REG_EIND = 61
+    let UC_AVR_REG_SPL = 62
+    let UC_AVR_REG_SPH = 63
+    let UC_AVR_REG_SREG = 64
+
+    // 16-bit coalesced registers
+    let UC_AVR_REG_R0W = 65
+    let UC_AVR_REG_R1W = 66
+    let UC_AVR_REG_R2W = 67
+    let UC_AVR_REG_R3W = 68
+    let UC_AVR_REG_R4W = 69
+    let UC_AVR_REG_R5W = 70
+    let UC_AVR_REG_R6W = 71
+    let UC_AVR_REG_R7W = 72
+    let UC_AVR_REG_R8W = 73
+    let UC_AVR_REG_R9W = 74
+    let UC_AVR_REG_R10W = 75
+    let UC_AVR_REG_R11W = 76
+    let UC_AVR_REG_R12W = 77
+    let UC_AVR_REG_R13W = 78
+    let UC_AVR_REG_R14W = 79
+    let UC_AVR_REG_R15W = 80
+    let UC_AVR_REG_R16W = 81
+    let UC_AVR_REG_R17W = 82
+    let UC_AVR_REG_R18W = 83
+    let UC_AVR_REG_R19W = 84
+    let UC_AVR_REG_R20W = 85
+    let UC_AVR_REG_R21W = 86
+    let UC_AVR_REG_R22W = 87
+    let UC_AVR_REG_R23W = 88
+    let UC_AVR_REG_R24W = 89
+    let UC_AVR_REG_R25W = 90
+    let UC_AVR_REG_R26W = 91
+    let UC_AVR_REG_R27W = 92
+    let UC_AVR_REG_R28W = 93
+    let UC_AVR_REG_R29W = 94
+    let UC_AVR_REG_R30W = 95
+
+    // 32-bit coalesced registers
+    let UC_AVR_REG_R0D = 97
+    let UC_AVR_REG_R1D = 98
+    let UC_AVR_REG_R2D = 99
+    let UC_AVR_REG_R3D = 100
+    let UC_AVR_REG_R4D = 101
+    let UC_AVR_REG_R5D = 102
+    let UC_AVR_REG_R6D = 103
+    let UC_AVR_REG_R7D = 104
+    let UC_AVR_REG_R8D = 105
+    let UC_AVR_REG_R9D = 106
+    let UC_AVR_REG_R10D = 107
+    let UC_AVR_REG_R11D = 108
+    let UC_AVR_REG_R12D = 109
+    let UC_AVR_REG_R13D = 110
+    let UC_AVR_REG_R14D = 111
+    let UC_AVR_REG_R15D = 112
+    let UC_AVR_REG_R16D = 113
+    let UC_AVR_REG_R17D = 114
+    let UC_AVR_REG_R18D = 115
+    let UC_AVR_REG_R19D = 116
+    let UC_AVR_REG_R20D = 117
+    let UC_AVR_REG_R21D = 118
+    let UC_AVR_REG_R22D = 119
+    let UC_AVR_REG_R23D = 120
+    let UC_AVR_REG_R24D = 121
+    let UC_AVR_REG_R25D = 122
+    let UC_AVR_REG_R26D = 123
+    let UC_AVR_REG_R27D = 124
+    let UC_AVR_REG_R28D = 125
+
+    // Alias registers
+    let UC_AVR_REG_Xhi = 28
+    let UC_AVR_REG_Xlo = 27
+    let UC_AVR_REG_Yhi = 30
+    let UC_AVR_REG_Ylo = 29
+    let UC_AVR_REG_Zhi = 32
+    let UC_AVR_REG_Zlo = 31
+    let UC_AVR_REG_X = 91
+    let UC_AVR_REG_Y = 93
+    let UC_AVR_REG_Z = 95
+

bindings/dotnet/UnicornEngine/Const/Common.fs

@@ -28,7 +28,8 @@ module Common =
     let UC_ARCH_RISCV = 8
     let UC_ARCH_S390X = 9
     let UC_ARCH_TRICORE = 10
-    let UC_ARCH_MAX = 11
+    let UC_ARCH_AVR = 11
+    let UC_ARCH_MAX = 12
 
     let UC_MODE_LITTLE_ENDIAN = 0
     let UC_MODE_BIG_ENDIAN = 1073741824