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