ManageabilityPkg/Include/Library/ManageabilityTransportIpmiLib.h

/** @file

  This file defines the manageability IPMI protocol specific transport data.

  Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef MANAGEABILITY_TRANSPORT_IPMI_LIB_H_
#define MANAGEABILITY_TRANSPORT_IPMI_LIB_H_

#include <Library/ManageabilityTransportLib.h>

///
/// The IPMI command header which is apart from
/// the payload.
///
typedef struct {
  UINT8    Lun   : 2;
  UINT8    NetFn : 6;
  UINT8    Command;
} MANAGEABILITY_IPMI_TRANSPORT_HEADER;

///
/// Unless otherwise specified, commands that are listed as mandatory must be accessed
/// via LUN 00b.
///
#define MANAGEABILITY_IPMI_BMC_LUN  0

#define MANAGEABILITY_IPMI_NET_FUNC_MAX  0x3F

///
/// The IPMI Completion Code mapping.
///
typedef struct {
  UINT8                                        CompletionCode;
  CHAR16                                       *CompletionCodeString;
  MANAGEABILITY_TRANSPORT_ADDITIONAL_STATUS    AdditionalStatus;
} MANAGEABILITY_IPMI_COMPLETTION_CODE_MAPPING;

#endif