-
Notifications
You must be signed in to change notification settings - Fork 881
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit adds support for the Raspberry Pi OS debian distribution. It includes a distro definition, 3 modules and integration into other systems like config generation. Signed-off-by: paulober <[email protected]>
- Loading branch information
Showing
42 changed files
with
1,108 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Copyright (C) 2024, Raspberry Pi Ltd. | ||
| # | ||
| # Author: Paul Oberosler <[email protected]> | ||
| # | ||
| # This file is part of cloud-init. See LICENSE file for license information. | ||
|
|
||
| from cloudinit import subp | ||
| from cloudinit.cloud import Cloud | ||
| from cloudinit.config import Config | ||
| from cloudinit.config.schema import MetaSchema | ||
| from cloudinit.settings import PER_INSTANCE | ||
| import logging | ||
|
|
||
|
|
||
| LOG = logging.getLogger(__name__) | ||
| ENABLE_RPI_CONNECT_KEY = "enable_rpi_connect" | ||
|
|
||
| meta: MetaSchema = { | ||
| "id": "cc_rpi_connect", | ||
| "distros": ["raspberry-pi-os"], | ||
| "frequency": PER_INSTANCE, | ||
| "activate_by_schema_keys": [ENABLE_RPI_CONNECT_KEY], | ||
| } | ||
|
|
||
|
|
||
| def configure_rpi_connect(enable: bool) -> None: | ||
| LOG.debug(f"Configuring rpi-connect: {enable}") | ||
|
|
||
| num = 0 if enable else 1 | ||
|
|
||
| try: | ||
| subp.subp(["/usr/bin/raspi-config", "do_rpi_connect", str(num)]) | ||
| except subp.ProcessExecutionError as e: | ||
| LOG.error("Failed to configure rpi-connect: %s", e) | ||
|
|
||
|
|
||
| def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None: | ||
| if ENABLE_RPI_CONNECT_KEY in cfg: | ||
| # expect it to be a dictionary | ||
| enable = cfg[ENABLE_RPI_CONNECT_KEY] | ||
|
|
||
| if isinstance(enable, bool): | ||
| configure_rpi_connect(enable) | ||
| else: | ||
| LOG.warning( | ||
| "Invalid value for %s: %s", ENABLE_RPI_CONNECT_KEY, enable | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| # Copyright (C) 2024, Raspberry Pi Ltd. | ||
| # | ||
| # Author: Paul Oberosler <[email protected]> | ||
| # | ||
| # This file is part of cloud-init. See LICENSE file for license information. | ||
|
|
||
| from cloudinit import subp | ||
| from cloudinit.cloud import Cloud | ||
| from cloudinit.config import Config | ||
| from cloudinit.config.schema import MetaSchema | ||
| from cloudinit.settings import PER_INSTANCE | ||
| import logging | ||
|
|
||
|
|
||
| LOG = logging.getLogger(__name__) | ||
| RPI_INTERFACES_KEY = "rpi_interfaces" | ||
| SUPPORTED_INTERFACES = { | ||
| "spi": "do_spi", | ||
| "i2c": "do_i2c", | ||
| "serial": "do_serial", | ||
| "onewire": "do_onewire", | ||
| "remote_gpio": "do_rgpio", | ||
| "ssh": "enable_ssh", | ||
| } | ||
| RASPI_CONFIG_SERIAL_CONS_FN = "do_serial_cons" | ||
| RASPI_CONFIG_SERIAL_HW_FN = "do_serial_hw" | ||
|
|
||
| meta: MetaSchema = { | ||
| "id": "cc_rpi_interfaces", | ||
| "distros": ["raspberry-pi-os"], | ||
| "frequency": PER_INSTANCE, | ||
| "activate_by_schema_keys": [RPI_INTERFACES_KEY], | ||
| } | ||
|
|
||
|
|
||
| # TODO: test | ||
| def require_reboot(cfg: Config) -> None: | ||
| cfg["power_state"] = cfg.get("power_state", {}) | ||
| cfg["power_state"]["mode"] = cfg["power_state"].get("mode", "reboot") | ||
| cfg["power_state"]["condition"] = True | ||
|
|
||
|
|
||
| def is_pifive() -> bool: | ||
| try: | ||
| subp.subp(["/usr/bin/raspi-config", "nonint", "is_pifive"]) | ||
| return True | ||
| except subp.ProcessExecutionError: | ||
| return False | ||
|
|
||
|
|
||
| def configure_serial_interface(cfg: dict | bool, instCfg: Config) -> None: | ||
| enable_console = False | ||
| enable_hw = False | ||
|
|
||
| if isinstance(cfg, dict): | ||
| enable_console = cfg.get("console", False) | ||
| enable_hw = cfg.get("hardware", False) | ||
| elif isinstance(cfg, bool): | ||
| # default to enabling console as if < pi5 | ||
| # this will also enable the hardware | ||
| enable_console = cfg | ||
|
|
||
| if not is_pifive() and enable_console: | ||
| # only pi5 has 2 usable UARTs | ||
| # on other models, enabling the console | ||
| # will also block the other UART | ||
| enable_hw = True | ||
|
|
||
| try: | ||
| subp.subp( | ||
| [ | ||
| "/usr/bin/raspi-config", | ||
| "nonint", | ||
| RASPI_CONFIG_SERIAL_CONS_FN, | ||
| str(0 if enable_console else 1), | ||
| ] | ||
| ) | ||
|
|
||
| try: | ||
| subp.subp( | ||
| [ | ||
| "/usr/bin/raspi-config", | ||
| "nonint", | ||
| RASPI_CONFIG_SERIAL_HW_FN, | ||
| str(0 if enable_hw else 1), | ||
| ] | ||
| ) | ||
| except subp.ProcessExecutionError as e: | ||
| LOG.error("Failed to configure serial hardware: %s", e) | ||
|
|
||
| require_reboot(instCfg) | ||
| except subp.ProcessExecutionError as e: | ||
| LOG.error("Failed to configure serial console: %s", e) | ||
|
|
||
|
|
||
| def enable_ssh(cfg: Config, enable: bool) -> None: | ||
| if not enable: | ||
| return | ||
|
|
||
| try: | ||
| subp.subp( | ||
| [ | ||
| "/usr/lib/raspberry-pi-sys-mods/imager_custom", | ||
| SUPPORTED_INTERFACES["ssh"], | ||
| ] | ||
| ) | ||
| require_reboot(cfg) | ||
| except subp.ProcessExecutionError as e: | ||
| LOG.error("Failed to enable ssh: %s", e) | ||
|
|
||
|
|
||
| def configure_interface(iface: str, enable: bool) -> None: | ||
| assert ( | ||
| iface in SUPPORTED_INTERFACES.keys() and iface != "serial" | ||
| ), f"Unsupported interface: {iface}" | ||
|
|
||
| try: | ||
| subp.subp( | ||
| [ | ||
| "/usr/bin/raspi-config", | ||
| "nonint", | ||
| SUPPORTED_INTERFACES[iface], | ||
| str(0 if enable else 1), | ||
| ] | ||
| ) | ||
| except subp.ProcessExecutionError as e: | ||
| LOG.error("Failed to configure %s: %s", iface, e) | ||
|
|
||
|
|
||
| def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None: | ||
| if RPI_INTERFACES_KEY not in cfg: | ||
| return | ||
| elif not isinstance(cfg[RPI_INTERFACES_KEY], dict): | ||
| LOG.warning( | ||
| "Invalid value for %s: %s", | ||
| RPI_INTERFACES_KEY, | ||
| cfg[RPI_INTERFACES_KEY], | ||
| ) | ||
| return | ||
| elif not cfg[RPI_INTERFACES_KEY]: | ||
| LOG.debug("Empty value for %s. Skipping...", RPI_INTERFACES_KEY) | ||
| return | ||
|
|
||
| # check for supported ARM interfaces | ||
| for key in cfg[RPI_INTERFACES_KEY]: | ||
| if key not in SUPPORTED_INTERFACES.keys(): | ||
| LOG.warning("Invalid key for %s: %s", RPI_INTERFACES_KEY, key) | ||
| continue | ||
|
|
||
| enable = cfg[RPI_INTERFACES_KEY][key] | ||
|
|
||
| if key == "serial": | ||
| if not isinstance(enable, dict) and not isinstance(enable, bool): | ||
| LOG.warning( | ||
| "Invalid value for %s.%s: %s", | ||
| RPI_INTERFACES_KEY, | ||
| key, | ||
| enable, | ||
| ) | ||
| else: | ||
| configure_serial_interface(enable, cfg) | ||
| continue | ||
| elif key == "ssh": | ||
| if not isinstance(enable, bool): | ||
| LOG.warning( | ||
| "Invalid value for %s.%s: %s", | ||
| RPI_INTERFACES_KEY, | ||
| key, | ||
| enable, | ||
| ) | ||
| else: | ||
| enable_ssh(cfg, enable) | ||
| continue | ||
|
|
||
| if isinstance(enable, bool): | ||
| configure_interface(key, enable) | ||
| else: | ||
| LOG.warning( | ||
| "Invalid value for %s.%s: %s", RPI_INTERFACES_KEY, key, enable | ||
| ) |
Oops, something went wrong.