blob: bc5a1c8cc09533114ef95e163f8750102f8e2adc [file] [log] [blame]
#pragma once
#include "config_parser.hpp"
#include "ethernet_interface.hpp"
#include "types.hpp"
#include "xyz/openbmc_project/Network/VLAN/server.hpp"
#include <sdbusplus/bus.hpp>
#include <sdbusplus/server/object.hpp>
#include <stdplus/zstring.hpp>
#include <xyz/openbmc_project/Object/Delete/server.hpp>
namespace phosphor
{
namespace network
{
class EthernetInterface;
class Manager;
using DeleteIface = sdbusplus::xyz::openbmc_project::Object::server::Delete;
using VlanIface = sdbusplus::xyz::openbmc_project::Network::server::VLAN;
/** @class VlanInterface
* @brief OpenBMC vlan Interface implementation.
* @details A concrete implementation for the vlan interface
*/
class VlanInterface : public VlanIface,
public DeleteIface,
public EthernetInterface
{
public:
VlanInterface() = delete;
VlanInterface(const VlanInterface&) = delete;
VlanInterface& operator=(const VlanInterface&) = delete;
VlanInterface(VlanInterface&&) = delete;
VlanInterface& operator=(VlanInterface&&) = delete;
virtual ~VlanInterface() = default;
/** @brief Constructor to put object onto bus at a dbus path.
* @param[in] bus - Bus to attach to.
* @param[in] objPath - Path to attach at.
* @param[in] config - The parsed configuation file.
* @param[in] vlanID - vlan identifier.
* @param[in] intf - ethernet interface object.
* @param[in] manager - network manager object.
*
* This constructor is called during loading the VLAN Interface
*/
VlanInterface(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
const config::Parser& config, bool nicEnabled,
uint32_t vlanID, EthernetInterface& intf, Manager& parent);
/** @brief Delete this d-bus object.
*/
void delete_() override;
/** @brief sets the MAC address.
* @param[in] value - MAC address which needs to be set on the system.
* @returns macAddress of the interface or throws an error.
*/
std::string macAddress(std::string value) override;
/** @brief writes the device configuration.
systemd reads this configuration file
and creates the vlan interface.*/
void writeDeviceFile();
private:
/** @brief VLAN Identifier. */
using VlanIface::id;
EthernetInterface& parentInterface;
friend class TestVlanInterface;
};
} // namespace network
} // namespace phosphor