U-Boot - Revision history

Pigs: Add category booting

2025-05-18T16:48:46Z

Add category booting

← Older revision		Revision as of 16:48, 18 May 2025
Line 1:		Line 1:
	~~'''~~U-Boot~~'''~~ is a common '''''platform firmware''''' implementation for embedded and embedded-like devices.		[https://www.u-boot.org/ U-Boot] is a common '''''platform firmware''''' implementation for embedded and embedded-like devices.

	It may also be used as a bootloader, but with modern U-Boot, [[UEFI]] boot is generally possible too.		It may also be used as a bootloader, but with modern U-Boot, [[UEFI]] boot is generally possible too.
Line 108:		Line 108:
	* [https://source.denx.de/u-boot/u-boot Official U-Boot source repo]		* [https://source.denx.de/u-boot/u-boot Official U-Boot source repo]
	* [https://docs.u-boot.org/ Official U-Boot documentation]		* [https://docs.u-boot.org/ Official U-Boot documentation]

			[[Category:Booting]]

Samueldr: /* Vendor U-Boot */ Define what is meant

2024-04-07T04:58:33Z

Vendor U-Boot: Define what is meant

← Older revision		Revision as of 04:58, 7 April 2024
Line 83:		Line 83:

	== Vendor U-Boot ==		== Vendor U-Boot ==

			The term ''vendor U-Boot'' means the provided pre-built U-Boot binaries and the source as well. It generally implies use of an older fork of U-Boot from a ''BSP'' (''Board Support Package'').

	Vendor U-Boot may or may not work to boot and use NixOS.		Vendor U-Boot may or may not work to boot and use NixOS.

Samueldr: Add a section about using U-Boot with NixOS

2024-04-07T04:20:55Z

Add a section about using U-Boot with NixOS

← Older revision		Revision as of 04:20, 7 April 2024
Line 59:		Line 59:
	</syntaxhighlight>		</syntaxhighlight>

	=== ~~Using~~ U-Boot ===		=== Installing U-Boot ===
	You will need to consult either the [https://docs.u-boot.org/ Official U-Boot documentation], or a board-specific page to find out how to use the produced output.		You will need to consult either the [https://docs.u-boot.org/ Official U-Boot documentation], or a board-specific page to find out how to use the produced output.

Line 68:		Line 68:
	* [[NixOS on ARM]]		* [[NixOS on ARM]]
	* [[NixOS on RISCV/VisionFive 2\|NixOS on RISCV]]		* [[NixOS on RISCV/VisionFive 2\|NixOS on RISCV]]

			== Using NixOS with U-Boot ==
			{{Note\|This section assumes U-Boot is installed already.}}
			With U-Boot, NixOS currently still assumes use of [https://docs.u-boot.org/en/v2024.04/develop/distro.html U-Boot's Generic Distro Configuration Concept] as the mechanism for discoverable boot. The preferred scheme is ''extlinux-compatible''. This is how the kernel <code>Image</code>, <code>initrd</code>, dtb, and Kernel command-line arguments are provided with complete support for the lifecycles of generations.

			Note that U-Boot is moving to [https://docs.u-boot.org/en/v2024.04/develop/bootstd.html ''U-Boot Standard Boot'']. How it affects the assumptions from NixOS is still not documented.

			Booting through UEFI with U-Boot should work. Booting with UEFI is tentatively supported, with intent of being the only fully supported boot method in the future. See [[NixOS on ARM/UEFI]], which describes part of the drawbacks.

			=== Quick overview about the Generic Distro Configuration support ===
			U-Boot is scripted to scan all attached storage devices and partitions, and look for a file named <code>/extlinux/extlinux.conf</code> or <code>/boot/extlinux/extlinux.conf</code>. This will will be generated by NixOS when configured with {{Nixos:option\|boot.loader.generic-extlinux-compatible.enable}}.

			The partition also needs to '''have its "bootable" flag set'''. This is true for ''both MBR and GPT partitioning schemes''.

	== Vendor U-Boot ==		== Vendor U-Boot ==

Samueldr: Rework example build

2024-04-07T04:03:51Z

Rework example build

← Older revision		Revision as of 04:03, 7 April 2024
Line 15:		Line 15:
	You need to know two things:		You need to know two things:

	# The target ~~architecture~~		# The target ISA (''Instruction Set Architecture'')
	# If you need to cross-compile		# If you need to cross-compile

	The target ~~architecture~~ is the ''~~architecture~~'' of the ~~target board. For example,~~ the ~~<code>LibreTechCC</code>~~ board ~~uses the <code>AArch64</code> ''architecture''~~.		The target ISA is the ISA of the ''target board''. This would be defined by the CPU used on the board.

	You will need to cross-compile if you are not building on the same ''architecture'' as the target board. For example, if you are building on a standard <code>x86_64</code> laptop, you would need to cross-compile.		You will need to cross-compile if you are not building on the same ''architecture'' as the target board. For example, if you are building for an <code>AArch64</code> ''target board'' on a standard <code>x86_64</code> laptop, you would need to cross-compile.

	With those facts known, you can build the appropriate attribute from a Nixpkgs checkout.		With those facts known, you can build the appropriate attribute from a Nixpkgs checkout.
Line 27:		Line 27:
	$ nix-build -A [pkgsCross.$cross_name.]$packageName		$ nix-build -A [pkgsCross.$cross_name.]$packageName
	$ # Where the part in [brackets] is needed for cross-compilation.		$ # Where the part in [brackets] is needed for cross-compilation.
	~~</syntaxhighlight>To build with cross-compilation, you will need to prefix with the correct cross-compilation package set:<syntaxhighlight lang="shell-session">~~
	~~$ # Example running on x86_64.~~
	~~$ uname -m~~
	~~x86_64~~

	~~$ nix-build -A pkgsCross.aarch64-multiplatform.ubootLibreTechCC~~
	~~</syntaxhighlight>If, instead, you are building natively (same architecture) you can refer to the package attribute name directly:<syntaxhighlight lang="shell-session">~~
	~~$ # Example output for an AArch64 system.~~
	~~$ uname -m~~
	~~aarch64~~

	~~$ nix-build -A ubootLibreTechCC~~
	</syntaxhighlight>		</syntaxhighlight>

	~~=== <code>pkgsCross</code> Cheat sheet ===~~
	{\| class="wikitable"		{\| class="wikitable"
			\|+
			<code>pkgsCross</code> attribute name cheat sheet
	!Architecture		!Architecture
	!Package Set		!Package Set
Line 55:		Line 43:
	\|<code>raspberryPi</code> ''[sic]''		\|<code>raspberryPi</code> ''[sic]''
	\|}		\|}

			==== Example build ====
			The following examples use the U-Boot package for a ''LibreTech CC ‘LePotato’'', which uses an ''S905X'' SoC. This SoC uses an <code>AArch64</code> ISA.

			To build the package with cross-compilation, you need to prefix with the correct cross-compilation package set:<syntaxhighlight lang="shell-session">
			$ # Example running on x86_64.
			$ uname -m
			x86_64
			$ nix-build -A pkgsCross.aarch64-multiplatform.ubootLibreTechCC
			</syntaxhighlight>If, instead, you are building natively (same architecture) you can refer to the package attribute name directly:<syntaxhighlight lang="shell-session">
			$ # Example output for an AArch64 system.
			$ uname -m
			aarch64
			$ nix-build -A ubootLibreTechCC
			</syntaxhighlight>

	=== Using U-Boot ===		=== Using U-Boot ===
	You will need to consult either the [https://docs.u-boot.org/ Official U-Boot documentation], or a board-specific page to find out how to use the produced output.		You will need to consult either the [https://docs.u-boot.org/ Official U-Boot documentation], or a board-specific page to find out how to use the produced output.

	The large variety of ecosystems supported by U-Boot makes it impossible to document ~~succintly~~.		The large variety of ecosystems supported by U-Boot makes it impossible to document succinctly.

	==== SBC and related projects in NixOS ====		==== SBC and related projects in NixOS ====
Line 76:		Line 79:

	== Other U-Boot distributions ==		== Other U-Boot distributions ==
	There exists other ~~prebuilt~~ U-Boot distributions. As long as they follow the mainline U-Boot semantics, and are close enough in age to the current releases, they should work to boot NixOS.		There exists other pre-built U-Boot distributions. As long as they follow the mainline U-Boot semantics, and are close enough in age to the current releases, they should work to boot NixOS.

	=== Tow-Boot ===		=== Tow-Boot ===

Samueldr: Add notes about usage (or rather lack of notes about usage)

2024-04-07T03:48:35Z

Add notes about usage (or rather lack of notes about usage)

@@ Line 55: / Line 55: @@
 |<code>raspberryPi</code> ''[sic]''
 |}
 == Vendor U-Boot ==

Samueldr: Add some external links

2024-04-07T03:39:02Z

Add some external links

← Older revision		Revision as of 03:39, 7 April 2024
Line 1:		Line 1:
	'''U-Boot''' is a common '''''platform firmware''''' implementation for embedded and embedded-like devices.		'''U-Boot''' is a common '''''platform firmware''''' implementation for embedded and embedded-like devices.

	It may also be used as a bootloader, but with modern U-Boot, UEFI boot is generally possible too.		It may also be used as a bootloader, but with modern U-Boot, [[UEFI]] boot is generally possible too.

	== U-Boot in Nixpkgs ==		== U-Boot in Nixpkgs ==
Line 72:		Line 72:
	Stock NixOS should be assumed to work with Tow-Boot, always depending on the boot method and kernel in use.		Stock NixOS should be assumed to work with Tow-Boot, always depending on the boot method and kernel in use.

	Tow-Boot is currently used as a reference as the only distro-agnostic U-Boot build, for support purposes.		[https://tow-boot.org/ Tow-Boot] is currently used as a reference as the only distro-agnostic U-Boot build, for support purposes.

	== See also ==		== See also ==

	* [[NixOS on ARM/UEFI]]		* [[NixOS on ARM/UEFI]]
			* [https://source.denx.de/u-boot/u-boot Official U-Boot source repo]
			* [https://docs.u-boot.org/ Official U-Boot documentation]

Samueldr: Add more details

2024-04-07T03:34:22Z

Add more details

← Older revision		Revision as of 03:34, 7 April 2024
Line 3:		Line 3:
	It may also be used as a bootloader, but with modern U-Boot, UEFI boot is generally possible too.		It may also be used as a bootloader, but with modern U-Boot, UEFI boot is generally possible too.

	=== U-Boot in Nixpkgs ===		== U-Boot in Nixpkgs ==
	Mainline U-Boot is packaged in Nixpkgs.		Mainline U-Boot is packaged in Nixpkgs.

Line 12:		Line 12:
	U-Boot may be patched for compatibility reasons mainly, and work should be taken to send them to mainline U-Boot.		U-Boot may be patched for compatibility reasons mainly, and work should be taken to send them to mainline U-Boot.

	==== Building a packaged U-Boot ====		=== Building a packaged U-Boot ===
	You need to know two things:		You need to know two things:

Line 41:		Line 41:
	</syntaxhighlight>		</syntaxhighlight>

	===== <code>pkgsCross</code> Cheat sheet =====		=== <code>pkgsCross</code> Cheat sheet ===
	{\| class="wikitable"		{\| class="wikitable"
	!Architecture		!Architecture
Line 55:		Line 55:
	\|<code>raspberryPi</code> ''[sic]''		\|<code>raspberryPi</code> ''[sic]''
	\|}		\|}

			== Vendor U-Boot ==
			Vendor U-Boot may or may not work to boot and use NixOS.

			The answer is actually really complicated, and depends not only about U-Boot, but the intended Linux kernel to be booted, and the boot method in use.

			The <code>buildUBoot</code> implementation in Nixpkgs may or may not work to build a vendor U-Boot, and this usage is unsupported.

			A few vendors ship good pre-built modern U-Boot implementations. Booting NixOS with those ''should work''. If it does not, things may need to be fixed on any of the end. But also, this depends on the kernel, and boot method in use.

			== Other U-Boot distributions ==
			There exists other prebuilt U-Boot distributions. As long as they follow the mainline U-Boot semantics, and are close enough in age to the current releases, they should work to boot NixOS.

			=== Tow-Boot ===
			{{Aside\|Tow-Boot is not a NixOS project.<br />Though it is built with Nix expressions, and made by authors involved with the NixOS project.}}
			Stock NixOS should be assumed to work with Tow-Boot, always depending on the boot method and kernel in use.

			Tow-Boot is currently used as a reference as the only distro-agnostic U-Boot build, for support purposes.

			== See also ==

			* [[NixOS on ARM/UEFI]]

Samueldr: Fixups

2024-04-07T03:25:14Z

Fixups

← Older revision		Revision as of 03:25, 7 April 2024
Line 6:		Line 6:
	Mainline U-Boot is packaged in Nixpkgs.		Mainline U-Boot is packaged in Nixpkgs.

	* {{Nixpkgs Link}}		* {{Nixpkgs Link\|pkgs/misc/uboot/default.nix}}

	Vendor forks of U-Boot is generally not ~~part~~ packaged in Nixpkgs, and generally unwelcome.		Vendor forks of U-Boot are generally not packaged in Nixpkgs, and generally unwelcome.

	U-Boot may be patched for compatibility reasons mainly, and work should be taken to send them to mainline U-Boot.		U-Boot may be patched for compatibility reasons mainly, and work should be taken to send them to mainline U-Boot.

Samueldr: Initial U-Boot page

2024-04-07T03:21:15Z

Initial U-Boot page

New page

'''U-Boot''' is a common '''''platform firmware''''' implementation for embedded and embedded-like devices.

It may also be used as a bootloader, but with modern U-Boot, UEFI boot is generally possible too.

=== U-Boot in Nixpkgs ===
Mainline U-Boot is packaged in Nixpkgs.

* {{Nixpkgs Link}}

Vendor forks of U-Boot is generally not part packaged in Nixpkgs, and generally unwelcome.

U-Boot may be patched for compatibility reasons mainly, and work should be taken to send them to mainline U-Boot.

==== Building a packaged U-Boot ====
You need to know two things:

# The target architecture
# If you need to cross-compile

The target architecture is the ''architecture'' of the target board. For example, the <code>LibreTechCC</code> board uses the <code>AArch64</code> ''architecture''.

You will need to cross-compile if you are not building on the same ''architecture'' as the target board. For example, if you are building on a standard <code>x86_64</code> laptop, you would need to cross-compile.

With those facts known, you can build the appropriate attribute from a Nixpkgs checkout.

The general format is:<syntaxhighlight lang="shell-session">
$ nix-build -A [pkgsCross.$cross_name.]$packageName
$ # Where the part in [brackets] is needed for cross-compilation.
</syntaxhighlight>To build with cross-compilation, you will need to prefix with the correct cross-compilation package set:<syntaxhighlight lang="shell-session">
$ # Example running on x86_64.
$ uname -m
x86_64

$ nix-build -A pkgsCross.aarch64-multiplatform.ubootLibreTechCC
</syntaxhighlight>If, instead, you are building natively (same architecture) you can refer to the package attribute name directly:<syntaxhighlight lang="shell-session">
$ # Example output for an AArch64 system.
$ uname -m
aarch64

$ nix-build -A ubootLibreTechCC
</syntaxhighlight>

===== <code>pkgsCross</code> Cheat sheet =====
{| class="wikitable"
!Architecture
!Package Set
|-
|<code>aarch64</code>
|<code>aarch64-multiplatform</code>
|-
|<code>armv7l</code>
|<code>armv7l-hf-multiplatform</code>
|-
|<code>armv6l</code>
|<code>raspberryPi</code> ''[sic]''
|}