openbmc/bios-settings-mgr/README.md

1 # Remote BIOS Configuration
7 The **biosconfig_manager** service enables users to view and modify the BIOS
16 - **Remote management** of BIOS settings.
18 - **Reset BIOS Settings** support through the dbus.
19 - **ChangePassword** support to change the BIOS setup password.
23 The Manager interface exposes methods and properties to Get & Set BIOS
24 attributes via dbus and its documented [here][pdi-manager-bios]
34 - **SetAttribute** Sets a specific BIOS attribute to a new value.
35 - **GetAttribute** Retrieves the current and pending values of a BIOS attribute.
39 - **ResetBIOSSettings** To reset the BIOS settings based on the Reset Flag.
40 - **BaseBIOSTable** Captures the entire BIOS table (collective information of
41   all the BIOS attributes and their properties)
46 dictionary that defines the structure of BIOS attributes. Its type signature is
64 - **Attribute Name (string)**: The name of the BIOS attribute.
65 - **Attribute Type (enum)**: The type of the BIOS attribute (e.g., String,
70 - **Menu Path (string)**: The BIOS menu path where this attribute can be found.
113     "displayname": "BIOS Serial Debug level",
114     "description": "BIOS Serial Debug level during system boot.",
129 When the `bios-settings-mgr` daemon starts, it initializes with an empty
131 or **IPMI**, to populate this table by fetching or defining the BIOS settings.
132 These provider daemons are expected to gather the necessary BIOS attributes and
136 ### BIOS with PLDM as Communication Protocol
139 BMC & Host, OEM vendors can define their own BIOS attributes in the form of
140 [JSON files][pldm-bios-json]. The PLDM daemon parses these files and initializes
142 BIOS configuration options based on the vendor's specifications.
144 For more details , refer to the [BIOS Support in PLDM][pldm-bios].
146 ### BIOS with IPMI as Communication Protocol
149 between BMC & Host, BIOS attributes are gathered from BIOS as an `xml file` &
153 For more details, refer to the code [BIOS Support in IPMI][ipmi-intel-bios].
166   Used to change the BIOS setup password.
170 - **PasswordInitialized** Used to indicate whether the BIOS password-related
174   https://github.com/openbmc/docs/blob/master/designs/remote-bios-configuration.md
175 [pldm-bios-json]:
176 …https://github.com/openbmc/pldm/blob/master/oem/ibm/configurations/bios/com.ibm.Hardware.Chassis.M…
177 [pldm-bios]: https://github.com/openbmc/pldm?tab=readme-ov-file#bios-support
178 [ipmi-intel-bios]:
180 [pdi-manager-bios]: