| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+: |
| 2 | |
| Heinrich Schuchardt | 1b0c316 | 2024-01-14 14:53:13 +0100 | [diff] [blame] | 3 | .. index:: |
| 4 | single: bootmeth (command) |
| 5 | |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 6 | bootmeth command |
| 7 | ================ |
| 8 | |
| Heinrich Schuchardt | 44b09b3 | 2024-03-16 11:09:36 +0100 | [diff] [blame] | 9 | Synopsis |
| 10 | -------- |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 11 | |
| 12 | :: |
| 13 | |
| 14 | bootmeth list [-a] - list selected bootmeths (-a for all) |
| 15 | bootmeth order "[<bm> ...]" - select the order of bootmeths\n" |
| 16 | |
| 17 | |
| 18 | Description |
| 19 | ----------- |
| 20 | |
| 21 | The `bootmeth` command is used to manage bootmeths. It can list them and change |
| 22 | the order in which they are used. |
| 23 | |
| Simon Glass | 16047dc | 2024-07-17 09:30:52 +0100 | [diff] [blame] | 24 | See :doc:`/develop/bootstd/index` for more information. |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 25 | |
| 26 | |
| 27 | .. _bootmeth_order: |
| 28 | |
| 29 | bootmeth order |
| 30 | ~~~~~~~~~~~~~~ |
| 31 | |
| 32 | Selects which bootmeths to use and the order in which they are invoked. When |
| 33 | scanning bootdevs, each bootmeth is tried in turn to see if it can find a valid |
| 34 | bootflow. You can use this command to adjust the order or even to omit some |
| 35 | boomeths. |
| 36 | |
| Simon Glass | afaeb77 | 2022-07-30 15:52:35 -0600 | [diff] [blame] | 37 | The argument is a quoted list of bootmeths to use, by name. If global bootmeths |
| 38 | are included, they must be at the end, otherwise the scanning mechanism will not |
| 39 | work correctly. |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 40 | |
| 41 | |
| 42 | bootmeth list |
| 43 | ~~~~~~~~~~~~~ |
| 44 | |
| 45 | This lists the selected bootmeths, or all of them, if the `-a` flag is used. |
| 46 | The format looks like this: |
| 47 | |
| 48 | ===== === ================== ================================= |
| 49 | Order Seq Name Description |
| 50 | ===== === ================== ================================= |
| Mattijs Korpershoek | 50cab92 | 2024-05-24 15:28:21 +0200 | [diff] [blame] | 51 | 0 0 extlinux Extlinux boot from a block device |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 52 | 1 1 efi EFI boot from an .efi file |
| 53 | 2 2 pxe PXE boot from a network device |
| 54 | 3 3 sandbox Sandbox boot for testing |
| Simon Glass | afaeb77 | 2022-07-30 15:52:35 -0600 | [diff] [blame] | 55 | glob 4 efi_mgr EFI bootmgr flow |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 56 | ===== === ================== ================================= |
| 57 | |
| 58 | The fields are as follows: |
| 59 | |
| 60 | Order: |
| 61 | The order in which these bootmeths are invoked for each bootdev. If this |
| Simon Glass | afaeb77 | 2022-07-30 15:52:35 -0600 | [diff] [blame] | 62 | shows as a hyphen, then the bootmeth is not in the current ordering. If it |
| 63 | shows as 'glob', then this is a global bootmeth and should be at the end. |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 64 | |
| 65 | Seq: |
| 66 | The sequence number of the bootmeth, i.e. the normal ordering if none is set |
| 67 | |
| 68 | Name: |
| 69 | Name of the bootmeth |
| 70 | |
| 71 | Description: |
| 72 | A friendly description for the bootmeth |
| 73 | |
| 74 | |
| 75 | Example |
| 76 | ------- |
| 77 | |
| 78 | This shows listing bootmeths. All are present and in the normal order:: |
| 79 | |
| 80 | => bootmeth list |
| 81 | Order Seq Name Description |
| 82 | ----- --- ------------------ ------------------ |
| Simon Glass | b71d7f7 | 2023-05-10 16:34:46 -0600 | [diff] [blame] | 83 | 0 0 distro Extlinux boot from a block device |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 84 | 1 1 efi EFI boot from an .efi file |
| 85 | 2 2 pxe PXE boot from a network device |
| 86 | 3 3 sandbox Sandbox boot for testing |
| 87 | 4 4 efi_mgr EFI bootmgr flow |
| 88 | ----- --- ------------------ ------------------ |
| 89 | (5 bootmeths) |
| 90 | |
| 91 | Now the order is changed, to include only two of them:: |
| 92 | |
| 93 | => bootmeth order "sandbox distro" |
| 94 | => bootmeth list |
| 95 | Order Seq Name Description |
| 96 | ----- --- ------------------ ------------------ |
| 97 | 0 3 sandbox Sandbox boot for testing |
| Simon Glass | b71d7f7 | 2023-05-10 16:34:46 -0600 | [diff] [blame] | 98 | 1 0 distro Extlinux boot from a block device |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 99 | ----- --- ------------------ ------------------ |
| 100 | (2 bootmeths) |
| 101 | |
| 102 | The -a flag shows all bootmeths so you can clearly see which ones are used and |
| 103 | which are not:: |
| 104 | |
| 105 | => bootmeth list -a |
| 106 | Order Seq Name Description |
| 107 | ----- --- ------------------ ------------------ |
| Simon Glass | b71d7f7 | 2023-05-10 16:34:46 -0600 | [diff] [blame] | 108 | 1 0 distro Extlinux boot from a block device |
| Simon Glass | 83b9be6 | 2022-04-24 23:31:26 -0600 | [diff] [blame] | 109 | - 1 efi EFI boot from an .efi file |
| 110 | - 2 pxe PXE boot from a network device |
| 111 | 0 3 sandbox Sandbox boot for testing |
| 112 | - 4 efi_mgr EFI bootmgr flow |
| 113 | ----- --- ------------------ ------------------ |
| 114 | (5 bootmeths) |