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