Close the mcp2221 device before exit.

[hackapet/Adafruit_Blinka.git] / src / adafruit_blinka / microcontroller / mcp2221 / mcp2221.py

diff --git a/src/adafruit_blinka/microcontroller/mcp2221/mcp2221.py b/src/adafruit_blinka/microcontroller/mcp2221/mcp2221.py
index 619c70e7da879d1b4eec0858e65f7c8701db92d4..fb8193cc87ba9e518e573b744a71b6ecf8a382ef 100644 (file)
--- a/src/adafruit_blinka/microcontroller/mcp2221/mcp2221.py
+++ b/src/adafruit_blinka/microcontroller/mcp2221/mcp2221.py
@@ -2,17 +2,17 @@
 
 import os
 import time
 
 import os
 import time

+import atexit

 import hid
 
 # Here if you need it
 MCP2221_HID_DELAY = float(os.environ.get("BLINKA_MCP2221_HID_DELAY", 0))
 import hid
 
 # Here if you need it
 MCP2221_HID_DELAY = float(os.environ.get("BLINKA_MCP2221_HID_DELAY", 0))

-# Use to set delay between reset and device reopen
+# Use to set delay between reset and device reopen. if negative, don't reset at all

 MCP2221_RESET_DELAY = float(os.environ.get("BLINKA_MCP2221_RESET_DELAY", 0.5))
 
 # from the C driver
 # http://ww1.microchip.com/downloads/en/DeviceDoc/mcp2221_0_1.tar.gz
 # others (???) determined during driver developement
 MCP2221_RESET_DELAY = float(os.environ.get("BLINKA_MCP2221_RESET_DELAY", 0.5))
 
 # from the C driver
 # http://ww1.microchip.com/downloads/en/DeviceDoc/mcp2221_0_1.tar.gz
 # others (???) determined during driver developement

-# pylint: disable=bad-whitespace

 RESP_ERR_NOERR = 0x00
 RESP_ADDR_NACK = 0x25
 RESP_READ_ERR = 0x7F
 RESP_ERR_NOERR = 0x00
 RESP_ADDR_NACK = 0x25
 RESP_READ_ERR = 0x7F


@@ -35,7 +35,6 @@ RESP_I2C_WRITINGNOSTOP = 0x45  # ???
 MCP2221_RETRY_MAX = 50
 MCP2221_MAX_I2C_DATA_LEN = 60
 MASK_ADDR_NACK = 0x40
 MCP2221_RETRY_MAX = 50
 MCP2221_MAX_I2C_DATA_LEN = 60
 MASK_ADDR_NACK = 0x40

-# pylint: enable=bad-whitespace

 
 
 class MCP2221:
 
 
 class MCP2221:


@@ -53,12 +52,30 @@ class MCP2221:
     def __init__(self):
         self._hid = hid.device()
         self._hid.open(MCP2221.VID, MCP2221.PID)
     def __init__(self):
         self._hid = hid.device()
         self._hid.open(MCP2221.VID, MCP2221.PID)

-        self._reset()
+        # make sure the device gets closed before exit
+        atexit.register(self.close)
+        if MCP2221_RESET_DELAY >= 0:
+            try:
+                self._reset()
+            except OSError:
+                # this might fail on Linux with the hid_mcp2221 native
+                # driver and a short reset delay -- if it fails,
+                # close the device before reraising
+                self.close()
+                raise

         self._gp_config = [0x07] * 4  # "don't care" initial value
         for pin in range(4):
             self.gp_set_mode(pin, self.GP_GPIO)  # set to GPIO mode
             self.gpio_set_direction(pin, 1)  # set to INPUT
 
         self._gp_config = [0x07] * 4  # "don't care" initial value
         for pin in range(4):
             self.gp_set_mode(pin, self.GP_GPIO)  # set to GPIO mode
             self.gpio_set_direction(pin, 1)  # set to INPUT
 

+    def close(self):
+        """Close the device. Does nothing if the device is not open."""
+        self._hid.close()
+
+    def __del__(self):
+        # try to close the device before destroying the instance
+        self.close()
+

     def _hid_xfer(self, report, response=True):
         """Perform HID Transfer"""
         # first byte is report ID, which =0 for MCP2221
     def _hid_xfer(self, report, response=True):
         """Perform HID Transfer"""
         # first byte is report ID, which =0 for MCP2221


