[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 - 2021, 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
  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
466ebdd2	14	Copyright (c) 2011 - 2021, Intel Corporation. All rights reserved.<BR>\r
06201d58 KQ	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
06201d58 KQ	23	/**\r
	24	The module Entry Point of the Firmware Performance Data Table MM driver.\r
	25	\r
	26	@retval EFI_SUCCESS The entry point is executed successfully.\r
	27	@retval Other Some error occurs when executing this entry point.\r
	28	\r
	29	**/\r
	30	EFI_STATUS\r
	31	FirmwarePerformanceCommonEntryPoint (\r
	32	VOID\r
	33	);\r
	34	\r
	35	#endif // _FW_PERF_COMMON_H_\r