blob: 5c95a663948167fd3a657212bdeca88409ef2cb2 [file] [log] [blame]
#pragma once
#include <host-cmd-manager.hpp>
#include <sdbusplus/bus.hpp>
#include <xyz/openbmc_project/Control/Host/server.hpp>
namespace phosphor
{
namespace host
{
namespace command
{
/** @class Host
* @brief OpenBMC control host interface implementation.
* @details A concrete implementation for xyz.openbmc_project.Control.Host
* DBus API.
*/
class Host : public sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Control::server::Host>
{
public:
/** @brief Constructs Host Control Interface
*
* @param[in] bus - The Dbus bus object
* @param[in] objPath - The Dbus object path
*/
Host(sdbusplus::bus::bus& bus, const char* objPath) :
sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Control::server::Host>(bus,
objPath),
bus(bus)
{
// Nothing to do
}
/** @brief Send input command to host
* Note that the command will be queued in a FIFO if
* other commands to the host have yet to be run
*
* @param[in] command - Input command to execute
*/
void execute(Command command) override;
private:
/** @brief sdbusplus DBus bus connection. */
sdbusplus::bus::bus& bus;
/** @brief Callback function to be invoked by command manager
*
* @detail Conveys the status of the last Host bound command.
* Depending on the status, a CommandComplete or
* CommandFailure signal would be sent
*
* @param[in] cmd - IPMI command and data sent to Host
* @param[in] status - Success or Failure
*/
void commandStatusHandler(IpmiCmdData cmd, bool status);
};
} // namespace command
} // namespace host
} // namespace phosphor