v.0.8.13 Now supporting the SREC format.

Milo-D · Sep 6, 2021 · 7c5ff52 · 7c5ff52
1 parent cc5a237
commit 7c5ff52
Show file tree

Hide file tree

Showing 42 changed files with 375 additions and 208 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 # Unreleased
 
+- nothing to log
+
+# v.0.8.13 - 2021-09-06
+
+- Now supporting Motorola SRecord
+
+- merged pull-request (#68) from pointbazaar (Alexander Hansen)
+  - added format reader for motorola hex (SRecord)
+  - thanks for that :)
+
+- refactored srec format reader (PR #68)
+  - adjusted style
+  - fixed some minor bugs
+
+- connected srec format reader to pipeline
+
+- Important: file extension decides which reader will be invoked 
+  - *.hex  ==> invokes intel hex reader
+  - *.srec ==> invokes srec reader
+
 - added format reader interface (reader/reader.c)
   - reader for different file formats can be now added to reader/format/
     - for example reader/format/ihex.c to read the intel hex format

diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.hex", m328p);
 
     for(uint32_t i = 0; i < report->cfg->used; i++) {
         
@@ -127,7 +127,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.srec", m328p);
 
     for(uint32_t i = 0; i < report->progsize; i++) {
 
@@ -161,7 +161,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.hex", m328p);
 
     for(uint32_t i = 0; i < report->progsize; i++) {
 
@@ -195,7 +195,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.hex", m328p);
 
     for(uint32_t i = 0; i < report->n_vector; i++) {
 
@@ -237,7 +237,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.hex", m328p);
 
     for(uint32_t i = 0; i < report->n_label; i++) {
 
@@ -287,7 +287,7 @@ int main(const int argc, const char **argv) {
 
     /* ignoring checks for this example */
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
-    vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
+    vmcu_report_t *report = vmcu_analyze_file("file.hex", m328p);
 
     for(uint32_t i = 0; i < report->n_sfr; i++) {
 
@@ -510,7 +510,7 @@ take a look at engine/*/arch/
 
 - [ ] format reader
     - [x] intel hex
-    - [ ] motorola hex
+    - [x] motorola hex
     - [ ] bin
     - [ ] elf 
 

diff --git a/TODO.txt b/TODO.txt
@@ -32,6 +32,8 @@ These are a some of my ideas for the future of libvmcu
 [10] a python binding would be really great.
     [10.1] requires external contributors :( see CONTRIBUTING.txt
 
+[11] make libvmcu thread safe
+
 /********************************* Internal / Cleanup *****************************/
 
 [12] remove usage of basic integers (int) in libvmcu (nearly done)
@@ -41,3 +43,5 @@ These are a some of my ideas for the future of libvmcu
 [14] speed up controlflow analysis by adding a lookup table for the cfg nodes
 
 [15] fix inconsistency of xref-to
+
+[16] a consistent way to return readable error codes (not just -1 and 0)
diff --git a/driver/cfg/cfg.c b/driver/cfg/cfg.c
@@ -43,14 +43,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./skeleton <hexfile>\n");
+        printf("Usage: ./skeleton <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/disasm/disasm.c b/driver/disasm/disasm.c
@@ -64,15 +64,15 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./skeleton <hexfile>\n");
+        printf("Usage: ./skeleton <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
     uint32_t progsize = 0;
-    vmcu_instr_t *prog = vmcu_disassemble_ihex(argv[1], &progsize, m328p);
+    vmcu_instr_t *prog = vmcu_disassemble_file(argv[1], &progsize, m328p);
 
     if(prog == NULL || progsize == 0)
         return EXIT_FAILURE;

diff --git a/driver/endloop/endloop.c b/driver/endloop/endloop.c
@@ -41,12 +41,12 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./endloop <file.hex>\n");
+        printf("Usage: ./endloop <binary>\n");
         return EXIT_FAILURE;
     }
 
     vmcu_model_t *m328p   = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t *report = vmcu_analyze_ihex(argv[1], m328p);
+    vmcu_report_t *report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL) {
 

diff --git a/driver/findgroup/findgroup.c b/driver/findgroup/findgroup.c
@@ -41,14 +41,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 3) {
 
-        printf("Usage: ./findgroup <file.hex> <group>\n");
+        printf("Usage: ./findgroup <binary> <group>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/findisr/findisr.c b/driver/findisr/findisr.c
@@ -56,7 +56,7 @@ int main(const int argc, const char **argv) {
 
     if(argc < 2) {
 
-        printf("Usage: ./findisr <hexfile>\n");
+        printf("Usage: ./findisr <binary>\n");
         return EXIT_FAILURE;
     }
 
@@ -76,7 +76,7 @@ int main(const int argc, const char **argv) {
     const char* filename = argv[argc-1];
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
-    if((report = vmcu_analyze_ihex(filename, m328p)) == NULL)
+    if((report = vmcu_analyze_file(filename, m328p)) == NULL)
         return EXIT_FAILURE;
 
     uint32_t start_index = 0;

diff --git a/driver/graph/graph.c b/driver/graph/graph.c
@@ -65,12 +65,12 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./cfg <hexfile>\n");
+        printf("Usage: ./cfg <binary>\n");
         return EXIT_FAILURE;
     }
 
     vmcu_model_t* m328p   = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t* report = vmcu_analyze_ihex(argv[1], m328p);
+    vmcu_report_t* report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/labels/labels.c b/driver/labels/labels.c
@@ -18,12 +18,12 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./labels <file.hex>\n");
+        printf("Usage: ./labels <binary>\n");
         return EXIT_FAILURE;
     }
 
     vmcu_model_t *m328p   = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t *report = vmcu_analyze_ihex(argv[1], m328p);
+    vmcu_report_t *report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL) {
 

diff --git a/driver/led/ledtest.c b/driver/led/ledtest.c
@@ -40,7 +40,7 @@ int main(const int argc, const char **argv) {
     if((m328p = vmcu_model_ctor(VMCU_DEVICE_M328P)) == NULL)
         return EXIT_FAILURE;
 
-    if((report = vmcu_analyze_ihex(TESTFILE, m328p)) == NULL)
+    if((report = vmcu_analyze_file(TESTFILE, m328p)) == NULL)
         return EXIT_FAILURE;
 
     if((sys = vmcu_system_ctor(report)) == NULL)

diff --git a/driver/occurence/occurence.c b/driver/occurence/occurence.c
@@ -64,7 +64,7 @@ void bubblesort(void **array, int length, int (*compar)(const void *, const void
 int main(int argc, char* argv[]) {
 
     if(argc != 2) {
-        printf("Expected hex file argument. exiting.\n");
+        printf("Expected binary file as argument. exiting.\n");
         return 1;
     }
 
@@ -73,7 +73,7 @@ int main(int argc, char* argv[]) {
     const char* fname = argv[argc-1];
 
     vmcu_model_t* m328p   = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t* report = vmcu_analyze_ihex(fname, m328p);
+    vmcu_report_t* report = vmcu_analyze_file(fname, m328p);
 
     if(report == NULL) {
 

diff --git a/driver/rwaccess/rwaccess.c b/driver/rwaccess/rwaccess.c
@@ -26,14 +26,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./rwaccess <hexfile>\n");
+        printf("Usage: ./rwaccess <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/sca/sca.c b/driver/sca/sca.c
@@ -94,13 +94,13 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./sca <file.hex>\n");
+        printf("Usage: ./sca <binary>\n");
         return EXIT_FAILURE;
     }
 
     vmcu_model_t *m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
-    vmcu_report_t *report = vmcu_analyze_ihex(FILE, m328p);
+    vmcu_report_t *report = vmcu_analyze_file(FILE, m328p);
     vmcu_system_t *sys    = vmcu_system_ctor(report);
 
     char cracked[LENGTH] = "";

diff --git a/driver/sfr/sfr.c b/driver/sfr/sfr.c
@@ -21,12 +21,12 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./sfr <hexfile>\n");
+        printf("Usage: ./sfr <binary>\n");
         return EXIT_FAILURE;
     }
 
     vmcu_model_t *m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    vmcu_report_t *report = vmcu_analyze_ihex(argv[1], m328p);
+    vmcu_report_t *report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL) {
 

diff --git a/driver/skeleton/skeleton.c b/driver/skeleton/skeleton.c
@@ -27,14 +27,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./skeleton <hexfile>\n");
+        printf("Usage: ./skeleton <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/speed/speed.c b/driver/speed/speed.c
@@ -33,14 +33,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./speed <hexfile>\n");
+        printf("Usage: ./speed <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/stepper/stepper.c b/driver/stepper/stepper.c
@@ -49,14 +49,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./skeleton <hexfile>\n");
+        printf("Usage: ./skeleton <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/strings/strings.c b/driver/strings/strings.c
@@ -27,14 +27,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./strings <hexfile>\n");
+        printf("Usage: ./strings <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;

diff --git a/driver/vcdump/vcdump.c b/driver/vcdump/vcdump.c
@@ -33,7 +33,7 @@ int main(const int argc, const char **argv) {
 
     if(argc < 4) {
 
-        printf("Usage: ./vcdump <hexfile> <cycles> <values to be monitored>+\n");
+        printf("Usage: ./vcdump <binary> <cycles> <values to be monitored>+\n");
         return EXIT_FAILURE;
     }
 
@@ -53,7 +53,7 @@ int main(const int argc, const char **argv) {
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
-    if((report = vmcu_analyze_ihex(filename, m328p)) == NULL)
+    if((report = vmcu_analyze_file(filename, m328p)) == NULL)
         return EXIT_FAILURE;
 
     sys = vmcu_system_ctor(report);

diff --git a/driver/vector/vector.c b/driver/vector/vector.c
@@ -25,14 +25,14 @@ int main(const int argc, const char **argv) {
 
     if(argc != 2) {
 
-        printf("Usage: ./vector <hexfile>\n");
+        printf("Usage: ./vector <binary>\n");
         return EXIT_FAILURE;
     }
 
     atexit(cleanup);
 
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
-    report = vmcu_analyze_ihex(argv[1], m328p);
+    report = vmcu_analyze_file(argv[1], m328p);
 
     if(report == NULL)
         return EXIT_FAILURE;