src/digitalio.py

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