3. Command reference

3.1. Information

• 3.1.1. at91clk - list clock configuration
• 3.1.2. blkstats - display block layer statistics
• 3.1.3. bootrom - Interact with BootROM on i.MX8M
• 3.1.4. class - show information about classes
• 3.1.5. clk_dump - show information about registered clocks
• 3.1.6. cpuinfo - show info about CPUshow CPU informationshow CPU informationshow CPU informationshow info about CPUshow CPU information
• 3.1.7. devinfo - show information about devices
• 3.1.8. devunbind - unbind device(s) from driver
• 3.1.9. dhrystone - run dhrystone test, specify number of runs
• 3.1.10. dmesg - Print or control log messages
• 3.1.11. drvinfo - list compiled-in device drivers
• 3.1.12. gpioinfo - list registered GPIOs
• 3.1.13. help - print online help
• 3.1.14. imd - extract metadata from barebox binary
• 3.1.15. iomem - show IO memory usage
• 3.1.16. ioport - show IO port usage
• 3.1.17. lspci - show PCI info
• 3.1.18. meminfo - print info about memory usage
• 3.1.19. mmuinfo - show MMU/cache information of an address
• 3.1.20. next - navigate the barebox tutorial
• 3.1.21. pm_domain - list power domains
• 3.1.22. reginfo - print MPC5200 register information
• 3.1.23. version - print barebox version

3.2. Booting

• 3.2.1. at91_boot_test - load and execute from SRAM
• 3.2.2. boot - boot from script, device, …
• 3.2.3. boot_order - set OMAP warm boot order
• 3.2.4. bootm - boot an application image
• 3.2.5. bootu - boot into already loaded Linux kernel
• 3.2.6. bootz - boot Linux zImage
• 3.2.7. fiptool - inspect and manipulate TF-A firmware image packages
• 3.2.8. go - start application at address or file
• 3.2.9. loadb - load binary file over serial line (Kermit)
• 3.2.10. loads - load binary file over serial line (S-Records)
• 3.2.11. loadx - load binary file over serial line (X-Modem)
• 3.2.12. loady - load binary file over serial line (Y-Modem)
• 3.2.13. reset - perform RESET of the CPU
• 3.2.14. saves - save file over serial line (S-Records)
• 3.2.15. uimage - extract/verify uImage

3.3. Partitions and Filesystems

• 3.3.1. addpart - add a partition description to a device
• 3.3.2. automount - execute (mount) COMMAND when PATH is first accessed
• 3.3.3. delpart - delete partition(s)
• 3.3.4. mount - mount a filesystem or list mounted filesystems
• 3.3.5. ubiattach - attach mtd device to UBI
• 3.3.6. ubidetach - detach an UBI device
• 3.3.7. ubiformat - format an ubi volume
• 3.3.8. ubimkvol - create an UBI volume
• 3.3.9. ubirename - rename UBI volume(s)
• 3.3.10. ubirmvol - delete an UBI volume
• 3.3.11. ubiupdatevol - Update an UBI volume
• 3.3.12. umount - umount a filesystem

3.4. Environment

• 3.4.1. defaultenv - Restore environment from default environment
• 3.4.2. export - export environment variables
• 3.4.3. global - create or set global variables
• 3.4.4. loadenv - load environment from ENVFS
• 3.4.5. magicvar - list information about magic variables
• 3.4.6. nv - create, set or remove non volatile (NV) variables
• 3.4.7. printenv - print value of environment variables
• 3.4.8. saveenv - save environment to persistent storage
• 3.4.9. setenv - set environment variable

3.5. Files

