xref: /openbmc/bios-settings-mgr/README.md (revision c65f0a3a)
17520590aSPatrick WilliamsRemote BIOS Configuration via BMC Overview Provides ability for the user to view
27520590aSPatrick Williamsand modify the BIOS setup configuration parameters remotely via BMC at any Host
37520590aSPatrick Williamsstate. Modifications to the parameters take place upon the next system reboot or
47520590aSPatrick Williamsimmediate based on the host firmware. Please refer
5ea08aa58SPatrick Williamshttps://github.com/openbmc/docs/blob/master/designs/remote-bios-configuration.md
6642f437eSKuiying Wang
77520590aSPatrick WilliamsRemote BIOS Configuration (RBC) service exposes D-Bus methods for BIOS settings
87520590aSPatrick Williamsmanagement operations.
9642f437eSKuiying Wang
107520590aSPatrick WilliamsRBC Manager Interface xyz.openbmc_project.BIOSConfig.Manager provides following
117520590aSPatrick Williamsmethods, properties.
12642f437eSKuiying Wang
13642f437eSKuiying WangObject Path : /xyz/openbmc_project/BIOSConfig/Manager
14642f437eSKuiying Wang
15642f437eSKuiying Wangxyz.openbmc_project.BIOSConfig.Manager
16642f437eSKuiying Wang
177520590aSPatrick Williamsmethods: SetAttribute -To set the particular BIOS attribute with new value.
187520590aSPatrick WilliamsGetAttribute -To get the bios attribute current values and pending values if
197520590aSPatrick Williamsagain.
20642f437eSKuiying Wang
21*c65f0a3aSManojkiran EdaProperties: ResetBIOSSettings - Contain reset BIOS setting type: Interface have
227520590aSPatrick Williamsto set NoAction this property, when Reset BIOS settings are informed to the
237520590aSPatrick WilliamsBIOS. BaseBIOSTable - Save the whole BIOS table.
24642f437eSKuiying Wangmap{attributeName,struct{attributeType,readonlyStatus,displayname,
257520590aSPatrick Williamsdescription,menuPath,current,default, array{struct{optionstring,optionvalue}}}}
267520590aSPatrick WilliamsExample 1: {"DdrFreqLimit",
277520590aSPatrick Williams{xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String, false, "Memory
287520590aSPatrick WilliamsOperating Speed Selection", "Force specific Memory Operating Speed or use Auto
297520590aSPatrick Williamssetting.", "Advanced/Memory Configuration/Memory Operating Speed Selection",
307520590aSPatrick Williams"0x00", "0x0B", { {"OneOf", "auto"}, {"OneOf", "2133"}, {"OneOf", "2400"},
317520590aSPatrick Williams{"OneOf", "2664"}, {"OneOf", "2933"} } } } Example 2: {"BIOSSerialDebugLevel",
327520590aSPatrick Williams{xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Integer, false, "BIOS
337520590aSPatrick WilliamsSerial Debug level", "BIOS Serial Debug level during system boot.",
347520590aSPatrick Williams"Advanced/Debug Feature Selection", 0x00, 0x01, { {"MinBound", 0}, {"MaxBound",
357520590aSPatrick Williams4}, {"ScalarIncrement",1} } } }
36642f437eSKuiying Wang
377520590aSPatrick WilliamsSignals: AttributeChanged - Signal sent out when attribute is changed
38642f437eSKuiying Wang
39642f437eSKuiying WangPasswordInterface:
40642f437eSKuiying Wang
417520590aSPatrick Williamsxyz.openbmc_project.BIOSConfig.Password provides following Methods and
42*c65f0a3aSManojkiran EdaProperties.
43642f437eSKuiying Wang
44642f437eSKuiying Wangxyz.openbmc_project.BIOSConfig.Password Interface
45642f437eSKuiying Wang
467520590aSPatrick WilliamsMethods: ChangePassword - Change the BIOS setup password.
47642f437eSKuiying Wang
48*c65f0a3aSManojkiran EdaProperties: PasswordInitialized - To indicate BIOS password related details are
498de46ffbSyesreceived or not.
50