[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / FirmwarePerformanceDataTableSmm / FirmwarePerformanceCommon.h

/** @file\r
  This module collects performance data for SMM driver boot records and S3 Suspend Performance Record.\r
\r
  This module registers report status code listener to collect performance data\r
  for SMM driver boot records and S3 Suspend Performance Record.\r
\r
  Caution: This module requires additional review when modified.\r
  This driver will have external input - communicate buffer in SMM mode.\r
  This external input must be validated carefully to avoid security issue like\r
  buffer overflow, integer overflow.\r
\r
  FpdtSmiHandler() will receive untrusted input and do basic validation.\r
\r
  Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c), Microsoft Corporation.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _FW_PERF_COMMON_H_\r
#define _FW_PERF_COMMON_H_\r
\r
/**\r
  This function is an abstraction layer for implementation specific Mm buffer validation routine.\r
\r
  @param Buffer  The buffer start address to be checked.\r
  @param Length  The buffer length to be checked.\r
\r
  @retval TRUE  This buffer is valid per processor architecture and not overlap with SMRAM.\r
  @retval FALSE This buffer is not valid per processor architecture or overlap with SMRAM.\r
**/\r
BOOLEAN\r
IsBufferOutsideMmValid (\r
  IN EFI_PHYSICAL_ADDRESS  Buffer,\r
  IN UINT64                Length\r
  );\r
\r
/**\r
  The module Entry Point of the Firmware Performance Data Table MM driver.\r
\r
  @retval EFI_SUCCESS    The entry point is executed successfully.\r
  @retval Other          Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
FirmwarePerformanceCommonEntryPoint (\r
  VOID\r
  );\r
\r
#endif // _FW_PERF_COMMON_H_\r
Commit	Line	Data
06201d58 KQ	1	/** @file\r
	2	This module collects performance data for SMM driver boot records and S3 Suspend Performance Record.\r
	3	\r
	4	This module registers report status code listener to collect performance data\r
	5	for SMM driver boot records and S3 Suspend Performance Record.\r
	6	\r
	7	Caution: This module requires additional review when modified.\r
	8	This driver will have external input - communicate buffer in SMM mode.\r
	9	This external input must be validated carefully to avoid security issue like\r
	10	buffer overflow, integer overflow.\r
	11	\r
	12	FpdtSmiHandler() will receive untrusted input and do basic validation.\r
	13	\r
	14	Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
	15	Copyright (c), Microsoft Corporation.\r
	16	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	17	\r
	18	**/\r
	19	\r
	20	#ifndef _FW_PERF_COMMON_H_\r
	21	#define _FW_PERF_COMMON_H_\r
	22	\r
	23	/**\r
	24	This function is an abstraction layer for implementation specific Mm buffer validation routine.\r
	25	\r
	26	@param Buffer The buffer start address to be checked.\r
	27	@param Length The buffer length to be checked.\r
	28	\r
	29	@retval TRUE This buffer is valid per processor architecture and not overlap with SMRAM.\r
	30	@retval FALSE This buffer is not valid per processor architecture or overlap with SMRAM.\r
	31	**/\r
	32	BOOLEAN\r
	33	IsBufferOutsideMmValid (\r
	34	IN EFI_PHYSICAL_ADDRESS Buffer,\r
	35	IN UINT64 Length\r
	36	);\r
	37	\r
	38	/**\r
	39	The module Entry Point of the Firmware Performance Data Table MM driver.\r
	40	\r
	41	@retval EFI_SUCCESS The entry point is executed successfully.\r
	42	@retval Other Some error occurs when executing this entry point.\r
	43	\r
	44	**/\r
	45	EFI_STATUS\r
	46	FirmwarePerformanceCommonEntryPoint (\r
	47	VOID\r
	48	);\r
	49	\r
	50	#endif // _FW_PERF_COMMON_H_\r