blob: c178e692efee4db68fa9f070126ed167376b3bbf [file] [log] [blame]
Adriana Kobylak0af80a42020-05-05 13:32:10 -05001# Supported BMC layout types. Reference:
Gunnar Mills34077dc2020-09-11 09:29:14 -05002# https://github.com/openbmc/docs/blob/master/architecture/code-update/flash-layout.md#supported-filesystem-choices
Adriana Kobylak0af80a42020-05-05 13:32:10 -05003# - static: NOR flash configured with fixed-sized MTD partitions.
4# - ubi: NOR flash device configured with UBI volumes.
Adriana Kobylak86013f32020-05-13 12:12:38 -05005# - mmc: eMMC flash device configured with ext4 filesystems.
Patrick Williamsec807fc2025-02-03 14:13:00 -05006option(
7 'bmc-layout',
8 type: 'combo',
Adriana Kobylak86013f32020-05-13 12:12:38 -05009 choices: ['static', 'ubi', 'mmc'],
Adriana Kobylak0af80a42020-05-05 13:32:10 -050010 value: 'static',
Patrick Williamsec807fc2025-02-03 14:13:00 -050011 description: 'The BMC layout type.',
12)
Adriana Kobylak0af80a42020-05-05 13:32:10 -050013
14# Features
Patrick Williamsec807fc2025-02-03 14:13:00 -050015option(
16 'host-bios-upgrade',
17 type: 'feature',
18 value: 'enabled',
19 description: 'Enable host bios upgrade support.',
20)
Adriana Kobylak0af80a42020-05-05 13:32:10 -050021
Patrick Williamsec807fc2025-02-03 14:13:00 -050022option(
23 'sync-bmc-files',
24 type: 'feature',
25 value: 'enabled',
26 description: 'Enable sync of filesystem files.',
27)
Adriana Kobylak0af80a42020-05-05 13:32:10 -050028
Adriana Kobylak78e72d92020-05-05 14:01:54 -050029option('tests', type: 'feature', description: 'Build tests')
30
Patrick Williamsec807fc2025-02-03 14:13:00 -050031option(
32 'verify-signature',
33 type: 'feature',
34 value: 'enabled',
35 description: 'Enable image signature validation.',
36)
George Liu0a06e972020-12-17 09:17:04 +080037
George Liucc742332021-10-20 16:25:55 +080038option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050039 'usb-code-update',
40 type: 'feature',
41 value: 'enabled',
George Liucc742332021-10-20 16:25:55 +080042 description: 'Firmware update via USB.',
43)
44
Patrick Williamsec807fc2025-02-03 14:13:00 -050045option(
46 'software-update-dbus-interface',
47 type: 'feature',
48 value: 'enabled',
Jagpal Singh Gillcc498782024-02-29 15:16:36 -080049 description: 'Implementation using software update D-Bus interface - https://github.com/openbmc/docs/blob/master/designs/code-update.md.',
50)
51
Andrew Geissler70d72f82022-03-23 13:15:05 -050052option(
Christopher Meis7e446a42024-10-22 09:36:41 +020053 'i2cvr-software-update',
54 type: 'feature',
55 value: 'enabled',
56 description: 'Enable update of i2c voltage regulators',
57)
58
59option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050060 'side-switch-on-boot',
61 type: 'feature',
62 value: 'enabled',
Andrew Geissler70d72f82022-03-23 13:15:05 -050063 description: 'Automatic flash side switch on boot',
64)
65
Alexander Hansenf2c95a02024-11-26 11:16:44 +010066option(
67 'bios-software-update',
68 type: 'feature',
69 value: 'enabled',
70 description: 'Enable BIOS/Host firmware update',
71)
72
Kevin Tung994a77f2024-12-23 17:48:56 +080073option(
74 'eepromdevice-software-update',
75 type: 'feature',
76 value: 'enabled',
77 description: 'Enable EEPROM device update support.',
78)
79
Adriana Kobylak0af80a42020-05-05 13:32:10 -050080# Variables
81option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050082 'active-bmc-max-allowed',
83 type: 'integer',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050084 value: 1,
85 description: 'The maximum allowed active BMC versions.',
86)
87
88option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050089 'hash-file-name',
90 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050091 value: 'hashfunc',
92 description: 'The name of the hash file.',
93)
94
95option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050096 'img-upload-dir',
97 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050098 value: '/tmp/images',
99 description: 'Directory where downloaded software images are placed.',
100)
101
102option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500103 'manifest-file-name',
104 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500105 value: 'MANIFEST',
106 description: 'The name of the MANIFEST file.',
107)
108
109option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500110 'media-dir',
111 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500112 value: '/run/media',
113 description: 'The base dir where all read-only partitions are mounted.',
114)
115
116option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500117 'optional-images',
118 type: 'array',
Adriana Kobylak73609bb2020-06-18 15:05:40 -0500119 value: [],
120 description: 'A list of additional image files in the BMC tarball.',
121)
122
123option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500124 'publickey-file-name',
125 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500126 value: 'publickey',
127 description: 'The name of the public key file.',
128)
129
130option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500131 'signature-file-ext',
132 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500133 value: '.sig',
134 description: 'The extension of the Signature file.',
135)
136
137option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500138 'signed-image-conf-path',
139 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500140 value: '/etc/activationdata/',
141 description: 'Path of public key and hash function files.',
142)
143
144option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500145 'sync-list-dir-path',
146 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500147 value: '/etc/',
148 description: 'The path to the sync list file directory.',
149)
150
151option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500152 'sync-list-file-name',
153 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500154 value: 'synclist',
155 description: 'The name of the sync list file.',
156)
Miguel Gomez21dad042020-06-26 20:54:48 +0000157
158option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500159 'bmc-msl',
160 type: 'string',
Miguel Gomez21dad042020-06-26 20:54:48 +0000161 value: '',
162 description: 'The BMC minimum ship level.',
163)
164
165option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500166 'regex-bmc-msl',
167 type: 'string',
Miguel Gomez21dad042020-06-26 20:54:48 +0000168 value: '',
169 description: 'The Regular expression to parse the MSL.',
170)
Lei YU6e9fb1d2021-02-19 18:01:40 +0800171
172option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500173 'bios-object-path',
174 type: 'string',
Lei YU6e9fb1d2021-02-19 18:01:40 +0800175 value: '/xyz/openbmc_project/software/bios_active',
176 description: 'The BIOS DBus object path.',
177)
Lei YU63769642021-12-10 16:15:04 +0800178
Patrick Williamsec807fc2025-02-03 14:13:00 -0500179option(
180 'bmc-static-dual-image',
181 type: 'feature',
182 value: 'enabled',
183 description: 'Enable the dual image support for static layout.',
184)
Lei YU63769642021-12-10 16:15:04 +0800185
186option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500187 'alt-rofs-dir',
188 type: 'string',
Lei YU63769642021-12-10 16:15:04 +0800189 value: '/run/media/rofs-alt',
190 description: 'The base dir where all read-only partitions are mounted.',
191)
Lei YUcc9b41a2021-12-15 14:07:16 +0800192
193option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500194 'alt-rwfs-dir',
195 type: 'string',
Lei YUcc9b41a2021-12-15 14:07:16 +0800196 value: '/run/media/rwfs-alt/cow',
197 description: 'The dir for alt-rwfs partition.',
198)