Mobile NixOS Options

Enables adbd on the device.

When enabled, fbcon consoles are disabled.

When enabled, plymouth is configured with nice defaults.

Note that this requires an update to the kernel command-line parameters, thus the boot image may need to be reflashed.

Whether silentBoot assumes the kernel logo is used as early splash, or leaves the fbcon unmapped such that (possibly) the vendor splash is kept on the display until the stage-1 boot interface starts.

By default, when using mobile.enable = true, this will assume the kernel is patched to provide the fbcon logo ASAP.

When mobile.enable is false, for example when using the Mobile NixOS stage-1 in a "normal" NixOS configuration, fbcon will not be enabled on VT1. What this means exactly will depend on the platform in use.

List of additional console names to be prepended in the list of consoles in the kernel cmdline.

These will have a lower priority than the console listed in defaultConsole, and assumedly other kernel cmdline parameters added by the user.

This option is useful to add additional consoles like the serial console to the list so that console multiplexing during boot can print messages to it too.

The kernel’s own messages will not be printed on those consoles.

Enables usage of boot-control to mark A/B boot as successful.

When not null, sets a console= parameter early in the kernel cmdline.

This option is useful to control the default console that will be used by the produced system, since otherwise it is impossible to remove an added console= parameter from the cmdline.

When using beautification options with the kernel logo, the console will be set to tty2, "losing" messages to the second VT. Without beautification, this will be set to tty1.

You can also add additional console params to the kernel cmdline, the last valid one in the list will be used for kernel messages by default during boot.

Whether or not to enable the serial console as an additional console.

Whether or not to enable the serial console as an additional console.

The console name for the serial console. Additional parameters allowed.

It will be used as an additional console by default. It can also be set as the default console with mobile.boot.enableDefaultSerial.

Enables bootlogd logging multiplexer.

Enables logging to /dev/kmsg.

Note that this may render switching to stage-2 inoperable.

The compression method for the stage-1 (initrd).

This may be set as a default by some devices requiring specific compression methods. Most likely to work around size limitations.

Additional files for the initrd.

See makeInitrd for use of contents.

When the stage-1 bootloader crashes, prefer rebooting directly to bootloader rather than panic by killing init.

This may be preferrable for devices with direct serial access.

Note that console ramoops requires the kernel to panic, this should be set to false if you rely on console ramoops to debug issues.

Whether to use the Mobile NixOS stage-1 implementation or not.

This will forcible override the NixOS stage-1 when enabled.

Additional packages to be included inside stage-1.

Do note that special manipulation happens and may not be compatible with everything.

The format for extra commands is: { package = package; extraCommand = extraCommand }

Where extraCommand is executed at build time, generally to fix the package for stage-1 use.

Duration (in seconds) before a reboot on failure.

Reboots the device after a delay on failure.

Enables fbterm.

framebuffer to run fbterm on.

List of packages containing firmware files to be included in the stage-1 for the device.

enable splash and boot selection GUI

Minimum delay spent waiting for input devices to settle.

The boot GUI will wait until this many seconds elapsed without changes before starting.

Whether to wait a bit for input devices before starting the user interface.

This is only necessary on "slow" busses where devices may arrive a tad later than expected.

Generally, only enable when a device needed to input the passphrase is connected via USB.

Module names to add to the closure. They will not be modprobed.

Chooses whether the modules closure build fails if a module is missing.

Whether the kernel is built with modules or not. This will enable modules closure generation and listing modules to bundle and load.

Module names to add to the closure. They will be modprobed.

Kernel to be used by the system-type to boot into the Mobile NixOS stage-1.

This is not using a kernelPackages attrset, but a kernel derivation directly.

Whether Mobile NixOS relies on upstream NixOS settings for kernel config.

Enable this when using the NixOS machinery for kernels.

Whether or not to fail when the config file differs when built.

When building a personal configuration, this should be disabled (false) for convenience, as it allows implicitly tracking revision updates.

When in testing scenarios (e.g. building an example system) this should be enabled (true), as it ensures all required configuration is set as expected.

