Show option->text of BIOS knob in Redfish response.

GET on /redfish/v1/Registries/BiosAttributeRegistry/BiosAttributeRegistry/
shows list of Attributes under RegistryEntries. Each attribute
correspo

Show option->text of BIOS knob in Redfish response.

GET on /redfish/v1/Registries/BiosAttributeRegistry/BiosAttributeRegistry/
shows list of Attributes under RegistryEntries. Each attribute
corresponds to a knob in BIOS.

If knob in BIOS is of type Enumeration, it will have 'option' with
'text' and 'value'. This text should be mapped to
attribute->Value->ValueDisplayName.

Code changes are made for the same.

Tested
Sample knobs from BIOS.

<knob name="AdaptiveRefreshMgmtLevel" ... >
<options>
<option text="Default" value="0x0"/>
<option text="Level A" value="0x1"/>
<option text="Level B" value="0x2"/>
<option text="Level C" value="0x3"/>
</options>
</knob>
<knob name="ADDDCEn" ... >
<options>
<option text="Disable" value="0x0"/>
<option text="Enable" value="0x1"/>
</options>
</knob>

Corresponding Redfish response in BiosAttributeRegistry

{
"AttributeName": "AdaptiveRefreshMgmtLevel",
"CurrentValue": "0x00",
"DefaultValue": "0x00",
"DisplayName": "AdaptiveRefreshMgmtLevel",
"HelpText": "ARFM Level when ... ",
"MenuPath": "./",
"ReadOnly": false,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "Default",
"ValueName": "0x0"
},
{
"ValueDisplayName": "Level A",
"ValueName": "0x1"
},
{
"ValueDisplayName": "Level B",
"ValueName": "0x2"
},
{
"ValueDisplayName": "Level C",
"ValueName": "0x3"
}
]
},
{
"AttributeName": "ADDDCEn",
"CurrentValue": "0x00",
"DefaultValue": "0x00",
"DisplayName": "ADDDCEn",
"HelpText": "Enable/Disable ADDDC Sparing",
"MenuPath": "./",
"ReadOnly": false,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "Disable",
"ValueName": "0x0"
},
{
"ValueDisplayName": "Enable",
"ValueName": "0x1"
}
]
}

Change-Id: Ie0134c3d47a5eae85b6838e6fe44e3ba31090c8e
Signed-off-by: Arun Lal K M <arun.lal@intel.com>

show more ...

Make BiosConfig run as one service.

