Deviceinfo Reference

Variables here are used both when building postmarketOS by tools like pmbootstrap, but also at runtime by other programs like postmarketos-mkinitfs. Any program that wants to read deviceinfo at any point should follow this specification to ensure consistent behaviour.

To edit deviceinfo before building an image, edit the file inside your device’s directory in pmaports. Typically this would be somewhere like ~/.local/var/pmbootstrap/cache_git/pmaports/device/your_device_name/deviceinfo. If you want to edit it on a device where postmarketOS already is installed, edit /etc/deviceinfo. This will override any values set in /usr/share/deviceinfo/deviceinfo. This path is owned by the system and should not be edited by users as this may cause problems after or during system upgrades.

The values of the deviceinfo variables are case sensitive. Most values are lowercase, but there are exceptions such as flash_heimdall_partition_kernel. See the “Datatype” bullet for what kind of value each variable accepts. Booleans should always be written as true or false. Values like True, TRUE, or tRuE are not valid.

“Device variant suffix” refers to a feature supported by some variables where in the case of device packages that support multiple variants, e.g. multiple display panels, the variable can be suffixed by the variant string to only affect installations which use that device variant. For instance, deviceinfo_dtb_kltechn instead of deviceinfo_dtb, where kltechn is the device variant suffix.

Variables

deviceinfo_legacy_uboot_load_address

Set a custom load address for the legacy U-Boot initfs, only makes sense in combination with generate_legacy_uboot_initfs.

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: 80008000

deviceinfo_flash_heimdall_partition_initfs

Only relevant for the heimdall-isorec flash method, the partition where the initramfs will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “RECOVERY”

deviceinfo_usb_serialnumber

Device’s serial number string

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “postmarketOS”

deviceinfo_bootimg_override_initramfs

File name in mkinitfs working dir to be used instead of initramfs file in android boot image.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_boot_part_start

Number of sectors from the start of the drive to place the boot partition. Some devices may need this increased, if their bootloader takes up more space (like the Librem 5).

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: 2048

deviceinfo_boot_filesystem

Sets the filesystem used for the /boot partition containing initramfs-extra

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_amazon_omap_header_size

Prepend a certificate exploit header to boot.img, required by the exploit chain used for most OMAP based Amazon Kindles. Value is typically 1024, 848 for amazon-soho.

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_fastboot_max_size

Set this if the fastboot required by your device has an upper limit to the size of system images it will flash.

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_drm

Defines if the device’s kernel supports the Direct Rendering Manager (DRM). This property is used by pmbootstrap init to hide UIs which require DRM if the device lacks such support.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_bootimg_qcdt

Append dtb file to boot.img

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_cgpt_kpart

Path to the file to be written to kernel partition

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_partition_type

Type of partition table to be generated. The default was changed from msdos to gpt with pmbootstrap 3.0.0

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “gpt”

deviceinfo_generate_depthcharge_image

Set this to true if you want the mkinitfs command to generate a vmlinuz.kpart file after creating the initramfs. Also add depthcharge-tools as dependency to your device’s APKBUILD!

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_flash_sparse

Set this to true if your device expects a sparse system image flashed

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_flash_mtkclient_partition_vbmeta

For AVB devices: set vbmeta partition to be flashed with a custom vbmeta.img which has verity flag disabled.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_dev_internal_storage_repartition

Allow the internal storage to be repartitioned by postmarketOS in the on-device installer. This makes it possible to install from SD card to eMMC.

This is dangerous and should not be enabled for Android devices! For Android devices, we never change the partition table, because the bootloader expects the boot.img to be at a specific partition and changing the partition scheme would likely result in the original OS not being usable anymore.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_vendor_device_tree_identifiers

Space separated list of patterns, used to identify dtb for Android.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_blobpack

Create a flashable blob for the ASUS Transformers from boot.img using BlobTools.

  • Datatype: enumeration: {“sign”, “true”, “false”}

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “false”

deviceinfo_screen_width

The width of the display. Needed if dev_touchscreen_calibration is set.

  • Datatype: integer within the interval [1, 1000000]

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_arch

Device architecture, must be supported by Alpine Linux

  • Datatype: enumeration: {“armhf”, “aarch64”, “riscv64”, “loongarch64”, “x86_64”, “armv7”, “x86”, “ppc64le”, “s390x”}

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_codename

Device codename, e.g. nokia-n900

  • Datatype: string

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_name

Device model, e.g. Nokia N900

  • Datatype: string

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_bootimg_override_payload_compression

Compression method, used to compress override_payload file. Stock bootloader usually expect gzip payload, and fail, if it’s not.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_root_filesystem

Sets the filesystem used for the / partition

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “ext4”

deviceinfo_mkinitfs_postprocess

