| #pragma once |
| |
| #include <vector> |
| #include "message_handler.hpp" |
| |
| namespace sol |
| { |
| |
| namespace command |
| { |
| |
| constexpr uint8_t IPMI_CC_PAYLOAD_ALREADY_ACTIVE = 0x80; |
| constexpr uint8_t IPMI_CC_PAYLOAD_TYPE_DISABLED = 0x81; |
| constexpr uint8_t IPMI_CC_PAYLOAD_ACTIVATION_LIMIT = 0x82; |
| constexpr uint8_t IPMI_CC_PAYLOAD_WITH_ENCRYPTION = 0x83; |
| constexpr uint8_t IPMI_CC_PAYLOAD_WITHOUT_ENCRYPTION = 0x84; |
| |
| /** @struct ActivatePayloadRequest |
| * |
| * IPMI payload for Activate Payload command request. |
| */ |
| struct ActivatePayloadRequest |
| { |
| #if BYTE_ORDER == LITTLE_ENDIAN |
| uint8_t payloadType : 6; //!< Payload type. |
| uint8_t reserved1 : 2; //!< Reserved. |
| #endif |
| |
| #if BYTE_ORDER == BIG_ENDIAN |
| uint8_t reserved1 : 2; //!< Payload type. |
| uint8_t payloadType : 6; //!< Payload type. |
| #endif |
| |
| #if BYTE_ORDER == LITTLE_ENDIAN |
| uint8_t payloadInstance : 4; //!< Payload instance. |
| uint8_t reserved2 : 4; //!< Reserved. |
| #endif |
| |
| #if BYTE_ORDER == BIG_ENDIAN |
| uint8_t reserved2 : 4; //!< Reserved. |
| uint8_t payloadInstance : 4; //!< Payload instance. |
| #endif |
| |
| /** @brief The following Auxiliary Request Data applies only for payload |
| * SOL only. |
| */ |
| #if BYTE_ORDER == LITTLE_ENDIAN |
| uint8_t reserved4 : 1; //!< Reserved. |
| uint8_t handshake : 1; //!< SOL startup handshake. |
| uint8_t alert : 2; //!< Shared serial alert behavior. |
| uint8_t reserved3 : 1; //!< Reserved. |
| uint8_t testMode : 1; //!< Test mode. |
| uint8_t auth : 1; //!< If true, activate payload with authentication. |
| uint8_t encryption : 1; //!< If true, activate payload with encryption. |
| #endif |
| |
| #if BYTE_ORDER == BIG_ENDIAN |
| uint8_t encryption : 1; //!< If true, activate payload with encryption. |
| uint8_t auth : 1; //!< If true, activate payload with authentication. |
| uint8_t testMode : 1; //!< Test mode. |
| uint8_t reserved3 : 1; //!< Reserved. |
| uint8_t alert : 2; //!< Shared serial alert behavior. |
| uint8_t handshake : 1; //!< SOL startup handshake. |
| uint8_t reserved4 : 1; //!< Reserved. |
| #endif |
| |
| uint8_t reserved5; //!< Reserved. |
| uint8_t reserved6; //!< Reserved. |
| uint8_t reserved7; //!< Reserved. |
| } __attribute__((packed)); |
| |
| /** @struct ActivatePayloadResponse |
| * |
| * IPMI payload for Activate Payload command response. |
| */ |
| struct ActivatePayloadResponse |
| { |
| uint8_t completionCode; //!< Completion code. |
| uint8_t reserved1; //!< Reserved. |
| uint8_t reserved2; //!< Reserved. |
| uint8_t reserved3; //!< Reserved. |
| |
| // Test Mode |
| #if BYTE_ORDER == LITTLE_ENDIAN |
| uint8_t testMode : 1; //!< Test mode. |
| uint8_t reserved4 : 7; //!< Reserved. |
| #endif |
| |
| #if BYTE_ORDER == BIG_ENDIAN |
| uint8_t reserved4 : 7; //!< Reserved. |
| uint8_t testMode : 1; //!< Test mode. |
| #endif |
| |
| uint16_t inPayloadSize; //!< Inbound payload size |
| uint16_t outPayloadSize; //!< Outbound payload size. |
| uint16_t portNum; //!< Payload UDP port number. |
| uint16_t vlanNum; //!< Payload VLAN number. |
| } __attribute__((packed)); |
| |
| /** @brief Activate Payload Command. |
| * |
| * This command is used for activating and deactivating a payload type under a |
| * given IPMI session. The UDP Port number for SOL is the same as the port that |
| * was used to establish the IPMI session. |
| * |
| * @param[in] inPayload - Request data for the command. |
| * @param[in] handler - Reference to the message handler. |
| * |
| * @return Response data for the command |
| */ |
| std::vector<uint8_t> activatePayload(std::vector<uint8_t>& inPayload, |
| const message::Handler& handler); |
| |
| } // namespace command |
| |
| } // namespace sol |