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.RK3328:
  91     from adafruit_blinka.microcontroller.rockchip.rk3328.pin import Pin
  92 elif detector.chip.RK3566:
  93     from adafruit_blinka.microcontroller.rockchip.rk3566.pin import Pin
  94 elif detector.chip.RK3568:
  95     from adafruit_blinka.microcontroller.rockchip.rk3568.pin import Pin
  96 elif detector.chip.PENTIUM_N3710:
  97     from adafruit_blinka.microcontroller.pentium.n3710.pin import Pin
  98 elif detector.chip.ATOM_J4105:
  99     from adafruit_blinka.microcontroller.pentium.j4105.pin import Pin
 100 elif detector.chip.STM32MP157:
 101     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import Pin
 102 elif detector.chip.MT8167:
 103     from adafruit_blinka.microcontroller.mt8167.pin import Pin
 104 elif detector.chip.H3:
 105     from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
 106 elif detector.chip.H5:
 107     from adafruit_blinka.microcontroller.allwinner.h5.pin import Pin
 108 elif detector.chip.H6:
 109     from adafruit_blinka.microcontroller.allwinner.h6.pin import Pin
 110 elif detector.chip.H618:
 111     from adafruit_blinka.microcontroller.allwinner.h618.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 elif detector.chip.K1:
 119     from adafruit_blinka.microcontroller.spacemit.k1.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.ftdi_ft4232h:
 126     from adafruit_blinka.microcontroller.ftdi_mpsse.ft4232h.pin import Pin
 127 elif detector.board.binho_nova:
 128     from adafruit_blinka.microcontroller.nova.pin import Pin
 129 elif detector.board.greatfet_one:
 130     from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
 131 elif detector.board.microchip_mcp2221:
 132     from adafruit_blinka.microcontroller.mcp2221.pin import Pin
 133 elif detector.chip.RP2040_U2IF:
 134     from adafruit_blinka.microcontroller.rp2040_u2if.pin import Pin
 135 # MicroPython Chips
 136 elif detector.chip.STM32F405:
 137     from machine import Pin
 138 elif detector.chip.RP2040:
 139     from machine import Pin
 140 elif detector.chip.CV1800B:
 141     from adafruit_blinka.microcontroller.cv1800b.pin import Pin
 142 elif detector.chip.RV1103:
 143     from adafruit_blinka.microcontroller.rockchip.rv1103.pin import Pin
 144 elif detector.chip.RV1106:
 145     from adafruit_blinka.microcontroller.rockchip.rv1106.pin import Pin
 146 elif detector.chip.OS_AGNOSTIC:
 147     from adafruit_blinka.microcontroller.generic_agnostic_board.pin import Pin
 148
 149 from adafruit_blinka import Enum, ContextManaged
 150
 151
 152 class DriveMode(Enum):
 153     """Drive Mode Enumeration"""
 154
 155     PUSH_PULL = None
 156     OPEN_DRAIN = None
 157
 158
 159 DriveMode.PUSH_PULL = DriveMode()
 160 DriveMode.OPEN_DRAIN = DriveMode()
 161
 162
 163 class Direction(Enum):
 164     """Direction Enumeration"""
 165
 166     INPUT = None
 167     OUTPUT = None
 168
 169
 170 Direction.INPUT = Direction()
 171 Direction.OUTPUT = Direction()
 172
 173
 174 class Pull(Enum):
 175     """PullUp/PullDown Enumeration"""
 176
 177     UP = None
 178     DOWN = None
 179     # NONE=None
 180
 181
 182 Pull.UP = Pull()
 183 Pull.DOWN = Pull()
 184
 185 # Pull.NONE = Pull()
 186
 187
 188 class DigitalInOut(ContextManaged):
 189     """DigitalInOut CircuitPython compatibility implementation"""
 190
 191     _pin = None
 192
 193     def __init__(self, pin):
 194         self._pin = Pin(pin.id)
 195         self.direction = Direction.INPUT
 196
 197     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 198         """Switch the Digital Pin Mode to Output"""
 199         self.direction = Direction.OUTPUT
 200         self.value = value
 201         self.drive_mode = drive_mode
 202
 203     def switch_to_input(self, pull=None):
 204         """Switch the Digital Pin Mode to Input"""
 205         self.direction = Direction.INPUT
 206         self.pull = pull
 207
 208     def deinit(self):
 209         """Deinitialize the Digital Pin"""
 210         del self._pin
 211
 212     @property
 213     def direction(self):
 214         """Get or Set the Digital Pin Direction"""
 215         return self.__direction
 216
 217     @direction.setter
 218     def direction(self, value):
 219         self.__direction = value
 220         if value is Direction.OUTPUT:
 221             self._pin.init(mode=Pin.OUT)
 222             self.value = False
 223             self.drive_mode = DriveMode.PUSH_PULL
 224         elif value is Direction.INPUT:
 225             self._pin.init(mode=Pin.IN)
 226             self.pull = None
 227         else:
 228             raise AttributeError("Not a Direction")
 229
 230     @property
 231     def value(self):
 232         """The Digital Pin Value"""
 233         return self._pin.value() == 1
 234
 235     @value.setter
 236     def value(self, val):
 237         if self.direction is Direction.OUTPUT:
 238             self._pin.value(1 if val else 0)
 239         else:
 240             raise AttributeError("Not an output")
 241
 242     @property
 243     def pull(self):
 244         """The pin pull direction"""
 245         if self.direction is Direction.INPUT:
 246             return self.__pull
 247         raise AttributeError("Not an input")
 248
 249     @pull.setter
 250     def pull(self, pul):
 251         if self.direction is Direction.INPUT:
 252             self.__pull = pul
 253             if pul is Pull.UP:
 254                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 255             elif pul is Pull.DOWN:
 256                 if hasattr(Pin, "PULL_DOWN"):
 257                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 258                 else:
 259                     raise NotImplementedError(
 260                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 261                     )
 262             elif pul is None:
 263                 self._pin.init(mode=Pin.IN, pull=None)
 264             else:
 265                 raise AttributeError("Not a Pull")
 266         else:
 267             raise AttributeError("Not an input")
 268
 269     @property
 270     def drive_mode(self):
 271         """The Digital Pin Drive Mode"""
 272         if self.direction is Direction.OUTPUT:
 273             return self.__drive_mode  #
 274         raise AttributeError("Not an output")
 275
 276     @drive_mode.setter
 277     def drive_mode(self, mod):
 278         self.__drive_mode = mod
 279         if mod is DriveMode.OPEN_DRAIN:
 280             self._pin.init(mode=Pin.OPEN_DRAIN)
 281         elif mod is DriveMode.PUSH_PULL:
 282             self._pin.init(mode=Pin.OUT)