MdePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdePkg / Library / BaseLib / Arm / InternalSwitchStack.c

/** @file\r
  SwitchStack() function for ARM.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "BaseLibInternals.h"\r
\r
/**\r
  Transfers control to a function starting with a new stack.\r
\r
  This internal worker function transfers control to the function\r
  specified by EntryPoint using the new stack specified by NewStack,\r
  and passes in the parameters specified by Context1 and Context2.\r
  Context1 and Context2 are optional and may be NULL.\r
  The function EntryPoint must never return.\r
\r
  @param EntryPoint   The pointer to the function to enter.\r
  @param Context1     The first parameter to pass in.\r
  @param Context2     The second Parameter to pass in\r
  @param NewStack     The new Location of the stack\r
\r
**/\r
VOID\r
EFIAPI\r
InternalSwitchStackAsm (\r
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
  IN      VOID                      *Context1    OPTIONAL,\r
  IN      VOID                      *Context2    OPTIONAL,\r
  IN      VOID                      *NewStack\r
  );\r
\r
\r
/**\r
  Transfers control to a function starting with a new stack.\r
\r
  Transfers control to the function specified by EntryPoint using the\r
  new stack specified by NewStack, and passes in the parameters specified\r
  by Context1 and Context2.  Context1 and Context2 are optional and may\r
  be NULL.  The function EntryPoint must never return.\r
  Marker will be ignored on IA-32, x64, and EBC.\r
  IPF CPUs expect one additional parameter of type VOID * that specifies\r
  the new backing store pointer.\r
\r
  If EntryPoint is NULL, then ASSERT().\r
  If NewStack is NULL, then ASSERT().\r
\r
  @param  EntryPoint  A pointer to function to call with the new stack.\r
  @param  Context1    A pointer to the context to pass into the EntryPoint\r
                      function.\r
  @param  Context2    A pointer to the context to pass into the EntryPoint\r
                      function.\r
  @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                      function.\r
  @param  Marker      A VA_LIST marker for the variable argument list.\r
\r
**/\r
VOID\r
EFIAPI\r
InternalSwitchStack (\r
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
  IN      VOID                      *Context1    OPTIONAL,\r
  IN      VOID                      *Context2    OPTIONAL,\r
  IN      VOID                      *NewStack,\r
  IN      VA_LIST                   Marker\r
  )\r
\r
{\r
  InternalSwitchStackAsm (EntryPoint, Context1, Context2, NewStack);\r
}\r