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