fixes, added hex documentation and firmware dump

Author: FabriceSalvaire

.gitignore

@@ -8,3 +8,11 @@ MANIFEST
 PySimAvr/Core/parser.out
 PySimAvr/Core/parsetab.py
 doc/sphinx/build/
+#
+data/blink-led/.build_ano/
+data/blink-led/asm/
+data/blink-led/ino-env
+data/blink-led/make-asm
+data/blink-led/make.log
+data/blink-led/sketch/
+data/blink-led/trash/

PySimAvr/Avr/__init__.py

@@ -18,6 +18,15 @@
 #
 ####################################################################################################
 
+"""Load AVR Instruction Set from YAML file.
+"""
+
+# Fixme:
+# and: & ∧ •
+# or: | ∨ +
+# xor: ^ ⊻ ⊗
+# not: ! ¬
+
 ####################################################################################################
 
 __all__ = ['instruction_set']

PySimAvr/Avr/opcodes.yml

@@ -122,7 +122,7 @@ BRCC:
  description: Branch if Carry Cleared
  alias_of: BRBC
  alias_substitution: s = 0
- 
+
 BRCS:
  description: Branch if Carry Set
  alias_of: BRBS
@@ -325,8 +325,8 @@ CLZ:
  alias_substitution: s = 1
 
 COM:
- description: One's Complement
- alternate: One\u2019s Complement
+ description: One s Complement
+ alternate: One s Complement
  operations:
  -
  opcode: 1001 010d dddd 0000
@@ -679,8 +679,8 @@ MULSU:
  cycles: 2
 
 NEG:
- description: Two's Complement
- alternate: Two\u2019s Complement
+ description: Two s Complement
+ alternate: Two s Complement
  operations:
  -
  opcode: 1001 010d dddd 0001
@@ -789,7 +789,7 @@ ROL:
  alternate: Rotate Left Through Carry
  alias_of: ADC
  alias_substitution: Rr = Rd
- 
+
 ROR:
  description: Rotate Right through Carry
  alternate: Rotate Right Through Carry

PySimAvr/BinaryFormat/HexFile.py

@@ -18,6 +18,11 @@
 #
 ####################################################################################################
 
+"""Read Intel HEX file format
+
+See https://en.wikipedia.org/wiki/Intel_HEX
+"""
+
 ####################################################################################################
 
 import logging
@@ -34,7 +39,7 @@
 
 ####################################################################################################
 
-class HexFile(object):
+class HexFile:
 
  _logger = _module_logger.getChild('Hex')
 

PySimAvr/Core/CoreHdlParser.py

@@ -204,8 +204,12 @@ def t_DECIMAL_NUMBER(self, t):
  )
 
  def p_error(self, p):
- self._logger.error("Syntax error at '%s'", p.value)
- raise NameError('Parser error')
+ if p:
+ self._logger.error("Syntax error at '%s'", p.value)
+ raise NameError('Syntax Error')
+ else:
+ self._logger.error("Syntax Error at End Of File")
+ raise NameError("Syntax Error at End Of File" )
 
  start = 'program'
 

bin/read-firmwares.py

@@ -20,12 +20,31 @@
 #
 ####################################################################################################
 
-# Fixme:
+"""Read a firmware in Intel HEX format and dump disassembled instructions.
+
+How to disassemble using GNU Binutils::
+
+ avr-objdump -D --prefix-addresses firmware.elf
+ avr-objdump -d -j .sec1 -m avr6 firmware.hex
+"""
+
+####################################################################################################
+
+# Fixme: End of program issue
+#
 # 0x066E: 0xCFFF
 # RJMP 1100 kkkk kkkk kkkk
 # {'k': 4095}
 # 0x0670: 0x000D
 # Illegal instruction
+#
+# objdump output is:
+#
+# 66a:	f8 94	cli
+# 66c:	ff cf	rjmp	.-2	; 0x66c
+# 66e:	0d 00	.word	0x000d	; ????
+
+# Fixme: What is this word ???
 
 ####################################################################################################
 
@@ -35,7 +54,11 @@
 
 ####################################################################################################
 
+# Fixme: use argparse ...
 path = 'data/blink-led-mega2560-firmware.hex'
+
+####################################################################################################
+
 hex_file = HexFile(path)
 
 decision_tree = instruction_set.decision_tree
@@ -58,5 +81,3 @@
  print(' ', opcode.decode(bytecode))
  except DecodeError:
  print(" Illegal instruction")
-
-# avr-objdump -D --prefix-addresses firmware.elf

bin/test-core-hdl-parser.py

@@ -20,28 +20,10 @@
 #
 ####################################################################################################
 
-# Fixme: <- is not implemented in parser ???
-#
-# Generating LALR tables
-# WARNING: 7 shift/reduce conflicts
-#
-# ================================================================================
-# 1 : C <- 0
-# 2017-05-21 14:31:19,562 - PySimAvr.Core.CoreHdlParser.Parser - CoreHdlParser.p_error - ERROR - Syntax error at '<'
-# Traceback (most recent call last):
-# File "bin/test-core-hdl-parser.py", line 50, in <module>
-# program = parser.parse(line)
-# File "/home/fabrice/home/developpement/PySimAvr/PySimAvr/Core/CoreHdlParser.py", line 417, in parse
-# self._parser.parse(text, lexer=self._lexer)
-# File "/opt/python-virtual-env/py35/lib/python3.5/site-packages/ply/yacc.py", line 331, in parse
-# return self.parseopt_notrack(input, lexer, debug, tracking, tokenfunc)
-# File "/opt/python-virtual-env/py35/lib/python3.5/site-packages/ply/yacc.py", line 1199, in parseopt_notrack
-# tok = call_errorfunc(self.errorfunc, errtoken, self)
-# File "/opt/python-virtual-env/py35/lib/python3.5/site-packages/ply/yacc.py", line 193, in call_errorfunc
-# r = errorfunc(token)
-# File "/home/fabrice/home/developpement/PySimAvr/PySimAvr/Core/CoreHdlParser.py", line 208, in p_error
-# raise NameError('Parser error')
-# NameError: Parser error
+"""Test the HDL parser for instruction operations.
+"""
+
+# Fixme: Some operations are supported !!!
 
 ####################################################################################################
 #
@@ -70,6 +52,9 @@
  print(line_number, ':', line)
  # print()
  # parser.test_lexer(line)
- program = parser.parse(line)
+ # try:
+ program = parser.parse(line + ';')
  print()
  print(program)
+ # except:
+ # print("Parse error")

bin/test-core.py

@@ -104,12 +104,20 @@
  R2 = 4;
 Y = 23;
 '''
+
+
+rule = '\n' + '-'*100 + '\n'
+
 print(source)
+
 # micro_code_parser.test_lexer(source)
+
 ast_program = micro_code_parser.parse(source)
+
 # print()
 # print(ast_program)
-print()
+
+print(rule)
 core.run_ast_program(ast_program)
 
 print(ram[:10])

bin/test-hex-file.py

@@ -18,6 +18,9 @@
 #
 ####################################################################################################
 
+"""Test the bytecode decoder.
+"""
+
 ####################################################################################################
 
 from PySimAvr.Avr import instruction_set
@@ -137,6 +140,8 @@
 # Bytecode Interval (but code is wrong)
 #
 
+# Fixme: what means (but code is wrong) ???
+
 if True:
  bytecode_interval_pool = []
  for instruction in instruction_set.iter_on_instructions():