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