• 3.5.1. basename - strip directory and suffix from filenames
• 3.5.2. cat - concatenate file(s) to stdout
• 3.5.3. cd - change working directory
• 3.5.4. cmp - compare two files
• 3.5.5. cp - copy files
• 3.5.6. digest - calculate digest
• 3.5.7. dirname - strip last component from a path
• 3.5.8. filetype - detect file type
• 3.5.9. findmnt - find a file system
• 3.5.10. ll - list a file or directory with details
• 3.5.11. ln - create symlink (make a new name for a file)
• 3.5.12. ls - list a file or directory
• 3.5.13. md5sum - calculate MD5 checksum
• 3.5.14. mkdir - make directories
• 3.5.15. parted - edit partition tables
• 3.5.16. pwd - print working directory
• 3.5.17. readlink - read value of a symbolic link or canonical file name
• 3.5.18. rm - remove files
• 3.5.19. rmdir - remove empty directory(s)
• 3.5.20. sha1sum - calculate SHA1 digest
• 3.5.21. sha224sum - calculate SHA224 digest
• 3.5.22. sha256sum - calculate SHA256 digest
• 3.5.23. sha384sum - calculate SHA384 digest
• 3.5.24. sha512sum - calculate SHA512 digest
• 3.5.25. stat - display file status
• 3.5.26. uncompress - uncompress a compressed file

3.6. Shell Scripting

• 3.6.1. devlookup - look up device behind device file and its parameters
• 3.6.2. exec - execute a script
• 3.6.3. exit - exit script
• 3.6.4. false - do nothing, unsuccessfully
• 3.6.5. getopt - parse option arguments
• 3.6.6. let - evaluate arithmetic expressions
• 3.6.7. msleep - delay execution for n milli-seconds
• 3.6.8. readf - read file into variable
• 3.6.9. sh - execute a shell script
• 3.6.10. sleep - delay execution for n seconds
• 3.6.11. source - execute shell script in current shell environment
• 3.6.12. test - minimal test command like in /bin/sh
• 3.6.13. true - do nothing, successfully

3.7. Console and Framebuffer

• 3.7.1. beep - play a GRUB beep tune
• 3.7.2. clear - clear screen
• 3.7.3. echo - echo args to console
• 3.7.4. edit - a small full-screen editor
• 3.7.5. fbtest - display a test pattern
• 3.7.6. login - ask for a password
• 3.7.7. menu - create and display menus
• 3.7.8. menutree - create menu from directory structure
• 3.7.9. mmc_extcsd - Read/write the extended CSD register.
• 3.7.10. passwd - set password
• 3.7.11. readline - prompt for user input
• 3.7.12. splash - display a BMP or PNG splash image
• 3.7.13. timeout - wait for a specified timeout

3.8. Memory

• 3.8.1. crc32 - CRC32 checksum calculation
• 3.8.2. md - memory display
• 3.8.3. memcmp - memory compare
• 3.8.4. memcpy - memory copy
• 3.8.5. memset - memory fill
• 3.8.6. memtest - extensive memory test
• 3.8.7. memtester - memory stress-testing
• 3.8.8. mm - memory modify with mask
• 3.8.9. mw - memory write

3.9. Hardware Manipulation

• 3.9.1. bcb - writes a i.MX23/28 BCB data structure to flash
• 3.9.2. blobgen - en/decrypt blobs
• 3.9.3. clk_disable - disable a clock
• 3.9.4. clk_enable - enable a clock
• 3.9.5. clk_get_rate - get a clocks rate
• 3.9.6. clk_round_rate - show a resulting clocks rate
• 3.9.7. clk_set_parent - set parent of a clock
• 3.9.8. clk_set_rate - set a clocks rate
• 3.9.9. detect - detect devices
• 3.9.10. erase - erase flash memory
• 3.9.11. gpio_direction_input - set direction of a GPIO pin to input
• 3.9.12. gpio_direction_output - set direction of a GPIO pin to output
• 3.9.13. gpio_get_value - return value of a GPIO pin
• 3.9.14. gpio_set_value - set a GPIO’s output value
• 3.9.15. hab - Handle i.MX HAB
• 3.9.16. hwclock - query or set the hardware clock (RTC)
• 3.9.17. hwmon - query hardware sensors (HWMON)
• 3.9.18. i2c_probe - probe for an i2c device
• 3.9.19. i2c_read - read from an i2c device
• 3.9.20. i2c_write - write to an i2c device
• 3.9.21. led - control LEDs
• 3.9.22. mipi_dbi - write/read from MIPI DBI SPI device
• 3.9.23. mmc
• 3.9.24. nand - NAND flash handling
• 3.9.25. nand_bitflip - Create bitflips on Nand pages
• 3.9.26. nandtest - NAND flash memory test
• 3.9.27. nvmem - list nvmem devices
• 3.9.28. poweroff - turn the power off
• 3.9.29. protect - enable flash write protection
• 3.9.30. pwm - pwm
• 3.9.31. rave_reset_switch - reset ethernet switch on RDU
• 3.9.32. regulator - list and control regulators
• 3.9.33. spd_decode - Decode SPD EEPROM
• 3.9.34. spi - write/read from SPI device
• 3.9.35. sync - flush cached writes
• 3.9.36. tegrarcm - Usage: tegrarcm
• 3.9.37. trigger - handle LED triggers
• 3.9.38. unprotect - disable flash write protection
• 3.9.39. usb - (re-)detect USB devices
• 3.9.40. usbgadget - Create USB Gadget multifunction device
• 3.9.41. usbserial - serial gadget enable/disable
• 3.9.42. wd - enable/disable/trigger the watchdog

