blob: b88eac6ff3481a442bec32b22b5e254ea3dc45a9 [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(
Patrick Williamsec807fc2025-02-03 14:13:00 -050053 'side-switch-on-boot',
54 type: 'feature',
55 value: 'enabled',
Andrew Geissler70d72f82022-03-23 13:15:05 -050056 description: 'Automatic flash side switch on boot',
57)
58
Alexander Hansenf2c95a02024-11-26 11:16:44 +010059option(
60 'bios-software-update',
61 type: 'feature',
62 value: 'enabled',
63 description: 'Enable BIOS/Host firmware update',
64)
65
Adriana Kobylak0af80a42020-05-05 13:32:10 -050066# Variables
67option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050068 'active-bmc-max-allowed',
69 type: 'integer',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050070 value: 1,
71 description: 'The maximum allowed active BMC versions.',
72)
73
74option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050075 'hash-file-name',
76 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050077 value: 'hashfunc',
78 description: 'The name of the hash file.',
79)
80
81option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050082 'img-upload-dir',
83 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050084 value: '/tmp/images',
85 description: 'Directory where downloaded software images are placed.',
86)
87
88option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050089 'manifest-file-name',
90 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050091 value: 'MANIFEST',
92 description: 'The name of the MANIFEST file.',
93)
94
95option(
Patrick Williamsec807fc2025-02-03 14:13:00 -050096 'media-dir',
97 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -050098 value: '/run/media',
99 description: 'The base dir where all read-only partitions are mounted.',
100)
101
102option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500103 'optional-images',
104 type: 'array',
Adriana Kobylak73609bb2020-06-18 15:05:40 -0500105 value: [],
106 description: 'A list of additional image files in the BMC tarball.',
107)
108
109option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500110 'publickey-file-name',
111 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500112 value: 'publickey',
113 description: 'The name of the public key file.',
114)
115
116option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500117 'signature-file-ext',
118 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500119 value: '.sig',
120 description: 'The extension of the Signature file.',
121)
122
123option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500124 'signed-image-conf-path',
125 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500126 value: '/etc/activationdata/',
127 description: 'Path of public key and hash function files.',
128)
129
130option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500131 'sync-list-dir-path',
132 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500133 value: '/etc/',
134 description: 'The path to the sync list file directory.',
135)
136
137option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500138 'sync-list-file-name',
139 type: 'string',
Adriana Kobylak0af80a42020-05-05 13:32:10 -0500140 value: 'synclist',
141 description: 'The name of the sync list file.',
142)
Miguel Gomez21dad042020-06-26 20:54:48 +0000143
144option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500145 'bmc-msl',
146 type: 'string',
Miguel Gomez21dad042020-06-26 20:54:48 +0000147 value: '',
148 description: 'The BMC minimum ship level.',
149)
150
151option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500152 'regex-bmc-msl',
153 type: 'string',
Miguel Gomez21dad042020-06-26 20:54:48 +0000154 value: '',
155 description: 'The Regular expression to parse the MSL.',
156)
Lei YU6e9fb1d2021-02-19 18:01:40 +0800157
158option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500159 'bios-object-path',
160 type: 'string',
Lei YU6e9fb1d2021-02-19 18:01:40 +0800161 value: '/xyz/openbmc_project/software/bios_active',
162 description: 'The BIOS DBus object path.',
163)
Lei YU63769642021-12-10 16:15:04 +0800164
Patrick Williamsec807fc2025-02-03 14:13:00 -0500165option(
166 'bmc-static-dual-image',
167 type: 'feature',
168 value: 'enabled',
169 description: 'Enable the dual image support for static layout.',
170)
Lei YU63769642021-12-10 16:15:04 +0800171
172option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500173 'alt-rofs-dir',
174 type: 'string',
Lei YU63769642021-12-10 16:15:04 +0800175 value: '/run/media/rofs-alt',
176 description: 'The base dir where all read-only partitions are mounted.',
177)
Lei YUcc9b41a2021-12-15 14:07:16 +0800178
179option(
Patrick Williamsec807fc2025-02-03 14:13:00 -0500180 'alt-rwfs-dir',
181 type: 'string',
Lei YUcc9b41a2021-12-15 14:07:16 +0800182 value: '/run/media/rwfs-alt/cow',
183 description: 'The dir for alt-rwfs partition.',
184)