MdePkg: Change OPTIONAL keyword usage style

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

/** @file\r
  Switch stack function for RISC-V\r
\r
  Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include "BaseLibInternals.h"\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 passing 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      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
  BASE_LIBRARY_JUMP_BUFFER  JumpBuffer;\r
\r
  DEBUG ((DEBUG_INFO, "RISC-V InternalSwitchStack Entry:%x Context1:%x Context2:%x NewStack%x\n", \\r
          EntryPoint, Context1, Context2, NewStack));\r
  JumpBuffer.RA = (UINTN)EntryPoint;\r
  JumpBuffer.SP = (UINTN)NewStack - sizeof (VOID *);\r
  JumpBuffer.S0 = (UINT64)(UINTN)Context1;\r
  JumpBuffer.S1 = (UINT64)(UINTN)Context2;\r
  LongJump (&JumpBuffer, (UINTN)-1);\r
  ASSERT(FALSE);\r
}\r