xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/BIOSConfig/README.md (revision 921791c73008a3edfc6507afb5bc15e48963d295)
1388b58f9SPatrick Williams# Remote BIOS Configuration via BMC
2b1b4d261SWilliam A. Kennington III
3388b58f9SPatrick Williams## Overview
4b1b4d261SWilliam A. Kennington III
5388b58f9SPatrick WilliamsProvides ability for the user to view and modify the BIOS setup configuration
6388b58f9SPatrick Williamsparameters remotely via BMC at any Host state. Modifications to the parameters
7388b58f9SPatrick Williamstake place upon the next system reboot or immediate based on the host firmware.
8b1b4d261SWilliam A. Kennington III
9388b58f9SPatrick WilliamsPlease refer to the [design][design] for more details.
10b1b4d261SWilliam A. Kennington III
11388b58f9SPatrick WilliamsRemote BIOS Configuration (RBC) service exposes D-Bus methods for BIOS settings
12388b58f9SPatrick Williamsmanagement operations.
13b1b4d261SWilliam A. Kennington III
14388b58f9SPatrick Williams## RBC Manager Interface
15b1b4d261SWilliam A. Kennington III
16388b58f9SPatrick Williams### Interface xyz.openbmc_project.BIOSConfigManager
17b1b4d261SWilliam A. Kennington III
1888902e67SSmriti-Ayushi- Object Path: `/xyz/openbmc_project/bios_config/manager`
19b1b4d261SWilliam A. Kennington III
20b1b4d261SWilliam A. Kennington IIIMethods:
21388b58f9SPatrick Williams
22388b58f9SPatrick Williams- `SetAttribute` -To set the particular BIOS attribute with new value.
23388b58f9SPatrick Williams- `GetAttribute` -To get the bios attribute current and pending values.
24388b58f9SPatrick Williams
25*921791c7SManojkiran EdaProperties:
26388b58f9SPatrick Williams
27388b58f9SPatrick Williams- `ResetBIOSSettings` - To reset the BIOS settings based on the Reset Flag.
2888902e67SSmriti-Ayushi- `BaseBiosTable` - To store all bios attributes details.
29*921791c7SManojkiran Eda- `PendingAttributes` - To store pending bios Attributes list.
30388b58f9SPatrick Williams
31388b58f9SPatrick Williams### Interface xyz.openbmc_project.BIOSConfig.Password
32388b58f9SPatrick Williams
3388902e67SSmriti-Ayushi- Object Path: `/xyz/openbmc_project/bios_config/password`
3488902e67SSmriti-Ayushi
35388b58f9SPatrick WilliamsMethods:
36388b58f9SPatrick Williams
3788902e67SSmriti-Ayushi- `ChangePassword` - To change BIOS setup password.
38b1b4d261SWilliam A. Kennington III
39*921791c7SManojkiran EdaProperties:
40b1b4d261SWilliam A. Kennington III
4188902e67SSmriti-Ayushi- `PasswordInitialized` - To indicate BIOS password related details are received
42388b58f9SPatrick Williams  or not.
43b1b4d261SWilliam A. Kennington III
44a1347418SPatrick Williams[design]:
45a1347418SPatrick Williams  https://github.com/openbmc/docs/blob/master/designs/remote-bios-configuration.md
46