MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Guid / SmiHandlerProfile.h

/** @file\r
  Header file for SMI handler profile definition.\r
\r
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef  _SMI_HANDLER_PROFILE_H_\r
#define  _SMI_HANDLER_PROFILE_H_\r
\r
#include <PiSmm.h>\r
#include <Protocol/SmmGpiDispatch2.h>\r
#include <Protocol/SmmIoTrapDispatch2.h>\r
#include <Protocol/SmmPeriodicTimerDispatch2.h>\r
#include <Protocol/SmmPowerButtonDispatch2.h>\r
#include <Protocol/SmmStandbyButtonDispatch2.h>\r
#include <Protocol/SmmSwDispatch2.h>\r
#include <Protocol/SmmSxDispatch2.h>\r
#include <Protocol/SmmUsbDispatch2.h>\r
\r
typedef struct {\r
  UINT32                       Signature;\r
  UINT32                       Length;\r
  UINT32                       Revision;\r
  UINT8                        Reserved[4];\r
} SMM_CORE_DATABASE_COMMON_HEADER;\r
\r
#define SMM_CORE_IMAGE_DATABASE_SIGNATURE SIGNATURE_32 ('S','C','I','D')\r
#define SMM_CORE_IMAGE_DATABASE_REVISION  0x0001\r
\r
typedef struct {\r
  SMM_CORE_DATABASE_COMMON_HEADER     Header;\r
  EFI_GUID                            FileGuid;\r
  PHYSICAL_ADDRESS                    EntryPoint;\r
  PHYSICAL_ADDRESS                    ImageBase;\r
  UINT64                              ImageSize;\r
  UINT32                              ImageRef;\r
  UINT16                              PdbStringOffset;\r
  UINT8                               Reserved[2];\r
//CHAR8                               PdbString[];\r
} SMM_CORE_IMAGE_DATABASE_STRUCTURE;\r
\r
#define SMM_CORE_SMI_DATABASE_SIGNATURE SIGNATURE_32 ('S','C','S','D')\r
#define SMM_CORE_SMI_DATABASE_REVISION  0x0001\r
\r
typedef enum {\r
  SmmCoreSmiHandlerCategoryRootHandler,\r
  SmmCoreSmiHandlerCategoryGuidHandler,\r
  SmmCoreSmiHandlerCategoryHardwareHandler,\r
} SMM_CORE_SMI_HANDLER_CATEGORY;\r
\r
//\r
// Context for SmmCoreSmiHandlerCategoryRootHandler:\r
//   NULL\r
// Context for SmmCoreSmiHandlerCategoryGuidHandler:\r
//   NULL\r
// Context for SmmCoreSmiHandlerCategoryHardwareHandler:\r
//   (NOTE: The context field should NOT include any data pointer.)\r
//   gEfiSmmSwDispatch2ProtocolGuid:            (EFI_SMM_SW_REGISTER_CONTEXT => SMI_HANDLER_PROFILE_SW_REGISTER_CONTEXT)\r
//   gEfiSmmSxDispatch2ProtocolGuid:            EFI_SMM_SX_REGISTER_CONTEXT\r
//   gEfiSmmPowerButtonDispatch2ProtocolGuid:   EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT\r
//   gEfiSmmStandbyButtonDispatch2ProtocolGuid: EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT\r
//   gEfiSmmPeriodicTimerDispatch2ProtocolGuid: EFI_SMM_PERIODIC_TIMER_CONTEXT\r
//   gEfiSmmGpiDispatch2ProtocolGuid:           EFI_SMM_GPI_REGISTER_CONTEXT\r
//   gEfiSmmIoTrapDispatch2ProtocolGuid:        EFI_SMM_IO_TRAP_REGISTER_CONTEXT\r
//   gEfiSmmUsbDispatch2ProtocolGuid:           (EFI_SMM_USB_REGISTER_CONTEXT => SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT)\r
//   Other:                                     GUID specific\r
\r
typedef struct {\r
  EFI_USB_SMI_TYPE          Type;\r
  UINT32                    DevicePathSize;\r
//UINT8                     DevicePath[DevicePathSize];\r
} SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT;\r
\r
typedef struct {\r
  UINT64                    SwSmiInputValue;\r
} SMI_HANDLER_PROFILE_SW_REGISTER_CONTEXT;\r
\r
typedef struct {\r
  UINT32                Length;\r
  UINT32                ImageRef;\r
  PHYSICAL_ADDRESS      CallerAddr;\r
  PHYSICAL_ADDRESS      Handler;\r
  UINT16                ContextBufferOffset;\r
  UINT8                 Reserved[2];\r
  UINT32                ContextBufferSize;\r
//UINT8                 ContextBuffer[];\r
} SMM_CORE_SMI_HANDLER_STRUCTURE;\r
\r
typedef struct {\r
  SMM_CORE_DATABASE_COMMON_HEADER     Header;\r
  EFI_GUID                            HandlerType;\r
  UINT32                              HandlerCategory;\r
  UINT32                              HandlerCount;\r
//SMM_CORE_SMI_HANDLER_STRUCTURE      Handler[HandlerCount];\r
} SMM_CORE_SMI_DATABASE_STRUCTURE;\r
\r
//\r
// Layout:\r
// +-------------------------------------+\r
// | SMM_CORE_IMAGE_DATABASE_STRUCTURE   |\r
// +-------------------------------------+\r
// | SMM_CORE_SMI_DATABASE_STRUCTURE     |\r
// +-------------------------------------+\r
//\r
\r
\r
\r
//\r
// SMM_CORE dump command\r
//\r
#define SMI_HANDLER_PROFILE_COMMAND_GET_INFO           0x1\r
#define SMI_HANDLER_PROFILE_COMMAND_GET_DATA_BY_OFFSET 0x2\r
\r
typedef struct {\r
  UINT32                            Command;\r
  UINT32                            DataLength;\r
  UINT64                            ReturnStatus;\r
} SMI_HANDLER_PROFILE_PARAMETER_HEADER;\r
\r
typedef struct {\r
  SMI_HANDLER_PROFILE_PARAMETER_HEADER    Header;\r
  UINT64                                  DataSize;\r
} SMI_HANDLER_PROFILE_PARAMETER_GET_INFO;\r
\r
typedef struct {\r
  SMI_HANDLER_PROFILE_PARAMETER_HEADER    Header;\r
  //\r
  // On input, data buffer size.\r
  // On output, actual data buffer size copied.\r
  //\r
  UINT64                                  DataSize;\r
  PHYSICAL_ADDRESS                        DataBuffer;\r
  //\r
  // On input, data buffer offset to copy.\r
  // On output, next time data buffer offset to copy.\r
  //\r
  UINT64                                  DataOffset;\r
} SMI_HANDLER_PROFILE_PARAMETER_GET_DATA_BY_OFFSET;\r
\r
#define SMI_HANDLER_PROFILE_GUID {0x49174342, 0x7108, 0x409b, {0x8b, 0xbe, 0x65, 0xfd, 0xa8, 0x53, 0x89, 0xf5}}\r
\r
extern EFI_GUID gSmiHandlerProfileGuid;\r
\r
typedef struct _SMI_HANDLER_PROFILE_PROTOCOL  SMI_HANDLER_PROFILE_PROTOCOL;\r
\r
/**\r
  This function is called by SmmChildDispatcher module to report\r
  a new SMI handler is registered, to SmmCore.\r
\r
  @param This            The protocol instance\r
  @param HandlerGuid     The GUID to identify the type of the handler.\r
                         For the SmmChildDispatch protocol, the HandlerGuid\r
                         must be the GUID of SmmChildDispatch protocol.\r
  @param Handler         The SMI handler.\r
  @param CallerAddress   The address of the module who registers the SMI handler.\r
  @param Context         The context of the SMI handler.\r
                         For the SmmChildDispatch protocol, the Context\r
                         must match the one defined for SmmChildDispatch protocol.\r
  @param ContextSize     The size of the context in bytes.\r
                         For the SmmChildDispatch protocol, the Context\r
                         must match the one defined for SmmChildDispatch protocol.\r
\r
  @retval EFI_SUCCESS           The information is recorded.\r
  @retval EFI_OUT_OF_RESOURCES  There is no enough resource to record the information.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI  *SMI_HANDLER_PROFILE_REGISTER_HANDLER) (\r
  IN SMI_HANDLER_PROFILE_PROTOCOL   *This,\r
  IN EFI_GUID                       *HandlerGuid,\r
  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,\r
  IN PHYSICAL_ADDRESS               CallerAddress,\r
  IN VOID                           *Context, OPTIONAL\r
  IN UINTN                          ContextSize OPTIONAL\r
  );\r
\r
/**\r
  This function is called by SmmChildDispatcher module to report\r
  an existing SMI handler is unregistered, to SmmCore.\r
\r
  @param This            The protocol instance\r
  @param HandlerGuid     The GUID to identify the type of the handler.\r
                         For the SmmChildDispatch protocol, the HandlerGuid\r
                         must be the GUID of SmmChildDispatch protocol.\r
  @param Handler         The SMI handler.\r
  @param Context         The context of the SMI handler.\r
                         If it is NOT NULL, it will be used to check what is registered.\r
  @param ContextSize     The size of the context in bytes.\r
                         If Context is NOT NULL, it will be used to check what is registered.\r
\r
  @retval EFI_SUCCESS           The original record is removed.\r
  @retval EFI_NOT_FOUND         There is no record for the HandlerGuid and handler.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI  *SMI_HANDLER_PROFILE_UNREGISTER_HANDLER) (\r
  IN SMI_HANDLER_PROFILE_PROTOCOL   *This,\r
  IN EFI_GUID                       *HandlerGuid,\r
  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,\r
  IN VOID                           *Context, OPTIONAL\r
  IN UINTN                          ContextSize OPTIONAL\r
  );\r
\r
struct _SMI_HANDLER_PROFILE_PROTOCOL {\r
  SMI_HANDLER_PROFILE_REGISTER_HANDLER     RegisterHandler;\r
  SMI_HANDLER_PROFILE_UNREGISTER_HANDLER   UnregisterHandler;\r
};\r
\r
#endif\r