3.10. Miscellaneous

• 3.10.1. 2048 - the 2048 game
• 3.10.2. barebox_update - update barebox to persistent media
• 3.10.3. bootchooser - bootchooser control
• 3.10.4. bthread - print info about registered bthreads
• 3.10.5. debug_fs_dump
• 3.10.6. dfu - device firmware update
• 3.10.7. efi_handle_dump - Usage: efi_handle_dump
• 3.10.8. efiexit - Leave barebox and return to the calling EFI process
• 3.10.9. fcb - Dump Flash Control Block (FCB)
• 3.10.10. firmwareload - Program a firmware file into a device
• 3.10.11. insmod - load a barebox module
• 3.10.12. ip - Show network interfaces, addresses, and routes
• 3.10.13. ip_route_get - get ethernet device name for an IP address
• 3.10.14. k3_authenticate_image - authenticate file with K3 ROM API
• 3.10.15. kallsyms - query kallsyms table
• 3.10.16. kasan_tests - Run KAsan tests
• 3.10.17. keystore - manage keys
• 3.10.18. linux_exec - execute a command on the host
• 3.10.19. lookup_dentry
• 3.10.20. lsmod - list loaded barebox modules
• 3.10.21. of_compatible - Check DT node’s compatible
• 3.10.22. of_diff - diff device trees
• 3.10.23. of_display_timings - print and select display-timings
• 3.10.24. of_dump - dump devicetree nodes
• 3.10.25. of_fixup - list and enable/disable fixups
• 3.10.26. of_fixup_status - register a fixup to enable or disable node
• 3.10.27. of_node - create/delete nodes in the device tree
• 3.10.28. of_overlay - register device tree overlay
• 3.10.29. of_property - handle device tree properties
• 3.10.30. oftree - handle device trees
• 3.10.31. poller - print info about registered pollers
• 3.10.32. seed - seed the PRNG
• 3.10.33. selftest - Run selftests
• 3.10.34. slice - debug slices
• 3.10.35. smc - secure monitor test command
• 3.10.36. stacksmash - Run stack smashing tests
• 3.10.37. state - load or save state information
• 3.10.38. time - measure execution duration of a command
• 3.10.39. ubsan - trigger undefined behavior for UBSAN to detect
• 3.10.40. uptime - Tell how long barebox has been running
• 3.10.41. watch - run program periodically

3.11. Networking

• 3.11.1. dhcp - DHCP client to obtain IP or boot params
• 3.11.2. ethlog - ETHLOG - tool to get dump of Ethernet packets
• 3.11.3. host - resolve a hostname
• 3.11.4. ifdown - disable a network interface
• 3.11.5. ifup - bring a network interface up
• 3.11.6. miitool - view media-independent interface status
• 3.11.7. nfs - boot image over NFS
• 3.11.8. ping - send ICMP echo requests
• 3.11.9. tftp - load (or save) a file using TFTP