src/board.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """
   5 `board` - Define ids for available pins
   6 =================================================
   7
   8 See `CircuitPython:board` in CircuitPython for more details.
   9
  10 * Author(s): cefn
  11 """
  12
  13
  14 __version__ = "0.0.0+auto.0"
  15 __repo__ = "https://github.com/adafruit/Adafruit_Blinka.git"
  16 __blinka__ = True
  17
  18
  19 import sys
  20 import adafruit_platformdetect.constants.boards as ap_board
  21 from adafruit_blinka.agnostic import board_id, detector
  22
  23 # pylint: disable=wildcard-import,unused-wildcard-import,ungrouped-imports
  24 # pylint: disable=import-outside-toplevel
  25
  26 if board_id == ap_board.FEATHER_HUZZAH:
  27     from adafruit_blinka.board.feather_huzzah import *
  28
  29 elif board_id == ap_board.OLIMEX_LIME2:
  30     from adafruit_blinka.board.OLIMEX_LIME2 import *
  31
  32 elif board_id == ap_board.NODEMCU:
  33     from adafruit_blinka.board.nodemcu import *
  34
  35 elif board_id == ap_board.PYBOARD:
  36     from adafruit_blinka.board.pyboard import *
  37
  38 elif board_id == ap_board.RASPBERRY_PI_PICO:
  39     from adafruit_blinka.board.raspberrypi.pico import *
  40
  41 elif (
  42     detector.board.RASPBERRY_PI_4B
  43     or detector.board.RASPBERRY_PI_CM4
  44     or detector.board.RASPBERRY_PI_CM4S
  45     or detector.board.RASPBERRY_PI_400
  46 ):
  47     from adafruit_blinka.board.raspberrypi.raspi_4b import *
  48 elif detector.board.RASPBERRY_PI_5:
  49     from adafruit_blinka.board.raspberrypi.raspi_5b import *
  50
  51 elif detector.board.any_raspberry_pi_40_pin:
  52     from adafruit_blinka.board.raspberrypi.raspi_40pin import *
  53
  54 elif detector.board.any_raspberry_pi_cm:
  55     from adafruit_blinka.board.raspberrypi.raspi_cm import *
  56
  57 elif detector.board.RASPBERRY_PI_B_REV1:
  58     from adafruit_blinka.board.raspberrypi.raspi_1b_rev1 import *
  59
  60 elif detector.board.RASPBERRY_PI_A or detector.board.RASPBERRY_PI_B_REV2:
  61     from adafruit_blinka.board.raspberrypi.raspi_1b_rev2 import *
  62
  63 elif board_id == ap_board.BEAGLEBONE:
  64     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  65
  66 elif board_id == ap_board.BEAGLEBONE_BLACK:
  67     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  68
  69 elif board_id == ap_board.BEAGLEBONE_BLUE:
  70     from adafruit_blinka.board.beagleboard.beaglebone_blue import *
  71
  72 elif board_id == ap_board.BEAGLEBONE_GREEN:
  73     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  74
  75 elif board_id == ap_board.BEAGLEBONE_GREEN_GATEWAY:
  76     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  77
  78 elif board_id == ap_board.BEAGLEBONE_BLACK_INDUSTRIAL:
  79     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  80
  81 elif board_id == ap_board.BEAGLEBONE_GREEN_WIRELESS:
  82     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  83
  84 elif board_id == ap_board.BEAGLEBONE_BLACK_WIRELESS:
  85     from adafruit_blinka.board.beagleboard.beaglebone_black import *
  86
  87 elif board_id == ap_board.BEAGLEBONE_POCKETBEAGLE:
  88     from adafruit_blinka.board.beagleboard.beaglebone_pocketbeagle import *
  89
  90 elif board_id == ap_board.BEAGLEBONE_AI:
  91     from adafruit_blinka.board.beagleboard.beaglebone_ai import *
  92
  93 elif board_id == ap_board.BEAGLEV_STARLIGHT:
  94     from adafruit_blinka.board.beagleboard.beaglev_starlight import *
  95
  96 elif board_id == ap_board.ORANGE_PI_PC:
  97     from adafruit_blinka.board.orangepi.orangepipc import *
  98
  99 elif board_id == ap_board.ORANGE_PI_R1:
 100     from adafruit_blinka.board.orangepi.orangepir1 import *
 101
 102 elif board_id == ap_board.ORANGE_PI_ZERO:
 103     from adafruit_blinka.board.orangepi.orangepizero import *
 104
 105 elif board_id == ap_board.ORANGE_PI_ONE:
 106     from adafruit_blinka.board.orangepi.orangepipc import *
 107
 108 elif board_id == ap_board.ORANGE_PI_PC_PLUS:
 109     from adafruit_blinka.board.orangepi.orangepipc import *
 110
 111 elif board_id == ap_board.ORANGE_PI_LITE:
 112     from adafruit_blinka.board.orangepi.orangepipc import *
 113
 114 elif board_id == ap_board.ORANGE_PI_PLUS_2E:
 115     from adafruit_blinka.board.orangepi.orangepipc import *
 116
 117 elif board_id == ap_board.ORANGE_PI_2:
 118     from adafruit_blinka.board.orangepi.orangepipc import *
 119
 120 elif board_id == ap_board.ORANGE_PI_ZERO_PLUS_2H5:
 121     from adafruit_blinka.board.orangepi.orangepizeroplus2h5 import *
 122
 123 elif board_id == ap_board.ORANGE_PI_ZERO_PLUS:
 124     from adafruit_blinka.board.orangepi.orangepizeroplus import *
 125
 126 elif board_id == ap_board.ORANGE_PI_ZERO_2:
 127     from adafruit_blinka.board.orangepi.orangepizero2 import *
 128
 129 elif board_id == ap_board.ORANGE_PI_3:
 130     from adafruit_blinka.board.orangepi.orangepi3 import *
 131
 132 elif board_id == ap_board.ORANGE_PI_4:
 133     from adafruit_blinka.board.orangepi.orangepi4 import *
 134
 135 elif board_id == ap_board.ORANGE_PI_4_LTS:
 136     from adafruit_blinka.board.orangepi.orangepi4 import *
 137
 138 elif board_id == ap_board.ORANGE_PI_5:
 139     from adafruit_blinka.board.orangepi.orangepi5 import *
 140
 141 elif board_id == ap_board.ORANGE_PI_5_PLUS:
 142     from adafruit_blinka.board.orangepi.orangepi5plus import *
 143
 144 elif board_id == ap_board.BANANA_PI_M2_ZERO:
 145     from adafruit_blinka.board.bananapi.bpim2zero import *
 146
 147 elif board_id == ap_board.BANANA_PI_M2_PLUS:
 148     from adafruit_blinka.board.bananapi.bpim2plus import *
 149
 150 elif board_id == ap_board.BANANA_PI_M5:
 151     from adafruit_blinka.board.bananapi.bpim5 import *
 152
 153 elif board_id == ap_board.LEMAKER_BANANA_PRO:
 154     from adafruit_blinka.board.lemaker.bananapro import *
 155
 156 elif board_id == ap_board.GIANT_BOARD:
 157     from adafruit_blinka.board.giantboard import *
 158
 159 elif board_id == ap_board.JETSON_TX1:
 160     from adafruit_blinka.board.nvidia.jetson_tx1 import *
 161
 162 elif board_id == ap_board.JETSON_TX2:
 163     from adafruit_blinka.board.nvidia.jetson_tx2 import *
 164
 165 elif board_id == ap_board.JETSON_TX2_NX:
 166     from adafruit_blinka.board.nvidia.jetson_tx2_nx import *
 167
 168 elif board_id == ap_board.JETSON_XAVIER:
 169     from adafruit_blinka.board.nvidia.jetson_xavier import *
 170
 171 elif board_id == ap_board.JETSON_NANO:
 172     from adafruit_blinka.board.nvidia.jetson_nano import *
 173
 174 elif board_id == ap_board.JETSON_NX:
 175     from adafruit_blinka.board.nvidia.jetson_nx import *
 176
 177 elif board_id == ap_board.JETSON_AGX_ORIN:
 178     from adafruit_blinka.board.nvidia.jetson_orin import *
 179
 180 elif board_id in (ap_board.JETSON_ORIN_NX, ap_board.JETSON_ORIN_NANO):
 181     from adafruit_blinka.board.nvidia.jetson_orin_nx import *
 182
 183 elif board_id == ap_board.CLARA_AGX_XAVIER:
 184     from adafruit_blinka.board.nvidia.clara_agx_xavier import *
 185
 186 elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
 187     from adafruit_blinka.board.coral_dev_board import *
 188
 189 elif board_id == ap_board.CORAL_EDGE_TPU_DEV_MINI:
 190     from adafruit_blinka.board.coral_dev_board_mini import *
 191
 192 elif board_id == ap_board.ODROID_C2:
 193     from adafruit_blinka.board.hardkernel.odroidc2 import *
 194
 195 elif board_id == ap_board.ODROID_C4:
 196     from adafruit_blinka.board.hardkernel.odroidc4 import *
 197
 198 elif board_id == ap_board.ODROID_N2:
 199     from adafruit_blinka.board.hardkernel.odroidn2 import *
 200
 201 elif board_id == ap_board.ODROID_M1:
 202     from adafruit_blinka.board.hardkernel.odroidm1 import *
 203
 204 elif board_id == ap_board.ODROID_M1S:
 205     from adafruit_blinka.board.hardkernel.odroidm1s import *
 206
 207 elif board_id == ap_board.KHADAS_VIM3:
 208     from adafruit_blinka.board.khadas.khadasvim3 import *
 209
 210 elif board_id == ap_board.ODROID_XU4:
 211     from adafruit_blinka.board.hardkernel.odroidxu4 import *
 212
 213 elif board_id == ap_board.DRAGONBOARD_410C:
 214     from adafruit_blinka.board.dragonboard_410c import *
 215
 216 elif board_id == ap_board.FTDI_FT232H:
 217     from adafruit_blinka.board.ftdi_ft232h import *
 218
 219 elif board_id == ap_board.FTDI_FT2232H:
 220     from adafruit_blinka.board.ftdi_ft2232h import *
 221
 222 elif board_id == ap_board.BINHO_NOVA:
 223     from adafruit_blinka.board.binho_nova import *
 224
 225 elif board_id == ap_board.MICROCHIP_MCP2221:
 226     from adafruit_blinka.board.microchip_mcp2221 import *
 227
 228 elif board_id == ap_board.GREATFET_ONE:
 229     from adafruit_blinka.board.greatfet_one import *
 230
 231 elif board_id == ap_board.SIFIVE_UNLEASHED:
 232     from adafruit_blinka.board.hifive_unleashed import *
 233
 234 elif board_id == ap_board.PINE64:
 235     from adafruit_blinka.board.pine64.pine64 import *
 236
 237 elif board_id == ap_board.PINEH64:
 238     from adafruit_blinka.board.pineH64 import *
 239
 240 elif board_id == ap_board.QUARTZ64_A:
 241     from adafruit_blinka.board.pine64.quartz64_a import *
 242
 243 elif board_id == ap_board.PCDUINO2:
 244     from adafruit_blinka.board.linksprite.pcduino2 import *
 245
 246 elif board_id == ap_board.PCDUINO3:
 247     from adafruit_blinka.board.linksprite.pcduino3 import *
 248
 249 elif board_id == ap_board.SOPINE:
 250     from adafruit_blinka.board.soPine import *
 251
 252 elif board_id == ap_board.CLOCKWORK_CPI3:
 253     from adafruit_blinka.board.clockworkcpi3 import *
 254
 255 elif board_id == ap_board.ONION_OMEGA2:
 256     from adafruit_blinka.board.onion.omega2 import *
 257
 258 elif board_id == ap_board.RADXA_CM3:
 259     from adafruit_blinka.board.radxa.radxacm3 import *
 260
 261 elif board_id == ap_board.ROCK_PI_3A:
 262     from adafruit_blinka.board.radxa.rockpi3a import *
 263
 264 elif board_id == ap_board.ROCK_PI_3C:
 265     from adafruit_blinka.board.radxa.rockpi3c import *
 266
 267 elif board_id == ap_board.RADXA_ZERO:
 268     from adafruit_blinka.board.radxa.radxazero import *
 269
 270 elif board_id == ap_board.RADXA_ZERO3:
 271     from adafruit_blinka.board.radxa.radxazero3 import *
 272
 273 elif board_id == ap_board.ROCK_PI_S:
 274     from adafruit_blinka.board.radxa.rockpis import *
 275
 276 elif board_id == ap_board.ROCK_PI_4:
 277     from adafruit_blinka.board.radxa.rockpi4 import *
 278
 279 elif board_id == ap_board.ROCK_PI_4_C_PLUS:
 280     from adafruit_blinka.board.radxa.rockpi4 import *
 281
 282 elif board_id == ap_board.ROCK_PI_4_SE:
 283     from adafruit_blinka.board.radxa.rockpi4 import *
 284
 285 elif board_id == ap_board.ROCK_PI_5:
 286     from adafruit_blinka.board.radxa.rock5 import *
 287
 288 elif board_id == ap_board.ROCK_PI_E:
 289     from adafruit_blinka.board.radxa.rockpie import *
 290
 291 elif board_id == ap_board.UDOO_X86:
 292     from adafruit_blinka.board.udoo_x86ultra import *
 293
 294 elif board_id == ap_board.ODYSSEY_X86J41X5:
 295     from adafruit_blinka.board.x86j41x5 import *
 296
 297 elif board_id == ap_board.STM32MP157C_DK2:
 298     from adafruit_blinka.board.stm32.stm32mp157c_dk2 import *
 299
 300 elif board_id == ap_board.OSD32MP1_RED:
 301     from adafruit_blinka.board.stm32.osd32mp1_red import *
 302
 303 elif board_id == ap_board.OSD32MP1_BRK:
 304     from adafruit_blinka.board.stm32.osd32mp1_brk import *
 305
 306 elif board_id == ap_board.LUBANCAT_IMX6ULL:
 307     from adafruit_blinka.board.lubancat.lubancat_imx6ull import *
 308
 309 elif board_id == ap_board.LUBANCAT_STM32MP157:
 310     from adafruit_blinka.board.lubancat.lubancat_stm32mp157 import *
 311
 312 elif board_id == ap_board.LUBANCAT_ZERO:
 313     from adafruit_blinka.board.lubancat.lubancat_zero import *
 314
 315 elif board_id == ap_board.LUBANCAT1:
 316     from adafruit_blinka.board.lubancat.lubancat1 import *
 317
 318 elif board_id == ap_board.LUBANCAT2:
 319     from adafruit_blinka.board.lubancat.lubancat2 import *
 320
 321 elif board_id == ap_board.LUBANCAT4:
 322     from adafruit_blinka.board.lubancat.lubancat4 import *
 323
 324 elif board_id == ap_board.NANOPI_NEO_AIR:
 325     from adafruit_blinka.board.nanopi.neoair import *
 326
 327 elif board_id == ap_board.NANOPI_DUO2:
 328     from adafruit_blinka.board.nanopi.duo2 import *
 329
 330 elif board_id == ap_board.NANOPI_NEO:
 331     from adafruit_blinka.board.nanopi.neo import *
 332
 333 elif board_id == ap_board.PICO_U2IF:
 334     from adafruit_blinka.board.pico_u2if import *
 335
 336 elif board_id == ap_board.FEATHER_U2IF:
 337     from adafruit_blinka.board.feather_u2if import *
 338
 339 elif board_id == ap_board.FEATHER_CAN_U2IF:
 340     from adafruit_blinka.board.feather_can_u2if import *
 341
 342 elif board_id == ap_board.FEATHER_EPD_U2IF:
 343     from adafruit_blinka.board.feather_epd_u2if import *
 344
 345 elif board_id == ap_board.FEATHER_RFM_U2IF:
 346     from adafruit_blinka.board.feather_rfm_u2if import *
 347
 348 elif board_id == ap_board.QTPY_U2IF:
 349     from adafruit_blinka.board.qtpy_u2if import *
 350
 351 elif board_id == ap_board.ITSYBITSY_U2IF:
 352     from adafruit_blinka.board.itsybitsy_u2if import *
 353
 354 elif board_id == ap_board.MACROPAD_U2IF:
 355     from adafruit_blinka.board.macropad_u2if import *
 356
 357 elif board_id == ap_board.QT2040_TRINKEY_U2IF:
 358     from adafruit_blinka.board.qt2040_trinkey_u2if import *
 359
 360 elif board_id == ap_board.KB2040_U2IF:
 361     from adafruit_blinka.board.kb2040_u2if import *
 362
 363 elif board_id == ap_board.LICHEE_RV:
 364     from adafruit_blinka.board.lichee_rv import *
 365
 366 elif board_id == ap_board.SIEMENS_SIMATIC_IOT2050_ADV:
 367     from adafruit_blinka.board.siemens.siemens_iot2050 import *
 368
 369 elif board_id == ap_board.SIEMENS_SIMATIC_IOT2050_BASIC:
 370     from adafruit_blinka.board.siemens.siemens_iot2050 import *
 371
 372 elif board_id == ap_board.AML_S905X_CC:
 373     from adafruit_blinka.board.librecomputer.aml_s905x_cc_v1 import *
 374
 375 elif board_id == ap_board.ROC_RK3328_CC:
 376     from adafruit_blinka.board.librecomputer.roc_rk3328_cc import *
 377
 378 elif board_id == ap_board.REPKA_PI_3_H5:
 379     from adafruit_blinka.board.repkapi.repka_pi_3 import *
 380
 381 elif board_id == ap_board.REPKA_PI_4_H6:
 382     from adafruit_blinka.board.repkapi.repka_pi_4 import *
 383
 384 elif board_id == ap_board.GENERIC_LINUX_PC:
 385     from adafruit_blinka.board.generic_linux_pc import *
 386
 387 elif board_id == ap_board.LICHEEPI_4A:
 388     from adafruit_blinka.board.licheepi_4a import *
 389
 390 elif board_id == ap_board.MILKV_DUO:
 391     from adafruit_blinka.board.milkv_duo import *
 392
 393 elif board_id == ap_board.WALNUT_PI_1B:
 394     from adafruit_blinka.board.walnutpi.walnutpi1b import *
 395
 396 elif board_id == ap_board.OS_AGNOSTIC_BOARD:
 397     from adafruit_blinka.board.generic_agnostic_board import *
 398
 399 elif board_id == ap_board.LUCKFOX_PICO:
 400     from adafruit_blinka.board.luckfox.luckfoxpico import *
 401
 402 elif board_id == ap_board.LUCKFOX_PICO_MINI:
 403     from adafruit_blinka.board.luckfox.luckfoxpico_mini import *
 404
 405 elif board_id == ap_board.LUCKFOX_PICO_PLUS:
 406     from adafruit_blinka.board.luckfox.luckfoxpico_plus import *
 407
 408 elif board_id == ap_board.LUCKFOX_PICO_MAX:
 409     from adafruit_blinka.board.luckfox.luckfoxpico_max import *
 410
 411 elif "sphinx" in sys.modules:
 412     pass
 413
 414 elif board_id is None:
 415     import platform
 416     import pkg_resources
 417
 418     package = str(pkg_resources.get_distribution("adafruit_platformdetect")).split()
 419     raise NotImplementedError(
 420         f"""
 421         {package[0]} version {package[1]} was unable to identify the board and/or
 422         microcontroller running the {platform.system()} platform. Please be sure you
 423         have the latest packages by running:
 424         'pip3 install --upgrade adafruit-blinka adafruit-platformdetect'
 425
 426         If you are running the latest package, your board may not yet be supported. Please
 427         open a New Issue on GitHub at https://github.com/adafruit/Adafruit_Blinka/issues and
 428         select New Board Request.
 429         """
 430     )
 431
 432 else:
 433     raise NotImplementedError(f"Board not supported {board_id}.")
 434
 435 if "SCL" in locals() and "SDA" in locals():
 436
 437     def I2C():
 438         """The singleton I2C interface"""
 439         import busio
 440
 441         return busio.I2C(SCL, SDA)
 442
 443
 444 if "SCLK" in locals() and "MOSI" in locals() and "MISO" in locals():
 445
 446     def SPI():
 447         """The singleton SPI interface"""
 448         import busio
 449
 450         return busio.SPI(SCLK, MOSI, MISO)