Define a script to run after generating the initramfs, historically used to append headers/footers to boot.img. Prefer adding this functionality to boot-deploy instead.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_offset_base

Used for flashing

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “0x10000000”

deviceinfo_sd_embed_firmware_step_size

The number of bytes for each increment of the offset specified in sd_embed_firmware

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: 1024

deviceinfo_usb_idVendor

Vendor ID

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “0x18D1”

deviceinfo_flash_offset_ramdisk

Ramdisk offset used for flashing

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_rk_partition_kernel

Only relevant for rk flash method, the partition where the kernel will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_generate_cmdline_txt

If set to true, then boot-deploy puts the kernel cmdline in /boot/cmdline.txt. The option was added for the raspberry pi family of devices.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_flash_fastboot_partition_dtbo

For devices that require dtbo populated: set dtbo partition to be flashed with a custom dtbo.img that’s generated by the linux package

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_no_framebuffer

Do not wait up to 10 seconds until a framebuffer device shows up and do not try to configure it

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_fastboot_partition_kernel

Only relevant for fastboot flash methods, the partition where the kernel or boot.img will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “boot”

deviceinfo_partition_blacklist

A comma-separated list of partitions that should not be flashed, because they brick the device. There are only very few devices where it is necessary (e.g. ouya-ouya).

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_screen_height

The height of the display. Needed if dev_touchscreen_calibration is set.

  • Datatype: integer within the interval [1, 1000000]

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_fastboot_partition_vbmeta

For AVB devices: set vbmeta partition to be flashed with a custom vbmeta.img which has verity flag disabled

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_generate_grub_config

Set this to true for EFI device, so the mkinitfs command will generate a /boot/grub/grub.cfg file after creating the initfs.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_bootimg_override_payload_append_dtb

File name in mkinitfs working dir to be appended to the payload.

Stock bootloader usually expect dtb appended to the payload, and fail, if it’s not.

Usually you should create a dtb with memory and chosen nodes, and install it in a place, where mkinifs script will pick it up, for example board’s u-boot directory.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_mtk_label_ramdisk

Prepend a MediaTek boot header to the initramfs before adding it to boot.img; needed on a select few MediaTek devices.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_fastboot_partition_rootfs

Only relevant for fastboot flash methods, the partition where the rootfs image will be stored (see also: partition-layout).

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “userdata”

deviceinfo_dtb

Name of the device tree blob file (only used on mainline kernels or devices with a header version of 2). See the option append_dtb on how this is used.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: Yes

deviceinfo_flash_heimdall_partition_vbmeta

For AVB devices: set vbmeta partition to be flashed with a custom vbmeta.img which has verity flag disabled

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_dtb_second

Place the dtb in the “second” area of the Android boot image

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_bootimg_prepend_dhtb

Some Samsung devices need 512-byte header prepend to the boot.img before it will even attempt to boot. If is true prepends “DHTB” and 508 NULL bytes to boot.img.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_flash_offset_second

Used for flashing

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_usb_idProduct

Product ID

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “0xD001”

deviceinfo_dev_internal_storage

Path to the internal storage (eMMC) (currently only used by the on-device installer). Only set this if you will use it.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_offset_kernel

Kernel offset used for flashing

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_append_dtb

Set to true if the dtb should be appended to the Linux kernel image, if set to false the dtb will be copied to the /boot partition instead

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: Yes

deviceinfo_create_prep_boot

Whether the image should contain an 8MB PowerPC PReP boot partition as used by Open Firmware or PowerVM devices. The rest of the space will be used by the root partition, no boot partition is created.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_flash_mtkclient_partition_dtbo

For devices that require dtbo populated: set dtbo partition to be flashed with a custom dtbo.img that’s generated by the linux package.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_custom_args

Additional custom arguments to pass to mkbootimg. Caution: adding contents to this variable removes the --header-version and --dtb arguments, which need to be added manually in that case

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_disable_dhcpd

Do not set the static ip to the network interface and do not run the DHCP daemon on it. This makes sense for devices with an ethernet port, like the Raspberry Pi

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_mtkclient_partition_rootfs

Only relevant for MTKClient flash methods, the partition where the system image will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “system”

deviceinfo_chassis

The computer case of your device

  • Datatype: enumeration: {“embedded”, “laptop”, “convertible”, “watch”, “server”, “container”, “vm”, “handset”, “desktop”, “tablet”}

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_initfs_compression

Format and compression level to use when compressing the initramfs. The format for this is: FORMAT:LEVEL, for example zstd:fast. Supported formats are zstd, lz4, lzma, gzip, none. Supported compression levels are: default, fast, best. This option does not impact the initramfs-extra archive, it is generated without any compression

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “gzip:default”

deviceinfo_flash_offset_dtb

Used for flashing on header_version 2

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_override_payload

File name in mkinitfs working dir to be used instead of linux kernel file in android boot image

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_offset_tags

