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