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