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