IP address for the USB networking gadget.

Enables networking.

IP address for the USB networking gadget.

Selects the /dev/_ device to use.

Use ttyS0 for serial, tty1 for first VT or keep the default to console for the last defined console= kernel parameter.

Enables a shell before switching root.

This shell (as currently configured) will not allow switching root.

Enables a shell on failures.

Enables ssh during stage-1.

CURRENT CONFIGURATION ALSO OPENS ACCESS TO ALL WITHOUT A PASSWORD NOR SSH KEY.

Enables USB features. For now, only Android-based devices are supported.

android_usb features to enable.

Whether the bootloader configuration for Mobile NixOS is enabled.

Installation and management of the Mobile NixOS bootloading components is not implemented at this point in time. (e.g. flashing boot.img on android, boot partition on other systems.)

Informal option that the end-user can use to get their device’s firmware package.

The firmware will be added to hardware.firmware automatically for most devices.

This is not added automatically to the system firmwares for some devices as some bundles will be unredistributable.

The device’s manufacturer name.

The device’s name as advertised by the manufacturer.

The device’s codename. Must match the device folder.

Support level for the device.

When this setting is set to false, including Mobile NixOS in your NixOS configuration should be a no-op.

Disk image definitions that will be created at build.

Additional commands to run during the disk image build.

Partitions alignment.

Automatically computed partition start position will be aligned to multiples of this value.

The default value is most likely appropriate.

Identifier for the disk.

Creates an hybrid MBR with the given (string) partition numbers.

Up to three partitions can be present in the hybrid MBR, an additional special partition can be placed last, named EE. When EE is present last the protective partition for the GPT will be placed last.

See man sgdisk

Number of partitions in the partition table.

The default value is likely appropriate.

Output path for the image file.

Location of the image in the $out path.

The default value means that $img == $out, which means that the image is bare at the out path.

Other values should start with the directory separator (/), and refer to the desired name.

The $img variable in the build script refers to $out$location.

Identifier for the disk.

Base name of the output

Partitioning scheme for the disk image output.

List of partitions to include in the disk image.

Sets the "legacy bios bootable flag" on the partition.

A filesystem image configuration.

The filesystem image produced by this configuration is the default value for the raw submodule option, unless overriden.

Additional commands to run during the filesystem image build.

Volume ID of the filesystem.

Volume ID of the filesystem.

When size is computed automatically, how many bytes to add to the filesystem total size.

Volume ID of the filesystem.

The default is a number which depends on the file system creation time.

Filesystem used in this filesystem image.

Output path for the image file.

Filesystem label

Not to be confused with either the output name, or the partition label.

Location of the image in the $out path.

The default value means that $img == $out, which means that the image is bare at the out path.

Other values should start with the directory separator (/), and refer to the desired name.

The $img variable in the build script refers to $out$location.

Base name of the output

Commands used to fill the filesystem.

$PWD is the root of the filesystem.

When null, size is computed automatically.

Otherwise sets the size of the filesystem image.

Note that the usable space in the disk image will most likely be smaller than the size given here!

Volume ID of the filesystem.

When set to true, only the length attribute is used, and describes an unpartitioned span in the disk image.

Size in bytes for the partition.

Defaults to the filesystem image length (computed at runtime).

Identifier for the partition.

Offset (in bytes) the partition starts at.

Defaults to the next aligned location on disk.

Partition label on supported partition schemes. Defaults to ${name}.

Not to be confused with filesystem label.

Partition type UUID.

Not to be confused with partitionUUID.

See: https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs

Partition UUID, for supported partition schemes.

Not to be confused with filesystem UUID.

Not to be confused with partitionType.

Raw image to be used as the partition content.

By default uses the output of the filesystem submodule.

For GPT, sets the Required Partition attribute on the partition.

Filesystem definitions that will be created at build.

Additional commands to run during the filesystem image build.

Volume ID of the filesystem.

Volume ID of the filesystem.

When size is computed automatically, how many bytes to add to the filesystem total size.

Volume ID of the filesystem.

The default is a number which depends on the file system creation time.

