src/digitalio.py

   1 """
   2 `digitalio` - Digital input and output control (GPIO)
   3 =====================================================
   4
   5 See `CircuitPython:digitalio` in CircuitPython for more details.
   6
   7 * Author(s): cefn
   8 """
   9
  10 from adafruit_blinka.agnostic import board_id, detector
  11
  12 # pylint: disable=ungrouped-imports,wrong-import-position
  13
  14 if detector.chip.BCM2XXX:
  15     from adafruit_blinka.microcontroller.bcm283x.pin import Pin
  16 elif detector.chip.AM33XX:
  17     from adafruit_blinka.microcontroller.am335x.pin import Pin
  18 elif detector.chip.DRA74X:
  19     from adafruit_blinka.microcontroller.dra74x.pin import Pin
  20 elif detector.chip.SUN8I:
  21     from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
  22 elif detector.chip.SAMA5:
  23     from adafruit_blinka.microcontroller.sama5.pin import Pin
  24 elif detector.chip.T210:
  25     from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
  26 elif detector.chip.T186:
  27     from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
  28 elif detector.chip.T194:
  29     from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
  30 elif detector.chip.S905:
  31     from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
  32 elif detector.chip.S905X3:
  33     from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
  34 elif detector.chip.S922X:
  35     from adafruit_blinka.microcontroller.amlogic.s922x.pin import Pin
  36 elif detector.chip.EXYNOS5422:
  37     from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
  38 elif detector.chip.APQ8016:
  39     from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
  40 elif detector.chip.IMX8MX:
  41     from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
  42 elif detector.chip.IMX6ULL:
  43     from adafruit_blinka.microcontroller.nxp_imx6ull.pin import Pin
  44 elif detector.chip.HFU540:
  45     from adafruit_blinka.microcontroller.hfu540.pin import Pin
  46 elif detector.chip.A64:
  47     from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
  48 elif detector.chip.A33:
  49     from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
  50 elif detector.chip.MIPS24KEC:
  51     from adafruit_blinka.microcontroller.mips24kec.pin import Pin
  52 elif detector.chip.RK3308:
  53     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
  54 elif detector.chip.RK3399:
  55     from adafruit_blinka.microcontroller.rockchip.rk3399.pin import Pin
  56 elif detector.board.ftdi_ft232h:
  57     from adafruit_blinka.microcontroller.ft232h.pin import Pin
  58 elif detector.board.binho_nova:
  59     from adafruit_blinka.microcontroller.nova.pin import Pin
  60 elif detector.board.greatfet_one:
  61     from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
  62 elif detector.chip.STM32F405:
  63     from machine import Pin
  64 elif detector.board.microchip_mcp2221:
  65     from adafruit_blinka.microcontroller.mcp2221.pin import Pin
  66 elif detector.chip.PENTIUM_N3710:
  67     from adafruit_blinka.microcontroller.pentium.n3710.pin import Pin
  68 elif detector.chip.STM32MP157:
  69     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import Pin
  70 elif detector.chip.MT8167:
  71     from adafruit_blinka.microcontroller.mt8167.pin import Pin
  72 elif detector.chip.H5:
  73     from adafruit_blinka.microcontroller.allwinner.h5.pin import Pin
  74 elif detector.chip.H616:
  75     from adafruit_blinka.microcontroller.allwinner.h616.pin import Pin
  76 elif detector.board.pico_u2if:
  77     from adafruit_blinka.microcontroller.pico_u2if.pin import Pin
  78
  79 from adafruit_blinka import Enum, ContextManaged
  80
  81
  82 class DriveMode(Enum):
  83     """Drive Mode Enumeration"""
  84
  85     PUSH_PULL = None
  86     OPEN_DRAIN = None
  87
  88
  89 DriveMode.PUSH_PULL = DriveMode()
  90 DriveMode.OPEN_DRAIN = DriveMode()
  91
  92
  93 class Direction(Enum):
  94     """Direction Enumeration"""
  95
  96     INPUT = None
  97     OUTPUT = None
  98
  99
 100 Direction.INPUT = Direction()
 101 Direction.OUTPUT = Direction()
 102
 103
 104 class Pull(Enum):
 105     """PullUp/PullDown Enumeration"""
 106
 107     UP = None
 108     DOWN = None
 109     # NONE=None
 110
 111
 112 Pull.UP = Pull()
 113 Pull.DOWN = Pull()
 114
 115 # Pull.NONE = Pull()
 116
 117
 118 class DigitalInOut(ContextManaged):
 119     """DigitalInOut CircuitPython compatibility implementation"""
 120
 121     _pin = None
 122
 123     def __init__(self, pin):
 124         self._pin = Pin(pin.id)
 125         self.direction = Direction.INPUT
 126
 127     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 128         """Switch the Digital Pin Mode to Output"""
 129         self.direction = Direction.OUTPUT
 130         self.value = value
 131         self.drive_mode = drive_mode
 132
 133     def switch_to_input(self, pull=None):
 134         """Switch the Digital Pin Mode to Input"""
 135         self.direction = Direction.INPUT
 136         self.pull = pull
 137
 138     def deinit(self):
 139         """Deinitialize the Digital Pin"""
 140         del self._pin
 141
 142     @property
 143     def direction(self):
 144         """Get or Set the Digital Pin Direction"""
 145         return self.__direction
 146
 147     @direction.setter
 148     def direction(self, value):
 149         self.__direction = value
 150         if value is Direction.OUTPUT:
 151             self._pin.init(mode=Pin.OUT)
 152             self.value = False
 153             self.drive_mode = DriveMode.PUSH_PULL
 154         elif value is Direction.INPUT:
 155             self._pin.init(mode=Pin.IN)
 156             self.pull = None
 157         else:
 158             raise AttributeError("Not a Direction")
 159
 160     @property
 161     def value(self):
 162         """Get or Set the Digital Pin Value"""
 163         return self._pin.value() == 1
 164
 165     @value.setter
 166     def value(self, val):
 167         if self.direction is Direction.OUTPUT:
 168             self._pin.value(1 if val else 0)
 169         else:
 170             raise AttributeError("Not an output")
 171
 172     @property
 173     def pull(self):
 174         """Get or Set the Digital Pin Direction"""
 175         if self.direction is Direction.INPUT:
 176             return self.__pull
 177         raise AttributeError("Not an input")
 178
 179     @pull.setter
 180     def pull(self, pul):
 181         if self.direction is Direction.INPUT:
 182             self.__pull = pul
 183             if pul is Pull.UP:
 184                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 185             elif pul is Pull.DOWN:
 186                 if hasattr(Pin, "PULL_DOWN"):
 187                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 188                 else:
 189                     raise NotImplementedError(
 190                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 191                     )
 192             elif pul is None:
 193                 self._pin.init(mode=Pin.IN, pull=None)
 194             else:
 195                 raise AttributeError("Not a Pull")
 196         else:
 197             raise AttributeError("Not an input")
 198
 199     @property
 200     def drive_mode(self):
 201         """Get or Set the Digital Pin Drive Mode"""
 202         if self.direction is Direction.OUTPUT:
 203             return self.__drive_mode  #
 204         raise AttributeError("Not an output")
 205
 206     @drive_mode.setter
 207     def drive_mode(self, mod):
 208         self.__drive_mode = mod
 209         if mod is DriveMode.OPEN_DRAIN:
 210             self._pin.init(mode=Pin.OPEN_DRAIN)
 211         elif mod is DriveMode.PUSH_PULL:
 212             self._pin.init(mode=Pin.OUT)