Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify the platform libraries and add platform initialization routine #16

Merged
merged 11 commits into from
Sep 14, 2022
Merged

Unify the platform libraries and add platform initialization routine #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f4356d4
merge IPMI platform libraries into a ingle lib
cfernald Sep 9, 2022
5cc7763
Remove the unused context pointer in the generic and interface layers
cfernald Sep 12, 2022
9fd7185
Move initialization code into generic code
cfernald Sep 12, 2022
ade0744
Introduce the init code to the PEI module
cfernald Sep 12, 2022
bff58fb
Cleanup PEIM
cfernald Sep 13, 2022
8c2954e
Add platform init function
cfernald Sep 13, 2022
01be21a
Unify the generic headers
cfernald Sep 13, 2022
d5a1d58
Fix comments
cfernald Sep 13, 2022
bf79978
Cleanup SMM driver
cfernald Sep 13, 2022
3d802c6
Style fixes
cfernald Sep 13, 2022
c90a436
cleanup comments and headers
cfernald Sep 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 29 additions & 53 deletions IpmiFeaturePkg/GenericIpmi/Common/GenericIpmi.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,23 @@ IpmiPrintCommand (
DEBUG ((DebugLevel, "**************** IPMI %ls End ****************\n", TypeString));
}

/**
Send IPMI command to BMC

@param[in] This Pointer to IPMI protocol instance.
@param[in] NetFunction Net Function of command to send.
@param[in] Lun LUN of command to send.
@param[in] Command IPMI command to send.
@param[in] CommandData Pointer to command data buffer, if needed.
@param[in] CommandDataSize Size of command data buffer.
@param[in,out] ResponseData Pointer to response data buffer.
@param[in,out] ResponseDataSize Pointer to response data buffer size.

@retval EFI_INVALID_PARAMETER One of the input values is bad.
@retval EFI_DEVICE_ERROR IPMI command failed.
@retval EFI_BUFFER_TOO_SMALL Response buffer is too small.
@retval EFI_SUCCESS Command completed successfully.
**/
EFI_STATUS
EFIAPI
IpmiSendCommandInternal (
Expand All @@ -112,37 +129,8 @@ IpmiSendCommandInternal (
IN UINT8 *CommandData,
IN UINT8 CommandDataSize,
IN OUT UINT8 *ResponseData,
IN OUT UINT8 *ResponseDataSize,
IN VOID *Context
IN OUT UINT8 *ResponseDataSize
)

/*++

Routine Description:

Send IPMI command to BMC

Arguments:

This - Pointer to IPMI protocol instance
NetFunction - Net Function of command to send
Lun - LUN of command to send
Command - IPMI command to send
CommandData - Pointer to command data buffer, if needed
CommandDataSize - Size of command data buffer
ResponseData - Pointer to response data buffer
ResponseDataSize - Pointer to response data buffer size
Context - Context

Returns:

EFI_INVALID_PARAMETER - One of the input values is bad
EFI_DEVICE_ERROR - IPMI command failed
EFI_BUFFER_TOO_SMALL - Response buffer is too small
EFI_UNSUPPORTED - Command is not supported by BMC
EFI_SUCCESS - Command completed successfully

--*/
{
IPMI_BMC_INSTANCE_DATA *IpmiInstance;
UINT8 DataSize;
Expand Down Expand Up @@ -195,7 +183,6 @@ Routine Description:

Status = SendDataToBmcPort (
IpmiInstance->IpmiTimeoutPeriod,
Context,
(UINT8 *)IpmiCommand,
(CommandDataSize + IPMI_COMMAND_HEADER_SIZE)
);
Expand All @@ -214,7 +201,6 @@ Routine Description:
DataSize = MAX_TEMP_DATA - 1;
Status = ReceiveBmcDataFromPort (
IpmiInstance->IpmiTimeoutPeriod,
Context,
(UINT8 *)IpmiResponse,
&DataSize
);
Expand Down Expand Up @@ -334,33 +320,23 @@ Routine Description:
return EFI_SUCCESS;
}

/**
Updates the BMC status and returns the Com Address.

@param[in,out] <ParameterName> <Description>
@param[in] This Pointer to IPMI protocol instance
@param[out] BmcStatus BMC status
@param[out] ComAddress Com Address

@retval EFI_SUCCESS Success
**/
EFI_STATUS
EFIAPI
IpmiBmcStatus (
IN IPMI_TRANSPORT *This,
OUT BMC_STATUS *BmcStatus,
OUT SM_COM_ADDRESS *ComAddress,
IN VOID *Context
OUT SM_COM_ADDRESS *ComAddress
)

/*++

Routine Description:

Updates the BMC status and returns the Com Address

Arguments:

This - Pointer to IPMI protocol instance
BmcStatus - BMC status
ComAddress - Com Address
Context - Context

Returns:

EFI_SUCCESS - Success

--*/
{
IPMI_BMC_INSTANCE_DATA *IpmiInstance;

Expand Down
135 changes: 130 additions & 5 deletions IpmiFeaturePkg/GenericIpmi/Common/GenericIpmi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef _IPMI_BMC_H_
#define _IPMI_BMC_H_
#ifndef GENERIC_IPMI_H_
#define GENERIC_IPMI_H_

#include <Uefi.h>
#include <IndustryStandard/Ipmi.h>
Expand All @@ -16,9 +16,21 @@
#include <Library/IpmiTransportLib.h>
#include <IpmiInterface.h>

#include "GenericIpmiCommon.h"
#include <IpmiHooks.h>

#define IPMI_DELAY_UNIT 50 // Unit is microseconds.
#define IPMI_DELAY_UNIT 50 // Unit is microseconds.
#define MAX_TEMP_DATA 255
#define BMC_SLAVE_ADDRESS 0x20
#define MAX_SOFT_COUNT 10

#define COMPLETION_CODES \
{ \
IPMI_COMP_CODE_NODE_BUSY, IPMI_COMP_CODE_TIMEOUT, IPMI_COMP_CODE_OUT_OF_SPACE, \
IPMI_COMP_CODE_OUT_OF_RANGE, IPMI_COMP_CODE_CMD_RESP_NOT_PROVIDED, \
IPMI_COMP_CODE_FAIL_DUP_REQUEST, IPMI_COMP_CODE_SDR_REP_IN_UPDATE_MODE, \
IPMI_COMP_CODE_DEV_IN_FW_UPDATE_MODE, IPMI_COMP_CODE_BMC_INIT_IN_PROGRESS, \
IPMI_COMP_CODE_INSUFFICIENT_PRIVILEGE, IPMI_COMP_CODE_UNSPECIFIED \
}

//
// IPMI Instance signature
Expand All @@ -32,4 +44,117 @@
SM_IPMI_BMC_SIGNATURE \
)

#endif // _IPMI_BMC_H_
//
// Dxe Ipmi instance data
//
typedef struct {
UINTN Signature;
UINT64 IpmiTimeoutPeriod;
UINT8 SlaveAddress;
UINT8 TempData[MAX_TEMP_DATA];
BMC_STATUS BmcStatus;
UINT64 ErrorStatus;
UINT8 SoftErrorCount;
IPMI_TRANSPORT IpmiTransport;
} IPMI_BMC_INSTANCE_DATA;

#pragma pack(1)

//
// Structure of IPMI Command buffer
//
#define IPMI_COMMAND_HEADER_SIZE 2

typedef struct {
UINT8 Lun : 2;
UINT8 NetFunction : 6;
UINT8 Command;
UINT8 CommandData[MAX_TEMP_DATA - IPMI_COMMAND_HEADER_SIZE];
} IPMI_COMMAND;

//
// Structure of IPMI Command response buffer
//
#define IPMI_RESPONSE_HEADER_SIZE 3

typedef struct {
UINT8 Lun : 2;
UINT8 NetFunction : 6;
UINT8 Command;
UINT8 CompletionCode;
UINT8 ResponseData[MAX_TEMP_DATA - IPMI_RESPONSE_HEADER_SIZE];
} IPMI_RESPONSE;

//
// Structure to communicate BMC state from PEI to DXE.
//

typedef struct _IPMI_BMC_HOB {
BMC_STATUS BmcStatus;
} IPMI_BMC_HOB;

#pragma pack()

/**
Initializes the IPMI state for the BMC. This includes performs platform
specific logic, getting the device ID, and checking self-test results.

@param[in,out] IpmiInstance The IPMI instance being initialized.
cfernald marked this conversation as resolved.
Show resolved Hide resolved

@retval EFI_SUCCESS The BMC state was successfully initialized.
@retval Other An error was returned by a subroutine.
**/
EFI_STATUS
EFIAPI
IpmiInitializeBmc (
IN IPMI_BMC_INSTANCE_DATA *IpmiInstance
);

/**
Send IPMI command to BMC

@param[in] This Pointer to IPMI protocol instance.
@param[in] NetFunction Net Function of command to send.
@param[in] Lun LUN of command to send.
@param[in] Command IPMI command to send.
@param[in] CommandData Pointer to command data buffer, if needed.
@param[in] CommandDataSize Size of command data buffer.
@param[in,out] ResponseData Pointer to response data buffer.
@param[in,out] ResponseDataSize Pointer to response data buffer size.

@retval EFI_INVALID_PARAMETER One of the input values is bad.
@retval EFI_DEVICE_ERROR IPMI command failed.
@retval EFI_BUFFER_TOO_SMALL Response buffer is too small.
@retval EFI_SUCCESS Command completed successfully.
**/
EFI_STATUS
EFIAPI
IpmiSendCommandInternal (
IN IPMI_TRANSPORT *This,
IN UINT8 NetFunction,
IN UINT8 Lun,
IN UINT8 Command,
IN UINT8 *CommandData,
IN UINT8 CommandDataSize,
IN OUT UINT8 *ResponseData,
IN OUT UINT8 *ResponseDataSize
);

/**
Updates the BMC status and returns the Com Address.

@param[in] This Pointer to IPMI protocol instance
@param[out] BmcStatus BMC status
@param[out] ComAddress Com Address

@retval EFI_SUCCESS Success
**/
EFI_STATUS
EFIAPI
IpmiBmcStatus (
IN IPMI_TRANSPORT *This,
OUT BMC_STATUS *BmcStatus,
OUT SM_COM_ADDRESS *ComAddress
);

#endif
Loading