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