src/digitalio.py

   1 """
   2 `digitalio` - Digital input and output control (GPIO)
   3 =====================================================
   4
   5 See `CircuitPython:digitalio` in CircuitPython for more details.
   6
   7 * Author(s): cefn
   8 """
   9
  10 from adafruit_blinka.agnostic import board_id, detector
  11
  12 # pylint: disable=ungrouped-imports,wrong-import-position
  13
  14 if detector.chip.BCM2XXX:
  15     from adafruit_blinka.microcontroller.bcm283x.pin import Pin
  16 elif detector.chip.AM33XX:
  17     from adafruit_blinka.microcontroller.am335x.pin import Pin
  18 elif detector.chip.DRA74X:
  19     from adafruit_blinka.microcontroller.dra74x.pin import Pin
  20 elif detector.chip.SUN8I:
  21     from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
  22 elif detector.chip.SAMA5:
  23     from adafruit_blinka.microcontroller.sama5.pin import Pin
  24 elif detector.chip.T210:
  25     from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
  26 elif detector.chip.T186:
  27     from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
  28 elif detector.chip.T194:
  29     from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
  30 elif detector.chip.S905:
  31     from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
  32 elif detector.chip.S905X3:
  33     from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
  34 elif detector.chip.S922X:
  35     from adafruit_blinka.microcontroller.amlogic.s922x.pin import Pin
  36 elif detector.chip.EXYNOS5422:
  37     from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
  38 elif detector.chip.APQ8016:
  39     from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
  40 elif detector.chip.IMX8MX:
  41     from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
  42 elif detector.chip.IMX6ULL:
  43     from adafruit_blinka.microcontroller.nxp_imx6ull.pin import Pin
  44 elif detector.chip.HFU540:
  45     from adafruit_blinka.microcontroller.hfu540.pin import Pin
  46 elif detector.chip.A64:
  47     from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
  48 elif detector.chip.A33:
  49     from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
  50 elif detector.chip.MIPS24KEC:
  51     from adafruit_blinka.microcontroller.mips24kec.pin import Pin
  52 elif detector.chip.RK3308:
  53     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
  54 elif detector.chip.RK3399:
  55     from adafruit_blinka.microcontroller.rockchip.rk3399.pin import Pin
  56 elif detector.chip.RK3328:
  57     from adafruit_blinka.microcontroller.rockchip.rk3328.pin import Pin
  58 elif detector.board.ftdi_ft232h:
  59     from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import Pin
  60 elif detector.board.ftdi_ft2232h:
  61     from adafruit_blinka.microcontroller.ftdi_mpsse.ft2232h.pin import Pin
  62 elif detector.board.binho_nova:
  63     from adafruit_blinka.microcontroller.nova.pin import Pin
  64 elif detector.board.greatfet_one:
  65     from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
  66 elif detector.chip.STM32F405:
  67     from machine import Pin
  68 elif detector.chip.RP2040:
  69     from machine import Pin
  70 elif detector.board.microchip_mcp2221:
  71     from adafruit_blinka.microcontroller.mcp2221.pin import Pin
  72 elif detector.chip.PENTIUM_N3710:
  73     from adafruit_blinka.microcontroller.pentium.n3710.pin import Pin
  74 elif detector.chip.STM32MP157:
  75     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import Pin
  76 elif detector.chip.MT8167:
  77     from adafruit_blinka.microcontroller.mt8167.pin import Pin
  78 elif detector.chip.H5:
  79     from adafruit_blinka.microcontroller.allwinner.h5.pin import Pin
  80 elif detector.chip.H6:
  81     from adafruit_blinka.microcontroller.allwinner.h6.pin import Pin
  82 elif detector.chip.H616:
  83     from adafruit_blinka.microcontroller.allwinner.h616.pin import Pin
  84 elif detector.board.pico_u2if:
  85     from adafruit_blinka.microcontroller.rp2040_u2if.pin import Pin
  86 elif detector.board.feather_u2if or detector.board.qtpy_u2if or \
  87      detector.board.itsybitsy_u2if or detector.board.qt2040_trinkey_u2if:
  88     from adafruit_blinka.microcontroller.rp2040_u2if.pin import Pin
  89
  90 from adafruit_blinka import Enum, ContextManaged
  91
  92
  93 class DriveMode(Enum):
  94     """Drive Mode Enumeration"""
  95
  96     PUSH_PULL = None
  97     OPEN_DRAIN = None
  98
  99
 100 DriveMode.PUSH_PULL = DriveMode()
 101 DriveMode.OPEN_DRAIN = DriveMode()
 102
 103
 104 class Direction(Enum):
 105     """Direction Enumeration"""
 106
 107     INPUT = None
 108     OUTPUT = None
 109
 110
 111 Direction.INPUT = Direction()
 112 Direction.OUTPUT = Direction()
 113
 114
 115 class Pull(Enum):
 116     """PullUp/PullDown Enumeration"""
 117
 118     UP = None
 119     DOWN = None
 120     # NONE=None
 121
 122
 123 Pull.UP = Pull()
 124 Pull.DOWN = Pull()
 125
 126 # Pull.NONE = Pull()
 127
 128
 129 class DigitalInOut(ContextManaged):
 130     """DigitalInOut CircuitPython compatibility implementation"""
 131
 132     _pin = None
 133
 134     def __init__(self, pin):
 135         self._pin = Pin(pin.id)
 136         self.direction = Direction.INPUT
 137
 138     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 139         """Switch the Digital Pin Mode to Output"""
 140         self.direction = Direction.OUTPUT
 141         self.value = value
 142         self.drive_mode = drive_mode
 143
 144     def switch_to_input(self, pull=None):
 145         """Switch the Digital Pin Mode to Input"""
 146         self.direction = Direction.INPUT
 147         self.pull = pull
 148
 149     def deinit(self):
 150         """Deinitialize the Digital Pin"""
 151         del self._pin
 152
 153     @property
 154     def direction(self):
 155         """Get or Set the Digital Pin Direction"""
 156         return self.__direction
 157
 158     @direction.setter
 159     def direction(self, value):
 160         self.__direction = value
 161         if value is Direction.OUTPUT:
 162             self._pin.init(mode=Pin.OUT)
 163             self.value = False
 164             self.drive_mode = DriveMode.PUSH_PULL
 165         elif value is Direction.INPUT:
 166             self._pin.init(mode=Pin.IN)
 167             self.pull = None
 168         else:
 169             raise AttributeError("Not a Direction")
 170
 171     @property
 172     def value(self):
 173         """Get or Set the Digital Pin Value"""
 174         return self._pin.value() == 1
 175
 176     @value.setter
 177     def value(self, val):
 178         if self.direction is Direction.OUTPUT:
 179             self._pin.value(1 if val else 0)
 180         else:
 181             raise AttributeError("Not an output")
 182
 183     @property
 184     def pull(self):
 185         """Get or Set the Digital Pin Direction"""
 186         if self.direction is Direction.INPUT:
 187             return self.__pull
 188         raise AttributeError("Not an input")
 189
 190     @pull.setter
 191     def pull(self, pul):
 192         if self.direction is Direction.INPUT:
 193             self.__pull = pul
 194             if pul is Pull.UP:
 195                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 196             elif pul is Pull.DOWN:
 197                 if hasattr(Pin, "PULL_DOWN"):
 198                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 199                 else:
 200                     raise NotImplementedError(
 201                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 202                     )
 203             elif pul is None:
 204                 self._pin.init(mode=Pin.IN, pull=None)
 205             else:
 206                 raise AttributeError("Not a Pull")
 207         else:
 208             raise AttributeError("Not an input")
 209
 210     @property
 211     def drive_mode(self):
 212         """Get or Set the Digital Pin Drive Mode"""
 213         if self.direction is Direction.OUTPUT:
 214             return self.__drive_mode  #
 215         raise AttributeError("Not an output")
 216
 217     @drive_mode.setter
 218     def drive_mode(self, mod):
 219         self.__drive_mode = mod
 220         if mod is DriveMode.OPEN_DRAIN:
 221             self._pin.init(mode=Pin.OPEN_DRAIN)
 222         elif mod is DriveMode.PUSH_PULL:
 223             self._pin.init(mode=Pin.OUT)