clean up non-English characters.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkMpService.h

/** @file\r
  When installed, the Framework MP Services Protocol produces a collection of \r
  services that are needed for MP management, such as initialization and management \r
  of application processors.  \r
  \r
  @par Note: \r
    This protocol has been deprecated and has been replaced by the MP Services \r
    Protocol from the UEFI Platform Initialization Specification 1.2, Volume 2:\r
    Driver Execution Environment Core Interface.\r
\r
  The MP Services Protocol provides a generalized way of performing following tasks:\r
    - Retrieving information of multi-processor environment and MP-related status of\r
      specific processors.\r
    - Dispatching user-provided function to APs.\r
    - Maintain MP-related processor status.\r
\r
  The MP Services Protocol must be produced on any system with more than one logical\r
  processor.\r
\r
  The Protocol is available only during boot time.\r
\r
  MP Services Protocol is hardware-independent. Most of the logic of this protocol\r
  is architecturally neutral. It abstracts the multi-processor environment and \r
  status of processors, and provides interfaces to retrieve information, maintain, \r
  and dispatch.\r
\r
  MP Services Protocol may be consumed by ACPI module. The ACPI module may use this \r
  protocol to retrieve data that are needed for an MP platform and report them to OS.\r
  MP Services Protocol may also be used to program and configure processors, such \r
  as MTRR synchronization for memory space attributes setting in DXE Services.\r
  MP Services Protocol may be used by non-CPU DXE drivers to speed up platform boot \r
  by taking advantage of the processing capabilities of the APs, for example, using \r
  APs to help test system memory in parallel with other device initialization.\r
  Diagnostics applications may also use this protocol for multi-processor.\r
\r
  Copyright (c) 1999 - 2002, 2009, Intel Corporation.<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at<BR>\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
--*/\r
\r
#ifndef _FRAMEWORK_MP_SERVICE_PROTOCOL_H_\r
#define _FRAMEWORK_MP_SERVICE_PROTOCOL_H_\r
\r
///\r
/// Global ID for the FRAMEWORK_EFI_MP_SERVICES_PROTOCOL\r
///\r
#define FRAMEWORK_EFI_MP_SERVICES_PROTOCOL_GUID \\r
  { \\r
    0xf33261e7, 0x23cb, 0x11d5, {0xbd, 0x5c, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81} \\r
  }\r
\r
///\r
/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL\r
///\r
typedef struct _FRAMEWORK_EFI_MP_SERVICES_PROTOCOL FRAMEWORK_EFI_MP_SERVICES_PROTOCOL;\r
\r
///\r
/// Fixed delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_FIXED           0x0\r
\r
///\r
/// Lowest priority delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_LOWEST_PRIORITY 0x1\r
\r
///\r
/// SMI delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_SMI             0x2\r
\r
///\r
/// Remote read delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_REMOTE_READ     0x3\r
\r
///\r
/// NMI delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_NMI             0x4\r
\r
///\r
/// INIT delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_INIT            0x5\r
\r
///\r
/// Startup IPI delivery mode that may be used as the DeliveryMode parameter in SendIpi() \r
///\r
#define DELIVERY_MODE_SIPI            0x6\r
\r
///\r
/// The DeliveryMode parameter in SendIpi() bust be less than this maximum value\r
///\r
#define DELIVERY_MODE_MAX             0x7\r
\r
///\r
/// IPF specific value for the state field of the Self Test State Parameter\r
///\r
#define EFI_MP_HEALTH_FLAGS_STATUS_HEALTHY                  0x0\r
\r
///\r
/// IPF specific value for the state field of the Self Test State Parameter\r
///\r
#define EFI_MP_HEALTH_FLAGS_STATUS_PERFORMANCE_RESTRICTED   0x1\r
\r
///\r
/// IPF specific value for the state field of the Self Test State Parameter\r
///\r
#define EFI_MP_HEALTH_FLAGS_STATUS_FUNCTIONALLY_RESTRICTED  0x2\r
\r
typedef union {\r
  ///\r
  /// Bitfield structure for the IPF Self Test State Parameter \r
  ///\r
  struct {\r
    UINT32  Status:2;\r
    UINT32  Tested:1;\r
    UINT32  Reserved1:13;\r
    UINT32  VirtualMemoryUnavailable:1;\r
    UINT32  Ia32ExecutionUnavailable:1;\r
    UINT32  FloatingPointUnavailable:1;\r
    UINT32  MiscFeaturesUnavailable:1;\r
    UINT32  Reserved2:12;\r
  } Bits;\r
  ///\r
  /// IA32 and X64 BIST data of the processor\r
  ///\r
  UINT32  Uint32;\r
} EFI_MP_HEALTH_FLAGS;\r
\r
typedef struct {\r
  ///\r
  /// @par IA32, X64:\r
  ///   BIST (built-in self test) data of the processor.\r
  ///\r
  /// @par IPF:\r
  ///   Lower 32 bits of self test state parameter. For definition of self test \r
  ///   state parameter, please refer to Intel(R) Itanium(R) Architecture Software \r
  ///   Developer's Manual, Volume 2: System Architecture.\r
  ///\r
  EFI_MP_HEALTH_FLAGS  Flags;\r
  ///\r
  /// @par IA32, X64:\r
  ///   Not used.\r
  ///\r
  /// @par IPF:\r
  ///   Higher 32 bits of self test state parameter.\r
  ///\r
  UINT32               TestStatus;\r
} EFI_MP_HEALTH;\r
\r
typedef enum {\r
  EfiCpuAP                = 0,  ///< The CPU is an AP (Application Processor)\r
  EfiCpuBSP,                    ///< The CPU is the BSP (Boot-Strap Processor)\r
  EfiCpuDesignationMaximum\r
} EFI_CPU_DESIGNATION;\r
\r
typedef struct {\r
  ///\r
  /// @par IA32, X64:\r
  ///   The lower 8 bits contains local APIC ID, and higher bits are reserved.\r
  ///\r
  /// @par IPF:\r
  ///   The lower 16 bits contains id/eid as physical address of local SAPIC \r
  ///   unit, and higher bits are reserved.\r
  ///\r
  UINT32               ApicID;\r
  ///\r
  /// This field indicates whether the processor is enabled.  If the value is \r
  /// TRUE, then the processor is enabled. Otherwise, it is disabled.\r
  ///\r
  BOOLEAN              Enabled;\r
  ///\r
  /// This field indicates whether the processor is playing the role of BSP.\r
  /// If the value is EfiCpuAP, then the processor is AP. If the value is \r
  /// EfiCpuBSP, then the processor is BSP.\r
  ///\r
  EFI_CPU_DESIGNATION  Designation;\r
  ///\r
  /// @par IA32, X64:\r
  ///   The Flags field of this EFI_MP_HEALTH data structure holds BIST (built-in \r
  ///   self test) data of the processor. The TestStatus field is not used, and \r
  ///   the value is always zero.\r
  ///\r
  /// @par IPF:\r
  ///   Bit format of this field is the same as the definition of self-test state \r