Used for flashing

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_mtk_label_kernel

Prepend a MediaTek boot header to the kernel before adding it to boot.img; needed on a select few MediaTek devices.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_format_version

Used to distinguish between different versions of this file.

  • Datatype: integer

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_header_version

Header version of boot image as defined by Android documentation.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_rk_partition_rootfs

Only relevant for rk flash method, the partition where the rootfs image will be stored

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_cgpt_kpart_start

Number of sectors from the start of the drive to place the kernel partition.

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_dev_touchscreen_calibration

Touchscreen calibration values (only necessary for devices with resistive touchscreen)

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_year

Release year of the device, e.g. 2012

  • Datatype: integer within the interval [1978, 9999)

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_flash_heimdall_partition_kernel

Only relevant for heimdall flash methods, the partition where the kernel or boot.img will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “KERNEL”

deviceinfo_sd_embed_firmware

A comma-separated list of binary:offset (where binary is under /usr/share)

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_depthcharge_compression

Compression type used for vmlinuz by depthcharge-tools

  • Datatype: enumeration: {“lzma”, “none”, “lz4”}

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_kernel_cmdline

Kernel command line (When modifying /etc/deviceinfo: Use kernel_cmdline_append instead. Unless you really want to override the whole kernel command-line, which is usually a bad idea.)

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: Yes

deviceinfo_flash_kernel_on_update

Android devices need the kernel and initramfs to be flashed to a dedicated partition. Set this variable to true to automatically do this with boot-deploy.

This is dangerous and should only be enabled after reading the script and verifying that it works for a given device! Double-check that it will not flash to a wrong partition, otherwise you might render a device unbootable.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_keymaps

Lists keymap options that are available for this device, this will be shown as options in the pmbootstrap init command, this will be passed to Alpine’s setup-keymap command

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_pxa

Set this to true if the device is based on the Marvell PXA1088/1908 chipset, which has header layout differences. Makes mkinitfs generate the boot image with a different mkbootimg. pxa-mkbootimg should be added as a dependency to your device package.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_usb_network_host_addr

Sets the host-side Ethernet address of the ethernet-over-usb link

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_usb_network_udc

Name of the USB Device Controller (UDC) to use, typically found in /sys/class/udc

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_pagesize

Page size (usually 2048)

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_generate_extlinux_config

Set this to true for U-Boot device, so the mkinitfs command will generate a /boot/extlinux/extlinux.conf file after creating the initfs.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_bootimg_append_seandroidenforce

Append SEANDROIDENFORCE file to boot.img

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_generate_legacy_uboot_initfs

For the Nokia N900, we use a legacy version of the U-Boot bootloader. When setting this variable to true, the initramfs will generate an U-Boot legacy compatible initramfs file. Modern versions of U-Boot can load regular initramfs files.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_rootfs_image_sector_size

Some devices made after 2016 with UFS storage use 4096 byte sectors and therefore need this option to boot.

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: 512

deviceinfo_generate_uboot_fit_images

Set true to generate U-boot FIT images, one image per *.its file in board’s u-boot directory

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_dev_touchscreen

Path to the touchscreen device (only necessary if not automatically detected)

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_kernel_cmdline_append

Additional kernel command line. Anything in this variable gets automatically added after kernel_cmdline. The purpose of this is to allow customising the kernel_cmdline by users without having to modify the package shipped by the device package.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_cgpt_kpart_size

Size of kernel partition

  • Datatype: integer

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_heimdall_partition_rootfs

Only relevant for heimdall flash methods, the partition where the system image will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “SYSTEM”

deviceinfo_flash_mtkclient_partition_kernel

Only relevant for MTKClient flash methods, the partition where the kernel or boot.img will be stored.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “boot”

deviceinfo_bootimg_vendor_android_boot_image

Filename. Place your Android boot image in a /boot directory with that name. It also may be copied by pmbootstrap during installation.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_bootimg_vendor_dependent

List of source files for generating boot images, dependent on vendor boot image file presence on a device.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_method

Method used to flash the device

  • Datatype: enumeration: {“uuu”, “fastboot”, “0xffff”, “rkdeveloptool”, “heimdall-bootimg”, “mtkclient”, “heimdall-isorec”, “fastboot-bootpart”, “sp-flash-tool”, “none”}

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “none”

deviceinfo_create_initfs_extra

Instructs mkinitfs to generate an initramfs archive, and an initramfs-extra archive. The initramfs is a minimal archive designed for devices with small boot partitions.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_super_partitions

For Androids with dynamic partitions, set the super partition(s) here.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_generate_bootimg

Set this to true for fastboot device, so the mkinitfs command will generate a boot.img file after creating the initfs. Add mkbootimg as dependency to your device’s APKBUILD!

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_tmp_as_tmpfs_size