As of now BiosConfig runs in two service as seen below.
1) xyz.openbmc_project.biosconfig_manager.service
busctl tree xyz.openbmc_project.BIOSConfigManager
`-/xyz

Make BiosConfig run as one service.

As of now BiosConfig runs in two service as seen below.
1) xyz.openbmc_project.biosconfig_manager.service
busctl tree xyz.openbmc_project.BIOSConfigManager
`-/xyz
`-/xyz/openbmc_project
`-/xyz/openbmc_project/bios_config
`-/xyz/openbmc_project/bios_config/manager

2) xyz.openbmc_project.biosconfig_password.service
busctl tree xyz.openbmc_project.BIOSConfigPassword
`-/xyz
`-/xyz/openbmc_project
`-/xyz/openbmc_project/bios_config
`-/xyz/openbmc_project/bios_config/password

The code changes are to move functionalities of
xyz.openbmc_project.biosconfig_password.service to
xyz.openbmc_project.biosconfig_manager.service as
shown below

busctl tree xyz.openbmc_project.BIOSConfigManager
`-/xyz
`-/xyz/openbmc_project
`-/xyz/openbmc_project/bios_config
|-/xyz/openbmc_project/bios_config/manager
`-/xyz/openbmc_project/bios_config/password

Tested:
Made sure BiosConfig functionality is not affected.
Note that calls from bmcweb will now require to use
service as xyz.openbmc_project.biosconfig_manager.service

Change-Id: I8adeb57ed3758041b2b9b0d1ddc714e418c4484e
Signed-off-by: Arun Lal K M <arun.lal@intel.com>

show more ...

Clean up manager code file

Abstracted functions to make code more readable.

Tested:
Verified oob-bios functionality is not altered.

Change-Id: Ic7487dc042e637b50c8b68e7a87c9d36465bac8b
Signed-off-

Clean up manager code file

Abstracted functions to make code more readable.

Tested:
Verified oob-bios functionality is not altered.

Change-Id: Ic7487dc042e637b50c8b68e7a87c9d36465bac8b
Signed-off-by: Smriti-Ayushi <smriti.ayushi@linux.intel.com>

show more ...

Fix some warnings by cppcheck

Warning message:
/src/manager.cpp:255:53: warning: Division by zero [core.DivideZero]
if (((std::abs(attrValue - lowerBound)) % scalarIncrement) != 0)

include/pass

Fix some warnings by cppcheck

Warning message:
/src/manager.cpp:255:53: warning: Division by zero [core.DivideZero]
if (((std::abs(attrValue - lowerBound)) % scalarIncrement) != 0)

include/password.hpp:84:36: performance: Function parameter 'rawData'
should be passed by const reference. [passedByValue]
const std::string rawData, const std::string algo);
^
include/password.hpp:84:63: performance: Function parameter 'algo'
should be passed by const reference. [passedByValue]
const std::string rawData, const std::string algo);

Tested: Verify that there are no such warnings in local CI.

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I12276f64b06e4eddfd8cd340ebc16d04e4e9ccd5

show more ...

Fix the String type of pendingAttributes method

When the user calls the `pendingAttributes` method, if the
`attributeType` is equal to the string type, there is a chance that
the previous logic will

Fix the String type of pendingAttributes method

When the user calls the `pendingAttributes` method, if the
`attributeType` is equal to the string type, there is a chance that
the previous logic will fail because of the `std::get<1>` exception.

Since the string type has joined `MinStringLength` and
`MaxStringLength`, it is necessary to verify the maximum length and
minimum length of the string.

resolved: https://github.com/openbmc/bios-settings-mgr/issues/2

Tested:
If the length of the hb_lid_ids attribute value we configure is 0 to
10, which is when we set a string with a length of more than 10
bytes, an exception will be thrown.

bios/string_attrs.json:
{
"attribute_name" : "hb_lid_ids",
"string_type" : "ASCII",
"minimum_string_length" : 0,
"maximum_string_length" : 10,
"default_string_length" : 0,
"default_string" : "",
"helpText" : "Provides the host a mapping of the lid IDs to human
readable names.",
"displayName" : "Hostboot Lid IDs"
}

busctl call xyz.openbmc_project.BIOSConfigManager
/xyz/openbmc_project/bios_config/manager
org.freedesktop.DBus.Properties Set ssv
xyz.openbmc_project.BIOSConfig.Manager PendingAttributes a{s\(sv\)} 1
"hb_lid_ids"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String" s
"123456789023"
Call failed: Invalid argument was given.

journalctl -o json-pretty SYSLOG_IDENTIFIER=biosconfig-manager
{
"_SYSTEMD_INVOCATION_ID" : "0930e3a7967e4eb68429fd472afebcec",
"_HOSTNAME" : "fp5280g2",
"_PID" : "243",
"ATTRVALUE" : "123456789023",
"_EXE" : "/usr/bin/biosconfig-manager",
"_CMDLINE" : "/usr/bin/biosconfig-manager",
"_SYSTEMD_SLICE" : "system.slice",
"SYSLOG_IDENTIFIER" : "biosconfig-manager",
"__REALTIME_TIMESTAMP" : "305445800",
"_GID" : "0",
"MINLEN" : "0",
"MAXLEN" : "10",
"CODE_LINE" : "210",
"MESSAGE" : "123456789023 Length is out of range, bound is invalid,
maxStringLength = 10, minStringLength = 0",
...
}

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: Ic13a8acf8417beb92ea3ed1bec5a4bc58d3adda9

show more ...

logging: switch to lg2

After switching to C++20, it is recommended to use `phosphor::lg2`
to format log, and the correct `CODE_LINE` and `CODE_FUNC` values
can be used in log tracking.

Tested: buil

logging: switch to lg2

After switching to C++20, it is recommended to use `phosphor::lg2`
to format log, and the correct `CODE_LINE` and `CODE_FUNC` values
can be used in log tracking.

Tested: built biosConfigManager successfully.
journalctl -o json-pretty SYSLOG_IDENTIFIER=biosconfig-manager
{
"_TRANSPORT" : "journal",
"_PID" : "244",
"__MONOTONIC_TIMESTAMP" : "513878067",
"_SYSTEMD_SLICE" : "system.slice",
"CODE_LINE" : "123",
"_SOURCE_REALTIME_TIMESTAMP" : "513877941",
"_HOSTNAME" : "fp5280g2",
"_CAP_EFFECTIVE" : "1ffffffffff",
"_BOOT_ID" : "40382c3612f54e1a96a6ecf41fe6b38e",
"SYSLOG_IDENTIFIER" : "biosconfig-manager",
"_CMDLINE" : "/usr/bin/biosconfig-manager",
"_EXE" : "/usr/bin/biosconfig-manager",
"LOG2_FMTMSG" : "BIOS attribute not found in the BaseBIOSTable",
"_SYSTEMD_UNIT" : "xyz.openbmc_project.biosconfig_manager.service",
"MESSAGE" : "BIOS attribute not found in the BaseBIOSTable",
"PRIORITY" : "3",
"CODE_FILE" : "../biosconfig-manager/src/manager.cpp",
"CODE_FUNC" : "virtual bios_config::Manager::PendingAttributes
bios_config::Manager::pendingAttributes
(bios_config::Manager::PendingAttributes)"
...
}

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I274d61827279b10ba3fe9d61404ce8b654ccdd9e

show more ...

Add data validation for PATCH to /Bios/Settings.

New data was validated only using option length.
Added code to check if new value is part of available options.
Error is thrown if the new values is

Add data validation for PATCH to /Bios/Settings.

New data was validated only using option length.
Added code to check if new value is part of available options.
Error is thrown if the new values is not a valid option.

Tested:
By giving PATCH Request to
'redfish/v1/systems/system/bios/settings'.
Output sample showing success case:
PATCH command raw data:
{
"data":[
{
"AttributeName": "AmpPrefetchEnable",
"AttributeType": "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String",
"AttributeValue": "0x01"
}
]
}

Response:
{
"@odata.id": "/redfish/v1/Systems/system/Bios/Settings",
"@odata.type": "#Bios.v1_1_0.Bios",
"AttributeRegistry": "BiosAttributeRegistry",
"Id": "BiosSettingsV1",
"Message": "Successfully Completed Request",
"Name": "Bios Settings Version 1"
}

Output sample showing failure case:
PATCH command raw data:
{
"data":[
{
"AttributeName": "AmpPrefetchEnable",
"AttributeType": "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String",
"AttributeValue": "0x05"
}
]
}

Response:
{
"@odata.id": "/redfish/v1/Systems/system/Bios/Settings",
"@odata.type": "#Bios.v1_1_0.Bios",
"AttributeRegistry": "BiosAttributeRegistry",
"Id": "BiosSettingsV1",
"Name": "Bios Settings Version 1",
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The request failed due to an internal service error. The service is still operational.",
"MessageArgs": [],
"MessageId": "Base.1.8.1.InternalError",
"MessageSeverity": "Critical",
"Resolution": "Resubmit the request. If the problem persists, consider resetting the service."
}
],
"code": "Base.1.8.1.InternalError",
"message": "The request failed due to an internal service error. The service is still operational."
}
}

Note: Valid options for knob AmpPrefetchEnable is 0x01 and 0x00 as shown below.
{
"AttributeName": "AmpPrefetchEnable",
"CurrentValue": "0x00",
"DefaultValue": "0x00",
"DisplayName": "AmpPrefetchEnable",
"HelpText": "Set to enable or disable MLC AMP prefetch (MSR 1A4h [4]).",
"MenuPath": "./",
"ReadOnly": false,
"Type": "String",
"Value": [
{
"OneOf": "0x01"
},
{
"OneOf": "0x00"
}
]
}

Signed-off-by: Arun Lal K M <arun.lal@intel.com>
Change-Id: Id66bacf2491d90aa189a8fb0f48d45243195e38c

show more ...

Remove readOnly attribute check

In IBM's p10 system, The BIOS attribute can be set by Host
but not other OOB entities(Redfish doPatch).

All attributes can be changed when the readOnly attribute is

Remove readOnly attribute check

In IBM's p10 system, The BIOS attribute can be set by Host
but not other OOB entities(Redfish doPatch).

All attributes can be changed when the readOnly attribute is true and
make corresponding change in pldmtool & D-Bus also.

Tested:
busctl call xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager org.freedesktop.DBus.Properties Set ssv xyz.openbmc_project.BIOSConfig.Manager PendingAttributes a{s\(sv\)} 1 "pvm_system_name" "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String" s "XXX"

busctl get-property xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager xyz.openbmc_project.BIOSConfig.Manager BaseBIOSTable --verbose
...
DICT_ENTRY "s(sbsssvva(sv))" {
STRING "pvm_system_name";
STRUCT "sbsssvva(sv)" {
STRING "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String";
BOOLEAN false;
STRING "pvm_system_name";
STRING "pvm_system_name";
STRING "";
VARIANT "s" {
STRING "XXX";
};
VARIANT "s" {
STRING "";
};
ARRAY "(sv)" {
STRUCT "sv" {
STRING "xyz.openbmc_project.BIOSConfig.Manager.BoundType.MinStringLength";
VARIANT "x" {
INT64 0;
};
};
STRUCT "sv" {
STRING "xyz.openbmc_project.BIOSConfig.Manager.BoundType.MaxStringLength";
VARIANT "x" {
INT64 100;
};
};
};
};
};
...

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I70ceeff2859d6c8b56690e04018bdf0b23427042

show more ...

Change Resetflag from default to Noaction

Change Resetflag from default to Noaction as BMC have to clear the
default reset bios settings flag whenever new BaseTable is received
from BIOS or else BIO

Change Resetflag from default to Noaction

Change Resetflag from default to Noaction as BMC have to clear the
default reset bios settings flag whenever new BaseTable is received
from BIOS or else BIOS will keep reset the system with default values.

Tested:
Ran unit test cases and manually tested with commands.
When new BaseTable is created, ResetBIOS setting will set the flag to
NoAction.

Signed-off-by: Snehalatha Venkatesh <snehalathax.v@intel.com>
Change-Id: Iea029b1a5a3d97c7f19bc21851972fdc5599cb8d

show more ...

oob bios config password and bios reset

Tested:
1. Bios reset flag can be modified throw redfish
POST https://IP_ADDR/redfish/v1/Systems/system/Bios/Actions/Bios.ResetBios
{
"ResetFlag": "Factor

oob bios config password and bios reset

Tested:
1. Bios reset flag can be modified throw redfish
POST https://IP_ADDR/redfish/v1/Systems/system/Bios/Actions/Bios.ResetBios
{
"ResetFlag": "Factory"
}
root@intel-obmc:~# busctl call xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager org.freedesktop.DBus.Properties Get ss xyz.openbmc_project.BIOSConfig.Manager ResetBIOSSettings
v s "xyz.openbmc_project.BIOSConfig.Manager.ResetFlag.FactoryDefaults"

2. Bios change password:
root@intel-obmc:~# cat /var/lib/bios-settings-manager/seedData
{
"UserPwdHash": "08D91157785366CDC3AA64D87E5E3C621EDAB13E26B6E484397EBA5E459E54C567BF5B1FFB36A43B6142B18F8D642E9D",
"AdminPwdHash": "08D91157785366CDC3AA64D87E5E3C621EDAB13E26B6E484397EBA5E459E54C567BF5B1FFB36A43B6142B18F8D642E9D",
"Seed": "123456",
"HashAlgo": "SHA384"
}
POST https://IP_ADDR/redfish/v1/Systems/system/Bios/Actions/Bios.ChangePassword
{
"NewPassword": "12345678",
"OldPassword": "1234567890",
"PasswordName": "Administrator"
}
root@intel-obmc:~# cat /var/lib/bios-settings-manager/passwordData
{
"CurrentPassword": "1234567890",
"IsAdminPwdChanged": 1,
"IsUserPwdChanged": 0,
"NewPassword": "2DD65D57EB60B1D92C5F3D2DC84724FCEE7BC02E57AA75E834712266ED94CAC704047B2FF7CEC1C36BED280B36BB5AC6",
"UserName": "Administrator"
}

Change-Id: Ib54b36819e49c891c6169c95d9cdaebd5bcb06f3
Signed-off-by: Kuiying Wang <kuiying.wang@intel.com>

show more ...

Add serialization for bios-settings-manager

Tested: Restarted the biosconfig-manager application and
BaseBIOSTable and PendingAttributes were restored.

Signed-off-by: Tom Joseph <tomjoseph@

Add serialization for bios-settings-manager

Tested: Restarted the biosconfig-manager application and
BaseBIOSTable and PendingAttributes were restored.

Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>
Change-Id: Iddbe69ed45a6895a324d236a14b6f21586315c62

show more ...

Initial patch for RBC BIOS Config Manager

ResetBIOSSettings is not implemented as part of this patch apart from
that GetAttribute, SetAttribute and setters for BaseBIOSTable,
PendingAttributes is im

Initial patch for RBC BIOS Config Manager

ResetBIOSSettings is not implemented as part of this patch apart from
that GetAttribute, SetAttribute and setters for BaseBIOSTable,
PendingAttributes is implemeted.

Interface:
xyz.openbmc_project.BIOSConfig.Manager
Properties:
.BaseBIOSTable property a{s(sbsssvva(sv))} 1 "testAttributeName" "xyz.openbmc_pr... emits-change writable
.PendingAttributes property a{s(sv)} 2 "test1" "xyz.openbmc_project.BIOSCo... emits-change writable
.ResetBIOSSettings property s "xyz.openbmc_project.BIOSConfig.Manag... emits-change writable
Methods:
.GetAttribute method s svv -
.SetAttribute method sv - -

Tested:
1. Service is working well.
2. All the dbus methods and properties are shown correctly.
3. Unit test done.
a). Tree
root@intel-obmc:~# busctl tree xyz.openbmc_project.BIOSConfigManager
`-/xyz
`-/xyz/openbmc_project
`-/xyz/openbmc_project/bios_config
`-/xyz/openbmc_project/bios_config/manager
b). Instrospect
root@intel-obmc:~# busctl introspect xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
org.freedesktop.DBus.Introspectable interface - - -
.Introspect method - s -
org.freedesktop.DBus.Peer interface - - -
.GetMachineId method - s -
.Ping method - - -
org.freedesktop.DBus.Properties interface - - -
.Get method ss v -
.GetAll method s a{sv} -
.Set method ssv - -
.PropertiesChanged signal sa{sv}as - -
xyz.openbmc_project.BIOSConfig.Manager interface - - -
.GetAttribute method s svv -
.SetAttribute method sv - -
.BaseBIOSTable property a{s(sbsssvva(sv))} 2 "attr0" "xyz.openbmc_project.BIOSCo... emits-change writable
.PendingAttributes property a{s(sv)} 1 "test1" "xyz.openbmc_project.BIOSCo... emits-change writable
.ResetBIOSSettings property s "xyz.openbmc_project.BIOSConfig.Manag... emits-change writable
c). Method: GetAttribute/SetAttribute
root@intel-obmc:~# busctl call xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager xyz.openbmc_project.BIOSConfig.Manager SetAttribute sv test1 s "value"
root@intel-obmc:~# busctl call xyz.openbmc_project.BIOSConfigManager /xyz/openbmc_project/bios_config/manager xyz.openbmc_project.BIOSConfig.Manager GetAttribute s test1
svv "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String" x 0 s "value"
d). Service
root@intel-obmc:~# systemctl status xyz.openbmc_project.biosconfig_manager
* xyz.openbmc_project.biosconfig_manager.service - BIOS Config Manager - For Remote BIOS configuration update
Loaded: loaded (8;;file://intel-obmc/lib/systemd/system/xyz.openbmc_project.biosconfig_manager.service/lib/systemd/system/xyz.openbmc_project.biosconfig_manager.service8;;; enabled; vendor preset: enabled)
Drop-In: /etc/systemd/system/xyz.openbmc_project.biosconfig_manager.service.d
`-8;;file://intel-obmc/etc/systemd/system/xyz.openbmc_project.biosconfig_manager.service.d/watchdog.confwatchdog.conf8;;
Active: active (running) since Thu 1970-01-01 00:00:56 UTC; 25min ago
Main PID: 394 (biosconfig-mana)
CGroup: /system.slice/xyz.openbmc_project.biosconfig_manager.service
`-394 /usr/bin/biosconfig-manager

Jan 01 00:00:56 intel-obmc systemd[1]: Started BIOS Config Manager - For Remote BIOS configuration update.

Change-Id: I7a7312ffbdf000aab254c77ed5e4f9a8d4ec4d45
Signed-off-by: Kuiying Wang <kuiying.wang@intel.com>

show more ...