| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 1 | # Supported BMC layout types. Reference: | 
| Gunnar Mills | 34077dc | 2020-09-11 09:29:14 -0500 | [diff] [blame] | 2 | # https://github.com/openbmc/docs/blob/master/architecture/code-update/flash-layout.md#supported-filesystem-choices | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 3 | # - static: NOR flash configured with fixed-sized MTD partitions. | 
|  | 4 | # - ubi: NOR flash device configured with UBI volumes. | 
| Adriana Kobylak | 86013f3 | 2020-05-13 12:12:38 -0500 | [diff] [blame] | 5 | # - mmc: eMMC flash device configured with ext4 filesystems. | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 6 | option( | 
|  | 7 | 'bmc-layout', | 
|  | 8 | type: 'combo', | 
| Adriana Kobylak | 86013f3 | 2020-05-13 12:12:38 -0500 | [diff] [blame] | 9 | choices: ['static', 'ubi', 'mmc'], | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 10 | value: 'static', | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 11 | description: 'The BMC layout type.', | 
|  | 12 | ) | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 13 |  | 
|  | 14 | # Features | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 15 | option( | 
|  | 16 | 'host-bios-upgrade', | 
|  | 17 | type: 'feature', | 
|  | 18 | value: 'enabled', | 
|  | 19 | description: 'Enable host bios upgrade support.', | 
|  | 20 | ) | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 21 |  | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 22 | option( | 
|  | 23 | 'sync-bmc-files', | 
|  | 24 | type: 'feature', | 
|  | 25 | value: 'enabled', | 
|  | 26 | description: 'Enable sync of filesystem files.', | 
|  | 27 | ) | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 28 |  | 
| Adriana Kobylak | 78e72d9 | 2020-05-05 14:01:54 -0500 | [diff] [blame] | 29 | option('tests', type: 'feature', description: 'Build tests') | 
|  | 30 |  | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 31 | option( | 
|  | 32 | 'verify-signature', | 
|  | 33 | type: 'feature', | 
|  | 34 | value: 'enabled', | 
|  | 35 | description: 'Enable image signature validation.', | 
|  | 36 | ) | 
| George Liu | 0a06e97 | 2020-12-17 09:17:04 +0800 | [diff] [blame] | 37 |  | 
| George Liu | cc74233 | 2021-10-20 16:25:55 +0800 | [diff] [blame] | 38 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 39 | 'usb-code-update', | 
|  | 40 | type: 'feature', | 
|  | 41 | value: 'enabled', | 
| George Liu | cc74233 | 2021-10-20 16:25:55 +0800 | [diff] [blame] | 42 | description: 'Firmware update via USB.', | 
|  | 43 | ) | 
|  | 44 |  | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 45 | option( | 
|  | 46 | 'software-update-dbus-interface', | 
|  | 47 | type: 'feature', | 
|  | 48 | value: 'enabled', | 
| Jagpal Singh Gill | cc49878 | 2024-02-29 15:16:36 -0800 | [diff] [blame] | 49 | description: 'Implementation using software update D-Bus interface - https://github.com/openbmc/docs/blob/master/designs/code-update.md.', | 
|  | 50 | ) | 
|  | 51 |  | 
| Andrew Geissler | 70d72f8 | 2022-03-23 13:15:05 -0500 | [diff] [blame] | 52 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 53 | 'side-switch-on-boot', | 
|  | 54 | type: 'feature', | 
|  | 55 | value: 'enabled', | 
| Andrew Geissler | 70d72f8 | 2022-03-23 13:15:05 -0500 | [diff] [blame] | 56 | description: 'Automatic flash side switch on boot', | 
|  | 57 | ) | 
|  | 58 |  | 
| Alexander Hansen | f2c95a0 | 2024-11-26 11:16:44 +0100 | [diff] [blame] | 59 | option( | 
|  | 60 | 'bios-software-update', | 
|  | 61 | type: 'feature', | 
|  | 62 | value: 'enabled', | 
|  | 63 | description: 'Enable BIOS/Host firmware update', | 
|  | 64 | ) | 
|  | 65 |  | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 66 | # Variables | 
|  | 67 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 68 | 'active-bmc-max-allowed', | 
|  | 69 | type: 'integer', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 70 | value: 1, | 
|  | 71 | description: 'The maximum allowed active BMC versions.', | 
|  | 72 | ) | 
|  | 73 |  | 
|  | 74 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 75 | 'hash-file-name', | 
|  | 76 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 77 | value: 'hashfunc', | 
|  | 78 | description: 'The name of the hash file.', | 
|  | 79 | ) | 
|  | 80 |  | 
|  | 81 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 82 | 'img-upload-dir', | 
|  | 83 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 84 | value: '/tmp/images', | 
|  | 85 | description: 'Directory where downloaded software images are placed.', | 
|  | 86 | ) | 
|  | 87 |  | 
|  | 88 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 89 | 'manifest-file-name', | 
|  | 90 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 91 | value: 'MANIFEST', | 
|  | 92 | description: 'The name of the MANIFEST file.', | 
|  | 93 | ) | 
|  | 94 |  | 
|  | 95 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 96 | 'media-dir', | 
|  | 97 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 98 | value: '/run/media', | 
|  | 99 | description: 'The base dir where all read-only partitions are mounted.', | 
|  | 100 | ) | 
|  | 101 |  | 
|  | 102 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 103 | 'optional-images', | 
|  | 104 | type: 'array', | 
| Adriana Kobylak | 73609bb | 2020-06-18 15:05:40 -0500 | [diff] [blame] | 105 | value: [], | 
|  | 106 | description: 'A list of additional image files in the BMC tarball.', | 
|  | 107 | ) | 
|  | 108 |  | 
|  | 109 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 110 | 'publickey-file-name', | 
|  | 111 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 112 | value: 'publickey', | 
|  | 113 | description: 'The name of the public key file.', | 
|  | 114 | ) | 
|  | 115 |  | 
|  | 116 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 117 | 'signature-file-ext', | 
|  | 118 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 119 | value: '.sig', | 
|  | 120 | description: 'The extension of the Signature file.', | 
|  | 121 | ) | 
|  | 122 |  | 
|  | 123 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 124 | 'signed-image-conf-path', | 
|  | 125 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 126 | value: '/etc/activationdata/', | 
|  | 127 | description: 'Path of public key and hash function files.', | 
|  | 128 | ) | 
|  | 129 |  | 
|  | 130 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 131 | 'sync-list-dir-path', | 
|  | 132 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 133 | value: '/etc/', | 
|  | 134 | description: 'The path to the sync list file directory.', | 
|  | 135 | ) | 
|  | 136 |  | 
|  | 137 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 138 | 'sync-list-file-name', | 
|  | 139 | type: 'string', | 
| Adriana Kobylak | 0af80a4 | 2020-05-05 13:32:10 -0500 | [diff] [blame] | 140 | value: 'synclist', | 
|  | 141 | description: 'The name of the sync list file.', | 
|  | 142 | ) | 
| Miguel Gomez | 21dad04 | 2020-06-26 20:54:48 +0000 | [diff] [blame] | 143 |  | 
|  | 144 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 145 | 'bmc-msl', | 
|  | 146 | type: 'string', | 
| Miguel Gomez | 21dad04 | 2020-06-26 20:54:48 +0000 | [diff] [blame] | 147 | value: '', | 
|  | 148 | description: 'The BMC minimum ship level.', | 
|  | 149 | ) | 
|  | 150 |  | 
|  | 151 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 152 | 'regex-bmc-msl', | 
|  | 153 | type: 'string', | 
| Miguel Gomez | 21dad04 | 2020-06-26 20:54:48 +0000 | [diff] [blame] | 154 | value: '', | 
|  | 155 | description: 'The Regular expression to parse the MSL.', | 
|  | 156 | ) | 
| Lei YU | 6e9fb1d | 2021-02-19 18:01:40 +0800 | [diff] [blame] | 157 |  | 
|  | 158 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 159 | 'bios-object-path', | 
|  | 160 | type: 'string', | 
| Lei YU | 6e9fb1d | 2021-02-19 18:01:40 +0800 | [diff] [blame] | 161 | value: '/xyz/openbmc_project/software/bios_active', | 
|  | 162 | description: 'The BIOS DBus object path.', | 
|  | 163 | ) | 
| Lei YU | 6376964 | 2021-12-10 16:15:04 +0800 | [diff] [blame] | 164 |  | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 165 | option( | 
|  | 166 | 'bmc-static-dual-image', | 
|  | 167 | type: 'feature', | 
|  | 168 | value: 'enabled', | 
|  | 169 | description: 'Enable the dual image support for static layout.', | 
|  | 170 | ) | 
| Lei YU | 6376964 | 2021-12-10 16:15:04 +0800 | [diff] [blame] | 171 |  | 
|  | 172 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 173 | 'alt-rofs-dir', | 
|  | 174 | type: 'string', | 
| Lei YU | 6376964 | 2021-12-10 16:15:04 +0800 | [diff] [blame] | 175 | value: '/run/media/rofs-alt', | 
|  | 176 | description: 'The base dir where all read-only partitions are mounted.', | 
|  | 177 | ) | 
| Lei YU | cc9b41a | 2021-12-15 14:07:16 +0800 | [diff] [blame] | 178 |  | 
|  | 179 | option( | 
| Patrick Williams | ec807fc | 2025-02-03 14:13:00 -0500 | [diff] [blame] | 180 | 'alt-rwfs-dir', | 
|  | 181 | type: 'string', | 
| Lei YU | cc9b41a | 2021-12-15 14:07:16 +0800 | [diff] [blame] | 182 | value: '/run/media/rwfs-alt/cow', | 
|  | 183 | description: 'The dir for alt-rwfs partition.', | 
|  | 184 | ) |