The size at which /tmp will be mounted from memory as tmpfs. If set to 0, no mounting will happen.

This value is passed directly to the tmpfs size= param, e.g., 50% and 2g. See man tmpfs for more information.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_manufacturer

Device manufacturer, e.g. Nokia

  • Datatype: string

  • Mandatory: Yes

  • Allows device variant suffix: No

deviceinfo_zram_swap_pct

The size of the ZRAM swap is based on a percentage of the device’s RAM, this allows overriding the default percentage to use in the calculation. If set to 0, ZRAM swap is disabled for the device.

  • Datatype: integer within the interval [0, 100]

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_getty

Configure a getty on boot. Creates an entry in /etc/inittab. Format is <port>;<baudrate> e.g. ttyS0;115200

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_flash_sparse_samsung_format

Generate a sparse image according to Samsung’s own format. Currently the only allowed value is “1”. See solutions for postmarketOS for more informations. In order to work flash_sparse must be set to true in conjunction with this option

  • Datatype: integer within the interval [1, 1]

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_external_storage

Does the device have an SD card slot or other external storage medium?

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_legacy_uboot_image_name

Set a custom uboot image name, required by some device bootloaders that expect a specific image name.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “postmarketos”

deviceinfo_generate_systemd_boot

Generate the configuration for systemd-boot or gummiboot, and install it on the system.

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

deviceinfo_bootimg_qcdt_type

Define the format of dt.img

  • Datatype: enumeration: {“qcom”, “exynos”, “sprd”}

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_depthcharge_board

Board codename used in depthcharge-tools

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_uboot_boardname

Files for each u-boot board are placed under (/usr/share/u-boot/$uboot_boardname in alpine) directory, if u-boot port for device exists. Maybe obtained from board_configs var after : delimiter. A defconfig file exists for each board in u-boot repository in configs/${uboot_boardname}_defconfig file

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

deviceinfo_usb_network_function

Name of the network function to use, located in /config/usb_gadget/g1/functions/

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: “ncm.usb0”

Variables (Obsolete)

deviceinfo_framebuffer_landscape

If set to true, the splash screen will be rotated to landscape mode

  • Datatype: boolean

  • Mandatory: No

  • Allows device variant suffix: No

  • Default value: false

Obsolete: Removed by the switch to pbsplash with no apparent replacement

deviceinfo_dev_keyboard

Path to hardware keyboard

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Originally intended to point osk-sdl to the hardware keyboard, but was never used and osk-sdl has now been replaced by unl0kr.

deviceinfo_mesa_driver

Name of the Mesa driver used by a given device.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: This was used by osk-sdl, which has been replaced by unl0kr.

deviceinfo_modules_initfs

List of kernel modules to include in the initramfs.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Replaced by the modules-initfs file in device packages

deviceinfo_weston_pixman_type

Weston-specific workaround for the “red screen bug”

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Removed as it required patching Weston, kernels should instead be patched to report the right framebuffer mode.

deviceinfo_keyboard

Whether the device has a hardware keyboard

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Programs should automatically detect if the device currently has a keyboard or not (often it can be hotplugged anyway).

deviceinfo_bootimg_mtk_mkimage

Same as bootimg_mtk_label_kernel and bootimg_mtk_label_ramdisk but with hard-coded LABEL values.

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Replaced by bootimg_mtk_label_kernel and bootimg_mtk_label_ramdisk in boot-deploy!49 when it was discovered that not all devices follow the exact same format.

deviceinfo_nonfree

Components of a device that only run with closed-source firmware

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: No devices ever used it.

deviceinfo_flash_fastboot_vendor_id

Passed to the fastboot -i option

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: fastboot used to have a -i option, but this was removed. Since we only had one device using this and nobody to verify if the option is really needed with this device, we decided to remove it. If you are interested in bringing it back, please create a new issue.

deviceinfo_generate_gummiboot

Generate necessary config for and install gummiboot

  • Datatype: string

  • Mandatory: No

  • Allows device variant suffix: No

Obsolete: Removed in boot-deploy 0.11 and effectively replaced by generate_systemd_boot

Renamed variables

deviceinfo_flash_fastboot_partition_system

  • New name: deviceinfo_flash_fastboot_partition_rootfs

  • Rationale: Renamed to avoid confusion

deviceinfo_usb_rndis_function

  • New name: deviceinfo_usb_network_function

  • Rationale: The variable describes the configfs function name to use, no matter if it’s rndis, ncm, ecm or any other function

deviceinfo_gpu_accelerated

  • New name: deviceinfo_drm

  • Rationale: More accurately describes its function; see pmaports#1481 for the reasoning.

deviceinfo_flash_heimdall_partition_system

  • New name: deviceinfo_flash_heimdall_partition_rootfs

  • Rationale: Renamed to avoid confusion