Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / google-ipmi-sys / fd0f1cf99b2ef022fc36a2ff8c1d8040ccddc4ec
commitfd0f1cf99b2ef022fc36a2ff8c1d8040ccddc4ec[log] [tgz]
authorJaghathiswari Rankappagounder Natarajan <jaghu@google.com>Fri Jan 18 15:31:07 2019 -0800
committerJaghathiswari Rankappagounder Natarajan <jaghu@google.com>Fri Jan 18 15:42:10 2019 -0800
treea55d18f39a28609e48332f5bb9cbde3129081b2b
parent3c7037a728b7e6f6c808b5694bf8ebf14df255a7 [diff]
google-ipmi-sys: Add "Entity Id:Entity Instance" mapping to Entity name

Say the system has a JSON file like :
{
    "cpu": [
        {"instance": 1, "name": "CPU0"},
        {"instance": 2, "name": "CPU1"}
    ],
    "memory_module": [
        {"instance": 1, "name": "DIMM_A1"},
        {"instance": 2, "name": "DIMM_A2"},
        {"instance": 3, "name": "DIMM_B1"},
        {"instance": 4, "name": "DIMM_B2"},
        {"instance": 5, "name": "DIMM_C1"},
        {"instance": 6, "name": "DIMM_C2"},
        {"instance": 7, "name": "DIMM_D1"},
        {"instance": 8, "name": "DIMM_D2"},
        {"instance": 9, "name": "DIMM_E1"},
        {"instance": 10, "name": "DIMM_E2"},
        {"instance": 11, "name": "DIMM_F1"},
    ],
    "add_in_card": [
        {"instance": 1, "name": "slot1"},
        {"instance": 2, "name": "slot2"},
        {"instance": 3, "name": "slot3"},
        {"instance": 4, "name": "slot5"}
    ],
    "storage_device": [
        {"instance": 1, "name": "SATA0"},
        {"instance": 2, "name": "SATA1"},
        {"instance": 3, "name": "SATA2"},
        {"instance": 4, "name": "SATA3"}
    ]
}

The system can query the BMC for an Entity name given the Entity ID and Entity Instance.

Tested:
Yes;
1) Sending GetEntityName command; Expecting error since entity ID and
entity instance are not specified.
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06
Unable to send RAW command (channel=0x0 netfn=0x2e lun=0x0 cmd=0x32
rsp=0xc7): Request data length invalid

2) Sending GetEntityName command; Expecting error since entity instance
is not specified.
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06 0x01
Unable to send RAW command (channel=0x0 netfn=0x2e lun=0x0 cmd=0x32
rsp=0xc7): Request data length invalid

3) Sending GetEntityName command; Expecting error since Entity Id = 0x07
is not supported.
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06 0x07 0x01
Unable to send RAW command (channel=0x0 netfn=0x2e lun=0x0 cmd=0x32
rsp=0xcc): Invalid data field in request

4) Sending GetEntityName command; Expecting error since Entity Instance
= 0x06 is not added in the JSON file.
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06 0x3
0x06
Unable to send RAW command (channel=0x0 netfn=0x2e lun=0x0 cmd=0x32
rsp=0xcc): Invalid data field in request

5) Sending GetEntityName command; Expecting success.
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06 0x3
0x01
 79 2b 00 06 04 43 50 55 30
root@adler:~# ipmitool -I dbus raw 0x2e 0x32 0x79 0x2b 0x00 0x06 0x0B
0x01
 79 2b 00 06 05 73 6c 6f 74 31
root@adler:~#

Change-Id: Idf6caae863acacd62460cbb7f73bf56fc927bcff
Signed-off-by: Jaghathiswari Rankappagounder Natarajan <jaghu@google.com>
6 files changed
tree: a55d18f39a28609e48332f5bb9cbde3129081b2b
  1. .clang-format
  2. .gitignore
  3. bootstrap.sh
  4. cable.cpp
  5. cable.hpp
  6. configure.ac
  7. cpld.cpp
  8. cpld.hpp
  9. entity_name.cpp
  10. entity_name.hpp
  11. eth.cpp
  12. eth.hpp
  13. gbmc-psu-hardreset.target
  14. LICENSE
  15. main.cpp
  16. main.hpp
  17. MAINTAINERS
  18. Makefile.am
  19. pcie_i2c.cpp
  20. pcie_i2c.hpp
  21. psu.cpp
  22. psu.hpp
  23. README.md
