EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/BaseLib/X64/Non-existing.c

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