Filesystem used in this filesystem image.

Output path for the image file.

Filesystem label

Not to be confused with either the output name, or the partition label.

Location of the image in the $out path.

The default value means that $img == $out, which means that the image is bare at the out path.

Other values should start with the directory separator (/), and refer to the desired name.

The $img variable in the build script refers to $out$location.

Base name of the output

Commands used to fill the filesystem.

$PWD is the root of the filesystem.

When null, size is computed automatically.

Otherwise sets the size of the filesystem image.

Note that the usable space in the disk image will most likely be smaller than the size given here!

Volume ID of the filesystem.

Enable to change some defaults so they work better on an eink display.

Enable only the eink changes affecting the theme.

Total RAM available (in MB, 1GB = 1024MB).

This may be used to turn on or off features depending on the device’s capabilities.

Height of the device’s display.

Width of the device’s display.

Give the SOC name for the device.

enable when SOC is Allwinner A64

enable when SOC is Allwinner-R18

enable when SOC is Exynos 7880

enable when SOC is Mediatek MT6755 (Helio P10)

enable when SOC is Mediatek MT6785 (Helio G90)

enable when SOC is Mediatek MT8127

enable when SOC is Mediatek MT8183

enable when SOC is APQ8064–1AA

enable when SOC is msm8939

enable when SOC is msm8940

enable when SOC is msm8953

enable when SOC is msm8996

enable when SOC is msm8998

enable when SOC is 7c (SC7180)

enable when SOC is SDM660

enable when SOC is SDM845

enable when SOC is SM6125

enable when SOC is RK3399-OP1

enable when SOC is RK3399S

Functions returning kernel structured config.

The functions take one argument, an attrset of helpers. These helpers are expected to be used with with, they provide the yes, no, whenOlder and similar helpers from lib.kernel.

The whenHelpers are configured with the appropriate version already.

Combines the derivation output path share/alsa/ucm2/ with pkgs.alsa-ucm-conf and points ALSA to the result.

Enable this on a device which requires the framebuffer to be notified for some components to work right.

With some Samsung phones it is required or else the display will not be updating.

Prefer patching the kernel to enable the framebuffer when the driver inits instead of fixing it in userspace.

Enables use of msm-fb-refresher. Use sparingly, it is better to patch software to flip buffers instead.

Note that while it was written for Qualcomm devices, this workaround may be useful for other vendors too.

Add msm-fb-refresher to stage-1.

It should not be needed for the usual assortment of Mobile NixOS tools. They already handle flipping the framebuffer as needed.

FDT nodes to forward to the kexec’d system.

Pair of [node prop] to forward to the kexec’d system.

Only the prop described on the exact node will be forwarded.

Enable this on a device which requires otg_switch to be configured for OTG to work.

Enable this on a device which requires the framebuffer to be notified for some components to work right.

The most likely thing this fixes is touch input.

Enable this on a mainline-based SC7180 device for modem/Wi-Fi support

Enable this on a mainline-based SDM845 device for modem support

Enable this on a device which uses wcnss wlan.

Set to true when a device, and its kernel, can use kexec.

This will enable booting into the generation’s kernel.

Additional U-Boot commands to run.

Disables MAC address randomization.

This may be required by some hardware or drivers, or combination. When the feature is enabled (quirk disabled) it may cause the wifi interface to disappear when enabled, as long as Network Manager is active.

Whether some of the rootfs configuration is managed by Mobile NixOS or not.

Whether to rehydrate the store at first boot or not.

The only reason you would disable this is to build a target system that has no Nix binaries.

List of dtb files to append to the kernel, when device uses appended DTB.

Defines the kind of target architecture system the device is.

This will automagically setup cross-compilation where possible.

Defines the kind of system the device is.

The different kind of system types will define the outputs produced for the system.

Mapping of logical gadgetfs functions to their implementation names.

USB product ID for the USB gadget.

USB vendor ID for the USB gadget.

The USB gadget implementation the device uses.

Whether to enable Quectel EG25 modem manager service.

The eg25-manager derivation to use.