SourceLevelDebugPkg: Apply uncrustify changes

[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / DebugAgentCommon / DebugMp.h

/** @file\r
  Header file for Multi-Processor support.\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _DEBUG_MP_H_\r
#define _DEBUG_MP_H_\r
\r
#define DEBUG_CPU_MAX_COUNT  256\r
\r
typedef struct {\r
  UINT32    CpuCount;                            ///< Processor count\r
  UINT16    ApicID[DEBUG_CPU_MAX_COUNT];         ///< Record the local apic id for each processor\r
} DEBUG_CPU_DATA;\r
\r
typedef struct {\r
  SPIN_LOCK    MpContextSpinLock;                        ///< Lock for writing MP context\r
  SPIN_LOCK    DebugPortSpinLock;                        ///< Lock for access debug port\r
  SPIN_LOCK    MailboxSpinLock;                          ///< Lock for accessing mail box\r
  UINT8        CpuBreakMask[DEBUG_CPU_MAX_COUNT/8];      ///< Bitmask of all breaking CPUs\r
  UINT8        CpuStopStatusMask[DEBUG_CPU_MAX_COUNT/8]; ///< Bitmask of CPU stop status\r
  UINT32       ViewPointIndex;                           ///< Current view point to be debugged\r
  UINT32       BspIndex;                                 ///< Processor index value of BSP\r
  UINT32       BreakAtCpuIndex;                          ///< Processor index value of the current breaking CPU\r
  UINT32       DebugTimerInitCount;                      ///< Record BSP's init timer count\r
  BOOLEAN      IpiSentByAp;                              ///< TRUE: IPI is sent by AP. FALSE: IPI is sent by BSP\r
  BOOLEAN      RunCommandSet;                            ///< TRUE: RUN command is executing. FALSE: RUN command has been executed.\r
} DEBUG_MP_CONTEXT;\r
\r
extern DEBUG_MP_CONTEXT volatile  mDebugMpContext;\r
extern DEBUG_CPU_DATA   volatile  mDebugCpuData;\r
\r
/**\r
  Break the other processor by send IPI.\r
\r
  @param[in] CurrentProcessorIndex  Current processor index value.\r
\r
**/\r
VOID\r
HaltOtherProcessors (\r
  IN UINT32  CurrentProcessorIndex\r
  );\r
\r
/**\r
  Get the current processor's index.\r
\r
  @return Processor index value.\r
\r
**/\r
UINT32\r
GetProcessorIndex (\r
  VOID\r
  );\r
\r
/**\r
  Acquire a spin lock when Multi-processor supported.\r
\r
  It will block in the function if cannot get the access control.\r
  If Multi-processor is not supported, return directly.\r
\r
  @param[in, out] MpSpinLock      A pointer to the spin lock.\r
\r
**/\r
VOID\r
AcquireMpSpinLock (\r
  IN OUT SPIN_LOCK  *MpSpinLock\r
  );\r
\r
/**\r
  Release a spin lock when Multi-processor supported.\r
\r
  @param[in, out] MpSpinLock      A pointer to the spin lock.\r
\r
**/\r
VOID\r
ReleaseMpSpinLock (\r
  IN OUT SPIN_LOCK  *MpSpinLock\r
  );\r
\r
/**\r
  Check if the specified processor is BSP or not.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
\r
  @retval TRUE    It is BSP.\r
  @retval FALSE   It isn't BSP.\r
\r
**/\r
BOOLEAN\r
DebugAgentIsBsp (\r
  IN UINT32  ProcessorIndex\r
  );\r
\r
/**\r
  Set processor stop flag bitmask in MP context.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
  @param[in] StopFlag       TRUE means set stop flag.\r
                            FALSE means clean break flag.\r
\r
**/\r
VOID\r
SetCpuStopFlagByIndex (\r
  IN UINT32   ProcessorIndex,\r
  IN BOOLEAN  StopFlag\r
  );\r
\r
/**\r
  Set processor break flag bitmask in MP context.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
  @param[in] BreakFlag      TRUE means set break flag.\r
                            FALSE means clean break flag.\r
\r
**/\r
VOID\r
SetCpuBreakFlagByIndex (\r
  IN UINT32   ProcessorIndex,\r
  IN BOOLEAN  BreakFlag\r
  );\r
\r
/**\r
  Check if processor is stopped already.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
  @retval TRUE        Processor is stopped already.\r
  @retval FALSE       Processor isn't stopped.\r
\r
**/\r
BOOLEAN\r
IsCpuStopped (\r
  IN UINT32  ProcessorIndex\r
  );\r
\r
/**\r
  Set the run command flag.\r
\r
  @param[in] RunningFlag   TRUE means run command flag is set.\r
                           FALSE means run command flag is cleared.\r
\r
**/\r
VOID\r
SetCpuRunningFlag (\r
  IN BOOLEAN  RunningFlag\r
  );\r
\r
/**\r
  Set the current view point to be debugged.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
**/\r
VOID\r
SetDebugViewPoint (\r
  IN UINT32  ProcessorIndex\r
  );\r
\r
/**\r
  Set the IPI send by BPS/AP flag.\r
\r
  @param[in] IpiSentByApFlag   TRUE means this IPI is sent by AP.\r
                               FALSE means this IPI is sent by BSP.\r
\r
**/\r
VOID\r
SetIpiSentByApFlag (\r
  IN BOOLEAN  IpiSentByApFlag\r
  );\r
\r
/**\r
  Check the next pending breaking CPU.\r
\r
  @retval others      There is at least one processor broken, the minimum\r
                      index number of Processor returned.\r
  @retval -1          No any processor broken.\r
\r
**/\r
UINT32\r
FindNextPendingBreakCpu (\r
  VOID\r
  );\r
\r
/**\r
  Check if all processors are in running status.\r
\r
  @retval TRUE        All processors run.\r
  @retval FALSE       At least one processor does not run.\r
\r
**/\r
BOOLEAN\r
IsAllCpuRunning (\r
  VOID\r
  );\r
\r
/**\r
  Check if the current processor is the first breaking processor.\r
\r
  If yes, halt other processors.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
  @return TRUE       This processor is the first breaking processor.\r
  @return FALSE      This processor is not the first breaking processor.\r
\r
**/\r
BOOLEAN\r
IsFirstBreakProcessor (\r
  IN UINT32  ProcessorIndex\r
  );\r
\r
#endif\r