README.md

Sys Commands (0x32)

There are and will be a variety of sys specific commands.

Cablecheck - SubCommand 0x00

The cablecheck command checks whether the BMC is seeing traffic between itself and the host's NIC. Sys specifies which if_name is expected to be connected. The BMC presently only checks traffic on the interface specified. There are now ethernet statistics available over IPMI, which can be checked directly in lieu of this.

Request

Byte(s)ValueData
0x000x00Subcommand
0x01If_name lengthWhere you expect the cable, eth0 or eth1, etc
0x02 ...The nameThe string, not null-terminated

Response

Byte(s)ValueData
0x000x00Subcommand
0x010x00/0x010 for false, 1 for true

CpldVersion - SubCommand 0x01

Any CPLD on the system that can only be read directly via the BMC can have its version exported to Sys via the cpld version command.

Request

Byte(s)ValueData
0x000x01Subcommand
0x01CPLD IDA one-byte identifier for the CPLD file to read, unsigned byte.

Response

Byte(s)ValueData
0x000x01Subcommand
0x01MajorMajor version
0x02MinorMinor Version
0x03Sub 1Third version number
0x04Sub 2Fourth version number

Per the above, if the version number doesn't fit in a byte it'll be cast to size.

GetNcsiEthDevice - SubCommand 0x02

The BMC itself must have hard-coded into the image, which ethernet device is connected to the host NIC. This is true also in the mapping of ethernet device to channel number. The channel number is used to configure the ethernet device over IPMI, instead of the interface name. This is because we leverage the current IPMI command set to read and write the networking configuration. Sys can be programmed already to have this information in the board protobuf, however, this information -- can be read from the BMC over IPMI.

Request

Byte(s)ValueData
0x000x02Subcommand

Response

Byte(s)ValueData
0x000x02Subcommand
0x01Channel numberThe IPMI channel number for use with the network configuration commands (such as reading the MAC or IP address of the BMC).
0x02if_name lengthThe length of the if_name in bytes.
0x03...if_nameThe interface name, not null-terminated

DelayedHardReset - SubCommand 0x03

Sys needs to be able to tell the BMC to reset the host but given a delay in seconds.

Request

Byte(s)ValueData
0x000x03Subcommand
0x01..0x04Seconds to delay (uint32)

Response

Byte(s)ValueData
0x000x03Subcommand

GetPCIeSlotsCount - SubCommand 0x04

Sys can get the total number of PCIe slots from BMC using this command. When BMC receives this command, BMC can enumerate over all the PCIe slots and create a hashmap with all the available PCIe slot name - I2C bus number mappings. BMC can then send the total number of PCIe slots as part of this command response.

Request

Byte(s)ValueData
0x000x04Subcommand

Response

Byte(s)ValueData
0x000x04Subcommand
0x01Total number of PCIe slotsTotal number of PCIe slots

GetPCIeSlotI2cBusMapping - SubCommand 0x05

If Sys gets N total slots as part of the above command, then Sys can send this command N times with Entry IDs ranging from 0 to N - 1. Say, Sys sends this command with Entry ID as 1, BMC can go and fetch the first PCIe slot name - I2C bus number mapping from the hashmap created above and then send the PCIe slot name and I2C bus number as part of the command response.

Request

Byte(s)ValueData
0x000x05Subcommand
0x01Entry IDEntry ID ranging from 0 to N - 1

Response

Byte(s)ValueData
0x000x05Subcommand
0x01I2C bus numberThe I2C bus number which is input to the above PCIe slot
0x02PCIe slot name lengthThe PCIe slot name length
0x03...PCIe slot nameThe PCIe slot name without null terminator

GetEntityName - SubCommand 0x06

Gsys can get the "Entity ID:Entity Instance" to Entity name mapping from BMC using this command. When BMC receives this command, BMC can check the related JSON file and then send the name for that particular entity as this command response.

Request

Byte(s)ValueData
0x000x06Subcommand
0x01Entity IDEntity ID
0x02Entity InstanceEntity Instance

Response

|Byte(s) |Value |Data |0x00|0x06|Subcommand |0x01|Entity name length (say N)|Entity name length |0x02...0x02 + N - 1|Entity name|Entity name without null terminator