xref: /openbmc/bios-settings-mgr/README.md (revision 2824833d)
1# bios-settings-mgr
2
3Remote BIOS Configuration via BMC Overview Provides ability for the user to view
4and modify the BIOS setup configuration parameters remotely via BMC at any Host
5state. Modifications to the parameters take place upon the next system reboot or
6immediate based on the host firmware. Please refer
7https://github.com/openbmc/docs/blob/master/designs/remote-bios-configuration.md
8
9Remote BIOS Configuration (RBC) service exposes D-Bus methods for BIOS settings
10management operations.
11
12RBC Manager Interface xyz.openbmc_project.BIOSConfig.Manager provides following
13methods, properties.
14
15Object Path : /xyz/openbmc_project/BIOSConfig/Manager
16
17xyz.openbmc_project.BIOSConfig.Manager
18
19methods: SetAttribute -To set the particular BIOS attribute with new value.
20GetAttribute -To get the bios attribute current values and pending values if
21again.
22
23Properties: ResetBIOSSettings - Contain reset BIOS setting type: Interface have
24to set NoAction this property, when Reset BIOS settings are informed to the
25BIOS. BaseBIOSTable - Save the whole BIOS table.
26map{attributeName,struct{attributeType,readonlyStatus,displayname,
27description,menuPath,current,default, array{struct{optionstring,optionvalue}}}}
28Example 1: {"DdrFreqLimit",
29{xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String, false, "Memory
30Operating Speed Selection", "Force specific Memory Operating Speed or use Auto
31setting.", "Advanced/Memory Configuration/Memory Operating Speed Selection",
32"0x00", "0x0B", { {"OneOf", "auto"}, {"OneOf", "2133"}, {"OneOf", "2400"},
33{"OneOf", "2664"}, {"OneOf", "2933"} } } } Example 2: {"BIOSSerialDebugLevel",
34{xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Integer, false, "BIOS
35Serial Debug level", "BIOS Serial Debug level during system boot.",
36"Advanced/Debug Feature Selection", 0x00, 0x01, { {"MinBound", 0}, {"MaxBound",
374}, {"ScalarIncrement",1} } } }
38
39Signals: AttributeChanged - Signal sent out when attribute is changed
40
41PasswordInterface:
42
43xyz.openbmc_project.BIOSConfig.Password provides following Methods and
44Properties.
45
46xyz.openbmc_project.BIOSConfig.Password Interface
47
48Methods: ChangePassword - Change the BIOS setup password.
49
50Properties: PasswordInitialized - To indicate BIOS password related details are
51received or not.
52