1. User manual

Contents:

• 1.1. Introduction
  • 1.1.1. Community
  • 1.1.2. Patch workflow
• 1.2. barebox
  • 1.2.1. Getting barebox
  • 1.2.2. Configuration
  • 1.2.3. Compilation
  • 1.2.4. Starting barebox
  • 1.2.5. First Steps
  • 1.2.6. Building barebox tools
• 1.3. Networking
  • 1.3.1. Network configuration
  • 1.3.2. Network filesystems
  • 1.3.3. Network console
  • 1.3.4. Fastboot over UDP
  • 1.3.5. DSA (Distributed Switch Architecture) Support in barebox
• 1.4. Automount
• 1.5. Memory areas
  • 1.5.1. Examples
• 1.6. Driver model
  • 1.6.1. Device detection
  • 1.6.2. Device parameters
• 1.7. Variables
  • 1.7.1. The global device
  • 1.7.2. Non volatile variables
  • 1.7.3. Non volatile device variables
• 1.8. Magic variables
  • 1.8.1. No prefix
  • 1.8.2. efi.*
  • 1.8.3. fw_cfg.*
  • 1.8.4. global.*
  • 1.8.5. ocotp0.*
  • 1.8.6. soc0.*
  • 1.8.7. arm-specific variables
  • 1.8.8. kvx-specific variables
  • 1.8.9. riscv-specific variables
  • 1.8.10. Board-specific variables
• 1.9. Hush shell
  • 1.9.1. Hush features
• 1.10. Default environment version 2
  • 1.10.1. /env/bin/init
  • 1.10.2. /env/init/
  • 1.10.3. /env/boot/
  • 1.10.4. /env/config
  • 1.10.5. /env/network/
  • 1.10.6. /env/bmode/
  • 1.10.7. /env/devboot/
  • 1.10.8. /env/match.of_compatible/
• 1.11. Updating barebox
  • 1.11.1. Repairing existing boot images
• 1.12. Image MetaData (IMD)
  • 1.12.1. Limitations
  • 1.12.2. IMD and barebox_update
• 1.13. Devicetree support
  • 1.13.1. The internal devicetree
  • 1.13.2. Devicetree commands
  • 1.13.3. Device tree overlays
• 1.14. PreBootLoader images (PBL)
  • 1.14.1. Technical background
• 1.15. Multi Image Support
  • 1.15.1. Technical background
• 1.16. Framebuffer support
  • 1.16.1. Framebuffer splash screen
  • 1.16.2. Framebuffer console
• 1.17. USB support
  • 1.17.1. USB host support
  • 1.17.2. USB device support
  • 1.17.3. USB OTG support
  • 1.17.4. USB Type-C support
  • 1.17.5. USB Gadget autostart Support
• 1.18. UBI/UBIFS support
  • 1.18.1. UBI Fastmap
• 1.19. Booting Linux
  • 1.19.1. Introduction
  • 1.19.2. The bootm command
  • 1.19.3. The boot command
  • 1.19.4. Network boot
  • 1.19.5. mtdparts/blkdevparts fixup
• 1.20. Booting OpenBSD
  • 1.20.1. Basic boot
  • 1.20.2. Framebuffer console
  • 1.20.3. Systems without a serial console
• 1.21. Devboot
  • 1.21.1. Boot overrides
  • 1.21.2. The devboot script
• 1.22. Barebox Bootchooser
  • 1.22.1. Bootchooser Targets
  • 1.22.2. The Bootchooser Algorithm
  • 1.22.3. General Bootchooser Options
  • 1.22.4. Setup Example
  • 1.22.5. Scenarios
  • 1.22.6. Using the State Framework as Backend for Run-Time Variable Data
  • 1.22.7. Using NV Run-Time Variable Data
  • 1.22.8. Updating systems
• 1.23. barebox remote control
  • 1.23.1. Enabling remote control support
  • 1.23.2. Running the bbremote tool
  • 1.23.3. running commands on the target
  • 1.23.4. ping
  • 1.23.5. getenv
  • 1.23.6. interactive console
  • 1.23.7. transferring files
• 1.24. The barebox threat model
  • 1.24.1. barebox’s responsibilities
  • 1.24.2. Assumptions
  • 1.24.3. What classes of problems are not considered vulnerabilities
• 1.25. Security Considerations
  • 1.25.1. Verified Boot
  • 1.25.2. Ensuring barebox is verified
  • 1.25.3. Ensuring the barebox devicetree is verified
  • 1.25.4. Loading firmware
  • 1.25.5. Pinning the FIT configuration
  • 1.25.6. Ensuring the kernel is verified
  • 1.25.7. Prevent the kernel from booting the rootfs in verity boots
  • 1.25.8. Configuring barebox
  • 1.25.9. Security Policy
• 1.26. Security Policies (User Manual)
  • 1.26.1. Overview
  • 1.26.2. Concepts
  • 1.26.3. Usage
  • 1.26.4. Limitations
  • 1.26.5. Trying it out
  • 1.26.6. Differences from Kconfig
  • 1.26.7. Best Practices
• 1.27. Reset Reason
• 1.28. System Restart
• 1.29. Barebox State Framework
  • 1.29.1. Backends (e.g. Supported Memory Types)
  • 1.29.2. Backend-Types (e.g. state Storage Format)
  • 1.29.3. Backend Storage Types (e.g. Media Storage Layout)
  • 1.29.4. Redundant state Variable Set Copies
  • 1.29.5. Handling of Bad Blocks
  • 1.29.6. Examples
  • 1.29.7. Frontend
• 1.30. barebox Artifact Versioning
  • 1.30.1. Query from barebox
  • 1.30.2. Query from OS
  • 1.30.3. Query without booting
• 1.31. Random Number Generator support
  • 1.31.1. API
  • 1.31.2. User interface
• 1.32. OP-TEE
  • 1.32.1. Loading OP-TEE
  • 1.32.2. Communication with OP-TEE
• 1.33. Debugging with OpenOCD
• 1.34. Watchdog Support
  • 1.34.1. Barebox Watchdog Functionality
• 1.35. Reboot Mode
  • 1.35.1. User API
  • 1.35.2. Reset
  • 1.35.3. Disambiguation
• 1.36. VirtIO Support
  • 1.36.1. What’s VirtIO?
  • 1.36.2. Status
  • 1.36.3. Build Instructions
  • 1.36.4. Testing
• 1.37. barebox TLV - Non-Volatile Factory Data Storage
  • 1.37.1. Data Format
  • 1.37.2. Tags
  • 1.37.3. Signature
  • 1.37.4. Data Types
  • 1.37.5. TLV Binary Generation
  • 1.37.6. Data Location
  • 1.37.7. Custom TLV format
• 1.38. Appendix: Development Host Setup
  • 1.38.1. Serial Console Access
  • 1.38.2. Network Access

• Search Page

• Index