Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / google-ipmi-sys / cc53c847f14dd843bd7a7488822c1af52a5add11
commitcc53c847f14dd843bd7a7488822c1af52a5add11[log] [tgz]
authorPeter Lundgren <peterlundgren@google.com>Mon Sep 30 18:43:58 2019 -0700
committerPeter Lundgren <peterlundgren@google.com>Tue Oct 01 09:46:46 2019 -0700
treea087e02357e6a4dbe715e2bc5433e1c63cd06586
parent0c0bfd3a145e63cc6347c4cffc9b4561c21ea174 [diff]
Add more entity ids

The entity ids are defined in the IPMI spec Section 43.14 Table 43-,
Entity ID Codes.

Tested:
GetEntityName [1] works with these new ids when combined with a json
file that uses them. For example:

    {
        "system_board": [
            {"instance": 1, "name": "foo"}
        ],
        "power_system_board": [
            {"instance": 1, "name": "bar"}
        ],
        "system_internal_expansion_board": [
            {"instance": 1, "name": "baz"}
        ],
        "fan": [
            {"instance": 1, "name": "qux"}
        ]
    }

  [1]: https://github.com/openbmc/google-ipmi-sys#getentityname---subcommand-0x06

Signed-off-by: Peter Lundgren <peterlundgren@google.com>
Change-Id: I8f546aa23d9da8a3ddf282b0c2de89f9c17edf8c
1 file changed
tree: a087e02357e6a4dbe715e2bc5433e1c63cd06586
  1. test/
  2. .clang-format
  3. .gitignore
  4. .lcovrc
  5. bootstrap.sh
  6. cable.cpp
  7. cable.hpp
  8. configure.ac
  9. cpld.cpp
  10. cpld.hpp
  11. entity_name.cpp
  12. entity_name.hpp
  13. errors.hpp
  14. eth.cpp
  15. eth.hpp
  16. gbmc-psu-hardreset.target
  17. handler.cpp
  18. handler.hpp
  19. LICENSE
  20. main.cpp
  21. main.hpp
  22. MAINTAINERS
  23. Makefile.am
  24. pcie_i2c.cpp
  25. pcie_i2c.hpp
  26. psu.cpp
  27. psu.hpp
  28. README.md
  29. util.cpp
  30. util.hpp
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)ValueData
0x000x06Subcommand
0x01Entity name length (say N)Entity name length
0x02...0x02 + N - 1Entity nameEntity name without null terminator