@@ -76,8 +93,6 @@ class MCP2221:
     # ----------------------------------------------------------------
     def gp_get_mode(self, pin):
         """Get Current Pin Mode"""
     # ----------------------------------------------------------------
     def gp_get_mode(self, pin):
         """Get Current Pin Mode"""

-        val = self._hid_xfer(b"\x61")[22 + pin]
-        print("0b{:08b}".format(val))

         return self._hid_xfer(b"\x61")[22 + pin] & 0x07
 
     def gp_set_mode(self, pin, mode):
         return self._hid_xfer(b"\x61")[22 + pin] & 0x07
 
     def gp_set_mode(self, pin, mode):


@@ -192,7 +207,7 @@ class MCP2221:
             # bus release will need "a few hundred microseconds"
             time.sleep(0.001)
 
             # bus release will need "a few hundred microseconds"
             time.sleep(0.001)
 

-    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-arguments,too-many-branches

     def _i2c_write(self, cmd, address, buffer, start=0, end=None):
         if self._i2c_state() != 0x00:
             self._i2c_cancel()
     def _i2c_write(self, cmd, address, buffer, start=0, end=None):
         if self._i2c_state() != 0x00:
             self._i2c_cancel()


@@ -201,7 +216,7 @@ class MCP2221:
         length = end - start
         retries = 0
 
         length = end - start
         retries = 0
 

-        while (end - start) > 0:
+        while (end - start) > 0 or not buffer:

             chunk = min(end - start, MCP2221_MAX_I2C_DATA_LEN)
             # write out current chunk
             resp = self._hid_xfer(
             chunk = min(end - start, MCP2221_MAX_I2C_DATA_LEN)
             # write out current chunk
             resp = self._hid_xfer(


@@ -226,6 +241,8 @@ class MCP2221:
             # yay chunk sent!
             while self._i2c_state() == RESP_I2C_PARTIALDATA:
                 time.sleep(0.001)
             # yay chunk sent!
             while self._i2c_state() == RESP_I2C_PARTIALDATA:
                 time.sleep(0.001)

+            if not buffer:
+                break

             start += chunk
             retries = 0
 
             start += chunk
             retries = 0
 


@@ -270,7 +287,7 @@ class MCP2221:
 
         # and now the read part
         while (end - start) > 0:
 
         # and now the read part
         while (end - start) > 0:

-            for retry in range(MCP2221_RETRY_MAX):
+            for _ in range(MCP2221_RETRY_MAX):

                 # the actual read
                 resp = self._hid_xfer(b"\x40")
                 # check for success
                 # the actual read
                 resp = self._hid_xfer(b"\x40")
                 # check for success


@@ -288,6 +305,8 @@ class MCP2221:
                     continue
                 if resp[2] in (RESP_READ_COMPL, RESP_READ_PARTIAL):
                     break
                     continue
                 if resp[2] in (RESP_READ_COMPL, RESP_READ_PARTIAL):
                     break

+            else:
+                raise RuntimeError("I2C read error: max retries reached.")

 
             # move data into buffer
             chunk = min(end - start, 60)
 
             # move data into buffer
             chunk = min(end - start, 60)


@@ -297,7 +316,7 @@ class MCP2221:
 
     # pylint: enable=too-many-arguments
 
 
     # pylint: enable=too-many-arguments
 

-    def i2c_configure(self, baudrate=100000):
+    def _i2c_configure(self, baudrate=100000):

         """Configure I2C"""
         self._hid_xfer(
             bytes(
         """Configure I2C"""
         self._hid_xfer(
             bytes(


@@ -328,7 +347,7 @@ class MCP2221:
         out_start=0,
         out_end=None,
         in_start=0,
         out_start=0,
         out_end=None,
         in_start=0,

-        in_end=None
+        in_end=None,

     ):
         """Write data from buffer_out to an address and then
         read data from an address and into buffer_in
     ):
         """Write data from buffer_out to an address and then
         read data from an address and into buffer_in