MdePkg/Library/BaseLib/x86EnablePaging32.c

   1 /** @file
   2   IA-32/x64 AsmEnablePaging32()
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   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   Module Name:  x86EnablePaging32.c
  14
  15 **/
  16
  17 //
  18 // Include common header file for this module.
  19 //
  20 #include "CommonHeader.h"
  21
  22 #include "BaseLibInternals.h"
  23
  24 /**
  25   Enables the 32-bit paging mode on the CPU.
  26
  27   Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
  28   must be properly initialized prior to calling this service. This function
  29   assumes the current execution mode is 32-bit protected mode. This function is
  30   only available on IA-32. After the 32-bit paging mode is enabled, control is
  31   transferred to the function specified by EntryPoint using the new stack
  32   specified by NewStack and passing in the parameters specified by Context1 and
  33   Context2. Context1 and Context2 are optional and may be NULL. The function
  34   EntryPoint must never return.
  35
  36   If the current execution mode is not 32-bit protected mode, then ASSERT().
  37   If EntryPoint is NULL, then ASSERT().
  38   If NewStack is NULL, then ASSERT().
  39
  40   There are a number of constraints that must be followed before calling this
  41   function:
  42   1)  Interrupts must be disabled.
  43   2)  The caller must be in 32-bit protected mode with flat descriptors. This
  44       means all descriptors must have a base of 0 and a limit of 4GB.
  45   3)  CR0 and CR4 must be compatible with 32-bit protected mode with flat
  46       descriptors.
  47   4)  CR3 must point to valid page tables that will be used once the transition
  48       is complete, and those page tables must guarantee that the pages for this
  49       function and the stack are identity mapped.
  50
  51   @param  EntryPoint  A pointer to function to call with the new stack after
  52                       paging is enabled.
  53   @param  Context1    A pointer to the context to pass into the EntryPoint
  54                       function as the first parameter after paging is enabled.
  55   @param  Context2    A pointer to the context to pass into the EntryPoint
  56                       function as the second parameter after paging is enabled.
  57   @param  NewStack    A pointer to the new stack to use for the EntryPoint
  58                       function after paging is enabled.
  59
  60 **/
  61 VOID
  62 EFIAPI
  63 AsmEnablePaging32 (
  64   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  65   IN      VOID                      *Context1,  OPTIONAL
  66   IN      VOID                      *Context2,  OPTIONAL
  67   IN      VOID                      *NewStack
  68   )
  69 {
  70   ASSERT (EntryPoint != NULL);
  71   ASSERT (NewStack != NULL);
  72   InternalX86EnablePaging32 (EntryPoint, Context1, Context2, NewStack);
  73 }