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