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