Added missing esp32/tools/pypic.py

Added missing esp32/tools/pypic.py

Author: Christian Ehlers

esp32/tools/pypic.py

@@ -0,0 +1,185 @@
+#!/usr/bin/env python
+
+from __future__ import print_function
+
+import sys
+import argparse
+import errno
+import serial
+import struct
+import time
+
+__version__ = '0.9.1'
+
+CMD_PEEK = (0x0)
+CMD_POKE = (0x01)
+CMD_MAGIC = (0x02)
+CMD_HW_VER = (0x10)
+CMD_FW_VER = (0x11)
+CMD_PROD_ID = (0x12)
+CMD_SETUP_SLEEP = (0x20)
+CMD_GO_SLEEP = (0x21)
+CMD_CALIBRATE = (0x22)
+CMD_BAUD_CHANGE = (0x30)
+CMD_DFU = (0x31)
+
+ANSELA_ADDR = (0x18C)
+ANSELB_ADDR = (0x18D)
+ANSELC_ADDR = (0x18E)
+
+ADCON0_ADDR = (0x9D)
+ADCON1_ADDR = (0x9E)
+
+IOCAP_ADDR = (0x391)
+IOCAN_ADDR = (0x392)
+
+_ADCON0_CHS_POSN = (0x02)
+_ADCON0_ADON_MASK = (0x01)
+_ADCON1_ADCS_POSN = (0x04)
+_ADCON0_GO_nDONE_MASK = (0x02)
+
+ADRESL_ADDR = (0x09B)
+ADRESH_ADDR = (0x09C)
+
+TRISC_ADDR = (0x08E)
+
+PORTA_ADDR = (0x00C)
+PORTC_ADDR = (0x00E)
+
+WPUA_ADDR = (0x20C)
+
+PCON_ADDR = (0x096)
+STATUS_ADDR = (0x083)
+
+
+# helper functions
+def eprint(*args, **kwargs):
+    print(*args, file=sys.stderr, **kwargs)
+
+def log(*args):
+    print(' '.join(str(a) for a in args))
+
+def error(msg):
+    eprint('error:', msg)
+
+def exit_with_error(code, msg):
+    error(msg)
+    sys.exit(code)
+
+def warn(msg):
+    eprint('warning:', msg)
+
+
+class Pypic:
+
+    def __init__(self, port):
+        # we need bytesize to be 5 bits in order for the PIC to process the commands
+        self.serial = serial.Serial(port, baudrate=115200, bytesize=serial.FIVEBITS, timeout=0.25)
+        self.detected = False
+
+        try:
+            if self.read_fw_version() < 6:
+                raise ValueError('PIC firmware out of date')
+            else:
+                self.detected = True
+        except Exception:
+            pass
+
+    def _write(self, data, read=True):
+        self.serial.write(data)
+        if read:
+            r_data = self.serial.read(2)
+            if not r_data:
+                raise Exception('Timeout while waiting for Rx data')
+            return struct.unpack('B', r_data[0])[0]
+
+    def _send_cmd(self, cmd):
+        return self._write(bytearray([cmd]))
+
+    def read_hw_version(self):
+        return self._send_cmd(CMD_HW_VER)
+
+    def read_fw_version(self):
+        return self._send_cmd(CMD_FW_VER)
+
+    def read_product_id(self):
+        return self._send_cmd(CMD_PROD_ID)
+
+    def peek_memory(self, addr):
+        return self._write(bytearray([CMD_PEEK, addr & 0xFF, (addr >> 8) & 0xFF]))
+
+    def poke_memory(self, addr, value):
+         self._write(bytearray([CMD_POKE, addr & 0xFF, (addr >> 8) & 0xFF, value & 0xFF]), False)
+
+    def magic_write_read(self, addr, _and=0xFF, _or=0, _xor=0):
+        return self._write(bytearray([CMD_MAGIC, addr & 0xFF, (addr >> 8) & 0xFF, _and & 0xFF, _or & 0xFF, _xor & 0xFF]))
+
+    def magic_write(self, addr, _and=0xFF, _or=0, _xor=0):
+        self._write(bytearray([CMD_MAGIC, addr & 0xFF, (addr >> 8) & 0xFF, _and & 0xFF, _or & 0xFF, _xor & 0xFF]), False)
+
+    def toggle_bits_in_memory(self, addr, bits):
+        self.magic_write(addr, _xor=bits)
+
+    def mask_bits_in_memory(self, addr, mask):
+        self.magic_write(addr, _and=mask)
+
+    def set_bits_in_memory(self, addr, bits):
+        self.magic_write(addr, _or=bits)
+
+    def reset_pycom_module(self):
+        # make RC5 an output
+        self.mask_bits_in_memory(TRISC_ADDR, ~(1 << 5))
+        # drive RC5 low
+        self.mask_bits_in_memory(PORTC_ADDR, ~(1 << 5))
+        time.sleep(0.25)
+        # drive RC5 high
+        self.set_bits_in_memory(PORTC_ADDR, 1 << 5)
+        time.sleep(0.1)
+
+    def enter_pycom_programming_mode(self):
+        # make RC0 an output
+        self.mask_bits_in_memory(TRISC_ADDR, ~(1 << 0))
+        # set RC0 low
+        self.mask_bits_in_memory(PORTC_ADDR, ~(1 << 0))
+        self.reset_pycom_module()
+
+    def exit_pycom_programming_mode(self):
+        # make RC0 an output
+        self.mask_bits_in_memory(TRISC_ADDR, ~(1 << 0))
+        # set RC0 high
+        self.set_bits_in_memory(PORTC_ADDR, 1 << 0)
+        self.reset_pycom_module()
+
+    def isdetected(self):
+        return self.detected
+
+    def close(self):
+        self.serial.close()
+
+
+def main(args):
+    parser = argparse.ArgumentParser(description='Sends internal commands to pu the Pycom module in programming mode')
+    parser.add_argument('-p', '--port', metavar='PORT', help='the serial port used to communicate with the PIC')
+    parser.add_argument('--enter', action='store_true', help='enter programming mode')
+    parser.add_argument('--exit', action='store_true', help='exit programming mode')
+    args = parser.parse_args()
+
+    if not args.port:
+        exit_with_error(1, 'no serial port specified')
+
+    if (args.enter and args.exit) or (not args.enter and not args.exit):
+        exit_with_error(1, 'invalid action requested')
+
+    pic = Pypic(args.port)
+
+    if pic.isdetected():
+        if args.enter:
+            pic.enter_pycom_programming_mode()
+        elif args.exit:
+            pic.exit_pycom_programming_mode()
+
+    pic.close()
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))