MdePkg/Library/BaseLib/X64/Non-existing.c

   1 /** @file
   2   Non-existing BaseLib functions on x64
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "../BaseLibInternals.h"
  16
  17 /**
  18   Enables the 32-bit paging mode on the CPU.
  19
  20   Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
  21   must be properly initialized prior to calling this service. This function
  22   assumes the current execution mode is 32-bit protected mode. This function is
  23   only available on IA-32. After the 32-bit paging mode is enabled, control is
  24   transferred to the function specified by EntryPoint using the new stack
  25   specified by NewStack and passing in the parameters specified by Context1 and
  26   Context2. Context1 and Context2 are optional and may be NULL. The function
  27   EntryPoint must never return.
  28
  29   There are a number of constraints that must be followed before calling this
  30   function:
  31   1)  Interrupts must be disabled.
  32   2)  The caller must be in 32-bit protected mode with flat descriptors. This
  33       means all descriptors must have a base of 0 and a limit of 4GB.
  34   3)  CR0 and CR4 must be compatible with 32-bit protected mode with flat
  35       descriptors.
  36   4)  CR3 must point to valid page tables that will be used once the transition
  37       is complete, and those page tables must guarantee that the pages for this
  38       function and the stack are identity mapped.
  39
  40   @param  EntryPoint  A pointer to function to call with the new stack after
  41                       paging is enabled.
  42   @param  Context1    A pointer to the context to pass into the EntryPoint
  43                       function as the first parameter after paging is enabled.
  44   @param  Context2    A pointer to the context to pass into the EntryPoint
  45                       function as the second parameter after paging is enabled.
  46   @param  NewStack    A pointer to the new stack to use for the EntryPoint
  47                       function after paging is enabled.
  48
  49 **/
  50 VOID
  51 EFIAPI
  52 InternalX86EnablePaging32 (
  53   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  54   IN      VOID                      *Context1,  OPTIONAL
  55   IN      VOID                      *Context2,  OPTIONAL
  56   IN      VOID                      *NewStack
  57   )
  58 {
  59   //
  60   // This function cannot work on X64 platform
  61   //
  62   ASSERT (FALSE);
  63 }
  64
  65 /**
  66   Disables the 32-bit paging mode on the CPU.
  67
  68   Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
  69   mode. This function assumes the current execution mode is 32-paged protected
  70   mode. This function is only available on IA-32. After the 32-bit paging mode
  71   is disabled, control is transferred to the function specified by EntryPoint
  72   using the new stack specified by NewStack and passing in the parameters
  73   specified by Context1 and Context2. Context1 and Context2 are optional and
  74   may be NULL. The function EntryPoint must never return.
  75
  76   There are a number of constraints that must be followed before calling this
  77   function:
  78   1)  Interrupts must be disabled.
  79   2)  The caller must be in 32-bit paged mode.
  80   3)  CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
  81   4)  CR3 must point to valid page tables that guarantee that the pages for
  82       this function and the stack are identity mapped.
  83
  84   @param  EntryPoint  A pointer to function to call with the new stack after
  85                       paging is disabled.
  86   @param  Context1    A pointer to the context to pass into the EntryPoint
  87                       function as the first parameter after paging is disabled.
  88   @param  Context2    A pointer to the context to pass into the EntryPoint
  89                       function as the second parameter after paging is
  90                       disabled.
  91   @param  NewStack    A pointer to the new stack to use for the EntryPoint
  92                       function after paging is disabled.
  93
  94 **/
  95 VOID
  96 EFIAPI
  97 InternalX86DisablePaging32 (
  98   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  99   IN      VOID                      *Context1,  OPTIONAL
 100   IN      VOID                      *Context2,  OPTIONAL
 101   IN      VOID                      *NewStack
 102   )
 103 {
 104   //
 105   // This function cannot work on X64 platform
 106   //
 107   ASSERT (FALSE);
 108 }